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
  30 static AVFrameSideData *frame_new_side_data(AVFrame *frame,
  31                                             enum AVFrameSideDataType type,
  32                                             AVBufferRef *buf);
  33
  34 #if FF_API_FRAME_GET_SET
  35 MAKE_ACCESSORS(AVFrame, frame, int64_t, best_effort_timestamp)
  36 MAKE_ACCESSORS(AVFrame, frame, int64_t, pkt_duration)
  37 MAKE_ACCESSORS(AVFrame, frame, int64_t, pkt_pos)
  38 MAKE_ACCESSORS(AVFrame, frame, int64_t, channel_layout)
  39 MAKE_ACCESSORS(AVFrame, frame, int,     channels)
  40 MAKE_ACCESSORS(AVFrame, frame, int,     sample_rate)
  41 MAKE_ACCESSORS(AVFrame, frame, AVDictionary *, metadata)
  42 MAKE_ACCESSORS(AVFrame, frame, int,     decode_error_flags)
  43 MAKE_ACCESSORS(AVFrame, frame, int,     pkt_size)
  44 MAKE_ACCESSORS(AVFrame, frame, enum AVColorSpace, colorspace)
  45 MAKE_ACCESSORS(AVFrame, frame, enum AVColorRange, color_range)
  46 #endif
  47
  48 #define CHECK_CHANNELS_CONSISTENCY(frame) \
  49     av_assert2(!(frame)->channel_layout || \
  50                (frame)->channels == \
  51                av_get_channel_layout_nb_channels((frame)->channel_layout))
  52
  53 #if FF_API_FRAME_QP
  54 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int qp_type)
  55 {
  56     av_buffer_unref(&f->qp_table_buf);
  57
  58     f->qp_table_buf = buf;
  59
  60 FF_DISABLE_DEPRECATION_WARNINGS
  61     f->qscale_table = buf->data;
  62     f->qstride      = stride;
  63     f->qscale_type  = qp_type;
  64 FF_ENABLE_DEPRECATION_WARNINGS
  65
  66     return 0;
  67 }
  68
  69 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type)
  70 {
  71 FF_DISABLE_DEPRECATION_WARNINGS
  72     *stride = f->qstride;
  73     *type   = f->qscale_type;
  74 FF_ENABLE_DEPRECATION_WARNINGS
  75
  76     if (!f->qp_table_buf)
  77         return NULL;
  78
  79     return f->qp_table_buf->data;
  80 }
  81 #endif
  82
  83 const char *av_get_colorspace_name(enum AVColorSpace val)
  84 {
  85     static const char * const name[] = {
  86         [AVCOL_SPC_RGB]       = "GBR",
  87         [AVCOL_SPC_BT709]     = "bt709",
  88         [AVCOL_SPC_FCC]       = "fcc",
  89         [AVCOL_SPC_BT470BG]   = "bt470bg",
  90         [AVCOL_SPC_SMPTE170M] = "smpte170m",
  91         [AVCOL_SPC_SMPTE240M] = "smpte240m",
  92         [AVCOL_SPC_YCOCG]     = "YCgCo",
  93     };
  94     if ((unsigned)val >= FF_ARRAY_ELEMS(name))
  95         return NULL;
  96     return name[val];
  97 }
  98
  99 static void get_frame_defaults(AVFrame *frame)
 100 {
 101     if (frame->extended_data != frame->data)
 102         av_freep(&frame->extended_data);
 103
 104     memset(frame, 0, sizeof(*frame));
 105
 106     frame->pts                   =
 107     frame->pkt_dts               = AV_NOPTS_VALUE;
 108 #if FF_API_PKT_PTS
 109 FF_DISABLE_DEPRECATION_WARNINGS
 110     frame->pkt_pts               = AV_NOPTS_VALUE;
 111 FF_ENABLE_DEPRECATION_WARNINGS
 112 #endif
 113     frame->best_effort_timestamp = AV_NOPTS_VALUE;
 114     frame->pkt_duration        = 0;
 115     frame->pkt_pos             = -1;
 116     frame->pkt_size            = -1;
 117     frame->key_frame           = 1;
 118     frame->sample_aspect_ratio = (AVRational){ 0, 1 };
 119     frame->format              = -1; /* unknown */
 120     frame->extended_data       = frame->data;
 121     frame->color_primaries     = AVCOL_PRI_UNSPECIFIED;
 122     frame->color_trc           = AVCOL_TRC_UNSPECIFIED;
 123     frame->colorspace          = AVCOL_SPC_UNSPECIFIED;
 124     frame->color_range         = AVCOL_RANGE_UNSPECIFIED;
 125     frame->chroma_location     = AVCHROMA_LOC_UNSPECIFIED;
 126     frame->flags               = 0;
 127 }
 128
 129 static void free_side_data(AVFrameSideData **ptr_sd)
 130 {
 131     AVFrameSideData *sd = *ptr_sd;
 132
 133     av_buffer_unref(&sd->buf);
 134     av_dict_free(&sd->metadata);
 135     av_freep(ptr_sd);
 136 }
 137
 138 static void wipe_side_data(AVFrame *frame)
 139 {
 140     int i;
 141
 142     for (i = 0; i < frame->nb_side_data; i++) {
 143         free_side_data(&frame->side_data[i]);
 144     }
 145     frame->nb_side_data = 0;
 146
 147     av_freep(&frame->side_data);
 148 }
 149
 150 AVFrame *av_frame_alloc(void)
 151 {
 152     AVFrame *frame = av_mallocz(sizeof(*frame));
 153
 154     if (!frame)
 155         return NULL;
 156
 157     frame->extended_data = NULL;
 158     get_frame_defaults(frame);
 159
 160     return frame;
 161 }
 162
 163 void av_frame_free(AVFrame **frame)
 164 {
 165     if (!frame || !*frame)
 166         return;
 167
 168     av_frame_unref(*frame);
 169     av_freep(frame);
 170 }
 171
 172 static int get_video_buffer(AVFrame *frame, int align)
 173 {
 174     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(frame->format);
 175     int ret, i;
 176
 177     if (!desc)
 178         return AVERROR(EINVAL);
 179
 180     if ((ret = av_image_check_size(frame->width, frame->height, 0, NULL)) < 0)
 181         return ret;
 182
 183     if (!frame->linesize[0]) {
 184         if (align <= 0)
 185             align = 32; /* STRIDE_ALIGN. Should be av_cpu_max_align() */
 186
 187         for(i=1; i<=align; i+=i) {
 188             ret = av_image_fill_linesizes(frame->linesize, frame->format,
 189                                           FFALIGN(frame->width, i));
 190             if (ret < 0)
 191                 return ret;
 192             if (!(frame->linesize[0] & (align-1)))
 193                 break;
 194         }
 195
 196         for (i = 0; i < 4 && frame->linesize[i]; i++)
 197             frame->linesize[i] = FFALIGN(frame->linesize[i], align);
 198     }
 199
 200     for (i = 0; i < 4 && frame->linesize[i]; i++) {
 201         int h = FFALIGN(frame->height, 32);
 202         if (i == 1 || i == 2)
 203             h = AV_CEIL_RSHIFT(h, desc->log2_chroma_h);
 204
 205         frame->buf[i] = av_buffer_alloc(frame->linesize[i] * h + 16 + 16/*STRIDE_ALIGN*/ - 1);
 206         if (!frame->buf[i])
 207             goto fail;
 208
 209         frame->data[i] = frame->buf[i]->data;
 210     }
 211     if (desc->flags & AV_PIX_FMT_FLAG_PAL || desc->flags & AV_PIX_FMT_FLAG_PSEUDOPAL) {
 212         av_buffer_unref(&frame->buf[1]);
 213         frame->buf[1] = av_buffer_alloc(AVPALETTE_SIZE);
 214         if (!frame->buf[1])
 215             goto fail;
 216         frame->data[1] = frame->buf[1]->data;
 217     }
 218
 219     frame->extended_data = frame->data;
 220
 221     return 0;
 222 fail:
 223     av_frame_unref(frame);
 224     return AVERROR(ENOMEM);
 225 }
 226
 227 static int get_audio_buffer(AVFrame *frame, int align)
 228 {
 229     int channels;
 230     int planar   = av_sample_fmt_is_planar(frame->format);
 231     int planes;
 232     int ret, i;
 233
 234     if (!frame->channels)
 235         frame->channels = av_get_channel_layout_nb_channels(frame->channel_layout);
 236
 237     channels = frame->channels;
 238     planes = planar ? channels : 1;
 239
 240     CHECK_CHANNELS_CONSISTENCY(frame);
 241     if (!frame->linesize[0]) {
 242         ret = av_samples_get_buffer_size(&frame->linesize[0], channels,
 243                                          frame->nb_samples, frame->format,
 244                                          align);
 245         if (ret < 0)
 246             return ret;
 247     }
 248
 249     if (planes > AV_NUM_DATA_POINTERS) {
 250         frame->extended_data = av_mallocz_array(planes,
 251                                           sizeof(*frame->extended_data));
 252         frame->extended_buf  = av_mallocz_array((planes - AV_NUM_DATA_POINTERS),
 253                                           sizeof(*frame->extended_buf));
 254         if (!frame->extended_data || !frame->extended_buf) {
 255             av_freep(&frame->extended_data);
 256             av_freep(&frame->extended_buf);
 257             return AVERROR(ENOMEM);
 258         }
 259         frame->nb_extended_buf = planes - AV_NUM_DATA_POINTERS;
 260     } else
 261         frame->extended_data = frame->data;
 262
 263     for (i = 0; i < FFMIN(planes, AV_NUM_DATA_POINTERS); i++) {
 264         frame->buf[i] = av_buffer_alloc(frame->linesize[0]);
 265         if (!frame->buf[i]) {
 266             av_frame_unref(frame);
 267             return AVERROR(ENOMEM);
 268         }
 269         frame->extended_data[i] = frame->data[i] = frame->buf[i]->data;
 270     }
 271     for (i = 0; i < planes - AV_NUM_DATA_POINTERS; i++) {
 272         frame->extended_buf[i] = av_buffer_alloc(frame->linesize[0]);
 273         if (!frame->extended_buf[i]) {
 274             av_frame_unref(frame);
 275             return AVERROR(ENOMEM);
 276         }
 277         frame->extended_data[i + AV_NUM_DATA_POINTERS] = frame->extended_buf[i]->data;
 278     }
 279     return 0;
 280
 281 }
 282
 283 int av_frame_get_buffer(AVFrame *frame, int align)
 284 {
 285     if (frame->format < 0)
 286         return AVERROR(EINVAL);
 287
 288     if (frame->width > 0 && frame->height > 0)
 289         return get_video_buffer(frame, align);
 290     else if (frame->nb_samples > 0 && (frame->channel_layout || frame->channels > 0))
 291         return get_audio_buffer(frame, align);
 292
 293     return AVERROR(EINVAL);
 294 }
 295
 296 static int frame_copy_props(AVFrame *dst, const AVFrame *src, int force_copy)
 297 {
 298     int i;
 299
 300     dst->key_frame              = src->key_frame;
 301     dst->pict_type              = src->pict_type;
 302     dst->sample_aspect_ratio    = src->sample_aspect_ratio;
 303     dst->crop_top               = src->crop_top;
 304     dst->crop_bottom            = src->crop_bottom;
 305     dst->crop_left              = src->crop_left;
 306     dst->crop_right             = src->crop_right;
 307     dst->pts                    = src->pts;
 308     dst->repeat_pict            = src->repeat_pict;
 309     dst->interlaced_frame       = src->interlaced_frame;
 310     dst->top_field_first        = src->top_field_first;
 311     dst->palette_has_changed    = src->palette_has_changed;
 312     dst->sample_rate            = src->sample_rate;
 313     dst->opaque                 = src->opaque;
 314 #if FF_API_PKT_PTS
 315 FF_DISABLE_DEPRECATION_WARNINGS
 316     dst->pkt_pts                = src->pkt_pts;
 317 FF_ENABLE_DEPRECATION_WARNINGS
 318 #endif
 319     dst->pkt_dts                = src->pkt_dts;
 320     dst->pkt_pos                = src->pkt_pos;
 321     dst->pkt_size               = src->pkt_size;
 322     dst->pkt_duration           = src->pkt_duration;
 323     dst->reordered_opaque       = src->reordered_opaque;
 324     dst->quality                = src->quality;
 325     dst->best_effort_timestamp  = src->best_effort_timestamp;
 326     dst->coded_picture_number   = src->coded_picture_number;
 327     dst->display_picture_number = src->display_picture_number;
 328     dst->flags                  = src->flags;
 329     dst->decode_error_flags     = src->decode_error_flags;
 330     dst->color_primaries        = src->color_primaries;
 331     dst->color_trc              = src->color_trc;
 332     dst->colorspace             = src->colorspace;
 333     dst->color_range            = src->color_range;
 334     dst->chroma_location        = src->chroma_location;
 335
 336     av_dict_copy(&dst->metadata, src->metadata, 0);
 337
 338 #if FF_API_ERROR_FRAME
 339 FF_DISABLE_DEPRECATION_WARNINGS
 340     memcpy(dst->error, src->error, sizeof(dst->error));
 341 FF_ENABLE_DEPRECATION_WARNINGS
 342 #endif
 343
 344     for (i = 0; i < src->nb_side_data; i++) {
 345         const AVFrameSideData *sd_src = src->side_data[i];
 346         AVFrameSideData *sd_dst;
 347         if (   sd_src->type == AV_FRAME_DATA_PANSCAN
 348             && (src->width != dst->width || src->height != dst->height))
 349             continue;
 350         if (force_copy) {
 351             sd_dst = av_frame_new_side_data(dst, sd_src->type,
 352                                             sd_src->size);
 353             if (!sd_dst) {
 354                 wipe_side_data(dst);
 355                 return AVERROR(ENOMEM);
 356             }
 357             memcpy(sd_dst->data, sd_src->data, sd_src->size);
 358         } else {
 359             sd_dst = frame_new_side_data(dst, sd_src->type, av_buffer_ref(sd_src->buf));
 360             if (!sd_dst) {
 361                 wipe_side_data(dst);
 362                 return AVERROR(ENOMEM);
 363             }
 364         }
 365         av_dict_copy(&sd_dst->metadata, sd_src->metadata, 0);
 366     }
 367
 368 #if FF_API_FRAME_QP
 369 FF_DISABLE_DEPRECATION_WARNINGS
 370     dst->qscale_table = NULL;
 371     dst->qstride      = 0;
 372     dst->qscale_type  = 0;
 373     av_buffer_unref(&dst->qp_table_buf);
 374     if (src->qp_table_buf) {
 375         dst->qp_table_buf = av_buffer_ref(src->qp_table_buf);
 376         if (dst->qp_table_buf) {
 377             dst->qscale_table = dst->qp_table_buf->data;
 378             dst->qstride      = src->qstride;
 379             dst->qscale_type  = src->qscale_type;
 380         }
 381     }
 382 FF_ENABLE_DEPRECATION_WARNINGS
 383 #endif
 384
 385     av_buffer_unref(&dst->opaque_ref);
 386     if (src->opaque_ref) {
 387         dst->opaque_ref = av_buffer_ref(src->opaque_ref);
 388         if (!dst->opaque_ref)
 389             return AVERROR(ENOMEM);
 390     }
 391
 392     return 0;
 393 }
 394
 395 int av_frame_ref(AVFrame *dst, const AVFrame *src)
 396 {
 397     int i, ret = 0;
 398
 399     av_assert1(dst->width == 0 && dst->height == 0);
 400     av_assert1(dst->channels == 0);
 401
 402     dst->format         = src->format;
 403     dst->width          = src->width;
 404     dst->height         = src->height;
 405     dst->channels       = src->channels;
 406     dst->channel_layout = src->channel_layout;
 407     dst->nb_samples     = src->nb_samples;
 408
 409     ret = frame_copy_props(dst, src, 0);
 410     if (ret < 0)
 411         return ret;
 412
 413     /* duplicate the frame data if it's not refcounted */
 414     if (!src->buf[0]) {
 415         ret = av_frame_get_buffer(dst, 32);
 416         if (ret < 0)
 417             return ret;
 418
 419         ret = av_frame_copy(dst, src);
 420         if (ret < 0)
 421             av_frame_unref(dst);
 422
 423         return ret;
 424     }
 425
 426     /* ref the buffers */
 427     for (i = 0; i < FF_ARRAY_ELEMS(src->buf); i++) {
 428         if (!src->buf[i])
 429             continue;
 430         dst->buf[i] = av_buffer_ref(src->buf[i]);
 431         if (!dst->buf[i]) {
 432             ret = AVERROR(ENOMEM);
 433             goto fail;
 434         }
 435     }
 436
 437     if (src->extended_buf) {
 438         dst->extended_buf = av_mallocz_array(sizeof(*dst->extended_buf),
 439                                        src->nb_extended_buf);
 440         if (!dst->extended_buf) {
 441             ret = AVERROR(ENOMEM);
 442             goto fail;
 443         }
 444         dst->nb_extended_buf = src->nb_extended_buf;
 445
 446         for (i = 0; i < src->nb_extended_buf; i++) {
 447             dst->extended_buf[i] = av_buffer_ref(src->extended_buf[i]);
 448             if (!dst->extended_buf[i]) {
 449                 ret = AVERROR(ENOMEM);
 450                 goto fail;
 451             }
 452         }
 453     }
 454
 455     if (src->hw_frames_ctx) {
 456         dst->hw_frames_ctx = av_buffer_ref(src->hw_frames_ctx);
 457         if (!dst->hw_frames_ctx) {
 458             ret = AVERROR(ENOMEM);
 459             goto fail;
 460         }
 461     }
 462
 463     /* duplicate extended data */
 464     if (src->extended_data != src->data) {
 465         int ch = src->channels;
 466
 467         if (!ch) {
 468             ret = AVERROR(EINVAL);
 469             goto fail;
 470         }
 471         CHECK_CHANNELS_CONSISTENCY(src);
 472
 473         dst->extended_data = av_malloc_array(sizeof(*dst->extended_data), ch);
 474         if (!dst->extended_data) {
 475             ret = AVERROR(ENOMEM);
 476             goto fail;
 477         }
 478         memcpy(dst->extended_data, src->extended_data, sizeof(*src->extended_data) * ch);
 479     } else
 480         dst->extended_data = dst->data;
 481
 482     memcpy(dst->data,     src->data,     sizeof(src->data));
 483     memcpy(dst->linesize, src->linesize, sizeof(src->linesize));
 484
 485     return 0;
 486
 487 fail:
 488     av_frame_unref(dst);
 489     return ret;
 490 }
 491
 492 AVFrame *av_frame_clone(const AVFrame *src)
 493 {
 494     AVFrame *ret = av_frame_alloc();
 495
 496     if (!ret)
 497         return NULL;
 498
 499     if (av_frame_ref(ret, src) < 0)
 500         av_frame_free(&ret);
 501
 502     return ret;
 503 }
 504
 505 void av_frame_unref(AVFrame *frame)
 506 {
 507     int i;
 508
 509     if (!frame)
 510         return;
 511
 512     wipe_side_data(frame);
 513
 514     for (i = 0; i < FF_ARRAY_ELEMS(frame->buf); i++)
 515         av_buffer_unref(&frame->buf[i]);
 516     for (i = 0; i < frame->nb_extended_buf; i++)
 517         av_buffer_unref(&frame->extended_buf[i]);
 518     av_freep(&frame->extended_buf);
 519     av_dict_free(&frame->metadata);
 520 #if FF_API_FRAME_QP
 521     av_buffer_unref(&frame->qp_table_buf);
 522 #endif
 523
 524     av_buffer_unref(&frame->hw_frames_ctx);
 525
 526     av_buffer_unref(&frame->opaque_ref);
 527
 528     get_frame_defaults(frame);
 529 }
 530
 531 void av_frame_move_ref(AVFrame *dst, AVFrame *src)
 532 {
 533     av_assert1(dst->width == 0 && dst->height == 0);
 534     av_assert1(dst->channels == 0);
 535
 536     *dst = *src;
 537     if (src->extended_data == src->data)
 538         dst->extended_data = dst->data;
 539     memset(src, 0, sizeof(*src));
 540     get_frame_defaults(src);
 541 }
 542
 543 int av_frame_is_writable(AVFrame *frame)
 544 {
 545     int i, ret = 1;
 546
 547     /* assume non-refcounted frames are not writable */
 548     if (!frame->buf[0])
 549         return 0;
 550
 551     for (i = 0; i < FF_ARRAY_ELEMS(frame->buf); i++)
 552         if (frame->buf[i])
 553             ret &= !!av_buffer_is_writable(frame->buf[i]);
 554     for (i = 0; i < frame->nb_extended_buf; i++)
 555         ret &= !!av_buffer_is_writable(frame->extended_buf[i]);
 556
 557     return ret;
 558 }
 559
 560 int av_frame_make_writable(AVFrame *frame)
 561 {
 562     AVFrame tmp;
 563     int ret;
 564
 565     if (!frame->buf[0])
 566         return AVERROR(EINVAL);
 567
 568     if (av_frame_is_writable(frame))
 569         return 0;
 570
 571     memset(&tmp, 0, sizeof(tmp));
 572     tmp.format         = frame->format;
 573     tmp.width          = frame->width;
 574     tmp.height         = frame->height;
 575     tmp.channels       = frame->channels;
 576     tmp.channel_layout = frame->channel_layout;
 577     tmp.nb_samples     = frame->nb_samples;
 578     ret = av_frame_get_buffer(&tmp, 32);
 579     if (ret < 0)
 580         return ret;
 581
 582     ret = av_frame_copy(&tmp, frame);
 583     if (ret < 0) {
 584         av_frame_unref(&tmp);
 585         return ret;
 586     }
 587
 588     ret = av_frame_copy_props(&tmp, frame);
 589     if (ret < 0) {
 590         av_frame_unref(&tmp);
 591         return ret;
 592     }
 593
 594     av_frame_unref(frame);
 595
 596     *frame = tmp;
 597     if (tmp.data == tmp.extended_data)
 598         frame->extended_data = frame->data;
 599
 600     return 0;
 601 }
 602
 603 int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
 604 {
 605     return frame_copy_props(dst, src, 1);
 606 }
 607
 608 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane)
 609 {
 610     uint8_t *data;
 611     int planes, i;
 612
 613     if (frame->nb_samples) {
 614         int channels = frame->channels;
 615         if (!channels)
 616             return NULL;
 617         CHECK_CHANNELS_CONSISTENCY(frame);
 618         planes = av_sample_fmt_is_planar(frame->format) ? channels : 1;
 619     } else
 620         planes = 4;
 621
 622     if (plane < 0 || plane >= planes || !frame->extended_data[plane])
 623         return NULL;
 624     data = frame->extended_data[plane];
 625
 626     for (i = 0; i < FF_ARRAY_ELEMS(frame->buf) && frame->buf[i]; i++) {
 627         AVBufferRef *buf = frame->buf[i];
 628         if (data >= buf->data && data < buf->data + buf->size)
 629             return buf;
 630     }
 631     for (i = 0; i < frame->nb_extended_buf; i++) {
 632         AVBufferRef *buf = frame->extended_buf[i];
 633         if (data >= buf->data && data < buf->data + buf->size)
 634             return buf;
 635     }
 636     return NULL;
 637 }
 638
 639 static AVFrameSideData *frame_new_side_data(AVFrame *frame,
 640                                             enum AVFrameSideDataType type,
 641                                             AVBufferRef *buf)
 642 {
 643     AVFrameSideData *ret, **tmp;
 644
 645     if (!buf)
 646         return NULL;
 647
 648     if (frame->nb_side_data > INT_MAX / sizeof(*frame->side_data) - 1)
 649         goto fail;
 650
 651     tmp = av_realloc(frame->side_data,
 652                      (frame->nb_side_data + 1) * sizeof(*frame->side_data));
 653     if (!tmp)
 654         goto fail;
 655     frame->side_data = tmp;
 656
 657     ret = av_mallocz(sizeof(*ret));
 658     if (!ret)
 659         goto fail;
 660
 661     ret->buf = buf;
 662     ret->data = ret->buf->data;
 663     ret->size = buf->size;
 664     ret->type = type;
 665
 666     frame->side_data[frame->nb_side_data++] = ret;
 667
 668     return ret;
 669 fail:
 670     av_buffer_unref(&buf);
 671     return NULL;
 672 }
 673
 674 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
 675                                         enum AVFrameSideDataType type,
 676                                         int size)
 677 {
 678
 679     return frame_new_side_data(frame, type, av_buffer_alloc(size));
 680 }
 681
 682 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
 683                                         enum AVFrameSideDataType type)
 684 {
 685     int i;
 686
 687     for (i = 0; i < frame->nb_side_data; i++) {
 688         if (frame->side_data[i]->type == type)
 689             return frame->side_data[i];
 690     }
 691     return NULL;
 692 }
 693
 694 static int frame_copy_video(AVFrame *dst, const AVFrame *src)
 695 {
 696     const uint8_t *src_data[4];
 697     int i, planes;
 698
 699     if (dst->width  < src->width ||
 700         dst->height < src->height)
 701         return AVERROR(EINVAL);
 702
 703     planes = av_pix_fmt_count_planes(dst->format);
 704     for (i = 0; i < planes; i++)
 705         if (!dst->data[i] || !src->data[i])
 706             return AVERROR(EINVAL);
 707
 708     memcpy(src_data, src->data, sizeof(src_data));
 709     av_image_copy(dst->data, dst->linesize,
 710                   src_data, src->linesize,
 711                   dst->format, src->width, src->height);
 712
 713     return 0;
 714 }
 715
 716 static int frame_copy_audio(AVFrame *dst, const AVFrame *src)
 717 {
 718     int planar   = av_sample_fmt_is_planar(dst->format);
 719     int channels = dst->channels;
 720     int planes   = planar ? channels : 1;
 721     int i;
 722
 723     if (dst->nb_samples     != src->nb_samples ||
 724         dst->channels       != src->channels ||
 725         dst->channel_layout != src->channel_layout)
 726         return AVERROR(EINVAL);
 727
 728     CHECK_CHANNELS_CONSISTENCY(src);
 729
 730     for (i = 0; i < planes; i++)
 731         if (!dst->extended_data[i] || !src->extended_data[i])
 732             return AVERROR(EINVAL);
 733
 734     av_samples_copy(dst->extended_data, src->extended_data, 0, 0,
 735                     dst->nb_samples, channels, dst->format);
 736
 737     return 0;
 738 }
 739
 740 int av_frame_copy(AVFrame *dst, const AVFrame *src)
 741 {
 742     if (dst->format != src->format || dst->format < 0)
 743         return AVERROR(EINVAL);
 744
 745     if (dst->width > 0 && dst->height > 0)
 746         return frame_copy_video(dst, src);
 747     else if (dst->nb_samples > 0 && dst->channels > 0)
 748         return frame_copy_audio(dst, src);
 749
 750     return AVERROR(EINVAL);
 751 }
 752
 753 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type)
 754 {
 755     int i;
 756
 757     for (i = 0; i < frame->nb_side_data; i++) {
 758         AVFrameSideData *sd = frame->side_data[i];
 759         if (sd->type == type) {
 760             free_side_data(&frame->side_data[i]);
 761             frame->side_data[i] = frame->side_data[frame->nb_side_data - 1];
 762             frame->nb_side_data--;
 763         }
 764     }
 765 }
 766
 767 const char *av_frame_side_data_name(enum AVFrameSideDataType type)
 768 {
 769     switch(type) {
 770     case AV_FRAME_DATA_PANSCAN:         return "AVPanScan";
 771     case AV_FRAME_DATA_A53_CC:          return "ATSC A53 Part 4 Closed Captions";
 772     case AV_FRAME_DATA_STEREO3D:        return "Stereoscopic 3d metadata";
 773     case AV_FRAME_DATA_MATRIXENCODING:  return "AVMatrixEncoding";
 774     case AV_FRAME_DATA_DOWNMIX_INFO:    return "Metadata relevant to a downmix procedure";
 775     case AV_FRAME_DATA_REPLAYGAIN:      return "AVReplayGain";
 776     case AV_FRAME_DATA_DISPLAYMATRIX:   return "3x3 displaymatrix";
 777     case AV_FRAME_DATA_AFD:             return "Active format description";
 778     case AV_FRAME_DATA_MOTION_VECTORS:  return "Motion vectors";
 779     case AV_FRAME_DATA_SKIP_SAMPLES:    return "Skip samples";
 780     case AV_FRAME_DATA_AUDIO_SERVICE_TYPE:          return "Audio service type";
 781     case AV_FRAME_DATA_MASTERING_DISPLAY_METADATA:  return "Mastering display metadata";
 782     case AV_FRAME_DATA_CONTENT_LIGHT_LEVEL:         return "Content light level metadata";
 783     case AV_FRAME_DATA_GOP_TIMECODE:                return "GOP timecode";
 784     case AV_FRAME_DATA_ICC_PROFILE:                 return "ICC profile";
 785     }
 786     return NULL;
 787 }
 788
 789 static int calc_cropping_offsets(size_t offsets[4], const AVFrame *frame,
 790                                  const AVPixFmtDescriptor *desc)
 791 {
 792     int i, j;
 793
 794     for (i = 0; frame->data[i]; i++) {
 795         const AVComponentDescriptor *comp = NULL;
 796         int shift_x = (i == 1 || i == 2) ? desc->log2_chroma_w : 0;
 797         int shift_y = (i == 1 || i == 2) ? desc->log2_chroma_h : 0;
 798
 799         if (desc->flags & (AV_PIX_FMT_FLAG_PAL | AV_PIX_FMT_FLAG_PSEUDOPAL) && i == 1) {
 800             offsets[i] = 0;
 801             break;
 802         }
 803
 804         /* find any component descriptor for this plane */
 805         for (j = 0; j < desc->nb_components; j++) {
 806             if (desc->comp[j].plane == i) {
 807                 comp = &desc->comp[j];
 808                 break;
 809             }
 810         }
 811         if (!comp)
 812             return AVERROR_BUG;
 813
 814         offsets[i] = (frame->crop_top  >> shift_y) * frame->linesize[i] +
 815                      (frame->crop_left >> shift_x) * comp->step;
 816     }
 817
 818     return 0;
 819 }
 820
 821 int av_frame_apply_cropping(AVFrame *frame, int flags)
 822 {
 823     const AVPixFmtDescriptor *desc;
 824     size_t offsets[4];
 825     int i;
 826
 827     if (!(frame->width > 0 && frame->height > 0))
 828         return AVERROR(EINVAL);
 829
 830     if (frame->crop_left >= INT_MAX - frame->crop_right        ||
 831         frame->crop_top  >= INT_MAX - frame->crop_bottom       ||
 832         (frame->crop_left + frame->crop_right) >= frame->width ||
 833         (frame->crop_top + frame->crop_bottom) >= frame->height)
 834         return AVERROR(ERANGE);
 835
 836     desc = av_pix_fmt_desc_get(frame->format);
 837     if (!desc)
 838         return AVERROR_BUG;
 839
 840     /* Apply just the right/bottom cropping for hwaccel formats. Bitstream
 841      * formats cannot be easily handled here either (and corresponding decoders
 842      * should not export any cropping anyway), so do the same for those as well.
 843      * */
 844     if (desc->flags & (AV_PIX_FMT_FLAG_BITSTREAM | AV_PIX_FMT_FLAG_HWACCEL)) {
 845         frame->width      -= frame->crop_right;
 846         frame->height     -= frame->crop_bottom;
 847         frame->crop_right  = 0;
 848         frame->crop_bottom = 0;
 849         return 0;
 850     }
 851
 852     /* calculate the offsets for each plane */
 853     calc_cropping_offsets(offsets, frame, desc);
 854
 855     /* adjust the offsets to avoid breaking alignment */
 856     if (!(flags & AV_FRAME_CROP_UNALIGNED)) {
 857         int log2_crop_align = frame->crop_left ? ff_ctz(frame->crop_left) : INT_MAX;
 858         int min_log2_align = INT_MAX;
 859
 860         for (i = 0; frame->data[i]; i++) {
 861             int log2_align = offsets[i] ? ff_ctz(offsets[i]) : INT_MAX;
 862             min_log2_align = FFMIN(log2_align, min_log2_align);
 863         }
 864
 865         /* we assume, and it should always be true, that the data alignment is
 866          * related to the cropping alignment by a constant power-of-2 factor */
 867         if (log2_crop_align < min_log2_align)
 868             return AVERROR_BUG;
 869
 870         if (min_log2_align < 5) {
 871             frame->crop_left &= ~((1 << (5 + log2_crop_align - min_log2_align)) - 1);
 872             calc_cropping_offsets(offsets, frame, desc);
 873         }
 874     }
 875
 876     for (i = 0; frame->data[i]; i++)
 877         frame->data[i] += offsets[i];
 878
 879     frame->width      -= (frame->crop_left + frame->crop_right);
 880     frame->height     -= (frame->crop_top  + frame->crop_bottom);
 881     frame->crop_left   = 0;
 882     frame->crop_right  = 0;
 883     frame->crop_top    = 0;
 884     frame->crop_bottom = 0;
 885
 886     return 0;
 887 }