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