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