avframe: add codec-independent stereoscopic metadata
[ffmpeg.git] / libavutil / frame.h
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 #ifndef AVUTIL_FRAME_H
21 #define AVUTIL_FRAME_H
22
23 #include <stdint.h>
24
25 #include "libavcodec/version.h"
26
27 #include "avutil.h"
28 #include "buffer.h"
29 #include "dict.h"
30 #include "rational.h"
31 #include "samplefmt.h"
32
33 enum AVFrameSideDataType {
34     /**
35      * The data is the AVPanScan struct defined in libavcodec.
36      */
37     AV_FRAME_DATA_PANSCAN,
38     /**
39      * ATSC A53 Part 4 Closed Captions.
40      * A53 CC bitstream is stored as uint8_t in AVFrameSideData.data.
41      * The number of bytes of CC data is AVFrameSideData.size.
42      */
43     AV_FRAME_DATA_A53_CC,
44     /**
45      * Stereoscopic 3d metadata.
46      * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
47      */
48     AV_FRAME_DATA_STEREO3D,
49 };
50
51 typedef struct AVFrameSideData {
52     enum AVFrameSideDataType type;
53     uint8_t *data;
54     int      size;
55     AVDictionary *metadata;
56 } AVFrameSideData;
57
58 /**
59  * This structure describes decoded (raw) audio or video data.
60  *
61  * AVFrame must be allocated using av_frame_alloc(). Not that this only
62  * allocates the AVFrame itself, the buffers for the data must be managed
63  * through other means (see below).
64  * AVFrame must be freed with av_frame_free().
65  *
66  * AVFrame is typically allocated once and then reused multiple times to hold
67  * different data (e.g. a single AVFrame to hold frames received from a
68  * decoder). In such a case, av_frame_unref() will free any references held by
69  * the frame and reset it to its original clean state before it
70  * is reused again.
71  *
72  * The data described by an AVFrame is usually reference counted through the
73  * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
74  * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
75  * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
76  * every single data plane must be contained in one of the buffers in
77  * AVFrame.buf or AVFrame.extended_buf.
78  * There may be a single buffer for all the data, or one separate buffer for
79  * each plane, or anything in between.
80  *
81  * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
82  * to the end with a minor bump.
83  */
84 typedef struct AVFrame {
85 #define AV_NUM_DATA_POINTERS 8
86     /**
87      * pointer to the picture/channel planes.
88      * This might be different from the first allocated byte
89      */
90     uint8_t *data[AV_NUM_DATA_POINTERS];
91
92     /**
93      * For video, size in bytes of each picture line.
94      * For audio, size in bytes of each plane.
95      *
96      * For audio, only linesize[0] may be set. For planar audio, each channel
97      * plane must be the same size.
98      *
99      * @note The linesize may be larger than the size of usable data -- there
100      * may be extra padding present for performance reasons.
101      */
102     int linesize[AV_NUM_DATA_POINTERS];
103
104     /**
105      * pointers to the data planes/channels.
106      *
107      * For video, this should simply point to data[].
108      *
109      * For planar audio, each channel has a separate data pointer, and
110      * linesize[0] contains the size of each channel buffer.
111      * For packed audio, there is just one data pointer, and linesize[0]
112      * contains the total size of the buffer for all channels.
113      *
114      * Note: Both data and extended_data should always be set in a valid frame,
115      * but for planar audio with more channels that can fit in data,
116      * extended_data must be used in order to access all channels.
117      */
118     uint8_t **extended_data;
119
120     /**
121      * width and height of the video frame
122      */
123     int width, height;
124
125     /**
126      * number of audio samples (per channel) described by this frame
127      */
128     int nb_samples;
129
130     /**
131      * format of the frame, -1 if unknown or unset
132      * Values correspond to enum AVPixelFormat for video frames,
133      * enum AVSampleFormat for audio)
134      */
135     int format;
136
137     /**
138      * 1 -> keyframe, 0-> not
139      */
140     int key_frame;
141
142     /**
143      * Picture type of the frame.
144      */
145     enum AVPictureType pict_type;
146
147 #if FF_API_AVFRAME_LAVC
148     attribute_deprecated
149     uint8_t *base[AV_NUM_DATA_POINTERS];
150 #endif
151
152     /**
153      * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
154      */
155     AVRational sample_aspect_ratio;
156
157     /**
158      * Presentation timestamp in time_base units (time when frame should be shown to user).
159      */
160     int64_t pts;
161
162     /**
163      * PTS copied from the AVPacket that was decoded to produce this frame.
164      */
165     int64_t pkt_pts;
166
167     /**
168      * DTS copied from the AVPacket that triggered returning this frame.
169      */
170     int64_t pkt_dts;
171
172     /**
173      * picture number in bitstream order
174      */
175     int coded_picture_number;
176     /**
177      * picture number in display order
178      */
179     int display_picture_number;
180
181     /**
182      * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
183      */
184     int quality;
185
186 #if FF_API_AVFRAME_LAVC
187     attribute_deprecated
188     int reference;
189
190     /**
191      * QP table
192      */
193     attribute_deprecated
194     int8_t *qscale_table;
195     /**
196      * QP store stride
197      */
198     attribute_deprecated
199     int qstride;
200
201     attribute_deprecated
202     int qscale_type;
203
204     /**
205      * mbskip_table[mb]>=1 if MB didn't change
206      * stride= mb_width = (width+15)>>4
207      */
208     attribute_deprecated
209     uint8_t *mbskip_table;
210
211     /**
212      * motion vector table
213      * @code
214      * example:
215      * int mv_sample_log2= 4 - motion_subsample_log2;
216      * int mb_width= (width+15)>>4;
217      * int mv_stride= (mb_width << mv_sample_log2) + 1;
218      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
219      * @endcode
220      */
221     attribute_deprecated
222     int16_t (*motion_val[2])[2];
223
224     /**
225      * macroblock type table
226      * mb_type_base + mb_width + 2
227      */
228     attribute_deprecated
229     uint32_t *mb_type;
230
231     /**
232      * DCT coefficients
233      */
234     attribute_deprecated
235     short *dct_coeff;
236
237     /**
238      * motion reference frame index
239      * the order in which these are stored can depend on the codec.
240      */
241     attribute_deprecated
242     int8_t *ref_index[2];
243 #endif
244
245     /**
246      * for some private data of the user
247      */
248     void *opaque;
249
250     /**
251      * error
252      */
253     uint64_t error[AV_NUM_DATA_POINTERS];
254
255 #if FF_API_AVFRAME_LAVC
256     attribute_deprecated
257     int type;
258 #endif
259
260     /**
261      * When decoding, this signals how much the picture must be delayed.
262      * extra_delay = repeat_pict / (2*fps)
263      */
264     int repeat_pict;
265
266     /**
267      * The content of the picture is interlaced.
268      */
269     int interlaced_frame;
270
271     /**
272      * If the content is interlaced, is top field displayed first.
273      */
274     int top_field_first;
275
276     /**
277      * Tell user application that palette has changed from previous frame.
278      */
279     int palette_has_changed;
280
281 #if FF_API_AVFRAME_LAVC
282     attribute_deprecated
283     int buffer_hints;
284
285     /**
286      * Pan scan.
287      */
288     attribute_deprecated
289     struct AVPanScan *pan_scan;
290 #endif
291
292     /**
293      * reordered opaque 64bit (generally an integer or a double precision float
294      * PTS but can be anything).
295      * The user sets AVCodecContext.reordered_opaque to represent the input at
296      * that time,
297      * the decoder reorders values as needed and sets AVFrame.reordered_opaque
298      * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
299      * @deprecated in favor of pkt_pts
300      */
301     int64_t reordered_opaque;
302
303 #if FF_API_AVFRAME_LAVC
304     /**
305      * @deprecated this field is unused
306      */
307     attribute_deprecated void *hwaccel_picture_private;
308
309     attribute_deprecated
310     struct AVCodecContext *owner;
311     attribute_deprecated
312     void *thread_opaque;
313
314     /**
315      * log2 of the size of the block which a single vector in motion_val represents:
316      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
317      */
318     attribute_deprecated
319     uint8_t motion_subsample_log2;
320 #endif
321
322     /**
323      * Sample rate of the audio data.
324      */
325     int sample_rate;
326
327     /**
328      * Channel layout of the audio data.
329      */
330     uint64_t channel_layout;
331
332     /**
333      * AVBuffer references backing the data for this frame. If all elements of
334      * this array are NULL, then this frame is not reference counted.
335      *
336      * There may be at most one AVBuffer per data plane, so for video this array
337      * always contains all the references. For planar audio with more than
338      * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
339      * this array. Then the extra AVBufferRef pointers are stored in the
340      * extended_buf array.
341      */
342     AVBufferRef *buf[AV_NUM_DATA_POINTERS];
343
344     /**
345      * For planar audio which requires more than AV_NUM_DATA_POINTERS
346      * AVBufferRef pointers, this array will hold all the references which
347      * cannot fit into AVFrame.buf.
348      *
349      * Note that this is different from AVFrame.extended_data, which always
350      * contains all the pointers. This array only contains the extra pointers,
351      * which cannot fit into AVFrame.buf.
352      *
353      * This array is always allocated using av_malloc() by whoever constructs
354      * the frame. It is freed in av_frame_unref().
355      */
356     AVBufferRef **extended_buf;
357     /**
358      * Number of elements in extended_buf.
359      */
360     int        nb_extended_buf;
361
362     AVFrameSideData **side_data;
363     int            nb_side_data;
364
365 /**
366  * The frame data may be corrupted, e.g. due to decoding errors.
367  */
368 #define AV_FRAME_FLAG_CORRUPT       (1 << 0)
369
370     /**
371      * Frame flags, a combination of AV_FRAME_FLAG_*
372      */
373     int flags;
374 } AVFrame;
375
376 /**
377  * Allocate an AVFrame and set its fields to default values.  The resulting
378  * struct must be freed using av_frame_free().
379  *
380  * @return An AVFrame filled with default values or NULL on failure.
381  *
382  * @note this only allocates the AVFrame itself, not the data buffers. Those
383  * must be allocated through other means, e.g. with av_frame_get_buffer() or
384  * manually.
385  */
386 AVFrame *av_frame_alloc(void);
387
388 /**
389  * Free the frame and any dynamically allocated objects in it,
390  * e.g. extended_data. If the frame is reference counted, it will be
391  * unreferenced first.
392  *
393  * @param frame frame to be freed. The pointer will be set to NULL.
394  */
395 void av_frame_free(AVFrame **frame);
396
397 /**
398  * Setup a new reference to the data described by an given frame.
399  *
400  * Copy frame properties from src to dst and create a new reference for each
401  * AVBufferRef from src.
402  *
403  * If src is not reference counted, new buffers are allocated and the data is
404  * copied.
405  *
406  * @return 0 on success, a negative AVERROR on error
407  */
408 int av_frame_ref(AVFrame *dst, const AVFrame *src);
409
410 /**
411  * Create a new frame that references the same data as src.
412  *
413  * This is a shortcut for av_frame_alloc()+av_frame_ref().
414  *
415  * @return newly created AVFrame on success, NULL on error.
416  */
417 AVFrame *av_frame_clone(const AVFrame *src);
418
419 /**
420  * Unreference all the buffers referenced by frame and reset the frame fields.
421  */
422 void av_frame_unref(AVFrame *frame);
423
424 /**
425  * Move everythnig contained in src to dst and reset src.
426  */
427 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
428
429 /**
430  * Allocate new buffer(s) for audio or video data.
431  *
432  * The following fields must be set on frame before calling this function:
433  * - format (pixel format for video, sample format for audio)
434  * - width and height for video
435  * - nb_samples and channel_layout for audio
436  *
437  * This function will fill AVFrame.data and AVFrame.buf arrays and, if
438  * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
439  * For planar formats, one buffer will be allocated for each plane.
440  *
441  * @param frame frame in which to store the new buffers.
442  * @param align required buffer size alignment
443  *
444  * @return 0 on success, a negative AVERROR on error.
445  */
446 int av_frame_get_buffer(AVFrame *frame, int align);
447
448 /**
449  * Check if the frame data is writable.
450  *
451  * @return A positive value if the frame data is writable (which is true if and
452  * only if each of the underlying buffers has only one reference, namely the one
453  * stored in this frame). Return 0 otherwise.
454  *
455  * If 1 is returned the answer is valid until av_buffer_ref() is called on any
456  * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
457  *
458  * @see av_frame_make_writable(), av_buffer_is_writable()
459  */
460 int av_frame_is_writable(AVFrame *frame);
461
462 /**
463  * Ensure that the frame data is writable, avoiding data copy if possible.
464  *
465  * Do nothing if the frame is writable, allocate new buffers and copy the data
466  * if it is not.
467  *
468  * @return 0 on success, a negative AVERROR on error.
469  *
470  * @see av_frame_is_writable(), av_buffer_is_writable(),
471  * av_buffer_make_writable()
472  */
473 int av_frame_make_writable(AVFrame *frame);
474
475 /**
476  * Copy only "metadata" fields from src to dst.
477  *
478  * Metadata for the purpose of this function are those fields that do not affect
479  * the data layout in the buffers.  E.g. pts, sample rate (for audio) or sample
480  * aspect ratio (for video), but not width/height or channel layout.
481  * Side data is also copied.
482  */
483 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
484
485 /**
486  * Get the buffer reference a given data plane is stored in.
487  *
488  * @param plane index of the data plane of interest in frame->extended_data.
489  *
490  * @return the buffer reference that contains the plane or NULL if the input
491  * frame is not valid.
492  */
493 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
494
495 /**
496  * Add a new side data to a frame.
497  *
498  * @param frame a frame to which the side data should be added
499  * @param type type of the added side data
500  * @param size size of the side data
501  *
502  * @return newly added side data on success, NULL on error
503  */
504 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
505                                         enum AVFrameSideDataType type,
506                                         int size);
507
508 /**
509  * @return a pointer to the side data of a given type on success, NULL if there
510  * is no side data with such type in this frame.
511  */
512 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
513                                         enum AVFrameSideDataType type);
514
515 #endif /* AVUTIL_FRAME_H */