diff mbox series

[FFmpeg-devel] ffprobe: add -output_format as an alias of -of

Message ID 20231015092910.388128-1-stefasab@gmail.com
State Accepted
Commit 7bf414408e4f07c0f48d452e014b630165287f94
Headers show
Series [FFmpeg-devel] ffprobe: add -output_format as an alias of -of | expand

Checks

Context Check Description
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Stefano Sabatini Oct. 15, 2023, 9:29 a.m. UTC
Currently we have -of and -print_format, which is a bit confusing. Add
-output_format as an alias of -of to match the short name.
---
 Changelog         |  1 +
 doc/ffprobe.texi  |  6 +++---
 fftools/ffprobe.c | 17 +++++++++--------
 3 files changed, 13 insertions(+), 11 deletions(-)

Comments

Stefano Sabatini Oct. 18, 2023, 9:45 p.m. UTC | #1
On date Sunday 2023-10-15 11:29:10 +0200, Stefano Sabatini wrote:
> Currently we have -of and -print_format, which is a bit confusing. Add
> -output_format as an alias of -of to match the short name.
> ---
>  Changelog         |  1 +
>  doc/ffprobe.texi  |  6 +++---
>  fftools/ffprobe.c | 17 +++++++++--------
>  3 files changed, 13 insertions(+), 11 deletions(-)
> 
> diff --git a/Changelog b/Changelog
> index 259180e190..cceee46215 100644
> --- a/Changelog
> +++ b/Changelog
> @@ -37,6 +37,7 @@ version <next>:
>  - VAAPI AV1 encoder
>  - ffprobe XML output schema changed to account for multiple
>    variable-fields elements within the same parent element
> +- ffprobe -output_format option added as an alias of -of

Will push tomorrow or later if I see no comments.
Stefano Sabatini Oct. 20, 2023, 5:02 p.m. UTC | #2
On date Wednesday 2023-10-18 23:45:11 +0200, Stefano Sabatini wrote:
> On date Sunday 2023-10-15 11:29:10 +0200, Stefano Sabatini wrote:
> > Currently we have -of and -print_format, which is a bit confusing. Add
> > -output_format as an alias of -of to match the short name.
> > ---
> >  Changelog         |  1 +
> >  doc/ffprobe.texi  |  6 +++---
> >  fftools/ffprobe.c | 17 +++++++++--------
> >  3 files changed, 13 insertions(+), 11 deletions(-)
> > 
> > diff --git a/Changelog b/Changelog
> > index 259180e190..cceee46215 100644
> > --- a/Changelog
> > +++ b/Changelog
> > @@ -37,6 +37,7 @@ version <next>:
> >  - VAAPI AV1 encoder
> >  - ffprobe XML output schema changed to account for multiple
> >    variable-fields elements within the same parent element
> > +- ffprobe -output_format option added as an alias of -of
> 
> Will push tomorrow or later if I see no comments.

Applied.
diff mbox series

Patch

diff --git a/Changelog b/Changelog
index 259180e190..cceee46215 100644
--- a/Changelog
+++ b/Changelog
@@ -37,6 +37,7 @@  version <next>:
 - VAAPI AV1 encoder
 - ffprobe XML output schema changed to account for multiple
   variable-fields elements within the same parent element
+- ffprobe -output_format option added as an alias of -of
 
 
 version 6.0:
diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi
index 4dc9f577bb..b74ff650ac 100644
--- a/doc/ffprobe.texi
+++ b/doc/ffprobe.texi
@@ -41,7 +41,7 @@  ffprobe will show it.
 
 ffprobe output is designed to be easily parsable by a textual filter,
 and consists of one or more sections of a form defined by the selected
-writer, which is specified by the @option{print_format} option.
+writer, which is specified by the @option{output_format} option.
 
 Sections may contain other nested sections, and are identified by a
 name (which may be shared by other sections), and an unique
@@ -83,7 +83,7 @@  Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
 Prettify the format of the displayed values, it corresponds to the
 options "-unit -prefix -byte_binary_prefix -sexagesimal".
 
-@item -of, -print_format @var{writer_name}[=@var{writer_options}]
+@item -output_format, -of, -print_format @var{writer_name}[=@var{writer_options}]
 Set the output printing format.
 
 @var{writer_name} specifies the name of the writer, and
@@ -91,7 +91,7 @@  Set the output printing format.
 
 For example for printing the output in JSON format, specify:
 @example
--print_format json
+-output_format json
 @end example
 
 For more details on the available output printing formats, see the
diff --git a/fftools/ffprobe.c b/fftools/ffprobe.c
index e490a9a9b2..91e81e639c 100644
--- a/fftools/ffprobe.c
+++ b/fftools/ffprobe.c
@@ -140,7 +140,7 @@  static int show_private_data            = 1;
 #define SHOW_OPTIONAL_FIELDS_ALWAYS      1
 static int show_optional_fields = SHOW_OPTIONAL_FIELDS_AUTO;
 
-static char *print_format;
+static char *output_format;
 static char *stream_specifier;
 static char *show_data_hash;
 
@@ -4094,9 +4094,10 @@  static const OptionDef real_options[] = {
       "use sexagesimal format HOURS:MM:SS.MICROSECONDS for time units" },
     { "pretty", 0, {.func_arg = opt_pretty},
       "prettify the format of displayed values, make it more human readable" },
-    { "print_format", OPT_STRING | HAS_ARG, { &print_format },
+    { "output_format", OPT_STRING | HAS_ARG, { &output_format },
       "set the output printing format (available formats are: default, compact, csv, flat, ini, json, xml)", "format" },
-    { "of", OPT_STRING | HAS_ARG, { &print_format }, "alias for -print_format", "format" },
+    { "print_format", OPT_STRING | HAS_ARG, { &output_format }, "alias for -output_format (deprecated)" },
+    { "of", OPT_STRING | HAS_ARG, { &output_format }, "alias for -output_format", "format" },
     { "select_streams", OPT_STRING | HAS_ARG, { &stream_specifier }, "select the specified streams", "stream_specifier" },
     { "sections", OPT_EXIT, {.func_arg = opt_sections}, "print sections structure and section information, and exit" },
     { "show_data",    OPT_BOOL, { &do_show_data }, "show packets data" },
@@ -4217,13 +4218,13 @@  int main(int argc, char **argv)
 
     writer_register_all();
 
-    if (!print_format)
-        print_format = av_strdup("default");
-    if (!print_format) {
+    if (!output_format)
+        output_format = av_strdup("default");
+    if (!output_format) {
         ret = AVERROR(ENOMEM);
         goto end;
     }
-    w_name = av_strtok(print_format, "=", &buf);
+    w_name = av_strtok(output_format, "=", &buf);
     if (!w_name) {
         av_log(NULL, AV_LOG_ERROR,
                "No name specified for the output format\n");
@@ -4292,7 +4293,7 @@  int main(int argc, char **argv)
     }
 
 end:
-    av_freep(&print_format);
+    av_freep(&output_format);
     av_freep(&read_intervals);
     av_hash_freep(&hash);