xref: /third_party/ffmpeg/libavutil/frame.h

46  * AVFrame is an abstraction for reference-counted raw multimedia data.
51      * The data is the AVPanScan struct defined in libavcodec.
56      * A53 CC bitstream is stored as uint8_t in AVFrameSideData.data.
57      * The number of bytes of CC data is AVFrameSideData.size.
62      * The data is the AVStereo3D struct defined in libavutil/stereo3d.h.
66      * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
71      * The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h.
79      * This side data contains a 3x3 transformation matrix describing an affine
83      * See libavutil/display.h for a detailed description of the data.
87      * Active Format Description data consisting of a single byte as specified
94      * The data is the AVMotionVector struct defined in
111      * This side data must be associated with an audio frame and corresponds to
128      * The data represents the AVSphericalMapping structure defined in
134      * Content light level (based on CTA-861.3). This payload contains data in
140      * The data contains an ICC profile as an opaque octet buffer following the
147      * Timecode which conforms to SMPTE ST 12-1. The data is an array of 4 uint32_t
162      * Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of
173      * User data unregistered metadata associated with a video frame.
175      * The data is stored as uint8_t in AVFrameSideData.data which is 16 bytes of
193      * Dolby Vision RPU raw data, suitable for passing to x265
226  * Structure to hold side data for an AVFrame.
233     uint8_t *data;
242  * When multiple regions are defined in a single side-data block, they
252      * Must be set to the size of this data structure (that is,
296  * This structure describes decoded (raw) audio or video data.
299  * allocates the AVFrame itself, the buffers for the data must be managed
304  * different data (e.g. a single AVFrame to hold frames received from a
309  * The data described by an AVFrame is usually reference counted through the
313  * every single data plane must be contained in one of the buffers in
315  * There may be a single buffer for all the data, or one separate buffer for
330      * it could even point to the end of the image data.
332      * All pointers in data and extended_data must point into one of the
342      * @attention In case of video, the data[] pointers can point to the
343      * end of image data in order to reverse line order, when used in
346     uint8_t *data[AV_NUM_DATA_POINTERS];
352      *   (with data[n] pointing to the end of the data
364      * @note The linesize may be larger than the size of usable data -- there
373      * pointers to the data planes/channels.
375      * For video, this should simply point to data[].
377      * For planar audio, each channel has a separate data pointer, and
379      * For packed audio, there is just one data pointer, and linesize[0]
382      * Note: Both data and extended_data should always be set in a valid frame,
383      * but for planar audio with more channels that can fit in data,
464      * for some private data of the user
500      * Sample rate of the audio data.
506      * Channel layout of the audio data.
514      * AVBuffer references backing the data for this frame. All the pointers in
515      * data and extended_data must point inside one of the buffers in buf or
519      * There may be at most one AVBuffer per data plane, so for video this array
557  * The frame data may be corrupted, e.g. due to decoding errors.
690      * Must not be used to transfer data between libraries.
702      * Channel layout of the audio data.
723  * @note this only allocates the AVFrame itself, not the data buffers. Those
739  * Set up a new reference to the data described by the source frame.
744  * If src is not reference counted, new buffers are allocated and the data is
756  * Create a new frame that references the same data as src.
779  * Allocate new buffer(s) for audio or video data.
786  * This function will fill AVFrame.data and AVFrame.buf arrays and, if
804  * Check if the frame data is writable.
806  * @return A positive value if the frame data is writable (which is true if and
818  * Ensure that the frame data is writable, avoiding data copy if possible.
820  * Do nothing if the frame is writable, allocate new buffers and copy the data
831  * Copy the frame data from src to dst.
836  * This function only copies the frame data (i.e. the contents of the data /
837  * extended data arrays), not any other properties.
847  * the data layout in the buffers.  E.g. pts, sample rate (for audio) or sample
849  * Side data is also copied.
854  * Get the buffer reference a given data plane is stored in.
856  * @param plane index of the data plane of interest in frame->extended_data.
864  * Add a new side data to a frame.
866  * @param frame a frame to which the side data should be added
867  * @param type type of the added side data
868  * @param size size of the side data
870  * @return newly added side data on success, NULL on error
877  * Add a new side data to a frame from an existing AVBufferRef
879  * @param frame a frame to which the side data should be added
880  * @param type  the type of the added side data
881  * @param buf   an AVBufferRef to add as side data. The ownership of
884  * @return newly added side data on success, NULL on error. On failure
893  * @return a pointer to the side data of a given type on success, NULL if there
894  * is no side data with such type in this frame.
900  * Remove and free all side data instances of the given type.
911      * AVFrame.data[] entries to unaligned pointers. Passing unaligned data
913      * (such as crashes). You can pass unaligned data only to FFmpeg APIs that
923  * data pointers and the width/height fields, and set the crop fields to 0.
939  * @return a string identifying the side data type

Indexes created Thu Nov 07 10:32:03 CST 2024