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