diff --git a/docs/dev/id3.rst b/docs/dev/id3.rst new file mode 100644 index 00000000..e73cc90c --- /dev/null +++ b/docs/dev/id3.rst @@ -0,0 +1,37 @@ +ID3 +=== + +`ID3 Website `__ + +ID3v2.4.0: + * `ID3v2.4.0 Main Structure `__ + * `ID3v2.4.0 Native Frames `__ + * `ID3v2.4.0 Changes `__ + +ID3v2.3.0: + * `ID3v2.3.0 Informal standard `__ + * `ID3v2 Programming Guidlines `__ + +ID3v2.2.0: + * `ID3v2.2.0 Informal standard `__ + +Additional standards: + * `ID3v2 Chapter Frame Addendum v1.0 `__ + * `ID3v2 Accessibility Addendum v1.0 `__ + + +Mutagen Implementation Details +------------------------------ + +* We don't interpret or write the "ID3v2 extended header". An existing extended + header gets removed when saving the tags. + + * https://github.com/quodlibet/mutagen/pull/631#issuecomment-1742118078 + +* We don't support appended tags. They will neither be found nor updated. + + * https://github.com/quodlibet/mutagen/issues/78 + +* We always NULL-terminate multivalue text frames and ignore them when parsing + + * https://github.com/quodlibet/mutagen/issues/379#issuecomment-486852503 diff --git a/docs/dev/index.rst b/docs/dev/index.rst new file mode 100644 index 00000000..ef2d3a4c --- /dev/null +++ b/docs/dev/index.rst @@ -0,0 +1,8 @@ +Developer Guide +=============== + +.. toctree:: + :titlesonly: + :maxdepth: 2 + + id3 diff --git a/docs/index.rst b/docs/index.rst index baea49b0..15c88f27 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,6 +13,7 @@ user/index api/index man/index + dev/index contact .. title:: Overview