Generate manpages for AV{Format,Codec}Context AVOptions.
authorAnton Khirnov <anton@khirnov.net>
Wed, 14 Mar 2012 19:08:50 +0000 (20:08 +0100)
committerAnton Khirnov <anton@khirnov.net>
Tue, 20 Mar 2012 06:10:06 +0000 (07:10 +0100)
Makefile
doc/Makefile
doc/avtools-common-opts.texi
doc/print_options.c [new file with mode: 0644]

index ae9191c..ae9c5fa 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -60,7 +60,7 @@ PROGS-$(CONFIG_AVSERVER) += avserver
 PROGS      := $(PROGS-yes:%=%$(EXESUF))
 OBJS        = $(PROGS-yes:%=%.o) cmdutils.o
 TESTTOOLS   = audiogen videogen rotozoom tiny_psnr base64
-HOSTPROGS  := $(TESTTOOLS:%=tests/%)
+HOSTPROGS  := $(TESTTOOLS:%=tests/%) doc/print_options
 TOOLS       = qt-faststart trasher
 TOOLS-$(CONFIG_ZLIB) += cws2fws
 
index 0acd984..5172707 100644 (file)
@@ -17,18 +17,27 @@ documentation: $(DOCS)
 
 TEXIDEP = awk '/^@include/ { printf "$@: $(@D)/%s\n", $$2 }' <$< >$(@:%=%.d)
 
+doc/print_options.o: libavformat/options_table.h libavcodec/options_table.h
+
+GENTEXI  = format codec
+GENTEXI := $(GENTEXI:%=doc/avoptions_%.texi)
+
+$(GENTEXI): TAG = GENTEXI
+$(GENTEXI): doc/avoptions_%.texi: doc/print_options
+       $(M)doc/print_options $* > $@
+
 doc/%.html: TAG = HTML
-doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init
+doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
        $(Q)$(TEXIDEP)
        $(M)texi2html -monolithic --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
 
 doc/%.pod: TAG = POD
-doc/%.pod: doc/%.texi
+doc/%.pod: doc/%.texi $(GENTEXI)
        $(Q)$(TEXIDEP)
        $(M)$(SRC_PATH)/doc/texi2pod.pl $< $@
 
 doc/%.1: TAG = MAN
-doc/%.1: doc/%.pod
+doc/%.1: doc/%.pod $(GENTEXI)
        $(M)pod2man --section=1 --center=" " --release=" " $< > $@
 
 $(DOCS): | doc
@@ -46,7 +55,7 @@ uninstall-man:
        $(RM) $(addprefix "$(MANDIR)/man1/",$(ALLMANPAGES))
 
 clean::
-       $(RM) doc/*.html doc/*.pod doc/*.1 $(CLEANSUFFIXES:%=doc/%)
+       $(RM) doc/*.html doc/*.pod doc/*.1 $(CLEANSUFFIXES:%=doc/%) doc/avoptions_*.texi
 
 -include $(wildcard $(DOCS:%=%.d))
 
index badd358..0be9cf0 100644 (file)
@@ -156,3 +156,6 @@ use @option{-option 0}/@option{-option 1}.
 
 Note2 old undocumented way of specifying per-stream AVOptions by prepending
 v/a/s to the options name is now obsolete and will be removed soon.
+
+@include avoptions_codec.texi
+@include avoptions_format.texi
diff --git a/doc/print_options.c b/doc/print_options.c
new file mode 100644 (file)
index 0000000..4283e6a
--- /dev/null
@@ -0,0 +1,123 @@
+/*
+ * Copyright (c) 2012 Anton Khirnov
+ *
+ * This file is part of Libav.
+ *
+ * Libav is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * Libav is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with Libav; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+/*
+ * generate texinfo manpages for avoptions
+ */
+
+#include <stddef.h>
+#include <string.h>
+#include <float.h>
+
+#include "libavformat/avformat.h"
+#include "libavcodec/avcodec.h"
+#include "libavutil/opt.h"
+
+static void print_usage(void)
+{
+    fprintf(stderr, "Usage: enum_options type\n"
+            "type: format codec\n");
+    exit(1);
+}
+
+static void print_option(const AVOption *opts, const AVOption *o, int per_stream)
+{
+    printf("@item -%s%s @var{", o->name, per_stream ? "[:stream_specifier]" : "");
+    switch (o->type) {
+    case AV_OPT_TYPE_BINARY:   printf("hexadecimal string"); break;
+    case AV_OPT_TYPE_STRING:   printf("string");             break;
+    case AV_OPT_TYPE_INT:
+    case AV_OPT_TYPE_INT64:    printf("integer");            break;
+    case AV_OPT_TYPE_FLOAT:
+    case AV_OPT_TYPE_DOUBLE:   printf("float");              break;
+    case AV_OPT_TYPE_RATIONAL: printf("rational number");    break;
+    case AV_OPT_TYPE_FLAGS:    printf("flags");              break;
+    default:                   printf("value");              break;
+    }
+    printf("} (@emph{");
+
+    if (o->flags & AV_OPT_FLAG_DECODING_PARAM) {
+        printf("input");
+        if (o->flags & AV_OPT_FLAG_ENCODING_PARAM)
+            printf("/");
+    }
+    if (o->flags & AV_OPT_FLAG_ENCODING_PARAM) printf("output");
+    if (o->flags & AV_OPT_FLAG_AUDIO_PARAM)    printf(",audio");
+    if (o->flags & AV_OPT_FLAG_VIDEO_PARAM)    printf(",video");
+    if (o->flags & AV_OPT_FLAG_SUBTITLE_PARAM) printf(",subtitles");
+
+    printf("})\n");
+    if (o->help)
+        printf("%s\n", o->help);
+
+    if (o->unit) {
+        const AVOption *u;
+        printf("\nPossible values:\n@table @samp\n");
+
+        for (u = opts; u->name; u++) {
+            if (u->type == AV_OPT_TYPE_CONST && u->unit && !strcmp(u->unit, o->unit))
+                printf("@item %s\n%s\n", u->name, u->help ? u->help : "");
+        }
+        printf("@end table\n");
+    }
+}
+
+static void show_opts(const AVOption *opts, int per_stream)
+{
+    const AVOption *o;
+
+    printf("@table @option\n");
+    for (o = opts; o->name; o++) {
+        if (o->type != AV_OPT_TYPE_CONST)
+            print_option(opts, o, per_stream);
+    }
+    printf("@end table\n");
+}
+
+static void show_format_opts(void)
+{
+#include "libavformat/options_table.h"
+
+    printf("@section Format AVOptions\n");
+    show_opts(options, 0);
+}
+
+static void show_codec_opts(void)
+{
+#include "libavcodec/options_table.h"
+
+    printf("@section Codec AVOptions\n");
+    show_opts(options, 1);
+}
+
+int main(int argc, char **argv)
+{
+    if (argc < 2)
+        print_usage();
+
+    if (!strcmp(argv[1], "format"))
+        show_format_opts();
+    else if (!strcmp(argv[1], "codec"))
+        show_codec_opts();
+    else
+        print_usage();
+
+    return 0;
+}