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->get_encode_buffer   = avcodec_default_get_encode_buffer;
 134     s->execute             = avcodec_default_execute;
 135     s->execute2            = avcodec_default_execute2;
 136     s->sample_aspect_ratio = (AVRational){0,1};
 137     s->pix_fmt             = AV_PIX_FMT_NONE;
 138     s->sw_pix_fmt          = AV_PIX_FMT_NONE;
 139     s->sample_fmt          = AV_SAMPLE_FMT_NONE;
 140
 141     s->reordered_opaque    = AV_NOPTS_VALUE;
 142     if(codec && codec->priv_data_size){
 143             s->priv_data= av_mallocz(codec->priv_data_size);
 144             if (!s->priv_data) {
 145                 return AVERROR(ENOMEM);
 146             }
 147         if(codec->priv_class){
 148             *(const AVClass**)s->priv_data = codec->priv_class;
 149             av_opt_set_defaults(s->priv_data);
 150         }
 151     }
 152     if (codec && codec->defaults) {
 153         int ret;
 154         const AVCodecDefault *d = codec->defaults;
 155         while (d->key) {
 156             ret = av_opt_set(s, d->key, d->value, 0);
 157             av_assert0(ret >= 0);
 158             d++;
 159         }
 160     }
 161     return 0;
 162 }
 163
 164 #if FF_API_GET_CONTEXT_DEFAULTS
 165 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec)
 166 {
 167     return init_context_defaults(s, codec);
 168 }
 169 #endif
 170
 171 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec)
 172 {
 173     AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
 174
 175     if (!avctx)
 176         return NULL;
 177
 178     if (init_context_defaults(avctx, codec) < 0) {
 179         av_free(avctx);
 180         return NULL;
 181     }
 182
 183     return avctx;
 184 }
 185
 186 void avcodec_free_context(AVCodecContext **pavctx)
 187 {
 188     AVCodecContext *avctx = *pavctx;
 189
 190     if (!avctx)
 191         return;
 192
 193     avcodec_close(avctx);
 194
 195     av_freep(&avctx->extradata);
 196     av_freep(&avctx->subtitle_header);
 197     av_freep(&avctx->intra_matrix);
 198     av_freep(&avctx->inter_matrix);
 199     av_freep(&avctx->rc_override);
 200
 201     av_freep(pavctx);
 202 }
 203
 204 #if FF_API_COPY_CONTEXT
 205 static void copy_context_reset(AVCodecContext *avctx)
 206 {
 207     int i;
 208
 209     av_opt_free(avctx);
 210 #if FF_API_CODED_FRAME
 211 FF_DISABLE_DEPRECATION_WARNINGS
 212     av_frame_free(&avctx->coded_frame);
 213 FF_ENABLE_DEPRECATION_WARNINGS
 214 #endif
 215     av_freep(&avctx->rc_override);
 216     av_freep(&avctx->intra_matrix);
 217     av_freep(&avctx->inter_matrix);
 218     av_freep(&avctx->extradata);
 219     av_freep(&avctx->subtitle_header);
 220     av_buffer_unref(&avctx->hw_frames_ctx);
 221     av_buffer_unref(&avctx->hw_device_ctx);
 222     for (i = 0; i < avctx->nb_coded_side_data; i++)
 223         av_freep(&avctx->coded_side_data[i].data);
 224     av_freep(&avctx->coded_side_data);
 225     avctx->subtitle_header_size = 0;
 226     avctx->nb_coded_side_data = 0;
 227     avctx->extradata_size = 0;
 228 }
 229
 230 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
 231 {
 232     const AVCodec *orig_codec = dest->codec;
 233     uint8_t *orig_priv_data = dest->priv_data;
 234
 235     if (avcodec_is_open(dest)) { // check that the dest context is uninitialized
 236         av_log(dest, AV_LOG_ERROR,
 237                "Tried to copy AVCodecContext %p into already-initialized %p\n",
 238                src, dest);
 239         return AVERROR(EINVAL);
 240     }
 241
 242     copy_context_reset(dest);
 243
 244     memcpy(dest, src, sizeof(*dest));
 245     av_opt_copy(dest, src);
 246
 247     dest->priv_data       = orig_priv_data;
 248     dest->codec           = orig_codec;
 249
 250     if (orig_priv_data && src->codec && src->codec->priv_class &&
 251         dest->codec && dest->codec->priv_class)
 252         av_opt_copy(orig_priv_data, src->priv_data);
 253
 254
 255     /* set values specific to opened codecs back to their default state */
 256     dest->slice_offset    = NULL;
 257     dest->hwaccel         = NULL;
 258     dest->internal        = NULL;
 259 #if FF_API_CODED_FRAME
 260 FF_DISABLE_DEPRECATION_WARNINGS
 261     dest->coded_frame     = NULL;
 262 FF_ENABLE_DEPRECATION_WARNINGS
 263 #endif
 264
 265     /* reallocate values that should be allocated separately */
 266     dest->extradata       = NULL;
 267     dest->coded_side_data = NULL;
 268     dest->intra_matrix    = NULL;
 269     dest->inter_matrix    = NULL;
 270     dest->rc_override     = NULL;
 271     dest->subtitle_header = NULL;
 272     dest->hw_frames_ctx   = NULL;
 273     dest->hw_device_ctx   = NULL;
 274     dest->nb_coded_side_data = 0;
 275
 276 #define alloc_and_copy_or_fail(obj, size, pad) \
 277     if (src->obj && size > 0) { \
 278         dest->obj = av_malloc(size + pad); \
 279         if (!dest->obj) \
 280             goto fail; \
 281         memcpy(dest->obj, src->obj, size); \
 282         if (pad) \
 283             memset(((uint8_t *) dest->obj) + size, 0, pad); \
 284     }
 285     alloc_and_copy_or_fail(extradata,    src->extradata_size,
 286                            AV_INPUT_BUFFER_PADDING_SIZE);
 287     dest->extradata_size  = src->extradata_size;
 288     alloc_and_copy_or_fail(intra_matrix, 64 * sizeof(int16_t), 0);
 289     alloc_and_copy_or_fail(inter_matrix, 64 * sizeof(int16_t), 0);
 290     alloc_and_copy_or_fail(rc_override,  src->rc_override_count * sizeof(*src->rc_override), 0);
 291     alloc_and_copy_or_fail(subtitle_header, src->subtitle_header_size, 1);
 292     av_assert0(dest->subtitle_header_size == src->subtitle_header_size);
 293 #undef alloc_and_copy_or_fail
 294
 295     if (src->hw_frames_ctx) {
 296         dest->hw_frames_ctx = av_buffer_ref(src->hw_frames_ctx);
 297         if (!dest->hw_frames_ctx)
 298             goto fail;
 299     }
 300
 301     return 0;
 302
 303 fail:
 304     copy_context_reset(dest);
 305     return AVERROR(ENOMEM);
 306 }
 307 #endif
 308
 309 const AVClass *avcodec_get_class(void)
 310 {
 311     return &av_codec_context_class;
 312 }
 313
 314 #if FF_API_GET_FRAME_CLASS
 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 #endif
 342
 343 #define SROFFSET(x) offsetof(AVSubtitleRect,x)
 344
 345 static const AVOption subtitle_rect_options[]={
 346 {"x", "", SROFFSET(x), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 347 {"y", "", SROFFSET(y), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 348 {"w", "", SROFFSET(w), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 349 {"h", "", SROFFSET(h), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 350 {"type", "", SROFFSET(type), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 351 {"flags", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0, "flags"},
 352 {"forced", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0},
 353 {NULL},
 354 };
 355
 356 static const AVClass av_subtitle_rect_class = {
 357     .class_name             = "AVSubtitleRect",
 358     .item_name              = NULL,
 359     .option                 = subtitle_rect_options,
 360     .version                = LIBAVUTIL_VERSION_INT,
 361 };
 362
 363 const AVClass *avcodec_get_subtitle_rect_class(void)
 364 {
 365     return &av_subtitle_rect_class;
 366 }