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