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