]> git.sesse.net Git - ffmpeg/blob - libavutil/frame.h
Merge commit '9485cce6d55baf547e92ef1f54cad117f2a38287'
[ffmpeg] / libavutil / frame.h
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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 <stddef.h>
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      * This side data must be associated with an audio frame and corresponds to
111      * enum AVAudioServiceType defined in avcodec.h.
112      */
113     AV_FRAME_DATA_AUDIO_SERVICE_TYPE,
114     /**
115      * Mastering display metadata associated with a video frame. The payload is
116      * an AVMasteringDisplayMetadata type and contains information about the
117      * mastering display color volume.
118      */
119     AV_FRAME_DATA_MASTERING_DISPLAY_METADATA,
120     /**
121      * The GOP timecode in 25 bit timecode format. Data format is 64-bit integer.
122      * This is set on the first frame of a GOP that has a temporal reference of 0.
123      */
124     AV_FRAME_DATA_GOP_TIMECODE,
125
126     /**
127      * The data represents the AVSphericalMapping structure defined in
128      * libavutil/spherical.h.
129      */
130     AV_FRAME_DATA_SPHERICAL,
131
132     /**
133      * Content light level (based on CTA-861.3). This payload contains data in
134      * the form of the AVContentLightMetadata struct.
135      */
136     AV_FRAME_DATA_CONTENT_LIGHT_LEVEL,
137
138     /**
139      * The data contains an ICC profile as an opaque octet buffer following the
140      * format described by ISO 15076-1 with an optional name defined in the
141      * metadata key entry "name".
142      */
143     AV_FRAME_DATA_ICC_PROFILE,
144
145 #if FF_API_FRAME_QP
146     /**
147      * Implementation-specific description of the format of AV_FRAME_QP_TABLE_DATA.
148      * The contents of this side data are undocumented and internal; use
149      * av_frame_set_qp_table() and av_frame_get_qp_table() to access this in a
150      * meaningful way instead.
151      */
152     AV_FRAME_DATA_QP_TABLE_PROPERTIES,
153
154     /**
155      * Raw QP table data. Its format is described by
156      * AV_FRAME_DATA_QP_TABLE_PROPERTIES. Use av_frame_set_qp_table() and
157      * av_frame_get_qp_table() to access this instead.
158      */
159     AV_FRAME_DATA_QP_TABLE_DATA,
160 #endif
161
162     /**
163      * Timecode which conforms to SMPTE ST 12-1. The data is an array of 4 uint32_t
164      * where the first uint32_t describes how many (1-3) of the other timecodes are used.
165      * The timecode format is described in the av_timecode_get_smpte_from_framenum()
166      * function in libavutil/timecode.c.
167      */
168     AV_FRAME_DATA_S12M_TIMECODE,
169
170     /**
171      * HDR dynamic metadata associated with a video frame. The payload is
172      * an AVDynamicHDRPlus type and contains information for color
173      * volume transform - application 4 of SMPTE 2094-40:2016 standard.
174      */
175     AV_FRAME_DATA_DYNAMIC_HDR_PLUS,
176
177     /**
178      * Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of
179      * array element is implied by AVFrameSideData.size / AVRegionOfInterest.self_size.
180      */
181     AV_FRAME_DATA_REGIONS_OF_INTEREST,
182 };
183
184 enum AVActiveFormatDescription {
185     AV_AFD_SAME         = 8,
186     AV_AFD_4_3          = 9,
187     AV_AFD_16_9         = 10,
188     AV_AFD_14_9         = 11,
189     AV_AFD_4_3_SP_14_9  = 13,
190     AV_AFD_16_9_SP_14_9 = 14,
191     AV_AFD_SP_4_3       = 15,
192 };
193
194
195 /**
196  * Structure to hold side data for an AVFrame.
197  *
198  * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
199  * to the end with a minor bump.
200  */
201 typedef struct AVFrameSideData {
202     enum AVFrameSideDataType type;
203     uint8_t *data;
204     int      size;
205     AVDictionary *metadata;
206     AVBufferRef *buf;
207 } AVFrameSideData;
208
209 /**
210  * Structure to hold Region Of Interest.
211  *
212  * self_size specifies the size of this data structure. This value
213  * should be set to sizeof(AVRegionOfInterest). EINVAL is returned if self_size is zero.
214  *
215  * Number of pixels to discard from the top/bottom/left/right border of
216  * the frame to obtain the region of interest of the frame.
217  * They are encoder dependent and will be extended internally
218  * if the codec requires an alignment.
219  * If the regions overlap, the last value in the list will be used.
220  *
221  * qoffset is quant offset, and base rule here:
222  * returns EINVAL if AVRational.den is zero.
223  * the value (num/den) range is [-1.0, 1.0], clamp to +-1.0 if out of range.
224  * 0 means no picture quality change,
225  * negative offset asks for better quality (and the best with value -1.0),
226  * positive offset asks for worse quality (and the worst with value 1.0).
227  * How to explain/implement the different quilaity requirement is encoder dependent.
228  */
229 typedef struct AVRegionOfInterest {
230     uint32_t self_size;
231     int top;
232     int bottom;
233     int left;
234     int right;
235     AVRational qoffset;
236 } AVRegionOfInterest;
237
238 /**
239  * This structure describes decoded (raw) audio or video data.
240  *
241  * AVFrame must be allocated using av_frame_alloc(). Note that this only
242  * allocates the AVFrame itself, the buffers for the data must be managed
243  * through other means (see below).
244  * AVFrame must be freed with av_frame_free().
245  *
246  * AVFrame is typically allocated once and then reused multiple times to hold
247  * different data (e.g. a single AVFrame to hold frames received from a
248  * decoder). In such a case, av_frame_unref() will free any references held by
249  * the frame and reset it to its original clean state before it
250  * is reused again.
251  *
252  * The data described by an AVFrame is usually reference counted through the
253  * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
254  * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
255  * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
256  * every single data plane must be contained in one of the buffers in
257  * AVFrame.buf or AVFrame.extended_buf.
258  * There may be a single buffer for all the data, or one separate buffer for
259  * each plane, or anything in between.
260  *
261  * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
262  * to the end with a minor bump.
263  *
264  * Fields can be accessed through AVOptions, the name string used, matches the
265  * C structure field name for fields accessible through AVOptions. The AVClass
266  * for AVFrame can be obtained from avcodec_get_frame_class()
267  */
268 typedef struct AVFrame {
269 #define AV_NUM_DATA_POINTERS 8
270     /**
271      * pointer to the picture/channel planes.
272      * This might be different from the first allocated byte
273      *
274      * Some decoders access areas outside 0,0 - width,height, please
275      * see avcodec_align_dimensions2(). Some filters and swscale can read
276      * up to 16 bytes beyond the planes, if these filters are to be used,
277      * then 16 extra bytes must be allocated.
278      *
279      * NOTE: Except for hwaccel formats, pointers not needed by the format
280      * MUST be set to NULL.
281      */
282     uint8_t *data[AV_NUM_DATA_POINTERS];
283
284     /**
285      * For video, size in bytes of each picture line.
286      * For audio, size in bytes of each plane.
287      *
288      * For audio, only linesize[0] may be set. For planar audio, each channel
289      * plane must be the same size.
290      *
291      * For video the linesizes should be multiples of the CPUs alignment
292      * preference, this is 16 or 32 for modern desktop CPUs.
293      * Some code requires such alignment other code can be slower without
294      * correct alignment, for yet other it makes no difference.
295      *
296      * @note The linesize may be larger than the size of usable data -- there
297      * may be extra padding present for performance reasons.
298      */
299     int linesize[AV_NUM_DATA_POINTERS];
300
301     /**
302      * pointers to the data planes/channels.
303      *
304      * For video, this should simply point to data[].
305      *
306      * For planar audio, each channel has a separate data pointer, and
307      * linesize[0] contains the size of each channel buffer.
308      * For packed audio, there is just one data pointer, and linesize[0]
309      * contains the total size of the buffer for all channels.
310      *
311      * Note: Both data and extended_data should always be set in a valid frame,
312      * but for planar audio with more channels that can fit in data,
313      * extended_data must be used in order to access all channels.
314      */
315     uint8_t **extended_data;
316
317     /**
318      * @name Video dimensions
319      * Video frames only. The coded dimensions (in pixels) of the video frame,
320      * i.e. the size of the rectangle that contains some well-defined values.
321      *
322      * @note The part of the frame intended for display/presentation is further
323      * restricted by the @ref cropping "Cropping rectangle".
324      * @{
325      */
326     int width, height;
327     /**
328      * @}
329      */
330
331     /**
332      * number of audio samples (per channel) described by this frame
333      */
334     int nb_samples;
335
336     /**
337      * format of the frame, -1 if unknown or unset
338      * Values correspond to enum AVPixelFormat for video frames,
339      * enum AVSampleFormat for audio)
340      */
341     int format;
342
343     /**
344      * 1 -> keyframe, 0-> not
345      */
346     int key_frame;
347
348     /**
349      * Picture type of the frame.
350      */
351     enum AVPictureType pict_type;
352
353     /**
354      * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
355      */
356     AVRational sample_aspect_ratio;
357
358     /**
359      * Presentation timestamp in time_base units (time when frame should be shown to user).
360      */
361     int64_t pts;
362
363 #if FF_API_PKT_PTS
364     /**
365      * PTS copied from the AVPacket that was decoded to produce this frame.
366      * @deprecated use the pts field instead
367      */
368     attribute_deprecated
369     int64_t pkt_pts;
370 #endif
371
372     /**
373      * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
374      * This is also the Presentation time of this AVFrame calculated from
375      * only AVPacket.dts values without pts values.
376      */
377     int64_t pkt_dts;
378
379     /**
380      * picture number in bitstream order
381      */
382     int coded_picture_number;
383     /**
384      * picture number in display order
385      */
386     int display_picture_number;
387
388     /**
389      * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
390      */
391     int quality;
392
393     /**
394      * for some private data of the user
395      */
396     void *opaque;
397
398 #if FF_API_ERROR_FRAME
399     /**
400      * @deprecated unused
401      */
402     attribute_deprecated
403     uint64_t error[AV_NUM_DATA_POINTERS];
404 #endif
405
406     /**
407      * When decoding, this signals how much the picture must be delayed.
408      * extra_delay = repeat_pict / (2*fps)
409      */
410     int repeat_pict;
411
412     /**
413      * The content of the picture is interlaced.
414      */
415     int interlaced_frame;
416
417     /**
418      * If the content is interlaced, is top field displayed first.
419      */
420     int top_field_first;
421
422     /**
423      * Tell user application that palette has changed from previous frame.
424      */
425     int palette_has_changed;
426
427     /**
428      * reordered opaque 64 bits (generally an integer or a double precision float
429      * PTS but can be anything).
430      * The user sets AVCodecContext.reordered_opaque to represent the input at
431      * that time,
432      * the decoder reorders values as needed and sets AVFrame.reordered_opaque
433      * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
434      */
435     int64_t reordered_opaque;
436
437     /**
438      * Sample rate of the audio data.
439      */
440     int sample_rate;
441
442     /**
443      * Channel layout of the audio data.
444      */
445     uint64_t channel_layout;
446
447     /**
448      * AVBuffer references backing the data for this frame. If all elements of
449      * this array are NULL, then this frame is not reference counted. This array
450      * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
451      * also be non-NULL for all j < i.
452      *
453      * There may be at most one AVBuffer per data plane, so for video this array
454      * always contains all the references. For planar audio with more than
455      * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
456      * this array. Then the extra AVBufferRef pointers are stored in the
457      * extended_buf array.
458      */
459     AVBufferRef *buf[AV_NUM_DATA_POINTERS];
460
461     /**
462      * For planar audio which requires more than AV_NUM_DATA_POINTERS
463      * AVBufferRef pointers, this array will hold all the references which
464      * cannot fit into AVFrame.buf.
465      *
466      * Note that this is different from AVFrame.extended_data, which always
467      * contains all the pointers. This array only contains the extra pointers,
468      * which cannot fit into AVFrame.buf.
469      *
470      * This array is always allocated using av_malloc() by whoever constructs
471      * the frame. It is freed in av_frame_unref().
472      */
473     AVBufferRef **extended_buf;
474     /**
475      * Number of elements in extended_buf.
476      */
477     int        nb_extended_buf;
478
479     AVFrameSideData **side_data;
480     int            nb_side_data;
481
482 /**
483  * @defgroup lavu_frame_flags AV_FRAME_FLAGS
484  * @ingroup lavu_frame
485  * Flags describing additional frame properties.
486  *
487  * @{
488  */
489
490 /**
491  * The frame data may be corrupted, e.g. due to decoding errors.
492  */
493 #define AV_FRAME_FLAG_CORRUPT       (1 << 0)
494 /**
495  * A flag to mark the frames which need to be decoded, but shouldn't be output.
496  */
497 #define AV_FRAME_FLAG_DISCARD   (1 << 2)
498 /**
499  * @}
500  */
501
502     /**
503      * Frame flags, a combination of @ref lavu_frame_flags
504      */
505     int flags;
506
507     /**
508      * MPEG vs JPEG YUV range.
509      * - encoding: Set by user
510      * - decoding: Set by libavcodec
511      */
512     enum AVColorRange color_range;
513
514     enum AVColorPrimaries color_primaries;
515
516     enum AVColorTransferCharacteristic color_trc;
517
518     /**
519      * YUV colorspace type.
520      * - encoding: Set by user
521      * - decoding: Set by libavcodec
522      */
523     enum AVColorSpace colorspace;
524
525     enum AVChromaLocation chroma_location;
526
527     /**
528      * frame timestamp estimated using various heuristics, in stream time base
529      * - encoding: unused
530      * - decoding: set by libavcodec, read by user.
531      */
532     int64_t best_effort_timestamp;
533
534     /**
535      * reordered pos from the last AVPacket that has been input into the decoder
536      * - encoding: unused
537      * - decoding: Read by user.
538      */
539     int64_t pkt_pos;
540
541     /**
542      * duration of the corresponding packet, expressed in
543      * AVStream->time_base units, 0 if unknown.
544      * - encoding: unused
545      * - decoding: Read by user.
546      */
547     int64_t pkt_duration;
548
549     /**
550      * metadata.
551      * - encoding: Set by user.
552      * - decoding: Set by libavcodec.
553      */
554     AVDictionary *metadata;
555
556     /**
557      * decode error flags of the frame, set to a combination of
558      * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
559      * were errors during the decoding.
560      * - encoding: unused
561      * - decoding: set by libavcodec, read by user.
562      */
563     int decode_error_flags;
564 #define FF_DECODE_ERROR_INVALID_BITSTREAM   1
565 #define FF_DECODE_ERROR_MISSING_REFERENCE   2
566
567     /**
568      * number of audio channels, only used for audio.
569      * - encoding: unused
570      * - decoding: Read by user.
571      */
572     int channels;
573
574     /**
575      * size of the corresponding packet containing the compressed
576      * frame.
577      * It is set to a negative value if unknown.
578      * - encoding: unused
579      * - decoding: set by libavcodec, read by user.
580      */
581     int pkt_size;
582
583 #if FF_API_FRAME_QP
584     /**
585      * QP table
586      */
587     attribute_deprecated
588     int8_t *qscale_table;
589     /**
590      * QP store stride
591      */
592     attribute_deprecated
593     int qstride;
594
595     attribute_deprecated
596     int qscale_type;
597
598     attribute_deprecated
599     AVBufferRef *qp_table_buf;
600 #endif
601     /**
602      * For hwaccel-format frames, this should be a reference to the
603      * AVHWFramesContext describing the frame.
604      */
605     AVBufferRef *hw_frames_ctx;
606
607     /**
608      * AVBufferRef for free use by the API user. FFmpeg will never check the
609      * contents of the buffer ref. FFmpeg calls av_buffer_unref() on it when
610      * the frame is unreferenced. av_frame_copy_props() calls create a new
611      * reference with av_buffer_ref() for the target frame's opaque_ref field.
612      *
613      * This is unrelated to the opaque field, although it serves a similar
614      * purpose.
615      */
616     AVBufferRef *opaque_ref;
617
618     /**
619      * @anchor cropping
620      * @name Cropping
621      * Video frames only. The number of pixels to discard from the the
622      * top/bottom/left/right border of the frame to obtain the sub-rectangle of
623      * the frame intended for presentation.
624      * @{
625      */
626     size_t crop_top;
627     size_t crop_bottom;
628     size_t crop_left;
629     size_t crop_right;
630     /**
631      * @}
632      */
633
634     /**
635      * AVBufferRef for internal use by a single libav* library.
636      * Must not be used to transfer data between libraries.
637      * Has to be NULL when ownership of the frame leaves the respective library.
638      *
639      * Code outside the FFmpeg libs should never check or change the contents of the buffer ref.
640      *
641      * FFmpeg calls av_buffer_unref() on it when the frame is unreferenced.
642      * av_frame_copy_props() calls create a new reference with av_buffer_ref()
643      * for the target frame's private_ref field.
644      */
645     AVBufferRef *private_ref;
646 } AVFrame;
647
648 #if FF_API_FRAME_GET_SET
649 /**
650  * Accessors for some AVFrame fields. These used to be provided for ABI
651  * compatibility, and do not need to be used anymore.
652  */
653 attribute_deprecated
654 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
655 attribute_deprecated
656 void    av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
657 attribute_deprecated
658 int64_t av_frame_get_pkt_duration         (const AVFrame *frame);
659 attribute_deprecated
660 void    av_frame_set_pkt_duration         (AVFrame *frame, int64_t val);
661 attribute_deprecated
662 int64_t av_frame_get_pkt_pos              (const AVFrame *frame);
663 attribute_deprecated
664 void    av_frame_set_pkt_pos              (AVFrame *frame, int64_t val);
665 attribute_deprecated
666 int64_t av_frame_get_channel_layout       (const AVFrame *frame);
667 attribute_deprecated
668 void    av_frame_set_channel_layout       (AVFrame *frame, int64_t val);
669 attribute_deprecated
670 int     av_frame_get_channels             (const AVFrame *frame);
671 attribute_deprecated
672 void    av_frame_set_channels             (AVFrame *frame, int     val);
673 attribute_deprecated
674 int     av_frame_get_sample_rate          (const AVFrame *frame);
675 attribute_deprecated
676 void    av_frame_set_sample_rate          (AVFrame *frame, int     val);
677 attribute_deprecated
678 AVDictionary *av_frame_get_metadata       (const AVFrame *frame);
679 attribute_deprecated
680 void          av_frame_set_metadata       (AVFrame *frame, AVDictionary *val);
681 attribute_deprecated
682 int     av_frame_get_decode_error_flags   (const AVFrame *frame);
683 attribute_deprecated
684 void    av_frame_set_decode_error_flags   (AVFrame *frame, int     val);
685 attribute_deprecated
686 int     av_frame_get_pkt_size(const AVFrame *frame);
687 attribute_deprecated
688 void    av_frame_set_pkt_size(AVFrame *frame, int val);
689 #if FF_API_FRAME_QP
690 attribute_deprecated
691 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
692 attribute_deprecated
693 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type);
694 #endif
695 attribute_deprecated
696 enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame);
697 attribute_deprecated
698 void    av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val);
699 attribute_deprecated
700 enum AVColorRange av_frame_get_color_range(const AVFrame *frame);
701 attribute_deprecated
702 void    av_frame_set_color_range(AVFrame *frame, enum AVColorRange val);
703 #endif
704
705 /**
706  * Get the name of a colorspace.
707  * @return a static string identifying the colorspace; can be NULL.
708  */
709 const char *av_get_colorspace_name(enum AVColorSpace val);
710
711 /**
712  * Allocate an AVFrame and set its fields to default values.  The resulting
713  * struct must be freed using av_frame_free().
714  *
715  * @return An AVFrame filled with default values or NULL on failure.
716  *
717  * @note this only allocates the AVFrame itself, not the data buffers. Those
718  * must be allocated through other means, e.g. with av_frame_get_buffer() or
719  * manually.
720  */
721 AVFrame *av_frame_alloc(void);
722
723 /**
724  * Free the frame and any dynamically allocated objects in it,
725  * e.g. extended_data. If the frame is reference counted, it will be
726  * unreferenced first.
727  *
728  * @param frame frame to be freed. The pointer will be set to NULL.
729  */
730 void av_frame_free(AVFrame **frame);
731
732 /**
733  * Set up a new reference to the data described by the source frame.
734  *
735  * Copy frame properties from src to dst and create a new reference for each
736  * AVBufferRef from src.
737  *
738  * If src is not reference counted, new buffers are allocated and the data is
739  * copied.
740  *
741  * @warning: dst MUST have been either unreferenced with av_frame_unref(dst),
742  *           or newly allocated with av_frame_alloc() before calling this
743  *           function, or undefined behavior will occur.
744  *
745  * @return 0 on success, a negative AVERROR on error
746  */
747 int av_frame_ref(AVFrame *dst, const AVFrame *src);
748
749 /**
750  * Create a new frame that references the same data as src.
751  *
752  * This is a shortcut for av_frame_alloc()+av_frame_ref().
753  *
754  * @return newly created AVFrame on success, NULL on error.
755  */
756 AVFrame *av_frame_clone(const AVFrame *src);
757
758 /**
759  * Unreference all the buffers referenced by frame and reset the frame fields.
760  */
761 void av_frame_unref(AVFrame *frame);
762
763 /**
764  * Move everything contained in src to dst and reset src.
765  *
766  * @warning: dst is not unreferenced, but directly overwritten without reading
767  *           or deallocating its contents. Call av_frame_unref(dst) manually
768  *           before calling this function to ensure that no memory is leaked.
769  */
770 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
771
772 /**
773  * Allocate new buffer(s) for audio or video data.
774  *
775  * The following fields must be set on frame before calling this function:
776  * - format (pixel format for video, sample format for audio)
777  * - width and height for video
778  * - nb_samples and channel_layout for audio
779  *
780  * This function will fill AVFrame.data and AVFrame.buf arrays and, if
781  * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
782  * For planar formats, one buffer will be allocated for each plane.
783  *
784  * @warning: if frame already has been allocated, calling this function will
785  *           leak memory. In addition, undefined behavior can occur in certain
786  *           cases.
787  *
788  * @param frame frame in which to store the new buffers.
789  * @param align Required buffer size alignment. If equal to 0, alignment will be
790  *              chosen automatically for the current CPU. It is highly
791  *              recommended to pass 0 here unless you know what you are doing.
792  *
793  * @return 0 on success, a negative AVERROR on error.
794  */
795 int av_frame_get_buffer(AVFrame *frame, int align);
796
797 /**
798  * Check if the frame data is writable.
799  *
800  * @return A positive value if the frame data is writable (which is true if and
801  * only if each of the underlying buffers has only one reference, namely the one
802  * stored in this frame). Return 0 otherwise.
803  *
804  * If 1 is returned the answer is valid until av_buffer_ref() is called on any
805  * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
806  *
807  * @see av_frame_make_writable(), av_buffer_is_writable()
808  */
809 int av_frame_is_writable(AVFrame *frame);
810
811 /**
812  * Ensure that the frame data is writable, avoiding data copy if possible.
813  *
814  * Do nothing if the frame is writable, allocate new buffers and copy the data
815  * if it is not.
816  *
817  * @return 0 on success, a negative AVERROR on error.
818  *
819  * @see av_frame_is_writable(), av_buffer_is_writable(),
820  * av_buffer_make_writable()
821  */
822 int av_frame_make_writable(AVFrame *frame);
823
824 /**
825  * Copy the frame data from src to dst.
826  *
827  * This function does not allocate anything, dst must be already initialized and
828  * allocated with the same parameters as src.
829  *
830  * This function only copies the frame data (i.e. the contents of the data /
831  * extended data arrays), not any other properties.
832  *
833  * @return >= 0 on success, a negative AVERROR on error.
834  */
835 int av_frame_copy(AVFrame *dst, const AVFrame *src);
836
837 /**
838  * Copy only "metadata" fields from src to dst.
839  *
840  * Metadata for the purpose of this function are those fields that do not affect
841  * the data layout in the buffers.  E.g. pts, sample rate (for audio) or sample
842  * aspect ratio (for video), but not width/height or channel layout.
843  * Side data is also copied.
844  */
845 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
846
847 /**
848  * Get the buffer reference a given data plane is stored in.
849  *
850  * @param plane index of the data plane of interest in frame->extended_data.
851  *
852  * @return the buffer reference that contains the plane or NULL if the input
853  * frame is not valid.
854  */
855 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
856
857 /**
858  * Add a new side data to a frame.
859  *
860  * @param frame a frame to which the side data should be added
861  * @param type type of the added side data
862  * @param size size of the side data
863  *
864  * @return newly added side data on success, NULL on error
865  */
866 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
867                                         enum AVFrameSideDataType type,
868                                         int size);
869
870 /**
871  * Add a new side data to a frame from an existing AVBufferRef
872  *
873  * @param frame a frame to which the side data should be added
874  * @param type  the type of the added side data
875  * @param buf   an AVBufferRef to add as side data. The ownership of
876  *              the reference is transferred to the frame.
877  *
878  * @return newly added side data on success, NULL on error. On failure
879  *         the frame is unchanged and the AVBufferRef remains owned by
880  *         the caller.
881  */
882 AVFrameSideData *av_frame_new_side_data_from_buf(AVFrame *frame,
883                                                  enum AVFrameSideDataType type,
884                                                  AVBufferRef *buf);
885
886 /**
887  * @return a pointer to the side data of a given type on success, NULL if there
888  * is no side data with such type in this frame.
889  */
890 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
891                                         enum AVFrameSideDataType type);
892
893 /**
894  * If side data of the supplied type exists in the frame, free it and remove it
895  * from the frame.
896  */
897 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
898
899
900 /**
901  * Flags for frame cropping.
902  */
903 enum {
904     /**
905      * Apply the maximum possible cropping, even if it requires setting the
906      * AVFrame.data[] entries to unaligned pointers. Passing unaligned data
907      * to FFmpeg API is generally not allowed, and causes undefined behavior
908      * (such as crashes). You can pass unaligned data only to FFmpeg APIs that
909      * are explicitly documented to accept it. Use this flag only if you
910      * absolutely know what you are doing.
911      */
912     AV_FRAME_CROP_UNALIGNED     = 1 << 0,
913 };
914
915 /**
916  * Crop the given video AVFrame according to its crop_left/crop_top/crop_right/
917  * crop_bottom fields. If cropping is successful, the function will adjust the
918  * data pointers and the width/height fields, and set the crop fields to 0.
919  *
920  * In all cases, the cropping boundaries will be rounded to the inherent
921  * alignment of the pixel format. In some cases, such as for opaque hwaccel
922  * formats, the left/top cropping is ignored. The crop fields are set to 0 even
923  * if the cropping was rounded or ignored.
924  *
925  * @param frame the frame which should be cropped
926  * @param flags Some combination of AV_FRAME_CROP_* flags, or 0.
927  *
928  * @return >= 0 on success, a negative AVERROR on error. If the cropping fields
929  * were invalid, AVERROR(ERANGE) is returned, and nothing is changed.
930  */
931 int av_frame_apply_cropping(AVFrame *frame, int flags);
932
933 /**
934  * @return a string identifying the side data type
935  */
936 const char *av_frame_side_data_name(enum AVFrameSideDataType type);
937
938 /**
939  * @}
940  */
941
942 #endif /* AVUTIL_FRAME_H */