diff mbox series

[FFmpeg-devel,v6,3/4] doc/{muxers, demuxers}: add RCWT demuxer doc and refresh the muxer's doc to be consistent

Message ID 20240319224429.3133701-4-marth64@proxyid.net
State New
Headers show
Series RCWT Closed Captions demuxer (meta) | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Marth64 March 19, 2024, 10:44 p.m. UTC 
Signed-off-by: Marth64 <marth64@proxyid.net>
---
 doc/demuxers.texi | 26 ++++++++++++++++++++++++++
 doc/muxers.texi   | 29 +++++++++++++++++++----------
 2 files changed, 45 insertions(+), 10 deletions(-)

Comments

Stefano Sabatini March 20, 2024, 2:39 p.m. UTC | #1 
On date Tuesday 2024-03-19 17:44:28 -0500, Marth64 wrote:
> Signed-off-by: Marth64 <marth64@proxyid.net>
> ---
>  doc/demuxers.texi | 26 ++++++++++++++++++++++++++
>  doc/muxers.texi   | 29 +++++++++++++++++++----------
>  2 files changed, 45 insertions(+), 10 deletions(-)
> 
> diff --git a/doc/demuxers.texi b/doc/demuxers.texi
> index b70f3a38d7..47e82eda55 100644
> --- a/doc/demuxers.texi
> +++ b/doc/demuxers.texi
> @@ -1038,6 +1038,32 @@ the command:
>  ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
>  @end example
>  
> +@anchor{rcwtdec}
> +@section rcwt
> +
> +RCWT (Raw Captions With Time) is a format native to ccextractor, a commonly
> +used open source tool for processing 608/708 Closed Captions (CC) sources.
> +For more information on the format, see @ref{rcwtenc,,,ffmpeg-formats}.
> +
> +This demuxer implements the specification as of March 2024, which has
> +been stable and unchanged since April 2014.
> +
> +@subsection Examples
> +
> +@itemize
> +@item

> +Render Closed Captions to ASSA (using FFmpeg's CC decoder):

what is ASSA?

> +@example
> +ffmpeg -i CC.rcwt.bin CC.ass
> +@end example
> +
> +@item

> +Convert an RCWT backup to SCC:

let's expand SCC

> +@example
> +ffmpeg -i CC.rcwt.bin -c:s copy CC.scc
> +@end example
> +@end itemize
> +
LGTM otheriwse, thanks.
Marth64 March 20, 2024, 6:06 p.m. UTC | #2 
> what is ASSA?
This should just be ASS, will update

> let's expand SCC
> for the sake of exclicitness, I'd avoid more acronyms, I'd guess this
> is source Closed Caption?
Actually SCC is a format itself (Scenarist Closed Caption) of which FFmpeg
has a muxer and demuxer.
SCC is one of the standard proprietary formats to exchange Closed Captions.
I'll update the doc to highlight the fact better that this is a different
format.

Thank you for the reviews. Working on updates, will send a v7 when ready.
diff mbox series

Patch

diff --git a/doc/demuxers.texi b/doc/demuxers.texi
index b70f3a38d7..47e82eda55 100644
--- a/doc/demuxers.texi
+++ b/doc/demuxers.texi
@@ -1038,6 +1038,32 @@  the command:
 ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
 @end example
 
+@anchor{rcwtdec}
+@section rcwt
+
+RCWT (Raw Captions With Time) is a format native to ccextractor, a commonly
+used open source tool for processing 608/708 Closed Captions (CC) sources.
+For more information on the format, see @ref{rcwtenc,,,ffmpeg-formats}.
+
+This demuxer implements the specification as of March 2024, which has
+been stable and unchanged since April 2014.
+
+@subsection Examples
+
+@itemize
+@item
+Render Closed Captions to ASSA (using FFmpeg's CC decoder):
+@example
+ffmpeg -i CC.rcwt.bin CC.ass
+@end example
+
+@item
+Convert an RCWT backup to SCC:
+@example
+ffmpeg -i CC.rcwt.bin -c:s copy CC.scc
+@end example
+@end itemize
+
 @section sbg
 
 SBaGen script demuxer.
diff --git a/doc/muxers.texi b/doc/muxers.texi
index d9dd72e613..0695a317d4 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -2987,19 +2987,18 @@  ogg files can be safely chained.
 
 @end table
 
-@anchor{rcwt}
+@anchor{rcwtenc}
 @section rcwt
 
-Raw Captions With Time (RCWT) is a format native to ccextractor, a commonly
-used open source tool for processing 608/708 closed caption (CC) sources.
-It can be used to archive the original, raw CC bitstream and to produce
-a source file for later CC processing or conversion. As a result,
-it also allows for interopability with ccextractor for processing CC data
-extracted via ffmpeg. The format is simple to parse and can be used
-to retain all lines and variants of CC.
+RCWT (Raw Captions With Time) is a format native to ccextractor, a commonly
+used open source tool for processing 608/708 Closed Captions (CC) sources.
+It can be used to archive the original extracted CC bitstream and to produce
+a source file for later processing or conversion. The format allows
+for interoperability between ccextractor and FFmpeg, is simple to parse,
+and can be used to create a backup of the CC presentation.
 
-This muxer implements the specification as of 2024-01-05, which has
-been stable and unchanged for 10 years as of this writing.
+This muxer implements the specification as of March 2024, which has
+been stable and unchanged since April 2014.
 
 This muxer will have some nuances from the way that ccextractor muxes RCWT.
 No compatibility issues when processing the output with ccextractor
@@ -3009,6 +3008,16 @@  and outputs will not be a bit-exact match.
 A free specification of RCWT can be found here:
 @url{https://github.com/CCExtractor/ccextractor/blob/master/docs/BINARY_FILE_FORMAT.TXT}
 
+@subsection Examples
+
+@itemize
+@item
+Extract Closed Captions to RCWT using lavfi:
+@example
+ffmpeg -f lavfi -i "movie=INPUT.mkv[out+subcc]" -map 0:s:0 -c:s copy CC.rcwt.bin
+@end example
+@end itemize
+
 @anchor{segment}
 @section segment, stream_segment, ssegment