|
0
|
1 /*
|
|
|
2 *
|
|
|
3 * This file is part of FFmpeg.
|
|
|
4 *
|
|
|
5 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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 AVActiveFormatDescription enum.
|
|
|
88 */
|
|
|
89 AV_FRAME_DATA_AFD,
|
|
|
90 /**
|
|
|
91 * Motion vectors exported by some codecs (on demand through the export_mvs
|
|
|
92 * flag set in the libavcodec AVCodecContext flags2 option).
|
|
|
93 * The data is the AVMotionVector struct defined in
|
|
|
94 * libavutil/motion_vector.h.
|
|
|
95 */
|
|
|
96 AV_FRAME_DATA_MOTION_VECTORS,
|
|
|
97 /**
|
|
|
98 * Recommmends skipping the specified number of samples. This is exported
|
|
|
99 * only if the "skip_manual" AVOption is set in libavcodec.
|
|
|
100 * This has the same format as AV_PKT_DATA_SKIP_SAMPLES.
|
|
|
101 * @code
|
|
|
102 * u32le number of samples to skip from start of this packet
|
|
|
103 * u32le number of samples to skip from end of this packet
|
|
|
104 * u8 reason for start skip
|
|
|
105 * u8 reason for end skip (0=padding silence, 1=convergence)
|
|
|
106 * @endcode
|
|
|
107 */
|
|
|
108 AV_FRAME_DATA_SKIP_SAMPLES,
|
|
|
109 };
|
|
|
110
|
|
|
111 enum AVActiveFormatDescription {
|
|
|
112 AV_AFD_SAME = 8,
|
|
|
113 AV_AFD_4_3 = 9,
|
|
|
114 AV_AFD_16_9 = 10,
|
|
|
115 AV_AFD_14_9 = 11,
|
|
|
116 AV_AFD_4_3_SP_14_9 = 13,
|
|
|
117 AV_AFD_16_9_SP_14_9 = 14,
|
|
|
118 AV_AFD_SP_4_3 = 15,
|
|
|
119 };
|
|
|
120
|
|
|
121 typedef struct AVFrameSideData {
|
|
|
122 enum AVFrameSideDataType type;
|
|
|
123 uint8_t *data;
|
|
|
124 int size;
|
|
|
125 AVDictionary *metadata;
|
|
|
126 } AVFrameSideData;
|
|
|
127
|
|
|
128 /**
|
|
|
129 * This structure describes decoded (raw) audio or video data.
|
|
|
130 *
|
|
|
131 * AVFrame must be allocated using av_frame_alloc(). Note that this only
|
|
|
132 * allocates the AVFrame itself, the buffers for the data must be managed
|
|
|
133 * through other means (see below).
|
|
|
134 * AVFrame must be freed with av_frame_free().
|
|
|
135 *
|
|
|
136 * AVFrame is typically allocated once and then reused multiple times to hold
|
|
|
137 * different data (e.g. a single AVFrame to hold frames received from a
|
|
|
138 * decoder). In such a case, av_frame_unref() will free any references held by
|
|
|
139 * the frame and reset it to its original clean state before it
|
|
|
140 * is reused again.
|
|
|
141 *
|
|
|
142 * The data described by an AVFrame is usually reference counted through the
|
|
|
143 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
|
|
|
144 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
|
|
|
145 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
|
|
|
146 * every single data plane must be contained in one of the buffers in
|
|
|
147 * AVFrame.buf or AVFrame.extended_buf.
|
|
|
148 * There may be a single buffer for all the data, or one separate buffer for
|
|
|
149 * each plane, or anything in between.
|
|
|
150 *
|
|
|
151 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
|
|
|
152 * to the end with a minor bump.
|
|
|
153 * Similarly fields that are marked as to be only accessed by
|
|
|
154 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
|
|
|
155 * without breaking compatibility with each other.
|
|
|
156 */
|
|
|
157 typedef struct AVFrame {
|
|
|
158 #define AV_NUM_DATA_POINTERS 8
|
|
|
159 /**
|
|
|
160 * pointer to the picture/channel planes.
|
|
|
161 * This might be different from the first allocated byte
|
|
|
162 *
|
|
|
163 * Some decoders access areas outside 0,0 - width,height, please
|
|
|
164 * see avcodec_align_dimensions2(). Some filters and swscale can read
|
|
|
165 * up to 16 bytes beyond the planes, if these filters are to be used,
|
|
|
166 * then 16 extra bytes must be allocated.
|
|
|
167 */
|
|
|
168 uint8_t *data[AV_NUM_DATA_POINTERS];
|
|
|
169
|
|
|
170 /**
|
|
|
171 * For video, size in bytes of each picture line.
|
|
|
172 * For audio, size in bytes of each plane.
|
|
|
173 *
|
|
|
174 * For audio, only linesize[0] may be set. For planar audio, each channel
|
|
|
175 * plane must be the same size.
|
|
|
176 *
|
|
|
177 * For video the linesizes should be multiples of the CPUs alignment
|
|
|
178 * preference, this is 16 or 32 for modern desktop CPUs.
|
|
|
179 * Some code requires such alignment other code can be slower without
|
|
|
180 * correct alignment, for yet other it makes no difference.
|
|
|
181 *
|
|
|
182 * @note The linesize may be larger than the size of usable data -- there
|
|
|
183 * may be extra padding present for performance reasons.
|
|
|
184 */
|
|
|
185 int linesize[AV_NUM_DATA_POINTERS];
|
|
|
186
|
|
|
187 #if 0
|
|
|
188 /**
|
|
|
189 * pointers to the data planes/channels.
|
|
|
190 *
|
|
|
191 * For video, this should simply point to data[].
|
|
|
192 *
|
|
|
193 * For planar audio, each channel has a separate data pointer, and
|
|
|
194 * linesize[0] contains the size of each channel buffer.
|
|
|
195 * For packed audio, there is just one data pointer, and linesize[0]
|
|
|
196 * contains the total size of the buffer for all channels.
|
|
|
197 *
|
|
|
198 * Note: Both data and extended_data should always be set in a valid frame,
|
|
|
199 * but for planar audio with more channels that can fit in data,
|
|
|
200 * extended_data must be used in order to access all channels.
|
|
|
201 */
|
|
|
202 uint8_t **extended_data;
|
|
|
203 #endif
|
|
|
204
|
|
|
205 /**
|
|
|
206 * width and height of the video frame
|
|
|
207 */
|
|
|
208 int width, height;
|
|
|
209
|
|
|
210 /**
|
|
|
211 * number of audio samples (per channel) described by this frame
|
|
|
212 */
|
|
|
213 int nb_samples;
|
|
|
214
|
|
|
215 /**
|
|
|
216 * format of the frame, -1 if unknown or unset
|
|
|
217 * Values correspond to enum AVPixelFormat for video frames,
|
|
|
218 * enum AVSampleFormat for audio)
|
|
|
219 */
|
|
|
220 int format;
|
|
|
221
|
|
|
222 /**
|
|
|
223 * 1 -> keyframe, 0-> not
|
|
|
224 */
|
|
|
225 int key_frame;
|
|
|
226
|
|
|
227 /**
|
|
|
228 * Picture type of the frame.
|
|
|
229 */
|
|
|
230 enum AVPictureType pict_type;
|
|
|
231
|
|
|
232 #if FF_API_AVFRAME_LAVC
|
|
|
233 attribute_deprecated
|
|
|
234 uint8_t *base[AV_NUM_DATA_POINTERS];
|
|
|
235 #endif
|
|
|
236
|
|
|
237 /**
|
|
|
238 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
|
|
|
239 */
|
|
|
240 AVRational sample_aspect_ratio;
|
|
|
241
|
|
|
242 /**
|
|
|
243 * Presentation timestamp in time_base units (time when frame should be shown to user).
|
|
|
244 */
|
|
|
245 int64_t pts;
|
|
|
246
|
|
|
247 /**
|
|
|
248 * PTS copied from the AVPacket that was decoded to produce this frame.
|
|
|
249 */
|
|
|
250 int64_t pkt_pts;
|
|
|
251
|
|
|
252 /**
|
|
|
253 * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
|
|
|
254 * This is also the Presentation time of this AVFrame calculated from
|
|
|
255 * only AVPacket.dts values without pts values.
|
|
|
256 */
|
|
|
257 int64_t pkt_dts;
|
|
|
258
|
|
|
259 /**
|
|
|
260 * picture number in bitstream order
|
|
|
261 */
|
|
|
262 int coded_picture_number;
|
|
|
263 /**
|
|
|
264 * picture number in display order
|
|
|
265 */
|
|
|
266 int display_picture_number;
|
|
|
267
|
|
|
268 /**
|
|
|
269 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
|
|
|
270 */
|
|
|
271 int quality;
|
|
|
272
|
|
|
273 /**
|
|
|
274 * for some private data of the user
|
|
|
275 */
|
|
|
276 void *opaque;
|
|
|
277
|
|
|
278 /**
|
|
|
279 * error
|
|
|
280 */
|
|
|
281 uint64_t error[AV_NUM_DATA_POINTERS];
|
|
|
282
|
|
|
283 #if FF_API_AVFRAME_LAVC
|
|
|
284 attribute_deprecated
|
|
|
285 int type;
|
|
|
286 #endif
|
|
|
287
|
|
|
288 /**
|
|
|
289 * When decoding, this signals how much the picture must be delayed.
|
|
|
290 * extra_delay = repeat_pict / (2*fps)
|
|
|
291 */
|
|
|
292 int repeat_pict;
|
|
|
293
|
|
|
294 /**
|
|
|
295 * The content of the picture is interlaced.
|
|
|
296 */
|
|
|
297 int interlaced_frame;
|
|
|
298
|
|
|
299 /**
|
|
|
300 * If the content is interlaced, is top field displayed first.
|
|
|
301 */
|
|
|
302 int top_field_first;
|
|
|
303
|
|
|
304 /**
|
|
|
305 * Tell user application that palette has changed from previous frame.
|
|
|
306 */
|
|
|
307 int palette_has_changed;
|
|
|
308
|
|
|
309 #if FF_API_AVFRAME_LAVC
|
|
|
310 attribute_deprecated
|
|
|
311 int buffer_hints;
|
|
|
312
|
|
|
313 /**
|
|
|
314 * Pan scan.
|
|
|
315 */
|
|
|
316 attribute_deprecated
|
|
|
317 struct AVPanScan *pan_scan;
|
|
|
318 #endif
|
|
|
319
|
|
|
320 /**
|
|
|
321 * reordered opaque 64bit (generally an integer or a double precision float
|
|
|
322 * PTS but can be anything).
|
|
|
323 * The user sets AVCodecContext.reordered_opaque to represent the input at
|
|
|
324 * that time,
|
|
|
325 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
|
|
|
326 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
|
|
|
327 * @deprecated in favor of pkt_pts
|
|
|
328 */
|
|
|
329 int64_t reordered_opaque;
|
|
|
330
|
|
|
331 #if FF_API_AVFRAME_LAVC
|
|
|
332 /**
|
|
|
333 * @deprecated this field is unused
|
|
|
334 */
|
|
|
335 attribute_deprecated void *hwaccel_picture_private;
|
|
|
336
|
|
|
337 attribute_deprecated
|
|
|
338 struct AVCodecContext *owner;
|
|
|
339 attribute_deprecated
|
|
|
340 void *thread_opaque;
|
|
|
341
|
|
|
342 /**
|
|
|
343 * log2 of the size of the block which a single vector in motion_val represents:
|
|
|
344 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
|
|
|
345 */
|
|
|
346 uint8_t motion_subsample_log2;
|
|
|
347 #endif
|
|
|
348
|
|
|
349 /**
|
|
|
350 * Sample rate of the audio data.
|
|
|
351 */
|
|
|
352 int sample_rate;
|
|
|
353
|
|
|
354 /**
|
|
|
355 * Channel layout of the audio data.
|
|
|
356 */
|
|
|
357 uint64_t channel_layout;
|
|
|
358
|
|
|
359 /**
|
|
|
360 * AVBuffer references backing the data for this frame. If all elements of
|
|
|
361 * this array are NULL, then this frame is not reference counted.
|
|
|
362 *
|
|
|
363 * There may be at most one AVBuffer per data plane, so for video this array
|
|
|
364 * always contains all the references. For planar audio with more than
|
|
|
365 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
|
|
|
366 * this array. Then the extra AVBufferRef pointers are stored in the
|
|
|
367 * extended_buf array.
|
|
|
368 */
|
|
|
369 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
|
|
|
370
|
|
|
371 #if 0
|
|
|
372 /**
|
|
|
373 * For planar audio which requires more than AV_NUM_DATA_POINTERS
|
|
|
374 * AVBufferRef pointers, this array will hold all the references which
|
|
|
375 * cannot fit into AVFrame.buf.
|
|
|
376 *
|
|
|
377 * Note that this is different from AVFrame.extended_data, which always
|
|
|
378 * contains all the pointers. This array only contains the extra pointers,
|
|
|
379 * which cannot fit into AVFrame.buf.
|
|
|
380 *
|
|
|
381 * This array is always allocated using av_malloc() by whoever constructs
|
|
|
382 * the frame. It is freed in av_frame_unref().
|
|
|
383 */
|
|
|
384 AVBufferRef **extended_buf;
|
|
|
385 /**
|
|
|
386 * Number of elements in extended_buf.
|
|
|
387 */
|
|
|
388 int nb_extended_buf;
|
|
|
389
|
|
|
390 AVFrameSideData **side_data;
|
|
|
391 int nb_side_data;
|
|
|
392 #endif
|
|
|
393
|
|
|
394 /**
|
|
|
395 * @defgroup lavu_frame_flags AV_FRAME_FLAGS
|
|
|
396 * Flags describing additional frame properties.
|
|
|
397 *
|
|
|
398 * @{
|
|
|
399 */
|
|
|
400
|
|
|
401 /**
|
|
|
402 * The frame data may be corrupted, e.g. due to decoding errors.
|
|
|
403 */
|
|
|
404 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
|
|
|
405 /**
|
|
|
406 * @}
|
|
|
407 */
|
|
|
408
|
|
|
409 /**
|
|
|
410 * Frame flags, a combination of @ref lavu_frame_flags
|
|
|
411 */
|
|
|
412 int flags;
|
|
|
413
|
|
|
414 /**
|
|
|
415 * MPEG vs JPEG YUV range.
|
|
|
416 * It must be accessed using av_frame_get_color_range() and
|
|
|
417 * av_frame_set_color_range().
|
|
|
418 * - encoding: Set by user
|
|
|
419 * - decoding: Set by libavcodec
|
|
|
420 */
|
|
|
421 enum AVColorRange color_range;
|
|
|
422
|
|
|
423 enum AVColorPrimaries color_primaries;
|
|
|
424
|
|
|
425 enum AVColorTransferCharacteristic color_trc;
|
|
|
426
|
|
|
427 /**
|
|
|
428 * YUV colorspace type.
|
|
|
429 * It must be accessed using av_frame_get_colorspace() and
|
|
|
430 * av_frame_set_colorspace().
|
|
|
431 * - encoding: Set by user
|
|
|
432 * - decoding: Set by libavcodec
|
|
|
433 */
|
|
|
434 enum AVColorSpace colorspace;
|
|
|
435
|
|
|
436 enum AVChromaLocation chroma_location;
|
|
|
437
|
|
|
438 /**
|
|
|
439 * frame timestamp estimated using various heuristics, in stream time base
|
|
|
440 * Code outside libavcodec should access this field using:
|
|
|
441 * av_frame_get_best_effort_timestamp(frame)
|
|
|
442 * - encoding: unused
|
|
|
443 * - decoding: set by libavcodec, read by user.
|
|
|
444 */
|
|
|
445 int64_t best_effort_timestamp;
|
|
|
446
|
|
|
447 /**
|
|
|
448 * reordered pos from the last AVPacket that has been input into the decoder
|
|
|
449 * Code outside libavcodec should access this field using:
|
|
|
450 * av_frame_get_pkt_pos(frame)
|
|
|
451 * - encoding: unused
|
|
|
452 * - decoding: Read by user.
|
|
|
453 */
|
|
|
454 int64_t pkt_pos;
|
|
|
455
|
|
|
456 /**
|
|
|
457 * duration of the corresponding packet, expressed in
|
|
|
458 * AVStream->time_base units, 0 if unknown.
|
|
|
459 * Code outside libavcodec should access this field using:
|
|
|
460 * av_frame_get_pkt_duration(frame)
|
|
|
461 * - encoding: unused
|
|
|
462 * - decoding: Read by user.
|
|
|
463 */
|
|
|
464 int64_t pkt_duration;
|
|
|
465
|
|
|
466 /**
|
|
|
467 * decode error flags of the frame, set to a combination of
|
|
|
468 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
|
|
|
469 * were errors during the decoding.
|
|
|
470 * Code outside libavcodec should access this field using:
|
|
|
471 * av_frame_get_decode_error_flags(frame)
|
|
|
472 * - encoding: unused
|
|
|
473 * - decoding: set by libavcodec, read by user.
|
|
|
474 */
|
|
|
475 int decode_error_flags;
|
|
|
476 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
|
|
|
477 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
|
|
|
478
|
|
|
479 /**
|
|
|
480 * number of audio channels, only used for audio.
|
|
|
481 * Code outside libavcodec should access this field using:
|
|
|
482 * av_frame_get_channels(frame)
|
|
|
483 * - encoding: unused
|
|
|
484 * - decoding: Read by user.
|
|
|
485 */
|
|
|
486 int channels;
|
|
|
487
|
|
|
488 /**
|
|
|
489 * size of the corresponding packet containing the compressed
|
|
|
490 * frame. It must be accessed using av_frame_get_pkt_size() and
|
|
|
491 * av_frame_set_pkt_size().
|
|
|
492 * It is set to a negative value if unknown.
|
|
|
493 * - encoding: unused
|
|
|
494 * - decoding: set by libavcodec, read by user.
|
|
|
495 */
|
|
|
496 int pkt_size;
|
|
|
497 } AVFrame;
|
|
|
498
|
|
|
499 /**
|
|
|
500 * Accessors for some AVFrame fields.
|
|
|
501 * The position of these field in the structure is not part of the ABI,
|
|
|
502 * they should not be accessed directly outside libavcodec.
|
|
|
503 */
|
|
|
504 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
|
|
|
505 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
|
|
|
506 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
|
|
|
507 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
|
|
|
508 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
|
|
|
509 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
|
|
|
510 int64_t av_frame_get_channel_layout (const AVFrame *frame);
|
|
|
511 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
|
|
|
512 int av_frame_get_channels (const AVFrame *frame);
|
|
|
513 void av_frame_set_channels (AVFrame *frame, int val);
|
|
|
514 int av_frame_get_sample_rate (const AVFrame *frame);
|
|
|
515 void av_frame_set_sample_rate (AVFrame *frame, int val);
|
|
|
516 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
|
|
|
517 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
|
|
|
518 int av_frame_get_decode_error_flags (const AVFrame *frame);
|
|
|
519 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
|
|
|
520 int av_frame_get_pkt_size(const AVFrame *frame);
|
|
|
521 void av_frame_set_pkt_size(AVFrame *frame, int val);
|
|
|
522 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame);
|
|
|
523 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
|
|
|
524 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type);
|
|
|
525 enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame);
|
|
|
526 void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val);
|
|
|
527 enum AVColorRange av_frame_get_color_range(const AVFrame *frame);
|
|
|
528 void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val);
|
|
|
529
|
|
|
530 /**
|
|
|
531 * Get the name of a colorspace.
|
|
|
532 * @return a static string identifying the colorspace; can be NULL.
|
|
|
533 */
|
|
|
534 const char *av_get_colorspace_name(enum AVColorSpace val);
|
|
|
535
|
|
|
536 /**
|
|
|
537 * Allocate an AVFrame and set its fields to default values. The resulting
|
|
|
538 * struct must be freed using av_frame_free().
|
|
|
539 *
|
|
|
540 * @return An AVFrame filled with default values or NULL on failure.
|
|
|
541 *
|
|
|
542 * @note this only allocates the AVFrame itself, not the data buffers. Those
|
|
|
543 * must be allocated through other means, e.g. with av_frame_get_buffer() or
|
|
|
544 * manually.
|
|
|
545 */
|
|
|
546 AVFrame *av_frame_alloc(void);
|
|
|
547
|
|
|
548 /**
|
|
|
549 * Free the frame and any dynamically allocated objects in it,
|
|
|
550 * e.g. extended_data. If the frame is reference counted, it will be
|
|
|
551 * unreferenced first.
|
|
|
552 *
|
|
|
553 * @param frame frame to be freed. The pointer will be set to NULL.
|
|
|
554 */
|
|
|
555 void av_frame_free(AVFrame **frame);
|
|
|
556
|
|
|
557 /**
|
|
|
558 * Set up a new reference to the data described by the source frame.
|
|
|
559 *
|
|
|
560 * Copy frame properties from src to dst and create a new reference for each
|
|
|
561 * AVBufferRef from src.
|
|
|
562 *
|
|
|
563 * If src is not reference counted, new buffers are allocated and the data is
|
|
|
564 * copied.
|
|
|
565 *
|
|
|
566 * @return 0 on success, a negative AVERROR on error
|
|
|
567 */
|
|
|
568 int av_frame_ref(AVFrame *dst, const AVFrame *src);
|
|
|
569
|
|
|
570 /**
|
|
|
571 * Create a new frame that references the same data as src.
|
|
|
572 *
|
|
|
573 * This is a shortcut for av_frame_alloc()+av_frame_ref().
|
|
|
574 *
|
|
|
575 * @return newly created AVFrame on success, NULL on error.
|
|
|
576 */
|
|
|
577 AVFrame *av_frame_clone(const AVFrame *src);
|
|
|
578
|
|
|
579 /**
|
|
|
580 * Unreference all the buffers referenced by frame and reset the frame fields.
|
|
|
581 */
|
|
|
582 void av_frame_unref(AVFrame *frame);
|
|
|
583
|
|
|
584 /**
|
|
|
585 * Move everythnig contained in src to dst and reset src.
|
|
|
586 */
|
|
|
587 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
|
|
|
588
|
|
|
589 /**
|
|
|
590 * Allocate new buffer(s) for audio or video data.
|
|
|
591 *
|
|
|
592 * The following fields must be set on frame before calling this function:
|
|
|
593 * - format (pixel format for video, sample format for audio)
|
|
|
594 * - width and height for video
|
|
|
595 * - nb_samples and channel_layout for audio
|
|
|
596 *
|
|
|
597 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
|
|
|
598 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
|
|
|
599 * For planar formats, one buffer will be allocated for each plane.
|
|
|
600 *
|
|
|
601 * @param frame frame in which to store the new buffers.
|
|
|
602 * @param align required buffer size alignment
|
|
|
603 *
|
|
|
604 * @return 0 on success, a negative AVERROR on error.
|
|
|
605 */
|
|
|
606 int av_frame_get_buffer(AVFrame *frame, int align);
|
|
|
607
|
|
|
608 /**
|
|
|
609 * Check if the frame data is writable.
|
|
|
610 *
|
|
|
611 * @return A positive value if the frame data is writable (which is true if and
|
|
|
612 * only if each of the underlying buffers has only one reference, namely the one
|
|
|
613 * stored in this frame). Return 0 otherwise.
|
|
|
614 *
|
|
|
615 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
|
|
|
616 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
|
|
|
617 *
|
|
|
618 * @see av_frame_make_writable(), av_buffer_is_writable()
|
|
|
619 */
|
|
|
620 int av_frame_is_writable(AVFrame *frame);
|
|
|
621
|
|
|
622 /**
|
|
|
623 * Ensure that the frame data is writable, avoiding data copy if possible.
|
|
|
624 *
|
|
|
625 * Do nothing if the frame is writable, allocate new buffers and copy the data
|
|
|
626 * if it is not.
|
|
|
627 *
|
|
|
628 * @return 0 on success, a negative AVERROR on error.
|
|
|
629 *
|
|
|
630 * @see av_frame_is_writable(), av_buffer_is_writable(),
|
|
|
631 * av_buffer_make_writable()
|
|
|
632 */
|
|
|
633 int av_frame_make_writable(AVFrame *frame);
|
|
|
634
|
|
|
635 /**
|
|
|
636 * Copy the frame data from src to dst.
|
|
|
637 *
|
|
|
638 * This function does not allocate anything, dst must be already initialized and
|
|
|
639 * allocated with the same parameters as src.
|
|
|
640 *
|
|
|
641 * This function only copies the frame data (i.e. the contents of the data /
|
|
|
642 * extended data arrays), not any other properties.
|
|
|
643 *
|
|
|
644 * @return >= 0 on success, a negative AVERROR on error.
|
|
|
645 */
|
|
|
646 int av_frame_copy(AVFrame *dst, const AVFrame *src);
|
|
|
647
|
|
|
648 /**
|
|
|
649 * Copy only "metadata" fields from src to dst.
|
|
|
650 *
|
|
|
651 * Metadata for the purpose of this function are those fields that do not affect
|
|
|
652 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
|
|
|
653 * aspect ratio (for video), but not width/height or channel layout.
|
|
|
654 * Side data is also copied.
|
|
|
655 */
|
|
|
656 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
|
|
|
657
|
|
|
658 /**
|
|
|
659 * Get the buffer reference a given data plane is stored in.
|
|
|
660 *
|
|
|
661 * @param plane index of the data plane of interest in frame->extended_data.
|
|
|
662 *
|
|
|
663 * @return the buffer reference that contains the plane or NULL if the input
|
|
|
664 * frame is not valid.
|
|
|
665 */
|
|
|
666 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
|
|
|
667
|
|
|
668 /**
|
|
|
669 * Add a new side data to a frame.
|
|
|
670 *
|
|
|
671 * @param frame a frame to which the side data should be added
|
|
|
672 * @param type type of the added side data
|
|
|
673 * @param size size of the side data
|
|
|
674 *
|
|
|
675 * @return newly added side data on success, NULL on error
|
|
|
676 */
|
|
|
677 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
|
|
|
678 enum AVFrameSideDataType type,
|
|
|
679 int size);
|
|
|
680
|
|
|
681 /**
|
|
|
682 * @return a pointer to the side data of a given type on success, NULL if there
|
|
|
683 * is no side data with such type in this frame.
|
|
|
684 */
|
|
|
685 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
|
|
|
686 enum AVFrameSideDataType type);
|
|
|
687
|
|
|
688 /**
|
|
|
689 * If side data of the supplied type exists in the frame, free it and remove it
|
|
|
690 * from the frame.
|
|
|
691 */
|
|
|
692 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
|
|
|
693
|
|
|
694 /**
|
|
|
695 * @return a string identifying the side data type
|
|
|
696 */
|
|
|
697 const char *av_frame_side_data_name(enum AVFrameSideDataType type);
|
|
|
698
|
|
|
699 /**
|
|
|
700 * @}
|
|
|
701 */
|
|
|
702
|
|
|
703 #endif /* AVUTIL_FRAME_H */
|
