Merge commit 'a18ef7a76c735bcf78ed4825e33ad7f9f6f77a54'
[ffmpeg.git] / libavutil / frame.c
1 /*
2  *
3  * This file is part of FFmpeg.
4  *
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.
9  *
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.
14  *
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
18  */
19
20 #include "channel_layout.h"
21 #include "avassert.h"
22 #include "buffer.h"
23 #include "common.h"
24 #include "dict.h"
25 #include "frame.h"
26 #include "imgutils.h"
27 #include "mem.h"
28 #include "samplefmt.h"
29
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
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))
46
47 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame) {return &frame->metadata;};
48
49 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int qp_type)
50 {
51     av_buffer_unref(&f->qp_table_buf);
52
53     f->qp_table_buf = buf;
54
55     f->qscale_table = buf->data;
56     f->qstride      = stride;
57     f->qscale_type  = qp_type;
58
59     return 0;
60 }
61
62 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type)
63 {
64     *stride = f->qstride;
65     *type   = f->qscale_type;
66
67     if (!f->qp_table_buf)
68         return NULL;
69
70     return f->qp_table_buf->data;
71 }
72
73 const char *av_get_colorspace_name(enum AVColorSpace val)
74 {
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",
83     };
84     if ((unsigned)val >= FF_ARRAY_ELEMS(name))
85         return NULL;
86     return name[val];
87 }
88
89 static void get_frame_defaults(AVFrame *frame)
90 {
91     if (frame->extended_data != frame->data)
92         av_freep(&frame->extended_data);
93
94     memset(frame, 0, sizeof(*frame));
95
96     frame->pts                   =
97     frame->pkt_dts               =
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;
108 }
109
110 AVFrame *av_frame_alloc(void)
111 {
112     AVFrame *frame = av_mallocz(sizeof(*frame));
113
114     if (!frame)
115         return NULL;
116
117     frame->extended_data = NULL;
118     get_frame_defaults(frame);
119
120     return frame;
121 }
122
123 void av_frame_free(AVFrame **frame)
124 {
125     if (!frame || !*frame)
126         return;
127
128     av_frame_unref(*frame);
129     av_freep(frame);
130 }
131
132 static int get_video_buffer(AVFrame *frame, int align)
133 {
134     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(frame->format);
135     int ret, i;
136
137     if (!desc)
138         return AVERROR(EINVAL);
139
140     if ((ret = av_image_check_size(frame->width, frame->height, 0, NULL)) < 0)
141         return ret;
142
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));
147             if (ret < 0)
148                 return ret;
149             if (!(frame->linesize[0] & (align-1)))
150                 break;
151         }
152
153         for (i = 0; i < 4 && frame->linesize[i]; i++)
154             frame->linesize[i] = FFALIGN(frame->linesize[i], align);
155     }
156
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);
161
162         frame->buf[i] = av_buffer_alloc(frame->linesize[i] * h + 16 + 16/*STRIDE_ALIGN*/ - 1);
163         if (!frame->buf[i])
164             goto fail;
165
166         frame->data[i] = frame->buf[i]->data;
167     }
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);
171         if (!frame->buf[1])
172             goto fail;
173         frame->data[1] = frame->buf[1]->data;
174     }
175
176     frame->extended_data = frame->data;
177
178     return 0;
179 fail:
180     av_frame_unref(frame);
181     return AVERROR(ENOMEM);
182 }
183
184 static int get_audio_buffer(AVFrame *frame, int align)
185 {
186     int channels;
187     int planar   = av_sample_fmt_is_planar(frame->format);
188     int planes;
189     int ret, i;
190
191     if (!frame->channels)
192         frame->channels = av_get_channel_layout_nb_channels(frame->channel_layout);
193
194     channels = frame->channels;
195     planes = planar ? channels : 1;
196
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,
201                                          align);
202         if (ret < 0)
203             return ret;
204     }
205
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);
215         }
216         frame->nb_extended_buf = planes - AV_NUM_DATA_POINTERS;
217     } else
218         frame->extended_data = frame->data;
219
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);
225         }
226         frame->extended_data[i] = frame->data[i] = frame->buf[i]->data;
227     }
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);
233         }
234         frame->extended_data[i + AV_NUM_DATA_POINTERS] = frame->extended_buf[i]->data;
235     }
236     return 0;
237
238 }
239
240 int av_frame_get_buffer(AVFrame *frame, int align)
241 {
242     if (frame->format < 0)
243         return AVERROR(EINVAL);
244
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);
249
250     return AVERROR(EINVAL);
251 }
252
253 int av_frame_ref(AVFrame *dst, const AVFrame *src)
254 {
255     int i, ret = 0;
256
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;
263
264     ret = av_frame_copy_props(dst, src);
265     if (ret < 0)
266         return ret;
267
268     /* duplicate the frame data if it's not refcounted */
269     if (!src->buf[0]) {
270         ret = av_frame_get_buffer(dst, 32);
271         if (ret < 0)
272             return ret;
273
274         ret = av_frame_copy(dst, src);
275         if (ret < 0)
276             av_frame_unref(dst);
277
278         return ret;
279     }
280
281     /* ref the buffers */
282     for (i = 0; i < FF_ARRAY_ELEMS(src->buf); i++) {
283         if (!src->buf[i])
284             continue;
285         dst->buf[i] = av_buffer_ref(src->buf[i]);
286         if (!dst->buf[i]) {
287             ret = AVERROR(ENOMEM);
288             goto fail;
289         }
290     }
291
292     if (src->extended_buf) {
293         dst->extended_buf = av_mallocz(sizeof(*dst->extended_buf) *
294                                        src->nb_extended_buf);
295         if (!dst->extended_buf) {
296             ret = AVERROR(ENOMEM);
297             goto fail;
298         }
299         dst->nb_extended_buf = src->nb_extended_buf;
300
301         for (i = 0; i < src->nb_extended_buf; i++) {
302             dst->extended_buf[i] = av_buffer_ref(src->extended_buf[i]);
303             if (!dst->extended_buf[i]) {
304                 ret = AVERROR(ENOMEM);
305                 goto fail;
306             }
307         }
308     }
309
310     /* duplicate extended data */
311     if (src->extended_data != src->data) {
312         int ch = src->channels;
313
314         if (!ch) {
315             ret = AVERROR(EINVAL);
316             goto fail;
317         }
318         CHECK_CHANNELS_CONSISTENCY(src);
319
320         dst->extended_data = av_malloc(sizeof(*dst->extended_data) * ch);
321         if (!dst->extended_data) {
322             ret = AVERROR(ENOMEM);
323             goto fail;
324         }
325         memcpy(dst->extended_data, src->extended_data, sizeof(*src->extended_data) * ch);
326     } else
327         dst->extended_data = dst->data;
328
329     memcpy(dst->data,     src->data,     sizeof(src->data));
330     memcpy(dst->linesize, src->linesize, sizeof(src->linesize));
331
332     return 0;
333
334 fail:
335     av_frame_unref(dst);
336     return ret;
337 }
338
339 AVFrame *av_frame_clone(const AVFrame *src)
340 {
341     AVFrame *ret = av_frame_alloc();
342
343     if (!ret)
344         return NULL;
345
346     if (av_frame_ref(ret, src) < 0)
347         av_frame_free(&ret);
348
349     return ret;
350 }
351
352 void av_frame_unref(AVFrame *frame)
353 {
354     int i;
355
356     for (i = 0; i < frame->nb_side_data; i++) {
357         av_freep(&frame->side_data[i]->data);
358         av_dict_free(&frame->side_data[i]->metadata);
359         av_freep(&frame->side_data[i]);
360     }
361     av_freep(&frame->side_data);
362
363     for (i = 0; i < FF_ARRAY_ELEMS(frame->buf); i++)
364         av_buffer_unref(&frame->buf[i]);
365     for (i = 0; i < frame->nb_extended_buf; i++)
366         av_buffer_unref(&frame->extended_buf[i]);
367     av_freep(&frame->extended_buf);
368     av_dict_free(&frame->metadata);
369     av_buffer_unref(&frame->qp_table_buf);
370
371     get_frame_defaults(frame);
372 }
373
374 void av_frame_move_ref(AVFrame *dst, AVFrame *src)
375 {
376     *dst = *src;
377     if (src->extended_data == src->data)
378         dst->extended_data = dst->data;
379     memset(src, 0, sizeof(*src));
380     get_frame_defaults(src);
381 }
382
383 int av_frame_is_writable(AVFrame *frame)
384 {
385     int i, ret = 1;
386
387     /* assume non-refcounted frames are not writable */
388     if (!frame->buf[0])
389         return 0;
390
391     for (i = 0; i < FF_ARRAY_ELEMS(frame->buf); i++)
392         if (frame->buf[i])
393             ret &= !!av_buffer_is_writable(frame->buf[i]);
394     for (i = 0; i < frame->nb_extended_buf; i++)
395         ret &= !!av_buffer_is_writable(frame->extended_buf[i]);
396
397     return ret;
398 }
399
400 int av_frame_make_writable(AVFrame *frame)
401 {
402     AVFrame tmp;
403     int ret;
404
405     if (!frame->buf[0])
406         return AVERROR(EINVAL);
407
408     if (av_frame_is_writable(frame))
409         return 0;
410
411     memset(&tmp, 0, sizeof(tmp));
412     tmp.format         = frame->format;
413     tmp.width          = frame->width;
414     tmp.height         = frame->height;
415     tmp.channels       = frame->channels;
416     tmp.channel_layout = frame->channel_layout;
417     tmp.nb_samples     = frame->nb_samples;
418     ret = av_frame_get_buffer(&tmp, 32);
419     if (ret < 0)
420         return ret;
421
422     ret = av_frame_copy(&tmp, frame);
423     if (ret < 0) {
424         av_frame_unref(&tmp);
425         return ret;
426     }
427
428     ret = av_frame_copy_props(&tmp, frame);
429     if (ret < 0) {
430         av_frame_unref(&tmp);
431         return ret;
432     }
433
434     av_frame_unref(frame);
435
436     *frame = tmp;
437     if (tmp.data == tmp.extended_data)
438         frame->extended_data = frame->data;
439
440     return 0;
441 }
442
443 int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
444 {
445     int i;
446
447     dst->key_frame              = src->key_frame;
448     dst->pict_type              = src->pict_type;
449     dst->sample_aspect_ratio    = src->sample_aspect_ratio;
450     dst->pts                    = src->pts;
451     dst->repeat_pict            = src->repeat_pict;
452     dst->interlaced_frame       = src->interlaced_frame;
453     dst->top_field_first        = src->top_field_first;
454     dst->palette_has_changed    = src->palette_has_changed;
455     dst->sample_rate            = src->sample_rate;
456     dst->opaque                 = src->opaque;
457 #if FF_API_AVFRAME_LAVC
458     dst->type                   = src->type;
459 #endif
460     dst->pkt_pts                = src->pkt_pts;
461     dst->pkt_dts                = src->pkt_dts;
462     dst->pkt_pos                = src->pkt_pos;
463     dst->pkt_size               = src->pkt_size;
464     dst->pkt_duration           = src->pkt_duration;
465     dst->reordered_opaque       = src->reordered_opaque;
466     dst->quality                = src->quality;
467     dst->best_effort_timestamp  = src->best_effort_timestamp;
468     dst->coded_picture_number   = src->coded_picture_number;
469     dst->display_picture_number = src->display_picture_number;
470     dst->flags                  = src->flags;
471     dst->decode_error_flags     = src->decode_error_flags;
472     dst->colorspace             = src->colorspace;
473     dst->color_range            = src->color_range;
474
475     av_dict_copy(&dst->metadata, src->metadata, 0);
476
477     memcpy(dst->error, src->error, sizeof(dst->error));
478
479     for (i = 0; i < src->nb_side_data; i++) {
480         const AVFrameSideData *sd_src = src->side_data[i];
481         AVFrameSideData *sd_dst = av_frame_new_side_data(dst, sd_src->type,
482                                                          sd_src->size);
483         if (!sd_dst) {
484             for (i = 0; i < dst->nb_side_data; i++) {
485                 av_freep(&dst->side_data[i]->data);
486                 av_freep(&dst->side_data[i]);
487                 av_dict_free(&dst->side_data[i]->metadata);
488             }
489             av_freep(&dst->side_data);
490             return AVERROR(ENOMEM);
491         }
492         memcpy(sd_dst->data, sd_src->data, sd_src->size);
493         av_dict_copy(&sd_dst->metadata, sd_src->metadata, 0);
494     }
495
496     dst->qscale_table = NULL;
497     dst->qstride      = 0;
498     dst->qscale_type  = 0;
499     if (src->qp_table_buf) {
500         dst->qp_table_buf = av_buffer_ref(src->qp_table_buf);
501         if (dst->qp_table_buf) {
502             dst->qscale_table = dst->qp_table_buf->data;
503             dst->qstride      = src->qstride;
504             dst->qscale_type  = src->qscale_type;
505         }
506     }
507
508     return 0;
509 }
510
511 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane)
512 {
513     uint8_t *data;
514     int planes, i;
515
516     if (frame->nb_samples) {
517         int channels = frame->channels;
518         if (!channels)
519             return NULL;
520         CHECK_CHANNELS_CONSISTENCY(frame);
521         planes = av_sample_fmt_is_planar(frame->format) ? channels : 1;
522     } else
523         planes = 4;
524
525     if (plane < 0 || plane >= planes || !frame->extended_data[plane])
526         return NULL;
527     data = frame->extended_data[plane];
528
529     for (i = 0; i < FF_ARRAY_ELEMS(frame->buf) && frame->buf[i]; i++) {
530         AVBufferRef *buf = frame->buf[i];
531         if (data >= buf->data && data < buf->data + buf->size)
532             return buf;
533     }
534     for (i = 0; i < frame->nb_extended_buf; i++) {
535         AVBufferRef *buf = frame->extended_buf[i];
536         if (data >= buf->data && data < buf->data + buf->size)
537             return buf;
538     }
539     return NULL;
540 }
541
542 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
543                                         enum AVFrameSideDataType type,
544                                         int size)
545 {
546     AVFrameSideData *ret, **tmp;
547
548     if (frame->nb_side_data > INT_MAX / sizeof(*frame->side_data) - 1)
549         return NULL;
550
551     tmp = av_realloc(frame->side_data,
552                      (frame->nb_side_data + 1) * sizeof(*frame->side_data));
553     if (!tmp)
554         return NULL;
555     frame->side_data = tmp;
556
557     ret = av_mallocz(sizeof(*ret));
558     if (!ret)
559         return NULL;
560
561     ret->data = av_malloc(size);
562     if (!ret->data) {
563         av_freep(&ret);
564         return NULL;
565     }
566
567     ret->size = size;
568     ret->type = type;
569
570     frame->side_data[frame->nb_side_data++] = ret;
571
572     return ret;
573 }
574
575 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
576                                         enum AVFrameSideDataType type)
577 {
578     int i;
579
580     for (i = 0; i < frame->nb_side_data; i++) {
581         if (frame->side_data[i]->type == type)
582             return frame->side_data[i];
583     }
584     return NULL;
585 }
586
587 static int frame_copy_video(AVFrame *dst, const AVFrame *src)
588 {
589     const uint8_t *src_data[4];
590     int i, planes;
591
592     if (dst->width  != src->width ||
593         dst->height != src->height)
594         return AVERROR(EINVAL);
595
596     planes = av_pix_fmt_count_planes(dst->format);
597     for (i = 0; i < planes; i++)
598         if (!dst->data[i] || !src->data[i])
599             return AVERROR(EINVAL);
600
601     memcpy(src_data, src->data, sizeof(src_data));
602     av_image_copy(dst->data, dst->linesize,
603                   src_data, src->linesize,
604                   dst->format, dst->width, dst->height);
605
606     return 0;
607 }
608
609 static int frame_copy_audio(AVFrame *dst, const AVFrame *src)
610 {
611     int planar   = av_sample_fmt_is_planar(dst->format);
612     int channels = dst->channels;
613     int planes   = planar ? channels : 1;
614     int i;
615
616     if (dst->nb_samples     != src->nb_samples ||
617         dst->channels       != src->channels ||
618         dst->channel_layout != src->channel_layout)
619         return AVERROR(EINVAL);
620
621     CHECK_CHANNELS_CONSISTENCY(src);
622
623     for (i = 0; i < planes; i++)
624         if (!dst->extended_data[i] || !src->extended_data[i])
625             return AVERROR(EINVAL);
626
627     av_samples_copy(dst->extended_data, src->extended_data, 0, 0,
628                     dst->nb_samples, channels, dst->format);
629
630     return 0;
631 }
632
633 int av_frame_copy(AVFrame *dst, const AVFrame *src)
634 {
635     if (dst->format != src->format || dst->format < 0)
636         return AVERROR(EINVAL);
637
638     if (dst->width > 0 && dst->height > 0)
639         return frame_copy_video(dst, src);
640     else if (dst->nb_samples > 0 && dst->channel_layout)
641         return frame_copy_audio(dst, src);
642
643     return AVERROR(EINVAL);
644 }