Supporter.

[dcpomatic.git] / src / lib / subtitle_content.h

diff --git a/src/lib/subtitle_content.h b/src/lib/subtitle_content.h
index db22863394840b65f382da8241f76b4cdac11e3b..c8492b91a32359c3eea8262cb00a3e32d516ba90 100644 (file)
--- 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>
 
-    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/>.
 
 */
 
@@ -40,23 +41,26 @@ public:
        static int const FONTS;
        static int const COLOUR;
        static int const OUTLINE;
-       static int const OUTLINE_COLOUR;
+       static int const SHADOW;
+       static int const EFFECT_COLOUR;
+       static int const LINE_SPACING;
 };
 
+/** @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>, std::vector<boost::shared_ptr<Content> >);
+       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 add_font (boost::shared_ptr<Font> font);
 
        void set_use (bool);
@@ -121,14 +125,28 @@ public:
                return _outline;
        }
 
-       void set_outline_colour (dcp::Colour);
+       void set_shadow (bool);
+
+       bool shadow () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _shadow;
+       }
+
+       void set_effect_colour (dcp::Colour);
+
+       dcp::Colour effect_colour () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _effect_colour;
+       }
+
+       void set_line_spacing (double s);
 
-       dcp::Colour outline_colour () const {
+       double line_spacing () const {
                boost::mutex::scoped_lock lm (_mutex);
-               return _outline_colour;
+               return _line_spacing;
        }
 
-       static boost::shared_ptr<SubtitleContent> from_xml (Content* parent, boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
+       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 */
@@ -137,7 +155,7 @@ protected:
 private:
        friend struct ffmpeg_pts_offset_test;
 
-       SubtitleContent (Content* parent, boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
+       SubtitleContent (Content* parent, cxml::ConstNodePtr, int version);
        void font_changed ();
        void connect_to_fonts ();
 
@@ -158,8 +176,11 @@ private:
        std::list<boost::shared_ptr<Font> > _fonts;
        dcp::Colour _colour;
        bool _outline;
-       dcp::Colour _outline_colour;
+       bool _shadow;
+       dcp::Colour _effect_colour;
        std::list<boost::signals2::connection> _font_connections;
+       /** scaling factor for line spacing; 1 is "standard", < 1 is closer together, > 1 is further apart */
+       double _line_spacing;
 };
 
 #endif