git.sesse.net Git - ffmpeg/blob - 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 "avio_internal.h"
  22 #include "libavutil/opt.h"
  23
  24 /**
  25  * @file
  26  * Options definition for AVFormatContext.
  27  */
  28
  29 static const char* format_to_name(void* ptr)
  30 {
  31     AVFormatContext* fc = (AVFormatContext*) ptr;
  32     if(fc->iformat) return fc->iformat->name;
  33     else if(fc->oformat) return fc->oformat->name;
  34     else return "NULL";
  35 }
  36
  37 static void *format_child_next(void *obj, void *prev)
  38 {
  39     AVFormatContext *s = obj;
  40     if (!prev && s->priv_data &&
  41         ((s->iformat && s->iformat->priv_class) ||
  42           s->oformat && s->oformat->priv_class))
  43         return s->priv_data;
  44     if (s->pb && s->pb->av_class && prev != s->pb)
  45         return s->pb;
  46     return NULL;
  47 }
  48
  49 static const AVClass *format_child_class_next(const AVClass *prev)
  50 {
  51     AVInputFormat  *ifmt = NULL;
  52     AVOutputFormat *ofmt = NULL;
  53
  54     if (!prev)
  55         return &ffio_url_class;
  56
  57     while ((ifmt = av_iformat_next(ifmt)))
  58         if (ifmt->priv_class == prev)
  59             break;
  60
  61     if (!ifmt)
  62         while ((ofmt = av_oformat_next(ofmt)))
  63             if (ofmt->priv_class == prev)
  64                 break;
  65     if (!ofmt)
  66         while (ifmt = av_iformat_next(ifmt))
  67             if (ifmt->priv_class)
  68                 return ifmt->priv_class;
  69
  70     while (ofmt = av_oformat_next(ofmt))
  71         if (ofmt->priv_class)
  72             return ofmt->priv_class;
  73
  74     return NULL;
  75 }
  76
  77 #define OFFSET(x) offsetof(AVFormatContext,x)
  78 #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
  79 //these names are too long to be readable
  80 #define E AV_OPT_FLAG_ENCODING_PARAM
  81 #define D AV_OPT_FLAG_DECODING_PARAM
  82
  83 static const AVOption options[]={
  84 {"probesize", "set probing size", OFFSET(probesize), AV_OPT_TYPE_INT, {.dbl = 5000000 }, 32, INT_MAX, D},
  85 {"packetsize", "set packet size", OFFSET(packet_size), AV_OPT_TYPE_INT, {.dbl = DEFAULT }, 0, INT_MAX, E},
  86 {"fflags", NULL, OFFSET(flags), AV_OPT_TYPE_FLAGS, {.dbl = DEFAULT }, INT_MIN, INT_MAX, D|E, "fflags"},
  87 {"ignidx", "ignore index", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_IGNIDX }, INT_MIN, INT_MAX, D, "fflags"},
  88 {"genpts", "generate pts", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_GENPTS }, INT_MIN, INT_MAX, D, "fflags"},
  89 {"nofillin", "do not fill in missing values that can be exactly calculated", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_NOFILLIN }, INT_MIN, INT_MAX, D, "fflags"},
  90 {"noparse", "disable AVParsers, this needs nofillin too", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_NOPARSE }, INT_MIN, INT_MAX, D, "fflags"},
  91 {"igndts", "ignore dts", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_IGNDTS }, INT_MIN, INT_MAX, D, "fflags"},
  92 {"discardcorrupt", "discard corrupted frames", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_DISCARD_CORRUPT }, INT_MIN, INT_MAX, D, "fflags"},
  93 {"sortdts", "try to interleave outputted packets by dts", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_SORT_DTS }, INT_MIN, INT_MAX, D, "fflags"},
  94 {"keepside", "dont merge side data", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_KEEP_SIDE_DATA }, INT_MIN, INT_MAX, D, "fflags"},
  95 {"latm", "enable RTP MP4A-LATM payload", 0, AV_OPT_TYPE_CONST, {.dbl = AVFMT_FLAG_MP4A_LATM }, INT_MIN, INT_MAX, E, "fflags"},
  96 {"analyzeduration", "how many microseconds are analyzed to estimate duration", OFFSET(max_analyze_duration), AV_OPT_TYPE_INT, {.dbl = 5*AV_TIME_BASE }, 0, INT_MAX, D},
  97 {"cryptokey", "decryption key", OFFSET(key), AV_OPT_TYPE_BINARY, {.dbl = 0}, 0, 0, D},
  98 {"indexmem", "max memory used for timestamp index (per stream)", OFFSET(max_index_size), AV_OPT_TYPE_INT, {.dbl = 1<<20 }, 0, INT_MAX, D},
  99 {"rtbufsize", "max memory used for buffering real-time frames", OFFSET(max_picture_buffer), AV_OPT_TYPE_INT, {.dbl = 3041280 }, 0, INT_MAX, D}, /* defaults to 1s of 15fps 352x288 YUYV422 video */
 100 {"fdebug", "print specific debug info", OFFSET(debug), AV_OPT_TYPE_FLAGS, {.dbl = DEFAULT }, 0, INT_MAX, E|D, "fdebug"},
 101 {"ts", NULL, 0, AV_OPT_TYPE_CONST, {.dbl = FF_FDEBUG_TS }, INT_MIN, INT_MAX, E|D, "fdebug"},
 102 {"max_delay", "maximum muxing or demuxing delay in microseconds", OFFSET(max_delay), AV_OPT_TYPE_INT, {.dbl = DEFAULT }, 0, INT_MAX, E|D},
 103 {"fpsprobesize", "number of frames used to probe fps", OFFSET(fps_probe_size), AV_OPT_TYPE_INT, {.dbl = -1}, -1, INT_MAX-1, D},
 104 {"audio_preload", "microseconds by which audio packets should be interleaved earlier", OFFSET(audio_preload), AV_OPT_TYPE_INT, {.dbl = 0}, 0, INT_MAX-1, E},
 105 {"chunk_duration", "microseconds for each chunk", OFFSET(max_chunk_duration), AV_OPT_TYPE_INT, {.dbl = 0}, 0, INT_MAX-1, E},
 106 {"chunk_size", "size in bytes for each chunk", OFFSET(max_chunk_size), AV_OPT_TYPE_INT, {.dbl = 0}, 0, INT_MAX-1, E},
 107 /* this is a crutch for avconv, since it cannot deal with identically named options in different contexts.
 108  * to be removed when avconv is fixed */
 109 {"f_err_detect", "set error detection flags (deprecated; use err_detect, save via avconv)", OFFSET(error_recognition), AV_OPT_TYPE_FLAGS, {.dbl = AV_EF_CRCCHECK }, INT_MIN, INT_MAX, D, "err_detect"},
 110 {"err_detect", "set error detection flags", OFFSET(error_recognition), AV_OPT_TYPE_FLAGS, {.dbl = AV_EF_CRCCHECK }, INT_MIN, INT_MAX, D, "err_detect"},
 111 {"crccheck", "verify embedded CRCs", 0, AV_OPT_TYPE_CONST, {.dbl = AV_EF_CRCCHECK }, INT_MIN, INT_MAX, D, "err_detect"},
 112 {"bitstream", "detect bitstream specification deviations", 0, AV_OPT_TYPE_CONST, {.dbl = AV_EF_BITSTREAM }, INT_MIN, INT_MAX, D, "err_detect"},
 113 {"buffer", "detect improper bitstream length", 0, AV_OPT_TYPE_CONST, {.dbl = AV_EF_BUFFER }, INT_MIN, INT_MAX, D, "err_detect"},
 114 {"explode", "abort decoding on minor error detection", 0, AV_OPT_TYPE_CONST, {.dbl = AV_EF_EXPLODE }, INT_MIN, INT_MAX, D, "err_detect"},
 115 {"careful",    "consider things that violate the spec and have not been seen in the wild as errors", 0, AV_OPT_TYPE_CONST, {.dbl = AV_EF_CAREFUL }, INT_MIN, INT_MAX, D, "err_detect"},
 116 {"compliant",  "consider all spec non compliancies as errors", 0, AV_OPT_TYPE_CONST, {.dbl = AV_EF_COMPLIANT }, INT_MIN, INT_MAX, D, "err_detect"},
 117 {"aggressive", "consider things that a sane encoder shouldnt do as an error", 0, AV_OPT_TYPE_CONST, {.dbl = AV_EF_AGGRESSIVE }, INT_MIN, INT_MAX, D, "err_detect"},
 118 {NULL},
 119 };
 120
 121 #undef E
 122 #undef D
 123 #undef DEFAULT
 124
 125 static const AVClass av_format_context_class = {
 126     .class_name     = "AVFormatContext",
 127     .item_name      = format_to_name,
 128     .option         = options,
 129     .version        = LIBAVUTIL_VERSION_INT,
 130     .child_next     = format_child_next,
 131     .child_class_next = format_child_class_next,
 132 };
 133
 134 static void avformat_get_context_defaults(AVFormatContext *s)
 135 {
 136     memset(s, 0, sizeof(AVFormatContext));
 137
 138     s->av_class = &av_format_context_class;
 139
 140     av_opt_set_defaults(s);
 141 }
 142
 143 AVFormatContext *avformat_alloc_context(void)
 144 {
 145     AVFormatContext *ic;
 146     ic = av_malloc(sizeof(AVFormatContext));
 147     if (!ic) return ic;
 148     avformat_get_context_defaults(ic);
 149     return ic;
 150 }
 151
 152 const AVClass *avformat_get_class(void)
 153 {
 154     return &av_format_context_class;
 155 }