[FFmpeg-devel] [PATCH] Add documentation for -ast, -vst, -sst

[Michael Niedermayer]

On Thu, Feb 26, 2009 at 08:43:01PM +0100, Stefano Sabatini wrote:
> On date Tuesday 2009-02-24 23:50:40 +0100, Stefano Sabatini encoded:
> > On date Sunday 2009-02-22 13:34:15 +0100, Stefano Sabatini encoded:
> > > On date Thursday 2009-02-19 20:52:35 -0500, Steve Zakulec encoded:
> > > > This patch adds documentation for the three options listed above.
> > > 
> > > > Index: ffplay.c
> > > > ===================================================================
> > > > --- ffplay.c	(revision 17468)
> > > > +++ ffplay.c	(working copy)
> > > > @@ -2503,9 +2503,9 @@
> > > >      { "fs", OPT_BOOL, {(void*)&is_full_screen}, "force full screen" },
> > > >      { "an", OPT_BOOL, {(void*)&audio_disable}, "disable audio" },
> > > >      { "vn", OPT_BOOL, {(void*)&video_disable}, "disable video" },
> > > > -    { "ast", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_audio_stream}, "", "" },
> > > > -    { "vst", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_video_stream}, "", "" },
> > > > -    { "sst", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_subtitle_stream}, "", "" },
> > > > +    { "ast", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_audio_stream}, "desired audio stream", "" },
> > > 
> > > The help name should be a verbal description of what the option does, for example:
> > > "select audio stream to play"
> > > 
> > > the argname is the nominal description of the arg, so maybe "audio
> > > stream number" may work.
> > > 
> > > Also the man page should be updated and extended, for example the
> > > number is the global stream index or the number of the audio stream in
> > > the list of audio streams? Also what happens when the value is invalid
> > > (negative or too big), does it starts with zero or with 1?
> > > 
> > > > +    { "vst", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_video_stream}, "desired video stream", "" },
> > > > +    { "sst", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_subtitle_stream}, "desired subtitle stream", "" },
> > > >      { "ss", HAS_ARG | OPT_FUNC2, {(void*)&opt_seek}, "seek to a given position in seconds", "pos" },
> > > >      { "bytes", OPT_BOOL, {(void*)&seek_by_bytes}, "seek by bytes" },
> > > >      { "nodisp", OPT_BOOL, {(void*)&display_disable}, "disable graphical display" },
> > 
> > Attached patch.
> > 
> > Regards.
> > -- 
> > FFmpeg = Fundamental Friendly Most Peaceless Enigmatic Goblin
> 
> > Index: ffplay.c
> > ===================================================================
> > --- ffplay.c	(revision 17569)
> > +++ ffplay.c	(working copy)
> > @@ -2503,9 +2503,9 @@
> >      { "fs", OPT_BOOL, {(void*)&is_full_screen}, "force full screen" },
> >      { "an", OPT_BOOL, {(void*)&audio_disable}, "disable audio" },
> >      { "vn", OPT_BOOL, {(void*)&video_disable}, "disable video" },
> > -    { "ast", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_audio_stream}, "", "" },
> > -    { "vst", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_video_stream}, "", "" },
> > -    { "sst", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_subtitle_stream}, "", "" },
> > +    { "ast", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_audio_stream}, "select desired audio stream, counting from 1", "stream_number" },
> > +    { "vst", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_video_stream}, "select desired video stream, counting from 1", "stream_number" },
> > +    { "sst", OPT_INT | HAS_ARG | OPT_EXPERT, {(void*)&wanted_subtitle_stream}, "select desired subtitle stream, counting from 1", "stream_number" },
> >      { "ss", HAS_ARG | OPT_FUNC2, {(void*)&opt_seek}, "seek to a given position in seconds", "pos" },
> >      { "bytes", OPT_BOOL, {(void*)&seek_by_bytes}, "seek by bytes" },
> >      { "nodisp", OPT_BOOL, {(void*)&display_disable}, "disable graphical display" },
> > Index: doc/ffplay-doc.texi
> > ===================================================================
> > --- doc/ffplay-doc.texi	(revision 17569)
> > +++ doc/ffplay-doc.texi	(working copy)
> > @@ -87,6 +87,21 @@
> >  used for debugging purposes.
> >  @item -threads @var{count}
> >  Set the thread count.
> > + at item -ast @var{audio_stream_number}
> > +Select the desired audio stream number, counting from 1. The number
> > +refers to the list of all the input audio streams, if it is greater
> > +than the number of audio streams then the last one is selected, if it
> > +is non-positive the first one is selected.
> > + at item -vst @var{video_stream_number}
> > +Select the desired video stream number, counting from 1. The number
> > +refers to the list of all the input video streams, if it is greater
> > +than the number of video streams then the last one is selected, if it
> > +is non-positive the first one is selected.
> > + at item -sst @var{subtitle_stream_number}
> > +Select the desired subtitle stream number, counting from 1. The number
> > +refers to the list of all the input subtitle streams, if it is greater
> > +than the number of subtitle streams then the last one is selected, if
> > +it is non-positive the first one is selected.
> >  @end table
> >  
> >  @section While playing
> 
> Ping?
> 
> I'd like to include it in the release.

iam too busy to review doc patches, commit if noone else is reviewing
and you think its ok

[...]

-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

The worst form of inequality is to try to make unequal things equal.
-- Aristotle
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20090226/70cd276d/attachment.pgp>