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

    This file is part of DCP-o-matic.

    DCP-o-matic 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.

    DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.

*/


#ifndef DCPOMATIC_CAPTION_CONTENT_H
#define DCPOMATIC_CAPTION_CONTENT_H


#include "content_part.h"
#include "dcp_text_track.h"
#include <libcxml/cxml.h>
#include <dcp/language_tag.h>
#include <dcp/types.h>
#include <boost/signals2.hpp>


namespace dcpomatic {
	class Font;
}

class TextContentProperty
{
public:
	static int constexpr X_OFFSET = 500;
	static int constexpr Y_OFFSET = 501;
	static int constexpr X_SCALE = 502;
	static int constexpr Y_SCALE = 503;
	static int constexpr USE = 504;
	static int constexpr BURN = 505;
	static int constexpr FONTS = 506;
	static int constexpr COLOUR = 507;
	static int constexpr EFFECT = 508;
	static int constexpr EFFECT_COLOUR = 509;
	static int constexpr LINE_SPACING = 510;
	static int constexpr FADE_IN = 511;
	static int constexpr FADE_OUT = 512;
	static int constexpr OUTLINE_WIDTH = 513;
	static int constexpr TYPE = 514;
	static int constexpr DCP_TRACK = 515;
	static int constexpr LANGUAGE = 516;
	static int constexpr LANGUAGE_IS_ADDITIONAL = 517;
};


/** @class TextContent
 *  @brief Description of how some text content should be presented.
 *
 *  There are `bitmap' subtitles and `plain' subtitles (plain text),
 *  and not all of the settings in this class correspond to both types.
 */
class TextContent : public ContentPart
{
public:
	TextContent(Content* parent, TextType type, TextType original_type);
	TextContent(Content* parent, std::vector<std::shared_ptr<Content>>);
	TextContent(Content* parent, cxml::ConstNodePtr, int version, std::list<std::string>& notes);

	void as_xml(xmlpp::Element*) const;
	std::string identifier() const;
	void take_settings_from(std::shared_ptr<const TextContent> c);

	void clear_fonts();
	void add_font(std::shared_ptr<dcpomatic::Font> font);
	std::shared_ptr<dcpomatic::Font> get_font(std::string id) const;

	void set_use(bool);
	void set_burn(bool);
	void set_x_offset(double);
	void set_y_offset(double);
	void set_x_scale(double);
	void set_y_scale(double);
	void set_colour(dcp::Colour);
	void unset_colour();
	void set_effect(dcp::Effect);
	void unset_effect();
	void set_effect_colour(dcp::Colour);
	void unset_effect_colour();
	void set_line_spacing(double s);
	void set_fade_in(dcpomatic::ContentTime);
	void unset_fade_in();
	void set_fade_out(dcpomatic::ContentTime);
	void set_outline_width(int);
	void unset_fade_out();
	void set_type(TextType type);
	void set_dcp_track(DCPTextTrack track);
	void unset_dcp_track();
	void set_language(boost::optional<dcp::LanguageTag> language = boost::none);
	void set_language_is_additional(bool additional);

	bool use() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _use;
	}

	bool burn() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _burn;
	}

	double x_offset() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _x_offset;
	}

	double y_offset() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _y_offset;
	}

	double x_scale() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _x_scale;
	}

	double y_scale() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _y_scale;
	}

	std::list<std::shared_ptr<dcpomatic::Font>> fonts() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _fonts;
	}

	boost::optional<dcp::Colour> colour() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _colour;
	}

	boost::optional<dcp::Effect> effect() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _effect;
	}

	boost::optional<dcp::Colour> effect_colour() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _effect_colour;
	}

	double line_spacing() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _line_spacing;
	}

	boost::optional<dcpomatic::ContentTime> fade_in() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _fade_in;
	}

	boost::optional<dcpomatic::ContentTime> fade_out() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _fade_out;
	}

	int outline_width() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _outline_width;
	}

	TextType type() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _type;
	}

	TextType original_type() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _original_type;
	}

	boost::optional<DCPTextTrack> dcp_track() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _dcp_track;
	}

	boost::optional<dcp::LanguageTag> language() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _language;
	}

	bool language_is_additional() const {
		boost::mutex::scoped_lock lm(_mutex);
		return _language_is_additional;
	}

	static std::vector<std::shared_ptr<TextContent>> from_xml(Content* parent, cxml::ConstNodePtr, int version, std::list<std::string>& notes);

private:
	friend struct ffmpeg_pts_offset_test;

	void font_changed();
	void connect_to_fonts();
	std::shared_ptr<dcpomatic::Font> get_font_unlocked(std::string id) const;

	std::list<boost::signals2::connection> _font_connections;

	bool _use;
	bool _burn;
	/** x offset for placing subtitles, as a proportion of the container width;
	 * +ve is further right, -ve is further left.
	 */
	double _x_offset;
	/** y offset for placing subtitles, as a proportion of the container height;
	 *  +ve is further down the frame, -ve is further up.
	 */
	double _y_offset;
	/** x scale factor to apply to subtitles */
	double _x_scale;
	/** y scale factor to apply to subtitles */
	double _y_scale;
	/** Fonts used by this content.  They are added during content examination, then
	 *  saved/loaded from metadata.xml.  This is so the user can change the font in
	 *  used by a piece of content.
	 */
	std::list<std::shared_ptr<dcpomatic::Font>> _fonts;
	boost::optional<dcp::Colour> _colour;
	boost::optional<dcp::Effect> _effect;
	boost::optional<dcp::Colour> _effect_colour;
	/** scaling factor for line spacing; 1 is "standard", < 1 is closer together, > 1 is further apart */
	double _line_spacing;
	boost::optional<dcpomatic::ContentTime> _fade_in;
	boost::optional<dcpomatic::ContentTime> _fade_out;
	int _outline_width;
	/** what these captions will be used for in the output DCP (not necessarily what
	 *  they were originally).
	 */
	TextType _type;
	/** the original type of these captions in their content */
	TextType _original_type;
	/** the track of closed captions that this content should be put in, or empty to put in the default (only) track */
	boost::optional<DCPTextTrack> _dcp_track;
	boost::optional<dcp::LanguageTag> _language;
	bool _language_is_additional = false;
};

#endif