Commit | Line | Data |
---|---|---|
2ba45a60 DM |
1 | /* |
2 | * Copyright (c) 2011 Anton Khirnov | |
3 | * | |
4 | * This file is part of FFmpeg. | |
5 | * | |
6 | * FFmpeg 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 | * FFmpeg 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 FFmpeg; if not, write to the Free Software | |
18 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
19 | */ | |
20 | ||
21 | /* | |
22 | * enumerate avoptions and format them in texinfo format | |
23 | */ | |
24 | ||
25 | #include <string.h> | |
26 | ||
27 | #include "libavformat/avformat.h" | |
28 | #include "libavcodec/avcodec.h" | |
29 | #include "libavutil/log.h" | |
30 | #include "libavutil/opt.h" | |
31 | ||
32 | static void print_usage(void) | |
33 | { | |
34 | fprintf(stderr, "Usage: enum_options type\n" | |
35 | "type: format codec\n"); | |
36 | exit(1); | |
37 | } | |
38 | ||
39 | static void print_option(const AVClass *class, const AVOption *o) | |
40 | { | |
41 | printf("@item -%s @var{", o->name); | |
42 | switch (o->type) { | |
43 | case FF_OPT_TYPE_BINARY: printf("hexadecimal string"); break; | |
44 | case FF_OPT_TYPE_STRING: printf("string"); break; | |
45 | case FF_OPT_TYPE_INT: | |
46 | case FF_OPT_TYPE_INT64: printf("integer"); break; | |
47 | case FF_OPT_TYPE_FLOAT: | |
48 | case FF_OPT_TYPE_DOUBLE: printf("float"); break; | |
49 | case FF_OPT_TYPE_RATIONAL: printf("rational number"); break; | |
50 | case FF_OPT_TYPE_FLAGS: printf("flags"); break; | |
51 | default: printf("value"); break; | |
52 | } | |
53 | printf("} (@emph{"); | |
54 | ||
55 | if (o->flags & AV_OPT_FLAG_ENCODING_PARAM) { | |
56 | printf("input"); | |
57 | if (o->flags & AV_OPT_FLAG_ENCODING_PARAM) | |
58 | printf("/"); | |
59 | } | |
60 | if (o->flags & AV_OPT_FLAG_ENCODING_PARAM) | |
61 | printf("output"); | |
62 | ||
63 | printf("})\n"); | |
64 | if (o->help) | |
65 | printf("%s\n", o->help); | |
66 | ||
67 | if (o->unit) { | |
68 | const AVOption *u = NULL; | |
69 | printf("\nPossible values:\n@table @samp\n"); | |
70 | ||
71 | while ((u = av_next_option(&class, u))) | |
72 | if (u->type == FF_OPT_TYPE_CONST && u->unit && !strcmp(u->unit, o->unit)) | |
73 | printf("@item %s\n%s\n", u->name, u->help ? u->help : ""); | |
74 | printf("@end table\n"); | |
75 | } | |
76 | } | |
77 | ||
78 | static void show_opts(const AVClass *class) | |
79 | { | |
80 | const AVOption *o = NULL; | |
81 | ||
82 | printf("@table @option\n"); | |
83 | while ((o = av_next_option(&class, o))) | |
84 | if (o->type != FF_OPT_TYPE_CONST) | |
85 | print_option(class, o); | |
86 | printf("@end table\n"); | |
87 | } | |
88 | ||
89 | static void show_format_opts(void) | |
90 | { | |
91 | AVInputFormat *iformat = NULL; | |
92 | AVOutputFormat *oformat = NULL; | |
93 | ||
94 | printf("@section Generic format AVOptions\n"); | |
95 | show_opts(avformat_get_class()); | |
96 | ||
97 | printf("@section Format-specific AVOptions\n"); | |
98 | while ((iformat = av_iformat_next(iformat))) { | |
99 | if (!iformat->priv_class) | |
100 | continue; | |
101 | printf("@subsection %s AVOptions\n", iformat->priv_class->class_name); | |
102 | show_opts(iformat->priv_class); | |
103 | } | |
104 | while ((oformat = av_oformat_next(oformat))) { | |
105 | if (!oformat->priv_class) | |
106 | continue; | |
107 | printf("@subsection %s AVOptions\n", oformat->priv_class->class_name); | |
108 | show_opts(oformat->priv_class); | |
109 | } | |
110 | } | |
111 | ||
112 | static void show_codec_opts(void) | |
113 | { | |
114 | AVCodec *c = NULL; | |
115 | ||
116 | printf("@section Generic codec AVOptions\n"); | |
117 | show_opts(avcodec_get_class()); | |
118 | ||
119 | printf("@section Codec-specific AVOptions\n"); | |
120 | while ((c = av_codec_next(c))) { | |
121 | if (!c->priv_class) | |
122 | continue; | |
123 | printf("@subsection %s AVOptions\n", c->priv_class->class_name); | |
124 | show_opts(c->priv_class); | |
125 | } | |
126 | } | |
127 | ||
128 | int main(int argc, char **argv) | |
129 | { | |
130 | if (argc < 2) | |
131 | print_usage(); | |
132 | ||
133 | av_register_all(); | |
134 | ||
135 | if (!strcmp(argv[1], "format")) | |
136 | show_format_opts(); | |
137 | else if (!strcmp(argv[1], "codec")) | |
138 | show_codec_opts(); | |
139 | else | |
140 | print_usage(); | |
141 | ||
142 | return 0; | |
143 | } |