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