path: root/src/colour_conversion.h

/*
    Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>

    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.

    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 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 LIBDCP_COLOUR_CONVERSION_H
#define LIBDCP_COLOUR_CONVERSION_H


#include "chromaticity.h"
#include "piecewise_lut.h"
#include "types.h"
#include <memory>
#if BOOST_VERSION >= 106400
#include <boost/serialization/array_wrapper.hpp>
#endif
#include <boost/numeric/ublas/matrix.hpp>
#include <boost/optional.hpp>
#include <stdint.h>


namespace dcp {


class Image;
class OpenJPEGImage;
class TransferFunction;


enum class YUVToRGB {
	REC601,
	REC709,
	REC2020,
	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(YUVToRGB::REC601)
	{}

	ColourConversion(
		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_j2k,
		std::shared_ptr<const TransferFunction> out_mpeg2
		);

	std::shared_ptr<const TransferFunction> in() const {
		return _in;
	}

	YUVToRGB yuv_to_rgb() const {
		return _yuv_to_rgb;
	}

	Chromaticity red() const {
		return _red;
	}

	Chromaticity green() const {
		return _green;
	}

	Chromaticity blue() const {
		return _blue;
	}

	Chromaticity white() const {
		return _white;
	}

	boost::optional<Chromaticity> adjusted_white() const {
		return _adjusted_white;
	}

	/** Output transfer function when going to XYZ for JPEG2000 */
	std::shared_ptr<const TransferFunction> out_j2k() const {
		return _out_j2k;
	}

	/** Output transfer function when going to MPEG2 */
	std::shared_ptr<const TransferFunction> out_mpeg2() const {
		return _out_mpeg2;
	}

	void set_in(std::shared_ptr<const TransferFunction> f) {
		_in = f;
	}

	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_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_j2k(std::shared_ptr<const TransferFunction> f) {
		_out_j2k = f;
	}

	void set_out_mpeg2(std::shared_ptr<const TransferFunction> f) {
		_out_mpeg2 = f;
	}

	bool about_equal(ColourConversion const & other, float epsilon) const;

	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_dcp();
	static ColourConversion const & rec601_to_dcp();
	static ColourConversion const & rec709_to_dcp();
	static ColourConversion const & p3_to_dcp();
	static ColourConversion const & rec1886_to_dcp();
	static ColourConversion const & rec2020_to_dcp();
	static ColourConversion const & s_gamut3_to_dcp();

protected:
	/** 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 to be used when going to XYZ for JPEG2000
	 *  Probably an inverse gamma function, or something similar.
	 */
	std::shared_ptr<const TransferFunction> _out_j2k;
	/** Output transfer function to be used when going to MPEG2 */
	std::shared_ptr<const TransferFunction> _out_mpeg2;
};


/** Convert an XYZ image to RGBA.
 *  @param xyz_image Image in XYZ.
 *  @param conversion Colour conversion to use.
 *  @param argb Buffer to fill with RGBA data.  The format of the data is:
 *
 *  <pre>
 *  Byte   /- 0 -------|- 1 --------|- 2 --------|- 3 --------|- 4 --------|- 5 --------| ...
 *         |(0, 0) Blue|(0, 0)Green |(0, 0) Red  |(0, 0) Alpha|(0, 1) Blue |(0, 1) Green| ...
 *  </pre>
 *
 *  So that the first byte is the blue component of the pixel at x=0, y=0, the second
 *  is the green component, and so on.
 *
 *  Lines are packed so that the second row directly follows the first.
 */
extern void xyz_to_rgba(
	std::shared_ptr<const OpenJPEGImage>,
	ColourConversion const & conversion,
	uint8_t* rgba,
	int stride
	);


/** Convert an XYZ image to 48bpp RGB.
 *  @param xyz_image Frame in XYZ.
 *  @param conversion Colour conversion to use.
 *  @param rgb Buffer to fill with RGB data.  Format is packed RGB
 *  16:16:16, 48bpp, 16R, 16G, 16B, with the 2-byte value for each
 *  R/G/B component stored as little-endian; i.e. AV_PIX_FMT_RGB48LE.
 *  @param stride Stride for RGB data in bytes.
 *  @param note Optional handler for any notes that may be made during the conversion (e.g. when clamping occurs).
 */
extern void xyz_to_rgb(
	std::shared_ptr<const OpenJPEGImage>,
	ColourConversion const & conversion,
	uint8_t* rgb,
	int stride,
	boost::optional<NoteHandler> note = boost::optional<NoteHandler> ()
	);


extern PiecewiseLUT2 make_inverse_gamma_lut(std::shared_ptr<const TransferFunction> fn, int scale);


/** @param rgb RGB data; packed RGB 16:16:16, 48bpp, 16R, 16G, 16B,
 *  with the 2-byte value for each R/G/B component stored as
 *  little-endian; i.e. AV_PIX_FMT_RGB48LE.
 *  @param dst Buffer to fill with packed 16-bit XYZ data, i.e. first
 *  16-bit word is X, second is Y etc.
 *  @param size size of RGB image in pixels.
 *  @param size stride of RGB data in pixels.
 */
extern void rgb_to_xyz(
	uint8_t const * rgb,
	uint16_t* dst,
	dcp::Size size,
	int stride,
	ColourConversion const& conversion
	);


/** @param rgb RGB data; packed RGB 16:16:16, 48bpp, 16R, 16G, 16B,
 *  with the 2-byte value for each R/G/B component stored as
 *  little-endian; i.e. AV_PIX_FMT_RGB48LE.
 *  @param size size of RGB image in pixels.
 *  @param size stride of RGB data in pixels.
 */
extern std::shared_ptr<OpenJPEGImage> rgb_to_xyz(
	uint8_t const * rgb,
	dcp::Size size,
	int stride,
	ColourConversion const& conversion
	);


/** @param conversion Colour conversion.
 *  @param matrix Filled in with the product of the RGB to XYZ matrix, the Bradford transform and the DCI companding.
 */
extern void combined_rgb_to_xyz(ColourConversion const & conversion, double* matrix);


extern void convert_rgb_gamma(
	uint8_t* rgb,
	dcp::Size size,
	int stride,
	ColourConversion const& conversion
	);


}

#endif