Missing finalize() in dcpdecryptmxf.
[libdcp.git] / src / colour_conversion.h
index e2a8c6bcf2d4d1c9a3363685ce78cca9a74c11e5..83ba3ad32ce9f750a7314318b1eb10f8df2cb020 100644 (file)
 /*
-    Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2021 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.
 */
 
-#include <boost/shared_ptr.hpp>
+
+/** @file  src/colour_conversion.h
+ *  @brief ColourConversion class.
+ */
+
+
+#ifndef DCP_COLOUR_CONVERSION_H
+#define DCP_COLOUR_CONVERSION_H
+
+
+#include "chromaticity.h"
+#include <memory>
+#if BOOST_VERSION >= 106400
+#include <boost/serialization/array_wrapper.hpp>
+#endif
 #include <boost/numeric/ublas/matrix.hpp>
+#include <boost/optional.hpp>
+
 
 namespace dcp {
 
+
 class TransferFunction;
 
+
+enum class YUVToRGB {
+       REC601,
+       REC709,
+       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 ()
-               : _matrix (3, 3)
+               : _yuv_to_rgb (YUVToRGB::REC601)
        {}
-       
+
        ColourConversion (
-               boost::shared_ptr<const TransferFunction> in,
-               double const matrix[3][3],
-               boost::shared_ptr<const TransferFunction> out
+               std::shared_ptr<const TransferFunction> in,
+               YUVToRGB yuv_to_rgb,
+               Chromaticity red,
+               Chromaticity green,
+               Chromaticity blue,
+               Chromaticity white,
+               boost::optional<Chromaticity> adjusted_white,
+               std::shared_ptr<const TransferFunction> out
                );
 
-       boost::shared_ptr<const TransferFunction> in () const {
+       std::shared_ptr<const TransferFunction> in () const {
                return _in;
        }
 
-       boost::numeric::ublas::matrix<double> matrix () const {
-               return _matrix;
+       YUVToRGB yuv_to_rgb () const {
+               return _yuv_to_rgb;
+       }
+
+       Chromaticity red () const {
+               return _red;
+       }
+
+       Chromaticity green () const {
+               return _green;
+       }
+
+       Chromaticity blue () const {
+               return _blue;
        }
 
-       boost::shared_ptr<const TransferFunction> out () const {
+       Chromaticity white () const {
+               return _white;
+       }
+
+       boost::optional<Chromaticity> adjusted_white () const {
+               return _adjusted_white;
+       }
+
+       std::shared_ptr<const TransferFunction> out () const {
                return _out;
        }
 
-       void set_in (boost::shared_ptr<const TransferFunction> f) {
+       void set_in (std::shared_ptr<const TransferFunction> f) {
                _in = f;
        }
 
-       void set_matrix (boost::numeric::ublas::matrix<double> m) {
-               _matrix = m;
+       void set_yuv_to_rgb (YUVToRGB y) {
+               _yuv_to_rgb = y;
+       }
+
+       void set_red (Chromaticity red) {
+               _red = red;
+       }
+
+       void set_green (Chromaticity green) {
+               _green = green;
+       }
+
+       void set_blue (Chromaticity blue) {
+               _blue = blue;
        }
 
-       void set_out (boost::shared_ptr<const TransferFunction> f) {
+       void set_white (Chromaticity white) {
+               _white = white;
+       }
+
+       void set_adjusted_white (Chromaticity adjusted_white) {
+               _adjusted_white = adjusted_white;
+       }
+
+       void unset_adjusted_white () {
+               _adjusted_white = boost::optional<Chromaticity> ();
+       }
+
+       void set_out (std::shared_ptr<const TransferFunction> f) {
                _out = f;
        }
 
        bool about_equal (ColourConversion const & other, float epsilon) const;
 
-       static ColourConversion srgb_to_xyz;
-       static ColourConversion xyz_to_srgb;
-       static ColourConversion rec709_to_xyz;
+       boost::numeric::ublas::matrix<double> rgb_to_xyz () const;
+       boost::numeric::ublas::matrix<double> xyz_to_rgb () const;
+       boost::numeric::ublas::matrix<double> bradford () const;
+
+       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:
-       boost::shared_ptr<const TransferFunction> _in;
-       boost::numeric::ublas::matrix<double> _matrix;
-       boost::shared_ptr<const TransferFunction> _out;
+       /** Input transfer function (probably a gamma function, or something similar) */
+       std::shared_ptr<const TransferFunction> _in;
+       /** Conversion to use from YUV to RGB */
+       YUVToRGB _yuv_to_rgb;
+       Chromaticity _red;
+       Chromaticity _green;
+       Chromaticity _blue;
+       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) */
+       std::shared_ptr<const TransferFunction> _out;
 };
 
+
 }
+
+
+#endif