git.sesse.net Git - ffmpeg/blob - libavutil/mastering_display_metadata.h

   1 /**
   2  * Copyright (c) 2016 Neil Birkbeck <neil.birkbeck@gmail.com>
   3  *
   4  * This file is part of FFmpeg.
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 #ifndef AVUTIL_MASTERING_DISPLAY_METADATA_H
  22 #define AVUTIL_MASTERING_DISPLAY_METADATA_H
  23
  24 #include "frame.h"
  25
  26 /**
  27  * Mastering display metadata capable of representing the color volume of
  28  * the display used to master the content (SMPTE 2086:2014).
  29  *
  30  * To be used as payload of a AVFrameSideData or AVPacketSideData with the
  31  * appropriate type.
  32  *
  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.
  35  */
  36 typedef struct AVMasteringDisplayMetadata {
  37     /**
  38      * CIE 1931 xy chromaticity coords of color primaries (r, g, b order).
  39      */
  40     float display_primaries[3][2];
  41
  42     /**
  43      * CIE 1931 xy chromaticity coords of white point.
  44      */
  45     float white_point[2];
  46
  47     /**
  48      * Min luminance of mastering display (cd/m^2).
  49      */
  50     float min_luminance;
  51
  52     /**
  53      * Max luminance of mastering display (cd/m^2).
  54      */
  55     float max_luminance;
  56
  57     /**
  58      * Flag indicating whether the display primaries (and white point) are set.
  59      */
  60     int has_primaries;
  61
  62     /**
  63      * Flag indicating whether the luminance (min_ and max_) have been set.
  64      */
  65     int has_luminance;
  66
  67 } AVMasteringDisplayMetadata;
  68
  69 /**
  70  * Allocate an AVMasteringDisplayMetadata structure and set its fields to
  71  * default values. The resulting struct can be freed using av_freep().
  72  *
  73  * @return An AVMasteringDisplayMetadata filled with default values or NULL
  74  *         on failure.
  75  */
  76 AVMasteringDisplayMetadata *av_mastering_display_metadata_alloc(void);
  77
  78 /**
  79  * Allocate a complete AVMasteringDisplayMetadata and add it to the frame.
  80  *
  81  * @param frame The frame which side data is added to.
  82  *
  83  * @return The AVMasteringDisplayMetadata structure to be filled by caller.
  84  */
  85 AVMasteringDisplayMetadata *av_mastering_display_metadata_create_side_data(AVFrame *frame);
  86
  87 #endif /* AVUTIL_MASTERING_DISPLAY_METADATA_H */