Moved some documenation into README

This commit is contained in:
Jamie Hardt
2020-11-20 12:12:51 -08:00
parent a53ee23c4d
commit 9de5b16847
2 changed files with 34 additions and 31 deletions

View File

@@ -32,3 +32,35 @@ All of the media for the integration tests is committed to the respository
in either zipped form or is created by ffmpeg. Before you can run tests, in either zipped form or is created by ffmpeg. Before you can run tests,
you need to `cd` into the `tests` directory and run the `create_test_media.sh` you need to `cd` into the `tests` directory and run the `create_test_media.sh`
script. script.
## Resources
### Implementation of Broadcast Wave Files
- [EBU Tech 3285][ebu3285] (May 2011), "Specification of the Broadcast Wave Format (BWF)"
### Implementation of 64-bit Wave Files
- [ITU-R 2088][itu2088] (October 2019), "Long-form file format for the international exchange of audio programme materials with metadata"
- Presently in force, adopted by the EBU in [EBU Tech 3306v2][ebu3306v2] (June 2018).
- [EBU Tech 3306v1][ebu3306v1] (July 2009), "MBWF / RF64: An extended File Format for Audio"
- No longer in force, however long-established.
### Implementation of Wave format `fmt` chunk
- [MSDN WAVEFORMATEX](https://docs.microsoft.com/en-us/windows/win32/api/mmeapi/ns-mmeapi-waveformatex)
- [MSDN WAVEFORMATEXTENSIBLE](https://docs.microsoft.com/en-us/windows/win32/api/mmreg/ns-mmreg-waveformatextensible)
### Other resources
- [RFC 3261][rfc3261] (June 1998) "WAVE and AVI Codec Registries"
- [Peter Kabal, McGill University](http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html)
- [Multimedia Programming Interface and Data Specifications 1.0](http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/Docs/riffmci.pdf)
IBM Corporation and Microsoft Corporation, (August 1991)
[ebu3285]: https://tech.ebu.ch/docs/tech/tech3285.pdf
[ebu3306v1]: https://tech.ebu.ch/docs/tech/tech3306v1_1.pdf
[ebu3306v2]: https://tech.ebu.ch/docs/tech/tech3306.pdf
[itu2088]: https://www.itu.int/dms_pubrec/itu-r/rec/bs/R-REC-BS.2088-1-201910-I!!PDF-E.pdf
[rfc3261]: https://tools.ietf.org/html/rfc2361

View File

@@ -16,36 +16,7 @@ use std::io::{Read, Seek};
/** /**
* Wave, Broadcast-WAV and RF64/BW64 parser/reader. * Wave, Broadcast-WAV and RF64/BW64 parser/reader.
* *
* ## Resources
*
* ### Implementation of Broadcast Wave Files
* - [EBU Tech 3285][ebu3285] (May 2011), "Specification of the Broadcast Wave Format (BWF)"
*
*
* ### Implementation of 64-bit Wave Files
* - [ITU-R 2088][itu2088] (October 2019), "Long-form file format for the international exchange of audio programme materials with metadata"
* - Presently in force, adopted by the EBU in [EBU Tech 3306v2][ebu3306v2] (June 2018).
*
* - [EBU Tech 3306v1][ebu3306v1] (July 2009), "MBWF / RF64: An extended File Format for Audio"
* - No longer in force, however long-established.
*
*
* ### Implementation of Wave format `fmt` chunk
* - [MSDN WAVEFORMATEX](https://docs.microsoft.com/en-us/windows/win32/api/mmeapi/ns-mmeapi-waveformatex)
* - [MSDN WAVEFORMATEXTENSIBLE](https://docs.microsoft.com/en-us/windows/win32/api/mmreg/ns-mmreg-waveformatextensible)
*
*
* ### Other resources
* - [RFC 3261][rfc3261] (June 1998) "WAVE and AVI Codec Registries"
* - [Peter Kabal, McGill University](http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html)
* - [Multimedia Programming Interface and Data Specifications 1.0](http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/Docs/riffmci.pdf)
* IBM Corporation and Microsoft Corporation, (August 1991)
*
* [ebu3285]: https://tech.ebu.ch/docs/tech/tech3285.pdf
* [ebu3306v1]: https://tech.ebu.ch/docs/tech/tech3306v1_1.pdf
* [ebu3306v2]: https://tech.ebu.ch/docs/tech/tech3306.pdf
* [itu2088]: https://www.itu.int/dms_pubrec/itu-r/rec/bs/R-REC-BS.2088-1-201910-I!!PDF-E.pdf
* [rfc3261]: https://tools.ietf.org/html/rfc2361
*/ */
#[derive(Debug)] #[derive(Debug)]
pub struct WaveReader<R: Read + Seek> { pub struct WaveReader<R: Read + Seek> {