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 #define MAKE_ACCESSORS(str, name, type, field) \
31 type av_##name##_get_##field(const str *s) { return s->field; } \
32 void av_##name##_set_##field(str *s, type v) { s->field = v; }
34 MAKE_ACCESSORS(AVFrame, frame, int64_t, best_effort_timestamp)
35 MAKE_ACCESSORS(AVFrame, frame, int64_t, pkt_duration)
36 MAKE_ACCESSORS(AVFrame, frame, int64_t, pkt_pos)
37 MAKE_ACCESSORS(AVFrame, frame, int64_t, channel_layout)
38 MAKE_ACCESSORS(AVFrame, frame, int, channels)
39 MAKE_ACCESSORS(AVFrame, frame, int, sample_rate)
40 MAKE_ACCESSORS(AVFrame, frame, AVDictionary *, metadata)
41 MAKE_ACCESSORS(AVFrame, frame, int, decode_error_flags)
42 MAKE_ACCESSORS(AVFrame, frame, int, pkt_size)
44 #define CHECK_CHANNELS_CONSISTENCY(frame) \
45 av_assert2(!(frame)->channel_layout || \
46 (frame)->channels == \
47 av_get_channel_layout_nb_channels((frame)->channel_layout))
49 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame) {return &frame->metadata;};
51 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int qp_type)
53 av_buffer_unref(&f->qp_table_buf);
55 f->qp_table_buf = buf;
57 f->qscale_table = buf->data;
59 f->qscale_type = qp_type;
64 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type)
67 *type = f->qscale_type;
72 return f->qp_table_buf->data;
75 static void get_frame_defaults(AVFrame *frame)
77 if (frame->extended_data != frame->data)
78 av_freep(&frame->extended_data);
80 memset(frame, 0, sizeof(*frame));
84 frame->pkt_pts = AV_NOPTS_VALUE;
85 av_frame_set_best_effort_timestamp(frame, AV_NOPTS_VALUE);
86 av_frame_set_pkt_duration (frame, 0);
87 av_frame_set_pkt_pos (frame, -1);
88 av_frame_set_pkt_size (frame, -1);
90 frame->sample_aspect_ratio = (AVRational){ 0, 1 };
91 frame->format = -1; /* unknown */
92 frame->extended_data = frame->data;
95 AVFrame *av_frame_alloc(void)
97 AVFrame *frame = av_mallocz(sizeof(*frame));
102 frame->extended_data = NULL;
103 get_frame_defaults(frame);
108 void av_frame_free(AVFrame **frame)
110 if (!frame || !*frame)
113 av_frame_unref(*frame);
117 static int get_video_buffer(AVFrame *frame, int align)
119 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(frame->format);
123 return AVERROR(EINVAL);
125 if ((ret = av_image_check_size(frame->width, frame->height, 0, NULL)) < 0)
128 if (!frame->linesize[0]) {
129 ret = av_image_fill_linesizes(frame->linesize, frame->format,
134 for (i = 0; i < 4 && frame->linesize[i]; i++)
135 frame->linesize[i] = FFALIGN(frame->linesize[i], align);
138 for (i = 0; i < 4 && frame->linesize[i]; i++) {
139 int h = FFALIGN(frame->height, 32);
140 if (i == 1 || i == 2)
141 h = FF_CEIL_RSHIFT(h, desc->log2_chroma_h);
143 frame->buf[i] = av_buffer_alloc(frame->linesize[i] * h + 16);
147 frame->data[i] = frame->buf[i]->data;
149 if (desc->flags & AV_PIX_FMT_FLAG_PAL || desc->flags & AV_PIX_FMT_FLAG_PSEUDOPAL) {
150 av_buffer_unref(&frame->buf[1]);
151 frame->buf[1] = av_buffer_alloc(1024);
154 frame->data[1] = frame->buf[1]->data;
157 frame->extended_data = frame->data;
161 av_frame_unref(frame);
162 return AVERROR(ENOMEM);
165 static int get_audio_buffer(AVFrame *frame, int align)
167 int channels = frame->channels;
168 int planar = av_sample_fmt_is_planar(frame->format);
169 int planes = planar ? channels : 1;
172 CHECK_CHANNELS_CONSISTENCY(frame);
173 if (!frame->linesize[0]) {
174 ret = av_samples_get_buffer_size(&frame->linesize[0], channels,
175 frame->nb_samples, frame->format,
181 if (planes > AV_NUM_DATA_POINTERS) {
182 frame->extended_data = av_mallocz(planes *
183 sizeof(*frame->extended_data));
184 frame->extended_buf = av_mallocz((planes - AV_NUM_DATA_POINTERS) *
185 sizeof(*frame->extended_buf));
186 if (!frame->extended_data || !frame->extended_buf) {
187 av_freep(&frame->extended_data);
188 av_freep(&frame->extended_buf);
189 return AVERROR(ENOMEM);
191 frame->nb_extended_buf = planes - AV_NUM_DATA_POINTERS;
193 frame->extended_data = frame->data;
195 for (i = 0; i < FFMIN(planes, AV_NUM_DATA_POINTERS); i++) {
196 frame->buf[i] = av_buffer_alloc(frame->linesize[0]);
197 if (!frame->buf[i]) {
198 av_frame_unref(frame);
199 return AVERROR(ENOMEM);
201 frame->extended_data[i] = frame->data[i] = frame->buf[i]->data;
203 for (i = 0; i < planes - AV_NUM_DATA_POINTERS; i++) {
204 frame->extended_buf[i] = av_buffer_alloc(frame->linesize[0]);
205 if (!frame->extended_buf[i]) {
206 av_frame_unref(frame);
207 return AVERROR(ENOMEM);
209 frame->extended_data[i + AV_NUM_DATA_POINTERS] = frame->extended_buf[i]->data;
215 int av_frame_get_buffer(AVFrame *frame, int align)
217 if (frame->format < 0)
218 return AVERROR(EINVAL);
220 if (frame->width > 0 && frame->height > 0)
221 return get_video_buffer(frame, align);
222 else if (frame->nb_samples > 0 && frame->channel_layout)
223 return get_audio_buffer(frame, align);
225 return AVERROR(EINVAL);
228 int av_frame_ref(AVFrame *dst, AVFrame *src)
232 dst->format = src->format;
233 dst->width = src->width;
234 dst->height = src->height;
235 dst->channels = src->channels;
236 dst->channel_layout = src->channel_layout;
237 dst->nb_samples = src->nb_samples;
239 ret = av_frame_copy_props(dst, src);
243 /* duplicate the frame data if it's not refcounted */
245 ret = av_frame_get_buffer(dst, 32);
249 if (src->nb_samples) {
250 int ch = src->channels;
251 CHECK_CHANNELS_CONSISTENCY(src);
252 av_samples_copy(dst->extended_data, src->extended_data, 0, 0,
253 dst->nb_samples, ch, dst->format);
255 av_image_copy(dst->data, dst->linesize, src->data, src->linesize,
256 dst->format, dst->width, dst->height);
261 /* ref the buffers */
262 for (i = 0; i < FF_ARRAY_ELEMS(src->buf); i++) {
265 dst->buf[i] = av_buffer_ref(src->buf[i]);
267 ret = AVERROR(ENOMEM);
272 if (src->extended_buf) {
273 dst->extended_buf = av_mallocz(sizeof(*dst->extended_buf) *
274 src->nb_extended_buf);
275 if (!dst->extended_buf) {
276 ret = AVERROR(ENOMEM);
279 dst->nb_extended_buf = src->nb_extended_buf;
281 for (i = 0; i < src->nb_extended_buf; i++) {
282 dst->extended_buf[i] = av_buffer_ref(src->extended_buf[i]);
283 if (!dst->extended_buf[i]) {
284 ret = AVERROR(ENOMEM);
290 /* duplicate extended data */
291 if (src->extended_data != src->data) {
292 int ch = src->channels;
295 ret = AVERROR(EINVAL);
298 CHECK_CHANNELS_CONSISTENCY(src);
300 dst->extended_data = av_malloc(sizeof(*dst->extended_data) * ch);
301 if (!dst->extended_data) {
302 ret = AVERROR(ENOMEM);
305 memcpy(dst->extended_data, src->extended_data, sizeof(*src->extended_data) * ch);
307 dst->extended_data = dst->data;
309 memcpy(dst->data, src->data, sizeof(src->data));
310 memcpy(dst->linesize, src->linesize, sizeof(src->linesize));
319 AVFrame *av_frame_clone(AVFrame *src)
321 AVFrame *ret = av_frame_alloc();
326 if (av_frame_ref(ret, src) < 0)
332 void av_frame_unref(AVFrame *frame)
336 for (i = 0; i < frame->nb_side_data; i++) {
337 av_freep(&frame->side_data[i]->data);
338 av_dict_free(&frame->side_data[i]->metadata);
339 av_freep(&frame->side_data[i]);
341 av_freep(&frame->side_data);
343 for (i = 0; i < FF_ARRAY_ELEMS(frame->buf); i++)
344 av_buffer_unref(&frame->buf[i]);
345 for (i = 0; i < frame->nb_extended_buf; i++)
346 av_buffer_unref(&frame->extended_buf[i]);
347 av_freep(&frame->extended_buf);
348 av_dict_free(&frame->metadata);
349 av_buffer_unref(&frame->qp_table_buf);
351 get_frame_defaults(frame);
354 void av_frame_move_ref(AVFrame *dst, AVFrame *src)
357 if (src->extended_data == src->data)
358 dst->extended_data = dst->data;
359 memset(src, 0, sizeof(*src));
360 get_frame_defaults(src);
363 int av_frame_is_writable(AVFrame *frame)
367 /* assume non-refcounted frames are not writable */
371 for (i = 0; i < FF_ARRAY_ELEMS(frame->buf); i++)
373 ret &= !!av_buffer_is_writable(frame->buf[i]);
374 for (i = 0; i < frame->nb_extended_buf; i++)
375 ret &= !!av_buffer_is_writable(frame->extended_buf[i]);
380 int av_frame_make_writable(AVFrame *frame)
386 return AVERROR(EINVAL);
388 if (av_frame_is_writable(frame))
391 memset(&tmp, 0, sizeof(tmp));
392 tmp.format = frame->format;
393 tmp.width = frame->width;
394 tmp.height = frame->height;
395 tmp.channels = frame->channels;
396 tmp.channel_layout = frame->channel_layout;
397 tmp.nb_samples = frame->nb_samples;
398 ret = av_frame_get_buffer(&tmp, 32);
402 if (tmp.nb_samples) {
403 int ch = tmp.channels;
404 CHECK_CHANNELS_CONSISTENCY(&tmp);
405 av_samples_copy(tmp.extended_data, frame->extended_data, 0, 0,
406 frame->nb_samples, ch, frame->format);
408 av_image_copy(tmp.data, tmp.linesize, frame->data, frame->linesize,
409 frame->format, frame->width, frame->height);
412 ret = av_frame_copy_props(&tmp, frame);
414 av_frame_unref(&tmp);
418 av_frame_unref(frame);
421 if (tmp.data == tmp.extended_data)
422 frame->extended_data = frame->data;
427 int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
431 dst->key_frame = src->key_frame;
432 dst->pict_type = src->pict_type;
433 dst->sample_aspect_ratio = src->sample_aspect_ratio;
435 dst->repeat_pict = src->repeat_pict;
436 dst->interlaced_frame = src->interlaced_frame;
437 dst->top_field_first = src->top_field_first;
438 dst->palette_has_changed = src->palette_has_changed;
439 dst->sample_rate = src->sample_rate;
440 dst->opaque = src->opaque;
441 #if FF_API_AVFRAME_LAVC
442 dst->type = src->type;
444 dst->pkt_pts = src->pkt_pts;
445 dst->pkt_dts = src->pkt_dts;
446 dst->pkt_pos = src->pkt_pos;
447 dst->pkt_size = src->pkt_size;
448 dst->pkt_duration = src->pkt_duration;
449 dst->reordered_opaque = src->reordered_opaque;
450 dst->quality = src->quality;
451 dst->best_effort_timestamp = src->best_effort_timestamp;
452 dst->coded_picture_number = src->coded_picture_number;
453 dst->display_picture_number = src->display_picture_number;
454 dst->decode_error_flags = src->decode_error_flags;
456 av_dict_copy(&dst->metadata, src->metadata, 0);
458 memcpy(dst->error, src->error, sizeof(dst->error));
460 for (i = 0; i < src->nb_side_data; i++) {
461 const AVFrameSideData *sd_src = src->side_data[i];
462 AVFrameSideData *sd_dst = av_frame_new_side_data(dst, sd_src->type,
465 for (i = 0; i < dst->nb_side_data; i++) {
466 av_freep(&dst->side_data[i]->data);
467 av_freep(&dst->side_data[i]);
468 av_dict_free(&dst->side_data[i]->metadata);
470 av_freep(&dst->side_data);
471 return AVERROR(ENOMEM);
473 memcpy(sd_dst->data, sd_src->data, sd_src->size);
474 av_dict_copy(&sd_dst->metadata, sd_src->metadata, 0);
477 dst->qscale_table = NULL;
479 dst->qscale_type = 0;
480 if (src->qp_table_buf) {
481 dst->qp_table_buf = av_buffer_ref(src->qp_table_buf);
482 if (dst->qp_table_buf) {
483 dst->qscale_table = dst->qp_table_buf->data;
484 dst->qstride = src->qstride;
485 dst->qscale_type = src->qscale_type;
492 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane)
497 if (frame->nb_samples) {
498 int channels = frame->channels;
501 CHECK_CHANNELS_CONSISTENCY(frame);
502 planes = av_sample_fmt_is_planar(frame->format) ? channels : 1;
506 if (plane < 0 || plane >= planes || !frame->extended_data[plane])
508 data = frame->extended_data[plane];
510 for (i = 0; i < FF_ARRAY_ELEMS(frame->buf) && frame->buf[i]; i++) {
511 AVBufferRef *buf = frame->buf[i];
512 if (data >= buf->data && data < buf->data + buf->size)
515 for (i = 0; i < frame->nb_extended_buf; i++) {
516 AVBufferRef *buf = frame->extended_buf[i];
517 if (data >= buf->data && data < buf->data + buf->size)
523 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
524 enum AVFrameSideDataType type,
527 AVFrameSideData *ret, **tmp;
529 if (frame->nb_side_data > INT_MAX / sizeof(*frame->side_data) - 1)
532 tmp = av_realloc(frame->side_data,
533 (frame->nb_side_data + 1) * sizeof(*frame->side_data));
536 frame->side_data = tmp;
538 ret = av_mallocz(sizeof(*ret));
542 ret->data = av_malloc(size);
551 frame->side_data[frame->nb_side_data++] = ret;
556 AVFrameSideData *av_frame_get_side_data(AVFrame *frame,
557 enum AVFrameSideDataType type)
561 for (i = 0; i < frame->nb_side_data; i++) {
562 if (frame->side_data[i]->type == type)
563 return frame->side_data[i];