libavutil: add mastering display metadata sidedata
[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 /**
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 AVActiveFormatDescription enum.
88      */
89     AV_FRAME_DATA_AFD,
90     /**
91      * Motion vectors exported by some codecs (on demand through the export_mvs
92      * flag set in the libavcodec AVCodecContext flags2 option).
93      * The data is the AVMotionVector struct defined in
94      * libavutil/motion_vector.h.
95      */
96     AV_FRAME_DATA_MOTION_VECTORS,
97     /**
98      * Recommmends skipping the specified number of samples. This is exported
99      * only if the "skip_manual" AVOption is set in libavcodec.
100      * This has the same format as AV_PKT_DATA_SKIP_SAMPLES.
101      * @code
102      * u32le number of samples to skip from start of this packet
103      * u32le number of samples to skip from end of this packet
104      * u8    reason for start skip
105      * u8    reason for end   skip (0=padding silence, 1=convergence)
106      * @endcode
107      */
108     AV_FRAME_DATA_SKIP_SAMPLES,
109     /**
110      * This side data must be associated with an audio frame and corresponds to
111      * enum AVAudioServiceType defined in avcodec.h.
112      */
113     AV_FRAME_DATA_AUDIO_SERVICE_TYPE,
114     /**
115      * Mastering display metadata associated with a video frame. The payload is
116      * an AVMasteringDisplayMetadata type and contains information about the
117      * mastering display color volume.
118      */
119     AV_FRAME_DATA_MASTERING_DISPLAY_METADATA
120 };
121
122 enum AVActiveFormatDescription {
123     AV_AFD_SAME         = 8,
124     AV_AFD_4_3          = 9,
125     AV_AFD_16_9         = 10,
126     AV_AFD_14_9         = 11,
127     AV_AFD_4_3_SP_14_9  = 13,
128     AV_AFD_16_9_SP_14_9 = 14,
129     AV_AFD_SP_4_3       = 15,
130 };
131
132
133 /**
134  * Structure to hold side data for an AVFrame.
135  *
136  * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added
137  * to the end with a minor bump.
138  */
139 typedef struct AVFrameSideData {
140     enum AVFrameSideDataType type;
141     uint8_t *data;
142     int      size;
143     AVDictionary *metadata;
144     AVBufferRef *buf;
145 } AVFrameSideData;
146
147 /**
148  * This structure describes decoded (raw) audio or video data.
149  *
150  * AVFrame must be allocated using av_frame_alloc(). Note that this only
151  * allocates the AVFrame itself, the buffers for the data must be managed
152  * through other means (see below).
153  * AVFrame must be freed with av_frame_free().
154  *
155  * AVFrame is typically allocated once and then reused multiple times to hold
156  * different data (e.g. a single AVFrame to hold frames received from a
157  * decoder). In such a case, av_frame_unref() will free any references held by
158  * the frame and reset it to its original clean state before it
159  * is reused again.
160  *
161  * The data described by an AVFrame is usually reference counted through the
162  * AVBuffer API. The underlying buffer references are stored in AVFrame.buf /
163  * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at
164  * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case,
165  * every single data plane must be contained in one of the buffers in
166  * AVFrame.buf or AVFrame.extended_buf.
167  * There may be a single buffer for all the data, or one separate buffer for
168  * each plane, or anything in between.
169  *
170  * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
171  * to the end with a minor bump.
172  * Similarly fields that are marked as to be only accessed by
173  * av_opt_ptr() can be reordered. This allows 2 forks to add fields
174  * without breaking compatibility with each other.
175  */
176 typedef struct AVFrame {
177 #define AV_NUM_DATA_POINTERS 8
178     /**
179      * pointer to the picture/channel planes.
180      * This might be different from the first allocated byte
181      *
182      * Some decoders access areas outside 0,0 - width,height, please
183      * see avcodec_align_dimensions2(). Some filters and swscale can read
184      * up to 16 bytes beyond the planes, if these filters are to be used,
185      * then 16 extra bytes must be allocated.
186      */
187     uint8_t *data[AV_NUM_DATA_POINTERS];
188
189     /**
190      * For video, size in bytes of each picture line.
191      * For audio, size in bytes of each plane.
192      *
193      * For audio, only linesize[0] may be set. For planar audio, each channel
194      * plane must be the same size.
195      *
196      * For video the linesizes should be multiples of the CPUs alignment
197      * preference, this is 16 or 32 for modern desktop CPUs.
198      * Some code requires such alignment other code can be slower without
199      * correct alignment, for yet other it makes no difference.
200      *
201      * @note The linesize may be larger than the size of usable data -- there
202      * may be extra padding present for performance reasons.
203      */
204     int linesize[AV_NUM_DATA_POINTERS];
205
206     /**
207      * pointers to the data planes/channels.
208      *
209      * For video, this should simply point to data[].
210      *
211      * For planar audio, each channel has a separate data pointer, and
212      * linesize[0] contains the size of each channel buffer.
213      * For packed audio, there is just one data pointer, and linesize[0]
214      * contains the total size of the buffer for all channels.
215      *
216      * Note: Both data and extended_data should always be set in a valid frame,
217      * but for planar audio with more channels that can fit in data,
218      * extended_data must be used in order to access all channels.
219      */
220     uint8_t **extended_data;
221
222     /**
223      * width and height of the video frame
224      */
225     int width, height;
226
227     /**
228      * number of audio samples (per channel) described by this frame
229      */
230     int nb_samples;
231
232     /**
233      * format of the frame, -1 if unknown or unset
234      * Values correspond to enum AVPixelFormat for video frames,
235      * enum AVSampleFormat for audio)
236      */
237     int format;
238
239     /**
240      * 1 -> keyframe, 0-> not
241      */
242     int key_frame;
243
244     /**
245      * Picture type of the frame.
246      */
247     enum AVPictureType pict_type;
248
249     /**
250      * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
251      */
252     AVRational sample_aspect_ratio;
253
254     /**
255      * Presentation timestamp in time_base units (time when frame should be shown to user).
256      */
257     int64_t pts;
258
259     /**
260      * PTS copied from the AVPacket that was decoded to produce this frame.
261      */
262     int64_t pkt_pts;
263
264     /**
265      * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used)
266      * This is also the Presentation time of this AVFrame calculated from
267      * only AVPacket.dts values without pts values.
268      */
269     int64_t pkt_dts;
270
271     /**
272      * picture number in bitstream order
273      */
274     int coded_picture_number;
275     /**
276      * picture number in display order
277      */
278     int display_picture_number;
279
280     /**
281      * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
282      */
283     int quality;
284
285     /**
286      * for some private data of the user
287      */
288     void *opaque;
289
290 #if FF_API_ERROR_FRAME
291     /**
292      * @deprecated unused
293      */
294     attribute_deprecated
295     uint64_t error[AV_NUM_DATA_POINTERS];
296 #endif
297
298     /**
299      * When decoding, this signals how much the picture must be delayed.
300      * extra_delay = repeat_pict / (2*fps)
301      */
302     int repeat_pict;
303
304     /**
305      * The content of the picture is interlaced.
306      */
307     int interlaced_frame;
308
309     /**
310      * If the content is interlaced, is top field displayed first.
311      */
312     int top_field_first;
313
314     /**
315      * Tell user application that palette has changed from previous frame.
316      */
317     int palette_has_changed;
318
319     /**
320      * reordered opaque 64bit (generally an integer or a double precision float
321      * PTS but can be anything).
322      * The user sets AVCodecContext.reordered_opaque to represent the input at
323      * that time,
324      * the decoder reorders values as needed and sets AVFrame.reordered_opaque
325      * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
326      * @deprecated in favor of pkt_pts
327      */
328     int64_t reordered_opaque;
329
330     /**
331      * Sample rate of the audio data.
332      */
333     int sample_rate;
334
335     /**
336      * Channel layout of the audio data.
337      */
338     uint64_t channel_layout;
339
340     /**
341      * AVBuffer references backing the data for this frame. If all elements of
342      * this array are NULL, then this frame is not reference counted. This array
343      * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must
344      * also be non-NULL for all j < i.
345      *
346      * There may be at most one AVBuffer per data plane, so for video this array
347      * always contains all the references. For planar audio with more than
348      * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in
349      * this array. Then the extra AVBufferRef pointers are stored in the
350      * extended_buf array.
351      */
352     AVBufferRef *buf[AV_NUM_DATA_POINTERS];
353
354     /**
355      * For planar audio which requires more than AV_NUM_DATA_POINTERS
356      * AVBufferRef pointers, this array will hold all the references which
357      * cannot fit into AVFrame.buf.
358      *
359      * Note that this is different from AVFrame.extended_data, which always
360      * contains all the pointers. This array only contains the extra pointers,
361      * which cannot fit into AVFrame.buf.
362      *
363      * This array is always allocated using av_malloc() by whoever constructs
364      * the frame. It is freed in av_frame_unref().
365      */
366     AVBufferRef **extended_buf;
367     /**
368      * Number of elements in extended_buf.
369      */
370     int        nb_extended_buf;
371
372     AVFrameSideData **side_data;
373     int            nb_side_data;
374
375 /**
376  * @defgroup lavu_frame_flags AV_FRAME_FLAGS
377  * Flags describing additional frame properties.
378  *
379  * @{
380  */
381
382 /**
383  * The frame data may be corrupted, e.g. due to decoding errors.
384  */
385 #define AV_FRAME_FLAG_CORRUPT       (1 << 0)
386 /**
387  * @}
388  */
389
390     /**
391      * Frame flags, a combination of @ref lavu_frame_flags
392      */
393     int flags;
394
395     /**
396      * MPEG vs JPEG YUV range.
397      * It must be accessed using av_frame_get_color_range() and
398      * av_frame_set_color_range().
399      * - encoding: Set by user
400      * - decoding: Set by libavcodec
401      */
402     enum AVColorRange color_range;
403
404     enum AVColorPrimaries color_primaries;
405
406     enum AVColorTransferCharacteristic color_trc;
407
408     /**
409      * YUV colorspace type.
410      * It must be accessed using av_frame_get_colorspace() and
411      * av_frame_set_colorspace().
412      * - encoding: Set by user
413      * - decoding: Set by libavcodec
414      */
415     enum AVColorSpace colorspace;
416
417     enum AVChromaLocation chroma_location;
418
419     /**
420      * frame timestamp estimated using various heuristics, in stream time base
421      * Code outside libavutil should access this field using:
422      * av_frame_get_best_effort_timestamp(frame)
423      * - encoding: unused
424      * - decoding: set by libavcodec, read by user.
425      */
426     int64_t best_effort_timestamp;
427
428     /**
429      * reordered pos from the last AVPacket that has been input into the decoder
430      * Code outside libavutil should access this field using:
431      * av_frame_get_pkt_pos(frame)
432      * - encoding: unused
433      * - decoding: Read by user.
434      */
435     int64_t pkt_pos;
436
437     /**
438      * duration of the corresponding packet, expressed in
439      * AVStream->time_base units, 0 if unknown.
440      * Code outside libavutil should access this field using:
441      * av_frame_get_pkt_duration(frame)
442      * - encoding: unused
443      * - decoding: Read by user.
444      */
445     int64_t pkt_duration;
446
447     /**
448      * metadata.
449      * Code outside libavutil should access this field using:
450      * av_frame_get_metadata(frame)
451      * - encoding: Set by user.
452      * - decoding: Set by libavcodec.
453      */
454     AVDictionary *metadata;
455
456     /**
457      * decode error flags of the frame, set to a combination of
458      * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
459      * were errors during the decoding.
460      * Code outside libavutil should access this field using:
461      * av_frame_get_decode_error_flags(frame)
462      * - encoding: unused
463      * - decoding: set by libavcodec, read by user.
464      */
465     int decode_error_flags;
466 #define FF_DECODE_ERROR_INVALID_BITSTREAM   1
467 #define FF_DECODE_ERROR_MISSING_REFERENCE   2
468
469     /**
470      * number of audio channels, only used for audio.
471      * Code outside libavutil should access this field using:
472      * av_frame_get_channels(frame)
473      * - encoding: unused
474      * - decoding: Read by user.
475      */
476     int channels;
477
478     /**
479      * size of the corresponding packet containing the compressed
480      * frame. It must be accessed using av_frame_get_pkt_size() and
481      * av_frame_set_pkt_size().
482      * It is set to a negative value if unknown.
483      * - encoding: unused
484      * - decoding: set by libavcodec, read by user.
485      */
486     int pkt_size;
487
488 #if FF_API_FRAME_QP
489     /**
490      * QP table
491      * Not to be accessed directly from outside libavutil
492      */
493     attribute_deprecated
494     int8_t *qscale_table;
495     /**
496      * QP store stride
497      * Not to be accessed directly from outside libavutil
498      */
499     attribute_deprecated
500     int qstride;
501
502     attribute_deprecated
503     int qscale_type;
504
505     /**
506      * Not to be accessed directly from outside libavutil
507      */
508     AVBufferRef *qp_table_buf;
509 #endif
510 } AVFrame;
511
512 /**
513  * Accessors for some AVFrame fields.
514  * The position of these field in the structure is not part of the ABI,
515  * they should not be accessed directly outside libavutil.
516  */
517 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
518 void    av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
519 int64_t av_frame_get_pkt_duration         (const AVFrame *frame);
520 void    av_frame_set_pkt_duration         (AVFrame *frame, int64_t val);
521 int64_t av_frame_get_pkt_pos              (const AVFrame *frame);
522 void    av_frame_set_pkt_pos              (AVFrame *frame, int64_t val);
523 int64_t av_frame_get_channel_layout       (const AVFrame *frame);
524 void    av_frame_set_channel_layout       (AVFrame *frame, int64_t val);
525 int     av_frame_get_channels             (const AVFrame *frame);
526 void    av_frame_set_channels             (AVFrame *frame, int     val);
527 int     av_frame_get_sample_rate          (const AVFrame *frame);
528 void    av_frame_set_sample_rate          (AVFrame *frame, int     val);
529 AVDictionary *av_frame_get_metadata       (const AVFrame *frame);
530 void          av_frame_set_metadata       (AVFrame *frame, AVDictionary *val);
531 int     av_frame_get_decode_error_flags   (const AVFrame *frame);
532 void    av_frame_set_decode_error_flags   (AVFrame *frame, int     val);
533 int     av_frame_get_pkt_size(const AVFrame *frame);
534 void    av_frame_set_pkt_size(AVFrame *frame, int val);
535 AVDictionary **avpriv_frame_get_metadatap(AVFrame *frame);
536 #if FF_API_FRAME_QP
537 int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type);
538 int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type);
539 #endif
540 enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame);
541 void    av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val);
542 enum AVColorRange av_frame_get_color_range(const AVFrame *frame);
543 void    av_frame_set_color_range(AVFrame *frame, enum AVColorRange val);
544
545 /**
546  * Get the name of a colorspace.
547  * @return a static string identifying the colorspace; can be NULL.
548  */
549 const char *av_get_colorspace_name(enum AVColorSpace val);
550
551 /**
552  * Allocate an AVFrame and set its fields to default values.  The resulting
553  * struct must be freed using av_frame_free().
554  *
555  * @return An AVFrame filled with default values or NULL on failure.
556  *
557  * @note this only allocates the AVFrame itself, not the data buffers. Those
558  * must be allocated through other means, e.g. with av_frame_get_buffer() or
559  * manually.
560  */
561 AVFrame *av_frame_alloc(void);
562
563 /**
564  * Free the frame and any dynamically allocated objects in it,
565  * e.g. extended_data. If the frame is reference counted, it will be
566  * unreferenced first.
567  *
568  * @param frame frame to be freed. The pointer will be set to NULL.
569  */
570 void av_frame_free(AVFrame **frame);
571
572 /**
573  * Set up a new reference to the data described by the source frame.
574  *
575  * Copy frame properties from src to dst and create a new reference for each
576  * AVBufferRef from src.
577  *
578  * If src is not reference counted, new buffers are allocated and the data is
579  * copied.
580  *
581  * @return 0 on success, a negative AVERROR on error
582  */
583 int av_frame_ref(AVFrame *dst, const AVFrame *src);
584
585 /**
586  * Create a new frame that references the same data as src.
587  *
588  * This is a shortcut for av_frame_alloc()+av_frame_ref().
589  *
590  * @return newly created AVFrame on success, NULL on error.
591  */
592 AVFrame *av_frame_clone(const AVFrame *src);
593
594 /**
595  * Unreference all the buffers referenced by frame and reset the frame fields.
596  */
597 void av_frame_unref(AVFrame *frame);
598
599 /**
600  * Move everything contained in src to dst and reset src.
601  */
602 void av_frame_move_ref(AVFrame *dst, AVFrame *src);
603
604 /**
605  * Allocate new buffer(s) for audio or video data.
606  *
607  * The following fields must be set on frame before calling this function:
608  * - format (pixel format for video, sample format for audio)
609  * - width and height for video
610  * - nb_samples and channel_layout for audio
611  *
612  * This function will fill AVFrame.data and AVFrame.buf arrays and, if
613  * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf.
614  * For planar formats, one buffer will be allocated for each plane.
615  *
616  * @param frame frame in which to store the new buffers.
617  * @param align required buffer size alignment
618  *
619  * @return 0 on success, a negative AVERROR on error.
620  */
621 int av_frame_get_buffer(AVFrame *frame, int align);
622
623 /**
624  * Check if the frame data is writable.
625  *
626  * @return A positive value if the frame data is writable (which is true if and
627  * only if each of the underlying buffers has only one reference, namely the one
628  * stored in this frame). Return 0 otherwise.
629  *
630  * If 1 is returned the answer is valid until av_buffer_ref() is called on any
631  * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
632  *
633  * @see av_frame_make_writable(), av_buffer_is_writable()
634  */
635 int av_frame_is_writable(AVFrame *frame);
636
637 /**
638  * Ensure that the frame data is writable, avoiding data copy if possible.
639  *
640  * Do nothing if the frame is writable, allocate new buffers and copy the data
641  * if it is not.
642  *
643  * @return 0 on success, a negative AVERROR on error.
644  *
645  * @see av_frame_is_writable(), av_buffer_is_writable(),
646  * av_buffer_make_writable()
647  */
648 int av_frame_make_writable(AVFrame *frame);
649
650 /**
651  * Copy the frame data from src to dst.
652  *
653  * This function does not allocate anything, dst must be already initialized and
654  * allocated with the same parameters as src.
655  *
656  * This function only copies the frame data (i.e. the contents of the data /
657  * extended data arrays), not any other properties.
658  *
659  * @return >= 0 on success, a negative AVERROR on error.
660  */
661 int av_frame_copy(AVFrame *dst, const AVFrame *src);
662
663 /**
664  * Copy only "metadata" fields from src to dst.
665  *
666  * Metadata for the purpose of this function are those fields that do not affect
667  * the data layout in the buffers.  E.g. pts, sample rate (for audio) or sample
668  * aspect ratio (for video), but not width/height or channel layout.
669  * Side data is also copied.
670  */
671 int av_frame_copy_props(AVFrame *dst, const AVFrame *src);
672
673 /**
674  * Get the buffer reference a given data plane is stored in.
675  *
676  * @param plane index of the data plane of interest in frame->extended_data.
677  *
678  * @return the buffer reference that contains the plane or NULL if the input
679  * frame is not valid.
680  */
681 AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane);
682
683 /**
684  * Add a new side data to a frame.
685  *
686  * @param frame a frame to which the side data should be added
687  * @param type type of the added side data
688  * @param size size of the side data
689  *
690  * @return newly added side data on success, NULL on error
691  */
692 AVFrameSideData *av_frame_new_side_data(AVFrame *frame,
693                                         enum AVFrameSideDataType type,
694                                         int size);
695
696 /**
697  * @return a pointer to the side data of a given type on success, NULL if there
698  * is no side data with such type in this frame.
699  */
700 AVFrameSideData *av_frame_get_side_data(const AVFrame *frame,
701                                         enum AVFrameSideDataType type);
702
703 /**
704  * If side data of the supplied type exists in the frame, free it and remove it
705  * from the frame.
706  */
707 void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type);
708
709 /**
710  * @return a string identifying the side data type
711  */
712 const char *av_frame_side_data_name(enum AVFrameSideDataType type);
713
714 /**
715  * @}
716  */
717
718 #endif /* AVUTIL_FRAME_H */