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