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