libavformat/options.c

   1 /*
   2  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
   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 #include "avformat.h"
  21 #include "libavutil/opt.h"
  22
  23 /**
  24  * @file
  25  * Options definition for AVFormatContext.
  26  */
  27
  28 static const char* format_to_name(void* ptr)
  29 {
  30     AVFormatContext* fc = (AVFormatContext*) ptr;
  31     if(fc->iformat) return fc->iformat->name;
  32     else if(fc->oformat) return fc->oformat->name;
  33     else return "NULL";
  34 }
  35
  36 static const AVOption *opt_find(void *obj, const char *name, const char *unit, int opt_flags, int search_flags)
  37 {
  38     AVFormatContext   *s = obj;
  39     AVInputFormat  *ifmt = NULL;
  40     AVOutputFormat *ofmt = NULL;
  41     if (!(search_flags & AV_OPT_SEARCH_FAKE_OBJ) && s->priv_data) {
  42         if ((s->iformat && !s->iformat->priv_class) ||
  43             (s->oformat && !s->oformat->priv_class))
  44             return NULL;
  45         return av_opt_find(s->priv_data, name, unit, opt_flags, search_flags);
  46     }
  47
  48     while ((ifmt = av_iformat_next(ifmt))) {
  49         const AVOption *o;
  50
  51         if (ifmt->priv_class && (o = av_opt_find(&ifmt->priv_class, name, unit, opt_flags, search_flags)))
  52             return o;
  53     }
  54     while ((ofmt = av_oformat_next(ofmt))) {
  55         const AVOption *o;
  56
  57         if (ofmt->priv_class && (o = av_opt_find(&ofmt->priv_class, name, unit, opt_flags, search_flags)))
  58             return o;
  59     }
  60     return NULL;
  61 }
  62
  63 #define OFFSET(x) offsetof(AVFormatContext,x)
  64 #define DEFAULT 0 //should be NAN but it does not work as it is not a constant in glibc as required by ANSI/ISO C
  65 //these names are too long to be readable
  66 #define E AV_OPT_FLAG_ENCODING_PARAM
  67 #define D AV_OPT_FLAG_DECODING_PARAM
  68
  69 static const AVOption options[]={
  70 {"probesize", "set probing size", OFFSET(probesize), FF_OPT_TYPE_INT, {.dbl = 5000000 }, 32, INT_MAX, D},
  71 {"muxrate", "set mux rate", OFFSET(mux_rate), FF_OPT_TYPE_INT, {.dbl = DEFAULT }, 0, INT_MAX, E},
  72 {"packetsize", "set packet size", OFFSET(packet_size), FF_OPT_TYPE_INT, {.dbl = DEFAULT }, 0, INT_MAX, E},
  73 {"fflags", NULL, OFFSET(flags), FF_OPT_TYPE_FLAGS, {.dbl = DEFAULT }, INT_MIN, INT_MAX, D|E, "fflags"},
  74 {"ignidx", "ignore index", 0, FF_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_IGNIDX }, INT_MIN, INT_MAX, D, "fflags"},
  75 {"genpts", "generate pts", 0, FF_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_GENPTS }, INT_MIN, INT_MAX, D, "fflags"},
  76 {"nofillin", "do not fill in missing values that can be exactly calculated", 0, FF_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_NOFILLIN }, INT_MIN, INT_MAX, D, "fflags"},
  77 {"noparse", "disable AVParsers, this needs nofillin too", 0, FF_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_NOPARSE }, INT_MIN, INT_MAX, D, "fflags"},
  78 {"igndts", "ignore dts", 0, FF_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_IGNDTS }, INT_MIN, INT_MAX, D, "fflags"},
  79 #if FF_API_FLAG_RTP_HINT
  80 {"rtphint", "add rtp hinting (deprecated, use the -movflags rtphint option instead)", 0, FF_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_RTP_HINT }, INT_MIN, INT_MAX, E, "fflags"},
  81 #endif
  82 {"discardcorrupt", "discard corrupted frames", 0, FF_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_DISCARD_CORRUPT }, INT_MIN, INT_MAX, D, "fflags"},
  83 {"sortdts", "try to interleave outputted packets by dts", 0, FF_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_SORT_DTS }, INT_MIN, INT_MAX, D, "fflags"},
  84 {"keepside", "dont merge side data", 0, FF_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_KEEP_SIDE_DATA }, INT_MIN, INT_MAX, D, "fflags"},
  85 {"latm", "enable RTP MP4A-LATM payload", 0, FF_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_MP4A_LATM }, INT_MIN, INT_MAX, E, "fflags"},
  86 {"analyzeduration", "how many microseconds are analyzed to estimate duration", OFFSET(max_analyze_duration), FF_OPT_TYPE_INT, {.dbl = 5*AV_TIME_BASE }, 0, INT_MAX, D},
  87 {"cryptokey", "decryption key", OFFSET(key), FF_OPT_TYPE_BINARY, {.dbl = 0}, 0, 0, D},
  88 {"indexmem", "max memory used for timestamp index (per stream)", OFFSET(max_index_size), FF_OPT_TYPE_INT, {.dbl = 1<<20 }, 0, INT_MAX, D},
  89 {"rtbufsize", "max memory used for buffering real-time frames", OFFSET(max_picture_buffer), FF_OPT_TYPE_INT, {.dbl = 3041280 }, 0, INT_MAX, D}, /* defaults to 1s of 15fps 352x288 YUYV422 video */
  90 {"fdebug", "print specific debug info", OFFSET(debug), FF_OPT_TYPE_FLAGS, {.dbl = DEFAULT }, 0, INT_MAX, E|D, "fdebug"},
  91 {"ts", NULL, 0, FF_OPT_TYPE_CONST, {.dbl = FF_FDEBUG_TS }, INT_MIN, INT_MAX, E|D, "fdebug"},
  92 {"max_delay", "maximum muxing or demuxing delay in microseconds", OFFSET(max_delay), FF_OPT_TYPE_INT, {.dbl = DEFAULT }, 0, INT_MAX, E|D},
  93 {"fer", "set error detection aggressivity", OFFSET(error_recognition), FF_OPT_TYPE_INT, {.dbl = FF_ER_CAREFUL }, INT_MIN, INT_MAX, D, "fer"},
  94 {"careful", NULL, 0, FF_OPT_TYPE_CONST, {.dbl = FF_ER_CAREFUL }, INT_MIN, INT_MAX, D, "fer"},
  95 {"explode", "abort decoding on error recognition", 0, FF_OPT_TYPE_CONST, {.dbl = FF_ER_EXPLODE }, INT_MIN, INT_MAX, D, "fer"},
  96 {"fpsprobesize", "number of frames used to probe fps", OFFSET(fps_probe_size), FF_OPT_TYPE_INT, {.dbl = -1}, -1, INT_MAX-1, D},
  97 {NULL},
  98 };
  99
 100 #undef E
 101 #undef D
 102 #undef DEFAULT
 103
 104 static const AVClass av_format_context_class = {
 105     .class_name     = "AVFormatContext",
 106     .item_name      = format_to_name,
 107     .option         = options,
 108     .version        = LIBAVUTIL_VERSION_INT,
 109     .opt_find       = opt_find,
 110 };
 111
 112 static void avformat_get_context_defaults(AVFormatContext *s)
 113 {
 114     memset(s, 0, sizeof(AVFormatContext));
 115
 116     s->av_class = &av_format_context_class;
 117
 118     av_opt_set_defaults(s);
 119 }
 120
 121 AVFormatContext *avformat_alloc_context(void)
 122 {
 123     AVFormatContext *ic;
 124     ic = av_malloc(sizeof(AVFormatContext));
 125     if (!ic) return ic;
 126     avformat_get_context_defaults(ic);
 127     return ic;
 128 }
 129
 130 const AVClass *avformat_get_class(void)
 131 {
 132     return &av_format_context_class;
 133 }