lavu: improve documentation of some AVFrame functions
[libav.git] / libavutil / frame.h
CommitLineData
7ecc2d40 1/*
7ecc2d40
AK
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
ff23c4e4
LB
19/**
20 * @file
21 * @ingroup lavu_frame
22 * reference-counted frame API
23 */
24
7ecc2d40
AK
25#ifndef AVUTIL_FRAME_H
26#define AVUTIL_FRAME_H
27
28#include <stdint.h>
29
7ecc2d40
AK
30#include "avutil.h"
31#include "buffer.h"
77b2cd7b 32#include "dict.h"
7ecc2d40
AK
33#include "rational.h"
34#include "samplefmt.h"
8c02adc6 35#include "pixfmt.h"
02b9fafc 36#include "version.h"
7ecc2d40 37
ff23c4e4
LB
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
77b2cd7b
AK
47enum AVFrameSideDataType {
48 /**
49 * The data is the AVPanScan struct defined in libavcodec.
50 */
51 AV_FRAME_DATA_PANSCAN,
1eaac1d6
JS
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,
7e244c68
VG
58 /**
59 * Stereoscopic 3d metadata.
60 * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
61 */
62 AV_FRAME_DATA_STEREO3D,
5b4797a2
TW
63 /**
64 * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
65 */
66 AV_FRAME_DATA_MATRIXENCODING,
c98f3169
TW
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,
5a7e35dd
AK
72 /**
73 * ReplayGain information in the form of the AVReplayGain struct.
74 */
75 AV_FRAME_DATA_REPLAYGAIN,
bddd8cbf
VG
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,
1ef9e837
KK
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,
728685f3
AK
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,
1ef9e837
KK
95};
96
97enum AVActiveFormatDescription {
98 AV_AFD_SAME = 8,
99 AV_AFD_4_3 = 9,
100 AV_AFD_16_9 = 10,
101 AV_AFD_14_9 = 11,
102 AV_AFD_4_3_SP_14_9 = 13,
103 AV_AFD_16_9_SP_14_9 = 14,
104 AV_AFD_SP_4_3 = 15,
77b2cd7b
AK
105};
106
107typedef struct AVFrameSideData {
108 enum AVFrameSideDataType type;
109 uint8_t *data;
110 int size;
111 AVDictionary *metadata;
112} AVFrameSideData;
7ecc2d40
AK
113
114/**
115 * This structure describes decoded (raw) audio or video data.
116 *
10d98248 117 * AVFrame must be allocated using av_frame_alloc(). Note that this only
7ecc2d40
AK
118 * allocates the AVFrame itself, the buffers for the data must be managed
119 * through other means (see below).
120 * AVFrame must be freed with av_frame_free().
121 *
122 * AVFrame is typically allocated once and then reused multiple times to hold
123 * different data (e.g. a single AVFrame to hold frames received from a
124 * decoder). In such a case, av_frame_unref() will free any references held by
125 * the frame and reset it to its original clean state before it
126 * is reused again.
127 *
128 * The data described by an AVFrame is usually reference counted through the
129 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
130 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
131 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
132 * every single data plane must be contained in one of the buffers in
133 * AVFrame.buf or AVFrame.extended_buf.
134 * There may be a single buffer for all the data, or one separate buffer for
135 * each plane, or anything in between.
136 *
137 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
138 * to the end with a minor bump.
139 */
140typedef struct AVFrame {
141#define AV_NUM_DATA_POINTERS 8
142 /**
143 * pointer to the picture/channel planes.
144 * This might be different from the first allocated byte
145 */
146 uint8_t *data[AV_NUM_DATA_POINTERS];
147
148 /**
149 * For video, size in bytes of each picture line.
150 * For audio, size in bytes of each plane.
151 *
152 * For audio, only linesize[0] may be set. For planar audio, each channel
153 * plane must be the same size.
38e15df1
AK
154 *
155 * @note The linesize may be larger than the size of usable data -- there
156 * may be extra padding present for performance reasons.
7ecc2d40
AK
157 */
158 int linesize[AV_NUM_DATA_POINTERS];
159
160 /**
161 * pointers to the data planes/channels.
162 *
163 * For video, this should simply point to data[].
164 *
165 * For planar audio, each channel has a separate data pointer, and
166 * linesize[0] contains the size of each channel buffer.
167 * For packed audio, there is just one data pointer, and linesize[0]
168 * contains the total size of the buffer for all channels.
169 *
170 * Note: Both data and extended_data should always be set in a valid frame,
171 * but for planar audio with more channels that can fit in data,
172 * extended_data must be used in order to access all channels.
173 */
174 uint8_t **extended_data;
175
176 /**
177 * width and height of the video frame
178 */
179 int width, height;
180
181 /**
182 * number of audio samples (per channel) described by this frame
183 */
184 int nb_samples;
185
186 /**
187 * format of the frame, -1 if unknown or unset
188 * Values correspond to enum AVPixelFormat for video frames,
189 * enum AVSampleFormat for audio)
190 */
191 int format;
192
193 /**
194 * 1 -> keyframe, 0-> not
195 */
196 int key_frame;
197
198 /**
199 * Picture type of the frame.
200 */
201 enum AVPictureType pict_type;
202
7ecc2d40
AK
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
7ecc2d40
AK
237 /**
238 * for some private data of the user
239 */
240 void *opaque;
241
1aa24df7 242#if FF_API_ERROR_FRAME
7ecc2d40 243 /**
1aa24df7 244 * @deprecated unused
7ecc2d40 245 */
1aa24df7 246 attribute_deprecated
7ecc2d40 247 uint64_t error[AV_NUM_DATA_POINTERS];
1aa24df7 248#endif
7ecc2d40 249
7ecc2d40
AK
250 /**
251 * When decoding, this signals how much the picture must be delayed.
252 * extra_delay = repeat_pict / (2*fps)
253 */
254 int repeat_pict;
255
256 /**
257 * The content of the picture is interlaced.
258 */
259 int interlaced_frame;
260
261 /**
262 * If the content is interlaced, is top field displayed first.
263 */
264 int top_field_first;
265
266 /**
267 * Tell user application that palette has changed from previous frame.
268 */
269 int palette_has_changed;
270
7ecc2d40
AK
271 /**
272 * reordered opaque 64bit (generally an integer or a double precision float
273 * PTS but can be anything).
274 * The user sets AVCodecContext.reordered_opaque to represent the input at
275 * that time,
276 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
277 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
278 * @deprecated in favor of pkt_pts
279 */
280 int64_t reordered_opaque;
281
7ecc2d40
AK
282 /**
283 * Sample rate of the audio data.
284 */
285 int sample_rate;
286
287 /**
288 * Channel layout of the audio data.
289 */
290 uint64_t channel_layout;
291
292 /**
293 * AVBuffer references backing the data for this frame. If all elements of
0232ba62
AK
294 * this array are NULL, then this frame is not reference counted. This array
295 * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
296 * also be non-NULL for all j < i.
7ecc2d40
AK
297 *
298 * There may be at most one AVBuffer per data plane, so for video this array
299 * always contains all the references. For planar audio with more than
300 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
301 * this array. Then the extra AVBufferRef pointers are stored in the
302 * extended_buf array.
303 */
304 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
305
306 /**
307 * For planar audio which requires more than AV_NUM_DATA_POINTERS
308 * AVBufferRef pointers, this array will hold all the references which
309 * cannot fit into AVFrame.buf.
310 *
311 * Note that this is different from AVFrame.extended_data, which always
312 * contains all the pointers. This array only contains the extra pointers,
313 * which cannot fit into AVFrame.buf.
314 *
315 * This array is always allocated using av_malloc() by whoever constructs
316 * the frame. It is freed in av_frame_unref().
317 */
318 AVBufferRef **extended_buf;
319 /**
320 * Number of elements in extended_buf.
321 */
322 int nb_extended_buf;
77b2cd7b
AK
323
324 AVFrameSideData **side_data;
325 int nb_side_data;
28096e0a
JS
326
327/**
045654f4
LB
328 * @defgroup lavu_frame_flags AV_FRAME_FLAGS
329 * Flags describing additional frame properties.
330 *
331 * @{
332 */
333
334/**
28096e0a
JS
335 * The frame data may be corrupted, e.g. due to decoding errors.
336 */
337#define AV_FRAME_FLAG_CORRUPT (1 << 0)
045654f4
LB
338/**
339 * @}
340 */
28096e0a
JS
341
342 /**
045654f4 343 * Frame flags, a combination of @ref lavu_frame_flags
28096e0a
JS
344 */
345 int flags;
8c02adc6 346
8c02adc6 347 enum AVColorRange color_range;
348
349 enum AVColorPrimaries color_primaries;
350
351 enum AVColorTransferCharacteristic color_trc;
352
353 enum AVColorSpace colorspace;
354
355 enum AVChromaLocation chroma_location;
89923e41
AK
356
357 /**
358 * For hwaccel-format frames, this should be a reference to the
359 * AVHWFramesContext describing the frame.
360 */
361 AVBufferRef *hw_frames_ctx;
7ecc2d40
AK
362} AVFrame;
363
364/**
365 * Allocate an AVFrame and set its fields to default values. The resulting
366 * struct must be freed using av_frame_free().
367 *
368 * @return An AVFrame filled with default values or NULL on failure.
369 *
370 * @note this only allocates the AVFrame itself, not the data buffers. Those
371 * must be allocated through other means, e.g. with av_frame_get_buffer() or
372 * manually.
373 */
374AVFrame *av_frame_alloc(void);
375
376/**
377 * Free the frame and any dynamically allocated objects in it,
378 * e.g. extended_data. If the frame is reference counted, it will be
379 * unreferenced first.
380 *
381 * @param frame frame to be freed. The pointer will be set to NULL.
382 */
383void av_frame_free(AVFrame **frame);
384
385/**
a18ef7a7 386 * Set up a new reference to the data described by the source frame.
7ecc2d40
AK
387 *
388 * Copy frame properties from src to dst and create a new reference for each
389 * AVBufferRef from src.
390 *
391 * If src is not reference counted, new buffers are allocated and the data is
392 * copied.
393 *
7a6cf277 394 * @warning: dst MUST have been either unreferenced with av_frame_unref(dst),
395 * or newly allocated with av_frame_alloc() before calling this
396 * function, or undefined behavior will occur.
397 *
7ecc2d40
AK
398 * @return 0 on success, a negative AVERROR on error
399 */
529a9893 400int av_frame_ref(AVFrame *dst, const AVFrame *src);
7ecc2d40
AK
401
402/**
403 * Create a new frame that references the same data as src.
404 *
405 * This is a shortcut for av_frame_alloc()+av_frame_ref().
406 *
407 * @return newly created AVFrame on success, NULL on error.
408 */
529a9893 409AVFrame *av_frame_clone(const AVFrame *src);
7ecc2d40
AK
410
411/**
412 * Unreference all the buffers referenced by frame and reset the frame fields.
413 */
414void av_frame_unref(AVFrame *frame);
415
416/**
7a6cf277 417 * Move everything contained in src to dst and reset src.
418 *
419 * @warning: dst is not unreferenced, but directly overwritten without reading
420 * or deallocating its contents. Call av_frame_unref(dst) manually
421 * before calling this function to ensure that no memory is leaked.
7ecc2d40
AK
422 */
423void av_frame_move_ref(AVFrame *dst, AVFrame *src);
424
425/**
426 * Allocate new buffer(s) for audio or video data.
427 *
428 * The following fields must be set on frame before calling this function:
429 * - format (pixel format for video, sample format for audio)
430 * - width and height for video
431 * - nb_samples and channel_layout for audio
432 *
433 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
434 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
435 * For planar formats, one buffer will be allocated for each plane.
436 *
7a6cf277 437 * @warning: if frame already has been allocated, calling this function will
438 * leak memory. In addition, undefined behavior can occur in certain
439 * cases.
440 *
7ecc2d40
AK
441 * @param frame frame in which to store the new buffers.
442 * @param align required buffer size alignment
443 *
444 * @return 0 on success, a negative AVERROR on error.
445 */
446int av_frame_get_buffer(AVFrame *frame, int align);
447
448/**
449 * Check if the frame data is writable.
450 *
451 * @return A positive value if the frame data is writable (which is true if and
452 * only if each of the underlying buffers has only one reference, namely the one
453 * stored in this frame). Return 0 otherwise.
454 *
455 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
456 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
457 *
458 * @see av_frame_make_writable(), av_buffer_is_writable()
459 */
460int av_frame_is_writable(AVFrame *frame);
461
462/**
463 * Ensure that the frame data is writable, avoiding data copy if possible.
464 *
465 * Do nothing if the frame is writable, allocate new buffers and copy the data
466 * if it is not.
467 *
468 * @return 0 on success, a negative AVERROR on error.
469 *
470 * @see av_frame_is_writable(), av_buffer_is_writable(),
471 * av_buffer_make_writable()
472 */
473int av_frame_make_writable(AVFrame *frame);
474
475/**
1155fd02
AK
476 * Copy the frame data from src to dst.
477 *
478 * This function does not allocate anything, dst must be already initialized and
479 * allocated with the same parameters as src.
480 *
481 * This function only copies the frame data (i.e. the contents of the data /
482 * extended data arrays), not any other properties.
483 *
484 * @return >= 0 on success, a negative AVERROR on error.
485 */
486int av_frame_copy(AVFrame *dst, const AVFrame *src);
487
488/**
7ecc2d40
AK
489 * Copy only "metadata" fields from src to dst.
490 *
491 * Metadata for the purpose of this function are those fields that do not affect
492 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
493 * aspect ratio (for video), but not width/height or channel layout.
77b2cd7b 494 * Side data is also copied.
7ecc2d40
AK
495 */
496int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
497
498/**
499 * Get the buffer reference a given data plane is stored in.
500 *
501 * @param plane index of the data plane of interest in frame->extended_data.
502 *
503 * @return the buffer reference that contains the plane or NULL if the input
504 * frame is not valid.
505 */
506AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
507
77b2cd7b
AK
508/**
509 * Add a new side data to a frame.
510 *
511 * @param frame a frame to which the side data should be added
512 * @param type type of the added side data
513 * @param size size of the side data
514 *
515 * @return newly added side data on success, NULL on error
516 */
517AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
518 enum AVFrameSideDataType type,
519 int size);
520
521/**
522 * @return a pointer to the side data of a given type on success, NULL if there
523 * is no side data with such type in this frame.
524 */
3c8bff07 525AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
77b2cd7b
AK
526 enum AVFrameSideDataType type);
527
ff23c4e4 528/**
d161ae0a
AK
529 * If side data of the supplied type exists in the frame, free it and remove it
530 * from the frame.
531 */
532void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
533
534/**
ff23c4e4
LB
535 * @}
536 */
537
7ecc2d40 538#endif /* AVUTIL_FRAME_H */