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;
213 AVDictionary *metadata;
218 * Structure describing a single Region Of Interest.
220 * When multiple regions are defined in a single side-data block, they
221 * should be ordered from most to least important - some encoders are only
222 * capable of supporting a limited number of distinct regions, so will have
223 * to truncate the list.
225 * When overlapping regions are defined, the first region containing a given
226 * area of the frame applies.
228 typedef struct AVRegionOfInterest {
230 * Must be set to the size of this data structure (that is,
231 * sizeof(AVRegionOfInterest)).
235 * Distance in pixels from the top edge of the frame to the top and
236 * bottom edges and from the left edge of the frame to the left and
237 * right edges of the rectangle defining this region of interest.
239 * The constraints on a region are encoder dependent, so the region
240 * actually affected may be slightly larger for alignment or other
248 * Quantisation offset.
250 * Must be in the range -1 to +1. A value of zero indicates no quality
251 * change. A negative value asks for better quality (less quantisation),
252 * while a positive value asks for worse quality (greater quantisation).
254 * The range is calibrated so that the extreme values indicate the
255 * largest possible offset - if the rest of the frame is encoded with the
256 * worst possible quality, an offset of -1 indicates that this region
257 * should be encoded with the best possible quality anyway. Intermediate
258 * values are then interpolated in some codec-dependent way.
260 * For example, in 10-bit H.264 the quantisation parameter varies between
261 * -12 and 51. A typical qoffset value of -1/10 therefore indicates that
262 * this region should be encoded with a QP around one-tenth of the full
263 * range better than the rest of the frame. So, if most of the frame
264 * were to be encoded with a QP of around 30, this region would get a QP
265 * of around 24 (an offset of approximately -1/10 * (51 - -12) = -6.3).
266 * An extreme value of -1 would indicate that this region should be
267 * encoded with the best possible quality regardless of the treatment of
268 * the rest of the frame - that is, should be encoded at a QP of -12.
271 } AVRegionOfInterest;
274 * This structure describes decoded (raw) audio or video data.
276 * AVFrame must be allocated using av_frame_alloc(). Note that this only
277 * allocates the AVFrame itself, the buffers for the data must be managed
278 * through other means (see below).
279 * AVFrame must be freed with av_frame_free().
281 * AVFrame is typically allocated once and then reused multiple times to hold
282 * different data (e.g. a single AVFrame to hold frames received from a
283 * decoder). In such a case, av_frame_unref() will free any references held by
284 * the frame and reset it to its original clean state before it
287 * The data described by an AVFrame is usually reference counted through the
288 * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
289 * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
290 * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
291 * every single data plane must be contained in one of the buffers in
292 * AVFrame.buf or AVFrame.extended_buf.
293 * There may be a single buffer for all the data, or one separate buffer for
294 * each plane, or anything in between.
296 * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
297 * to the end with a minor bump.
299 * Fields can be accessed through AVOptions, the name string used, matches the
300 * C structure field name for fields accessible through AVOptions. The AVClass
301 * for AVFrame can be obtained from avcodec_get_frame_class()
303 typedef struct AVFrame {
304 #define AV_NUM_DATA_POINTERS 8
306 * pointer to the picture/channel planes.
307 * This might be different from the first allocated byte
309 * Some decoders access areas outside 0,0 - width,height, please
310 * see avcodec_align_dimensions2(). Some filters and swscale can read
311 * up to 16 bytes beyond the planes, if these filters are to be used,
312 * then 16 extra bytes must be allocated.
314 * NOTE: Except for hwaccel formats, pointers not needed by the format
315 * MUST be set to NULL.
317 uint8_t *data[AV_NUM_DATA_POINTERS];
320 * For video, size in bytes of each picture line.
321 * For audio, size in bytes of each plane.
323 * For audio, only linesize[0] may be set. For planar audio, each channel
324 * plane must be the same size.
326 * For video the linesizes should be multiples of the CPUs alignment
327 * preference, this is 16 or 32 for modern desktop CPUs.
328 * Some code requires such alignment other code can be slower without
329 * correct alignment, for yet other it makes no difference.
331 * @note The linesize may be larger than the size of usable data -- there
332 * may be extra padding present for performance reasons.
334 int linesize[AV_NUM_DATA_POINTERS];
337 * pointers to the data planes/channels.
339 * For video, this should simply point to data[].
341 * For planar audio, each channel has a separate data pointer, and
342 * linesize[0] contains the size of each channel buffer.
343 * For packed audio, there is just one data pointer, and linesize[0]
344 * contains the total size of the buffer for all channels.
346 * Note: Both data and extended_data should always be set in a valid frame,
347 * but for planar audio with more channels that can fit in data,
348 * extended_data must be used in order to access all channels.
350 uint8_t **extended_data;
353 * @name Video dimensions
354 * Video frames only. The coded dimensions (in pixels) of the video frame,
355 * i.e. the size of the rectangle that contains some well-defined values.
357 * @note The part of the frame intended for display/presentation is further
358 * restricted by the @ref cropping "Cropping rectangle".
367 * number of audio samples (per channel) described by this frame
372 * format of the frame, -1 if unknown or unset
373 * Values correspond to enum AVPixelFormat for video frames,
374 * enum AVSampleFormat for audio)
379 * 1 -> keyframe, 0-> not
384 * Picture type of the frame.
386 enum AVPictureType pict_type;
389 * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
391 AVRational sample_aspect_ratio;
394 * Presentation timestamp in time_base units (time when frame should be shown to user).
399 * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
400 * This is also the Presentation time of this AVFrame calculated from
401 * only AVPacket.dts values without pts values.
406 * picture number in bitstream order
408 int coded_picture_number;
410 * picture number in display order
412 int display_picture_number;
415 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
420 * for some private data of the user
425 * When decoding, this signals how much the picture must be delayed.
426 * extra_delay = repeat_pict / (2*fps)
431 * The content of the picture is interlaced.
433 int interlaced_frame;
436 * If the content is interlaced, is top field displayed first.
441 * Tell user application that palette has changed from previous frame.
443 int palette_has_changed;
446 * reordered opaque 64 bits (generally an integer or a double precision float
447 * PTS but can be anything).
448 * The user sets AVCodecContext.reordered_opaque to represent the input at
450 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
451 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
453 int64_t reordered_opaque;
456 * Sample rate of the audio data.
461 * Channel layout of the audio data.
463 uint64_t channel_layout;
466 * AVBuffer references backing the data for this frame. If all elements of
467 * this array are NULL, then this frame is not reference counted. This array
468 * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
469 * also be non-NULL for all j < i.
471 * There may be at most one AVBuffer per data plane, so for video this array
472 * always contains all the references. For planar audio with more than
473 * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
474 * this array. Then the extra AVBufferRef pointers are stored in the
475 * extended_buf array.
477 AVBufferRef *buf[AV_NUM_DATA_POINTERS];
480 * For planar audio which requires more than AV_NUM_DATA_POINTERS
481 * AVBufferRef pointers, this array will hold all the references which
482 * cannot fit into AVFrame.buf.
484 * Note that this is different from AVFrame.extended_data, which always
485 * contains all the pointers. This array only contains the extra pointers,
486 * which cannot fit into AVFrame.buf.
488 * This array is always allocated using av_malloc() by whoever constructs
489 * the frame. It is freed in av_frame_unref().
491 AVBufferRef **extended_buf;
493 * Number of elements in extended_buf.
497 AVFrameSideData **side_data;
501 * @defgroup lavu_frame_flags AV_FRAME_FLAGS
502 * @ingroup lavu_frame
503 * Flags describing additional frame properties.
509 * The frame data may be corrupted, e.g. due to decoding errors.
511 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
513 * A flag to mark the frames which need to be decoded, but shouldn't be output.
515 #define AV_FRAME_FLAG_DISCARD (1 << 2)
521 * Frame flags, a combination of @ref lavu_frame_flags
526 * MPEG vs JPEG YUV range.
527 * - encoding: Set by user
528 * - decoding: Set by libavcodec
530 enum AVColorRange color_range;
532 enum AVColorPrimaries color_primaries;
534 enum AVColorTransferCharacteristic color_trc;
537 * YUV colorspace type.
538 * - encoding: Set by user
539 * - decoding: Set by libavcodec
541 enum AVColorSpace colorspace;
543 enum AVChromaLocation chroma_location;
546 * frame timestamp estimated using various heuristics, in stream time base
548 * - decoding: set by libavcodec, read by user.
550 int64_t best_effort_timestamp;
553 * reordered pos from the last AVPacket that has been input into the decoder
555 * - decoding: Read by user.
560 * duration of the corresponding packet, expressed in
561 * AVStream->time_base units, 0 if unknown.
563 * - decoding: Read by user.
565 int64_t pkt_duration;
569 * - encoding: Set by user.
570 * - decoding: Set by libavcodec.
572 AVDictionary *metadata;
575 * decode error flags of the frame, set to a combination of
576 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
577 * were errors during the decoding.
579 * - decoding: set by libavcodec, read by user.
581 int decode_error_flags;
582 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
583 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
584 #define FF_DECODE_ERROR_CONCEALMENT_ACTIVE 4
585 #define FF_DECODE_ERROR_DECODE_SLICES 8
588 * number of audio channels, only used for audio.
590 * - decoding: Read by user.
595 * size of the corresponding packet containing the compressed
597 * It is set to a negative value if unknown.
599 * - decoding: set by libavcodec, read by user.
604 * For hwaccel-format frames, this should be a reference to the
605 * AVHWFramesContext describing the frame.
607 AVBufferRef *hw_frames_ctx;
610 * AVBufferRef for free use by the API user. FFmpeg will never check the
611 * contents of the buffer ref. FFmpeg calls av_buffer_unref() on it when
612 * the frame is unreferenced. av_frame_copy_props() calls create a new
613 * reference with av_buffer_ref() for the target frame's opaque_ref field.
615 * This is unrelated to the opaque field, although it serves a similar
618 AVBufferRef *opaque_ref;
623 * Video frames only. The number of pixels to discard from the the
624 * top/bottom/left/right border of the frame to obtain the sub-rectangle of
625 * the frame intended for presentation.
637 * AVBufferRef for internal use by a single libav* library.
638 * Must not be used to transfer data between libraries.
639 * Has to be NULL when ownership of the frame leaves the respective library.
641 * Code outside the FFmpeg libs should never check or change the contents of the buffer ref.
643 * FFmpeg calls av_buffer_unref() on it when the frame is unreferenced.
644 * av_frame_copy_props() calls create a new reference with av_buffer_ref()
645 * for the target frame's private_ref field.
647 AVBufferRef *private_ref;
651 #if FF_API_COLORSPACE_NAME
653 * Get the name of a colorspace.
654 * @return a static string identifying the colorspace; can be NULL.
655 * @deprecated use av_color_space_name()
658 const char *av_get_colorspace_name(enum AVColorSpace val);
661 * Allocate an AVFrame and set its fields to default values. The resulting
662 * struct must be freed using av_frame_free().
664 * @return An AVFrame filled with default values or NULL on failure.
666 * @note this only allocates the AVFrame itself, not the data buffers. Those
667 * must be allocated through other means, e.g. with av_frame_get_buffer() or
670 AVFrame *av_frame_alloc(void);
673 * Free the frame and any dynamically allocated objects in it,
674 * e.g. extended_data. If the frame is reference counted, it will be
675 * unreferenced first.
677 * @param frame frame to be freed. The pointer will be set to NULL.
679 void av_frame_free(AVFrame **frame);
682 * Set up a new reference to the data described by the source frame.
684 * Copy frame properties from src to dst and create a new reference for each
685 * AVBufferRef from src.
687 * If src is not reference counted, new buffers are allocated and the data is
690 * @warning: dst MUST have been either unreferenced with av_frame_unref(dst),
691 * or newly allocated with av_frame_alloc() before calling this
692 * function, or undefined behavior will occur.
694 * @return 0 on success, a negative AVERROR on error
696 int av_frame_ref(AVFrame *dst, const AVFrame *src);
699 * Create a new frame that references the same data as src.
701 * This is a shortcut for av_frame_alloc()+av_frame_ref().
703 * @return newly created AVFrame on success, NULL on error.
705 AVFrame *av_frame_clone(const AVFrame *src);
708 * Unreference all the buffers referenced by frame and reset the frame fields.
710 void av_frame_unref(AVFrame *frame);
713 * Move everything contained in src to dst and reset src.
715 * @warning: dst is not unreferenced, but directly overwritten without reading
716 * or deallocating its contents. Call av_frame_unref(dst) manually
717 * before calling this function to ensure that no memory is leaked.
719 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
722 * Allocate new buffer(s) for audio or video data.
724 * The following fields must be set on frame before calling this function:
725 * - format (pixel format for video, sample format for audio)
726 * - width and height for video
727 * - nb_samples and channel_layout for audio
729 * This function will fill AVFrame.data and AVFrame.buf arrays and, if
730 * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
731 * For planar formats, one buffer will be allocated for each plane.
733 * @warning: if frame already has been allocated, calling this function will
734 * leak memory. In addition, undefined behavior can occur in certain
737 * @param frame frame in which to store the new buffers.
738 * @param align Required buffer size alignment. If equal to 0, alignment will be
739 * chosen automatically for the current CPU. It is highly
740 * recommended to pass 0 here unless you know what you are doing.
742 * @return 0 on success, a negative AVERROR on error.
744 int av_frame_get_buffer(AVFrame *frame, int align);
747 * Check if the frame data is writable.
749 * @return A positive value if the frame data is writable (which is true if and
750 * only if each of the underlying buffers has only one reference, namely the one
751 * stored in this frame). Return 0 otherwise.
753 * If 1 is returned the answer is valid until av_buffer_ref() is called on any
754 * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
756 * @see av_frame_make_writable(), av_buffer_is_writable()
758 int av_frame_is_writable(AVFrame *frame);
761 * Ensure that the frame data is writable, avoiding data copy if possible.
763 * Do nothing if the frame is writable, allocate new buffers and copy the data
766 * @return 0 on success, a negative AVERROR on error.
768 * @see av_frame_is_writable(), av_buffer_is_writable(),
769 * av_buffer_make_writable()
771 int av_frame_make_writable(AVFrame *frame);
774 * Copy the frame data from src to dst.
776 * This function does not allocate anything, dst must be already initialized and
777 * allocated with the same parameters as src.
779 * This function only copies the frame data (i.e. the contents of the data /
780 * extended data arrays), not any other properties.
782 * @return >= 0 on success, a negative AVERROR on error.
784 int av_frame_copy(AVFrame *dst, const AVFrame *src);
787 * Copy only "metadata" fields from src to dst.
789 * Metadata for the purpose of this function are those fields that do not affect
790 * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample
791 * aspect ratio (for video), but not width/height or channel layout.
792 * Side data is also copied.
794 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
797 * Get the buffer reference a given data plane is stored in.
799 * @param plane index of the data plane of interest in frame->extended_data.
801 * @return the buffer reference that contains the plane or NULL if the input
802 * frame is not valid.
804 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
807 * Add a new side data to a frame.
809 * @param frame a frame to which the side data should be added
810 * @param type type of the added side data
811 * @param size size of the side data
813 * @return newly added side data on success, NULL on error
815 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
816 enum AVFrameSideDataType type,
820 * Add a new side data to a frame from an existing AVBufferRef
822 * @param frame a frame to which the side data should be added
823 * @param type the type of the added side data
824 * @param buf an AVBufferRef to add as side data. The ownership of
825 * the reference is transferred to the frame.
827 * @return newly added side data on success, NULL on error. On failure
828 * the frame is unchanged and the AVBufferRef remains owned by
831 AVFrameSideData *av_frame_new_side_data_from_buf(AVFrame *frame,
832 enum AVFrameSideDataType type,
836 * @return a pointer to the side data of a given type on success, NULL if there
837 * is no side data with such type in this frame.
839 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
840 enum AVFrameSideDataType type);
843 * Remove and free all side data instances of the given type.
845 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
849 * Flags for frame cropping.
853 * Apply the maximum possible cropping, even if it requires setting the
854 * AVFrame.data[] entries to unaligned pointers. Passing unaligned data
855 * to FFmpeg API is generally not allowed, and causes undefined behavior
856 * (such as crashes). You can pass unaligned data only to FFmpeg APIs that
857 * are explicitly documented to accept it. Use this flag only if you
858 * absolutely know what you are doing.
860 AV_FRAME_CROP_UNALIGNED = 1 << 0,
864 * Crop the given video AVFrame according to its crop_left/crop_top/crop_right/
865 * crop_bottom fields. If cropping is successful, the function will adjust the
866 * data pointers and the width/height fields, and set the crop fields to 0.
868 * In all cases, the cropping boundaries will be rounded to the inherent
869 * alignment of the pixel format. In some cases, such as for opaque hwaccel
870 * formats, the left/top cropping is ignored. The crop fields are set to 0 even
871 * if the cropping was rounded or ignored.
873 * @param frame the frame which should be cropped
874 * @param flags Some combination of AV_FRAME_CROP_* flags, or 0.
876 * @return >= 0 on success, a negative AVERROR on error. If the cropping fields
877 * were invalid, AVERROR(ERANGE) is returned, and nothing is changed.
879 int av_frame_apply_cropping(AVFrame *frame, int flags);
882 * @return a string identifying the side data type
884 const char *av_frame_side_data_name(enum AVFrameSideDataType type);
890 #endif /* AVUTIL_FRAME_H */