ChptFmtNative needs more info

[AncientAbysswalker]

There is not currently enough info to understand how to add chapters to the Metadata. The documentation states that all that is required is the command tone tag --taggers="ChptFmtNative" [file] and the chapter data found in chapters.txt (assumedly in the same directory that the [file] is in - but I also tried the current directory and the user home directory) will be added. There is no indication of what format or interface to use. After reading through your tests it seems that the format to use is something like 00:00:00.000 chapter 1 \n00:00:05.000 chapter 2 \n00:00:15.000 chapter 3. This should be indicated. Despite this, it doesn't make any changes and simply states unchanged: [file], and does not give any indication whether the file was picked up or not. More information should be added to the documentation to make this process much clearer... I have also tried adding the --debug flag and changing the name of the chapters file and nothing changes.

Using: Windows 10 and Powershell

[sandreas]

Thank you for reporting this issue - I'm always especially interested in documentation problem reports, because this is something, everyone can benefit from.

Let's see if I can break down your problems into bullet points to get a better overview:

• You misunderstood the --taggers option - it is not to specify the import formats, but to specify, which taggers should be used (a small difference, but important)
• You did not find an example of the ChptFmtNativeFormat in the documentation (which indeed should be added)
• You tried to change the chapters of a file and it did not work (I think this is because of the first misunderstanding, but I'll have to verify this)

The todo's:

• [ ] Change the documentation to be clearer about --taggers (It is an option for advanced users and not necessary for default tasks)
• [ ] Add examples for the supported formats to the documentation
• [ ] Verify, that ChptFmtNative works as import format, if the correct parameters are used

And now how it works:

• Create a file <audio-file-name>.chapters.txt (e.g. my-audio-book.m4b maps to my-audio-book.chapters.txt)
  • you can use tone dump --format=chptfmtnative my-audio-book.m4b > my-audio-book.chapters.txt to dump existing chapters
• Change the contents of *.chapters.txt to your liking
• Run tone tag --auto-import=chapters my-audio-book.m4b to reimport modified chapters

If this does not work as expected, please feel free to give feedback.

[AncientAbysswalker]

Thanks for the quick response! I believe you are 100% correct in that I misunderstood the workflow due to the lack of documentation on the feature. I tested out the feature using the updated information you provided and I was able to successfully add chapters as intended! :) I believe those listed updates to the documentation should be enough to clarify the workflow.

On a side note, I think that --format=chptfmtnative is not available to me yet, as the comments in the commit seem to indicate version 0.1.1 release and I think the most recent release for Windows is 0.1.0 :)

[sandreas]

On a side note, I think that --format=chptfmtnative is not available to me yet, as the comments in the commit seem to indicate version 0.1.1 release and I think the most recent release for Windows is 0.1.0 :)

Ah sorry, yes, it's in the upcoming 0.1.1 - but I'm happy you solved your problem. The docs will be updated for 0.1.1, too. Thank you again for reporting this.