2 * This file is part of FFmpeg.
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.
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.
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
19 #include "channel_layout.h"
27 #include "samplefmt.h"
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)
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))
46 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame) {return &frame->metadata;};
49 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int qp_type)
51 av_buffer_unref(&f->qp_table_buf);
53 f->qp_table_buf = buf;
55 FF_DISABLE_DEPRECATION_WARNINGS
56 f->qscale_table = buf->data;
58 f->qscale_type = qp_type;
59 FF_ENABLE_DEPRECATION_WARNINGS
64 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type)
66 FF_DISABLE_DEPRECATION_WARNINGS
68 *type = f->qscale_type;
69 FF_ENABLE_DEPRECATION_WARNINGS
74 return f->qp_table_buf->data;
78 const char *av_get_colorspace_name(enum AVColorSpace val)
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",
89 if ((unsigned)val >= FF_ARRAY_ELEMS(name))
94 static void get_frame_defaults(AVFrame *frame)
96 if (frame->extended_data != frame->data)
97 av_freep(&frame->extended_data);
99 memset(frame, 0, sizeof(*frame));
103 frame->pkt_pts = AV_NOPTS_VALUE;
104 av_frame_set_best_effort_timestamp(frame, AV_NOPTS_VALUE);
105 av_frame_set_pkt_duration (frame, 0);
106 av_frame_set_pkt_pos (frame, -1);
107 av_frame_set_pkt_size (frame, -1);
108 frame->key_frame = 1;
109 frame->sample_aspect_ratio = (AVRational){ 0, 1 };
110 frame->format = -1; /* unknown */
111 frame->extended_data = frame->data;
112 frame->color_primaries = AVCOL_PRI_UNSPECIFIED;
113 frame->color_trc = AVCOL_TRC_UNSPECIFIED;
114 frame->colorspace = AVCOL_SPC_UNSPECIFIED;
115 frame->color_range = AVCOL_RANGE_UNSPECIFIED;
116 frame->chroma_location = AVCHROMA_LOC_UNSPECIFIED;
119 static void free_side_data(AVFrameSideData **ptr_sd)
121 AVFrameSideData *sd = *ptr_sd;
123 av_buffer_unref(&sd->buf);
124 av_dict_free(&sd->metadata);
128 static void wipe_side_data(AVFrame *frame)
132 for (i = 0; i < frame->nb_side_data; i++) {
133 free_side_data(&frame->side_data[i]);
135 frame->nb_side_data = 0;
137 av_freep(&frame->side_data);
140 AVFrame *av_frame_alloc(void)
142 AVFrame *frame = av_mallocz(sizeof(*frame));
147 frame->extended_data = NULL;
148 get_frame_defaults(frame);
153 void av_frame_free(AVFrame **frame)
155 if (!frame || !*frame)
158 av_frame_unref(*frame);
162 static int get_video_buffer(AVFrame *frame, int align)
164 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(frame->format);
168 return AVERROR(EINVAL);
170 if ((ret = av_image_check_size(frame->width, frame->height, 0, NULL)) < 0)
173 if (!frame->linesize[0]) {
174 for(i=1; i<=align; i+=i) {
175 ret = av_image_fill_linesizes(frame->linesize, frame->format,
176 FFALIGN(frame->width, i));
179 if (!(frame->linesize[0] & (align-1)))
183 for (i = 0; i < 4 && frame->linesize[i]; i++)
184 frame->linesize[i] = FFALIGN(frame->linesize[i], align);
187 for (i = 0; i < 4 && frame->linesize[i]; i++) {
188 int h = FFALIGN(frame->height, 32);
189 if (i == 1 || i == 2)
190 h = AV_CEIL_RSHIFT(h, desc->log2_chroma_h);
192 frame->buf[i] = av_buffer_alloc(frame->linesize[i] * h + 16 + 16/*STRIDE_ALIGN*/ - 1);
196 frame->data[i] = frame->buf[i]->data;
198 if (desc->flags & AV_PIX_FMT_FLAG_PAL || desc->flags & AV_PIX_FMT_FLAG_PSEUDOPAL) {
199 av_buffer_unref(&frame->buf[1]);
200 frame->buf[1] = av_buffer_alloc(AVPALETTE_SIZE);
203 frame->data[1] = frame->buf[1]->data;
206 frame->extended_data = frame->data;
210 av_frame_unref(frame);
211 return AVERROR(ENOMEM);
214 static int get_audio_buffer(AVFrame *frame, int align)
217 int planar = av_sample_fmt_is_planar(frame->format);
221 if (!frame->channels)
222 frame->channels = av_get_channel_layout_nb_channels(frame->channel_layout);
224 channels = frame->channels;
225 planes = planar ? channels : 1;
227 CHECK_CHANNELS_CONSISTENCY(frame);
228 if (!frame->linesize[0]) {
229 ret = av_samples_get_buffer_size(&frame->linesize[0], channels,
230 frame->nb_samples, frame->format,
236 if (planes > AV_NUM_DATA_POINTERS) {
237 frame->extended_data = av_mallocz_array(planes,
238 sizeof(*frame->extended_data));
239 frame->extended_buf = av_mallocz_array((planes - AV_NUM_DATA_POINTERS),
240 sizeof(*frame->extended_buf));
241 if (!frame->extended_data || !frame->extended_buf) {
242 av_freep(&frame->extended_data);
243 av_freep(&frame->extended_buf);
244 return AVERROR(ENOMEM);
246 frame->nb_extended_buf = planes - AV_NUM_DATA_POINTERS;
248 frame->extended_data = frame->data;
250 for (i = 0; i < FFMIN(planes, AV_NUM_DATA_POINTERS); i++) {
251 frame->buf[i] = av_buffer_alloc(frame->linesize[0]);
252 if (!frame->buf[i]) {
253 av_frame_unref(frame);
254 return AVERROR(ENOMEM);
256 frame->extended_data[i] = frame->data[i] = frame->buf[i]->data;
258 for (i = 0; i < planes - AV_NUM_DATA_POINTERS; i++) {
259 frame->extended_buf[i] = av_buffer_alloc(frame->linesize[0]);
260 if (!frame->extended_buf[i]) {
261 av_frame_unref(frame);
262 return AVERROR(ENOMEM);
264 frame->extended_data[i + AV_NUM_DATA_POINTERS] = frame->extended_buf[i]->data;
270 int av_frame_get_buffer(AVFrame *frame, int align)
272 if (frame->format < 0)
273 return AVERROR(EINVAL);
275 if (frame->width > 0 && frame->height > 0)
276 return get_video_buffer(frame, align);
277 else if (frame->nb_samples > 0 && (frame->channel_layout || frame->channels > 0))
278 return get_audio_buffer(frame, align);
280 return AVERROR(EINVAL);
283 static int frame_copy_props(AVFrame *dst, const AVFrame *src, int force_copy)
287 dst->key_frame = src->key_frame;
288 dst->pict_type = src->pict_type;
289 dst->sample_aspect_ratio = src->sample_aspect_ratio;
291 dst->repeat_pict = src->repeat_pict;
292 dst->interlaced_frame = src->interlaced_frame;
293 dst->top_field_first = src->top_field_first;
294 dst->palette_has_changed = src->palette_has_changed;
295 dst->sample_rate = src->sample_rate;
296 dst->opaque = src->opaque;
297 dst->pkt_pts = src->pkt_pts;
298 dst->pkt_dts = src->pkt_dts;
299 dst->pkt_pos = src->pkt_pos;
300 dst->pkt_size = src->pkt_size;
301 dst->pkt_duration = src->pkt_duration;
302 dst->reordered_opaque = src->reordered_opaque;
303 dst->quality = src->quality;
304 dst->best_effort_timestamp = src->best_effort_timestamp;
305 dst->coded_picture_number = src->coded_picture_number;
306 dst->display_picture_number = src->display_picture_number;
307 dst->flags = src->flags;
308 dst->decode_error_flags = src->decode_error_flags;
309 dst->color_primaries = src->color_primaries;
310 dst->color_trc = src->color_trc;
311 dst->colorspace = src->colorspace;
312 dst->color_range = src->color_range;
313 dst->chroma_location = src->chroma_location;
315 av_dict_copy(&dst->metadata, src->metadata, 0);
317 #if FF_API_ERROR_FRAME
318 FF_DISABLE_DEPRECATION_WARNINGS
319 memcpy(dst->error, src->error, sizeof(dst->error));
320 FF_ENABLE_DEPRECATION_WARNINGS
323 for (i = 0; i < src->nb_side_data; i++) {
324 const AVFrameSideData *sd_src = src->side_data[i];
325 AVFrameSideData *sd_dst;
326 if ( sd_src->type == AV_FRAME_DATA_PANSCAN
327 && (src->width != dst->width || src->height != dst->height))
330 sd_dst = av_frame_new_side_data(dst, sd_src->type,
334 return AVERROR(ENOMEM);
336 memcpy(sd_dst->data, sd_src->data, sd_src->size);
338 sd_dst = av_frame_new_side_data(dst, sd_src->type, 0);
341 return AVERROR(ENOMEM);
343 sd_dst->buf = av_buffer_ref(sd_src->buf);
346 return AVERROR(ENOMEM);
348 sd_dst->data = sd_dst->buf->data;
349 sd_dst->size = sd_dst->buf->size;
351 av_dict_copy(&sd_dst->metadata, sd_src->metadata, 0);
355 FF_DISABLE_DEPRECATION_WARNINGS
356 dst->qscale_table = NULL;
358 dst->qscale_type = 0;
359 av_buffer_unref(&dst->qp_table_buf);
360 if (src->qp_table_buf) {
361 dst->qp_table_buf = av_buffer_ref(src->qp_table_buf);
362 if (dst->qp_table_buf) {
363 dst->qscale_table = dst->qp_table_buf->data;
364 dst->qstride = src->qstride;
365 dst->qscale_type = src->qscale_type;
368 FF_ENABLE_DEPRECATION_WARNINGS
374 int av_frame_ref(AVFrame *dst, const AVFrame *src)
378 av_assert1(dst->width == 0 && dst->height == 0);
379 av_assert1(dst->channels == 0);
381 dst->format = src->format;
382 dst->width = src->width;
383 dst->height = src->height;
384 dst->channels = src->channels;
385 dst->channel_layout = src->channel_layout;
386 dst->nb_samples = src->nb_samples;
388 ret = frame_copy_props(dst, src, 0);
392 /* duplicate the frame data if it's not refcounted */
394 ret = av_frame_get_buffer(dst, 32);
398 ret = av_frame_copy(dst, src);
405 /* ref the buffers */
406 for (i = 0; i < FF_ARRAY_ELEMS(src->buf); i++) {
409 dst->buf[i] = av_buffer_ref(src->buf[i]);
411 ret = AVERROR(ENOMEM);
416 if (src->extended_buf) {
417 dst->extended_buf = av_mallocz_array(sizeof(*dst->extended_buf),
418 src->nb_extended_buf);
419 if (!dst->extended_buf) {
420 ret = AVERROR(ENOMEM);
423 dst->nb_extended_buf = src->nb_extended_buf;
425 for (i = 0; i < src->nb_extended_buf; i++) {
426 dst->extended_buf[i] = av_buffer_ref(src->extended_buf[i]);
427 if (!dst->extended_buf[i]) {
428 ret = AVERROR(ENOMEM);
434 if (src->hw_frames_ctx) {
435 dst->hw_frames_ctx = av_buffer_ref(src->hw_frames_ctx);
436 if (!dst->hw_frames_ctx) {
437 ret = AVERROR(ENOMEM);
442 /* duplicate extended data */
443 if (src->extended_data != src->data) {
444 int ch = src->channels;
447 ret = AVERROR(EINVAL);
450 CHECK_CHANNELS_CONSISTENCY(src);
452 dst->extended_data = av_malloc_array(sizeof(*dst->extended_data), ch);
453 if (!dst->extended_data) {
454 ret = AVERROR(ENOMEM);
457 memcpy(dst->extended_data, src->extended_data, sizeof(*src->extended_data) * ch);
459 dst->extended_data = dst->data;
461 memcpy(dst->data, src->data, sizeof(src->data));
462 memcpy(dst->linesize, src->linesize, sizeof(src->linesize));
471 AVFrame *av_frame_clone(const AVFrame *src)
473 AVFrame *ret = av_frame_alloc();
478 if (av_frame_ref(ret, src) < 0)
484 void av_frame_unref(AVFrame *frame)
491 wipe_side_data(frame);
493 for (i = 0; i < FF_ARRAY_ELEMS(frame->buf); i++)
494 av_buffer_unref(&frame->buf[i]);
495 for (i = 0; i < frame->nb_extended_buf; i++)
496 av_buffer_unref(&frame->extended_buf[i]);
497 av_freep(&frame->extended_buf);
498 av_dict_free(&frame->metadata);
500 av_buffer_unref(&frame->qp_table_buf);
503 av_buffer_unref(&frame->hw_frames_ctx);
505 get_frame_defaults(frame);
508 void av_frame_move_ref(AVFrame *dst, AVFrame *src)
510 av_assert1(dst->width == 0 && dst->height == 0);
511 av_assert1(dst->channels == 0);
514 if (src->extended_data == src->data)
515 dst->extended_data = dst->data;
516 memset(src, 0, sizeof(*src));
517 get_frame_defaults(src);
520 int av_frame_is_writable(AVFrame *frame)
524 /* assume non-refcounted frames are not writable */
528 for (i = 0; i < FF_ARRAY_ELEMS(frame->buf); i++)
530 ret &= !!av_buffer_is_writable(frame->buf[i]);
531 for (i = 0; i < frame->nb_extended_buf; i++)
532 ret &= !!av_buffer_is_writable(frame->extended_buf[i]);
537 int av_frame_make_writable(AVFrame *frame)
543 return AVERROR(EINVAL);
545 if (av_frame_is_writable(frame))
548 memset(&tmp, 0, sizeof(tmp));
549 tmp.format = frame->format;
550 tmp.width = frame->width;
551 tmp.height = frame->height;
552 tmp.channels = frame->channels;
553 tmp.channel_layout = frame->channel_layout;
554 tmp.nb_samples = frame->nb_samples;
555 ret = av_frame_get_buffer(&tmp, 32);
559 ret = av_frame_copy(&tmp, frame);
561 av_frame_unref(&tmp);
565 ret = av_frame_copy_props(&tmp, frame);
567 av_frame_unref(&tmp);
571 av_frame_unref(frame);
574 if (tmp.data == tmp.extended_data)
575 frame->extended_data = frame->data;
580 int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
582 return frame_copy_props(dst, src, 1);
585 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane)
590 if (frame->nb_samples) {
591 int channels = frame->channels;
594 CHECK_CHANNELS_CONSISTENCY(frame);
595 planes = av_sample_fmt_is_planar(frame->format) ? channels : 1;
599 if (plane < 0 || plane >= planes || !frame->extended_data[plane])
601 data = frame->extended_data[plane];
603 for (i = 0; i < FF_ARRAY_ELEMS(frame->buf) && frame->buf[i]; i++) {
604 AVBufferRef *buf = frame->buf[i];
605 if (data >= buf->data && data < buf->data + buf->size)
608 for (i = 0; i < frame->nb_extended_buf; i++) {
609 AVBufferRef *buf = frame->extended_buf[i];
610 if (data >= buf->data && data < buf->data + buf->size)
616 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
617 enum AVFrameSideDataType type,
620 AVFrameSideData *ret, **tmp;
622 if (frame->nb_side_data > INT_MAX / sizeof(*frame->side_data) - 1)
625 tmp = av_realloc(frame->side_data,
626 (frame->nb_side_data + 1) * sizeof(*frame->side_data));
629 frame->side_data = tmp;
631 ret = av_mallocz(sizeof(*ret));
636 ret->buf = av_buffer_alloc(size);
642 ret->data = ret->buf->data;
647 frame->side_data[frame->nb_side_data++] = ret;
652 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
653 enum AVFrameSideDataType type)
657 for (i = 0; i < frame->nb_side_data; i++) {
658 if (frame->side_data[i]->type == type)
659 return frame->side_data[i];
664 static int frame_copy_video(AVFrame *dst, const AVFrame *src)
666 const uint8_t *src_data[4];
669 if (dst->width < src->width ||
670 dst->height < src->height)
671 return AVERROR(EINVAL);
673 planes = av_pix_fmt_count_planes(dst->format);
674 for (i = 0; i < planes; i++)
675 if (!dst->data[i] || !src->data[i])
676 return AVERROR(EINVAL);
678 memcpy(src_data, src->data, sizeof(src_data));
679 av_image_copy(dst->data, dst->linesize,
680 src_data, src->linesize,
681 dst->format, src->width, src->height);
686 static int frame_copy_audio(AVFrame *dst, const AVFrame *src)
688 int planar = av_sample_fmt_is_planar(dst->format);
689 int channels = dst->channels;
690 int planes = planar ? channels : 1;
693 if (dst->nb_samples != src->nb_samples ||
694 dst->channels != src->channels ||
695 dst->channel_layout != src->channel_layout)
696 return AVERROR(EINVAL);
698 CHECK_CHANNELS_CONSISTENCY(src);
700 for (i = 0; i < planes; i++)
701 if (!dst->extended_data[i] || !src->extended_data[i])
702 return AVERROR(EINVAL);
704 av_samples_copy(dst->extended_data, src->extended_data, 0, 0,
705 dst->nb_samples, channels, dst->format);
710 int av_frame_copy(AVFrame *dst, const AVFrame *src)
712 if (dst->format != src->format || dst->format < 0)
713 return AVERROR(EINVAL);
715 if (dst->width > 0 && dst->height > 0)
716 return frame_copy_video(dst, src);
717 else if (dst->nb_samples > 0 && dst->channel_layout)
718 return frame_copy_audio(dst, src);
720 return AVERROR(EINVAL);
723 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type)
727 for (i = 0; i < frame->nb_side_data; i++) {
728 AVFrameSideData *sd = frame->side_data[i];
729 if (sd->type == type) {
730 free_side_data(&frame->side_data[i]);
731 frame->side_data[i] = frame->side_data[frame->nb_side_data - 1];
732 frame->nb_side_data--;
737 const char *av_frame_side_data_name(enum AVFrameSideDataType type)
740 case AV_FRAME_DATA_PANSCAN: return "AVPanScan";
741 case AV_FRAME_DATA_A53_CC: return "ATSC A53 Part 4 Closed Captions";
742 case AV_FRAME_DATA_STEREO3D: return "Stereoscopic 3d metadata";
743 case AV_FRAME_DATA_MATRIXENCODING: return "AVMatrixEncoding";
744 case AV_FRAME_DATA_DOWNMIX_INFO: return "Metadata relevant to a downmix procedure";
745 case AV_FRAME_DATA_REPLAYGAIN: return "AVReplayGain";
746 case AV_FRAME_DATA_DISPLAYMATRIX: return "3x3 displaymatrix";
747 case AV_FRAME_DATA_AFD: return "Active format description";
748 case AV_FRAME_DATA_MOTION_VECTORS: return "Motion vectors";
749 case AV_FRAME_DATA_SKIP_SAMPLES: return "Skip samples";
750 case AV_FRAME_DATA_AUDIO_SERVICE_TYPE: return "Audio service type";
751 case AV_FRAME_DATA_MASTERING_DISPLAY_METADATA: return "Mastering display metadata";
752 case AV_FRAME_DATA_GOP_TIMECODE: return "GOP timecode";