Be more cautious in CertificateChain::private_key_valid.

[libdcp.git] / src / colour_conversion.h

diff --git a/src/colour_conversion.h b/src/colour_conversion.h
index e1ee1b1163a8347d854878605fad9c3ad5830485..c6f6f5296fa2447aed168079cff93cff21e808e2 100644 (file)
--- a/src/colour_conversion.h
+++ b/src/colour_conversion.h
@@ -1,24 +1,48 @@
 /*
     Copyright (C) 2014-2015 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of libdcp.
+
+    libdcp is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    libdcp is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
+    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
+/** @file  src/colour_conversion.h
+ *  @brief ColourConversion class.
+ */
+
+#ifndef DCP_COLOUR_CONVERSION_H
+#define DCP_COLOUR_CONVERSION_H
+
 #include "chromaticity.h"
 #include <boost/shared_ptr.hpp>
+#if BOOST_VERSION >= 106400
+#include <boost/serialization/array_wrapper.hpp>
+#endif
 #include <boost/numeric/ublas/matrix.hpp>
 #include <boost/optional.hpp>
 
@@ -32,12 +56,17 @@ enum YUVToRGB {
        YUV_TO_RGB_COUNT
 };
 
+/** @class ColourConversion
+ *  @brief A representation of all the parameters involved the colourspace conversion
+ *  of a YUV image to XYZ (via RGB).
+ */
 class ColourConversion
 {
 public:
        ColourConversion ()
+               : _yuv_to_rgb (YUV_TO_RGB_REC601)
        {}
-       
+
        ColourConversion (
                boost::shared_ptr<const TransferFunction> in,
                YUVToRGB yuv_to_rgb,
@@ -76,7 +105,7 @@ public:
        boost::optional<Chromaticity> adjusted_white () const {
                return _adjusted_white;
        }
-       
+
        boost::shared_ptr<const TransferFunction> out () const {
                return _out;
        }
@@ -112,7 +141,7 @@ public:
        void unset_adjusted_white () {
                _adjusted_white = boost::optional<Chromaticity> ();
        }
-       
+
        void set_out (boost::shared_ptr<const TransferFunction> f) {
                _out = f;
        }
@@ -126,9 +155,15 @@ public:
        static ColourConversion const & srgb_to_xyz ();
        static ColourConversion const & rec601_to_xyz ();
        static ColourConversion const & rec709_to_xyz ();
+       static ColourConversion const & p3_to_xyz ();
+       static ColourConversion const & rec1886_to_xyz ();
+       static ColourConversion const & rec2020_to_xyz ();
+       static ColourConversion const & s_gamut3_to_xyz ();
 
 protected:
+       /** Input transfer function (probably a gamma function, or something similar) */
        boost::shared_ptr<const TransferFunction> _in;
+       /** Conversion to use from YUV to RGB */
        YUVToRGB _yuv_to_rgb;
        Chromaticity _red;
        Chromaticity _green;
@@ -136,7 +171,10 @@ protected:
        Chromaticity _white;
        /** White point that we are adjusting to using a Bradford matrix */
        boost::optional<Chromaticity> _adjusted_white;
+       /** Output transfer function (probably an inverse gamma function, or something similar) */
        boost::shared_ptr<const TransferFunction> _out;
 };
 
 }
+
+#endif