libavcodec/options.c
78acb9e7
 /*
406792e7
  * Copyright (c) 2001 Fabrice Bellard
78acb9e7
  * Copyright (c) 2002-2004 Michael Niedermayer <michaelni@gmx.at>
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 /**
ba87f080
  * @file
78acb9e7
  * Options definition for AVCodecContext.
  */
 
 #include "avcodec.h"
84626b36
 #include "internal.h"
 #include "libavutil/avassert.h"
a75c2eb2
 #include "libavutil/internal.h"
1d9c2dc8
 #include "libavutil/mem.h"
6ed04040
 #include "libavutil/opt.h"
78acb9e7
 #include <float.h>              /* FLT_MIN, FLT_MAX */
1d9c2dc8
 #include <string.h>
78acb9e7
 
f046c3b5
 FF_DISABLE_DEPRECATION_WARNINGS
56266971
 #include "options_table.h"
f046c3b5
 FF_ENABLE_DEPRECATION_WARNINGS
56266971
 
78acb9e7
 static const char* context_to_name(void* ptr) {
     AVCodecContext *avc= ptr;
 
     if(avc && avc->codec && avc->codec->name)
         return avc->codec->name;
     else
         return "NULL";
 }
 
641c7afe
 static void *codec_child_next(void *obj, void *prev)
78440c00
 {
     AVCodecContext *s = obj;
641c7afe
     if (!prev && s->codec && s->codec->priv_class && s->priv_data)
         return s->priv_data;
     return NULL;
 }
 
 static const AVClass *codec_child_class_next(const AVClass *prev)
 {
     AVCodec *c = NULL;
78440c00
 
641c7afe
     /* find the codec that corresponds to prev */
     while (prev && (c = av_codec_next(c)))
         if (c->priv_class == prev)
             break;
78440c00
 
641c7afe
     /* find next codec with priv options */
     while (c = av_codec_next(c))
         if (c->priv_class)
             return c->priv_class;
78440c00
     return NULL;
 }
 
938e4470
 static AVClassCategory get_category(void *ptr)
6fb7d03d
 {
938e4470
     AVCodecContext* avctx = ptr;
6fb7d03d
     if(avctx->codec && avctx->codec->decode) return AV_CLASS_CATEGORY_DECODER;
     else                                     return AV_CLASS_CATEGORY_ENCODER;
 }
 
0ba1e197
 static const AVClass av_codec_context_class = {
     .class_name              = "AVCodecContext",
     .item_name               = context_to_name,
b5a13865
     .option                  = avcodec_options,
0ba1e197
     .version                 = LIBAVUTIL_VERSION_INT,
56266971
     .log_level_offset_offset = offsetof(AVCodecContext, log_level_offset),
641c7afe
     .child_next              = codec_child_next,
     .child_class_next        = codec_child_class_next,
a5c7525b
     .category                = AV_CLASS_CATEGORY_ENCODER,
938e4470
     .get_category            = get_category,
0ba1e197
 };
78acb9e7
 
0a0f19b5
 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec)
 {
78acb9e7
     int flags=0;
     memset(s, 0, sizeof(AVCodecContext));
 
f0eeff70
     s->av_class = &av_codec_context_class;
78acb9e7
 
f0eeff70
     s->codec_type = codec ? codec->type : AVMEDIA_TYPE_UNKNOWN;
d1d39042
     if (codec) {
         s->codec = codec;
2ae91c86
         s->codec_id = codec->id;
d1d39042
     }
2ae91c86
 
d0492578
     if(s->codec_type == AVMEDIA_TYPE_AUDIO)
78acb9e7
         flags= AV_OPT_FLAG_AUDIO_PARAM;
d0492578
     else if(s->codec_type == AVMEDIA_TYPE_VIDEO)
78acb9e7
         flags= AV_OPT_FLAG_VIDEO_PARAM;
d0492578
     else if(s->codec_type == AVMEDIA_TYPE_SUBTITLE)
78acb9e7
         flags= AV_OPT_FLAG_SUBTITLE_PARAM;
     av_opt_set_defaults2(s, flags, flags);
 
f0eeff70
     s->time_base           = (AVRational){0,1};
7ea1b347
     s->framerate           = (AVRational){ 0, 1 };
01974a58
     s->pkt_timebase        = (AVRational){ 0, 1 };
759001c5
     s->get_buffer2         = avcodec_default_get_buffer2;
f0eeff70
     s->get_format          = avcodec_default_get_format;
     s->execute             = avcodec_default_execute;
     s->execute2            = avcodec_default_execute2;
     s->sample_aspect_ratio = (AVRational){0,1};
716d413c
     s->pix_fmt             = AV_PIX_FMT_NONE;
f0eeff70
     s->sample_fmt          = AV_SAMPLE_FMT_NONE;
78acb9e7
 
f0eeff70
     s->reordered_opaque    = AV_NOPTS_VALUE;
dc51a72b
     if(codec && codec->priv_data_size){
         if(!s->priv_data){
             s->priv_data= av_mallocz(codec->priv_data_size);
             if (!s->priv_data) {
                 return AVERROR(ENOMEM);
             }
         }
         if(codec->priv_class){
fa9aeb82
             *(const AVClass**)s->priv_data = codec->priv_class;
dc51a72b
             av_opt_set_defaults(s->priv_data);
         }
     }
84626b36
     if (codec && codec->defaults) {
         int ret;
fa9aeb82
         const AVCodecDefault *d = codec->defaults;
84626b36
         while (d->key) {
513b6919
             ret = av_opt_set(s, d->key, d->value, 0);
84626b36
             av_assert0(ret >= 0);
             d++;
         }
     }
dc51a72b
     return 0;
 }
 
0a0f19b5
 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec)
 {
dc51a72b
     AVCodecContext *avctx= av_malloc(sizeof(AVCodecContext));
 
f929ab05
     if (!avctx)
         return NULL;
dc51a72b
 
     if(avcodec_get_context_defaults3(avctx, codec) < 0){
         av_free(avctx);
         return NULL;
     }
 
     return avctx;
 }
 
fd056029
 void avcodec_free_context(AVCodecContext **pavctx)
 {
     AVCodecContext *avctx = *pavctx;
 
     if (!avctx)
         return;
 
     avcodec_close(avctx);
 
     av_freep(&avctx->extradata);
     av_freep(&avctx->subtitle_header);
345cfd04
     av_freep(&avctx->intra_matrix);
     av_freep(&avctx->inter_matrix);
     av_freep(&avctx->rc_override);
fd056029
 
     av_freep(pavctx);
 }
 
d1032180
 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
 {
efc7df6c
     const AVCodec *orig_codec = dest->codec;
     uint8_t *orig_priv_data = dest->priv_data;
 
af08d9ae
     if (avcodec_is_open(dest)) { // check that the dest context is uninitialized
d1032180
         av_log(dest, AV_LOG_ERROR,
                "Tried to copy AVCodecContext %p into already-initialized %p\n",
                src, dest);
         return AVERROR(EINVAL);
     }
cba9a40d
 
     av_opt_free(dest);
8616c5b7
     av_freep(&dest->rc_override);
     av_freep(&dest->intra_matrix);
     av_freep(&dest->inter_matrix);
     av_freep(&dest->extradata);
     av_freep(&dest->subtitle_header);
cba9a40d
 
d1032180
     memcpy(dest, src, sizeof(*dest));
db2caf0a
     av_opt_copy(dest, src);
d1032180
 
efc7df6c
     dest->priv_data       = orig_priv_data;
53b2809f
     dest->codec           = orig_codec;
8b686c88
 
53b2809f
     if (orig_priv_data && src->codec && src->codec->priv_class &&
         dest->codec && dest->codec->priv_class)
8b686c88
         av_opt_copy(orig_priv_data, src->priv_data);
 
efc7df6c
 
d1032180
     /* set values specific to opened codecs back to their default state */
     dest->slice_offset    = NULL;
     dest->hwaccel         = NULL;
f3a29b75
     dest->internal        = NULL;
a368920e
 #if FF_API_CODED_FRAME
 FF_DISABLE_DEPRECATION_WARNINGS
8616c5b7
     dest->coded_frame     = NULL;
a368920e
 FF_ENABLE_DEPRECATION_WARNINGS
 #endif
d1032180
 
     /* reallocate values that should be allocated separately */
     dest->extradata       = NULL;
     dest->intra_matrix    = NULL;
     dest->inter_matrix    = NULL;
     dest->rc_override     = NULL;
3b2fbe67
     dest->subtitle_header = NULL;
d1032180
 
 #define alloc_and_copy_or_fail(obj, size, pad) \
     if (src->obj && size > 0) { \
         dest->obj = av_malloc(size + pad); \
         if (!dest->obj) \
             goto fail; \
         memcpy(dest->obj, src->obj, size); \
         if (pad) \
             memset(((uint8_t *) dest->obj) + size, 0, pad); \
     }
     alloc_and_copy_or_fail(extradata,    src->extradata_size,
059a9348
                            AV_INPUT_BUFFER_PADDING_SIZE);
8616c5b7
     dest->extradata_size  = src->extradata_size;
d1032180
     alloc_and_copy_or_fail(intra_matrix, 64 * sizeof(int16_t), 0);
     alloc_and_copy_or_fail(inter_matrix, 64 * sizeof(int16_t), 0);
     alloc_and_copy_or_fail(rc_override,  src->rc_override_count * sizeof(*src->rc_override), 0);
ceb33f3a
     alloc_and_copy_or_fail(subtitle_header, src->subtitle_header_size, 1);
97f856a4
     av_assert0(dest->subtitle_header_size == src->subtitle_header_size);
d1032180
 #undef alloc_and_copy_or_fail
 
     return 0;
 
 fail:
     av_freep(&dest->rc_override);
     av_freep(&dest->intra_matrix);
     av_freep(&dest->inter_matrix);
     av_freep(&dest->extradata);
8616c5b7
     av_freep(&dest->subtitle_header);
     dest->subtitle_header_size = 0;
     dest->extradata_size = 0;
     av_opt_free(dest);
d1032180
     return AVERROR(ENOMEM);
 }
fb4ca26b
 
 const AVClass *avcodec_get_class(void)
 {
     return &av_codec_context_class;
 }
fef411ef
 
 #define FOFFSET(x) offsetof(AVFrame,x)
 
 static const AVOption frame_options[]={
15a0fb58
 {"best_effort_timestamp", "", FOFFSET(best_effort_timestamp), AV_OPT_TYPE_INT64, {.i64 = AV_NOPTS_VALUE }, INT64_MIN, INT64_MAX, 0},
 {"pkt_pos", "", FOFFSET(pkt_pos), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
96d815fc
 {"pkt_size", "", FOFFSET(pkt_size), AV_OPT_TYPE_INT64, {.i64 = -1 }, INT64_MIN, INT64_MAX, 0},
fef411ef
 {"sample_aspect_ratio", "", FOFFSET(sample_aspect_ratio), AV_OPT_TYPE_RATIONAL, {.dbl = 0 }, 0, INT_MAX, 0},
d46c1c72
 {"width", "", FOFFSET(width), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 {"height", "", FOFFSET(height), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 {"format", "", FOFFSET(format), AV_OPT_TYPE_INT, {.i64 = -1 }, 0, INT_MAX, 0},
15a0fb58
 {"channel_layout", "", FOFFSET(channel_layout), AV_OPT_TYPE_INT64, {.i64 = 0 }, 0, INT64_MAX, 0},
d46c1c72
 {"sample_rate", "", FOFFSET(sample_rate), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
fef411ef
 {NULL},
 };
 
 static const AVClass av_frame_class = {
     .class_name              = "AVFrame",
     .item_name               = NULL,
     .option                  = frame_options,
     .version                 = LIBAVUTIL_VERSION_INT,
 };
 
 const AVClass *avcodec_get_frame_class(void)
 {
     return &av_frame_class;
 }
1f46b50a
 
 #define SROFFSET(x) offsetof(AVSubtitleRect,x)
 
 static const AVOption subtitle_rect_options[]={
d46c1c72
 {"x", "", SROFFSET(x), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 {"y", "", SROFFSET(y), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 {"w", "", SROFFSET(w), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 {"h", "", SROFFSET(h), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
 {"type", "", SROFFSET(type), AV_OPT_TYPE_INT, {.i64 = 0 }, 0, INT_MAX, 0},
1885ffb0
 {"flags", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0, "flags"},
 {"forced", "", SROFFSET(flags), AV_OPT_TYPE_FLAGS, {.i64 = 0}, 0, 1, 0},
1f46b50a
 {NULL},
 };
 
 static const AVClass av_subtitle_rect_class = {
     .class_name             = "AVSubtitleRect",
     .item_name              = NULL,
     .option                 = subtitle_rect_options,
     .version                = LIBAVUTIL_VERSION_INT,
 };
 
 const AVClass *avcodec_get_subtitle_rect_class(void)
 {
     return &av_subtitle_rect_class;
 }
72732307
 
 #ifdef TEST
 static int dummy_init(AVCodecContext *ctx)
 {
     //TODO: this code should set every possible pointer that could be set by codec and is not an option;
     ctx->extradata_size = 8;
     ctx->extradata = av_malloc(ctx->extradata_size);
     return 0;
 }
 
 static int dummy_close(AVCodecContext *ctx)
 {
     av_freep(&ctx->extradata);
     ctx->extradata_size = 0;
     return 0;
 }
 
 static int dummy_encode(AVCodecContext *ctx, AVPacket *pkt, const AVFrame *frame, int *got_packet)
 {
     return AVERROR(ENOSYS);
 }
 
 typedef struct Dummy12Context {
     AVClass  *av_class;
     int      num;
     char*    str;
 } Dummy12Context;
 
 typedef struct Dummy3Context {
     void     *fake_av_class;
     int      num;
     char*    str;
 } Dummy3Context;
 
 #define OFFSET(x) offsetof(Dummy12Context, x)
 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
 static const AVOption dummy_options[] = {
     { "str", "set str", OFFSET(str), AV_OPT_TYPE_STRING, { .str = "i'm src default value" }, 0, 0, VE},
     { "num", "set num", OFFSET(num), AV_OPT_TYPE_INT,    { .i64 = 1500100900 },    0, INT_MAX, VE},
     { NULL },
 };
 
 static const AVClass dummy_v1_class = {
     .class_name = "dummy_v1_class",
     .item_name  = av_default_item_name,
     .option     = dummy_options,
     .version    = LIBAVUTIL_VERSION_INT,
 };
 
 static const AVClass dummy_v2_class = {
     .class_name = "dummy_v2_class",
     .item_name  = av_default_item_name,
     .option     = dummy_options,
     .version    = LIBAVUTIL_VERSION_INT,
 };
 
 /* codec with options */
845fb3d4
 static AVCodec dummy_v1_encoder = {
72732307
     .name             = "dummy_v1_codec",
     .type             = AVMEDIA_TYPE_VIDEO,
     .id               = AV_CODEC_ID_NONE - 1,
     .encode2          = dummy_encode,
     .init             = dummy_init,
     .close            = dummy_close,
     .priv_class       = &dummy_v1_class,
     .priv_data_size   = sizeof(Dummy12Context),
 };
 
 /* codec with options, different class */
845fb3d4
 static AVCodec dummy_v2_encoder = {
72732307
     .name             = "dummy_v2_codec",
     .type             = AVMEDIA_TYPE_VIDEO,
     .id               = AV_CODEC_ID_NONE - 2,
     .encode2          = dummy_encode,
     .init             = dummy_init,
     .close            = dummy_close,
     .priv_class       = &dummy_v2_class,
     .priv_data_size   = sizeof(Dummy12Context),
 };
 
 /* codec with priv data, but no class */
845fb3d4
 static AVCodec dummy_v3_encoder = {
72732307
     .name             = "dummy_v3_codec",
     .type             = AVMEDIA_TYPE_VIDEO,
     .id               = AV_CODEC_ID_NONE - 3,
     .encode2          = dummy_encode,
     .init             = dummy_init,
     .close            = dummy_close,
     .priv_data_size   = sizeof(Dummy3Context),
 };
 
 /* codec without priv data */
845fb3d4
 static AVCodec dummy_v4_encoder = {
72732307
     .name             = "dummy_v4_codec",
     .type             = AVMEDIA_TYPE_VIDEO,
     .id               = AV_CODEC_ID_NONE - 4,
     .encode2          = dummy_encode,
     .init             = dummy_init,
     .close            = dummy_close,
 };
 
 static void test_copy_print_codec(const AVCodecContext *ctx)
 {
     printf("%-14s: %dx%d prv: %s",
            ctx->codec ? ctx->codec->name : "NULL",
            ctx->width, ctx->height,
            ctx->priv_data ? "set" : "null");
     if (ctx->codec && ctx->codec->priv_class && ctx->codec->priv_data_size) {
         int64_t i64;
         char *str = NULL;
         av_opt_get_int(ctx->priv_data, "num", 0, &i64);
         av_opt_get(ctx->priv_data, "str", 0, (uint8_t**)&str);
         printf(" opts: %"PRId64" %s", i64, str);
         av_free(str);
     }
     printf("\n");
 }
 
 static void test_copy(const AVCodec *c1, const AVCodec *c2)
 {
     AVCodecContext *ctx1, *ctx2;
     printf("%s -> %s\nclosed:\n", c1 ? c1->name : "NULL", c2 ? c2->name : "NULL");
     ctx1 = avcodec_alloc_context3(c1);
     ctx2 = avcodec_alloc_context3(c2);
     ctx1->width = ctx1->height = 128;
     if (ctx2->codec && ctx2->codec->priv_class && ctx2->codec->priv_data_size) {
         av_opt_set(ctx2->priv_data, "num", "667", 0);
         av_opt_set(ctx2->priv_data, "str", "i'm dest value before copy", 0);
     }
     avcodec_copy_context(ctx2, ctx1);
     test_copy_print_codec(ctx1);
     test_copy_print_codec(ctx2);
     if (ctx1->codec) {
         printf("opened:\n");
         avcodec_open2(ctx1, ctx1->codec, NULL);
         if (ctx2->codec && ctx2->codec->priv_class && ctx2->codec->priv_data_size) {
             av_opt_set(ctx2->priv_data, "num", "667", 0);
             av_opt_set(ctx2->priv_data, "str", "i'm dest value before copy", 0);
         }
         avcodec_copy_context(ctx2, ctx1);
         test_copy_print_codec(ctx1);
         test_copy_print_codec(ctx2);
         avcodec_close(ctx1);
     }
     avcodec_free_context(&ctx1);
     avcodec_free_context(&ctx2);
 }
 
 int main(void)
 {
     AVCodec *dummy_codec[] = {
         &dummy_v1_encoder,
         &dummy_v2_encoder,
         &dummy_v3_encoder,
         &dummy_v4_encoder,
         NULL,
     };
     int i, j;
 
     for (i = 0; dummy_codec[i]; i++)
         avcodec_register(dummy_codec[i]);
 
     printf("testing avcodec_copy_context()\n");
     for (i = 0; i < FF_ARRAY_ELEMS(dummy_codec); i++)
         for (j = 0; j < FF_ARRAY_ELEMS(dummy_codec); j++)
             test_copy(dummy_codec[i], dummy_codec[j]);
     return 0;
 }
 #endif