git.sesse.net Git - ffmpeg/blob - libavutil/frame.c

   1 /*
   2  * This file is part of FFmpeg.
   3  *
   4  * FFmpeg is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * FFmpeg is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with FFmpeg; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #include "channel_layout.h"
  20 #include "avassert.h"
  21 #include "buffer.h"
  22 #include "common.h"
  23 #include "dict.h"
  24 #include "frame.h"
  25 #include "imgutils.h"
  26 #include "mem.h"
  27 #include "samplefmt.h"
  28
  29 MAKE_ACCESSORS(AVFrame, frame, int64_t, best_effort_timestamp)
  30 MAKE_ACCESSORS(AVFrame, frame, int64_t, pkt_duration)
  31 MAKE_ACCESSORS(AVFrame, frame, int64_t, pkt_pos)
  32 MAKE_ACCESSORS(AVFrame, frame, int64_t, channel_layout)
  33 MAKE_ACCESSORS(AVFrame, frame, int,     channels)
  34 MAKE_ACCESSORS(AVFrame, frame, int,     sample_rate)
  35 MAKE_ACCESSORS(AVFrame, frame, AVDictionary *, metadata)
  36 MAKE_ACCESSORS(AVFrame, frame, int,     decode_error_flags)
  37 MAKE_ACCESSORS(AVFrame, frame, int,     pkt_size)
  38 MAKE_ACCESSORS(AVFrame, frame, enum AVColorSpace, colorspace)
  39 MAKE_ACCESSORS(AVFrame, frame, enum AVColorRange, color_range)
  40
  41 #define CHECK_CHANNELS_CONSISTENCY(frame) \
  42     av_assert2(!(frame)->channel_layout || \
  43                (frame)->channels == \
  44                av_get_channel_layout_nb_channels((frame)->channel_layout))
  45
  46 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame) {return &frame->metadata;};
  47
  48 #if FF_API_FRAME_QP
  49 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int qp_type)
  50 {
  51     av_buffer_unref(&f->qp_table_buf);
  52
  53     f->qp_table_buf = buf;
  54
  55 FF_DISABLE_DEPRECATION_WARNINGS
  56     f->qscale_table = buf->data;
  57     f->qstride      = stride;
  58     f->qscale_type  = qp_type;
  59 FF_ENABLE_DEPRECATION_WARNINGS
  60
  61     return 0;
  62 }
  63
  64 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type)
  65 {
  66 FF_DISABLE_DEPRECATION_WARNINGS
  67     *stride = f->qstride;
  68     *type   = f->qscale_type;
  69 FF_ENABLE_DEPRECATION_WARNINGS
  70
  71     if (!f->qp_table_buf)
  72         return NULL;
  73
  74     return f->qp_table_buf->data;
  75 }
  76 #endif
  77
  78 const char *av_get_colorspace_name(enum AVColorSpace val)
  79 {
  80     static const char * const name[] = {
  81         [AVCOL_SPC_RGB]       = "GBR",
  82         [AVCOL_SPC_BT709]     = "bt709",
  83         [AVCOL_SPC_FCC]       = "fcc",
  84         [AVCOL_SPC_BT470BG]   = "bt470bg",
  85         [AVCOL_SPC_SMPTE170M] = "smpte170m",
  86         [AVCOL_SPC_SMPTE240M] = "smpte240m",
  87         [AVCOL_SPC_YCOCG]     = "YCgCo",
  88     };
  89     if ((unsigned)val >= FF_ARRAY_ELEMS(name))
  90         return NULL;
  91     return name[val];
  92 }
  93
  94 static void get_frame_defaults(AVFrame *frame)
  95 {
  96     if (frame->extended_data != frame->data)
  97         av_freep(&frame->extended_data);
  98
  99     memset(frame, 0, sizeof(*frame));
 100
 101     frame->pts                   =
 102     frame->pkt_dts               = AV_NOPTS_VALUE;
 103 #if FF_API_PKT_PTS
 104 FF_DISABLE_DEPRECATION_WARNINGS
 105     frame->pkt_pts               = AV_NOPTS_VALUE;
 106 FF_ENABLE_DEPRECATION_WARNINGS
 107 #endif
 108     frame->best_effort_timestamp = AV_NOPTS_VALUE;
 109     frame->pkt_duration        = 0;
 110     frame->pkt_pos             = -1;
 111     frame->pkt_size            = -1;
 112     frame->key_frame           = 1;
 113     frame->sample_aspect_ratio = (AVRational){ 0, 1 };
 114     frame->format              = -1; /* unknown */
 115     frame->extended_data       = frame->data;
 116     frame->color_primaries     = AVCOL_PRI_UNSPECIFIED;
 117     frame->color_trc           = AVCOL_TRC_UNSPECIFIED;
 118     frame->colorspace          = AVCOL_SPC_UNSPECIFIED;
 119     frame->color_range         = AVCOL_RANGE_UNSPECIFIED;
 120     frame->chroma_location     = AVCHROMA_LOC_UNSPECIFIED;
 121     frame->flags               = 0;
 122 }
 123
 124 static void free_side_data(AVFrameSideData **ptr_sd)
 125 {
 126     AVFrameSideData *sd = *ptr_sd;
 127
 128     av_buffer_unref(&sd->buf);
 129     av_dict_free(&sd->metadata);
 130     av_freep(ptr_sd);
 131 }
 132
 133 static void wipe_side_data(AVFrame *frame)
 134 {
 135     int i;
 136
 137     for (i = 0; i < frame->nb_side_data; i++) {
 138         free_side_data(&frame->side_data[i]);
 139     }
 140     frame->nb_side_data = 0;
 141
 142     av_freep(&frame->side_data);
 143 }
 144
 145 AVFrame *av_frame_alloc(void)
 146 {
 147     AVFrame *frame = av_mallocz(sizeof(*frame));
 148
 149     if (!frame)
 150         return NULL;
 151
 152     frame->extended_data = NULL;
 153     get_frame_defaults(frame);
 154
 155     return frame;
 156 }
 157
 158 void av_frame_free(AVFrame **frame)
 159 {
 160     if (!frame || !*frame)
 161         return;
 162
 163     av_frame_unref(*frame);
 164     av_freep(frame);
 165 }
 166
 167 static int get_video_buffer(AVFrame *frame, int align)
 168 {
 169     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(frame->format);
 170     int ret, i;
 171
 172     if (!desc)
 173         return AVERROR(EINVAL);
 174
 175     if ((ret = av_image_check_size(frame->width, frame->height, 0, NULL)) < 0)
 176         return ret;
 177
 178     if (!frame->linesize[0]) {
 179         for(i=1; i<=align; i+=i) {
 180             ret = av_image_fill_linesizes(frame->linesize, frame->format,
 181                                           FFALIGN(frame->width, i));
 182             if (ret < 0)
 183                 return ret;
 184             if (!(frame->linesize[0] & (align-1)))
 185                 break;
 186         }
 187
 188         for (i = 0; i < 4 && frame->linesize[i]; i++)
 189             frame->linesize[i] = FFALIGN(frame->linesize[i], align);
 190     }
 191
 192     for (i = 0; i < 4 && frame->linesize[i]; i++) {
 193         int h = FFALIGN(frame->height, 32);
 194         if (i == 1 || i == 2)
 195             h = AV_CEIL_RSHIFT(h, desc->log2_chroma_h);
 196
 197         frame->buf[i] = av_buffer_alloc(frame->linesize[i] * h + 16 + 16/*STRIDE_ALIGN*/ - 1);
 198         if (!frame->buf[i])
 199             goto fail;
 200
 201         frame->data[i] = frame->buf[i]->data;
 202     }
 203     if (desc->flags & AV_PIX_FMT_FLAG_PAL || desc->flags & AV_PIX_FMT_FLAG_PSEUDOPAL) {
 204         av_buffer_unref(&frame->buf[1]);
 205         frame->buf[1] = av_buffer_alloc(AVPALETTE_SIZE);
 206         if (!frame->buf[1])
 207             goto fail;
 208         frame->data[1] = frame->buf[1]->data;
 209     }
 210
 211     frame->extended_data = frame->data;
 212
 213     return 0;
 214 fail:
 215     av_frame_unref(frame);
 216     return AVERROR(ENOMEM);
 217 }
 218
 219 static int get_audio_buffer(AVFrame *frame, int align)
 220 {
 221     int channels;
 222     int planar   = av_sample_fmt_is_planar(frame->format);
 223     int planes;
 224     int ret, i;
 225
 226     if (!frame->channels)
 227         frame->channels = av_get_channel_layout_nb_channels(frame->channel_layout);
 228
 229     channels = frame->channels;
 230     planes = planar ? channels : 1;
 231
 232     CHECK_CHANNELS_CONSISTENCY(frame);
 233     if (!frame->linesize[0]) {
 234         ret = av_samples_get_buffer_size(&frame->linesize[0], channels,
 235                                          frame->nb_samples, frame->format,
 236                                          align);
 237         if (ret < 0)
 238             return ret;
 239     }
 240
 241     if (planes > AV_NUM_DATA_POINTERS) {
 242         frame->extended_data = av_mallocz_array(planes,
 243                                           sizeof(*frame->extended_data));
 244         frame->extended_buf  = av_mallocz_array((planes - AV_NUM_DATA_POINTERS),
 245                                           sizeof(*frame->extended_buf));
 246         if (!frame->extended_data || !frame->extended_buf) {
 247             av_freep(&frame->extended_data);
 248             av_freep(&frame->extended_buf);
 249             return AVERROR(ENOMEM);
 250         }
 251         frame->nb_extended_buf = planes - AV_NUM_DATA_POINTERS;
 252     } else
 253         frame->extended_data = frame->data;
 254
 255     for (i = 0; i < FFMIN(planes, AV_NUM_DATA_POINTERS); i++) {
 256         frame->buf[i] = av_buffer_alloc(frame->linesize[0]);
 257         if (!frame->buf[i]) {
 258             av_frame_unref(frame);
 259             return AVERROR(ENOMEM);
 260         }
 261         frame->extended_data[i] = frame->data[i] = frame->buf[i]->data;
 262     }
 263     for (i = 0; i < planes - AV_NUM_DATA_POINTERS; i++) {
 264         frame->extended_buf[i] = av_buffer_alloc(frame->linesize[0]);
 265         if (!frame->extended_buf[i]) {
 266             av_frame_unref(frame);
 267             return AVERROR(ENOMEM);
 268         }
 269         frame->extended_data[i + AV_NUM_DATA_POINTERS] = frame->extended_buf[i]->data;
 270     }
 271     return 0;
 272
 273 }
 274
 275 int av_frame_get_buffer(AVFrame *frame, int align)
 276 {
 277     if (frame->format < 0)
 278         return AVERROR(EINVAL);
 279
 280     if (frame->width > 0 && frame->height > 0)
 281         return get_video_buffer(frame, align);
 282     else if (frame->nb_samples > 0 && (frame->channel_layout || frame->channels > 0))
 283         return get_audio_buffer(frame, align);
 284
 285     return AVERROR(EINVAL);
 286 }
 287
 288 static int frame_copy_props(AVFrame *dst, const AVFrame *src, int force_copy)
 289 {
 290     int i;
 291
 292     dst->key_frame              = src->key_frame;
 293     dst->pict_type              = src->pict_type;
 294     dst->sample_aspect_ratio    = src->sample_aspect_ratio;
 295     dst->pts                    = src->pts;
 296     dst->repeat_pict            = src->repeat_pict;
 297     dst->interlaced_frame       = src->interlaced_frame;
 298     dst->top_field_first        = src->top_field_first;
 299     dst->palette_has_changed    = src->palette_has_changed;
 300     dst->sample_rate            = src->sample_rate;
 301     dst->opaque                 = src->opaque;
 302 #if FF_API_PKT_PTS
 303 FF_DISABLE_DEPRECATION_WARNINGS
 304     dst->pkt_pts                = src->pkt_pts;
 305 FF_ENABLE_DEPRECATION_WARNINGS
 306 #endif
 307     dst->pkt_dts                = src->pkt_dts;
 308     dst->pkt_pos                = src->pkt_pos;
 309     dst->pkt_size               = src->pkt_size;
 310     dst->pkt_duration           = src->pkt_duration;
 311     dst->reordered_opaque       = src->reordered_opaque;
 312     dst->quality                = src->quality;
 313     dst->best_effort_timestamp  = src->best_effort_timestamp;
 314     dst->coded_picture_number   = src->coded_picture_number;
 315     dst->display_picture_number = src->display_picture_number;
 316     dst->flags                  = src->flags;
 317     dst->decode_error_flags     = src->decode_error_flags;
 318     dst->color_primaries        = src->color_primaries;
 319     dst->color_trc              = src->color_trc;
 320     dst->colorspace             = src->colorspace;
 321     dst->color_range            = src->color_range;
 322     dst->chroma_location        = src->chroma_location;
 323
 324     av_dict_copy(&dst->metadata, src->metadata, 0);
 325
 326 #if FF_API_ERROR_FRAME
 327 FF_DISABLE_DEPRECATION_WARNINGS
 328     memcpy(dst->error, src->error, sizeof(dst->error));
 329 FF_ENABLE_DEPRECATION_WARNINGS
 330 #endif
 331
 332     for (i = 0; i < src->nb_side_data; i++) {
 333         const AVFrameSideData *sd_src = src->side_data[i];
 334         AVFrameSideData *sd_dst;
 335         if (   sd_src->type == AV_FRAME_DATA_PANSCAN
 336             && (src->width != dst->width || src->height != dst->height))
 337             continue;
 338         if (force_copy) {
 339             sd_dst = av_frame_new_side_data(dst, sd_src->type,
 340                                             sd_src->size);
 341             if (!sd_dst) {
 342                 wipe_side_data(dst);
 343                 return AVERROR(ENOMEM);
 344             }
 345             memcpy(sd_dst->data, sd_src->data, sd_src->size);
 346         } else {
 347             sd_dst = av_frame_new_side_data(dst, sd_src->type, 0);
 348             if (!sd_dst) {
 349                 wipe_side_data(dst);
 350                 return AVERROR(ENOMEM);
 351             }
 352             sd_dst->buf = av_buffer_ref(sd_src->buf);
 353             if (!sd_dst->buf) {
 354                 wipe_side_data(dst);
 355                 return AVERROR(ENOMEM);
 356             }
 357             sd_dst->data = sd_dst->buf->data;
 358             sd_dst->size = sd_dst->buf->size;
 359         }
 360         av_dict_copy(&sd_dst->metadata, sd_src->metadata, 0);
 361     }
 362
 363 #if FF_API_FRAME_QP
 364 FF_DISABLE_DEPRECATION_WARNINGS
 365     dst->qscale_table = NULL;
 366     dst->qstride      = 0;
 367     dst->qscale_type  = 0;
 368     av_buffer_unref(&dst->qp_table_buf);
 369     if (src->qp_table_buf) {
 370         dst->qp_table_buf = av_buffer_ref(src->qp_table_buf);
 371         if (dst->qp_table_buf) {
 372             dst->qscale_table = dst->qp_table_buf->data;
 373             dst->qstride      = src->qstride;
 374             dst->qscale_type  = src->qscale_type;
 375         }
 376     }
 377 FF_ENABLE_DEPRECATION_WARNINGS
 378 #endif
 379
 380     return 0;
 381 }
 382
 383 int av_frame_ref(AVFrame *dst, const AVFrame *src)
 384 {
 385     int i, ret = 0;
 386
 387     av_assert1(dst->width == 0 && dst->height == 0);
 388     av_assert1(dst->channels == 0);
 389
 390     dst->format         = src->format;
 391     dst->width          = src->width;
 392     dst->height         = src->height;
 393     dst->channels       = src->channels;
 394     dst->channel_layout = src->channel_layout;
 395     dst->nb_samples     = src->nb_samples;
 396
 397     ret = frame_copy_props(dst, src, 0);
 398     if (ret < 0)
 399         return ret;
 400
 401     /* duplicate the frame data if it's not refcounted */
 402     if (!src->buf[0]) {
 403         ret = av_frame_get_buffer(dst, 32);
 404         if (ret < 0)
 405             return ret;
 406
 407         ret = av_frame_copy(dst, src);
 408         if (ret < 0)
 409             av_frame_unref(dst);
 410
 411         return ret;
 412     }
 413
 414     /* ref the buffers */
 415     for (i = 0; i < FF_ARRAY_ELEMS(src->buf); i++) {
 416         if (!src->buf[i])
 417             continue;
 418         dst->buf[i] = av_buffer_ref(src->buf[i]);
 419         if (!dst->buf[i]) {
 420             ret = AVERROR(ENOMEM);
 421             goto fail;
 422         }
 423     }
 424
 425     if (src->extended_buf) {
 426         dst->extended_buf = av_mallocz_array(sizeof(*dst->extended_buf),
 427                                        src->nb_extended_buf);
 428         if (!dst->extended_buf) {
 429             ret = AVERROR(ENOMEM);
 430             goto fail;
 431         }
 432         dst->nb_extended_buf = src->nb_extended_buf;
 433
 434         for (i = 0; i < src->nb_extended_buf; i++) {
 435             dst->extended_buf[i] = av_buffer_ref(src->extended_buf[i]);
 436             if (!dst->extended_buf[i]) {
 437                 ret = AVERROR(ENOMEM);
 438                 goto fail;
 439             }
 440         }
 441     }
 442
 443     if (src->hw_frames_ctx) {
 444         dst->hw_frames_ctx = av_buffer_ref(src->hw_frames_ctx);
 445         if (!dst->hw_frames_ctx) {
 446             ret = AVERROR(ENOMEM);
 447             goto fail;
 448         }
 449     }
 450
 451     /* duplicate extended data */
 452     if (src->extended_data != src->data) {
 453         int ch = src->channels;
 454
 455         if (!ch) {
 456             ret = AVERROR(EINVAL);
 457             goto fail;
 458         }
 459         CHECK_CHANNELS_CONSISTENCY(src);
 460
 461         dst->extended_data = av_malloc_array(sizeof(*dst->extended_data), ch);
 462         if (!dst->extended_data) {
 463             ret = AVERROR(ENOMEM);
 464             goto fail;
 465         }
 466         memcpy(dst->extended_data, src->extended_data, sizeof(*src->extended_data) * ch);
 467     } else
 468         dst->extended_data = dst->data;
 469
 470     memcpy(dst->data,     src->data,     sizeof(src->data));
 471     memcpy(dst->linesize, src->linesize, sizeof(src->linesize));
 472
 473     return 0;
 474
 475 fail:
 476     av_frame_unref(dst);
 477     return ret;
 478 }
 479
 480 AVFrame *av_frame_clone(const AVFrame *src)
 481 {
 482     AVFrame *ret = av_frame_alloc();
 483
 484     if (!ret)
 485         return NULL;
 486
 487     if (av_frame_ref(ret, src) < 0)
 488         av_frame_free(&ret);
 489
 490     return ret;
 491 }
 492
 493 void av_frame_unref(AVFrame *frame)
 494 {
 495     int i;
 496
 497     if (!frame)
 498         return;
 499
 500     wipe_side_data(frame);
 501
 502     for (i = 0; i < FF_ARRAY_ELEMS(frame->buf); i++)
 503         av_buffer_unref(&frame->buf[i]);
 504     for (i = 0; i < frame->nb_extended_buf; i++)
 505         av_buffer_unref(&frame->extended_buf[i]);
 506     av_freep(&frame->extended_buf);
 507     av_dict_free(&frame->metadata);
 508 #if FF_API_FRAME_QP
 509     av_buffer_unref(&frame->qp_table_buf);
 510 #endif
 511
 512     av_buffer_unref(&frame->hw_frames_ctx);
 513
 514     get_frame_defaults(frame);
 515 }
 516
 517 void av_frame_move_ref(AVFrame *dst, AVFrame *src)
 518 {
 519     av_assert1(dst->width == 0 && dst->height == 0);
 520     av_assert1(dst->channels == 0);
 521
 522     *dst = *src;
 523     if (src->extended_data == src->data)
 524         dst->extended_data = dst->data;
 525     memset(src, 0, sizeof(*src));
 526     get_frame_defaults(src);
 527 }
 528
 529 int av_frame_is_writable(AVFrame *frame)
 530 {
 531     int i, ret = 1;
 532
 533     /* assume non-refcounted frames are not writable */
 534     if (!frame->buf[0])
 535         return 0;
 536
 537     for (i = 0; i < FF_ARRAY_ELEMS(frame->buf); i++)
 538         if (frame->buf[i])
 539             ret &= !!av_buffer_is_writable(frame->buf[i]);
 540     for (i = 0; i < frame->nb_extended_buf; i++)
 541         ret &= !!av_buffer_is_writable(frame->extended_buf[i]);
 542
 543     return ret;
 544 }
 545
 546 int av_frame_make_writable(AVFrame *frame)
 547 {
 548     AVFrame tmp;
 549     int ret;
 550
 551     if (!frame->buf[0])
 552         return AVERROR(EINVAL);
 553
 554     if (av_frame_is_writable(frame))
 555         return 0;
 556
 557     memset(&tmp, 0, sizeof(tmp));
 558     tmp.format         = frame->format;
 559     tmp.width          = frame->width;
 560     tmp.height         = frame->height;
 561     tmp.channels       = frame->channels;
 562     tmp.channel_layout = frame->channel_layout;
 563     tmp.nb_samples     = frame->nb_samples;
 564     ret = av_frame_get_buffer(&tmp, 32);
 565     if (ret < 0)
 566         return ret;
 567
 568     ret = av_frame_copy(&tmp, frame);
 569     if (ret < 0) {
 570         av_frame_unref(&tmp);
 571         return ret;
 572     }
 573
 574     ret = av_frame_copy_props(&tmp, frame);
 575     if (ret < 0) {
 576         av_frame_unref(&tmp);
 577         return ret;
 578     }
 579
 580     av_frame_unref(frame);
 581
 582     *frame = tmp;
 583     if (tmp.data == tmp.extended_data)
 584         frame->extended_data = frame->data;
 585
 586     return 0;
 587 }
 588
 589 int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
 590 {
 591     return frame_copy_props(dst, src, 1);
 592 }
 593
 594 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane)
 595 {
 596     uint8_t *data;
 597     int planes, i;
 598
 599     if (frame->nb_samples) {
 600         int channels = frame->channels;
 601         if (!channels)
 602             return NULL;
 603         CHECK_CHANNELS_CONSISTENCY(frame);
 604         planes = av_sample_fmt_is_planar(frame->format) ? channels : 1;
 605     } else
 606         planes = 4;
 607
 608     if (plane < 0 || plane >= planes || !frame->extended_data[plane])
 609         return NULL;
 610     data = frame->extended_data[plane];
 611
 612     for (i = 0; i < FF_ARRAY_ELEMS(frame->buf) && frame->buf[i]; i++) {
 613         AVBufferRef *buf = frame->buf[i];
 614         if (data >= buf->data && data < buf->data + buf->size)
 615             return buf;
 616     }
 617     for (i = 0; i < frame->nb_extended_buf; i++) {
 618         AVBufferRef *buf = frame->extended_buf[i];
 619         if (data >= buf->data && data < buf->data + buf->size)
 620             return buf;
 621     }
 622     return NULL;
 623 }
 624
 625 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
 626                                         enum AVFrameSideDataType type,
 627                                         int size)
 628 {
 629     AVFrameSideData *ret, **tmp;
 630
 631     if (frame->nb_side_data > INT_MAX / sizeof(*frame->side_data) - 1)
 632         return NULL;
 633
 634     tmp = av_realloc(frame->side_data,
 635                      (frame->nb_side_data + 1) * sizeof(*frame->side_data));
 636     if (!tmp)
 637         return NULL;
 638     frame->side_data = tmp;
 639
 640     ret = av_mallocz(sizeof(*ret));
 641     if (!ret)
 642         return NULL;
 643
 644     if (size > 0) {
 645         ret->buf = av_buffer_alloc(size);
 646         if (!ret->buf) {
 647             av_freep(&ret);
 648             return NULL;
 649         }
 650
 651         ret->data = ret->buf->data;
 652         ret->size = size;
 653     }
 654     ret->type = type;
 655
 656     frame->side_data[frame->nb_side_data++] = ret;
 657
 658     return ret;
 659 }
 660
 661 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
 662                                         enum AVFrameSideDataType type)
 663 {
 664     int i;
 665
 666     for (i = 0; i < frame->nb_side_data; i++) {
 667         if (frame->side_data[i]->type == type)
 668             return frame->side_data[i];
 669     }
 670     return NULL;
 671 }
 672
 673 static int frame_copy_video(AVFrame *dst, const AVFrame *src)
 674 {
 675     const uint8_t *src_data[4];
 676     int i, planes;
 677
 678     if (dst->width  < src->width ||
 679         dst->height < src->height)
 680         return AVERROR(EINVAL);
 681
 682     planes = av_pix_fmt_count_planes(dst->format);
 683     for (i = 0; i < planes; i++)
 684         if (!dst->data[i] || !src->data[i])
 685             return AVERROR(EINVAL);
 686
 687     memcpy(src_data, src->data, sizeof(src_data));
 688     av_image_copy(dst->data, dst->linesize,
 689                   src_data, src->linesize,
 690                   dst->format, src->width, src->height);
 691
 692     return 0;
 693 }
 694
 695 static int frame_copy_audio(AVFrame *dst, const AVFrame *src)
 696 {
 697     int planar   = av_sample_fmt_is_planar(dst->format);
 698     int channels = dst->channels;
 699     int planes   = planar ? channels : 1;
 700     int i;
 701
 702     if (dst->nb_samples     != src->nb_samples ||
 703         dst->channels       != src->channels ||
 704         dst->channel_layout != src->channel_layout)
 705         return AVERROR(EINVAL);
 706
 707     CHECK_CHANNELS_CONSISTENCY(src);
 708
 709     for (i = 0; i < planes; i++)
 710         if (!dst->extended_data[i] || !src->extended_data[i])
 711             return AVERROR(EINVAL);
 712
 713     av_samples_copy(dst->extended_data, src->extended_data, 0, 0,
 714                     dst->nb_samples, channels, dst->format);
 715
 716     return 0;
 717 }
 718
 719 int av_frame_copy(AVFrame *dst, const AVFrame *src)
 720 {
 721     if (dst->format != src->format || dst->format < 0)
 722         return AVERROR(EINVAL);
 723
 724     if (dst->width > 0 && dst->height > 0)
 725         return frame_copy_video(dst, src);
 726     else if (dst->nb_samples > 0 && dst->channel_layout)
 727         return frame_copy_audio(dst, src);
 728
 729     return AVERROR(EINVAL);
 730 }
 731
 732 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type)
 733 {
 734     int i;
 735
 736     for (i = 0; i < frame->nb_side_data; i++) {
 737         AVFrameSideData *sd = frame->side_data[i];
 738         if (sd->type == type) {
 739             free_side_data(&frame->side_data[i]);
 740             frame->side_data[i] = frame->side_data[frame->nb_side_data - 1];
 741             frame->nb_side_data--;
 742         }
 743     }
 744 }
 745
 746 const char *av_frame_side_data_name(enum AVFrameSideDataType type)
 747 {
 748     switch(type) {
 749     case AV_FRAME_DATA_PANSCAN:         return "AVPanScan";
 750     case AV_FRAME_DATA_A53_CC:          return "ATSC A53 Part 4 Closed Captions";
 751     case AV_FRAME_DATA_STEREO3D:        return "Stereoscopic 3d metadata";
 752     case AV_FRAME_DATA_MATRIXENCODING:  return "AVMatrixEncoding";
 753     case AV_FRAME_DATA_DOWNMIX_INFO:    return "Metadata relevant to a downmix procedure";
 754     case AV_FRAME_DATA_REPLAYGAIN:      return "AVReplayGain";
 755     case AV_FRAME_DATA_DISPLAYMATRIX:   return "3x3 displaymatrix";
 756     case AV_FRAME_DATA_AFD:             return "Active format description";
 757     case AV_FRAME_DATA_MOTION_VECTORS:  return "Motion vectors";
 758     case AV_FRAME_DATA_SKIP_SAMPLES:    return "Skip samples";
 759     case AV_FRAME_DATA_AUDIO_SERVICE_TYPE:          return "Audio service type";
 760     case AV_FRAME_DATA_MASTERING_DISPLAY_METADATA:  return "Mastering display metadata";
 761     case AV_FRAME_DATA_GOP_TIMECODE:                return "GOP timecode";
 762     }
 763     return NULL;
 764 }