CCAP doc tweaks.

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

diff --git a/src/lib/subtitle_content.h b/src/lib/subtitle_content.h
index 6665f563af4a0496ce9826f17dda7fad80b2b9c5..b64e4787b536b1d7fec96519027155ab9312e736 100644 (file)
--- a/src/lib/subtitle_content.h
+++ b/src/lib/subtitle_content.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -40,9 +40,12 @@ 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
@@ -54,11 +57,12 @@ public:
 class SubtitleContent : public ContentPart
 {
 public:
-       SubtitleContent (Content* parent);
+       explicit SubtitleContent (Content* parent);
        SubtitleContent (Content* parent, std::vector<boost::shared_ptr<Content> >);
 
        void as_xml (xmlpp::Node *) const;
        std::string identifier () const;
+       void take_settings_from (boost::shared_ptr<const SubtitleContent> c);
 
        void add_font (boost::shared_ptr<Font> font);
 
@@ -69,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);
@@ -110,32 +126,39 @@ 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;
        }
 
-       void set_line_spacing (double s);
+       boost::optional<ContentTime> fade_out () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _fade_out;
+       }
 
-       double line_spacing () const {
+       int outline_width () const {
                boost::mutex::scoped_lock lm (_mutex);
-               return _line_spacing;
+               return _outline_width;
        }
 
        static boost::shared_ptr<SubtitleContent> from_xml (Content* parent, cxml::ConstNodePtr, int version);
@@ -151,6 +174,8 @@ private:
        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;
@@ -166,12 +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