Move the AVFormatContext options definition to a dedicated file,
[libav.git] / libavformat / options.c
CommitLineData
708ec8fb
SS
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 "libavcodec/opt.h"
22
23/**
24 * @file options.c
25 * Options definition for AVFormatContext.
26 */
27
28static 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#define OFFSET(x) offsetof(AVFormatContext,x)
37#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
38//these names are too long to be readable
39#define E AV_OPT_FLAG_ENCODING_PARAM
40#define D AV_OPT_FLAG_DECODING_PARAM
41
42static const AVOption options[]={
43{"probesize", NULL, OFFSET(probesize), FF_OPT_TYPE_INT, 32000, 32, INT_MAX, D}, /* 32000 from mpegts.c: 1.0 second at 24Mbit/s */
44{"muxrate", "set mux rate", OFFSET(mux_rate), FF_OPT_TYPE_INT, DEFAULT, 0, INT_MAX, E},
45{"packetsize", "set packet size", OFFSET(packet_size), FF_OPT_TYPE_INT, DEFAULT, 0, INT_MAX, E},
46{"fflags", NULL, OFFSET(flags), FF_OPT_TYPE_FLAGS, DEFAULT, INT_MIN, INT_MAX, D|E, "fflags"},
47{"ignidx", "ignore index", 0, FF_OPT_TYPE_CONST, AVFMT_FLAG_IGNIDX, INT_MIN, INT_MAX, D, "fflags"},
48{"genpts", "generate pts", 0, FF_OPT_TYPE_CONST, AVFMT_FLAG_GENPTS, INT_MIN, INT_MAX, D, "fflags"},
49{"track", " set the track number", OFFSET(track), FF_OPT_TYPE_INT, DEFAULT, 0, INT_MAX, E},
50{"year", "set the year", OFFSET(year), FF_OPT_TYPE_INT, DEFAULT, INT_MIN, INT_MAX, E},
51{"analyzeduration", "how many microseconds are analyzed to estimate duration", OFFSET(max_analyze_duration), FF_OPT_TYPE_INT, 3*AV_TIME_BASE, 0, INT_MAX, D},
52{"cryptokey", "decryption key", OFFSET(key), FF_OPT_TYPE_BINARY, 0, 0, 0, D},
53{"indexmem", "max memory used for timestamp index (per stream)", OFFSET(max_index_size), FF_OPT_TYPE_INT, 1<<20, 0, INT_MAX, D},
54{"rtbufsize", "max memory used for buffering real-time frames", OFFSET(max_picture_buffer), FF_OPT_TYPE_INT, 3041280, 0, INT_MAX, D}, /* defaults to 1s of 15fps 352x288 YUYV422 video */
55{"fdebug", "print specific debug info", OFFSET(debug), FF_OPT_TYPE_FLAGS, DEFAULT, 0, INT_MAX, E|D, "fdebug"},
56{"ts", NULL, 0, FF_OPT_TYPE_CONST, FF_FDEBUG_TS, INT_MIN, INT_MAX, E|D, "fdebug"},
57{NULL},
58};
59
60#undef E
61#undef D
62#undef DEFAULT
63
64static const AVClass av_format_context_class = { "AVFormatContext", format_to_name, options };
65
66static void avformat_get_context_defaults(AVFormatContext *s)
67{
68 memset(s, 0, sizeof(AVFormatContext));
69
70 s->av_class = &av_format_context_class;
71
72 av_opt_set_defaults(s);
73}
74
75AVFormatContext *av_alloc_format_context(void)
76{
77 AVFormatContext *ic;
78 ic = av_malloc(sizeof(AVFormatContext));
79 if (!ic) return ic;
80 avformat_get_context_defaults(ic);
81 ic->av_class = &av_format_context_class;
82 return ic;
83}