Made all documentation links internal.

Added reference documentation
This commit is contained in:
Jamie Hardt
2022-11-26 19:54:00 -08:00
parent cf39d19ef2
commit 391a97d39a
3 changed files with 54 additions and 13 deletions

View File

@@ -10,13 +10,13 @@ The `wavinfo` package allows you to probe WAVE and [RF64/WAVE files][eburf64] an
`wavinfo` reads:
* [__Broadcast-WAVE__][ebu] metadata, including embedded program
loudness, coding history and [__SMPTE UMID__][smpte_330m2011].
* [__ADM__][adm] track metadata and schema, including channel, pack formats, object, content and programme.
* [__Dolby Digital Plus__][ebu3285s6] and Dolby Atmos `dbmd` metadata.
* [__iXML__][ixml] production recorder metadata, including project, scene, and take tags, recorder notes
* [Broadcast-WAVE][bext] metadata, including embedded program
loudness, coding history and [SMPTE UMID][smpte_330m2011].
* [ADM][adm] track metadata and schema, including channel, pack formats, object, content and programme.
* [Dolby Digital Plus][ebu3285s6] and Dolby Atmos `dbmd` metadata.
* [iXML][ixml] production recorder metadata, including project, scene, and take tags, recorder notes
and file family information.
* Most of the common [__RIFF INFO__][info-tags] metadata fields.
* Most of the common [RIFF INFO][info-tags] metadata fields.
* The __wav format__ is also parsed, so you can access the basic sample rate and channel count
information.
@@ -24,13 +24,14 @@ In progress:
* Pro Tools __embedded regions__.
* iXML `STEINBERG` sound library attributes.
[ebu]:https://tech.ebu.ch/docs/tech/tech3285.pdf
[ebu3285s6]:https://tech.ebu.ch/docs/tech/tech3285s6.pdf
[adm]:https://www.itu.int/dms_pubrec/itu-r/rec/bs/R-REC-BS.2076-2-201910-I!!PDF-E.pdf
[smpte_330m2011]:http://standards.smpte.org/content/978-1-61482-678-1/st-330-2011/SEC1.abstract
[ixml]:http://www.ixml.info
[bext]:https://wavinfo.readthedocs.io/en/latest/scopes/bext.html
[smpte_330m2011]:https://wavinfo.readthedocs.io/en/latest/scopes/bext.html#wavinfo.wave_bext_reader.WavBextReader.umid
[adm]:https://wavinfo.readthedocs.io/en/latest/scopes/adm.html
[ebu3285s6]:https://wavinfo.readthedocs.io/en/latest/scopes/dolby.html
[ixml]:https://wavinfo.readthedocs.io/en/latest/scopes/ixml.html
[info-tags]:https://wavinfo.readthedocs.io/en/latest/scopes/info.html
[eburf64]:https://tech.ebu.ch/docs/tech/tech3306v1_1.pdf
[info-tags]:https://exiftool.org/TagNames/RIFF.html#Info
## How To Use

View File

@@ -19,8 +19,8 @@ music production metadata.
quickstart
command_line
scopes/*
classes
references
Indices and tables

View File

@@ -0,0 +1,40 @@
References
==========
Broadcast Wave Format
---------------------
* `bext<EBU Tech 3285>`
Audio Definition Model
----------------------
* `adm<ITU Recommendation BS.2076-2-2019>`
Dolby
-----
* `ebu3285s6<EBU Tech 3285 Supplement 6: Dolby Metadata>`
* `Dolby Atmos ADM Profile`_
iXML
----
* `ixml<iXML Specification>`
RIFF INFO
---------
* `infotags<Exiftool Documentation>`
.. _Dolby Atmos ADM Profile: https://developer.dolby.com/globalassets/documentation/technology/dolby_atmos_master_adm_profile_v1.0.pdf
.. _bext: https://tech.ebu.ch/docs/tech/tech3285.pdf
.. _adm: https://www.itu.int/dms_pubrec/itu-r/rec/bs/R-REC-BS.2076-2-201910-I!!PDF-E.pdf
.. _ebu3285s6: https://tech.ebu.ch/docs/tech/tech3285s6.pdf
.. _smpte_330m2011: http://standards.smpte.org/content/978-1-61482-678-1/st-330-2011/SEC1.abstract
.. _ixml: http://www.gallery.co.uk/ixml/
.. _eburf64: https://tech.ebu.ch/docs/tech/tech3306v1_1.pdf
.. _infotags: https://exiftool.org/TagNames/RIFF.html#Info