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