Skip to content

Commit 880933c

Browse files
committed
Update supported formats and add FAQ entries
1 parent 7b96573 commit 880933c

File tree

2 files changed

+31
-16
lines changed

2 files changed

+31
-16
lines changed

.github/readme.md

+18-16
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,24 @@ Create and _convert_ chapters for podcasts, youtube, matroska, mkvmerge/nero/vor
1010

1111
## Supported Formats
1212

13-
- `chaptersjson` podcasting 2.0 chapters json file ([spec](https://github.com/Podcastindex-org/podcast-namespace/blob/main/chapters/jsonChapters.md))
14-
- `ffmpegdata` ffmpeg metadata format ([spec](https://ffmpeg.org/ffmpeg-formats.html#Metadata-1))
15-
- `matroskaxml` matroska XML format ([spec](https://www.matroska.org/technical/chapters.html))
16-
- `mkvmergexml` MKVToolNix mkvmerge XML format ([spec](https://mkvtoolnix.download/doc/mkvmerge.html#mkvmerge.chapters))
17-
- `mkvmergesimple` MKVToolNix mkvmerge "simple" format ([spec](https://mkvtoolnix.download/doc/mkvmerge.html#mkvmerge.chapters))
18-
- `webvtt` WebVTT chapter format ([spec](https://developer.mozilla.org/en-US/docs/Web/API/WebVTT_API))
19-
- `youtube` Youtube description chapter notation
20-
- `ffmpeginfo` (readonly) ffmpeg scene detection output, used internally
21-
- `pyscenedetect` PySceneDetect list-scenes CSV Format ([project home](https://github.com/Breakthrough/PySceneDetect))
22-
- `vorbiscomment` [Vorbis Comment](https://wiki.xiph.org/Chapter_Extension#:~:text=two%20sequential%20chapters%3A-,CHAPTER001,-%3D00%3A00%3A00.0009) format that is slightly different from mkvmergesimple
23-
- `applechapters` [mythical chapter format](https://github.com/rigaya/NVEnc/blob/master/NVEncC_Options.en.md#--chapter-string:~:text=CHAPTER03NAME%3Dchapter%2D3-,apple%20format,-(should%20be%20in)) of unclear origin/spec or purpose
24-
- `edl` Edit Decision List, compatible with [shutter encoder](https://www.shutterencoder.com/en/), unclear actual spec
25-
- `podlove simple chapters` [xml](https://podlove.org/simple-chapters/) and [json](https://github.com/podlove/chapters#:~:text=org/%3E-,Encode%20to%20JSON,-iex%3E%20Chapters) format
26-
- `mp4chaps` [mp4chaps](https://github.com/podlove/chapters#:~:text=%3Achapters%3E-,Encode%20to%20mp4chaps,-iex%3E%20Chapters) format - actual spec unknown
27-
- `applehls` [Apple HLS Chapter](https://developer.apple.com/documentation/http-live-streaming/providing-javascript-object-notation-json-chapters) format - partial support
28-
13+
| name | key | ext | info |
14+
|-------|------|----------|------|
15+
| Podcasting 2.0 Chapters | chaptersjson | `json` | [spec](https://github.com/Podcastindex-org/podcast-namespace/blob/main/chapters/jsonChapters.md) |
16+
| FFMetadata | ffmpegdata | `txt` | [spec](https://ffmpeg.org/ffmpeg-formats.html#Metadata-1) |
17+
| Matroska XML chapters | matroskaxml | `xml` | [spec](https://www.matroska.org/technical/chapters.html) |
18+
| MKVToolNix mkvmerge XML | mkvmergexml | `xml` | [spec](https://mkvtoolnix.download/doc/mkvmerge.html#mkvmerge.chapters) |
19+
| MKVToolNix mkvmerge _simple_ | mkvmergesimple | `txt` | [spec](https://mkvtoolnix.download/doc/mkvmerge.html#mkvmerge.chapters) |
20+
| WebVTT Chapters | webvtt | `vtt` | [spec](https://developer.mozilla.org/en-US/docs/Web/API/WebVTT_API) |
21+
| Youtube Chapter Syntax | youtube | `txt` | |
22+
| FFMpegInfo | ffmpeginfo | `txt` | read only, used internally |
23+
| PySceneDetect | pyscenedetect | `csv` | [project home](https://github.com/Breakthrough/PySceneDetect) |
24+
| Vorbis Comment Format | vorbiscomment | `txt` | [spec](https://wiki.xiph.org/Chapter_Extension) |
25+
| "Apple Chapters" | applechapters | `xml` | [source](https://github.com/rigaya/NVEnc/blob/master/NVEncC_Options.en.md#--chapter-string:~:text=CHAPTER03NAME%3Dchapter%2D3-,apple%20format,-(should%20be%20in)) |
26+
| Shutter EDL | edl | `edl` | [source](https://github.com/paulpacifico/shutter-encoder/blob/f3d6bb6dfcd629861a0b0a50113bf4b062e1ba17/src/application/SceneDetection.java) |
27+
| Podlove Simple Chapters | psc | `xml` | [spec](https://podlove.org/simple-chapters/) |
28+
| Podlove Simple Chapters JSON | podlovejson | `json` | [source](https://github.com/podlove/chapters#:~:text=org/%3E-,Encode%20to%20JSON,-iex%3E%20Chapters) |
29+
| MP4Chaps | mp4chaps | `txt` | [source](https://github.com/podlove/chapters#:~:text=%3Achapters%3E-,Encode%20to%20mp4chaps,-iex%3E%20Chapters) |
30+
| Apple HLS Chapters | applehls | `json` | [spec](https://developer.apple.com/documentation/http-live-streaming/providing-javascript-object-notation-json-chapters), partial support |
2931

3032
## CLI
3133

faq.md

+13
Original file line numberDiff line numberDiff line change
@@ -82,5 +82,18 @@ be 00:00.
8282
## How to use the apple chapters?
8383
I honestly don't know as the only reference I could find is [NVEnc's documentation](https://github.com/rigaya/NVEnc/blob/master/NVEncC_Options.en.md#--chapter-string:~:text=apple%20format%20(should%20be%20in%20utf%2D8))
8484

85+
## Which EDL format is used?
86+
I used the EDL format that is yielded by [shutter encoder](https://www.shutterencoder.com/en/). I hope the format is compatible with other software, but I haven't tested it.
87+
88+
## How to use the podlove simple chapters?
89+
The podlove simple chapters are used in the podlove web player. The format is described in the [podlove documentation](https://podlove.org/simple-chapters/).
90+
91+
## How to use the apple hls chapters?
92+
I have no idea. Also the format is only partially supported as it has more features than `chaptersjson` (which is the internal format used by chaptertool) can express.
93+
94+
## How to use the mp4chaps chapters?
95+
No clue, hopefully you can figure it out.
96+
97+
8598
## What does "chapter/timeline lock" do?
8699
When enabled, clicking anywhere on the timeline will select the chapter below. When disabled you can click on the timeline without the chapter below being selected and scrolled into view.

0 commit comments

Comments
 (0)