lavu: Drop deprecated duplicated AVFrame/AVCodecContext parameters
[libav.git] / libavutil / frame.h
CommitLineData
7ecc2d40
AK
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
ff23c4e4
LB
20/**
21 * @file
22 * @ingroup lavu_frame
23 * reference-counted frame API
24 */
25
7ecc2d40
AK
26#ifndef AVUTIL_FRAME_H
27#define AVUTIL_FRAME_H
28
29#include <stdint.h>
30
7ecc2d40
AK
31#include "avutil.h"
32#include "buffer.h"
77b2cd7b 33#include "dict.h"
7ecc2d40
AK
34#include "rational.h"
35#include "samplefmt.h"
8c02adc6 36#include "pixfmt.h"
02b9fafc 37#include "version.h"
7ecc2d40 38
ff23c4e4
LB
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
77b2cd7b
AK
48enum AVFrameSideDataType {
49 /**
50 * The data is the AVPanScan struct defined in libavcodec.
51 */
52 AV_FRAME_DATA_PANSCAN,
1eaac1d6
JS
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,
7e244c68
VG
59 /**
60 * Stereoscopic 3d metadata.
61 * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
62 */
63 AV_FRAME_DATA_STEREO3D,
5b4797a2
TW
64 /**
65 * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
66 */
67 AV_FRAME_DATA_MATRIXENCODING,
c98f3169
TW
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,
5a7e35dd
AK
73 /**
74 * ReplayGain information in the form of the AVReplayGain struct.
75 */
76 AV_FRAME_DATA_REPLAYGAIN,
bddd8cbf
VG
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,
1ef9e837
KK
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,
728685f3
AK
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,
1ef9e837
KK
96};
97
98enum 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,
77b2cd7b
AK
106};
107
108typedef struct AVFrameSideData {
109 enum AVFrameSideDataType type;
110 uint8_t *data;
111 int size;
112 AVDictionary *metadata;
113} AVFrameSideData;
7ecc2d40
AK
114
115/**
116 * This structure describes decoded (raw) audio or video data.
117 *
10d98248 118 * AVFrame must be allocated using av_frame_alloc(). Note that this only
7ecc2d40
AK
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 */
141typedef 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.
38e15df1
AK
155 *
156 * @note The linesize may be larger than the size of usable data -- there
157 * may be extra padding present for performance reasons.
7ecc2d40
AK
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
7ecc2d40
AK
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
7ecc2d40
AK
238 /**
239 * for some private data of the user
240 */
241 void *opaque;
242
243 /**
244 * error
245 */
246 uint64_t error[AV_NUM_DATA_POINTERS];
247
7ecc2d40
AK
248 /**
249 * When decoding, this signals how much the picture must be delayed.
250 * extra_delay = repeat_pict / (2*fps)
251 */
252 int repeat_pict;
253
254 /**
255 * The content of the picture is interlaced.
256 */
257 int interlaced_frame;
258
259 /**
260 * If the content is interlaced, is top field displayed first.
261 */
262 int top_field_first;
263
264 /**
265 * Tell user application that palette has changed from previous frame.
266 */
267 int palette_has_changed;
268
7ecc2d40
AK
269 /**
270 * reordered opaque 64bit (generally an integer or a double precision float
271 * PTS but can be anything).
272 * The user sets AVCodecContext.reordered_opaque to represent the input at
273 * that time,
274 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
275 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
276 * @deprecated in favor of pkt_pts
277 */
278 int64_t reordered_opaque;
279
7ecc2d40
AK
280 /**
281 * Sample rate of the audio data.
282 */
283 int sample_rate;
284
285 /**
286 * Channel layout of the audio data.
287 */
288 uint64_t channel_layout;
289
290 /**
291 * AVBuffer references backing the data for this frame. If all elements of
0232ba62
AK
292 * this array are NULL, then this frame is not reference counted. This array
293 * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
294 * also be non-NULL for all j < i.
7ecc2d40
AK
295 *
296 * There may be at most one AVBuffer per data plane, so for video this array
297 * always contains all the references. For planar audio with more than
298 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
299 * this array. Then the extra AVBufferRef pointers are stored in the
300 * extended_buf array.
301 */
302 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
303
304 /**
305 * For planar audio which requires more than AV_NUM_DATA_POINTERS
306 * AVBufferRef pointers, this array will hold all the references which
307 * cannot fit into AVFrame.buf.
308 *
309 * Note that this is different from AVFrame.extended_data, which always
310 * contains all the pointers. This array only contains the extra pointers,
311 * which cannot fit into AVFrame.buf.
312 *
313 * This array is always allocated using av_malloc() by whoever constructs
314 * the frame. It is freed in av_frame_unref().
315 */
316 AVBufferRef **extended_buf;
317 /**
318 * Number of elements in extended_buf.
319 */
320 int nb_extended_buf;
77b2cd7b
AK
321
322 AVFrameSideData **side_data;
323 int nb_side_data;
28096e0a
JS
324
325/**
045654f4
LB
326 * @defgroup lavu_frame_flags AV_FRAME_FLAGS
327 * Flags describing additional frame properties.
328 *
329 * @{
330 */
331
332/**
28096e0a
JS
333 * The frame data may be corrupted, e.g. due to decoding errors.
334 */
335#define AV_FRAME_FLAG_CORRUPT (1 << 0)
045654f4
LB
336/**
337 * @}
338 */
28096e0a
JS
339
340 /**
045654f4 341 * Frame flags, a combination of @ref lavu_frame_flags
28096e0a
JS
342 */
343 int flags;
8c02adc6 344
8c02adc6 345 enum AVColorRange color_range;
346
347 enum AVColorPrimaries color_primaries;
348
349 enum AVColorTransferCharacteristic color_trc;
350
351 enum AVColorSpace colorspace;
352
353 enum AVChromaLocation chroma_location;
7ecc2d40
AK
354} AVFrame;
355
356/**
357 * Allocate an AVFrame and set its fields to default values. The resulting
358 * struct must be freed using av_frame_free().
359 *
360 * @return An AVFrame filled with default values or NULL on failure.
361 *
362 * @note this only allocates the AVFrame itself, not the data buffers. Those
363 * must be allocated through other means, e.g. with av_frame_get_buffer() or
364 * manually.
365 */
366AVFrame *av_frame_alloc(void);
367
368/**
369 * Free the frame and any dynamically allocated objects in it,
370 * e.g. extended_data. If the frame is reference counted, it will be
371 * unreferenced first.
372 *
373 * @param frame frame to be freed. The pointer will be set to NULL.
374 */
375void av_frame_free(AVFrame **frame);
376
377/**
a18ef7a7 378 * Set up a new reference to the data described by the source frame.
7ecc2d40
AK
379 *
380 * Copy frame properties from src to dst and create a new reference for each
381 * AVBufferRef from src.
382 *
383 * If src is not reference counted, new buffers are allocated and the data is
384 * copied.
385 *
386 * @return 0 on success, a negative AVERROR on error
387 */
529a9893 388int av_frame_ref(AVFrame *dst, const AVFrame *src);
7ecc2d40
AK
389
390/**
391 * Create a new frame that references the same data as src.
392 *
393 * This is a shortcut for av_frame_alloc()+av_frame_ref().
394 *
395 * @return newly created AVFrame on success, NULL on error.
396 */
529a9893 397AVFrame *av_frame_clone(const AVFrame *src);
7ecc2d40
AK
398
399/**
400 * Unreference all the buffers referenced by frame and reset the frame fields.
401 */
402void av_frame_unref(AVFrame *frame);
403
404/**
405 * Move everythnig contained in src to dst and reset src.
406 */
407void av_frame_move_ref(AVFrame *dst, AVFrame *src);
408
409/**
410 * Allocate new buffer(s) for audio or video data.
411 *
412 * The following fields must be set on frame before calling this function:
413 * - format (pixel format for video, sample format for audio)
414 * - width and height for video
415 * - nb_samples and channel_layout for audio
416 *
417 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
418 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
419 * For planar formats, one buffer will be allocated for each plane.
420 *
421 * @param frame frame in which to store the new buffers.
422 * @param align required buffer size alignment
423 *
424 * @return 0 on success, a negative AVERROR on error.
425 */
426int av_frame_get_buffer(AVFrame *frame, int align);
427
428/**
429 * Check if the frame data is writable.
430 *
431 * @return A positive value if the frame data is writable (which is true if and
432 * only if each of the underlying buffers has only one reference, namely the one
433 * stored in this frame). Return 0 otherwise.
434 *
435 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
436 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
437 *
438 * @see av_frame_make_writable(), av_buffer_is_writable()
439 */
440int av_frame_is_writable(AVFrame *frame);
441
442/**
443 * Ensure that the frame data is writable, avoiding data copy if possible.
444 *
445 * Do nothing if the frame is writable, allocate new buffers and copy the data
446 * if it is not.
447 *
448 * @return 0 on success, a negative AVERROR on error.
449 *
450 * @see av_frame_is_writable(), av_buffer_is_writable(),
451 * av_buffer_make_writable()
452 */
453int av_frame_make_writable(AVFrame *frame);
454
455/**
1155fd02
AK
456 * Copy the frame data from src to dst.
457 *
458 * This function does not allocate anything, dst must be already initialized and
459 * allocated with the same parameters as src.
460 *
461 * This function only copies the frame data (i.e. the contents of the data /
462 * extended data arrays), not any other properties.
463 *
464 * @return >= 0 on success, a negative AVERROR on error.
465 */
466int av_frame_copy(AVFrame *dst, const AVFrame *src);
467
468/**
7ecc2d40
AK
469 * Copy only "metadata" fields from src to dst.
470 *
471 * Metadata for the purpose of this function are those fields that do not affect
472 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
473 * aspect ratio (for video), but not width/height or channel layout.
77b2cd7b 474 * Side data is also copied.
7ecc2d40
AK
475 */
476int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
477
478/**
479 * Get the buffer reference a given data plane is stored in.
480 *
481 * @param plane index of the data plane of interest in frame->extended_data.
482 *
483 * @return the buffer reference that contains the plane or NULL if the input
484 * frame is not valid.
485 */
486AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
487
77b2cd7b
AK
488/**
489 * Add a new side data to a frame.
490 *
491 * @param frame a frame to which the side data should be added
492 * @param type type of the added side data
493 * @param size size of the side data
494 *
495 * @return newly added side data on success, NULL on error
496 */
497AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
498 enum AVFrameSideDataType type,
499 int size);
500
501/**
502 * @return a pointer to the side data of a given type on success, NULL if there
503 * is no side data with such type in this frame.
504 */
3c8bff07 505AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
77b2cd7b
AK
506 enum AVFrameSideDataType type);
507
ff23c4e4 508/**
d161ae0a
AK
509 * If side data of the supplied type exists in the frame, free it and remove it
510 * from the frame.
511 */
512void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
513
514/**
ff23c4e4
LB
515 * @}
516 */
517
7ecc2d40 518#endif /* AVUTIL_FRAME_H */