tocparser 0.1.0__tar.gz

tocparser-0.1.0/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Jean-Marc Fontaine
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tocparser-0.1.0/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: tocparser
+Version: 0.1.0
+Summary: Parse, validate, and write cdrdao CD TOC files
+Keywords: audio,cd,cd-text,cdrdao,parser,toc
+Author: Jean-Marc Fontaine
+Author-email: Jean-Marc Fontaine <jm@jmfontaine.net>
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Multimedia :: Sound/Audio :: CD Audio
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: lark>=1.2
+Requires-Dist: pydantic>=2.9
+Requires-Dist: pydantic>=2.14.0b1,<2.15 ; python_full_version == '3.15.*'
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# tocparser
+
+tocparser parses cdrdao's TOC files into Pydantic models and writes them back out.
+
+- It supports the full TOC format. Older files mostly parse the same, with two
+  exceptions described below.
+- It validates files like cdrdao, matching its error messages and line numbers. See
+  Limits for exceptions.
+- Writing preserves every value. Unedited files usually serialize byte for byte
+  identically, though hand-written comments are dropped and some formatting is
+  normalized. See What Is Written Back for details.
+- It is fully typed and depends only on `lark` and `pydantic`.
+
+## Install
+
+```
+uv add tocparser
+```
+
+Requires Python 3.10 or newer.
+
+## Usage
+
+```python
+from tocparser import dump, parse_file
+
+toc = parse_file("the_downward_spiral.toc")
+
+toc.disc_type                    # <DiscType.CD_DA: 'CD_DA'>
+toc.catalog                      # '0602498647295'
+toc.cd_text[0].title             # 'The Downward Spiral - Deluxe Edition [ Disc 1 ] '
+toc.cd_text[0].performer         # 'Nine Inch Nails'
+
+track = toc.tracks[4]
+track.mode                       # <TrackMode.AUDIO: 'AUDIO'>
+track.isrc                       # 'USIR19400529'
+track.cd_text[0].title           # 'Closer'
+track.content[0].start           # Msf(minutes=15, seconds=47, frames=32)
+track.content[0].length          # Msf(minutes=6, seconds=13, frames=23)
+
+# "The Becoming" starts with a 00:02:30 pre-gap: 2 seconds and 30 frames.
+toc.tracks[6].start              # Start(kind='start', position=Msf(minutes=0, seconds=2, frames=30))
+```
+
+Models are ordinary Pydantic models, so `model_dump()`, `model_dump_json()` and
+`Toc.model_validate_json()` all work and preserve the parsed values.
+
+### Times
+
+A position or length can be written as `MM:SS:FF`, where frames are counted at 75 per
+second, or as a bare integer representing samples on an audio track and bytes on a data
+track. These formats are not interchangeable. If a sample count is not frame-aligned, it
+has no `MM:SS:FF` equivalent, so tocparser preserves the format in which it was written.
+Frame-based values become `Msf`, while bare integers remain `int`.
+
+```python
+from tocparser import Msf
+
+position = Msf(15, 47, 32)       # where "Closer" starts
+position.total_frames            # 71057
+position.to_samples()            # 41781516
+position.to_bytes(2352)          # 167126064
+str(position)                    # '15:47:32'
+Msf.from_frames(71057)           # Msf(minutes=15, seconds=47, frames=32)
+```
+
+`Msf` is ordered and hashable, so positions sort and can be used as keys.
+
+### CD-TEXT
+
+CD-TEXT values are `str`, or `list[int]` for binary packs. Each language block uses
+ISO-8859-1 unless the disc's `CD_TEXT` specifies an `ENCODING_*` value. Track blocks
+follow the disc block with the same number, as they do in cdrdao.
+`toc.cd_text_encoding(n)` returns the encoding used for block `n`.
+
+Strings follow cdrdao's rules. Non-ASCII text is UTF-8 and must fit the block's
+encoding: `TITLE "日本"` requires `ENCODING_MS_JIS`, because ISO-8859-1 cannot represent
+Japanese. Plain ASCII strings may contain `\NNN` octal escapes, which represent bytes in
+the block's encoding. For example, `"caf\351"` decodes to `'café'`, and under
+`ENCODING_MS_JIS`, `"\223\372\226\173"` decodes to `'日本'`.
+
+cdrdao treats `UPC_EAN` and `ISRC` as the same pack, as well as `RESERVED4` and
+`CLOSED`. A block retains the spelling written last, and `block.upc_ean` and
+`block.isrc` both access it.
+
+### Errors
+
+```python
+from tocparser import TocParseError, TocValidationError, parse
+
+parse(
+    'CD_DA\nCATALOG "0602498647"\nTRACK AUDIO\nFILE "hurt.wav" 0\n',
+    filename="the_downward_spiral.toc",
+)
+# TocValidationError: the_downward_spiral.toc:2: Illegal catalog number: 0602498647.
+```
+
+`TocParseError` covers syntax errors and `TocValidationError` covers input that parses
+but breaks a rule cdrdao enforces. Both derive from `TocError` and carry `line`, and
+`TocParseError` also carries `column`. `parse_file` reads files as UTF-8 and raises
+`TocParseError` for bytes that do not decode; pass `encoding=` for other encodings.
+
+The models enforce the same rules, so building one by hand that cdrdao would reject
+raises `TocValidationError`, whose `loc` locates the problem inside that model, e.g.
+`("statements", 2)`. A value cdrdao's syntax cannot express, such as a value of the
+wrong type or a negative number, raises Pydantic's `ValidationError` instead. Models can
+be changed after they are built, so `dumps` validates its argument again before writing
+it.
+
+## What Is Written Back
+
+Serializing preserves meaning, though not always the exact bytes. In practice, the
+output is usually byte-for-byte identical. Differences are limited to the following:
+
+- Hand-written comments are dropped. cdrdao-generated comments—the `// Track N` headers
+  and the `// length in bytes:` annotations on data lengths—are regenerated.
+- `MM:SS:FF` values are zero-padded: `0:10:0` becomes `00:10:00`. Bare integers remain
+  unchanged.
+- When a CD-TEXT item appears more than once, only its last instance is written. An
+  empty string does not replace an earlier value because cdrdao drops it. Repeated
+  LANGUAGE blocks are merged into the first, as in cdrdao's output.
+- Text is written as UTF-8, so `\NNN` escapes are replaced by the characters they
+  represent. A backslash followed by three digits is written as `\134`, because cdrdao
+  would interpret even an escaped backslash as an octal escape. cdrdao does not accept
+  escapes in non-ASCII text, so such text cannot contain that sequence; `dumps` raises
+  an error if it does.
+- Unwritten flags are not added. A track without a `COPY` line keeps
+  `copy_permitted is None` and has no `COPY` line in the output. The effective values
+  are available through `is_copy_permitted`, `has_pre_emphasis`, and `channel_count`.
+
+## Limits
+
+tocparser follows cdrdao 1.2.6, but some checks require the audio and data files
+referenced by a TOC file. Because tocparser reads only the TOC file, it cannot check the
+four-second minimum track length, an `INDEX` beyond the track end, `START` or `END` past
+the track end, an `END` within the pre-gap, or a requested length that exceeds the file.
+It also skips the CD-TEXT completeness checks that cdrdao performs only before writing a
+disc. tocparser checks everything else that `cdrdao show-toc` checks, with these
+differences:
+
+- If a file contains several errors, tocparser raises one, but not necessarily the one
+  cdrdao reports first.
+- For two syntax errors—a `PREGAP` after track data and a `LANGUAGE_MAP` inside a
+  track's `CD_TEXT`—cdrdao's parser stops at a different token than tocparser does.
+- cdrdao reports a `FIFO` that mixes audio and data on line 0; tocparser reports the
+  `FIFO`'s own line.
+- tocparser rejects `\NNN` bytes that are not text in their block's encoding—for
+  example, a lone CP932 lead byte or a byte above 127 in an `ENCODING_ASCII` block.
+  cdrdao keeps these bytes, at most issuing a warning, but could not read back the text
+  it would write for them.
+- cdrdao drops CD-TEXT items with empty strings. tocparser preserves an empty item when
+  no other value is provided and writes it back. Like cdrdao, it also allows a track to
+  contain an empty item that is valid only at the disc level.
+- Escapes in file names are decoded like CD-TEXT (as ISO-8859-1) and written back as
+  UTF-8.
+
+## TOC Files from Older cdrdao
+
+Files written by cdrdao 1.2.2 through 1.2.4 are mostly read the same way, with two
+exceptions that also apply to later releases. Releases before 1.2.2 were not checked.
+
+- cdrdao 1.2.2 through 1.2.4 wrote backslashes in strings unchanged. Since 1.2.5, a
+  backslash must begin an escape, so `"AC\DC"` is rejected with `Illegal token: \`, and
+  `"C:\\x"` now reads as `C:\x`, with one backslash rather than two. This applies to all
+  strings, including file names.
+- cdrdao 1.2.2 through 1.2.4 wrote bytes above 127 as octal escapes, at least under the
+  default C locale, and omitted `ENCODING_*`, so the text is read as ISO-8859-1. Latin
+  text remains intact, but text in another encoding, such as Japanese, does not.
+
+## Contributing
+
+Contributions are welcome. See CONTRIBUTING.md for development setup, test comparisons
+between tocparser and cdrdao, and the pull request process.
+
+## License
+
+tocparser is licensed under the Apache License 2.0.

tocparser-0.1.0/README.md

@@ -0,0 +1,177 @@
+# tocparser
+
+tocparser parses cdrdao's TOC files into Pydantic models and writes them back out.
+
+- It supports the full TOC format. Older files mostly parse the same, with two
+  exceptions described below.
+- It validates files like cdrdao, matching its error messages and line numbers. See
+  Limits for exceptions.
+- Writing preserves every value. Unedited files usually serialize byte for byte
+  identically, though hand-written comments are dropped and some formatting is
+  normalized. See What Is Written Back for details.
+- It is fully typed and depends only on `lark` and `pydantic`.
+
+## Install
+
+```
+uv add tocparser
+```
+
+Requires Python 3.10 or newer.
+
+## Usage
+
+```python
+from tocparser import dump, parse_file
+
+toc = parse_file("the_downward_spiral.toc")
+
+toc.disc_type                    # <DiscType.CD_DA: 'CD_DA'>
+toc.catalog                      # '0602498647295'
+toc.cd_text[0].title             # 'The Downward Spiral - Deluxe Edition [ Disc 1 ] '
+toc.cd_text[0].performer         # 'Nine Inch Nails'
+
+track = toc.tracks[4]
+track.mode                       # <TrackMode.AUDIO: 'AUDIO'>
+track.isrc                       # 'USIR19400529'
+track.cd_text[0].title           # 'Closer'
+track.content[0].start           # Msf(minutes=15, seconds=47, frames=32)
+track.content[0].length          # Msf(minutes=6, seconds=13, frames=23)
+
+# "The Becoming" starts with a 00:02:30 pre-gap: 2 seconds and 30 frames.
+toc.tracks[6].start              # Start(kind='start', position=Msf(minutes=0, seconds=2, frames=30))
+```
+
+Models are ordinary Pydantic models, so `model_dump()`, `model_dump_json()` and
+`Toc.model_validate_json()` all work and preserve the parsed values.
+
+### Times
+
+A position or length can be written as `MM:SS:FF`, where frames are counted at 75 per
+second, or as a bare integer representing samples on an audio track and bytes on a data
+track. These formats are not interchangeable. If a sample count is not frame-aligned, it
+has no `MM:SS:FF` equivalent, so tocparser preserves the format in which it was written.
+Frame-based values become `Msf`, while bare integers remain `int`.
+
+```python
+from tocparser import Msf
+
+position = Msf(15, 47, 32)       # where "Closer" starts
+position.total_frames            # 71057
+position.to_samples()            # 41781516
+position.to_bytes(2352)          # 167126064
+str(position)                    # '15:47:32'
+Msf.from_frames(71057)           # Msf(minutes=15, seconds=47, frames=32)
+```
+
+`Msf` is ordered and hashable, so positions sort and can be used as keys.
+
+### CD-TEXT
+
+CD-TEXT values are `str`, or `list[int]` for binary packs. Each language block uses
+ISO-8859-1 unless the disc's `CD_TEXT` specifies an `ENCODING_*` value. Track blocks
+follow the disc block with the same number, as they do in cdrdao.
+`toc.cd_text_encoding(n)` returns the encoding used for block `n`.
+
+Strings follow cdrdao's rules. Non-ASCII text is UTF-8 and must fit the block's
+encoding: `TITLE "日本"` requires `ENCODING_MS_JIS`, because ISO-8859-1 cannot represent
+Japanese. Plain ASCII strings may contain `\NNN` octal escapes, which represent bytes in
+the block's encoding. For example, `"caf\351"` decodes to `'café'`, and under
+`ENCODING_MS_JIS`, `"\223\372\226\173"` decodes to `'日本'`.
+
+cdrdao treats `UPC_EAN` and `ISRC` as the same pack, as well as `RESERVED4` and
+`CLOSED`. A block retains the spelling written last, and `block.upc_ean` and
+`block.isrc` both access it.
+
+### Errors
+
+```python
+from tocparser import TocParseError, TocValidationError, parse
+
+parse(
+    'CD_DA\nCATALOG "0602498647"\nTRACK AUDIO\nFILE "hurt.wav" 0\n',
+    filename="the_downward_spiral.toc",
+)
+# TocValidationError: the_downward_spiral.toc:2: Illegal catalog number: 0602498647.
+```
+
+`TocParseError` covers syntax errors and `TocValidationError` covers input that parses
+but breaks a rule cdrdao enforces. Both derive from `TocError` and carry `line`, and
+`TocParseError` also carries `column`. `parse_file` reads files as UTF-8 and raises
+`TocParseError` for bytes that do not decode; pass `encoding=` for other encodings.
+
+The models enforce the same rules, so building one by hand that cdrdao would reject
+raises `TocValidationError`, whose `loc` locates the problem inside that model, e.g.
+`("statements", 2)`. A value cdrdao's syntax cannot express, such as a value of the
+wrong type or a negative number, raises Pydantic's `ValidationError` instead. Models can
+be changed after they are built, so `dumps` validates its argument again before writing
+it.
+
+## What Is Written Back
+
+Serializing preserves meaning, though not always the exact bytes. In practice, the
+output is usually byte-for-byte identical. Differences are limited to the following:
+
+- Hand-written comments are dropped. cdrdao-generated comments—the `// Track N` headers
+  and the `// length in bytes:` annotations on data lengths—are regenerated.
+- `MM:SS:FF` values are zero-padded: `0:10:0` becomes `00:10:00`. Bare integers remain
+  unchanged.
+- When a CD-TEXT item appears more than once, only its last instance is written. An
+  empty string does not replace an earlier value because cdrdao drops it. Repeated
+  LANGUAGE blocks are merged into the first, as in cdrdao's output.
+- Text is written as UTF-8, so `\NNN` escapes are replaced by the characters they
+  represent. A backslash followed by three digits is written as `\134`, because cdrdao
+  would interpret even an escaped backslash as an octal escape. cdrdao does not accept
+  escapes in non-ASCII text, so such text cannot contain that sequence; `dumps` raises
+  an error if it does.
+- Unwritten flags are not added. A track without a `COPY` line keeps
+  `copy_permitted is None` and has no `COPY` line in the output. The effective values
+  are available through `is_copy_permitted`, `has_pre_emphasis`, and `channel_count`.
+
+## Limits
+
+tocparser follows cdrdao 1.2.6, but some checks require the audio and data files
+referenced by a TOC file. Because tocparser reads only the TOC file, it cannot check the
+four-second minimum track length, an `INDEX` beyond the track end, `START` or `END` past
+the track end, an `END` within the pre-gap, or a requested length that exceeds the file.
+It also skips the CD-TEXT completeness checks that cdrdao performs only before writing a
+disc. tocparser checks everything else that `cdrdao show-toc` checks, with these
+differences:
+
+- If a file contains several errors, tocparser raises one, but not necessarily the one
+  cdrdao reports first.
+- For two syntax errors—a `PREGAP` after track data and a `LANGUAGE_MAP` inside a
+  track's `CD_TEXT`—cdrdao's parser stops at a different token than tocparser does.
+- cdrdao reports a `FIFO` that mixes audio and data on line 0; tocparser reports the
+  `FIFO`'s own line.
+- tocparser rejects `\NNN` bytes that are not text in their block's encoding—for
+  example, a lone CP932 lead byte or a byte above 127 in an `ENCODING_ASCII` block.
+  cdrdao keeps these bytes, at most issuing a warning, but could not read back the text
+  it would write for them.
+- cdrdao drops CD-TEXT items with empty strings. tocparser preserves an empty item when
+  no other value is provided and writes it back. Like cdrdao, it also allows a track to
+  contain an empty item that is valid only at the disc level.
+- Escapes in file names are decoded like CD-TEXT (as ISO-8859-1) and written back as
+  UTF-8.
+
+## TOC Files from Older cdrdao
+
+Files written by cdrdao 1.2.2 through 1.2.4 are mostly read the same way, with two
+exceptions that also apply to later releases. Releases before 1.2.2 were not checked.
+
+- cdrdao 1.2.2 through 1.2.4 wrote backslashes in strings unchanged. Since 1.2.5, a
+  backslash must begin an escape, so `"AC\DC"` is rejected with `Illegal token: \`, and
+  `"C:\\x"` now reads as `C:\x`, with one backslash rather than two. This applies to all
+  strings, including file names.
+- cdrdao 1.2.2 through 1.2.4 wrote bytes above 127 as octal escapes, at least under the
+  default C locale, and omitted `ENCODING_*`, so the text is read as ISO-8859-1. Latin
+  text remains intact, but text in another encoding, such as Japanese, does not.
+
+## Contributing
+
+Contributions are welcome. See CONTRIBUTING.md for development setup, test comparisons
+between tocparser and cdrdao, and the pull request process.
+
+## License
+
+tocparser is licensed under the Apache License 2.0.