doc: Turn off noisy deprecation warnings in the option printer
[ffmpeg.git] / doc / print_options.c
1 /*
2  * Copyright (c) 2012 Anton Khirnov
3  *
4  * This file is part of Libav.
5  *
6  * Libav is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * Libav is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 /*
22  * generate texinfo manpages for avoptions
23  */
24
25 #include <stddef.h>
26 #include <stdio.h>
27 #include <string.h>
28 #include <float.h>
29
30 #include "libavutil/attributes.h"
31 #include "libavutil/opt.h"
32
33 /* Forcibly turn off deprecation warnings, which just add noise here. */
34 #undef attribute_deprecated
35 #define attribute_deprecated
36
37 #include "libavcodec/options_table.h"
38
39 #include "libavformat/options_table.h"
40
41 static void print_usage(void)
42 {
43     fprintf(stderr, "Usage: enum_options type\n"
44             "type: format codec\n");
45     exit(1);
46 }
47
48 static void print_option(const AVOption *opts, const AVOption *o, int per_stream)
49 {
50     if (!(o->flags & (AV_OPT_FLAG_DECODING_PARAM | AV_OPT_FLAG_ENCODING_PARAM)))
51         return;
52
53     printf("@item -%s%s @var{", o->name, per_stream ? "[:stream_specifier]" : "");
54     switch (o->type) {
55     case AV_OPT_TYPE_BINARY:   printf("hexadecimal string"); break;
56     case AV_OPT_TYPE_STRING:   printf("string");             break;
57     case AV_OPT_TYPE_INT:
58     case AV_OPT_TYPE_INT64:    printf("integer");            break;
59     case AV_OPT_TYPE_FLOAT:
60     case AV_OPT_TYPE_DOUBLE:   printf("float");              break;
61     case AV_OPT_TYPE_RATIONAL: printf("rational number");    break;
62     case AV_OPT_TYPE_FLAGS:    printf("flags");              break;
63     default:                   printf("value");              break;
64     }
65     printf("} (@emph{");
66
67     if (o->flags & AV_OPT_FLAG_DECODING_PARAM) {
68         printf("input");
69         if (o->flags & AV_OPT_FLAG_ENCODING_PARAM)
70             printf("/");
71     }
72     if (o->flags & AV_OPT_FLAG_ENCODING_PARAM) printf("output");
73     if (o->flags & AV_OPT_FLAG_AUDIO_PARAM)    printf(",audio");
74     if (o->flags & AV_OPT_FLAG_VIDEO_PARAM)    printf(",video");
75     if (o->flags & AV_OPT_FLAG_SUBTITLE_PARAM) printf(",subtitles");
76
77     printf("})\n");
78     if (o->help)
79         printf("%s\n", o->help);
80
81     if (o->unit) {
82         const AVOption *u;
83         printf("\nPossible values:\n@table @samp\n");
84
85         for (u = opts; u->name; u++) {
86             if (u->type == AV_OPT_TYPE_CONST && u->unit && !strcmp(u->unit, o->unit))
87                 printf("@item %s\n%s\n", u->name, u->help ? u->help : "");
88         }
89         printf("@end table\n");
90     }
91 }
92
93 static void show_opts(const AVOption *opts, int per_stream)
94 {
95     const AVOption *o;
96
97     printf("@table @option\n");
98     for (o = opts; o->name; o++) {
99         if (o->type != AV_OPT_TYPE_CONST)
100             print_option(opts, o, per_stream);
101     }
102     printf("@end table\n");
103 }
104
105 static void show_format_opts(void)
106 {
107     printf("@section Format AVOptions\n");
108     show_opts(avformat_options, 0);
109 }
110
111 static void show_codec_opts(void)
112 {
113     printf("@section Codec AVOptions\n");
114     show_opts(avcodec_options, 1);
115 }
116
117 int main(int argc, char **argv)
118 {
119     if (argc < 2)
120         print_usage();
121
122     if (!strcmp(argv[1], "format"))
123         show_format_opts();
124     else if (!strcmp(argv[1], "codec"))
125         show_codec_opts();
126     else
127         print_usage();
128
129     return 0;
130 }