Changelog

  • X.X.X - Work in progress

    • XX

  • 1.2.0 - 2024-10-09

    • COMPATIBILITY WARNING: Drop support for Python 3.7 and Python 3.8.

    • Python 3.13 is officially supported.

  • 1.1.1 - 2023-10-05

  • 1.1.0 - 2022-05-17

    • COMPATIBILITY WARNING: Drop support for Python 3.6.

    • Add support for Python 3.10 and 3.11. Tested with 3.11.0b1.

    • Warnings in tests should be errors.

    • Migrate from ‘unittest.makeSuite()’ to ‘unittest.TestLoader.loadTestsFromTestCase()’.

    • More appropriate wording in the generated exception when the timestamps are not strictly monotonic.

    • Bibliography chapter.

    • Some typos in docs.

  • 1.0.0 - 2021-05-18

    • When printing the chapter list in the terminal, show also the duration of the chapter in minutes and seconds.

    • When printing the chapter list in the terminal, align the titles of the chapters.

    • Add tutorial.

    • Production ready.

  • 0.6.0 - 2021-04-20

    • Apparently, many players require that if chapters are present, they must cover all the audio.

      So, if the first chapter doesn’t start at “[00:00]” because you don’t specify it in the markdown TOC file or because you are applying a “timestamp offset”, the software will generate a dummy chapter starting at “[00:00]”.

    • MP3: Chapter timestamps must be encoded as miliseconds, not seconds.

    • MP4: Audio players require that the last chapter ends at the end of the audio file. If not, the player will keep playing “silence” until the end of the chapter.

    • MP3: Just in case it is needed for audio players, last chapter ends at the end of the audio file.

    • MP4: Missing import.

  • 0.5.0 - 2021-04-16

    • MP3: Force a rewrite of the audio file only when the metadata is updated.

    • MP3: Only clean old chapter information if we are adding new chapter information. Leave metadata alone if the user doesn’t want to change it.

    • Add “toc2audio” identification in the audio file comment section.

    • MP4: Preserve metadata of the original file, except the chapter information we are inserting.

    • Chapter titles: new lines transformed to spaces. Tabs transformed to spaces. Multiple spaces replaced by a single space.

    • When adding chapters to audio file, print the chapter list on the terminal.

    • COMPATIBILITY WARNING: Drop HTML tags in chapter titles. Keep only the text.

    • Better audio player chapter compatibility using Opus and Vorbis audio files.

  • 0.4.0.post1 - 2021-04-14

  • 0.4.0 - 2021-04-14

    • COMPATIBILITY WARNING: Drop the feature of the first line in the markdown TOC file being the TOC title. Only MP3 supports that. Now, when tagging mp3, we use the audio ID3 title as the TOC title.

    • Install toc2audio command line utility.

    • Add --version command line parameter.

    • New URLs for the project documentation, changelog, etc.

    • New theme for Sphinx: sphinx_rtd_theme.

  • 0.3.0 - 2021-04-14

    • An optional --offset command line parameter allows to specify a global offset to add to all timestamps. Useful to specify the duration of the intro you will add to the audio you listened in order to write the show notes markdown document.

    • Beside showing the TOC in your browser, the HTML is printed in the terminal. You can copy&paste or redirect it to complete your show notes.

    • A timestamp can be shown as compact format (MM:SS) or not compact format (00:MM:SS).

    • A timestamp is declared as compact or not compact when read from the markdown TOC document. The idea is to keep the same representation that the user used in the markdown TOC document, after applying the optional time offsets.

  • 0.2.0 - 2021-04-13

    • We can add chapters to M4A files now. This feature requires availability of FFmpeg software.

    • We can add chapters to Opus files now.

    • We can add chapters to Vorbis files now.

    • The chapter end time should be provided in the TOC object, instead of each audio tagger taking care of calculating it.

  • 0.1.0 - 2021-04-09

    Initial release. It can add chapters to MP3 files.

    Warning

    In many MP3 players, the MP3 file MUST BE CBR in order for the chapter metadata seeking to be accurate.