src/lib/text_content.h

   1 /*
   2     Copyright (C) 2013-2020 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_CAPTION_CONTENT_H
  22 #define DCPOMATIC_CAPTION_CONTENT_H
  23
  24 #include "content_part.h"
  25 #include "dcp_text_track.h"
  26 #include <libcxml/cxml.h>
  27 #include <dcp/types.h>
  28 #include <boost/signals2.hpp>
  29
  30 namespace dcpomatic {
  31         class Font;
  32 }
  33
  34 class TextContentProperty
  35 {
  36 public:
  37         static int const X_OFFSET;
  38         static int const Y_OFFSET;
  39         static int const X_SCALE;
  40         static int const Y_SCALE;
  41         static int const USE;
  42         static int const BURN;
  43         static int const FONTS;
  44         static int const COLOUR;
  45         static int const EFFECT;
  46         static int const EFFECT_COLOUR;
  47         static int const LINE_SPACING;
  48         static int const FADE_IN;
  49         static int const FADE_OUT;
  50         static int const OUTLINE_WIDTH;
  51         static int const TYPE;
  52         static int const DCP_TRACK;
  53 };
  54
  55 /** @class TextContent
  56  *  @brief Description of how some text content should be presented.
  57  *
  58  *  There are `bitmap' subtitles and `plain' subtitles (plain text),
  59  *  and not all of the settings in this class correspond to both types.
  60  */
  61 class TextContent : public ContentPart
  62 {
  63 public:
  64         TextContent (Content* parent, TextType type, TextType original_type);
  65         TextContent (Content* parent, std::vector<std::shared_ptr<Content> >);
  66
  67         void as_xml (xmlpp::Node *) const;
  68         std::string identifier () const;
  69         void take_settings_from (std::shared_ptr<const TextContent> c);
  70
  71         void add_font (std::shared_ptr<dcpomatic::Font> font);
  72
  73         void set_use (bool);
  74         void set_burn (bool);
  75         void set_x_offset (double);
  76         void set_y_offset (double);
  77         void set_x_scale (double);
  78         void set_y_scale (double);
  79         void set_colour (dcp::Colour);
  80         void unset_colour ();
  81         void set_effect (dcp::Effect);
  82         void unset_effect ();
  83         void set_effect_colour (dcp::Colour);
  84         void unset_effect_colour ();
  85         void set_line_spacing (double s);
  86         void set_fade_in (dcpomatic::ContentTime);
  87         void unset_fade_in ();
  88         void set_fade_out (dcpomatic::ContentTime);
  89         void set_outline_width (int);
  90         void unset_fade_out ();
  91         void set_type (TextType type);
  92         void set_dcp_track (DCPTextTrack track);
  93         void unset_dcp_track ();
  94
  95         bool use () const {
  96                 boost::mutex::scoped_lock lm (_mutex);
  97                 return _use;
  98         }
  99
 100         bool burn () const {
 101                 boost::mutex::scoped_lock lm (_mutex);
 102                 return _burn;
 103         }
 104
 105         double x_offset () const {
 106                 boost::mutex::scoped_lock lm (_mutex);
 107                 return _x_offset;
 108         }
 109
 110         double y_offset () const {
 111                 boost::mutex::scoped_lock lm (_mutex);
 112                 return _y_offset;
 113         }
 114
 115         double x_scale () const {
 116                 boost::mutex::scoped_lock lm (_mutex);
 117                 return _x_scale;
 118         }
 119
 120         double y_scale () const {
 121                 boost::mutex::scoped_lock lm (_mutex);
 122                 return _y_scale;
 123         }
 124
 125         std::list<std::shared_ptr<dcpomatic::Font> > fonts () const {
 126                 boost::mutex::scoped_lock lm (_mutex);
 127                 return _fonts;
 128         }
 129
 130         boost::optional<dcp::Colour> colour () const {
 131                 boost::mutex::scoped_lock lm (_mutex);
 132                 return _colour;
 133         }
 134
 135         boost::optional<dcp::Effect> effect () const {
 136                 boost::mutex::scoped_lock lm (_mutex);
 137                 return _effect;
 138         }
 139
 140         boost::optional<dcp::Colour> effect_colour () const {
 141                 boost::mutex::scoped_lock lm (_mutex);
 142                 return _effect_colour;
 143         }
 144
 145         double line_spacing () const {
 146                 boost::mutex::scoped_lock lm (_mutex);
 147                 return _line_spacing;
 148         }
 149
 150         boost::optional<dcpomatic::ContentTime> fade_in () const {
 151                 boost::mutex::scoped_lock lm (_mutex);
 152                 return _fade_in;
 153         }
 154
 155         boost::optional<dcpomatic::ContentTime> fade_out () const {
 156                 boost::mutex::scoped_lock lm (_mutex);
 157                 return _fade_out;
 158         }
 159
 160         int outline_width () const {
 161                 boost::mutex::scoped_lock lm (_mutex);
 162                 return _outline_width;
 163         }
 164
 165         TextType type () const {
 166                 boost::mutex::scoped_lock lm (_mutex);
 167                 return _type;
 168         }
 169
 170         TextType original_type () const {
 171                 boost::mutex::scoped_lock lm (_mutex);
 172                 return _original_type;
 173         }
 174
 175         boost::optional<DCPTextTrack> dcp_track () const {
 176                 boost::mutex::scoped_lock lm (_mutex);
 177                 return _dcp_track;
 178         }
 179
 180         static std::list<std::shared_ptr<TextContent> > from_xml (Content* parent, cxml::ConstNodePtr, int version);
 181
 182 private:
 183         friend struct ffmpeg_pts_offset_test;
 184
 185         TextContent (Content* parent, cxml::ConstNodePtr, int version);
 186         void font_changed ();
 187         void connect_to_fonts ();
 188
 189         std::list<boost::signals2::connection> _font_connections;
 190
 191         bool _use;
 192         bool _burn;
 193         /** x offset for placing subtitles, as a proportion of the container width;
 194          * +ve is further right, -ve is further left.
 195          */
 196         double _x_offset;
 197         /** y offset for placing subtitles, as a proportion of the container height;
 198          *  +ve is further down the frame, -ve is further up.
 199          */
 200         double _y_offset;
 201         /** x scale factor to apply to subtitles */
 202         double _x_scale;
 203         /** y scale factor to apply to subtitles */
 204         double _y_scale;
 205         std::list<std::shared_ptr<dcpomatic::Font> > _fonts;
 206         boost::optional<dcp::Colour> _colour;
 207         boost::optional<dcp::Effect> _effect;
 208         boost::optional<dcp::Colour> _effect_colour;
 209         /** scaling factor for line spacing; 1 is "standard", < 1 is closer together, > 1 is further apart */
 210         double _line_spacing;
 211         boost::optional<dcpomatic::ContentTime> _fade_in;
 212         boost::optional<dcpomatic::ContentTime> _fade_out;
 213         int _outline_width;
 214         /** what these captions will be used for in the output DCP (not necessarily what
 215          *  they were originally).
 216          */
 217         TextType _type;
 218         /** the original type of these captions in their content */
 219         TextType _original_type;
 220         /** the track of closed captions that this content should be put in, or empty to put in the default (only) track */
 221         boost::optional<DCPTextTrack> _dcp_track;
 222 };
 223
 224 #endif