AVFrame: deprecate all now unused fields
[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 #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(). Not 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  */
73 typedef struct AVFrame {
74 #define AV_NUM_DATA_POINTERS 8
75     /**
76      * pointer to the picture/channel planes.
77      * This might be different from the first allocated byte
78      */
79     uint8_t *data[AV_NUM_DATA_POINTERS];
80
81     /**
82      * For video, size in bytes of each picture line.
83      * For audio, size in bytes of each plane.
84      *
85      * For audio, only linesize[0] may be set. For planar audio, each channel
86      * plane must be the same size.
87      */
88     int linesize[AV_NUM_DATA_POINTERS];
89
90     /**
91      * pointers to the data planes/channels.
92      *
93      * For video, this should simply point to data[].
94      *
95      * For planar audio, each channel has a separate data pointer, and
96      * linesize[0] contains the size of each channel buffer.
97      * For packed audio, there is just one data pointer, and linesize[0]
98      * contains the total size of the buffer for all channels.
99      *
100      * Note: Both data and extended_data should always be set in a valid frame,
101      * but for planar audio with more channels that can fit in data,
102      * extended_data must be used in order to access all channels.
103      */
104     uint8_t **extended_data;
105
106     /**
107      * width and height of the video frame
108      */
109     int width, height;
110
111     /**
112      * number of audio samples (per channel) described by this frame
113      */
114     int nb_samples;
115
116     /**
117      * format of the frame, -1 if unknown or unset
118      * Values correspond to enum AVPixelFormat for video frames,
119      * enum AVSampleFormat for audio)
120      */
121     int format;
122
123     /**
124      * 1 -> keyframe, 0-> not
125      */
126     int key_frame;
127
128     /**
129      * Picture type of the frame.
130      */
131     enum AVPictureType pict_type;
132
133 #if FF_API_AVFRAME_LAVC
134     attribute_deprecated
135     uint8_t *base[AV_NUM_DATA_POINTERS];
136 #endif
137
138     /**
139      * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
140      */
141     AVRational sample_aspect_ratio;
142
143     /**
144      * Presentation timestamp in time_base units (time when frame should be shown to user).
145      */
146     int64_t pts;
147
148     /**
149      * PTS copied from the AVPacket that was decoded to produce this frame.
150      */
151     int64_t pkt_pts;
152
153     /**
154      * DTS copied from the AVPacket that triggered returning this frame.
155      */
156     int64_t pkt_dts;
157
158     /**
159      * picture number in bitstream order
160      */
161     int coded_picture_number;
162     /**
163      * picture number in display order
164      */
165     int display_picture_number;
166
167     /**
168      * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
169      */
170     int quality;
171
172 #if FF_API_AVFRAME_LAVC
173     attribute_deprecated
174     int reference;
175
176     /**
177      * QP table
178      */
179     attribute_deprecated
180     int8_t *qscale_table;
181     /**
182      * QP store stride
183      */
184     attribute_deprecated
185     int qstride;
186
187     attribute_deprecated
188     int qscale_type;
189
190     /**
191      * mbskip_table[mb]>=1 if MB didn't change
192      * stride= mb_width = (width+15)>>4
193      */
194     attribute_deprecated
195     uint8_t *mbskip_table;
196
197     /**
198      * motion vector table
199      * @code
200      * example:
201      * int mv_sample_log2= 4 - motion_subsample_log2;
202      * int mb_width= (width+15)>>4;
203      * int mv_stride= (mb_width << mv_sample_log2) + 1;
204      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
205      * @endcode
206      */
207     attribute_deprecated
208     int16_t (*motion_val[2])[2];
209
210     /**
211      * macroblock type table
212      * mb_type_base + mb_width + 2
213      */
214     attribute_deprecated
215     uint32_t *mb_type;
216
217     /**
218      * DCT coefficients
219      */
220     attribute_deprecated
221     short *dct_coeff;
222
223     /**
224      * motion reference frame index
225      * the order in which these are stored can depend on the codec.
226      */
227     attribute_deprecated
228     int8_t *ref_index[2];
229 #endif
230
231     /**
232      * for some private data of the user
233      */
234     void *opaque;
235
236     /**
237      * error
238      */
239     uint64_t error[AV_NUM_DATA_POINTERS];
240
241 #if FF_API_AVFRAME_LAVC
242     attribute_deprecated
243     int type;
244 #endif
245
246     /**
247      * When decoding, this signals how much the picture must be delayed.
248      * extra_delay = repeat_pict / (2*fps)
249      */
250     int repeat_pict;
251
252     /**
253      * The content of the picture is interlaced.
254      */
255     int interlaced_frame;
256
257     /**
258      * If the content is interlaced, is top field displayed first.
259      */
260     int top_field_first;
261
262     /**
263      * Tell user application that palette has changed from previous frame.
264      */
265     int palette_has_changed;
266
267 #if FF_API_AVFRAME_LAVC
268     attribute_deprecated
269     int buffer_hints;
270
271     /**
272      * Pan scan.
273      */
274     attribute_deprecated
275     struct AVPanScan *pan_scan;
276 #endif
277
278     /**
279      * reordered opaque 64bit (generally an integer or a double precision float
280      * PTS but can be anything).
281      * The user sets AVCodecContext.reordered_opaque to represent the input at
282      * that time,
283      * the decoder reorders values as needed and sets AVFrame.reordered_opaque
284      * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
285      * @deprecated in favor of pkt_pts
286      */
287     int64_t reordered_opaque;
288
289 #if FF_API_AVFRAME_LAVC
290     /**
291      * @deprecated this field is unused
292      */
293     attribute_deprecated void *hwaccel_picture_private;
294
295     attribute_deprecated
296     struct AVCodecContext *owner;
297     attribute_deprecated
298     void *thread_opaque;
299
300     /**
301      * log2 of the size of the block which a single vector in motion_val represents:
302      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
303      */
304     attribute_deprecated
305     uint8_t motion_subsample_log2;
306 #endif
307
308     /**
309      * Sample rate of the audio data.
310      */
311     int sample_rate;
312
313     /**
314      * Channel layout of the audio data.
315      */
316     uint64_t channel_layout;
317
318     /**
319      * AVBuffer references backing the data for this frame. If all elements of
320      * this array are NULL, then this frame is not reference counted.
321      *
322      * There may be at most one AVBuffer per data plane, so for video this array
323      * always contains all the references. For planar audio with more than
324      * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
325      * this array. Then the extra AVBufferRef pointers are stored in the
326      * extended_buf array.
327      */
328     AVBufferRef *buf[AV_NUM_DATA_POINTERS];
329
330     /**
331      * For planar audio which requires more than AV_NUM_DATA_POINTERS
332      * AVBufferRef pointers, this array will hold all the references which
333      * cannot fit into AVFrame.buf.
334      *
335      * Note that this is different from AVFrame.extended_data, which always
336      * contains all the pointers. This array only contains the extra pointers,
337      * which cannot fit into AVFrame.buf.
338      *
339      * This array is always allocated using av_malloc() by whoever constructs
340      * the frame. It is freed in av_frame_unref().
341      */
342     AVBufferRef **extended_buf;
343     /**
344      * Number of elements in extended_buf.
345      */
346     int        nb_extended_buf;
347
348     AVFrameSideData **side_data;
349     int            nb_side_data;
350 } AVFrame;
351
352 /**
353  * Allocate an AVFrame and set its fields to default values.  The resulting
354  * struct must be freed using av_frame_free().
355  *
356  * @return An AVFrame filled with default values or NULL on failure.
357  *
358  * @note this only allocates the AVFrame itself, not the data buffers. Those
359  * must be allocated through other means, e.g. with av_frame_get_buffer() or
360  * manually.
361  */
362 AVFrame *av_frame_alloc(void);
363
364 /**
365  * Free the frame and any dynamically allocated objects in it,
366  * e.g. extended_data. If the frame is reference counted, it will be
367  * unreferenced first.
368  *
369  * @param frame frame to be freed. The pointer will be set to NULL.
370  */
371 void av_frame_free(AVFrame **frame);
372
373 /**
374  * Setup a new reference to the data described by an given frame.
375  *
376  * Copy frame properties from src to dst and create a new reference for each
377  * AVBufferRef from src.
378  *
379  * If src is not reference counted, new buffers are allocated and the data is
380  * copied.
381  *
382  * @return 0 on success, a negative AVERROR on error
383  */
384 int av_frame_ref(AVFrame *dst, AVFrame *src);
385
386 /**
387  * Create a new frame that references the same data as src.
388  *
389  * This is a shortcut for av_frame_alloc()+av_frame_ref().
390  *
391  * @return newly created AVFrame on success, NULL on error.
392  */
393 AVFrame *av_frame_clone(AVFrame *src);
394
395 /**
396  * Unreference all the buffers referenced by frame and reset the frame fields.
397  */
398 void av_frame_unref(AVFrame *frame);
399
400 /**
401  * Move everythnig contained in src to dst and reset src.
402  */
403 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
404
405 /**
406  * Allocate new buffer(s) for audio or video data.
407  *
408  * The following fields must be set on frame before calling this function:
409  * - format (pixel format for video, sample format for audio)
410  * - width and height for video
411  * - nb_samples and channel_layout for audio
412  *
413  * This function will fill AVFrame.data and AVFrame.buf arrays and, if
414  * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
415  * For planar formats, one buffer will be allocated for each plane.
416  *
417  * @param frame frame in which to store the new buffers.
418  * @param align required buffer size alignment
419  *
420  * @return 0 on success, a negative AVERROR on error.
421  */
422 int av_frame_get_buffer(AVFrame *frame, int align);
423
424 /**
425  * Check if the frame data is writable.
426  *
427  * @return A positive value if the frame data is writable (which is true if and
428  * only if each of the underlying buffers has only one reference, namely the one
429  * stored in this frame). Return 0 otherwise.
430  *
431  * If 1 is returned the answer is valid until av_buffer_ref() is called on any
432  * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
433  *
434  * @see av_frame_make_writable(), av_buffer_is_writable()
435  */
436 int av_frame_is_writable(AVFrame *frame);
437
438 /**
439  * Ensure that the frame data is writable, avoiding data copy if possible.
440  *
441  * Do nothing if the frame is writable, allocate new buffers and copy the data
442  * if it is not.
443  *
444  * @return 0 on success, a negative AVERROR on error.
445  *
446  * @see av_frame_is_writable(), av_buffer_is_writable(),
447  * av_buffer_make_writable()
448  */
449 int av_frame_make_writable(AVFrame *frame);
450
451 /**
452  * Copy only "metadata" fields from src to dst.
453  *
454  * Metadata for the purpose of this function are those fields that do not affect
455  * the data layout in the buffers.  E.g. pts, sample rate (for audio) or sample
456  * aspect ratio (for video), but not width/height or channel layout.
457  * Side data is also copied.
458  */
459 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
460
461 /**
462  * Get the buffer reference a given data plane is stored in.
463  *
464  * @param plane index of the data plane of interest in frame->extended_data.
465  *
466  * @return the buffer reference that contains the plane or NULL if the input
467  * frame is not valid.
468  */
469 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
470
471 /**
472  * Add a new side data to a frame.
473  *
474  * @param frame a frame to which the side data should be added
475  * @param type type of the added side data
476  * @param size size of the side data
477  *
478  * @return newly added side data on success, NULL on error
479  */
480 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
481                                         enum AVFrameSideDataType type,
482                                         int size);
483
484 /**
485  * @return a pointer to the side data of a given type on success, NULL if there
486  * is no side data with such type in this frame.
487  */
488 AVFrameSideData *av_frame_get_side_data(AVFrame *frame,
489                                         enum AVFrameSideDataType type);
490
491 #endif /* AVUTIL_FRAME_H */