addcb25a509bdcf8f3e418aa45603eb5aa5c963a
[ffmpeg.git] / libavutil / frame.h
1 /*
2  *
3  * This file is part of Libav.
4  *
5  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19
20 /**
21  * @file
22  * @ingroup lavu_frame
23  * reference-counted frame API
24  */
25
26 #ifndef AVUTIL_FRAME_H
27 #define AVUTIL_FRAME_H
28
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 enum AVActiveFormatDescription.
88      */
89     AV_FRAME_DATA_AFD,
90
91     /**
92      * This side data must be associated with an audio frame and corresponds to
93      * enum AVAudioServiceType defined in avcodec.h.
94      */
95     AV_FRAME_DATA_AUDIO_SERVICE_TYPE,
96 };
97
98 enum AVActiveFormatDescription {
99     AV_AFD_SAME         = 8,
100     AV_AFD_4_3          = 9,
101     AV_AFD_16_9         = 10,
102     AV_AFD_14_9         = 11,
103     AV_AFD_4_3_SP_14_9  = 13,
104     AV_AFD_16_9_SP_14_9 = 14,
105     AV_AFD_SP_4_3       = 15,
106 };
107
108 typedef struct AVFrameSideData {
109     enum AVFrameSideDataType type;
110     uint8_t *data;
111     int      size;
112     AVDictionary *metadata;
113 } AVFrameSideData;
114
115 /**
116  * This structure describes decoded (raw) audio or video data.
117  *
118  * AVFrame must be allocated using av_frame_alloc(). Note that this only
119  * allocates the AVFrame itself, the buffers for the data must be managed
120  * through other means (see below).
121  * AVFrame must be freed with av_frame_free().
122  *
123  * AVFrame is typically allocated once and then reused multiple times to hold
124  * different data (e.g. a single AVFrame to hold frames received from a
125  * decoder). In such a case, av_frame_unref() will free any references held by
126  * the frame and reset it to its original clean state before it
127  * is reused again.
128  *
129  * The data described by an AVFrame is usually reference counted through the
130  * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
131  * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
132  * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
133  * every single data plane must be contained in one of the buffers in
134  * AVFrame.buf or AVFrame.extended_buf.
135  * There may be a single buffer for all the data, or one separate buffer for
136  * each plane, or anything in between.
137  *
138  * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
139  * to the end with a minor bump.
140  */
141 typedef struct AVFrame {
142 #define AV_NUM_DATA_POINTERS 8
143     /**
144      * pointer to the picture/channel planes.
145      * This might be different from the first allocated byte
146      */
147     uint8_t *data[AV_NUM_DATA_POINTERS];
148
149     /**
150      * For video, size in bytes of each picture line.
151      * For audio, size in bytes of each plane.
152      *
153      * For audio, only linesize[0] may be set. For planar audio, each channel
154      * plane must be the same size.
155      *
156      * @note The linesize may be larger than the size of usable data -- there
157      * may be extra padding present for performance reasons.
158      */
159     int linesize[AV_NUM_DATA_POINTERS];
160
161     /**
162      * pointers to the data planes/channels.
163      *
164      * For video, this should simply point to data[].
165      *
166      * For planar audio, each channel has a separate data pointer, and
167      * linesize[0] contains the size of each channel buffer.
168      * For packed audio, there is just one data pointer, and linesize[0]
169      * contains the total size of the buffer for all channels.
170      *
171      * Note: Both data and extended_data should always be set in a valid frame,
172      * but for planar audio with more channels that can fit in data,
173      * extended_data must be used in order to access all channels.
174      */
175     uint8_t **extended_data;
176
177     /**
178      * width and height of the video frame
179      */
180     int width, height;
181
182     /**
183      * number of audio samples (per channel) described by this frame
184      */
185     int nb_samples;
186
187     /**
188      * format of the frame, -1 if unknown or unset
189      * Values correspond to enum AVPixelFormat for video frames,
190      * enum AVSampleFormat for audio)
191      */
192     int format;
193
194     /**
195      * 1 -> keyframe, 0-> not
196      */
197     int key_frame;
198
199     /**
200      * Picture type of the frame.
201      */
202     enum AVPictureType pict_type;
203
204 #if FF_API_AVFRAME_LAVC
205     attribute_deprecated
206     uint8_t *base[AV_NUM_DATA_POINTERS];
207 #endif
208
209     /**
210      * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
211      */
212     AVRational sample_aspect_ratio;
213
214     /**
215      * Presentation timestamp in time_base units (time when frame should be shown to user).
216      */
217     int64_t pts;
218
219     /**
220      * PTS copied from the AVPacket that was decoded to produce this frame.
221      */
222     int64_t pkt_pts;
223
224     /**
225      * DTS copied from the AVPacket that triggered returning this frame.
226      */
227     int64_t pkt_dts;
228
229     /**
230      * picture number in bitstream order
231      */
232     int coded_picture_number;
233     /**
234      * picture number in display order
235      */
236     int display_picture_number;
237
238     /**
239      * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
240      */
241     int quality;
242
243 #if FF_API_AVFRAME_LAVC
244     attribute_deprecated
245     int reference;
246
247     /**
248      * QP table
249      */
250     attribute_deprecated
251     int8_t *qscale_table;
252     /**
253      * QP store stride
254      */
255     attribute_deprecated
256     int qstride;
257
258     attribute_deprecated
259     int qscale_type;
260
261     /**
262      * mbskip_table[mb]>=1 if MB didn't change
263      * stride= mb_width = (width+15)>>4
264      */
265     attribute_deprecated
266     uint8_t *mbskip_table;
267
268     /**
269      * motion vector table
270      * @code
271      * example:
272      * int mv_sample_log2= 4 - motion_subsample_log2;
273      * int mb_width= (width+15)>>4;
274      * int mv_stride= (mb_width << mv_sample_log2) + 1;
275      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
276      * @endcode
277      */
278     attribute_deprecated
279     int16_t (*motion_val[2])[2];
280
281     /**
282      * macroblock type table
283      * mb_type_base + mb_width + 2
284      */
285     attribute_deprecated
286     uint32_t *mb_type;
287
288     /**
289      * DCT coefficients
290      */
291     attribute_deprecated
292     short *dct_coeff;
293
294     /**
295      * motion reference frame index
296      * the order in which these are stored can depend on the codec.
297      */
298     attribute_deprecated
299     int8_t *ref_index[2];
300 #endif
301
302     /**
303      * for some private data of the user
304      */
305     void *opaque;
306
307     /**
308      * error
309      */
310     uint64_t error[AV_NUM_DATA_POINTERS];
311
312 #if FF_API_AVFRAME_LAVC
313     attribute_deprecated
314     int type;
315 #endif
316
317     /**
318      * When decoding, this signals how much the picture must be delayed.
319      * extra_delay = repeat_pict / (2*fps)
320      */
321     int repeat_pict;
322
323     /**
324      * The content of the picture is interlaced.
325      */
326     int interlaced_frame;
327
328     /**
329      * If the content is interlaced, is top field displayed first.
330      */
331     int top_field_first;
332
333     /**
334      * Tell user application that palette has changed from previous frame.
335      */
336     int palette_has_changed;
337
338 #if FF_API_AVFRAME_LAVC
339     attribute_deprecated
340     int buffer_hints;
341
342     /**
343      * Pan scan.
344      */
345     attribute_deprecated
346     struct AVPanScan *pan_scan;
347 #endif
348
349     /**
350      * reordered opaque 64bit (generally an integer or a double precision float
351      * PTS but can be anything).
352      * The user sets AVCodecContext.reordered_opaque to represent the input at
353      * that time,
354      * the decoder reorders values as needed and sets AVFrame.reordered_opaque
355      * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
356      * @deprecated in favor of pkt_pts
357      */
358     int64_t reordered_opaque;
359
360 #if FF_API_AVFRAME_LAVC
361     /**
362      * @deprecated this field is unused
363      */
364     attribute_deprecated void *hwaccel_picture_private;
365
366     attribute_deprecated
367     struct AVCodecContext *owner;
368     attribute_deprecated
369     void *thread_opaque;
370
371     /**
372      * log2 of the size of the block which a single vector in motion_val represents:
373      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
374      */
375     attribute_deprecated
376     uint8_t motion_subsample_log2;
377 #endif
378
379     /**
380      * Sample rate of the audio data.
381      */
382     int sample_rate;
383
384     /**
385      * Channel layout of the audio data.
386      */
387     uint64_t channel_layout;
388
389     /**
390      * AVBuffer references backing the data for this frame. If all elements of
391      * this array are NULL, then this frame is not reference counted. This array
392      * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
393      * also be non-NULL for all j < i.
394      *
395      * There may be at most one AVBuffer per data plane, so for video this array
396      * always contains all the references. For planar audio with more than
397      * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
398      * this array. Then the extra AVBufferRef pointers are stored in the
399      * extended_buf array.
400      */
401     AVBufferRef *buf[AV_NUM_DATA_POINTERS];
402
403     /**
404      * For planar audio which requires more than AV_NUM_DATA_POINTERS
405      * AVBufferRef pointers, this array will hold all the references which
406      * cannot fit into AVFrame.buf.
407      *
408      * Note that this is different from AVFrame.extended_data, which always
409      * contains all the pointers. This array only contains the extra pointers,
410      * which cannot fit into AVFrame.buf.
411      *
412      * This array is always allocated using av_malloc() by whoever constructs
413      * the frame. It is freed in av_frame_unref().
414      */
415     AVBufferRef **extended_buf;
416     /**
417      * Number of elements in extended_buf.
418      */
419     int        nb_extended_buf;
420
421     AVFrameSideData **side_data;
422     int            nb_side_data;
423
424 /**
425  * @defgroup lavu_frame_flags AV_FRAME_FLAGS
426  * Flags describing additional frame properties.
427  *
428  * @{
429  */
430
431 /**
432  * The frame data may be corrupted, e.g. due to decoding errors.
433  */
434 #define AV_FRAME_FLAG_CORRUPT       (1 << 0)
435 /**
436  * @}
437  */
438
439     /**
440      * Frame flags, a combination of @ref lavu_frame_flags
441      */
442     int flags;
443
444     enum AVColorRange color_range;
445
446     enum AVColorPrimaries color_primaries;
447
448     enum AVColorTransferCharacteristic color_trc;
449
450     enum AVColorSpace colorspace;
451
452     enum AVChromaLocation chroma_location;
453 } AVFrame;
454
455 /**
456  * Allocate an AVFrame and set its fields to default values.  The resulting
457  * struct must be freed using av_frame_free().
458  *
459  * @return An AVFrame filled with default values or NULL on failure.
460  *
461  * @note this only allocates the AVFrame itself, not the data buffers. Those
462  * must be allocated through other means, e.g. with av_frame_get_buffer() or
463  * manually.
464  */
465 AVFrame *av_frame_alloc(void);
466
467 /**
468  * Free the frame and any dynamically allocated objects in it,
469  * e.g. extended_data. If the frame is reference counted, it will be
470  * unreferenced first.
471  *
472  * @param frame frame to be freed. The pointer will be set to NULL.
473  */
474 void av_frame_free(AVFrame **frame);
475
476 /**
477  * Set up a new reference to the data described by the source frame.
478  *
479  * Copy frame properties from src to dst and create a new reference for each
480  * AVBufferRef from src.
481  *
482  * If src is not reference counted, new buffers are allocated and the data is
483  * copied.
484  *
485  * @return 0 on success, a negative AVERROR on error
486  */
487 int av_frame_ref(AVFrame *dst, const AVFrame *src);
488
489 /**
490  * Create a new frame that references the same data as src.
491  *
492  * This is a shortcut for av_frame_alloc()+av_frame_ref().
493  *
494  * @return newly created AVFrame on success, NULL on error.
495  */
496 AVFrame *av_frame_clone(const AVFrame *src);
497
498 /**
499  * Unreference all the buffers referenced by frame and reset the frame fields.
500  */
501 void av_frame_unref(AVFrame *frame);
502
503 /**
504  * Move everythnig contained in src to dst and reset src.
505  */
506 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
507
508 /**
509  * Allocate new buffer(s) for audio or video data.
510  *
511  * The following fields must be set on frame before calling this function:
512  * - format (pixel format for video, sample format for audio)
513  * - width and height for video
514  * - nb_samples and channel_layout for audio
515  *
516  * This function will fill AVFrame.data and AVFrame.buf arrays and, if
517  * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
518  * For planar formats, one buffer will be allocated for each plane.
519  *
520  * @param frame frame in which to store the new buffers.
521  * @param align required buffer size alignment
522  *
523  * @return 0 on success, a negative AVERROR on error.
524  */
525 int av_frame_get_buffer(AVFrame *frame, int align);
526
527 /**
528  * Check if the frame data is writable.
529  *
530  * @return A positive value if the frame data is writable (which is true if and
531  * only if each of the underlying buffers has only one reference, namely the one
532  * stored in this frame). Return 0 otherwise.
533  *
534  * If 1 is returned the answer is valid until av_buffer_ref() is called on any
535  * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
536  *
537  * @see av_frame_make_writable(), av_buffer_is_writable()
538  */
539 int av_frame_is_writable(AVFrame *frame);
540
541 /**
542  * Ensure that the frame data is writable, avoiding data copy if possible.
543  *
544  * Do nothing if the frame is writable, allocate new buffers and copy the data
545  * if it is not.
546  *
547  * @return 0 on success, a negative AVERROR on error.
548  *
549  * @see av_frame_is_writable(), av_buffer_is_writable(),
550  * av_buffer_make_writable()
551  */
552 int av_frame_make_writable(AVFrame *frame);
553
554 /**
555  * Copy the frame data from src to dst.
556  *
557  * This function does not allocate anything, dst must be already initialized and
558  * allocated with the same parameters as src.
559  *
560  * This function only copies the frame data (i.e. the contents of the data /
561  * extended data arrays), not any other properties.
562  *
563  * @return >= 0 on success, a negative AVERROR on error.
564  */
565 int av_frame_copy(AVFrame *dst, const AVFrame *src);
566
567 /**
568  * Copy only "metadata" fields from src to dst.
569  *
570  * Metadata for the purpose of this function are those fields that do not affect
571  * the data layout in the buffers.  E.g. pts, sample rate (for audio) or sample
572  * aspect ratio (for video), but not width/height or channel layout.
573  * Side data is also copied.
574  */
575 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
576
577 /**
578  * Get the buffer reference a given data plane is stored in.
579  *
580  * @param plane index of the data plane of interest in frame->extended_data.
581  *
582  * @return the buffer reference that contains the plane or NULL if the input
583  * frame is not valid.
584  */
585 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
586
587 /**
588  * Add a new side data to a frame.
589  *
590  * @param frame a frame to which the side data should be added
591  * @param type type of the added side data
592  * @param size size of the side data
593  *
594  * @return newly added side data on success, NULL on error
595  */
596 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
597                                         enum AVFrameSideDataType type,
598                                         int size);
599
600 /**
601  * @return a pointer to the side data of a given type on success, NULL if there
602  * is no side data with such type in this frame.
603  */
604 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
605                                         enum AVFrameSideDataType type);
606
607 /**
608  * If side data of the supplied type exists in the frame, free it and remove it
609  * from the frame.
610  */
611 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
612
613 /**
614  * @}
615  */
616
617 #endif /* AVUTIL_FRAME_H */