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