[FFmpeg-devel,2/2] doc/ffmpeg.texi: update docs for autoscale/autorotate

Submitted by Linjie Fu on July 15, 2019, 10:39 a.m.

Details

Message ID 20190715103914.26982-1-linjie.fu@intel.com
State New
Headers show

Commit Message

Linjie Fu July 15, 2019, 10:39 a.m.
Add docs for autoscale/noautoscale.

Update information for autorotate according to ffplay.

Signed-off-by: Linjie Fu <linjie.fu@intel.com>
---
 doc/ffmpeg.texi | 11 +++++++++++
 1 file changed, 11 insertions(+)

Comments

Moritz Barsnick July 15, 2019, 12:02 p.m.
On Mon, Jul 15, 2019 at 18:39:14 +0800, Linjie Fu wrote:

Nit:

> +@item -noautoscale
> +Disable automatically scale video based on first frame resolution.
                         ^ scaling

Cheers,
Moritz
Linjie Fu July 15, 2019, 12:58 p.m.
> -----Original Message-----

> From: ffmpeg-devel [mailto:ffmpeg-devel-bounces@ffmpeg.org] On Behalf

> Of Moritz Barsnick

> Sent: Monday, July 15, 2019 20:02

> To: FFmpeg development discussions and patches <ffmpeg-

> devel@ffmpeg.org>

> Subject: Re: [FFmpeg-devel] [PATCH 2/2] doc/ffmpeg.texi: update docs for

> autoscale/autorotate

> 

> On Mon, Jul 15, 2019 at 18:39:14 +0800, Linjie Fu wrote:

> 

> Nit:

> 

> > +@item -noautoscale

> > +Disable automatically scale video based on first frame resolution.

>                          ^ scaling

> 


Yes, scaling :)
Thanks.
Nicolas George July 15, 2019, 2 p.m.
Linjie Fu (12019-07-15):
> Add docs for autoscale/noautoscale.

This belongs in the path that adds them.

> 
> Update information for autorotate according to ffplay.
> 
> Signed-off-by: Linjie Fu <linjie.fu@intel.com>
> ---
>  doc/ffmpeg.texi | 11 +++++++++++
>  1 file changed, 11 insertions(+)
> 
> diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
> index cd35eb49c8..040a2b53cf 100644
> --- a/doc/ffmpeg.texi
> +++ b/doc/ffmpeg.texi
> @@ -735,9 +735,20 @@ Technical note -- attachments are implemented as codec extradata, so this
>  option can actually be used to extract extradata from any stream, not just
>  attachments.
>  
> +@item -autorotate
> +Automatically rotate the video according to file metadata. Enabled by
> +default, use @option{-noautorotate} to disable it.
> +
> +@item -autoscale
> +Automatically scale the video according to the resolution of first frame.
> +Enabled by default, use @option{-noautoscale} to disable it.
> +
>  @item -noautorotate
>  Disable automatically rotating video based on file metadata.
>  

> +@item -noautoscale
> +Disable automatically scale video based on first frame resolution.

You neglected to explain the drawbacks.

> +
>  @end table
>  
>  @section Video Options

Regards,
Carl Eugen Hoyos July 15, 2019, 3:37 p.m.
Am Mo., 15. Juli 2019 um 12:39 Uhr schrieb Linjie Fu <linjie.fu@intel.com>:
>
> Add docs for autoscale/noautoscale.
>
> Update information for autorotate according to ffplay.
>
> Signed-off-by: Linjie Fu <linjie.fu@intel.com>
> ---
>  doc/ffmpeg.texi | 11 +++++++++++
>  1 file changed, 11 insertions(+)
>
> diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
> index cd35eb49c8..040a2b53cf 100644
> --- a/doc/ffmpeg.texi
> +++ b/doc/ffmpeg.texi
> @@ -735,9 +735,20 @@ Technical note -- attachments are implemented as codec extradata, so this
>  option can actually be used to extract extradata from any stream, not just
>  attachments.
>
> +@item -autorotate
> +Automatically rotate the video according to file metadata. Enabled by
> +default, use @option{-noautorotate} to disable it.
> +
> +@item -autoscale
> +Automatically scale the video according to the resolution of first frame.
> +Enabled by default, use @option{-noautoscale} to disable it.
> +
>  @item -noautorotate
>  Disable automatically rotating video based on file metadata.
>
> +@item -noautoscale
> +Disable automatically scale video based on first frame resolution.

Istn't there a "-no" option for most (all?) ffmpeg options but we only
document one of them?
I believe "autorotate" and "autoscale" are sufficient if there counterparts
are also described.

Carl Eugen
Linjie Fu July 15, 2019, 4:12 p.m.
> -----Original Message-----

> From: ffmpeg-devel [mailto:ffmpeg-devel-bounces@ffmpeg.org] On Behalf

> Of Carl Eugen Hoyos

> Sent: Monday, July 15, 2019 23:38

> To: FFmpeg development discussions and patches <ffmpeg-

> devel@ffmpeg.org>

> Subject: Re: [FFmpeg-devel] [PATCH 2/2] doc/ffmpeg.texi: update docs for

> autoscale/autorotate

> 

> Am Mo., 15. Juli 2019 um 12:39 Uhr schrieb Linjie Fu <linjie.fu@intel.com>:

> >

> > Add docs for autoscale/noautoscale.

> >

> > Update information for autorotate according to ffplay.

> >

> > Signed-off-by: Linjie Fu <linjie.fu@intel.com>

> > ---

> >  doc/ffmpeg.texi | 11 +++++++++++

> >  1 file changed, 11 insertions(+)

> >

> > diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi

> > index cd35eb49c8..040a2b53cf 100644

> > --- a/doc/ffmpeg.texi

> > +++ b/doc/ffmpeg.texi

> > @@ -735,9 +735,20 @@ Technical note -- attachments are implemented as

> codec extradata, so this

> >  option can actually be used to extract extradata from any stream, not just

> >  attachments.

> >

> > +@item -autorotate

> > +Automatically rotate the video according to file metadata. Enabled by

> > +default, use @option{-noautorotate} to disable it.

> > +

> > +@item -autoscale

> > +Automatically scale the video according to the resolution of first frame.

> > +Enabled by default, use @option{-noautoscale} to disable it.

> > +

> >  @item -noautorotate

> >  Disable automatically rotating video based on file metadata.

> >

> > +@item -noautoscale

> > +Disable automatically scale video based on first frame resolution.

> 

> Istn't there a "-no" option for most (all?) ffmpeg options but we only

> document one of them?


Options with OPT_BOOL flag (/* boolean -nofoo options */) can be used in this way.

> I believe "autorotate" and "autoscale" are sufficient if there counterparts

> are also described.

Agree, if there is docs for "-no"  option well explained.
Linjie Fu July 16, 2019, 2:01 a.m.
> -----Original Message-----
> From: Nicolas George [mailto:george@nsup.org]
> Sent: Monday, July 15, 2019 22:00
> To: FFmpeg development discussions and patches <ffmpeg-
> devel@ffmpeg.org>
> Cc: Fu, Linjie <linjie.fu@intel.com>
> Subject: Re: [FFmpeg-devel] [PATCH 2/2] doc/ffmpeg.texi: update docs for
> autoscale/autorotate
> 
> Linjie Fu (12019-07-15):
> > Add docs for autoscale/noautoscale.
> 
> This belongs in the path that adds them.

A little bit confused on this.
Improper position in doc for these options or  I need to add docs together with
code in one patch?
 
> >
> > Update information for autorotate according to ffplay.
> >
> > Signed-off-by: Linjie Fu <linjie.fu@intel.com>
> > ---
> >  doc/ffmpeg.texi | 11 +++++++++++
> >  1 file changed, 11 insertions(+)
> >
> > diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
> > index cd35eb49c8..040a2b53cf 100644
> > --- a/doc/ffmpeg.texi
> > +++ b/doc/ffmpeg.texi
> > @@ -735,9 +735,20 @@ Technical note -- attachments are implemented as
> codec extradata, so this
> >  option can actually be used to extract extradata from any stream, not just
> >  attachments.
> >
> > +@item -autorotate
> > +Automatically rotate the video according to file metadata. Enabled by
> > +default, use @option{-noautorotate} to disable it.
> > +
> > +@item -autoscale
> > +Automatically scale the video according to the resolution of first frame.
> > +Enabled by default, use @option{-noautoscale} to disable it.
> > +
> >  @item -noautorotate
> >  Disable automatically rotating video based on file metadata.
> >
> 
> > +@item -noautoscale
> > +Disable automatically scale video based on first frame resolution.
> 
> You neglected to explain the drawbacks.

Yes, can add something like:
"Each frame of the output raw video can in different resolutions
and is in need to be handled in following pipeline like vpp/encode."

- linjie

Patch hide | download patch | download mbox

diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index cd35eb49c8..040a2b53cf 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -735,9 +735,20 @@  Technical note -- attachments are implemented as codec extradata, so this
 option can actually be used to extract extradata from any stream, not just
 attachments.
 
+@item -autorotate
+Automatically rotate the video according to file metadata. Enabled by
+default, use @option{-noautorotate} to disable it.
+
+@item -autoscale
+Automatically scale the video according to the resolution of first frame.
+Enabled by default, use @option{-noautoscale} to disable it.
+
 @item -noautorotate
 Disable automatically rotating video based on file metadata.
 
+@item -noautoscale
+Disable automatically scale video based on first frame resolution.
+
 @end table
 
 @section Video Options