flacgo/README.md

# flac

[![Build Status](https://travis-ci.org/mewkiz/flac.svg?branch=master)](https://travis-ci.org/mewkiz/flac)
[![Coverage Status](https://img.shields.io/coveralls/mewkiz/flac.svg)](https://coveralls.io/r/mewkiz/flac?branch=master)
[![GoDoc](https://godoc.org/git.gammaspectra.live/S.O.N.G/flacgo?status.svg)](https://godoc.org/git.gammaspectra.live/S.O.N.G/flacgo)

This package provides access to [FLAC][1] (Free Lossless Audio Codec) streams.

[1]: http://flac.sourceforge.net/format.html

## Documentation

Documentation provided by GoDoc.

- [flac]: provides access to FLAC (Free Lossless Audio Codec) streams.
    - [frame][flac/frame]: implements access to FLAC audio frames.
    - [meta][flac/meta]: implements access to FLAC metadata blocks.

[flac]: http://godoc.org/git.gammaspectra.live/S.O.N.G/flacgo
[flac/frame]: http://godoc.org/git.gammaspectra.live/S.O.N.G/flacgo/frame
[flac/meta]: http://godoc.org/git.gammaspectra.live/S.O.N.G/flacgo/meta

## Changes

* Version 1.0.7 (2021-01-28)
    - Add seek API (see [#44](https://git.gammaspectra.live/S.O.N.G/flacgo/pull/44) and [#46](https://git.gammaspectra.live/S.O.N.G/flacgo/pull/46)). Thanks to [Craig Swank](https://github.com/cswank).

* Version 1.0.6 (2019-12-20)
    - Add experimental Encoder API to encode audio samples and metadata blocks (see [#32](https://git.gammaspectra.live/S.O.N.G/flacgo/pull/32)).
    - Use go.mod.
    - Skip ID3v2 data prepended to flac files when parsing (see [36cc17e](https://git.gammaspectra.live/S.O.N.G/flacgo/commit/36cc17efed51a9bae283d6a3a7a10997492945e7)).
        - Remove dependency on encodebytes. Thanks to [Mikey Dickerson](https://github.com/mdickers47).
    - Add 16kHz test case. Thanks to [Chewxy](https://github.com/chewxy).
    - Fix lint issues (see [#25](https://git.gammaspectra.live/S.O.N.G/flacgo/issues/25)).

* Version 1.0.5 (2016-05-06)
    - Simplify import paths. Drop use of gopkg.in, and rely on vendoring instead (see [azul3d/engine#1](https://github.com/azul3d/engine/issues/1)).
    - Add FLAC decoding benchmark (see [d675e0a](https://git.gammaspectra.live/S.O.N.G/flacgo/blob/d675e0aaccf2e43055f56b9b3feeddfdeed402e2/frame/frame_test.go#L60))

* Version 1.0.4 (2016-02-11)
    - Add API examples to documentation (see [#11](https://git.gammaspectra.live/S.O.N.G/flacgo/issues/11)).
    - Extend test cases (see [aadf80a](https://git.gammaspectra.live/S.O.N.G/flacgo/commit/aadf80aa28c463a94b8d5c49757e5a0948613ce2)).

* Version 1.0.3 (2016-02-02)
    - Implement decoding of FLAC files with wasted bits-per-sample (see [#12](https://git.gammaspectra.live/S.O.N.G/flacgo/issues/12)).
    - Stress test the library using [go-fuzz](https://github.com/dvyukov/go-fuzz) (see [#10](https://git.gammaspectra.live/S.O.N.G/flacgo/pull/10)). Thanks to [Patrick Mézard](https://github.com/pmezard).

* Version 1.0.2 (2015-06-05)
    - Fix decoding of blocking strategy (see [#9](https://git.gammaspectra.live/S.O.N.G/flacgo/pull/9)). Thanks to [Sergey Didyk](https://github.com/sdidyk).

* Version 1.0.1 (2015-02-25)
    - Fix two subframe decoding bugs (see [#7](https://git.gammaspectra.live/S.O.N.G/flacgo/pull/7)). Thanks to [Jonathan MacMillan](https://github.com/perotinus).
    - Add frame decoding test cases.

* Version 1.0.0 (2014-09-30)
    - Initial release.
    - Implement decoding of FLAC files.
readme: Add v1.0.1 release notes. 2015-01-30 00:47:26 +00:00			`# flac`
rsf: Added readme. Updated import paths. 2012-11-01 20:27:51 +00:00
travis: Add config. 2014-11-09 23:23:09 +00:00			`[![Build Status](https://travis-ci.org/mewkiz/flac.svg?branch=master)](https://travis-ci.org/mewkiz/flac)`
			`[![Coverage Status](https://img.shields.io/coveralls/mewkiz/flac.svg)](https://coveralls.io/r/mewkiz/flac?branch=master)`
Update module url 2022-07-16 22:07:10 +00:00			`[![GoDoc](https://godoc.org/git.gammaspectra.live/S.O.N.G/flacgo?status.svg)](https://godoc.org/git.gammaspectra.live/S.O.N.G/flacgo)`
travis: Add config. 2014-11-09 23:23:09 +00:00
readme: Minor wording update. 2014-08-07 23:20:37 +00:00			`This package provides access to [FLAC][1] (Free Lossless Audio Codec) streams.`
rsf: Added readme. Updated import paths. 2012-11-01 20:27:51 +00:00
readme: Fix link to flac format specification. 2013-06-07 01:26:34 +00:00			`[1]: http://flac.sourceforge.net/format.html`
rsf: Added readme. Updated import paths. 2012-11-01 20:27:51 +00:00
readme: Add v1.0.1 release notes. 2015-01-30 00:47:26 +00:00			`## Documentation`
rsf: Added readme. Updated import paths. 2012-11-01 20:27:51 +00:00
Minor alteration of readme. 2013-01-23 00:14:51 +00:00			`Documentation provided by GoDoc.`
rsf: Added readme. Updated import paths. 2012-11-01 20:27:51 +00:00
readme: Add v1.0.1 release notes. 2015-01-30 00:47:26 +00:00			`- [flac]: provides access to FLAC (Free Lossless Audio Codec) streams.`
			`- [frame][flac/frame]: implements access to FLAC audio frames.`
			`- [meta][flac/meta]: implements access to FLAC metadata blocks.`
rsf: Added readme. Updated import paths. 2012-11-01 20:27:51 +00:00
Update module url 2022-07-16 22:07:10 +00:00			`[flac]: http://godoc.org/git.gammaspectra.live/S.O.N.G/flacgo`
			`[flac/frame]: http://godoc.org/git.gammaspectra.live/S.O.N.G/flacgo/frame`
			`[flac/meta]: http://godoc.org/git.gammaspectra.live/S.O.N.G/flacgo/meta`
rsf: Added readme. Updated import paths. 2012-11-01 20:27:51 +00:00
readme: Add v1.0.1 release notes. 2015-01-30 00:47:26 +00:00			`## Changes`
rsf: Added readme. Updated import paths. 2012-11-01 20:27:51 +00:00
readme: update release date of v1.0.7 and add ref to #46 2021-01-27 23:38:31 +00:00			`* Version 1.0.7 (2021-01-28)`
Update module url 2022-07-16 22:07:10 +00:00			`- Add seek API (see [#44](https://git.gammaspectra.live/S.O.N.G/flacgo/pull/44) and [#46](https://git.gammaspectra.live/S.O.N.G/flacgo/pull/46)). Thanks to [Craig Swank](https://github.com/cswank).`
Update README.md 2021-01-23 16:43:44 +00:00
readme: add release notes for version 1.0.6 2019-12-20 20:09:38 +00:00			`* Version 1.0.6 (2019-12-20)`
Update module url 2022-07-16 22:07:10 +00:00			`- Add experimental Encoder API to encode audio samples and metadata blocks (see [#32](https://git.gammaspectra.live/S.O.N.G/flacgo/pull/32)).`
readme: add release notes for version 1.0.6 2019-12-20 20:09:38 +00:00			`- Use go.mod.`
Update module url 2022-07-16 22:07:10 +00:00			`- Skip ID3v2 data prepended to flac files when parsing (see [36cc17e](https://git.gammaspectra.live/S.O.N.G/flacgo/commit/36cc17efed51a9bae283d6a3a7a10997492945e7)).`
readme: add release notes for version 1.0.6 2019-12-20 20:09:38 +00:00			`- Remove dependency on encodebytes. Thanks to [Mikey Dickerson](https://github.com/mdickers47).`
			`- Add 16kHz test case. Thanks to [Chewxy](https://github.com/chewxy).`
Update module url 2022-07-16 22:07:10 +00:00			`- Fix lint issues (see [#25](https://git.gammaspectra.live/S.O.N.G/flacgo/issues/25)).`
readme: add release notes for version 1.0.6 2019-12-20 20:09:38 +00:00
readme: Add release notes for version 1.0.5. 2016-05-05 23:35:53 +00:00			`* Version 1.0.5 (2016-05-06)`
			`- Simplify import paths. Drop use of gopkg.in, and rely on vendoring instead (see [azul3d/engine#1](https://github.com/azul3d/engine/issues/1)).`
Update module url 2022-07-16 22:07:10 +00:00			`- Add FLAC decoding benchmark (see [d675e0a](https://git.gammaspectra.live/S.O.N.G/flacgo/blob/d675e0aaccf2e43055f56b9b3feeddfdeed402e2/frame/frame_test.go#L60))`
readme: Add release notes for version 1.0.5. 2016-05-05 23:35:53 +00:00
readme: Add release notes for version 1.0.4. 2016-02-11 03:15:29 +00:00			`* Version 1.0.4 (2016-02-11)`
Update module url 2022-07-16 22:07:10 +00:00			`- Add API examples to documentation (see [#11](https://git.gammaspectra.live/S.O.N.G/flacgo/issues/11)).`
			`- Extend test cases (see [aadf80a](https://git.gammaspectra.live/S.O.N.G/flacgo/commit/aadf80aa28c463a94b8d5c49757e5a0948613ce2)).`
readme: Add release notes for version 1.0.4. 2016-02-11 03:15:29 +00:00
readme: Add release dates to change history. 2016-02-02 14:13:53 +00:00			`* Version 1.0.3 (2016-02-02)`
Update module url 2022-07-16 22:07:10 +00:00			`- Implement decoding of FLAC files with wasted bits-per-sample (see [#12](https://git.gammaspectra.live/S.O.N.G/flacgo/issues/12)).`
			`- Stress test the library using [go-fuzz](https://github.com/dvyukov/go-fuzz) (see [#10](https://git.gammaspectra.live/S.O.N.G/flacgo/pull/10)). Thanks to [Patrick Mézard](https://github.com/pmezard).`
readme: Add release notes for version 1.0.3. 2016-02-02 14:06:04 +00:00
readme: Add release dates to change history. 2016-02-02 14:13:53 +00:00			`* Version 1.0.2 (2015-06-05)`
Update module url 2022-07-16 22:07:10 +00:00			`- Fix decoding of blocking strategy (see [#9](https://git.gammaspectra.live/S.O.N.G/flacgo/pull/9)). Thanks to [Sergey Didyk](https://github.com/sdidyk).`
readme: Add version 1.0.2 changes. 2015-06-04 22:17:58 +00:00
readme: Add release dates to change history. 2016-02-02 14:13:53 +00:00			`* Version 1.0.1 (2015-02-25)`
Update module url 2022-07-16 22:07:10 +00:00			`- Fix two subframe decoding bugs (see [#7](https://git.gammaspectra.live/S.O.N.G/flacgo/pull/7)). Thanks to [Jonathan MacMillan](https://github.com/perotinus).`
readme: Add v1.0.1 release notes. 2015-01-30 00:47:26 +00:00			`- Add frame decoding test cases.`

readme: Add release dates to change history. 2016-02-02 14:13:53 +00:00			`* Version 1.0.0 (2014-09-30)`
			`- Initial release.`
			`- Implement decoding of FLAC files.`