doc/print_options.c
0d0b81f9
 /*
  * Copyright (c) 2012 Anton Khirnov
  *
d814a839
  * This file is part of FFmpeg.
0d0b81f9
  *
d814a839
  * FFmpeg is free software; you can redistribute it and/or
0d0b81f9
  * 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.
  *
d814a839
  * FFmpeg is distributed in the hope that it will be useful,
0d0b81f9
  * 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
d814a839
  * License along with FFmpeg; if not, write to the Free Software
0d0b81f9
  * 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>
 
b2865259
 // print_options is build for the host, os_support.h isn't needed and is setup
c724c82a
 // for the target. without this build breaks on mingw
 #define AVFORMAT_OS_SUPPORT_H
 
0d0b81f9
 #include "libavformat/avformat.h"
79be2c32
 #include "libavformat/options_table.h"
0d0b81f9
 #include "libavcodec/avcodec.h"
79be2c32
 #include "libavcodec/options_table.h"
0d0b81f9
 #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)
 {
35862807
     if (!(o->flags & (AV_OPT_FLAG_DECODING_PARAM | AV_OPT_FLAG_ENCODING_PARAM)))
         return;
 
0d0b81f9
     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)
 {
     printf("@section Format AVOptions\n");
b5a13865
     show_opts(avformat_options, 0);
0d0b81f9
 }
 
 static void show_codec_opts(void)
 {
     printf("@section Codec AVOptions\n");
b5a13865
     show_opts(avcodec_options, 1);
0d0b81f9
 }
 
 int main(int argc, char **argv)
 {
     if (argc < 2)
         print_usage();
 
1e43786b
     printf("@c DO NOT EDIT THIS FILE!\n"
            "@c It was generated by print_options.\n\n");
0d0b81f9
     if (!strcmp(argv[1], "format"))
         show_format_opts();
     else if (!strcmp(argv[1], "codec"))
         show_codec_opts();
     else
         print_usage();
 
     return 0;
 }