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