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/internal.h"
  31 #include "libavutil/mem.h"
  32 #include "libavutil/opt.h"
  33 #include <string.h>
  34
  35 FF_DISABLE_DEPRECATION_WARNINGS
  36 #include "options_table.h"
  37 FF_ENABLE_DEPRECATION_WARNINGS
  38
  39 static const char* context_to_name(void* ptr) {
  40     AVCodecContext *avc= ptr;
  41
  42     if(avc && avc->codec && avc->codec->name)
  43         return avc->codec->name;
  44     else
  45         return "NULL";
  46 }
  47
  48 static void *codec_child_next(void *obj, void *prev)
  49 {
  50     AVCodecContext *s = obj;
  51     if (!prev && s->codec && s->codec->priv_class && s->priv_data)
  52         return s->priv_data;
  53     return NULL;
  54 }
  55
  56 #if FF_API_CHILD_CLASS_NEXT
  57 static const AVClass *codec_child_class_next(const AVClass *prev)
  58 {
  59     void *iter = NULL;
  60     const AVCodec *c = NULL;
  61
  62     /* find the codec that corresponds to prev */
  63     while (prev && (c = av_codec_iterate(&iter)))
  64         if (c->priv_class == prev)
  65             break;
  66
  67     /* find next codec with priv options */
  68     while (c = av_codec_iterate(&iter))
  69         if (c->priv_class)
  70             return c->priv_class;
  71     return NULL;
  72 }
  73 #endif
  74
  75 static const AVClass *codec_child_class_iterate(void **iter)
  76 {
  77     const AVCodec *c;
  78     /* find next codec with priv options */
  79     while (c = av_codec_iterate(iter))
  80         if (c->priv_class)
  81             return c->priv_class;
  82     return NULL;
  83 }
  84
  85 static AVClassCategory get_category(void *ptr)
  86 {
  87     AVCodecContext* avctx = ptr;
  88     if(avctx->codec && avctx->codec->decode) return AV_CLASS_CATEGORY_DECODER;
  89     else                                     return AV_CLASS_CATEGORY_ENCODER;
  90 }
  91
  92 static const AVClass av_codec_context_class = {
  93     .class_name              = "AVCodecContext",
  94     .item_name               = context_to_name,
  95     .option                  = avcodec_options,
  96     .version                 = LIBAVUTIL_VERSION_INT,
  97     .log_level_offset_offset = offsetof(AVCodecContext, log_level_offset),
  98     .child_next              = codec_child_next,
  99 #if FF_API_CHILD_CLASS_NEXT
 100     .child_class_next        = codec_child_class_next,
 101 #endif
 102     .child_class_iterate     = codec_child_class_iterate,
 103     .category                = AV_CLASS_CATEGORY_ENCODER,
 104     .get_category            = get_category,
 105 };
 106
 107 static int init_context_defaults(AVCodecContext *s, const AVCodec *codec)
 108 {
 109     int flags=0;
 110     memset(s, 0, sizeof(AVCodecContext));
 111
 112     s->av_class = &av_codec_context_class;
 113
 114     s->codec_type = codec ? codec->type : AVMEDIA_TYPE_UNKNOWN;
 115     if (codec) {
 116         s->codec = codec;
 117         s->codec_id = codec->id;
 118     }
 119
 120     if(s->codec_type == AVMEDIA_TYPE_AUDIO)
 121         flags= AV_OPT_FLAG_AUDIO_PARAM;
 122     else if(s->codec_type == AVMEDIA_TYPE_VIDEO)
 123         flags= AV_OPT_FLAG_VIDEO_PARAM;
 124     else if(s->codec_type == AVMEDIA_TYPE_SUBTITLE)
 125         flags= AV_OPT_FLAG_SUBTITLE_PARAM;
 126     av_opt_set_defaults2(s, flags, flags);
 127
 128     s->time_base           = (AVRational){0,1};
 129     s->framerate           = (AVRational){ 0, 1 };
 130     s->pkt_timebase        = (AVRational){ 0, 1 };
 131     s->get_buffer2         = avcodec_default_get_buffer2;
 132     s->get_format          = avcodec_default_get_format;
 133     s->execute             = avcodec_default_execute;
 134     s->execute2            = avcodec_default_execute2;
 135     s->sample_aspect_ratio = (AVRational){0,1};
 136     s->pix_fmt             = AV_PIX_FMT_NONE;
 137     s->sw_pix_fmt          = AV_PIX_FMT_NONE;
 138     s->sample_fmt          = AV_SAMPLE_FMT_NONE;
 139
 140     s->reordered_opaque    = AV_NOPTS_VALUE;
 141     if(codec && codec->priv_data_size){
 142         if(!s->priv_data){
 143             s->priv_data= av_mallocz(codec->priv_data_size);
 144             if (!s->priv_data) {
 145                 return AVERROR(ENOMEM);
 146             }
 147         }
 148         if(codec->priv_class){
 149             *(const AVClass**)s->priv_data = codec->priv_class;
 150             av_opt_set_defaults(s->priv_data);
 151         }
 152     }
 153     if (codec && codec->defaults) {
 154         int ret;
 155         const AVCodecDefault *d = codec->defaults;
 156         while (d->key) {
 157             ret = av_opt_set(s, d->key, d->value, 0);
 158             av_assert0(ret >= 0);
 159             d++;
 160         }
 161     }
 162     return 0;
 163 }
 164
 165 #if FF_API_GET_CONTEXT_DEFAULTS
 166 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec)
 167 {
 168     return init_context_defaults(s, codec);
 169 }
 170 #endif
 171
 172 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec)
 173 {
 174     AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
 175
 176     if (!avctx)
 177         return NULL;
 178
 179     if (init_context_defaults(avctx, codec) < 0) {
 180         av_free(avctx);
 181         return NULL;
 182     }
 183
 184     return avctx;
 185 }
 186
 187 void avcodec_free_context(AVCodecContext **pavctx)
 188 {
 189     AVCodecContext *avctx = *pavctx;
 190
 191     if (!avctx)
 192         return;
 193
 194     avcodec_close(avctx);
 195
 196     av_freep(&avctx->extradata);
 197     av_freep(&avctx->subtitle_header);
 198     av_freep(&avctx->intra_matrix);
 199     av_freep(&avctx->inter_matrix);
 200     av_freep(&avctx->rc_override);
 201
 202     av_freep(pavctx);
 203 }
 204
 205 #if FF_API_COPY_CONTEXT
 206 static void copy_context_reset(AVCodecContext *avctx)
 207 {
 208     int i;
 209
 210     av_opt_free(avctx);
 211 #if FF_API_CODED_FRAME
 212 FF_DISABLE_DEPRECATION_WARNINGS
 213     av_frame_free(&avctx->coded_frame);
 214 FF_ENABLE_DEPRECATION_WARNINGS
 215 #endif
 216     av_freep(&avctx->rc_override);
 217     av_freep(&avctx->intra_matrix);
 218     av_freep(&avctx->inter_matrix);
 219     av_freep(&avctx->extradata);
 220     av_freep(&avctx->subtitle_header);
 221     av_buffer_unref(&avctx->hw_frames_ctx);
 222     av_buffer_unref(&avctx->hw_device_ctx);
 223     for (i = 0; i < avctx->nb_coded_side_data; i++)
 224         av_freep(&avctx->coded_side_data[i].data);
 225     av_freep(&avctx->coded_side_data);
 226     avctx->subtitle_header_size = 0;
 227     avctx->nb_coded_side_data = 0;
 228     avctx->extradata_size = 0;
 229 }
 230
 231 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
 232 {
 233     const AVCodec *orig_codec = dest->codec;
 234     uint8_t *orig_priv_data = dest->priv_data;
 235
 236     if (avcodec_is_open(dest)) { // check that the dest context is uninitialized
 237         av_log(dest, AV_LOG_ERROR,
 238                "Tried to copy AVCodecContext %p into already-initialized %p\n",
 239                src, dest);
 240         return AVERROR(EINVAL);
 241     }
 242
 243     copy_context_reset(dest);
 244
 245     memcpy(dest, src, sizeof(*dest));
 246     av_opt_copy(dest, src);
 247
 248     dest->priv_data       = orig_priv_data;
 249     dest->codec           = orig_codec;
 250
 251     if (orig_priv_data && src->codec && src->codec->priv_class &&
 252         dest->codec && dest->codec->priv_class)
 253         av_opt_copy(orig_priv_data, src->priv_data);
 254
 255
 256     /* set values specific to opened codecs back to their default state */
 257     dest->slice_offset    = NULL;
 258     dest->hwaccel         = NULL;
 259     dest->internal        = NULL;
 260 #if FF_API_CODED_FRAME
 261 FF_DISABLE_DEPRECATION_WARNINGS
 262     dest->coded_frame     = NULL;
 263 FF_ENABLE_DEPRECATION_WARNINGS
 264 #endif
 265
 266     /* reallocate values that should be allocated separately */
 267     dest->extradata       = NULL;
 268     dest->coded_side_data = NULL;
 269     dest->intra_matrix    = NULL;
 270     dest->inter_matrix    = NULL;
 271     dest->rc_override     = NULL;
 272     dest->subtitle_header = NULL;
 273     dest->hw_frames_ctx   = NULL;
 274     dest->hw_device_ctx   = NULL;
 275     dest->nb_coded_side_data = 0;
 276
 277 #define alloc_and_copy_or_fail(obj, size, pad) \
 278     if (src->obj && size > 0) { \
 279         dest->obj = av_malloc(size + pad); \
 280         if (!dest->obj) \
 281             goto fail; \
 282         memcpy(dest->obj, src->obj, size); \
 283         if (pad) \
 284             memset(((uint8_t *) dest->obj) + size, 0, pad); \
 285     }
 286     alloc_and_copy_or_fail(extradata,    src->extradata_size,
 287                            AV_INPUT_BUFFER_PADDING_SIZE);
 288     dest->extradata_size  = src->extradata_size;
 289     alloc_and_copy_or_fail(intra_matrix, 64 * sizeof(int16_t), 0);
 290     alloc_and_copy_or_fail(inter_matrix, 64 * sizeof(int16_t), 0);
 291     alloc_and_copy_or_fail(rc_override,  src->rc_override_count * sizeof(*src->rc_override), 0);
 292     alloc_and_copy_or_fail(subtitle_header, src->subtitle_header_size, 1);
 293     av_assert0(dest->subtitle_header_size == src->subtitle_header_size);
 294 #undef alloc_and_copy_or_fail
 295
 296     if (src->hw_frames_ctx) {
 297         dest->hw_frames_ctx = av_buffer_ref(src->hw_frames_ctx);
 298         if (!dest->hw_frames_ctx)
 299             goto fail;
 300     }
 301
 302     return 0;
 303
 304 fail:
 305     copy_context_reset(dest);
 306     return AVERROR(ENOMEM);
 307 }
 308 #endif
 309
 310 const AVClass *avcodec_get_class(void)
 311 {
 312     return &av_codec_context_class;
 313 }
 314
 315 #define FOFFSET(x) offsetof(AVFrame,x)
 316
 317 static const AVOption frame_options[]={
 318 {"best_effort_timestamp", "", FOFFSET(best_effort_timestamp), AV_OPT_TYPE_INT64, {.i64 = AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, 0},
 319 {"pkt_pos", "", FOFFSET(pkt_pos), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
 320 {"pkt_size", "", FOFFSET(pkt_size), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
 321 {"sample_aspect_ratio", "", FOFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL, {.dbl = 0 }, 0, INT_MAX, 0},
 322 {"width", "", FOFFSET(width), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 323 {"height", "", FOFFSET(height), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 324 {"format", "", FOFFSET(format), AV_OPT_TYPE_INT, {.i64 = -1 }, 0, INT_MAX, 0},
 325 {"channel_layout", "", FOFFSET(channel_layout), AV_OPT_TYPE_INT64, {.i64 = 0 }, 0, INT64_MAX, 0},
 326 {"sample_rate", "", FOFFSET(sample_rate), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 327 {NULL},
 328 };
 329
 330 static const AVClass av_frame_class = {
 331     .class_name              = "AVFrame",
 332     .item_name               = NULL,
 333     .option                  = frame_options,
 334     .version                 = LIBAVUTIL_VERSION_INT,
 335 };
 336
 337 const AVClass *avcodec_get_frame_class(void)
 338 {
 339     return &av_frame_class;
 340 }
 341
 342 #define SROFFSET(x) offsetof(AVSubtitleRect,x)
 343
 344 static const AVOption subtitle_rect_options[]={
 345 {"x", "", SROFFSET(x), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 346 {"y", "", SROFFSET(y), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 347 {"w", "", SROFFSET(w), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 348 {"h", "", SROFFSET(h), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 349 {"type", "", SROFFSET(type), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 350 {"flags", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0, "flags"},
 351 {"forced", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0},
 352 {NULL},
 353 };
 354
 355 static const AVClass av_subtitle_rect_class = {
 356     .class_name             = "AVSubtitleRect",
 357     .item_name              = NULL,
 358     .option                 = subtitle_rect_options,
 359     .version                = LIBAVUTIL_VERSION_INT,
 360 };
 361
 362 const AVClass *avcodec_get_subtitle_rect_class(void)
 363 {
 364     return &av_subtitle_rect_class;
 365 }