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