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