Note whether subtitle effect colour is forced or not.
[dcpomatic.git] / src / lib / subtitle_content.h
1 /*
2     Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
6     DCP-o-matic is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     DCP-o-matic is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
18
19 */
20
21 #ifndef DCPOMATIC_SUBTITLE_CONTENT_H
22 #define DCPOMATIC_SUBTITLE_CONTENT_H
23
24 #include "content_part.h"
25 #include <libcxml/cxml.h>
26 #include <dcp/types.h>
27 #include <boost/signals2.hpp>
28
29 class Font;
30
31 class SubtitleContentProperty
32 {
33 public:
34         static int const X_OFFSET;
35         static int const Y_OFFSET;
36         static int const X_SCALE;
37         static int const Y_SCALE;
38         static int const USE;
39         static int const BURN;
40         static int const LANGUAGE;
41         static int const FONTS;
42         static int const COLOUR;
43         static int const OUTLINE;
44         static int const SHADOW;
45         static int const EFFECT_COLOUR;
46         static int const LINE_SPACING;
47         static int const FADE_IN;
48         static int const FADE_OUT;
49         static int const OUTLINE_WIDTH;
50 };
51
52 /** @class SubtitleContent
53  *  @brief Description of how some subtitle content should be presented.
54  *
55  *  There are `image' subtitles (bitmaps) and `text' subtitles (plain text),
56  *  and not all of the settings in this class correspond to both types.
57  */
58 class SubtitleContent : public ContentPart
59 {
60 public:
61         SubtitleContent (Content* parent);
62         SubtitleContent (Content* parent, std::vector<boost::shared_ptr<Content> >);
63
64         void as_xml (xmlpp::Node *) const;
65         std::string identifier () const;
66         void take_settings_from (boost::shared_ptr<const SubtitleContent> c);
67
68         void add_font (boost::shared_ptr<Font> font);
69
70         void set_use (bool);
71         void set_burn (bool);
72         void set_x_offset (double);
73         void set_y_offset (double);
74         void set_x_scale (double);
75         void set_y_scale (double);
76         void set_language (std::string language);
77         void set_colour (dcp::Colour);
78         void unset_colour ();
79         void set_outline (bool);
80         void set_shadow (bool);
81         void set_effect_colour (dcp::Colour);
82         void unset_effect_colour ();
83         void set_line_spacing (double s);
84         void set_fade_in (ContentTime);
85         void set_fade_out (ContentTime);
86         void set_outline_width (int);
87
88         bool use () const {
89                 boost::mutex::scoped_lock lm (_mutex);
90                 return _use;
91         }
92
93         bool burn () const {
94                 boost::mutex::scoped_lock lm (_mutex);
95                 return _burn;
96         }
97
98         double x_offset () const {
99                 boost::mutex::scoped_lock lm (_mutex);
100                 return _x_offset;
101         }
102
103         double y_offset () const {
104                 boost::mutex::scoped_lock lm (_mutex);
105                 return _y_offset;
106         }
107
108         double x_scale () const {
109                 boost::mutex::scoped_lock lm (_mutex);
110                 return _x_scale;
111         }
112
113         double y_scale () const {
114                 boost::mutex::scoped_lock lm (_mutex);
115                 return _y_scale;
116         }
117
118         std::list<boost::shared_ptr<Font> > fonts () const {
119                 boost::mutex::scoped_lock lm (_mutex);
120                 return _fonts;
121         }
122
123         std::string language () const {
124                 boost::mutex::scoped_lock lm (_mutex);
125                 return _language;
126         }
127
128         boost::optional<dcp::Colour> colour () const {
129                 boost::mutex::scoped_lock lm (_mutex);
130                 return _colour;
131         }
132
133         bool outline () const {
134                 boost::mutex::scoped_lock lm (_mutex);
135                 return _outline;
136         }
137
138         bool shadow () const {
139                 boost::mutex::scoped_lock lm (_mutex);
140                 return _shadow;
141         }
142
143         boost::optional<dcp::Colour> effect_colour () const {
144                 boost::mutex::scoped_lock lm (_mutex);
145                 return _effect_colour;
146         }
147
148         double line_spacing () const {
149                 boost::mutex::scoped_lock lm (_mutex);
150                 return _line_spacing;
151         }
152
153         ContentTime fade_in () const {
154                 boost::mutex::scoped_lock lm (_mutex);
155                 return _fade_in;
156         }
157
158         ContentTime fade_out () const {
159                 boost::mutex::scoped_lock lm (_mutex);
160                 return _fade_out;
161         }
162
163         int outline_width () const {
164                 boost::mutex::scoped_lock lm (_mutex);
165                 return _outline_width;
166         }
167
168         static boost::shared_ptr<SubtitleContent> from_xml (Content* parent, cxml::ConstNodePtr, int version);
169
170 protected:
171         /** subtitle language (e.g. "German") or empty if it is not known */
172         std::string _language;
173
174 private:
175         friend struct ffmpeg_pts_offset_test;
176
177         SubtitleContent (Content* parent, cxml::ConstNodePtr, int version);
178         void font_changed ();
179         void connect_to_fonts ();
180
181         std::list<boost::signals2::connection> _font_connections;
182
183         bool _use;
184         bool _burn;
185         /** x offset for placing subtitles, as a proportion of the container width;
186          * +ve is further right, -ve is further left.
187          */
188         double _x_offset;
189         /** y offset for placing subtitles, as a proportion of the container height;
190          *  +ve is further down the frame, -ve is further up.
191          */
192         double _y_offset;
193         /** x scale factor to apply to subtitles */
194         double _x_scale;
195         /** y scale factor to apply to subtitles */
196         double _y_scale;
197         std::list<boost::shared_ptr<Font> > _fonts;
198         boost::optional<dcp::Colour> _colour;
199         bool _outline;
200         bool _shadow;
201         boost::optional<dcp::Colour> _effect_colour;
202         /** scaling factor for line spacing; 1 is "standard", < 1 is closer together, > 1 is further apart */
203         double _line_spacing;
204         ContentTime _fade_in;
205         ContentTime _fade_out;
206         int _outline_width;
207 };
208
209 #endif