lavu: fix grammar in doxy for av_frame_ref.
[ffmpeg.git] / libavutil / frame.h
1 /*
2  *
3  * This file is part of FFmpeg.
4  *
5  * FFmpeg is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * FFmpeg is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with FFmpeg; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19
20 #ifndef AVUTIL_FRAME_H
21 #define AVUTIL_FRAME_H
22
23 #include <stdint.h>
24
25 #include "libavcodec/version.h"
26
27 #include "avutil.h"
28 #include "buffer.h"
29 #include "dict.h"
30 #include "rational.h"
31 #include "samplefmt.h"
32
33 enum AVColorSpace{
34     AVCOL_SPC_RGB         = 0,
35     AVCOL_SPC_BT709       = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
36     AVCOL_SPC_UNSPECIFIED = 2,
37     AVCOL_SPC_FCC         = 4,
38     AVCOL_SPC_BT470BG     = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
39     AVCOL_SPC_SMPTE170M   = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
40     AVCOL_SPC_SMPTE240M   = 7,
41     AVCOL_SPC_YCOCG       = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
42     AVCOL_SPC_NB             , ///< Not part of ABI
43 };
44 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
45
46 enum AVColorRange{
47     AVCOL_RANGE_UNSPECIFIED = 0,
48     AVCOL_RANGE_MPEG        = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
49     AVCOL_RANGE_JPEG        = 2, ///< the normal     2^n-1   "JPEG" YUV ranges
50     AVCOL_RANGE_NB             , ///< Not part of ABI
51 };
52
53 enum AVFrameSideDataType {
54     /**
55      * The data is the AVPanScan struct defined in libavcodec.
56      */
57     AV_FRAME_DATA_PANSCAN,
58 };
59
60 typedef struct AVFrameSideData {
61     enum AVFrameSideDataType type;
62     uint8_t *data;
63     int      size;
64     AVDictionary *metadata;
65 } AVFrameSideData;
66
67 /**
68  * This structure describes decoded (raw) audio or video data.
69  *
70  * AVFrame must be allocated using av_frame_alloc(). Note that this only
71  * allocates the AVFrame itself, the buffers for the data must be managed
72  * through other means (see below).
73  * AVFrame must be freed with av_frame_free().
74  *
75  * AVFrame is typically allocated once and then reused multiple times to hold
76  * different data (e.g. a single AVFrame to hold frames received from a
77  * decoder). In such a case, av_frame_unref() will free any references held by
78  * the frame and reset it to its original clean state before it
79  * is reused again.
80  *
81  * The data described by an AVFrame is usually reference counted through the
82  * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
83  * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
84  * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
85  * every single data plane must be contained in one of the buffers in
86  * AVFrame.buf or AVFrame.extended_buf.
87  * There may be a single buffer for all the data, or one separate buffer for
88  * each plane, or anything in between.
89  *
90  * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
91  * to the end with a minor bump.
92  * Similarly fields that are marked as to be only accessed by
93  * av_opt_ptr() can be reordered. This allows 2 forks to add fields
94  * without breaking compatibility with each other.
95  */
96 typedef struct AVFrame {
97 #define AV_NUM_DATA_POINTERS 8
98     /**
99      * pointer to the picture/channel planes.
100      * This might be different from the first allocated byte
101      *
102      * Some decoders access areas outside 0,0 - width,height, please
103      * see avcodec_align_dimensions2(). Some filters and swscale can read
104      * up to 16 bytes beyond the planes, if these filters are to be used,
105      * then 16 extra bytes must be allocated.
106      */
107     uint8_t *data[AV_NUM_DATA_POINTERS];
108
109     /**
110      * For video, size in bytes of each picture line.
111      * For audio, size in bytes of each plane.
112      *
113      * For audio, only linesize[0] may be set. For planar audio, each channel
114      * plane must be the same size.
115      *
116      * For video the linesizes should be multiplies of the CPUs alignment
117      * preference, this is 16 or 32 for modern desktop CPUs.
118      * Some code requires such alignment other code can be slower without
119      * correct alignment, for yet other it makes no difference.
120      */
121     int linesize[AV_NUM_DATA_POINTERS];
122
123     /**
124      * pointers to the data planes/channels.
125      *
126      * For video, this should simply point to data[].
127      *
128      * For planar audio, each channel has a separate data pointer, and
129      * linesize[0] contains the size of each channel buffer.
130      * For packed audio, there is just one data pointer, and linesize[0]
131      * contains the total size of the buffer for all channels.
132      *
133      * Note: Both data and extended_data should always be set in a valid frame,
134      * but for planar audio with more channels that can fit in data,
135      * extended_data must be used in order to access all channels.
136      */
137     uint8_t **extended_data;
138
139     /**
140      * width and height of the video frame
141      */
142     int width, height;
143
144     /**
145      * number of audio samples (per channel) described by this frame
146      */
147     int nb_samples;
148
149     /**
150      * format of the frame, -1 if unknown or unset
151      * Values correspond to enum AVPixelFormat for video frames,
152      * enum AVSampleFormat for audio)
153      */
154     int format;
155
156     /**
157      * 1 -> keyframe, 0-> not
158      */
159     int key_frame;
160
161     /**
162      * Picture type of the frame.
163      */
164     enum AVPictureType pict_type;
165
166 #if FF_API_AVFRAME_LAVC
167     attribute_deprecated
168     uint8_t *base[AV_NUM_DATA_POINTERS];
169 #endif
170
171     /**
172      * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
173      */
174     AVRational sample_aspect_ratio;
175
176     /**
177      * Presentation timestamp in time_base units (time when frame should be shown to user).
178      */
179     int64_t pts;
180
181     /**
182      * PTS copied from the AVPacket that was decoded to produce this frame.
183      */
184     int64_t pkt_pts;
185
186     /**
187      * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isnt used)
188      * This is also the Presentation time of this AVFrame calculated from
189      * only AVPacket.dts values without pts values.
190      */
191     int64_t pkt_dts;
192
193     /**
194      * picture number in bitstream order
195      */
196     int coded_picture_number;
197     /**
198      * picture number in display order
199      */
200     int display_picture_number;
201
202     /**
203      * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
204      */
205     int quality;
206
207 #if FF_API_AVFRAME_LAVC
208     attribute_deprecated
209     int reference;
210
211     /**
212      * QP table
213      */
214     attribute_deprecated
215     int8_t *qscale_table;
216     /**
217      * QP store stride
218      */
219     attribute_deprecated
220     int qstride;
221
222     attribute_deprecated
223     int qscale_type;
224
225     /**
226      * mbskip_table[mb]>=1 if MB didn't change
227      * stride= mb_width = (width+15)>>4
228      */
229     attribute_deprecated
230     uint8_t *mbskip_table;
231
232     /**
233      * motion vector table
234      * @code
235      * example:
236      * int mv_sample_log2= 4 - motion_subsample_log2;
237      * int mb_width= (width+15)>>4;
238      * int mv_stride= (mb_width << mv_sample_log2) + 1;
239      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
240      * @endcode
241      */
242     attribute_deprecated
243     int16_t (*motion_val[2])[2];
244
245     /**
246      * macroblock type table
247      * mb_type_base + mb_width + 2
248      */
249     attribute_deprecated
250     uint32_t *mb_type;
251
252     /**
253      * DCT coefficients
254      */
255     attribute_deprecated
256     short *dct_coeff;
257
258     /**
259      * motion reference frame index
260      * the order in which these are stored can depend on the codec.
261      */
262     attribute_deprecated
263     int8_t *ref_index[2];
264 #endif
265
266     /**
267      * for some private data of the user
268      */
269     void *opaque;
270
271     /**
272      * error
273      */
274     uint64_t error[AV_NUM_DATA_POINTERS];
275
276 #if FF_API_AVFRAME_LAVC
277     attribute_deprecated
278     int type;
279 #endif
280
281     /**
282      * When decoding, this signals how much the picture must be delayed.
283      * extra_delay = repeat_pict / (2*fps)
284      */
285     int repeat_pict;
286
287     /**
288      * The content of the picture is interlaced.
289      */
290     int interlaced_frame;
291
292     /**
293      * If the content is interlaced, is top field displayed first.
294      */
295     int top_field_first;
296
297     /**
298      * Tell user application that palette has changed from previous frame.
299      */
300     int palette_has_changed;
301
302 #if FF_API_AVFRAME_LAVC
303     attribute_deprecated
304     int buffer_hints;
305
306     /**
307      * Pan scan.
308      */
309     attribute_deprecated
310     struct AVPanScan *pan_scan;
311 #endif
312
313     /**
314      * reordered opaque 64bit (generally an integer or a double precision float
315      * PTS but can be anything).
316      * The user sets AVCodecContext.reordered_opaque to represent the input at
317      * that time,
318      * the decoder reorders values as needed and sets AVFrame.reordered_opaque
319      * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
320      * @deprecated in favor of pkt_pts
321      */
322     int64_t reordered_opaque;
323
324 #if FF_API_AVFRAME_LAVC
325     /**
326      * @deprecated this field is unused
327      */
328     attribute_deprecated void *hwaccel_picture_private;
329
330     attribute_deprecated
331     struct AVCodecContext *owner;
332     attribute_deprecated
333     void *thread_opaque;
334
335     /**
336      * log2 of the size of the block which a single vector in motion_val represents:
337      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
338      */
339     attribute_deprecated
340     uint8_t motion_subsample_log2;
341 #endif
342
343     /**
344      * Sample rate of the audio data.
345      */
346     int sample_rate;
347
348     /**
349      * Channel layout of the audio data.
350      */
351     uint64_t channel_layout;
352
353     /**
354      * AVBuffer references backing the data for this frame. If all elements of
355      * this array are NULL, then this frame is not reference counted.
356      *
357      * There may be at most one AVBuffer per data plane, so for video this array
358      * always contains all the references. For planar audio with more than
359      * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
360      * this array. Then the extra AVBufferRef pointers are stored in the
361      * extended_buf array.
362      */
363     AVBufferRef *buf[AV_NUM_DATA_POINTERS];
364
365     /**
366      * For planar audio which requires more than AV_NUM_DATA_POINTERS
367      * AVBufferRef pointers, this array will hold all the references which
368      * cannot fit into AVFrame.buf.
369      *
370      * Note that this is different from AVFrame.extended_data, which always
371      * contains all the pointers. This array only contains the extra pointers,
372      * which cannot fit into AVFrame.buf.
373      *
374      * This array is always allocated using av_malloc() by whoever constructs
375      * the frame. It is freed in av_frame_unref().
376      */
377     AVBufferRef **extended_buf;
378     /**
379      * Number of elements in extended_buf.
380      */
381     int        nb_extended_buf;
382
383     AVFrameSideData **side_data;
384     int            nb_side_data;
385
386     /**
387      * frame timestamp estimated using various heuristics, in stream time base
388      * Code outside libavcodec should access this field using:
389      * av_frame_get_best_effort_timestamp(frame)
390      * - encoding: unused
391      * - decoding: set by libavcodec, read by user.
392      */
393     int64_t best_effort_timestamp;
394
395     /**
396      * reordered pos from the last AVPacket that has been input into the decoder
397      * Code outside libavcodec should access this field using:
398      * av_frame_get_pkt_pos(frame)
399      * - encoding: unused
400      * - decoding: Read by user.
401      */
402     int64_t pkt_pos;
403
404     /**
405      * duration of the corresponding packet, expressed in
406      * AVStream->time_base units, 0 if unknown.
407      * Code outside libavcodec should access this field using:
408      * av_frame_get_pkt_duration(frame)
409      * - encoding: unused
410      * - decoding: Read by user.
411      */
412     int64_t pkt_duration;
413
414     /**
415      * metadata.
416      * Code outside libavcodec should access this field using:
417      * av_frame_get_metadata(frame)
418      * - encoding: Set by user.
419      * - decoding: Set by libavcodec.
420      */
421     AVDictionary *metadata;
422
423     /**
424      * decode error flags of the frame, set to a combination of
425      * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
426      * were errors during the decoding.
427      * Code outside libavcodec should access this field using:
428      * av_frame_get_decode_error_flags(frame)
429      * - encoding: unused
430      * - decoding: set by libavcodec, read by user.
431      */
432     int decode_error_flags;
433 #define FF_DECODE_ERROR_INVALID_BITSTREAM   1
434 #define FF_DECODE_ERROR_MISSING_REFERENCE   2
435
436     /**
437      * number of audio channels, only used for audio.
438      * Code outside libavcodec should access this field using:
439      * av_frame_get_channels(frame)
440      * - encoding: unused
441      * - decoding: Read by user.
442      */
443     int channels;
444
445     /**
446      * size of the corresponding packet containing the compressed
447      * frame. It must be accessed using av_frame_get_pkt_size() and
448      * av_frame_set_pkt_size().
449      * It is set to a negative value if unknown.
450      * - encoding: unused
451      * - decoding: set by libavcodec, read by user.
452      */
453     int pkt_size;
454
455     /**
456      * YUV colorspace type.
457      * It must be accessed using av_frame_get_colorspace() and
458      * av_frame_set_colorspace().
459      * - encoding: Set by user
460      * - decoding: Set by libavcodec
461      */
462     enum AVColorSpace colorspace;
463
464     /**
465      * MPEG vs JPEG YUV range.
466      * It must be accessed using av_frame_get_color_range() and
467      * av_frame_set_color_range().
468      * - encoding: Set by user
469      * - decoding: Set by libavcodec
470      */
471     enum AVColorRange color_range;
472
473
474     /**
475      * Not to be accessed directly from outside libavutil
476      */
477     AVBufferRef *qp_table_buf;
478 } AVFrame;
479
480 /**
481  * Accessors for some AVFrame fields.
482  * The position of these field in the structure is not part of the ABI,
483  * they should not be accessed directly outside libavcodec.
484  */
485 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
486 void    av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
487 int64_t av_frame_get_pkt_duration         (const AVFrame *frame);
488 void    av_frame_set_pkt_duration         (AVFrame *frame, int64_t val);
489 int64_t av_frame_get_pkt_pos              (const AVFrame *frame);
490 void    av_frame_set_pkt_pos              (AVFrame *frame, int64_t val);
491 int64_t av_frame_get_channel_layout       (const AVFrame *frame);
492 void    av_frame_set_channel_layout       (AVFrame *frame, int64_t val);
493 int     av_frame_get_channels             (const AVFrame *frame);
494 void    av_frame_set_channels             (AVFrame *frame, int     val);
495 int     av_frame_get_sample_rate          (const AVFrame *frame);
496 void    av_frame_set_sample_rate          (AVFrame *frame, int     val);
497 AVDictionary *av_frame_get_metadata       (const AVFrame *frame);
498 void          av_frame_set_metadata       (AVFrame *frame, AVDictionary *val);
499 int     av_frame_get_decode_error_flags   (const AVFrame *frame);
500 void    av_frame_set_decode_error_flags   (AVFrame *frame, int     val);
501 int     av_frame_get_pkt_size(const AVFrame *frame);
502 void    av_frame_set_pkt_size(AVFrame *frame, int val);
503 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame);
504 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
505 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type);
506 enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame);
507 void    av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val);
508 enum AVColorRange av_frame_get_color_range(const AVFrame *frame);
509 void    av_frame_set_color_range(AVFrame *frame, enum AVColorRange val);
510
511 /**
512  * Allocate an AVFrame and set its fields to default values.  The resulting
513  * struct must be freed using av_frame_free().
514  *
515  * @return An AVFrame filled with default values or NULL on failure.
516  *
517  * @note this only allocates the AVFrame itself, not the data buffers. Those
518  * must be allocated through other means, e.g. with av_frame_get_buffer() or
519  * manually.
520  */
521 AVFrame *av_frame_alloc(void);
522
523 /**
524  * Free the frame and any dynamically allocated objects in it,
525  * e.g. extended_data. If the frame is reference counted, it will be
526  * unreferenced first.
527  *
528  * @param frame frame to be freed. The pointer will be set to NULL.
529  */
530 void av_frame_free(AVFrame **frame);
531
532 /**
533  * Setup a new reference to the data described by a given frame.
534  *
535  * Copy frame properties from src to dst and create a new reference for each
536  * AVBufferRef from src.
537  *
538  * If src is not reference counted, new buffers are allocated and the data is
539  * copied.
540  *
541  * @return 0 on success, a negative AVERROR on error
542  */
543 int av_frame_ref(AVFrame *dst, AVFrame *src);
544
545 /**
546  * Create a new frame that references the same data as src.
547  *
548  * This is a shortcut for av_frame_alloc()+av_frame_ref().
549  *
550  * @return newly created AVFrame on success, NULL on error.
551  */
552 AVFrame *av_frame_clone(AVFrame *src);
553
554 /**
555  * Unreference all the buffers referenced by frame and reset the frame fields.
556  */
557 void av_frame_unref(AVFrame *frame);
558
559 /**
560  * Move everythnig contained in src to dst and reset src.
561  */
562 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
563
564 /**
565  * Allocate new buffer(s) for audio or video data.
566  *
567  * The following fields must be set on frame before calling this function:
568  * - format (pixel format for video, sample format for audio)
569  * - width and height for video
570  * - nb_samples and channel_layout for audio
571  *
572  * This function will fill AVFrame.data and AVFrame.buf arrays and, if
573  * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
574  * For planar formats, one buffer will be allocated for each plane.
575  *
576  * @param frame frame in which to store the new buffers.
577  * @param align required buffer size alignment
578  *
579  * @return 0 on success, a negative AVERROR on error.
580  */
581 int av_frame_get_buffer(AVFrame *frame, int align);
582
583 /**
584  * Check if the frame data is writable.
585  *
586  * @return A positive value if the frame data is writable (which is true if and
587  * only if each of the underlying buffers has only one reference, namely the one
588  * stored in this frame). Return 0 otherwise.
589  *
590  * If 1 is returned the answer is valid until av_buffer_ref() is called on any
591  * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
592  *
593  * @see av_frame_make_writable(), av_buffer_is_writable()
594  */
595 int av_frame_is_writable(AVFrame *frame);
596
597 /**
598  * Ensure that the frame data is writable, avoiding data copy if possible.
599  *
600  * Do nothing if the frame is writable, allocate new buffers and copy the data
601  * if it is not.
602  *
603  * @return 0 on success, a negative AVERROR on error.
604  *
605  * @see av_frame_is_writable(), av_buffer_is_writable(),
606  * av_buffer_make_writable()
607  */
608 int av_frame_make_writable(AVFrame *frame);
609
610 /**
611  * Copy only "metadata" fields from src to dst.
612  *
613  * Metadata for the purpose of this function are those fields that do not affect
614  * the data layout in the buffers.  E.g. pts, sample rate (for audio) or sample
615  * aspect ratio (for video), but not width/height or channel layout.
616  * Side data is also copied.
617  */
618 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
619
620 /**
621  * Get the buffer reference a given data plane is stored in.
622  *
623  * @param plane index of the data plane of interest in frame->extended_data.
624  *
625  * @return the buffer reference that contains the plane or NULL if the input
626  * frame is not valid.
627  */
628 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
629
630 /**
631  * Add a new side data to a frame.
632  *
633  * @param frame a frame to which the side data should be added
634  * @param type type of the added side data
635  * @param size size of the side data
636  *
637  * @return newly added side data on success, NULL on error
638  */
639 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
640                                         enum AVFrameSideDataType type,
641                                         int size);
642
643 /**
644  * @return a pointer to the side data of a given type on success, NULL if there
645  * is no side data with such type in this frame.
646  */
647 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
648                                         enum AVFrameSideDataType type);
649
650 #endif /* AVUTIL_FRAME_H */