X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fsubtitle_content.h;h=b64e4787b536b1d7fec96519027155ab9312e736;hb=c6871fe8617b3de03662b7630355059393bf8043;hp=09cc92709b2a9a125efec4eff62ae7b83bded7a1;hpb=19f94521139aac13ef8fb4eaa55855b2ada307b4;p=dcpomatic.git

diff --git a/src/lib/subtitle_content.h b/src/lib/subtitle_content.h
index 09cc92709..b64e4787b 100644
--- a/src/lib/subtitle_content.h
+++ b/src/lib/subtitle_content.h
@@ -1,19 +1,20 @@
 /*
-    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    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.
 
-    This program is distributed in the hope that it will be useful,
+    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 this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
@@ -39,24 +40,29 @@ public:
 	static int const LANGUAGE;
 	static int const FONTS;
 	static int const COLOUR;
-	static int const OUTLINE;
-	static int const OUTLINE_COLOUR;
+	static int const EFFECT;
+	static int const EFFECT_COLOUR;
+	static int const LINE_SPACING;
+	static int const FADE_IN;
+	static int const FADE_OUT;
+	static int const OUTLINE_WIDTH;
 };
 
+/** @class SubtitleContent
+ *  @brief Description of how some subtitle content should be presented.
+ *
+ *  There are `image' subtitles (bitmaps) and `text' subtitles (plain text),
+ *  and not all of the settings in this class correspond to both types.
+ */
 class SubtitleContent : public ContentPart
 {
 public:
-	SubtitleContent (Content* parent, boost::shared_ptr<const Film>);
-	SubtitleContent (Content* parent, boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
-	SubtitleContent (Content* parent, boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
+	explicit SubtitleContent (Content* parent);
+	SubtitleContent (Content* parent, std::vector<boost::shared_ptr<Content> >);
 
 	void as_xml (xmlpp::Node *) const;
 	std::string identifier () const;
-
-	bool has_image_subtitles () const {
-		/* XXX */
-		return true;
-	}
+	void take_settings_from (boost::shared_ptr<const SubtitleContent> c);
 
 	void add_font (boost::shared_ptr<Font> font);
 
@@ -67,6 +73,18 @@ public:
 	void set_x_scale (double);
 	void set_y_scale (double);
 	void set_language (std::string language);
+	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 (ContentTime);
+	void unset_fade_in ();
+	void set_fade_out (ContentTime);
+	void set_outline_width (int);
+	void unset_fade_out ();
 
 	bool use () const {
 		boost::mutex::scoped_lock lm (_mutex);
@@ -108,36 +126,56 @@ public:
 		return _language;
 	}
 
-	void set_colour (dcp::Colour);
-
-	dcp::Colour colour () const {
+	boost::optional<dcp::Colour> colour () const {
 		boost::mutex::scoped_lock lm (_mutex);
 		return _colour;
 	}
 
-	void set_outline (bool);
+	boost::optional<dcp::Effect> effect () const {
+		boost::mutex::scoped_lock lm (_mutex);
+		return _effect;
+	}
 
-	bool outline () const {
+	boost::optional<dcp::Colour> effect_colour () const {
 		boost::mutex::scoped_lock lm (_mutex);
-		return _outline;
+		return _effect_colour;
 	}
 
-	void set_outline_colour (dcp::Colour);
+	double line_spacing () const {
+		boost::mutex::scoped_lock lm (_mutex);
+		return _line_spacing;
+	}
 
-	dcp::Colour outline_colour () const {
+	boost::optional<ContentTime> fade_in () const {
 		boost::mutex::scoped_lock lm (_mutex);
-		return _outline_colour;
+		return _fade_in;
 	}
 
+	boost::optional<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;
+	}
+
+	static boost::shared_ptr<SubtitleContent> from_xml (Content* parent, cxml::ConstNodePtr, int version);
+
 protected:
 	/** subtitle language (e.g. "German") or empty if it is not known */
 	std::string _language;
 
 private:
 	friend struct ffmpeg_pts_offset_test;
+
+	SubtitleContent (Content* parent, cxml::ConstNodePtr, int version);
 	void font_changed ();
 	void connect_to_fonts ();
 
+	std::list<boost::signals2::connection> _font_connections;
+
 	bool _use;
 	bool _burn;
 	/** x offset for placing subtitles, as a proportion of the container width;
@@ -153,10 +191,14 @@ private:
 	/** y scale factor to apply to subtitles */
 	double _y_scale;
 	std::list<boost::shared_ptr<Font> > _fonts;
-	dcp::Colour _colour;
-	bool _outline;
-	dcp::Colour _outline_colour;
-	std::list<boost::signals2::connection> _font_connections;
+	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<ContentTime> _fade_in;
+	boost::optional<ContentTime> _fade_out;
+	int _outline_width;
 };
 
 #endif