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