修改默认readme文件

This commit is contained in:
yangyudong 2025-04-19 23:17:23 +08:00
parent 34e13c29ff
commit 525022ddba
3 changed files with 133 additions and 133 deletions

112
README.md Executable file → Normal file
View File

@ -1,80 +1,74 @@
# flac # flac
[![Go build status](https://github.com/mewkiz/flac/actions/workflows/go.yml/badge.svg?branch=master)](https://github.com/mewkiz/flac/actions/workflows/go.yml) [![Go构建状态](https://github.com/mewkiz/flac/actions/workflows/go.yml/badge.svg?branch=master)](https://github.com/mewkiz/flac/actions/workflows/go.yml)
[![Coverage Status](https://coveralls.io/repos/github/mewkiz/flac/badge.svg?branch=master)](https://coveralls.io/github/mewkiz/flac?branch=master) [![覆盖状态](https://coveralls.io/repos/github/mewkiz/flac/badge.svg?branch=master)](https://coveralls.io/github/mewkiz/flac?branch=master)
[![GoDoc](https://pkg.go.dev/badge/github.com/mewkiz/flac)](https://pkg.go.dev/github.com/mewkiz/flac) [![GoDoc](https://pkg.go.dev/badge/github.com/mewkiz/flac)](https://pkg.go.dev/github.com/mewkiz/flac)
This package provides access to [FLAC][1] (Free Lossless Audio Codec) streams. 这个包提供对[FLAC](http://flac.sourceforge.net/format.html)(自由无损音频编码)的流访问。
[1]: http://flac.sourceforge.net/format.html ## 文档
## Documentation 文档由GoDoc提供。
Documentation provided by GoDoc. - [flac]提供对FLAC自由无损音频编码流的访问。
- [frame][flac/frame]实现对FLAC音频帧的访问。
- [meta][flac/meta]实现对FLAC元数据块的访问。
- [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://pkg.go.dev/github.com/mewkiz/flac * 版本 1.0.122024-08-11
[flac/frame]: http://pkg.go.dev/github.com/mewkiz/flac/frame - 通过使用缓冲读取器来提高flac.NewSeek()的性能(见[#72](https://github.com/mewkiz/flac/pull/72))。
[flac/meta]: http://pkg.go.dev/github.com/mewkiz/flac/meta - 修复流结束检查中的越界错误(见[#73](https://github.com/mewkiz/flac/pull/73))。
## Changes * 版本 1.0.112024-08-04
- 将示例工具移动到专用的[mewkiz/flac-tools](https://github.com/mewkiz/flac-tools)存储库,以减少外部依赖(见[#62](https://github.com/mewkiz/flac/pull/62))。
- 修复帧起始位置的寻址(见[#71](https://github.com/mewkiz/flac/pull/71))。感谢[Mark Kremer](https://github.com/MarkKremer)。
- 简化flac.Stream和flac.Encoder类型中io.Closer元素的内部处理见[#70](https://github.com/mewkiz/flac/pull/70))。感谢[Mario Salgado](https://github.com/zalgonoise)。
* Version 1.0.12 (2024-08-11) * 版本 1.0.102023-11-11
- Improve performance of flac.NewSeek() by using a buffered reader (see [#72](https://github.com/mewkiz/flac/pull/72)). - 添加对LPC音频样本编码的支持见[#66](https://github.com/mewkiz/flac/pull/66))。感谢[Mark Kremer](https://github.com/MarkKremer)提供的错误修复和[Mattias Wadman](https://github.com/wader)提供的宝贵工具[fq](https://github.com/wader/fq)用于调查FLAC编码问题。
- Fix off-by-one error in Seek end of stream check (see [#73](https://github.com/mewkiz/flac/pull/73)). - 用GitHub Actions替代Travis CI进行CI构建状态、测试状态和代码覆盖率见[#64](https://github.com/mewkiz/flac/pull/64))。感谢[Mark Kremer](https://github.com/MarkKremer)。
* Version 1.0.11 (2024-08-04) * 版本 1.0.92023-10-24
- Move example tools to dedicated [mewkiz/flac-tools](https://github.com/mewkiz/flac-tools) repository to reduce external dependencies (see [#62](https://github.com/mewkiz/flac/pull/62)). - 修复在展开米饭剩余样本时的整数溢出(见[#61](https://github.com/mewkiz/flac/pull/61))。感谢[Mark Kremer](https://github.com/MarkKremer)。
- Fix seek to frame start (see [#71](https://github.com/mewkiz/flac/pull/71)). Thanks to [Mark Kremer](https://github.com/MarkKremer). - 修复转义分区音频样本的解码(见[#60](https://github.com/mewkiz/flac/issues/60))。感谢[Mark Kremer](https://github.com/MarkKremer)。
- Simplify internal handling of io.Closer element in flac.Stream and flac.Encoder types (see [#70](https://github.com/mewkiz/flac/pull/70)). Thanks to [Mario Salgado](https://github.com/zalgonoise). - 处理样本位数不均匀可被8整除的音频帧哈希见[9d50c9e](https://github.com/mewkiz/flac/commit/9d50c9ee99ba322f487ed60442dc16f22b2affb8))。
* Version 1.0.10 (2023-11-11) * 版本 1.0.82023-04-09
- Add support for LPC audio sample encoding (see [#66](https://github.com/mewkiz/flac/pull/66)). Thanks to [Mark Kremer](https://github.com/MarkKremer) for bug fixes and [Mattias Wadman](https://github.com/wader) for the invaluable [fq](https://github.com/wader/fq) tool used to investigate FLAC encoding issues. - 修复读取元数据时的竞争条件(见[#56](https://github.com/mewkiz/flac/pull/56))。感谢[Zach Orosz](https://github.com/zachorosz)。
- Replace Travis CI with GitHub actions for CI build status, test status and code coverage [#64](https://github.com/mewkiz/flac/pull/64)). Thanks to [Mark Kremer](https://github.com/MarkKremer). - 修复8-bps WAV音频样本的编码见[#52](https://github.com/mewkiz/flac/pull/52))。感谢[Martijn van Beurden](https://github.com/ktmf01)。
- 修复StreamInfo块类型错误信息见[#49](https://github.com/mewkiz/flac/pull/49))。
* Version 1.0.9 (2023-10-24) * 版本 1.0.72021-01-28
- Fix integer overflow during unfolding of rice residual (see [#61](https://github.com/mewkiz/flac/pull/61)). Thanks to [Mark Kremer](https://github.com/MarkKremer). - 添加寻址API见[#44](https://github.com/mewkiz/flac/pull/44)和[#46](https://github.com/mewkiz/flac/pull/46))。感谢[Craig Swank](https://github.com/cswank)。
- Fix decoding of escaped partition audio samples (see [#60](https://github.com/mewkiz/flac/issues/60)). Thanks to [Mark Kremer](https://github.com/MarkKremer).
- Handle frame hashing of audio samples with bits-per-sample not evenly divisible by 8 (see [9d50c9e](https://github.com/mewkiz/flac/commit/9d50c9ee99ba322f487ed60442dc16f22b2affb8)).
* Version 1.0.8 (2023-04-09) * 版本 1.0.62019-12-20
- Fix race condition when reading meta data (see [#56](https://github.com/mewkiz/flac/pull/56)). Thanks to [Zach Orosz](https://github.com/zachorosz). - 添加实验性的Encoder API以编码音频样本和元数据块见[#32](https://github.com/mewkiz/flac/pull/32))。
- Fix encoding of 8-bps WAV audio samples (see [#52](https://github.com/mewkiz/flac/pull/52)). Thanks to [Martijn van Beurden](https://github.com/ktmf01). - 使用go.mod。
- Fix StreamInfo block type error message (see [#49](https://github.com/mewkiz/flac/pull/49)). - 在解析时跳过添加到flac文件前的ID3v2数据见[36cc17e](https://github.com/mewkiz/flac/commit/36cc17efed51a9bae283d6a3a7a10997492945e7))。
- 删除对encodebytes的依赖。感谢[Mikey Dickerson](https://github.com/mdickers47)。
- 添加16kHz测试用例。感谢[Chewxy](https://github.com/chewxy)。
- 修复lint问题见[#25](https://github.com/mewkiz/flac/issues/25))。
* Version 1.0.7 (2021-01-28) * 版本 1.0.52016-05-06
- Add seek API (see [#44](https://github.com/mewkiz/flac/pull/44) and [#46](https://github.com/mewkiz/flac/pull/46)). Thanks to [Craig Swank](https://github.com/cswank). - 简化导入路径。放弃使用gopkg.in改为依赖于包装见[azul3d/engine#1](https://github.com/azul3d/engine/issues/1))。
- 添加FLAC解码基准测试见[d675e0a](https://github.com/mewkiz/flac/blob/d675e0aaccf2e43055f56b9b3feeddfdeed402e2/frame/frame_test.go#L60))。
* Version 1.0.6 (2019-12-20) * 版本 1.0.42016-02-11
- Add experimental Encoder API to encode audio samples and metadata blocks (see [#32](https://github.com/mewkiz/flac/pull/32)). - 在文档中添加API示例见[#11](https://github.com/mewkiz/flac/issues/11))。
- Use go.mod. - 扩展测试用例(见[aadf80a](https://github.com/mewkiz/flac/commit/aadf80aa28c463a94b8d5c49757e5a0948613ce2))。
- Skip ID3v2 data prepended to flac files when parsing (see [36cc17e](https://github.com/mewkiz/flac/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://github.com/mewkiz/flac/issues/25)).
* Version 1.0.5 (2016-05-06) * 版本 1.0.32016-02-02
- Simplify import paths. Drop use of gopkg.in, and rely on vendoring instead (see [azul3d/engine#1](https://github.com/azul3d/engine/issues/1)). - 实现FLAC文件的解码不浪费样本位数见[#12](https://github.com/mewkiz/flac/issues/12))。
- Add FLAC decoding benchmark (see [d675e0a](https://github.com/mewkiz/flac/blob/d675e0aaccf2e43055f56b9b3feeddfdeed402e2/frame/frame_test.go#L60)). - 使用[go-fuzz](https://github.com/dvyukov/go-fuzz)对库进行压力测试(见[#10](https://github.com/mewkiz/flac/pull/10))。感谢[Patrick Mézard](https://github.com/pmezard)。
* Version 1.0.4 (2016-02-11) * 版本 1.0.22015-06-05
- Add API examples to documentation (see [#11](https://github.com/mewkiz/flac/issues/11)). - 修复阻塞策略的解码(见[#9](https://github.com/mewkiz/flac/pull/9))。感谢[Sergey Didyk](https://github.com/sdidyk)。
- Extend test cases (see [aadf80a](https://github.com/mewkiz/flac/commit/aadf80aa28c463a94b8d5c49757e5a0948613ce2)).
* Version 1.0.3 (2016-02-02) * 版本 1.0.12015-02-25
- Implement decoding of FLAC files with wasted bits-per-sample (see [#12](https://github.com/mewkiz/flac/issues/12)). - 修复两个子帧解码的错误(见[#7](https://github.com/mewkiz/flac/pull/7))。感谢[Jonathan MacMillan](https://github.com/perotinus)。
- Stress test the library using [go-fuzz](https://github.com/dvyukov/go-fuzz) (see [#10](https://github.com/mewkiz/flac/pull/10)). Thanks to [Patrick Mézard](https://github.com/pmezard). - 添加帧解码测试用例。
* Version 1.0.2 (2015-06-05) * 版本 1.0.02014-09-30
- Fix decoding of blocking strategy (see [#9](https://github.com/mewkiz/flac/pull/9)). Thanks to [Sergey Didyk](https://github.com/sdidyk). - 初次发布。
- 实现FLAC文件的解码。
* Version 1.0.1 (2015-02-25)
- Fix two subframe decoding bugs (see [#7](https://github.com/mewkiz/flac/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.

View File

@ -1,74 +0,0 @@
# flac
[![Go构建状态](https://github.com/mewkiz/flac/actions/workflows/go.yml/badge.svg?branch=master)](https://github.com/mewkiz/flac/actions/workflows/go.yml)
[![覆盖状态](https://coveralls.io/repos/github/mewkiz/flac/badge.svg?branch=master)](https://coveralls.io/github/mewkiz/flac?branch=master)
[![GoDoc](https://pkg.go.dev/badge/github.com/mewkiz/flac)](https://pkg.go.dev/github.com/mewkiz/flac)
这个包提供对[FLAC](http://flac.sourceforge.net/format.html)(自由无损音频编码)的流访问。
## 文档
文档由GoDoc提供。
- [flac]提供对FLAC自由无损音频编码流的访问。
- [frame][flac/frame]实现对FLAC音频帧的访问。
- [meta][flac/meta]实现对FLAC元数据块的访问。
## 更改记录
* 版本 1.0.122024-08-11
- 通过使用缓冲读取器来提高flac.NewSeek()的性能(见[#72](https://github.com/mewkiz/flac/pull/72))。
- 修复流结束检查中的越界错误(见[#73](https://github.com/mewkiz/flac/pull/73))。
* 版本 1.0.112024-08-04
- 将示例工具移动到专用的[mewkiz/flac-tools](https://github.com/mewkiz/flac-tools)存储库,以减少外部依赖(见[#62](https://github.com/mewkiz/flac/pull/62))。
- 修复帧起始位置的寻址(见[#71](https://github.com/mewkiz/flac/pull/71))。感谢[Mark Kremer](https://github.com/MarkKremer)。
- 简化flac.Stream和flac.Encoder类型中io.Closer元素的内部处理见[#70](https://github.com/mewkiz/flac/pull/70))。感谢[Mario Salgado](https://github.com/zalgonoise)。
* 版本 1.0.102023-11-11
- 添加对LPC音频样本编码的支持见[#66](https://github.com/mewkiz/flac/pull/66))。感谢[Mark Kremer](https://github.com/MarkKremer)提供的错误修复和[Mattias Wadman](https://github.com/wader)提供的宝贵工具[fq](https://github.com/wader/fq)用于调查FLAC编码问题。
- 用GitHub Actions替代Travis CI进行CI构建状态、测试状态和代码覆盖率见[#64](https://github.com/mewkiz/flac/pull/64))。感谢[Mark Kremer](https://github.com/MarkKremer)。
* 版本 1.0.92023-10-24
- 修复在展开米饭剩余样本时的整数溢出(见[#61](https://github.com/mewkiz/flac/pull/61))。感谢[Mark Kremer](https://github.com/MarkKremer)。
- 修复转义分区音频样本的解码(见[#60](https://github.com/mewkiz/flac/issues/60))。感谢[Mark Kremer](https://github.com/MarkKremer)。
- 处理样本位数不均匀可被8整除的音频帧哈希见[9d50c9e](https://github.com/mewkiz/flac/commit/9d50c9ee99ba322f487ed60442dc16f22b2affb8))。
* 版本 1.0.82023-04-09
- 修复读取元数据时的竞争条件(见[#56](https://github.com/mewkiz/flac/pull/56))。感谢[Zach Orosz](https://github.com/zachorosz)。
- 修复8-bps WAV音频样本的编码见[#52](https://github.com/mewkiz/flac/pull/52))。感谢[Martijn van Beurden](https://github.com/ktmf01)。
- 修复StreamInfo块类型错误信息见[#49](https://github.com/mewkiz/flac/pull/49))。
* 版本 1.0.72021-01-28
- 添加寻址API见[#44](https://github.com/mewkiz/flac/pull/44)和[#46](https://github.com/mewkiz/flac/pull/46))。感谢[Craig Swank](https://github.com/cswank)。
* 版本 1.0.62019-12-20
- 添加实验性的Encoder API以编码音频样本和元数据块见[#32](https://github.com/mewkiz/flac/pull/32))。
- 使用go.mod。
- 在解析时跳过添加到flac文件前的ID3v2数据见[36cc17e](https://github.com/mewkiz/flac/commit/36cc17efed51a9bae283d6a3a7a10997492945e7))。
- 删除对encodebytes的依赖。感谢[Mikey Dickerson](https://github.com/mdickers47)。
- 添加16kHz测试用例。感谢[Chewxy](https://github.com/chewxy)。
- 修复lint问题见[#25](https://github.com/mewkiz/flac/issues/25))。
* 版本 1.0.52016-05-06
- 简化导入路径。放弃使用gopkg.in改为依赖于包装见[azul3d/engine#1](https://github.com/azul3d/engine/issues/1))。
- 添加FLAC解码基准测试见[d675e0a](https://github.com/mewkiz/flac/blob/d675e0aaccf2e43055f56b9b3feeddfdeed402e2/frame/frame_test.go#L60))。
* 版本 1.0.42016-02-11
- 在文档中添加API示例见[#11](https://github.com/mewkiz/flac/issues/11))。
- 扩展测试用例(见[aadf80a](https://github.com/mewkiz/flac/commit/aadf80aa28c463a94b8d5c49757e5a0948613ce2))。
* 版本 1.0.32016-02-02
- 实现FLAC文件的解码不浪费样本位数见[#12](https://github.com/mewkiz/flac/issues/12))。
- 使用[go-fuzz](https://github.com/dvyukov/go-fuzz)对库进行压力测试(见[#10](https://github.com/mewkiz/flac/pull/10))。感谢[Patrick Mézard](https://github.com/pmezard)。
* 版本 1.0.22015-06-05
- 修复阻塞策略的解码(见[#9](https://github.com/mewkiz/flac/pull/9))。感谢[Sergey Didyk](https://github.com/sdidyk)。
* 版本 1.0.12015-02-25
- 修复两个子帧解码的错误(见[#7](https://github.com/mewkiz/flac/pull/7))。感谢[Jonathan MacMillan](https://github.com/perotinus)。
- 添加帧解码测试用例。
* 版本 1.0.02014-09-30
- 初次发布。
- 实现FLAC文件的解码。

80
README_EN.md Executable file
View File

@ -0,0 +1,80 @@
# flac
[![Go build status](https://github.com/mewkiz/flac/actions/workflows/go.yml/badge.svg?branch=master)](https://github.com/mewkiz/flac/actions/workflows/go.yml)
[![Coverage Status](https://coveralls.io/repos/github/mewkiz/flac/badge.svg?branch=master)](https://coveralls.io/github/mewkiz/flac?branch=master)
[![GoDoc](https://pkg.go.dev/badge/github.com/mewkiz/flac)](https://pkg.go.dev/github.com/mewkiz/flac)
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://pkg.go.dev/github.com/mewkiz/flac
[flac/frame]: http://pkg.go.dev/github.com/mewkiz/flac/frame
[flac/meta]: http://pkg.go.dev/github.com/mewkiz/flac/meta
## Changes
* Version 1.0.12 (2024-08-11)
- Improve performance of flac.NewSeek() by using a buffered reader (see [#72](https://github.com/mewkiz/flac/pull/72)).
- Fix off-by-one error in Seek end of stream check (see [#73](https://github.com/mewkiz/flac/pull/73)).
* Version 1.0.11 (2024-08-04)
- Move example tools to dedicated [mewkiz/flac-tools](https://github.com/mewkiz/flac-tools) repository to reduce external dependencies (see [#62](https://github.com/mewkiz/flac/pull/62)).
- Fix seek to frame start (see [#71](https://github.com/mewkiz/flac/pull/71)). Thanks to [Mark Kremer](https://github.com/MarkKremer).
- Simplify internal handling of io.Closer element in flac.Stream and flac.Encoder types (see [#70](https://github.com/mewkiz/flac/pull/70)). Thanks to [Mario Salgado](https://github.com/zalgonoise).
* Version 1.0.10 (2023-11-11)
- Add support for LPC audio sample encoding (see [#66](https://github.com/mewkiz/flac/pull/66)). Thanks to [Mark Kremer](https://github.com/MarkKremer) for bug fixes and [Mattias Wadman](https://github.com/wader) for the invaluable [fq](https://github.com/wader/fq) tool used to investigate FLAC encoding issues.
- Replace Travis CI with GitHub actions for CI build status, test status and code coverage [#64](https://github.com/mewkiz/flac/pull/64)). Thanks to [Mark Kremer](https://github.com/MarkKremer).
* Version 1.0.9 (2023-10-24)
- Fix integer overflow during unfolding of rice residual (see [#61](https://github.com/mewkiz/flac/pull/61)). Thanks to [Mark Kremer](https://github.com/MarkKremer).
- Fix decoding of escaped partition audio samples (see [#60](https://github.com/mewkiz/flac/issues/60)). Thanks to [Mark Kremer](https://github.com/MarkKremer).
- Handle frame hashing of audio samples with bits-per-sample not evenly divisible by 8 (see [9d50c9e](https://github.com/mewkiz/flac/commit/9d50c9ee99ba322f487ed60442dc16f22b2affb8)).
* Version 1.0.8 (2023-04-09)
- Fix race condition when reading meta data (see [#56](https://github.com/mewkiz/flac/pull/56)). Thanks to [Zach Orosz](https://github.com/zachorosz).
- Fix encoding of 8-bps WAV audio samples (see [#52](https://github.com/mewkiz/flac/pull/52)). Thanks to [Martijn van Beurden](https://github.com/ktmf01).
- Fix StreamInfo block type error message (see [#49](https://github.com/mewkiz/flac/pull/49)).
* Version 1.0.7 (2021-01-28)
- Add seek API (see [#44](https://github.com/mewkiz/flac/pull/44) and [#46](https://github.com/mewkiz/flac/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://github.com/mewkiz/flac/pull/32)).
- Use go.mod.
- Skip ID3v2 data prepended to flac files when parsing (see [36cc17e](https://github.com/mewkiz/flac/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://github.com/mewkiz/flac/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://github.com/mewkiz/flac/blob/d675e0aaccf2e43055f56b9b3feeddfdeed402e2/frame/frame_test.go#L60)).
* Version 1.0.4 (2016-02-11)
- Add API examples to documentation (see [#11](https://github.com/mewkiz/flac/issues/11)).
- Extend test cases (see [aadf80a](https://github.com/mewkiz/flac/commit/aadf80aa28c463a94b8d5c49757e5a0948613ce2)).
* Version 1.0.3 (2016-02-02)
- Implement decoding of FLAC files with wasted bits-per-sample (see [#12](https://github.com/mewkiz/flac/issues/12)).
- Stress test the library using [go-fuzz](https://github.com/dvyukov/go-fuzz) (see [#10](https://github.com/mewkiz/flac/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://github.com/mewkiz/flac/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://github.com/mewkiz/flac/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.