3 * This file is part of FFmpeg.
5 * FFmpeg is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * FFmpeg is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with FFmpeg; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 #include "channel_layout.h"
28 #include "samplefmt.h"
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)
42 #define CHECK_CHANNELS_CONSISTENCY(frame) \
43 av_assert2(!(frame)->channel_layout || \
44 (frame)->channels == \
45 av_get_channel_layout_nb_channels((frame)->channel_layout))
47 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 f->qscale_table = buf->data;
57 f->qscale_type = qp_type;
62 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type)
65 *type = f->qscale_type;
70 return f->qp_table_buf->data;
73 const char *av_get_colorspace_name(enum AVColorSpace val)
75 static const char *name[] = {
76 [AVCOL_SPC_RGB] = "GBR",
77 [AVCOL_SPC_BT709] = "bt709",
78 [AVCOL_SPC_FCC] = "fcc",
79 [AVCOL_SPC_BT470BG] = "bt470bg",
80 [AVCOL_SPC_SMPTE170M] = "smpte170m",
81 [AVCOL_SPC_SMPTE240M] = "smpte240m",
82 [AVCOL_SPC_YCOCG] = "YCgCo",
84 if ((unsigned)val >= FF_ARRAY_ELEMS(name))
89 static void get_frame_defaults(AVFrame *frame)
91 if (frame->extended_data != frame->data)
92 av_freep(&frame->extended_data);
94 memset(frame, 0, sizeof(*frame));
98 frame->pkt_pts = AV_NOPTS_VALUE;
99 av_frame_set_best_effort_timestamp(frame, AV_NOPTS_VALUE);
100 av_frame_set_pkt_duration (frame, 0);
101 av_frame_set_pkt_pos (frame, -1);
102 av_frame_set_pkt_size (frame, -1);
103 frame->key_frame = 1;
104 frame->sample_aspect_ratio = (AVRational){ 0, 1 };
105 frame->format = -1; /* unknown */
106 frame->colorspace = AVCOL_SPC_UNSPECIFIED;
107 frame->extended_data = frame->data;
110 AVFrame *av_frame_alloc(void)
112 AVFrame *frame = av_mallocz(sizeof(*frame));
117 frame->extended_data = NULL;
118 get_frame_defaults(frame);
123 void av_frame_free(AVFrame **frame)
125 if (!frame || !*frame)
128 av_frame_unref(*frame);
132 static int get_video_buffer(AVFrame *frame, int align)
134 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(frame->format);
138 return AVERROR(EINVAL);
140 if ((ret = av_image_check_size(frame->width, frame->height, 0, NULL)) < 0)
143 if (!frame->linesize[0]) {
144 for(i=1; i<=align; i+=i) {
145 ret = av_image_fill_linesizes(frame->linesize, frame->format,
146 FFALIGN(frame->width, i));
149 if (!(frame->linesize[0] & (align-1)))
153 for (i = 0; i < 4 && frame->linesize[i]; i++)
154 frame->linesize[i] = FFALIGN(frame->linesize[i], align);
157 for (i = 0; i < 4 && frame->linesize[i]; i++) {
158 int h = FFALIGN(frame->height, 32);
159 if (i == 1 || i == 2)
160 h = FF_CEIL_RSHIFT(h, desc->log2_chroma_h);
162 frame->buf[i] = av_buffer_alloc(frame->linesize[i] * h + 16);
166 frame->data[i] = frame->buf[i]->data;
168 if (desc->flags & AV_PIX_FMT_FLAG_PAL || desc->flags & AV_PIX_FMT_FLAG_PSEUDOPAL) {
169 av_buffer_unref(&frame->buf[1]);
170 frame->buf[1] = av_buffer_alloc(1024);
173 frame->data[1] = frame->buf[1]->data;
176 frame->extended_data = frame->data;
180 av_frame_unref(frame);
181 return AVERROR(ENOMEM);
184 static int get_audio_buffer(AVFrame *frame, int align)
187 int planar = av_sample_fmt_is_planar(frame->format);
191 if (!frame->channels)
192 frame->channels = av_get_channel_layout_nb_channels(frame->channel_layout);
194 channels = frame->channels;
195 planes = planar ? channels : 1;
197 CHECK_CHANNELS_CONSISTENCY(frame);
198 if (!frame->linesize[0]) {
199 ret = av_samples_get_buffer_size(&frame->linesize[0], channels,
200 frame->nb_samples, frame->format,
206 if (planes > AV_NUM_DATA_POINTERS) {
207 frame->extended_data = av_mallocz(planes *
208 sizeof(*frame->extended_data));
209 frame->extended_buf = av_mallocz((planes - AV_NUM_DATA_POINTERS) *
210 sizeof(*frame->extended_buf));
211 if (!frame->extended_data || !frame->extended_buf) {
212 av_freep(&frame->extended_data);
213 av_freep(&frame->extended_buf);
214 return AVERROR(ENOMEM);
216 frame->nb_extended_buf = planes - AV_NUM_DATA_POINTERS;
218 frame->extended_data = frame->data;
220 for (i = 0; i < FFMIN(planes, AV_NUM_DATA_POINTERS); i++) {
221 frame->buf[i] = av_buffer_alloc(frame->linesize[0]);
222 if (!frame->buf[i]) {
223 av_frame_unref(frame);
224 return AVERROR(ENOMEM);
226 frame->extended_data[i] = frame->data[i] = frame->buf[i]->data;
228 for (i = 0; i < planes - AV_NUM_DATA_POINTERS; i++) {
229 frame->extended_buf[i] = av_buffer_alloc(frame->linesize[0]);
230 if (!frame->extended_buf[i]) {
231 av_frame_unref(frame);
232 return AVERROR(ENOMEM);
234 frame->extended_data[i + AV_NUM_DATA_POINTERS] = frame->extended_buf[i]->data;
240 int av_frame_get_buffer(AVFrame *frame, int align)
242 if (frame->format < 0)
243 return AVERROR(EINVAL);
245 if (frame->width > 0 && frame->height > 0)
246 return get_video_buffer(frame, align);
247 else if (frame->nb_samples > 0 && (frame->channel_layout || frame->channels > 0))
248 return get_audio_buffer(frame, align);
250 return AVERROR(EINVAL);
253 int av_frame_ref(AVFrame *dst, const AVFrame *src)
257 dst->format = src->format;
258 dst->width = src->width;
259 dst->height = src->height;
260 dst->channels = src->channels;
261 dst->channel_layout = src->channel_layout;
262 dst->nb_samples = src->nb_samples;
264 ret = av_frame_copy_props(dst, src);
268 /* duplicate the frame data if it's not refcounted */
270 ret = av_frame_get_buffer(dst, 32);
274 if (src->nb_samples) {
275 int ch = src->channels;
276 CHECK_CHANNELS_CONSISTENCY(src);
277 av_samples_copy(dst->extended_data, src->extended_data, 0, 0,
278 dst->nb_samples, ch, dst->format);
280 av_image_copy(dst->data, dst->linesize, src->data, src->linesize,
281 dst->format, dst->width, dst->height);
286 /* ref the buffers */
287 for (i = 0; i < FF_ARRAY_ELEMS(src->buf); i++) {
290 dst->buf[i] = av_buffer_ref(src->buf[i]);
292 ret = AVERROR(ENOMEM);
297 if (src->extended_buf) {
298 dst->extended_buf = av_mallocz(sizeof(*dst->extended_buf) *
299 src->nb_extended_buf);
300 if (!dst->extended_buf) {
301 ret = AVERROR(ENOMEM);
304 dst->nb_extended_buf = src->nb_extended_buf;
306 for (i = 0; i < src->nb_extended_buf; i++) {
307 dst->extended_buf[i] = av_buffer_ref(src->extended_buf[i]);
308 if (!dst->extended_buf[i]) {
309 ret = AVERROR(ENOMEM);
315 /* duplicate extended data */
316 if (src->extended_data != src->data) {
317 int ch = src->channels;
320 ret = AVERROR(EINVAL);
323 CHECK_CHANNELS_CONSISTENCY(src);
325 dst->extended_data = av_malloc(sizeof(*dst->extended_data) * ch);
326 if (!dst->extended_data) {
327 ret = AVERROR(ENOMEM);
330 memcpy(dst->extended_data, src->extended_data, sizeof(*src->extended_data) * ch);
332 dst->extended_data = dst->data;
334 memcpy(dst->data, src->data, sizeof(src->data));
335 memcpy(dst->linesize, src->linesize, sizeof(src->linesize));
344 AVFrame *av_frame_clone(const AVFrame *src)
346 AVFrame *ret = av_frame_alloc();
351 if (av_frame_ref(ret, src) < 0)
357 void av_frame_unref(AVFrame *frame)
361 for (i = 0; i < frame->nb_side_data; i++) {
362 av_freep(&frame->side_data[i]->data);
363 av_dict_free(&frame->side_data[i]->metadata);
364 av_freep(&frame->side_data[i]);
366 av_freep(&frame->side_data);
368 for (i = 0; i < FF_ARRAY_ELEMS(frame->buf); i++)
369 av_buffer_unref(&frame->buf[i]);
370 for (i = 0; i < frame->nb_extended_buf; i++)
371 av_buffer_unref(&frame->extended_buf[i]);
372 av_freep(&frame->extended_buf);
373 av_dict_free(&frame->metadata);
374 av_buffer_unref(&frame->qp_table_buf);
376 get_frame_defaults(frame);
379 void av_frame_move_ref(AVFrame *dst, AVFrame *src)
382 if (src->extended_data == src->data)
383 dst->extended_data = dst->data;
384 memset(src, 0, sizeof(*src));
385 get_frame_defaults(src);
388 int av_frame_is_writable(AVFrame *frame)
392 /* assume non-refcounted frames are not writable */
396 for (i = 0; i < FF_ARRAY_ELEMS(frame->buf); i++)
398 ret &= !!av_buffer_is_writable(frame->buf[i]);
399 for (i = 0; i < frame->nb_extended_buf; i++)
400 ret &= !!av_buffer_is_writable(frame->extended_buf[i]);
405 int av_frame_make_writable(AVFrame *frame)
411 return AVERROR(EINVAL);
413 if (av_frame_is_writable(frame))
416 memset(&tmp, 0, sizeof(tmp));
417 tmp.format = frame->format;
418 tmp.width = frame->width;
419 tmp.height = frame->height;
420 tmp.channels = frame->channels;
421 tmp.channel_layout = frame->channel_layout;
422 tmp.nb_samples = frame->nb_samples;
423 ret = av_frame_get_buffer(&tmp, 32);
427 if (tmp.nb_samples) {
428 int ch = tmp.channels;
429 CHECK_CHANNELS_CONSISTENCY(&tmp);
430 av_samples_copy(tmp.extended_data, frame->extended_data, 0, 0,
431 frame->nb_samples, ch, frame->format);
433 av_image_copy(tmp.data, tmp.linesize, frame->data, frame->linesize,
434 frame->format, frame->width, frame->height);
437 ret = av_frame_copy_props(&tmp, frame);
439 av_frame_unref(&tmp);
443 av_frame_unref(frame);
446 if (tmp.data == tmp.extended_data)
447 frame->extended_data = frame->data;
452 int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
456 dst->key_frame = src->key_frame;
457 dst->pict_type = src->pict_type;
458 dst->sample_aspect_ratio = src->sample_aspect_ratio;
460 dst->repeat_pict = src->repeat_pict;
461 dst->interlaced_frame = src->interlaced_frame;
462 dst->top_field_first = src->top_field_first;
463 dst->palette_has_changed = src->palette_has_changed;
464 dst->sample_rate = src->sample_rate;
465 dst->opaque = src->opaque;
466 #if FF_API_AVFRAME_LAVC
467 dst->type = src->type;
469 dst->pkt_pts = src->pkt_pts;
470 dst->pkt_dts = src->pkt_dts;
471 dst->pkt_pos = src->pkt_pos;
472 dst->pkt_size = src->pkt_size;
473 dst->pkt_duration = src->pkt_duration;
474 dst->reordered_opaque = src->reordered_opaque;
475 dst->quality = src->quality;
476 dst->best_effort_timestamp = src->best_effort_timestamp;
477 dst->coded_picture_number = src->coded_picture_number;
478 dst->display_picture_number = src->display_picture_number;
479 dst->flags = src->flags;
480 dst->decode_error_flags = src->decode_error_flags;
481 dst->colorspace = src->colorspace;
482 dst->color_range = src->color_range;
484 av_dict_copy(&dst->metadata, src->metadata, 0);
486 memcpy(dst->error, src->error, sizeof(dst->error));
488 for (i = 0; i < src->nb_side_data; i++) {
489 const AVFrameSideData *sd_src = src->side_data[i];
490 AVFrameSideData *sd_dst = av_frame_new_side_data(dst, sd_src->type,
493 for (i = 0; i < dst->nb_side_data; i++) {
494 av_freep(&dst->side_data[i]->data);
495 av_freep(&dst->side_data[i]);
496 av_dict_free(&dst->side_data[i]->metadata);
498 av_freep(&dst->side_data);
499 return AVERROR(ENOMEM);
501 memcpy(sd_dst->data, sd_src->data, sd_src->size);
502 av_dict_copy(&sd_dst->metadata, sd_src->metadata, 0);
505 dst->qscale_table = NULL;
507 dst->qscale_type = 0;
508 if (src->qp_table_buf) {
509 dst->qp_table_buf = av_buffer_ref(src->qp_table_buf);
510 if (dst->qp_table_buf) {
511 dst->qscale_table = dst->qp_table_buf->data;
512 dst->qstride = src->qstride;
513 dst->qscale_type = src->qscale_type;
520 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane)
525 if (frame->nb_samples) {
526 int channels = frame->channels;
529 CHECK_CHANNELS_CONSISTENCY(frame);
530 planes = av_sample_fmt_is_planar(frame->format) ? channels : 1;
534 if (plane < 0 || plane >= planes || !frame->extended_data[plane])
536 data = frame->extended_data[plane];
538 for (i = 0; i < FF_ARRAY_ELEMS(frame->buf) && frame->buf[i]; i++) {
539 AVBufferRef *buf = frame->buf[i];
540 if (data >= buf->data && data < buf->data + buf->size)
543 for (i = 0; i < frame->nb_extended_buf; i++) {
544 AVBufferRef *buf = frame->extended_buf[i];
545 if (data >= buf->data && data < buf->data + buf->size)
551 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
552 enum AVFrameSideDataType type,
555 AVFrameSideData *ret, **tmp;
557 if (frame->nb_side_data > INT_MAX / sizeof(*frame->side_data) - 1)
560 tmp = av_realloc(frame->side_data,
561 (frame->nb_side_data + 1) * sizeof(*frame->side_data));
564 frame->side_data = tmp;
566 ret = av_mallocz(sizeof(*ret));
570 ret->data = av_malloc(size);
579 frame->side_data[frame->nb_side_data++] = ret;
584 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
585 enum AVFrameSideDataType type)
589 for (i = 0; i < frame->nb_side_data; i++) {
590 if (frame->side_data[i]->type == type)
591 return frame->side_data[i];