avutil/frame: Add some very basic documentation for AVFrameSideData
[ffmpeg.git] / libavutil / frame.h
1 /*
2  *
3  * This file is part of FFmpeg.
4  *
5  * FFmpeg is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * FFmpeg is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with FFmpeg; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19
20 /**
21  * @file
22  * @ingroup lavu_frame
23  * reference-counted frame API
24  */
25
26 #ifndef AVUTIL_FRAME_H
27 #define AVUTIL_FRAME_H
28
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     /**
111      * This side data must be associated with an audio frame and corresponds to
112      * enum AVAudioServiceType defined in avcodec.h.
113      */
114     AV_FRAME_DATA_AUDIO_SERVICE_TYPE,
115 };
116
117 enum AVActiveFormatDescription {
118     AV_AFD_SAME         = 8,
119     AV_AFD_4_3          = 9,
120     AV_AFD_16_9         = 10,
121     AV_AFD_14_9         = 11,
122     AV_AFD_4_3_SP_14_9  = 13,
123     AV_AFD_16_9_SP_14_9 = 14,
124     AV_AFD_SP_4_3       = 15,
125 };
126
127
128 /**
129  * Structure to hold side data for an AVFrame.
130  *
131  * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
132  * to the end with a minor bump.
133  */
134 typedef struct AVFrameSideData {
135     enum AVFrameSideDataType type;
136     uint8_t *data;
137     int      size;
138     AVDictionary *metadata;
139 } AVFrameSideData;
140
141 /**
142  * This structure describes decoded (raw) audio or video data.
143  *
144  * AVFrame must be allocated using av_frame_alloc(). Note that this only
145  * allocates the AVFrame itself, the buffers for the data must be managed
146  * through other means (see below).
147  * AVFrame must be freed with av_frame_free().
148  *
149  * AVFrame is typically allocated once and then reused multiple times to hold
150  * different data (e.g. a single AVFrame to hold frames received from a
151  * decoder). In such a case, av_frame_unref() will free any references held by
152  * the frame and reset it to its original clean state before it
153  * is reused again.
154  *
155  * The data described by an AVFrame is usually reference counted through the
156  * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
157  * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
158  * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
159  * every single data plane must be contained in one of the buffers in
160  * AVFrame.buf or AVFrame.extended_buf.
161  * There may be a single buffer for all the data, or one separate buffer for
162  * each plane, or anything in between.
163  *
164  * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
165  * to the end with a minor bump.
166  * Similarly fields that are marked as to be only accessed by
167  * av_opt_ptr() can be reordered. This allows 2 forks to add fields
168  * without breaking compatibility with each other.
169  */
170 typedef struct AVFrame {
171 #define AV_NUM_DATA_POINTERS 8
172     /**
173      * pointer to the picture/channel planes.
174      * This might be different from the first allocated byte
175      *
176      * Some decoders access areas outside 0,0 - width,height, please
177      * see avcodec_align_dimensions2(). Some filters and swscale can read
178      * up to 16 bytes beyond the planes, if these filters are to be used,
179      * then 16 extra bytes must be allocated.
180      */
181     uint8_t *data[AV_NUM_DATA_POINTERS];
182
183     /**
184      * For video, size in bytes of each picture line.
185      * For audio, size in bytes of each plane.
186      *
187      * For audio, only linesize[0] may be set. For planar audio, each channel
188      * plane must be the same size.
189      *
190      * For video the linesizes should be multiples of the CPUs alignment
191      * preference, this is 16 or 32 for modern desktop CPUs.
192      * Some code requires such alignment other code can be slower without
193      * correct alignment, for yet other it makes no difference.
194      *
195      * @note The linesize may be larger than the size of usable data -- there
196      * may be extra padding present for performance reasons.
197      */
198     int linesize[AV_NUM_DATA_POINTERS];
199
200     /**
201      * pointers to the data planes/channels.
202      *
203      * For video, this should simply point to data[].
204      *
205      * For planar audio, each channel has a separate data pointer, and
206      * linesize[0] contains the size of each channel buffer.
207      * For packed audio, there is just one data pointer, and linesize[0]
208      * contains the total size of the buffer for all channels.
209      *
210      * Note: Both data and extended_data should always be set in a valid frame,
211      * but for planar audio with more channels that can fit in data,
212      * extended_data must be used in order to access all channels.
213      */
214     uint8_t **extended_data;
215
216     /**
217      * width and height of the video frame
218      */
219     int width, height;
220
221     /**
222      * number of audio samples (per channel) described by this frame
223      */
224     int nb_samples;
225
226     /**
227      * format of the frame, -1 if unknown or unset
228      * Values correspond to enum AVPixelFormat for video frames,
229      * enum AVSampleFormat for audio)
230      */
231     int format;
232
233     /**
234      * 1 -> keyframe, 0-> not
235      */
236     int key_frame;
237
238     /**
239      * Picture type of the frame.
240      */
241     enum AVPictureType pict_type;
242
243 #if FF_API_AVFRAME_LAVC
244     attribute_deprecated
245     uint8_t *base[AV_NUM_DATA_POINTERS];
246 #endif
247
248     /**
249      * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
250      */
251     AVRational sample_aspect_ratio;
252
253     /**
254      * Presentation timestamp in time_base units (time when frame should be shown to user).
255      */
256     int64_t pts;
257
258     /**
259      * PTS copied from the AVPacket that was decoded to produce this frame.
260      */
261     int64_t pkt_pts;
262
263     /**
264      * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
265      * This is also the Presentation time of this AVFrame calculated from
266      * only AVPacket.dts values without pts values.
267      */
268     int64_t pkt_dts;
269
270     /**
271      * picture number in bitstream order
272      */
273     int coded_picture_number;
274     /**
275      * picture number in display order
276      */
277     int display_picture_number;
278
279     /**
280      * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
281      */
282     int quality;
283
284 #if FF_API_AVFRAME_LAVC
285     attribute_deprecated
286     int reference;
287
288     /**
289      * QP table
290      */
291     attribute_deprecated
292     int8_t *qscale_table;
293     /**
294      * QP store stride
295      */
296     attribute_deprecated
297     int qstride;
298
299     attribute_deprecated
300     int qscale_type;
301
302     /**
303      * mbskip_table[mb]>=1 if MB didn't change
304      * stride= mb_width = (width+15)>>4
305      */
306     attribute_deprecated
307     uint8_t *mbskip_table;
308
309     /**
310      * motion vector table
311      * @code
312      * example:
313      * int mv_sample_log2= 4 - motion_subsample_log2;
314      * int mb_width= (width+15)>>4;
315      * int mv_stride= (mb_width << mv_sample_log2) + 1;
316      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
317      * @endcode
318      */
319     int16_t (*motion_val[2])[2];
320
321     /**
322      * macroblock type table
323      * mb_type_base + mb_width + 2
324      */
325     attribute_deprecated
326     uint32_t *mb_type;
327
328     /**
329      * DCT coefficients
330      */
331     attribute_deprecated
332     short *dct_coeff;
333
334     /**
335      * motion reference frame index
336      * the order in which these are stored can depend on the codec.
337      */
338     attribute_deprecated
339     int8_t *ref_index[2];
340 #endif
341
342     /**
343      * for some private data of the user
344      */
345     void *opaque;
346
347     /**
348      * error
349      */
350     uint64_t error[AV_NUM_DATA_POINTERS];
351
352 #if FF_API_AVFRAME_LAVC
353     attribute_deprecated
354     int type;
355 #endif
356
357     /**
358      * When decoding, this signals how much the picture must be delayed.
359      * extra_delay = repeat_pict / (2*fps)
360      */
361     int repeat_pict;
362
363     /**
364      * The content of the picture is interlaced.
365      */
366     int interlaced_frame;
367
368     /**
369      * If the content is interlaced, is top field displayed first.
370      */
371     int top_field_first;
372
373     /**
374      * Tell user application that palette has changed from previous frame.
375      */
376     int palette_has_changed;
377
378 #if FF_API_AVFRAME_LAVC
379     attribute_deprecated
380     int buffer_hints;
381
382     /**
383      * Pan scan.
384      */
385     attribute_deprecated
386     struct AVPanScan *pan_scan;
387 #endif
388
389     /**
390      * reordered opaque 64bit (generally an integer or a double precision float
391      * PTS but can be anything).
392      * The user sets AVCodecContext.reordered_opaque to represent the input at
393      * that time,
394      * the decoder reorders values as needed and sets AVFrame.reordered_opaque
395      * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
396      * @deprecated in favor of pkt_pts
397      */
398     int64_t reordered_opaque;
399
400 #if FF_API_AVFRAME_LAVC
401     /**
402      * @deprecated this field is unused
403      */
404     attribute_deprecated void *hwaccel_picture_private;
405
406     attribute_deprecated
407     struct AVCodecContext *owner;
408     attribute_deprecated
409     void *thread_opaque;
410
411     /**
412      * log2 of the size of the block which a single vector in motion_val represents:
413      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
414      */
415     uint8_t motion_subsample_log2;
416 #endif
417
418     /**
419      * Sample rate of the audio data.
420      */
421     int sample_rate;
422
423     /**
424      * Channel layout of the audio data.
425      */
426     uint64_t channel_layout;
427
428     /**
429      * AVBuffer references backing the data for this frame. If all elements of
430      * this array are NULL, then this frame is not reference counted. This array
431      * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
432      * also be non-NULL for all j < i.
433      *
434      * There may be at most one AVBuffer per data plane, so for video this array
435      * always contains all the references. For planar audio with more than
436      * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
437      * this array. Then the extra AVBufferRef pointers are stored in the
438      * extended_buf array.
439      */
440     AVBufferRef *buf[AV_NUM_DATA_POINTERS];
441
442     /**
443      * For planar audio which requires more than AV_NUM_DATA_POINTERS
444      * AVBufferRef pointers, this array will hold all the references which
445      * cannot fit into AVFrame.buf.
446      *
447      * Note that this is different from AVFrame.extended_data, which always
448      * contains all the pointers. This array only contains the extra pointers,
449      * which cannot fit into AVFrame.buf.
450      *
451      * This array is always allocated using av_malloc() by whoever constructs
452      * the frame. It is freed in av_frame_unref().
453      */
454     AVBufferRef **extended_buf;
455     /**
456      * Number of elements in extended_buf.
457      */
458     int        nb_extended_buf;
459
460     AVFrameSideData **side_data;
461     int            nb_side_data;
462
463 /**
464  * @defgroup lavu_frame_flags AV_FRAME_FLAGS
465  * Flags describing additional frame properties.
466  *
467  * @{
468  */
469
470 /**
471  * The frame data may be corrupted, e.g. due to decoding errors.
472  */
473 #define AV_FRAME_FLAG_CORRUPT       (1 << 0)
474 /**
475  * @}
476  */
477
478     /**
479      * Frame flags, a combination of @ref lavu_frame_flags
480      */
481     int flags;
482
483     /**
484      * MPEG vs JPEG YUV range.
485      * It must be accessed using av_frame_get_color_range() and
486      * av_frame_set_color_range().
487      * - encoding: Set by user
488      * - decoding: Set by libavcodec
489      */
490     enum AVColorRange color_range;
491
492     enum AVColorPrimaries color_primaries;
493
494     enum AVColorTransferCharacteristic color_trc;
495
496     /**
497      * YUV colorspace type.
498      * It must be accessed using av_frame_get_colorspace() and
499      * av_frame_set_colorspace().
500      * - encoding: Set by user
501      * - decoding: Set by libavcodec
502      */
503     enum AVColorSpace colorspace;
504
505     enum AVChromaLocation chroma_location;
506
507     /**
508      * frame timestamp estimated using various heuristics, in stream time base
509      * Code outside libavcodec should access this field using:
510      * av_frame_get_best_effort_timestamp(frame)
511      * - encoding: unused
512      * - decoding: set by libavcodec, read by user.
513      */
514     int64_t best_effort_timestamp;
515
516     /**
517      * reordered pos from the last AVPacket that has been input into the decoder
518      * Code outside libavcodec should access this field using:
519      * av_frame_get_pkt_pos(frame)
520      * - encoding: unused
521      * - decoding: Read by user.
522      */
523     int64_t pkt_pos;
524
525     /**
526      * duration of the corresponding packet, expressed in
527      * AVStream->time_base units, 0 if unknown.
528      * Code outside libavcodec should access this field using:
529      * av_frame_get_pkt_duration(frame)
530      * - encoding: unused
531      * - decoding: Read by user.
532      */
533     int64_t pkt_duration;
534
535     /**
536      * metadata.
537      * Code outside libavcodec should access this field using:
538      * av_frame_get_metadata(frame)
539      * - encoding: Set by user.
540      * - decoding: Set by libavcodec.
541      */
542     AVDictionary *metadata;
543
544     /**
545      * decode error flags of the frame, set to a combination of
546      * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
547      * were errors during the decoding.
548      * Code outside libavcodec should access this field using:
549      * av_frame_get_decode_error_flags(frame)
550      * - encoding: unused
551      * - decoding: set by libavcodec, read by user.
552      */
553     int decode_error_flags;
554 #define FF_DECODE_ERROR_INVALID_BITSTREAM   1
555 #define FF_DECODE_ERROR_MISSING_REFERENCE   2
556
557     /**
558      * number of audio channels, only used for audio.
559      * Code outside libavcodec should access this field using:
560      * av_frame_get_channels(frame)
561      * - encoding: unused
562      * - decoding: Read by user.
563      */
564     int channels;
565
566     /**
567      * size of the corresponding packet containing the compressed
568      * frame. It must be accessed using av_frame_get_pkt_size() and
569      * av_frame_set_pkt_size().
570      * It is set to a negative value if unknown.
571      * - encoding: unused
572      * - decoding: set by libavcodec, read by user.
573      */
574     int pkt_size;
575
576     /**
577      * Not to be accessed directly from outside libavutil
578      */
579     AVBufferRef *qp_table_buf;
580 } AVFrame;
581
582 /**
583  * Accessors for some AVFrame fields.
584  * The position of these field in the structure is not part of the ABI,
585  * they should not be accessed directly outside libavcodec.
586  */
587 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
588 void    av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
589 int64_t av_frame_get_pkt_duration         (const AVFrame *frame);
590 void    av_frame_set_pkt_duration         (AVFrame *frame, int64_t val);
591 int64_t av_frame_get_pkt_pos              (const AVFrame *frame);
592 void    av_frame_set_pkt_pos              (AVFrame *frame, int64_t val);
593 int64_t av_frame_get_channel_layout       (const AVFrame *frame);
594 void    av_frame_set_channel_layout       (AVFrame *frame, int64_t val);
595 int     av_frame_get_channels             (const AVFrame *frame);
596 void    av_frame_set_channels             (AVFrame *frame, int     val);
597 int     av_frame_get_sample_rate          (const AVFrame *frame);
598 void    av_frame_set_sample_rate          (AVFrame *frame, int     val);
599 AVDictionary *av_frame_get_metadata       (const AVFrame *frame);
600 void          av_frame_set_metadata       (AVFrame *frame, AVDictionary *val);
601 int     av_frame_get_decode_error_flags   (const AVFrame *frame);
602 void    av_frame_set_decode_error_flags   (AVFrame *frame, int     val);
603 int     av_frame_get_pkt_size(const AVFrame *frame);
604 void    av_frame_set_pkt_size(AVFrame *frame, int val);
605 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame);
606 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
607 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type);
608 enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame);
609 void    av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val);
610 enum AVColorRange av_frame_get_color_range(const AVFrame *frame);
611 void    av_frame_set_color_range(AVFrame *frame, enum AVColorRange val);
612
613 /**
614  * Get the name of a colorspace.
615  * @return a static string identifying the colorspace; can be NULL.
616  */
617 const char *av_get_colorspace_name(enum AVColorSpace val);
618
619 /**
620  * Allocate an AVFrame and set its fields to default values.  The resulting
621  * struct must be freed using av_frame_free().
622  *
623  * @return An AVFrame filled with default values or NULL on failure.
624  *
625  * @note this only allocates the AVFrame itself, not the data buffers. Those
626  * must be allocated through other means, e.g. with av_frame_get_buffer() or
627  * manually.
628  */
629 AVFrame *av_frame_alloc(void);
630
631 /**
632  * Free the frame and any dynamically allocated objects in it,
633  * e.g. extended_data. If the frame is reference counted, it will be
634  * unreferenced first.
635  *
636  * @param frame frame to be freed. The pointer will be set to NULL.
637  */
638 void av_frame_free(AVFrame **frame);
639
640 /**
641  * Set up a new reference to the data described by the source frame.
642  *
643  * Copy frame properties from src to dst and create a new reference for each
644  * AVBufferRef from src.
645  *
646  * If src is not reference counted, new buffers are allocated and the data is
647  * copied.
648  *
649  * @return 0 on success, a negative AVERROR on error
650  */
651 int av_frame_ref(AVFrame *dst, const AVFrame *src);
652
653 /**
654  * Create a new frame that references the same data as src.
655  *
656  * This is a shortcut for av_frame_alloc()+av_frame_ref().
657  *
658  * @return newly created AVFrame on success, NULL on error.
659  */
660 AVFrame *av_frame_clone(const AVFrame *src);
661
662 /**
663  * Unreference all the buffers referenced by frame and reset the frame fields.
664  */
665 void av_frame_unref(AVFrame *frame);
666
667 /**
668  * Move everythnig contained in src to dst and reset src.
669  */
670 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
671
672 /**
673  * Allocate new buffer(s) for audio or video data.
674  *
675  * The following fields must be set on frame before calling this function:
676  * - format (pixel format for video, sample format for audio)
677  * - width and height for video
678  * - nb_samples and channel_layout for audio
679  *
680  * This function will fill AVFrame.data and AVFrame.buf arrays and, if
681  * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
682  * For planar formats, one buffer will be allocated for each plane.
683  *
684  * @param frame frame in which to store the new buffers.
685  * @param align required buffer size alignment
686  *
687  * @return 0 on success, a negative AVERROR on error.
688  */
689 int av_frame_get_buffer(AVFrame *frame, int align);
690
691 /**
692  * Check if the frame data is writable.
693  *
694  * @return A positive value if the frame data is writable (which is true if and
695  * only if each of the underlying buffers has only one reference, namely the one
696  * stored in this frame). Return 0 otherwise.
697  *
698  * If 1 is returned the answer is valid until av_buffer_ref() is called on any
699  * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
700  *
701  * @see av_frame_make_writable(), av_buffer_is_writable()
702  */
703 int av_frame_is_writable(AVFrame *frame);
704
705 /**
706  * Ensure that the frame data is writable, avoiding data copy if possible.
707  *
708  * Do nothing if the frame is writable, allocate new buffers and copy the data
709  * if it is not.
710  *
711  * @return 0 on success, a negative AVERROR on error.
712  *
713  * @see av_frame_is_writable(), av_buffer_is_writable(),
714  * av_buffer_make_writable()
715  */
716 int av_frame_make_writable(AVFrame *frame);
717
718 /**
719  * Copy the frame data from src to dst.
720  *
721  * This function does not allocate anything, dst must be already initialized and
722  * allocated with the same parameters as src.
723  *
724  * This function only copies the frame data (i.e. the contents of the data /
725  * extended data arrays), not any other properties.
726  *
727  * @return >= 0 on success, a negative AVERROR on error.
728  */
729 int av_frame_copy(AVFrame *dst, const AVFrame *src);
730
731 /**
732  * Copy only "metadata" fields from src to dst.
733  *
734  * Metadata for the purpose of this function are those fields that do not affect
735  * the data layout in the buffers.  E.g. pts, sample rate (for audio) or sample
736  * aspect ratio (for video), but not width/height or channel layout.
737  * Side data is also copied.
738  */
739 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
740
741 /**
742  * Get the buffer reference a given data plane is stored in.
743  *
744  * @param plane index of the data plane of interest in frame->extended_data.
745  *
746  * @return the buffer reference that contains the plane or NULL if the input
747  * frame is not valid.
748  */
749 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
750
751 /**
752  * Add a new side data to a frame.
753  *
754  * @param frame a frame to which the side data should be added
755  * @param type type of the added side data
756  * @param size size of the side data
757  *
758  * @return newly added side data on success, NULL on error
759  */
760 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
761                                         enum AVFrameSideDataType type,
762                                         int size);
763
764 /**
765  * @return a pointer to the side data of a given type on success, NULL if there
766  * is no side data with such type in this frame.
767  */
768 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
769                                         enum AVFrameSideDataType type);
770
771 /**
772  * If side data of the supplied type exists in the frame, free it and remove it
773  * from the frame.
774  */
775 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
776
777 /**
778  * @return a string identifying the side data type
779  */
780 const char *av_frame_side_data_name(enum AVFrameSideDataType type);
781
782 /**
783  * @}
784  */
785
786 #endif /* AVUTIL_FRAME_H */