lavu: add a framework for handling hwaccel frames
[ffmpeg.git] / libavutil / frame.c
1 /*
2  *
3  * This file is part of Libav.
4  *
5  * Libav 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  * Libav 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 Libav; 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 "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 static void get_frame_defaults(AVFrame *frame)
30 {
31     if (frame->extended_data != frame->data)
32         av_freep(&frame->extended_data);
33
34     memset(frame, 0, sizeof(*frame));
35
36     frame->pts                 = AV_NOPTS_VALUE;
37     frame->key_frame           = 1;
38     frame->sample_aspect_ratio = (AVRational){ 0, 1 };
39     frame->format              = -1; /* unknown */
40     frame->extended_data       = frame->data;
41     frame->color_primaries     = AVCOL_PRI_UNSPECIFIED;
42     frame->color_trc           = AVCOL_TRC_UNSPECIFIED;
43     frame->colorspace          = AVCOL_SPC_UNSPECIFIED;
44     frame->color_range         = AVCOL_RANGE_UNSPECIFIED;
45     frame->chroma_location     = AVCHROMA_LOC_UNSPECIFIED;
46 }
47
48 static void free_side_data(AVFrameSideData **ptr_sd)
49 {
50     AVFrameSideData *sd = *ptr_sd;
51
52     av_freep(&sd->data);
53     av_dict_free(&sd->metadata);
54     av_freep(ptr_sd);
55 }
56
57 static void wipe_side_data(AVFrame *frame)
58 {
59     int i;
60
61     for (i = 0; i < frame->nb_side_data; i++) {
62         free_side_data(&frame->side_data[i]);
63     }
64     frame->nb_side_data = 0;
65
66     av_freep(&frame->side_data);
67 }
68
69 AVFrame *av_frame_alloc(void)
70 {
71     AVFrame *frame = av_mallocz(sizeof(*frame));
72
73     if (!frame)
74         return NULL;
75
76     get_frame_defaults(frame);
77
78     return frame;
79 }
80
81 void av_frame_free(AVFrame **frame)
82 {
83     if (!frame || !*frame)
84         return;
85
86     av_frame_unref(*frame);
87     av_freep(frame);
88 }
89
90 static int get_video_buffer(AVFrame *frame, int align)
91 {
92     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(frame->format);
93     int ret, i;
94
95     if (!desc)
96         return AVERROR(EINVAL);
97
98     if ((ret = av_image_check_size(frame->width, frame->height, 0, NULL)) < 0)
99         return ret;
100
101     if (!frame->linesize[0]) {
102         ret = av_image_fill_linesizes(frame->linesize, frame->format,
103                                       frame->width);
104         if (ret < 0)
105             return ret;
106
107         for (i = 0; i < 4 && frame->linesize[i]; i++)
108             frame->linesize[i] = FFALIGN(frame->linesize[i], align);
109     }
110
111     for (i = 0; i < 4 && frame->linesize[i]; i++) {
112         int h = frame->height;
113         if (i == 1 || i == 2)
114             h = AV_CEIL_RSHIFT(h, desc->log2_chroma_h);
115
116         frame->buf[i] = av_buffer_alloc(frame->linesize[i] * h);
117         if (!frame->buf[i])
118             goto fail;
119
120         frame->data[i] = frame->buf[i]->data;
121     }
122     if (desc->flags & AV_PIX_FMT_FLAG_PAL || desc->flags & AV_PIX_FMT_FLAG_PSEUDOPAL) {
123         av_buffer_unref(&frame->buf[1]);
124         frame->buf[1] = av_buffer_alloc(1024);
125         if (!frame->buf[1])
126             goto fail;
127         frame->data[1] = frame->buf[1]->data;
128     }
129
130     frame->extended_data = frame->data;
131
132     return 0;
133 fail:
134     av_frame_unref(frame);
135     return AVERROR(ENOMEM);
136 }
137
138 static int get_audio_buffer(AVFrame *frame, int align)
139 {
140     int channels = av_get_channel_layout_nb_channels(frame->channel_layout);
141     int planar   = av_sample_fmt_is_planar(frame->format);
142     int planes   = planar ? channels : 1;
143     int ret, i;
144
145     if (!frame->linesize[0]) {
146         ret = av_samples_get_buffer_size(&frame->linesize[0], channels,
147                                          frame->nb_samples, frame->format,
148                                          align);
149         if (ret < 0)
150             return ret;
151     }
152
153     if (planes > AV_NUM_DATA_POINTERS) {
154         frame->extended_data = av_mallocz(planes *
155                                           sizeof(*frame->extended_data));
156         frame->extended_buf  = av_mallocz((planes - AV_NUM_DATA_POINTERS) *
157                                           sizeof(*frame->extended_buf));
158         if (!frame->extended_data || !frame->extended_buf) {
159             av_freep(&frame->extended_data);
160             av_freep(&frame->extended_buf);
161             return AVERROR(ENOMEM);
162         }
163         frame->nb_extended_buf = planes - AV_NUM_DATA_POINTERS;
164     } else
165         frame->extended_data = frame->data;
166
167     for (i = 0; i < FFMIN(planes, AV_NUM_DATA_POINTERS); i++) {
168         frame->buf[i] = av_buffer_alloc(frame->linesize[0]);
169         if (!frame->buf[i]) {
170             av_frame_unref(frame);
171             return AVERROR(ENOMEM);
172         }
173         frame->extended_data[i] = frame->data[i] = frame->buf[i]->data;
174     }
175     for (i = 0; i < planes - AV_NUM_DATA_POINTERS; i++) {
176         frame->extended_buf[i] = av_buffer_alloc(frame->linesize[0]);
177         if (!frame->extended_buf[i]) {
178             av_frame_unref(frame);
179             return AVERROR(ENOMEM);
180         }
181         frame->extended_data[i + AV_NUM_DATA_POINTERS] = frame->extended_buf[i]->data;
182     }
183     return 0;
184
185 }
186
187 int av_frame_get_buffer(AVFrame *frame, int align)
188 {
189     if (frame->format < 0)
190         return AVERROR(EINVAL);
191
192     if (frame->width > 0 && frame->height > 0)
193         return get_video_buffer(frame, align);
194     else if (frame->nb_samples > 0 && frame->channel_layout)
195         return get_audio_buffer(frame, align);
196
197     return AVERROR(EINVAL);
198 }
199
200 int av_frame_ref(AVFrame *dst, const AVFrame *src)
201 {
202     int i, ret = 0;
203
204     dst->format         = src->format;
205     dst->width          = src->width;
206     dst->height         = src->height;
207     dst->channel_layout = src->channel_layout;
208     dst->nb_samples     = src->nb_samples;
209
210     ret = av_frame_copy_props(dst, src);
211     if (ret < 0)
212         return ret;
213
214     /* duplicate the frame data if it's not refcounted */
215     if (!src->buf[0]) {
216         ret = av_frame_get_buffer(dst, 32);
217         if (ret < 0)
218             return ret;
219
220         ret = av_frame_copy(dst, src);
221         if (ret < 0)
222             av_frame_unref(dst);
223
224         return ret;
225     }
226
227     /* ref the buffers */
228     for (i = 0; i < FF_ARRAY_ELEMS(src->buf) && src->buf[i]; i++) {
229         dst->buf[i] = av_buffer_ref(src->buf[i]);
230         if (!dst->buf[i]) {
231             ret = AVERROR(ENOMEM);
232             goto fail;
233         }
234     }
235
236     if (src->extended_buf) {
237         dst->extended_buf = av_mallocz(sizeof(*dst->extended_buf) *
238                                        src->nb_extended_buf);
239         if (!dst->extended_buf) {
240             ret = AVERROR(ENOMEM);
241             goto fail;
242         }
243         dst->nb_extended_buf = src->nb_extended_buf;
244
245         for (i = 0; i < src->nb_extended_buf; i++) {
246             dst->extended_buf[i] = av_buffer_ref(src->extended_buf[i]);
247             if (!dst->extended_buf[i]) {
248                 ret = AVERROR(ENOMEM);
249                 goto fail;
250             }
251         }
252     }
253
254     if (src->hw_frames_ctx) {
255         dst->hw_frames_ctx = av_buffer_ref(src->hw_frames_ctx);
256         if (!dst->hw_frames_ctx) {
257             ret = AVERROR(ENOMEM);
258             goto fail;
259         }
260     }
261
262     /* duplicate extended data */
263     if (src->extended_data != src->data) {
264         int ch = av_get_channel_layout_nb_channels(src->channel_layout);
265
266         if (!ch) {
267             ret = AVERROR(EINVAL);
268             goto fail;
269         }
270
271         dst->extended_data = av_malloc(sizeof(*dst->extended_data) * ch);
272         if (!dst->extended_data) {
273             ret = AVERROR(ENOMEM);
274             goto fail;
275         }
276         memcpy(dst->extended_data, src->extended_data, sizeof(*src->extended_data) * ch);
277     } else
278         dst->extended_data = dst->data;
279
280     memcpy(dst->data,     src->data,     sizeof(src->data));
281     memcpy(dst->linesize, src->linesize, sizeof(src->linesize));
282
283     return 0;
284
285 fail:
286     av_frame_unref(dst);
287     return ret;
288 }
289
290 AVFrame *av_frame_clone(const AVFrame *src)
291 {
292     AVFrame *ret = av_frame_alloc();
293
294     if (!ret)
295         return NULL;
296
297     if (av_frame_ref(ret, src) < 0)
298         av_frame_free(&ret);
299
300     return ret;
301 }
302
303 void av_frame_unref(AVFrame *frame)
304 {
305     int i;
306
307     wipe_side_data(frame);
308
309     for (i = 0; i < FF_ARRAY_ELEMS(frame->buf); i++)
310         av_buffer_unref(&frame->buf[i]);
311     for (i = 0; i < frame->nb_extended_buf; i++)
312         av_buffer_unref(&frame->extended_buf[i]);
313     av_freep(&frame->extended_buf);
314
315     av_buffer_unref(&frame->hw_frames_ctx);
316
317     get_frame_defaults(frame);
318 }
319
320 void av_frame_move_ref(AVFrame *dst, AVFrame *src)
321 {
322     *dst = *src;
323     if (src->extended_data == src->data)
324         dst->extended_data = dst->data;
325     memset(src, 0, sizeof(*src));
326     get_frame_defaults(src);
327 }
328
329 int av_frame_is_writable(AVFrame *frame)
330 {
331     int i, ret = 1;
332
333     /* assume non-refcounted frames are not writable */
334     if (!frame->buf[0])
335         return 0;
336
337     for (i = 0; i < FF_ARRAY_ELEMS(frame->buf) && frame->buf[i]; i++)
338         ret &= !!av_buffer_is_writable(frame->buf[i]);
339     for (i = 0; i < frame->nb_extended_buf; i++)
340         ret &= !!av_buffer_is_writable(frame->extended_buf[i]);
341
342     return ret;
343 }
344
345 int av_frame_make_writable(AVFrame *frame)
346 {
347     AVFrame tmp;
348     int ret;
349
350     if (!frame->buf[0])
351         return AVERROR(EINVAL);
352
353     if (av_frame_is_writable(frame))
354         return 0;
355
356     memset(&tmp, 0, sizeof(tmp));
357     tmp.format         = frame->format;
358     tmp.width          = frame->width;
359     tmp.height         = frame->height;
360     tmp.channel_layout = frame->channel_layout;
361     tmp.nb_samples     = frame->nb_samples;
362     ret = av_frame_get_buffer(&tmp, 32);
363     if (ret < 0)
364         return ret;
365
366     ret = av_frame_copy(&tmp, frame);
367     if (ret < 0) {
368         av_frame_unref(&tmp);
369         return ret;
370     }
371
372     ret = av_frame_copy_props(&tmp, frame);
373     if (ret < 0) {
374         av_frame_unref(&tmp);
375         return ret;
376     }
377
378     av_frame_unref(frame);
379
380     *frame = tmp;
381     if (tmp.data == tmp.extended_data)
382         frame->extended_data = frame->data;
383
384     return 0;
385 }
386
387 int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
388 {
389     int i;
390
391     dst->key_frame              = src->key_frame;
392     dst->pict_type              = src->pict_type;
393     dst->sample_aspect_ratio    = src->sample_aspect_ratio;
394     dst->pts                    = src->pts;
395     dst->repeat_pict            = src->repeat_pict;
396     dst->interlaced_frame       = src->interlaced_frame;
397     dst->top_field_first        = src->top_field_first;
398     dst->palette_has_changed    = src->palette_has_changed;
399     dst->sample_rate            = src->sample_rate;
400     dst->opaque                 = src->opaque;
401     dst->pkt_pts                = src->pkt_pts;
402     dst->pkt_dts                = src->pkt_dts;
403     dst->reordered_opaque       = src->reordered_opaque;
404     dst->quality                = src->quality;
405     dst->coded_picture_number   = src->coded_picture_number;
406     dst->display_picture_number = src->display_picture_number;
407     dst->flags                  = src->flags;
408     dst->color_primaries        = src->color_primaries;
409     dst->color_trc              = src->color_trc;
410     dst->colorspace             = src->colorspace;
411     dst->color_range            = src->color_range;
412     dst->chroma_location        = src->chroma_location;
413
414 #if FF_API_ERROR_FRAME
415 FF_DISABLE_DEPRECATION_WARNINGS
416     memcpy(dst->error, src->error, sizeof(dst->error));
417 FF_ENABLE_DEPRECATION_WARNINGS
418 #endif
419
420     for (i = 0; i < src->nb_side_data; i++) {
421         const AVFrameSideData *sd_src = src->side_data[i];
422         AVFrameSideData *sd_dst = av_frame_new_side_data(dst, sd_src->type,
423                                                          sd_src->size);
424         if (!sd_dst) {
425             wipe_side_data(dst);
426             return AVERROR(ENOMEM);
427         }
428         memcpy(sd_dst->data, sd_src->data, sd_src->size);
429         av_dict_copy(&sd_dst->metadata, sd_src->metadata, 0);
430     }
431
432     return 0;
433 }
434
435 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane)
436 {
437     uint8_t *data;
438     int planes, i;
439
440     if (frame->nb_samples) {
441         int channels = av_get_channel_layout_nb_channels(frame->channel_layout);
442         if (!channels)
443             return NULL;
444         planes = av_sample_fmt_is_planar(frame->format) ? channels : 1;
445     } else
446         planes = 4;
447
448     if (plane < 0 || plane >= planes || !frame->extended_data[plane])
449         return NULL;
450     data = frame->extended_data[plane];
451
452     for (i = 0; i < FF_ARRAY_ELEMS(frame->buf) && frame->buf[i]; i++) {
453         AVBufferRef *buf = frame->buf[i];
454         if (data >= buf->data && data < buf->data + buf->size)
455             return buf;
456     }
457     for (i = 0; i < frame->nb_extended_buf; i++) {
458         AVBufferRef *buf = frame->extended_buf[i];
459         if (data >= buf->data && data < buf->data + buf->size)
460             return buf;
461     }
462     return NULL;
463 }
464
465 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
466                                         enum AVFrameSideDataType type,
467                                         int size)
468 {
469     AVFrameSideData *ret, **tmp;
470
471     if (frame->nb_side_data > INT_MAX / sizeof(*frame->side_data) - 1)
472         return NULL;
473
474     tmp = av_realloc(frame->side_data,
475                      (frame->nb_side_data + 1) * sizeof(*frame->side_data));
476     if (!tmp)
477         return NULL;
478     frame->side_data = tmp;
479
480     ret = av_mallocz(sizeof(*ret));
481     if (!ret)
482         return NULL;
483
484     ret->data = av_malloc(size);
485     if (!ret->data) {
486         av_freep(&ret);
487         return NULL;
488     }
489
490     ret->size = size;
491     ret->type = type;
492
493     frame->side_data[frame->nb_side_data++] = ret;
494
495     return ret;
496 }
497
498 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
499                                         enum AVFrameSideDataType type)
500 {
501     int i;
502
503     for (i = 0; i < frame->nb_side_data; i++) {
504         if (frame->side_data[i]->type == type)
505             return frame->side_data[i];
506     }
507     return NULL;
508 }
509
510 static int frame_copy_video(AVFrame *dst, const AVFrame *src)
511 {
512     const uint8_t *src_data[4];
513     int i, planes;
514
515     if (dst->width  != src->width ||
516         dst->height != src->height)
517         return AVERROR(EINVAL);
518
519     planes = av_pix_fmt_count_planes(dst->format);
520     for (i = 0; i < planes; i++)
521         if (!dst->data[i] || !src->data[i])
522             return AVERROR(EINVAL);
523
524     memcpy(src_data, src->data, sizeof(src_data));
525     av_image_copy(dst->data, dst->linesize,
526                   src_data, src->linesize,
527                   dst->format, dst->width, dst->height);
528
529     return 0;
530 }
531
532 static int frame_copy_audio(AVFrame *dst, const AVFrame *src)
533 {
534     int planar   = av_sample_fmt_is_planar(dst->format);
535     int channels = av_get_channel_layout_nb_channels(dst->channel_layout);
536     int planes   = planar ? channels : 1;
537     int i;
538
539     if (dst->nb_samples     != src->nb_samples ||
540         dst->channel_layout != src->channel_layout)
541         return AVERROR(EINVAL);
542
543     for (i = 0; i < planes; i++)
544         if (!dst->extended_data[i] || !src->extended_data[i])
545             return AVERROR(EINVAL);
546
547     av_samples_copy(dst->extended_data, src->extended_data, 0, 0,
548                     dst->nb_samples, channels, dst->format);
549
550     return 0;
551 }
552
553 int av_frame_copy(AVFrame *dst, const AVFrame *src)
554 {
555     if (dst->format != src->format || dst->format < 0)
556         return AVERROR(EINVAL);
557
558     if (dst->width > 0 && dst->height > 0)
559         return frame_copy_video(dst, src);
560     else if (dst->nb_samples > 0 && dst->channel_layout)
561         return frame_copy_audio(dst, src);
562
563     return AVERROR(EINVAL);
564 }
565
566 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type)
567 {
568     int i;
569
570     for (i = 0; i < frame->nb_side_data; i++) {
571         AVFrameSideData *sd = frame->side_data[i];
572         if (sd->type == type) {
573             free_side_data(&frame->side_data[i]);
574             frame->side_data[i] = frame->side_data[frame->nb_side_data - 1];
575             frame->nb_side_data--;
576         }
577     }
578 }