src/lib/text_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_CAPTION_CONTENT_H
  22 #define DCPOMATIC_CAPTION_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 TextContentProperty
  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 EFFECT;
  44         static int const EFFECT_COLOUR;
  45         static int const LINE_SPACING;
  46         static int const FADE_IN;
  47         static int const FADE_OUT;
  48         static int const OUTLINE_WIDTH;
  49         static int const TYPE;
  50 };
  51
  52 /** @class TextContent
  53  *  @brief Description of how some text content should be presented.
  54  *
  55  *  There are `bitmap' subtitles and `plain' subtitles (plain text),
  56  *  and not all of the settings in this class correspond to both types.
  57  */
  58 class TextContent : public ContentPart
  59 {
  60 public:
  61         TextContent (Content* parent, TextType original_type);
  62         TextContent (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 TextContent> 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_effect (dcp::Effect);
  80         void unset_effect ();
  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 unset_fade_in ();
  86         void set_fade_out (ContentTime);
  87         void set_outline_width (int);
  88         void unset_fade_out ();
  89         void set_type (TextType type);
  90
  91         bool use () const {
  92                 boost::mutex::scoped_lock lm (_mutex);
  93                 return _use;
  94         }
  95
  96         bool burn () const {
  97                 boost::mutex::scoped_lock lm (_mutex);
  98                 return _burn;
  99         }
 100
 101         double x_offset () const {
 102                 boost::mutex::scoped_lock lm (_mutex);
 103                 return _x_offset;
 104         }
 105
 106         double y_offset () const {
 107                 boost::mutex::scoped_lock lm (_mutex);
 108                 return _y_offset;
 109         }
 110
 111         double x_scale () const {
 112                 boost::mutex::scoped_lock lm (_mutex);
 113                 return _x_scale;
 114         }
 115
 116         double y_scale () const {
 117                 boost::mutex::scoped_lock lm (_mutex);
 118                 return _y_scale;
 119         }
 120
 121         std::list<boost::shared_ptr<Font> > fonts () const {
 122                 boost::mutex::scoped_lock lm (_mutex);
 123                 return _fonts;
 124         }
 125
 126         std::string language () const {
 127                 boost::mutex::scoped_lock lm (_mutex);
 128                 return _language;
 129         }
 130
 131         boost::optional<dcp::Colour> colour () const {
 132                 boost::mutex::scoped_lock lm (_mutex);
 133                 return _colour;
 134         }
 135
 136         boost::optional<dcp::Effect> effect () const {
 137                 boost::mutex::scoped_lock lm (_mutex);
 138                 return _effect;
 139         }
 140
 141         boost::optional<dcp::Colour> effect_colour () const {
 142                 boost::mutex::scoped_lock lm (_mutex);
 143                 return _effect_colour;
 144         }
 145
 146         double line_spacing () const {
 147                 boost::mutex::scoped_lock lm (_mutex);
 148                 return _line_spacing;
 149         }
 150
 151         boost::optional<ContentTime> fade_in () const {
 152                 boost::mutex::scoped_lock lm (_mutex);
 153                 return _fade_in;
 154         }
 155
 156         boost::optional<ContentTime> fade_out () const {
 157                 boost::mutex::scoped_lock lm (_mutex);
 158                 return _fade_out;
 159         }
 160
 161         int outline_width () const {
 162                 boost::mutex::scoped_lock lm (_mutex);
 163                 return _outline_width;
 164         }
 165
 166         TextType type () const {
 167                 boost::mutex::scoped_lock lm (_mutex);
 168                 return _type;
 169         }
 170
 171         TextType original_type () const {
 172                 boost::mutex::scoped_lock lm (_mutex);
 173                 return _original_type;
 174         }
 175
 176         static std::list<boost::shared_ptr<TextContent> > from_xml (Content* parent, cxml::ConstNodePtr, int version);
 177
 178 protected:
 179         /** subtitle language (e.g. "German") or empty if it is not known */
 180         std::string _language;
 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<boost::shared_ptr<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<ContentTime> _fade_in;
 212         boost::optional<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 };
 221
 222 #endif