2 * This file is part of FFmpeg.
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.
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.
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
22 * reference-counted frame API
25 #ifndef AVUTIL_FRAME_H
26 #define AVUTIL_FRAME_H
35 #include "samplefmt.h"
41 * @defgroup lavu_frame AVFrame
45 * AVFrame is an abstraction for reference-counted raw multimedia data.
48 enum AVFrameSideDataType {
50 * The data is the AVPanScan struct defined in libavcodec.
52 AV_FRAME_DATA_PANSCAN,
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.
60 * Stereoscopic 3d metadata.
61 * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
63 AV_FRAME_DATA_STEREO3D,
65 * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
67 AV_FRAME_DATA_MATRIXENCODING,
69 * Metadata relevant to a downmix procedure.
70 * The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h.
72 AV_FRAME_DATA_DOWNMIX_INFO,
74 * ReplayGain information in the form of the AVReplayGain struct.
76 AV_FRAME_DATA_REPLAYGAIN,
78 * This side data contains a 3x3 transformation matrix describing an affine
79 * transformation that needs to be applied to the frame for correct
82 * See libavutil/display.h for a detailed description of the data.
84 AV_FRAME_DATA_DISPLAYMATRIX,
86 * Active Format Description data consisting of a single byte as specified
87 * in ETSI TS 101 154 using AVActiveFormatDescription enum.
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.
96 AV_FRAME_DATA_MOTION_VECTORS,
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.
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)
108 AV_FRAME_DATA_SKIP_SAMPLES,
110 * This side data must be associated with an audio frame and corresponds to
111 * enum AVAudioServiceType defined in avcodec.h.
113 AV_FRAME_DATA_AUDIO_SERVICE_TYPE,
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.
119 AV_FRAME_DATA_MASTERING_DISPLAY_METADATA,
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.
124 AV_FRAME_DATA_GOP_TIMECODE,
127 * The data represents the AVSphericalMapping structure defined in
128 * libavutil/spherical.h.
130 AV_FRAME_DATA_SPHERICAL,
133 * Content light level (based on CTA-861.3). This payload contains data in
134 * the form of the AVContentLightMetadata struct.
136 AV_FRAME_DATA_CONTENT_LIGHT_LEVEL,
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".
143 AV_FRAME_DATA_ICC_PROFILE,
146 * Timecode which conforms to SMPTE ST 12-1. The data is an array of 4 uint32_t
147 * where the first uint32_t describes how many (1-3) of the other timecodes are used.
148 * The timecode format is described in the documentation of av_timecode_get_smpte_from_framenum()
149 * function in libavutil/timecode.h.
151 AV_FRAME_DATA_S12M_TIMECODE,
154 * HDR dynamic metadata associated with a video frame. The payload is
155 * an AVDynamicHDRPlus type and contains information for color
156 * volume transform - application 4 of SMPTE 2094-40:2016 standard.
158 AV_FRAME_DATA_DYNAMIC_HDR_PLUS,
161 * Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of
162 * array element is implied by AVFrameSideData.size / AVRegionOfInterest.self_size.
164 AV_FRAME_DATA_REGIONS_OF_INTEREST,
167 * Encoding parameters for a video frame, as described by AVVideoEncParams.
169 AV_FRAME_DATA_VIDEO_ENC_PARAMS,
172 * User data unregistered metadata associated with a video frame.
173 * This is the H.26[45] UDU SEI message, and shouldn't be used for any other purpose
174 * The data is stored as uint8_t in AVFrameSideData.data which is 16 bytes of
175 * uuid_iso_iec_11578 followed by AVFrameSideData.size - 16 bytes of user_data_payload_byte.
177 AV_FRAME_DATA_SEI_UNREGISTERED,
180 * Film grain parameters for a frame, described by AVFilmGrainParams.
181 * Must be present for every frame which should have film grain applied.
183 AV_FRAME_DATA_FILM_GRAIN_PARAMS,
186 * Bounding boxes for object detection and classification,
187 * as described by AVDetectionBBoxHeader.
189 AV_FRAME_DATA_DETECTION_BBOXES,
192 enum AVActiveFormatDescription {
197 AV_AFD_4_3_SP_14_9 = 13,
198 AV_AFD_16_9_SP_14_9 = 14,
204 * Structure to hold side data for an AVFrame.
206 * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
207 * to the end with a minor bump.
209 typedef struct AVFrameSideData {
210 enum AVFrameSideDataType type;
212 #if FF_API_BUFFER_SIZE_T
217 AVDictionary *metadata;
222 * Structure describing a single Region Of Interest.
224 * When multiple regions are defined in a single side-data block, they
225 * should be ordered from most to least important - some encoders are only
226 * capable of supporting a limited number of distinct regions, so will have
227 * to truncate the list.
229 * When overlapping regions are defined, the first region containing a given
230 * area of the frame applies.
232 typedef struct AVRegionOfInterest {
234 * Must be set to the size of this data structure (that is,
235 * sizeof(AVRegionOfInterest)).
239 * Distance in pixels from the top edge of the frame to the top and
240 * bottom edges and from the left edge of the frame to the left and
241 * right edges of the rectangle defining this region of interest.
243 * The constraints on a region are encoder dependent, so the region
244 * actually affected may be slightly larger for alignment or other
252 * Quantisation offset.
254 * Must be in the range -1 to +1. A value of zero indicates no quality
255 * change. A negative value asks for better quality (less quantisation),
256 * while a positive value asks for worse quality (greater quantisation).
258 * The range is calibrated so that the extreme values indicate the
259 * largest possible offset - if the rest of the frame is encoded with the
260 * worst possible quality, an offset of -1 indicates that this region
261 * should be encoded with the best possible quality anyway. Intermediate
262 * values are then interpolated in some codec-dependent way.
264 * For example, in 10-bit H.264 the quantisation parameter varies between
265 * -12 and 51. A typical qoffset value of -1/10 therefore indicates that
266 * this region should be encoded with a QP around one-tenth of the full
267 * range better than the rest of the frame. So, if most of the frame
268 * were to be encoded with a QP of around 30, this region would get a QP
269 * of around 24 (an offset of approximately -1/10 * (51 - -12) = -6.3).
270 * An extreme value of -1 would indicate that this region should be
271 * encoded with the best possible quality regardless of the treatment of
272 * the rest of the frame - that is, should be encoded at a QP of -12.
275 } AVRegionOfInterest;
278 * This structure describes decoded (raw) audio or video data.
280 * AVFrame must be allocated using av_frame_alloc(). Note that this only
281 * allocates the AVFrame itself, the buffers for the data must be managed
282 * through other means (see below).
283 * AVFrame must be freed with av_frame_free().
285 * AVFrame is typically allocated once and then reused multiple times to hold
286 * different data (e.g. a single AVFrame to hold frames received from a
287 * decoder). In such a case, av_frame_unref() will free any references held by
288 * the frame and reset it to its original clean state before it
291 * The data described by an AVFrame is usually reference counted through the
292 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
293 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
294 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
295 * every single data plane must be contained in one of the buffers in
296 * AVFrame.buf or AVFrame.extended_buf.
297 * There may be a single buffer for all the data, or one separate buffer for
298 * each plane, or anything in between.
300 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
301 * to the end with a minor bump.
303 * Fields can be accessed through AVOptions, the name string used, matches the
304 * C structure field name for fields accessible through AVOptions. The AVClass
305 * for AVFrame can be obtained from avcodec_get_frame_class()
307 typedef struct AVFrame {
308 #define AV_NUM_DATA_POINTERS 8
310 * pointer to the picture/channel planes.
311 * This might be different from the first allocated byte
313 * Some decoders access areas outside 0,0 - width,height, please
314 * see avcodec_align_dimensions2(). Some filters and swscale can read
315 * up to 16 bytes beyond the planes, if these filters are to be used,
316 * then 16 extra bytes must be allocated.
318 * NOTE: Except for hwaccel formats, pointers not needed by the format
319 * MUST be set to NULL.
321 uint8_t *data[AV_NUM_DATA_POINTERS];
324 * For video, size in bytes of each picture line.
325 * For audio, size in bytes of each plane.
327 * For audio, only linesize[0] may be set. For planar audio, each channel
328 * plane must be the same size.
330 * For video the linesizes should be multiples of the CPUs alignment
331 * preference, this is 16 or 32 for modern desktop CPUs.
332 * Some code requires such alignment other code can be slower without
333 * correct alignment, for yet other it makes no difference.
335 * @note The linesize may be larger than the size of usable data -- there
336 * may be extra padding present for performance reasons.
338 int linesize[AV_NUM_DATA_POINTERS];
341 * pointers to the data planes/channels.
343 * For video, this should simply point to data[].
345 * For planar audio, each channel has a separate data pointer, and
346 * linesize[0] contains the size of each channel buffer.
347 * For packed audio, there is just one data pointer, and linesize[0]
348 * contains the total size of the buffer for all channels.
350 * Note: Both data and extended_data should always be set in a valid frame,
351 * but for planar audio with more channels that can fit in data,
352 * extended_data must be used in order to access all channels.
354 uint8_t **extended_data;
357 * @name Video dimensions
358 * Video frames only. The coded dimensions (in pixels) of the video frame,
359 * i.e. the size of the rectangle that contains some well-defined values.
361 * @note The part of the frame intended for display/presentation is further
362 * restricted by the @ref cropping "Cropping rectangle".
371 * number of audio samples (per channel) described by this frame
376 * format of the frame, -1 if unknown or unset
377 * Values correspond to enum AVPixelFormat for video frames,
378 * enum AVSampleFormat for audio)
383 * 1 -> keyframe, 0-> not
388 * Picture type of the frame.
390 enum AVPictureType pict_type;
393 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
395 AVRational sample_aspect_ratio;
398 * Presentation timestamp in time_base units (time when frame should be shown to user).
404 * PTS copied from the AVPacket that was decoded to produce this frame.
405 * @deprecated use the pts field instead
412 * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
413 * This is also the Presentation time of this AVFrame calculated from
414 * only AVPacket.dts values without pts values.
419 * picture number in bitstream order
421 int coded_picture_number;
423 * picture number in display order
425 int display_picture_number;
428 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
433 * for some private data of the user
438 * When decoding, this signals how much the picture must be delayed.
439 * extra_delay = repeat_pict / (2*fps)
444 * The content of the picture is interlaced.
446 int interlaced_frame;
449 * If the content is interlaced, is top field displayed first.
454 * Tell user application that palette has changed from previous frame.
456 int palette_has_changed;
459 * reordered opaque 64 bits (generally an integer or a double precision float
460 * PTS but can be anything).
461 * The user sets AVCodecContext.reordered_opaque to represent the input at
463 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
464 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
466 int64_t reordered_opaque;
469 * Sample rate of the audio data.
474 * Channel layout of the audio data.
476 uint64_t channel_layout;
479 * AVBuffer references backing the data for this frame. If all elements of
480 * this array are NULL, then this frame is not reference counted. This array
481 * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
482 * also be non-NULL for all j < i.
484 * There may be at most one AVBuffer per data plane, so for video this array
485 * always contains all the references. For planar audio with more than
486 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
487 * this array. Then the extra AVBufferRef pointers are stored in the
488 * extended_buf array.
490 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
493 * For planar audio which requires more than AV_NUM_DATA_POINTERS
494 * AVBufferRef pointers, this array will hold all the references which
495 * cannot fit into AVFrame.buf.
497 * Note that this is different from AVFrame.extended_data, which always
498 * contains all the pointers. This array only contains the extra pointers,
499 * which cannot fit into AVFrame.buf.
501 * This array is always allocated using av_malloc() by whoever constructs
502 * the frame. It is freed in av_frame_unref().
504 AVBufferRef **extended_buf;
506 * Number of elements in extended_buf.
510 AVFrameSideData **side_data;
514 * @defgroup lavu_frame_flags AV_FRAME_FLAGS
515 * @ingroup lavu_frame
516 * Flags describing additional frame properties.
522 * The frame data may be corrupted, e.g. due to decoding errors.
524 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
526 * A flag to mark the frames which need to be decoded, but shouldn't be output.
528 #define AV_FRAME_FLAG_DISCARD (1 << 2)
534 * Frame flags, a combination of @ref lavu_frame_flags
539 * MPEG vs JPEG YUV range.
540 * - encoding: Set by user
541 * - decoding: Set by libavcodec
543 enum AVColorRange color_range;
545 enum AVColorPrimaries color_primaries;
547 enum AVColorTransferCharacteristic color_trc;
550 * YUV colorspace type.
551 * - encoding: Set by user
552 * - decoding: Set by libavcodec
554 enum AVColorSpace colorspace;
556 enum AVChromaLocation chroma_location;
559 * frame timestamp estimated using various heuristics, in stream time base
561 * - decoding: set by libavcodec, read by user.
563 int64_t best_effort_timestamp;
566 * reordered pos from the last AVPacket that has been input into the decoder
568 * - decoding: Read by user.
573 * duration of the corresponding packet, expressed in
574 * AVStream->time_base units, 0 if unknown.
576 * - decoding: Read by user.
578 int64_t pkt_duration;
582 * - encoding: Set by user.
583 * - decoding: Set by libavcodec.
585 AVDictionary *metadata;
588 * decode error flags of the frame, set to a combination of
589 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
590 * were errors during the decoding.
592 * - decoding: set by libavcodec, read by user.
594 int decode_error_flags;
595 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
596 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
597 #define FF_DECODE_ERROR_CONCEALMENT_ACTIVE 4
598 #define FF_DECODE_ERROR_DECODE_SLICES 8
601 * number of audio channels, only used for audio.
603 * - decoding: Read by user.
608 * size of the corresponding packet containing the compressed
610 * It is set to a negative value if unknown.
612 * - decoding: set by libavcodec, read by user.
617 * For hwaccel-format frames, this should be a reference to the
618 * AVHWFramesContext describing the frame.
620 AVBufferRef *hw_frames_ctx;
623 * AVBufferRef for free use by the API user. FFmpeg will never check the
624 * contents of the buffer ref. FFmpeg calls av_buffer_unref() on it when
625 * the frame is unreferenced. av_frame_copy_props() calls create a new
626 * reference with av_buffer_ref() for the target frame's opaque_ref field.
628 * This is unrelated to the opaque field, although it serves a similar
631 AVBufferRef *opaque_ref;
636 * Video frames only. The number of pixels to discard from the the
637 * top/bottom/left/right border of the frame to obtain the sub-rectangle of
638 * the frame intended for presentation.
650 * AVBufferRef for internal use by a single libav* library.
651 * Must not be used to transfer data between libraries.
652 * Has to be NULL when ownership of the frame leaves the respective library.
654 * Code outside the FFmpeg libs should never check or change the contents of the buffer ref.
656 * FFmpeg calls av_buffer_unref() on it when the frame is unreferenced.
657 * av_frame_copy_props() calls create a new reference with av_buffer_ref()
658 * for the target frame's private_ref field.
660 AVBufferRef *private_ref;
663 #if FF_API_FRAME_GET_SET
665 * Accessors for some AVFrame fields. These used to be provided for ABI
666 * compatibility, and do not need to be used anymore.
669 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
671 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
673 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
675 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
677 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
679 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
681 int64_t av_frame_get_channel_layout (const AVFrame *frame);
683 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
685 int av_frame_get_channels (const AVFrame *frame);
687 void av_frame_set_channels (AVFrame *frame, int val);
689 int av_frame_get_sample_rate (const AVFrame *frame);
691 void av_frame_set_sample_rate (AVFrame *frame, int val);
693 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
695 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
697 int av_frame_get_decode_error_flags (const AVFrame *frame);
699 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
701 int av_frame_get_pkt_size(const AVFrame *frame);
703 void av_frame_set_pkt_size(AVFrame *frame, int val);
705 enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame);
707 void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val);
709 enum AVColorRange av_frame_get_color_range(const AVFrame *frame);
711 void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val);
714 #if FF_API_COLORSPACE_NAME
716 * Get the name of a colorspace.
717 * @return a static string identifying the colorspace; can be NULL.
718 * @deprecated use av_color_space_name()
721 const char *av_get_colorspace_name(enum AVColorSpace val);
724 * Allocate an AVFrame and set its fields to default values. The resulting
725 * struct must be freed using av_frame_free().
727 * @return An AVFrame filled with default values or NULL on failure.
729 * @note this only allocates the AVFrame itself, not the data buffers. Those
730 * must be allocated through other means, e.g. with av_frame_get_buffer() or
733 AVFrame *av_frame_alloc(void);
736 * Free the frame and any dynamically allocated objects in it,
737 * e.g. extended_data. If the frame is reference counted, it will be
738 * unreferenced first.
740 * @param frame frame to be freed. The pointer will be set to NULL.
742 void av_frame_free(AVFrame **frame);
745 * Set up a new reference to the data described by the source frame.
747 * Copy frame properties from src to dst and create a new reference for each
748 * AVBufferRef from src.
750 * If src is not reference counted, new buffers are allocated and the data is
753 * @warning: dst MUST have been either unreferenced with av_frame_unref(dst),
754 * or newly allocated with av_frame_alloc() before calling this
755 * function, or undefined behavior will occur.
757 * @return 0 on success, a negative AVERROR on error
759 int av_frame_ref(AVFrame *dst, const AVFrame *src);
762 * Create a new frame that references the same data as src.
764 * This is a shortcut for av_frame_alloc()+av_frame_ref().
766 * @return newly created AVFrame on success, NULL on error.
768 AVFrame *av_frame_clone(const AVFrame *src);
771 * Unreference all the buffers referenced by frame and reset the frame fields.
773 void av_frame_unref(AVFrame *frame);
776 * Move everything contained in src to dst and reset src.
778 * @warning: dst is not unreferenced, but directly overwritten without reading
779 * or deallocating its contents. Call av_frame_unref(dst) manually
780 * before calling this function to ensure that no memory is leaked.
782 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
785 * Allocate new buffer(s) for audio or video data.
787 * The following fields must be set on frame before calling this function:
788 * - format (pixel format for video, sample format for audio)
789 * - width and height for video
790 * - nb_samples and channel_layout for audio
792 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
793 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
794 * For planar formats, one buffer will be allocated for each plane.
796 * @warning: if frame already has been allocated, calling this function will
797 * leak memory. In addition, undefined behavior can occur in certain
800 * @param frame frame in which to store the new buffers.
801 * @param align Required buffer size alignment. If equal to 0, alignment will be
802 * chosen automatically for the current CPU. It is highly
803 * recommended to pass 0 here unless you know what you are doing.
805 * @return 0 on success, a negative AVERROR on error.
807 int av_frame_get_buffer(AVFrame *frame, int align);
810 * Check if the frame data is writable.
812 * @return A positive value if the frame data is writable (which is true if and
813 * only if each of the underlying buffers has only one reference, namely the one
814 * stored in this frame). Return 0 otherwise.
816 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
817 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
819 * @see av_frame_make_writable(), av_buffer_is_writable()
821 int av_frame_is_writable(AVFrame *frame);
824 * Ensure that the frame data is writable, avoiding data copy if possible.
826 * Do nothing if the frame is writable, allocate new buffers and copy the data
829 * @return 0 on success, a negative AVERROR on error.
831 * @see av_frame_is_writable(), av_buffer_is_writable(),
832 * av_buffer_make_writable()
834 int av_frame_make_writable(AVFrame *frame);
837 * Copy the frame data from src to dst.
839 * This function does not allocate anything, dst must be already initialized and
840 * allocated with the same parameters as src.
842 * This function only copies the frame data (i.e. the contents of the data /
843 * extended data arrays), not any other properties.
845 * @return >= 0 on success, a negative AVERROR on error.
847 int av_frame_copy(AVFrame *dst, const AVFrame *src);
850 * Copy only "metadata" fields from src to dst.
852 * Metadata for the purpose of this function are those fields that do not affect
853 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
854 * aspect ratio (for video), but not width/height or channel layout.
855 * Side data is also copied.
857 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
860 * Get the buffer reference a given data plane is stored in.
862 * @param plane index of the data plane of interest in frame->extended_data.
864 * @return the buffer reference that contains the plane or NULL if the input
865 * frame is not valid.
867 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
870 * Add a new side data to a frame.
872 * @param frame a frame to which the side data should be added
873 * @param type type of the added side data
874 * @param size size of the side data
876 * @return newly added side data on success, NULL on error
878 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
879 enum AVFrameSideDataType type,
880 #if FF_API_BUFFER_SIZE_T
887 * Add a new side data to a frame from an existing AVBufferRef
889 * @param frame a frame to which the side data should be added
890 * @param type the type of the added side data
891 * @param buf an AVBufferRef to add as side data. The ownership of
892 * the reference is transferred to the frame.
894 * @return newly added side data on success, NULL on error. On failure
895 * the frame is unchanged and the AVBufferRef remains owned by
898 AVFrameSideData *av_frame_new_side_data_from_buf(AVFrame *frame,
899 enum AVFrameSideDataType type,
903 * @return a pointer to the side data of a given type on success, NULL if there
904 * is no side data with such type in this frame.
906 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
907 enum AVFrameSideDataType type);
910 * Remove and free all side data instances of the given type.
912 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
916 * Flags for frame cropping.
920 * Apply the maximum possible cropping, even if it requires setting the
921 * AVFrame.data[] entries to unaligned pointers. Passing unaligned data
922 * to FFmpeg API is generally not allowed, and causes undefined behavior
923 * (such as crashes). You can pass unaligned data only to FFmpeg APIs that
924 * are explicitly documented to accept it. Use this flag only if you
925 * absolutely know what you are doing.
927 AV_FRAME_CROP_UNALIGNED = 1 << 0,
931 * Crop the given video AVFrame according to its crop_left/crop_top/crop_right/
932 * crop_bottom fields. If cropping is successful, the function will adjust the
933 * data pointers and the width/height fields, and set the crop fields to 0.
935 * In all cases, the cropping boundaries will be rounded to the inherent
936 * alignment of the pixel format. In some cases, such as for opaque hwaccel
937 * formats, the left/top cropping is ignored. The crop fields are set to 0 even
938 * if the cropping was rounded or ignored.
940 * @param frame the frame which should be cropped
941 * @param flags Some combination of AV_FRAME_CROP_* flags, or 0.
943 * @return >= 0 on success, a negative AVERROR on error. If the cropping fields
944 * were invalid, AVERROR(ERANGE) is returned, and nothing is changed.
946 int av_frame_apply_cropping(AVFrame *frame, int flags);
949 * @return a string identifying the side data type
951 const char *av_frame_side_data_name(enum AVFrameSideDataType type);
957 #endif /* AVUTIL_FRAME_H */