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