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