git.sesse.net Git - ffmpeg/blob - libavcodec/options.c

   1 /*
   2  * Copyright (c) 2001 Fabrice Bellard
   3  * Copyright (c) 2002-2004 Michael Niedermayer <michaelni@gmx.at>
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * FFmpeg is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 /**
  23  * @file
  24  * Options definition for AVCodecContext.
  25  */
  26
  27 #include "avcodec.h"
  28 #include "internal.h"
  29 #include "libavutil/avassert.h"
  30 #include "libavutil/opt.h"
  31 #include <float.h>              /* FLT_MIN, FLT_MAX */
  32
  33 #include "options_table.h"
  34
  35 static const char* context_to_name(void* ptr) {
  36     AVCodecContext *avc= ptr;
  37
  38     if(avc && avc->codec && avc->codec->name)
  39         return avc->codec->name;
  40     else
  41         return "NULL";
  42 }
  43
  44 static void *codec_child_next(void *obj, void *prev)
  45 {
  46     AVCodecContext *s = obj;
  47     if (!prev && s->codec && s->codec->priv_class && s->priv_data)
  48         return s->priv_data;
  49     return NULL;
  50 }
  51
  52 static const AVClass *codec_child_class_next(const AVClass *prev)
  53 {
  54     AVCodec *c = NULL;
  55
  56     /* find the codec that corresponds to prev */
  57     while (prev && (c = av_codec_next(c)))
  58         if (c->priv_class == prev)
  59             break;
  60
  61     /* find next codec with priv options */
  62     while (c = av_codec_next(c))
  63         if (c->priv_class)
  64             return c->priv_class;
  65     return NULL;
  66 }
  67
  68 static AVClassCategory get_category(void *ptr)
  69 {
  70     AVCodecContext* avctx = ptr;
  71     if(avctx->codec && avctx->codec->decode) return AV_CLASS_CATEGORY_DECODER;
  72     else                                     return AV_CLASS_CATEGORY_ENCODER;
  73 }
  74
  75 static const AVClass av_codec_context_class = {
  76     .class_name              = "AVCodecContext",
  77     .item_name               = context_to_name,
  78     .option                  = options,
  79     .version                 = LIBAVUTIL_VERSION_INT,
  80     .log_level_offset_offset = offsetof(AVCodecContext, log_level_offset),
  81     .child_next              = codec_child_next,
  82     .child_class_next        = codec_child_class_next,
  83     .category                = AV_CLASS_CATEGORY_ENCODER,
  84     .get_category            = get_category,
  85 };
  86
  87 #if FF_API_ALLOC_CONTEXT
  88 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType codec_type){
  89     AVCodec c= {0};
  90     c.type= codec_type;
  91     avcodec_get_context_defaults3(s, &c);
  92 }
  93 #endif
  94
  95 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec){
  96     int flags=0;
  97     memset(s, 0, sizeof(AVCodecContext));
  98
  99     s->av_class = &av_codec_context_class;
 100
 101     s->codec_type = codec ? codec->type : AVMEDIA_TYPE_UNKNOWN;
 102     if(s->codec_type == AVMEDIA_TYPE_AUDIO)
 103         flags= AV_OPT_FLAG_AUDIO_PARAM;
 104     else if(s->codec_type == AVMEDIA_TYPE_VIDEO)
 105         flags= AV_OPT_FLAG_VIDEO_PARAM;
 106     else if(s->codec_type == AVMEDIA_TYPE_SUBTITLE)
 107         flags= AV_OPT_FLAG_SUBTITLE_PARAM;
 108     av_opt_set_defaults2(s, flags, flags);
 109
 110     s->time_base           = (AVRational){0,1};
 111     s->get_buffer          = avcodec_default_get_buffer;
 112     s->release_buffer      = avcodec_default_release_buffer;
 113     s->get_format          = avcodec_default_get_format;
 114     s->execute             = avcodec_default_execute;
 115     s->execute2            = avcodec_default_execute2;
 116     s->sample_aspect_ratio = (AVRational){0,1};
 117     s->pix_fmt             = PIX_FMT_NONE;
 118     s->sample_fmt          = AV_SAMPLE_FMT_NONE;
 119     s->timecode_frame_start = -1;
 120
 121     s->reget_buffer        = avcodec_default_reget_buffer;
 122     s->reordered_opaque    = AV_NOPTS_VALUE;
 123     if(codec && codec->priv_data_size){
 124         if(!s->priv_data){
 125             s->priv_data= av_mallocz(codec->priv_data_size);
 126             if (!s->priv_data) {
 127                 return AVERROR(ENOMEM);
 128             }
 129         }
 130         if(codec->priv_class){
 131             *(const AVClass**)s->priv_data = codec->priv_class;
 132             av_opt_set_defaults(s->priv_data);
 133         }
 134     }
 135     if (codec && codec->defaults) {
 136         int ret;
 137         const AVCodecDefault *d = codec->defaults;
 138         while (d->key) {
 139             ret = av_opt_set(s, d->key, d->value, 0);
 140             av_assert0(ret >= 0);
 141             d++;
 142         }
 143     }
 144     return 0;
 145 }
 146
 147 AVCodecContext *avcodec_alloc_context3(AVCodec *codec){
 148     AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
 149
 150     if(avctx==NULL) return NULL;
 151
 152     if(avcodec_get_context_defaults3(avctx, codec) < 0){
 153         av_free(avctx);
 154         return NULL;
 155     }
 156
 157     return avctx;
 158 }
 159
 160 #if FF_API_ALLOC_CONTEXT
 161 AVCodecContext *avcodec_alloc_context2(enum AVMediaType codec_type){
 162     AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
 163
 164     if(avctx==NULL) return NULL;
 165
 166     avcodec_get_context_defaults2(avctx, codec_type);
 167
 168     return avctx;
 169 }
 170
 171 void avcodec_get_context_defaults(AVCodecContext *s){
 172     avcodec_get_context_defaults2(s, AVMEDIA_TYPE_UNKNOWN);
 173 }
 174
 175 AVCodecContext *avcodec_alloc_context(void){
 176     return avcodec_alloc_context2(AVMEDIA_TYPE_UNKNOWN);
 177 }
 178 #endif
 179
 180 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
 181 {
 182     if (avcodec_is_open(dest)) { // check that the dest context is uninitialized
 183         av_log(dest, AV_LOG_ERROR,
 184                "Tried to copy AVCodecContext %p into already-initialized %p\n",
 185                src, dest);
 186         return AVERROR(EINVAL);
 187     }
 188     memcpy(dest, src, sizeof(*dest));
 189
 190     /* set values specific to opened codecs back to their default state */
 191     dest->priv_data       = NULL;
 192     dest->codec           = NULL;
 193     dest->slice_offset    = NULL;
 194     dest->hwaccel         = NULL;
 195     dest->thread_opaque   = NULL;
 196     dest->internal        = NULL;
 197
 198     /* reallocate values that should be allocated separately */
 199     dest->rc_eq           = NULL;
 200     dest->extradata       = NULL;
 201     dest->intra_matrix    = NULL;
 202     dest->inter_matrix    = NULL;
 203     dest->rc_override     = NULL;
 204     if (src->rc_eq) {
 205         dest->rc_eq = av_strdup(src->rc_eq);
 206         if (!dest->rc_eq)
 207             return AVERROR(ENOMEM);
 208     }
 209
 210 #define alloc_and_copy_or_fail(obj, size, pad) \
 211     if (src->obj && size > 0) { \
 212         dest->obj = av_malloc(size + pad); \
 213         if (!dest->obj) \
 214             goto fail; \
 215         memcpy(dest->obj, src->obj, size); \
 216         if (pad) \
 217             memset(((uint8_t *) dest->obj) + size, 0, pad); \
 218     }
 219     alloc_and_copy_or_fail(extradata,    src->extradata_size,
 220                            FF_INPUT_BUFFER_PADDING_SIZE);
 221     alloc_and_copy_or_fail(intra_matrix, 64 * sizeof(int16_t), 0);
 222     alloc_and_copy_or_fail(inter_matrix, 64 * sizeof(int16_t), 0);
 223     alloc_and_copy_or_fail(rc_override,  src->rc_override_count * sizeof(*src->rc_override), 0);
 224 #undef alloc_and_copy_or_fail
 225
 226     return 0;
 227
 228 fail:
 229     av_freep(&dest->rc_override);
 230     av_freep(&dest->intra_matrix);
 231     av_freep(&dest->inter_matrix);
 232     av_freep(&dest->extradata);
 233     av_freep(&dest->rc_eq);
 234     return AVERROR(ENOMEM);
 235 }
 236
 237 const AVClass *avcodec_get_class(void)
 238 {
 239     return &av_codec_context_class;
 240 }
 241
 242 #define FOFFSET(x) offsetof(AVFrame,x)
 243
 244 static const AVOption frame_options[]={
 245 {"best_effort_timestamp", "", FOFFSET(best_effort_timestamp), AV_OPT_TYPE_INT64, {.dbl = AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, 0},
 246 {"pkt_pos", "", FOFFSET(pkt_pos), AV_OPT_TYPE_INT64, {.dbl = -1 }, INT64_MIN, INT64_MAX, 0},
 247 {"sample_aspect_ratio", "", FOFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL, {.dbl = 0 }, 0, INT_MAX, 0},
 248 {"width", "", FOFFSET(width), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
 249 {"height", "", FOFFSET(height), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
 250 {"format", "", FOFFSET(format), AV_OPT_TYPE_INT, {.dbl = -1 }, 0, INT_MAX, 0},
 251 {"channel_layout", "", FOFFSET(channel_layout), AV_OPT_TYPE_INT64, {.dbl = 0 }, 0, INT64_MAX, 0},
 252 {"sample_rate", "", FOFFSET(sample_rate), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
 253 {NULL},
 254 };
 255
 256 static const AVClass av_frame_class = {
 257     .class_name              = "AVFrame",
 258     .item_name               = NULL,
 259     .option                  = frame_options,
 260     .version                 = LIBAVUTIL_VERSION_INT,
 261 };
 262
 263 const AVClass *avcodec_get_frame_class(void)
 264 {
 265     return &av_frame_class;
 266 }
 267
 268 #define SROFFSET(x) offsetof(AVSubtitleRect,x)
 269
 270 static const AVOption subtitle_rect_options[]={
 271 {"x", "", SROFFSET(x), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
 272 {"y", "", SROFFSET(y), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
 273 {"w", "", SROFFSET(w), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
 274 {"h", "", SROFFSET(h), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
 275 {"type", "", SROFFSET(type), AV_OPT_TYPE_INT, {.dbl = 0 }, 0, INT_MAX, 0},
 276 {"forced", "", SROFFSET(forced), AV_OPT_TYPE_INT, {.dbl = 0}, 0, 1, 0},
 277 {NULL},
 278 };
 279
 280 static const AVClass av_subtitle_rect_class = {
 281     .class_name             = "AVSubtitleRect",
 282     .item_name              = NULL,
 283     .option                 = subtitle_rect_options,
 284     .version                = LIBAVUTIL_VERSION_INT,
 285 };
 286
 287 const AVClass *avcodec_get_subtitle_rect_class(void)
 288 {
 289     return &av_subtitle_rect_class;
 290 }