diff mbox series

[FFmpeg-devel,3/3] avfilter/vf_subtitles: Reorganized subtitles filter options.

Message ID 20200705130535.5615-3-mstamat@gmail.com
State Superseded, archived
Headers show
Series [FFmpeg-devel,1/3] avfilter/vf_subtitles: add shift option | expand

Checks

Context Check Description
andriy/default pending
andriy/make success Make finished
andriy/make_fate success Make fate finished

Commit Message

Manolis Stamatogiannakis July 5, 2020, 1:05 p.m. UTC
Some options are common between subtitles/ass filters.
Rather than mentioning for each option whether it is common or not,
the options are now displayed in two separate tables.

Signed-off-by: Manolis Stamatogiannakis <mstamat@gmail.com>
---
 doc/filters.texi | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

Comments

Gyan Doshi July 5, 2020, 3:30 p.m. UTC | #1
On 05-07-2020 06:35 pm, Manolis Stamatogiannakis wrote:
> Some options are common between subtitles/ass filters.
> Rather than mentioning for each option whether it is common or not,
> the options are now displayed in two separate tables.
>
> Signed-off-by: Manolis Stamatogiannakis <mstamat@gmail.com>
> ---
>   doc/filters.texi | 18 +++++++++++-------
>   1 file changed, 11 insertions(+), 7 deletions(-)
>
> diff --git a/doc/filters.texi b/doc/filters.texi
> index c962ac55b0..c4ca39cb6d 100644
> --- a/doc/filters.texi
> +++ b/doc/filters.texi
> @@ -6453,6 +6453,7 @@ This filter supports the following @ref{commands} that corresponds to option of
>   @item planes
>   @end table
>   
> +@anchor{ass}
>   @section ass
>   
>   Same as the @ref{subtitles} filter, except that it doesn't require libavcodec
> @@ -17929,15 +17930,12 @@ To enable compilation of this filter you need to configure FFmpeg with
>   libavformat to convert the passed subtitles file to ASS (Advanced Substation
>   Alpha) subtitles format.
>   
> -The filter accepts the following options:
> +Common @ref{subtitles}/@ref{ass} filter options:
>   
>   @table @option
>   @item filename, f
>   Set the filename of the subtitle file to read. It must be specified.
>   
> -@item shift
> -Shift subtitles timings by the specified amount.
> -
>   @item original_size
>   Specify the size of the original video, the video for which the ASS file
>   was composed. For the syntax of this option, check the
> @@ -17952,12 +17950,18 @@ These fonts will be used in addition to whatever the font provider uses.
>   @item alpha
>   Process alpha channel, by default alpha channel is untouched.
>   
> +@item shift
> +Shift subtitles timings by the specified amount.
> +@end table
> +
> +Additional options for @ref{subtitles} filter:
> +
> +@table @option
>   @item charenc
> -Set subtitles input character encoding. @code{subtitles} filter only. Only
> -useful if not UTF-8.
> +Set subtitles input character encoding. Only useful if not UTF-8.
>   
>   @item stream_index, si
> -Set subtitles stream index. @code{subtitles} filter only.
> +Set subtitles stream index.

Break this off into a standalone without the shift option entry.
Then merge the doc shift entry with the code patches.

Regards,
Gyan
Manolis Stamatogiannakis July 5, 2020, 4:39 p.m. UTC | #2
Fair point. I've submitted a v2 where the docs reorganization is applied
first.

On Sun, 5 Jul 2020 at 17:30, Gyan Doshi <ffmpeg@gyani.pro> wrote:

>
>
> On 05-07-2020 06:35 pm, Manolis Stamatogiannakis wrote:
> > Some options are common between subtitles/ass filters.
> > Rather than mentioning for each option whether it is common or not,
> > the options are now displayed in two separate tables.
> >
> > Signed-off-by: Manolis Stamatogiannakis <mstamat@gmail.com>
> > ---
> >   doc/filters.texi | 18 +++++++++++-------
> >   1 file changed, 11 insertions(+), 7 deletions(-)
> >
> > diff --git a/doc/filters.texi b/doc/filters.texi
> > index c962ac55b0..c4ca39cb6d 100644
> > --- a/doc/filters.texi
> > +++ b/doc/filters.texi
> > @@ -6453,6 +6453,7 @@ This filter supports the following @ref{commands}
> that corresponds to option of
> >   @item planes
> >   @end table
> >
> > +@anchor{ass}
> >   @section ass
> >
> >   Same as the @ref{subtitles} filter, except that it doesn't require
> libavcodec
> > @@ -17929,15 +17930,12 @@ To enable compilation of this filter you need
> to configure FFmpeg with
> >   libavformat to convert the passed subtitles file to ASS (Advanced
> Substation
> >   Alpha) subtitles format.
> >
> > -The filter accepts the following options:
> > +Common @ref{subtitles}/@ref{ass} filter options:
> >
> >   @table @option
> >   @item filename, f
> >   Set the filename of the subtitle file to read. It must be specified.
> >
> > -@item shift
> > -Shift subtitles timings by the specified amount.
> > -
> >   @item original_size
> >   Specify the size of the original video, the video for which the ASS
> file
> >   was composed. For the syntax of this option, check the
> > @@ -17952,12 +17950,18 @@ These fonts will be used in addition to
> whatever the font provider uses.
> >   @item alpha
> >   Process alpha channel, by default alpha channel is untouched.
> >
> > +@item shift
> > +Shift subtitles timings by the specified amount.
> > +@end table
> > +
> > +Additional options for @ref{subtitles} filter:
> > +
> > +@table @option
> >   @item charenc
> > -Set subtitles input character encoding. @code{subtitles} filter only.
> Only
> > -useful if not UTF-8.
> > +Set subtitles input character encoding. Only useful if not UTF-8.
> >
> >   @item stream_index, si
> > -Set subtitles stream index. @code{subtitles} filter only.
> > +Set subtitles stream index.
>
> Break this off into a standalone without the shift option entry.
> Then merge the doc shift entry with the code patches.
>
> Regards,
> Gyan
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel@ffmpeg.org
> https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
>
> To unsubscribe, visit link above, or email
> ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
diff mbox series

Patch

diff --git a/doc/filters.texi b/doc/filters.texi
index c962ac55b0..c4ca39cb6d 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -6453,6 +6453,7 @@  This filter supports the following @ref{commands} that corresponds to option of
 @item planes
 @end table
 
+@anchor{ass}
 @section ass
 
 Same as the @ref{subtitles} filter, except that it doesn't require libavcodec
@@ -17929,15 +17930,12 @@  To enable compilation of this filter you need to configure FFmpeg with
 libavformat to convert the passed subtitles file to ASS (Advanced Substation
 Alpha) subtitles format.
 
-The filter accepts the following options:
+Common @ref{subtitles}/@ref{ass} filter options:
 
 @table @option
 @item filename, f
 Set the filename of the subtitle file to read. It must be specified.
 
-@item shift
-Shift subtitles timings by the specified amount.
-
 @item original_size
 Specify the size of the original video, the video for which the ASS file
 was composed. For the syntax of this option, check the
@@ -17952,12 +17950,18 @@  These fonts will be used in addition to whatever the font provider uses.
 @item alpha
 Process alpha channel, by default alpha channel is untouched.
 
+@item shift
+Shift subtitles timings by the specified amount.
+@end table
+
+Additional options for @ref{subtitles} filter:
+
+@table @option
 @item charenc
-Set subtitles input character encoding. @code{subtitles} filter only. Only
-useful if not UTF-8.
+Set subtitles input character encoding. Only useful if not UTF-8.
 
 @item stream_index, si
-Set subtitles stream index. @code{subtitles} filter only.
+Set subtitles stream index.
 
 @item force_style
 Override default style or script info parameters of the subtitles. It accepts a