2 * Copyright (c) 2016 Neil Birkbeck <neil.birkbeck@gmail.com>
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVUTIL_MASTERING_DISPLAY_METADATA_H
22 #define AVUTIL_MASTERING_DISPLAY_METADATA_H
27 * Mastering display metadata capable of representing the color volume of
28 * the display used to master the content (SMPTE 2086:2014).
30 * To be used as payload of a AVFrameSideData or AVPacketSideData with the
33 * @note The struct should be allocated with av_mastering_display_metadata_alloc()
34 * and its size is not a part of the public ABI.
36 typedef struct AVMasteringDisplayMetadata {
38 * CIE 1931 xy chromaticity coords of color primaries (r, g, b order).
40 float display_primaries[3][2];
43 * CIE 1931 xy chromaticity coords of white point.
48 * Min luminance of mastering display (cd/m^2).
53 * Max luminance of mastering display (cd/m^2).
58 * Flag indicating whether the display primaries (and white point) are set.
63 * Flag indicating whether the luminance (min_ and max_) have been set.
67 } AVMasteringDisplayMetadata;
70 * Allocate an AVMasteringDisplayMetadata structure and set its fields to
71 * default values. The resulting struct can be freed using av_freep().
73 * @return An AVMasteringDisplayMetadata filled with default values or NULL
76 AVMasteringDisplayMetadata *av_mastering_display_metadata_alloc(void);
79 * Allocate a complete AVMasteringDisplayMetadata and add it to the frame.
81 * @param frame The frame which side data is added to.
83 * @return The AVMasteringDisplayMetadata structure to be filled by caller.
85 AVMasteringDisplayMetadata *av_mastering_display_metadata_create_side_data(AVFrame *frame);
87 #endif /* AVUTIL_MASTERING_DISPLAY_METADATA_H */