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