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 NAME;
  41         static int const LANGUAGE;
  42         static int const FONTS;
  43         static int const COLOUR;
  44         static int const EFFECT;
  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         static int const TYPE;
  51 };
  52
  53 /** @class TextContent
  54  *  @brief Description of how some text content should be presented.
  55  *
  56  *  There are `bitmap' subtitles and `plain' subtitles (plain text),
  57  *  and not all of the settings in this class correspond to both types.
  58  */
  59 class TextContent : public ContentPart
  60 {
  61 public:
  62         TextContent (Content* parent, TextType type, TextType original_type);
  63         TextContent (Content* parent, std::vector<boost::shared_ptr<Content> >);
  64
  65         void as_xml (xmlpp::Node *) const;
  66         std::string identifier () const;
  67         void take_settings_from (boost::shared_ptr<const TextContent> c);
  68
  69         void add_font (boost::shared_ptr<Font> font);
  70
  71         void set_use (bool);
  72         void set_burn (bool);
  73         void set_x_offset (double);
  74         void set_y_offset (double);
  75         void set_x_scale (double);
  76         void set_y_scale (double);
  77         void set_name (std::string name);
  78         void set_language (std::string language);
  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 (ContentTime);
  87         void unset_fade_in ();
  88         void set_fade_out (ContentTime);
  89         void set_outline_width (int);
  90         void unset_fade_out ();
  91         void set_type (TextType type);
  92
  93         bool use () const {
  94                 boost::mutex::scoped_lock lm (_mutex);
  95                 return _use;
  96         }
  97
  98         bool burn () const {
  99                 boost::mutex::scoped_lock lm (_mutex);
 100                 return _burn;
 101         }
 102
 103         double x_offset () const {
 104                 boost::mutex::scoped_lock lm (_mutex);
 105                 return _x_offset;
 106         }
 107
 108         double y_offset () const {
 109                 boost::mutex::scoped_lock lm (_mutex);
 110                 return _y_offset;
 111         }
 112
 113         double x_scale () const {
 114                 boost::mutex::scoped_lock lm (_mutex);
 115                 return _x_scale;
 116         }
 117
 118         double y_scale () const {
 119                 boost::mutex::scoped_lock lm (_mutex);
 120                 return _y_scale;
 121         }
 122
 123         std::list<boost::shared_ptr<Font> > fonts () const {
 124                 boost::mutex::scoped_lock lm (_mutex);
 125                 return _fonts;
 126         }
 127
 128         std::string name () const {
 129                 boost::mutex::scoped_lock lm (_mutex);
 130                 return _name;
 131         }
 132
 133         std::string language () const {
 134                 boost::mutex::scoped_lock lm (_mutex);
 135                 return _language;
 136         }
 137
 138         boost::optional<dcp::Colour> colour () const {
 139                 boost::mutex::scoped_lock lm (_mutex);
 140                 return _colour;
 141         }
 142
 143         boost::optional<dcp::Effect> effect () const {
 144                 boost::mutex::scoped_lock lm (_mutex);
 145                 return _effect;
 146         }
 147
 148         boost::optional<dcp::Colour> effect_colour () const {
 149                 boost::mutex::scoped_lock lm (_mutex);
 150                 return _effect_colour;
 151         }
 152
 153         double line_spacing () const {
 154                 boost::mutex::scoped_lock lm (_mutex);
 155                 return _line_spacing;
 156         }
 157
 158         boost::optional<ContentTime> fade_in () const {
 159                 boost::mutex::scoped_lock lm (_mutex);
 160                 return _fade_in;
 161         }
 162
 163         boost::optional<ContentTime> fade_out () const {
 164                 boost::mutex::scoped_lock lm (_mutex);
 165                 return _fade_out;
 166         }
 167
 168         int outline_width () const {
 169                 boost::mutex::scoped_lock lm (_mutex);
 170                 return _outline_width;
 171         }
 172
 173         TextType type () const {
 174                 boost::mutex::scoped_lock lm (_mutex);
 175                 return _type;
 176         }
 177
 178         TextType original_type () const {
 179                 boost::mutex::scoped_lock lm (_mutex);
 180                 return _original_type;
 181         }
 182
 183         static std::list<boost::shared_ptr<TextContent> > from_xml (Content* parent, cxml::ConstNodePtr, int version);
 184
 185 protected:
 186         /** Name (annotation text) for this subtitle */
 187         std::string _name;
 188         /** subtitle language (e.g. "German") or empty if it is not known */
 189         std::string _language;
 190
 191 private:
 192         friend struct ffmpeg_pts_offset_test;
 193
 194         TextContent (Content* parent, cxml::ConstNodePtr, int version);
 195         void font_changed ();
 196         void connect_to_fonts ();
 197
 198         std::list<boost::signals2::connection> _font_connections;
 199
 200         bool _use;
 201         bool _burn;
 202         /** x offset for placing subtitles, as a proportion of the container width;
 203          * +ve is further right, -ve is further left.
 204          */
 205         double _x_offset;
 206         /** y offset for placing subtitles, as a proportion of the container height;
 207          *  +ve is further down the frame, -ve is further up.
 208          */
 209         double _y_offset;
 210         /** x scale factor to apply to subtitles */
 211         double _x_scale;
 212         /** y scale factor to apply to subtitles */
 213         double _y_scale;
 214         std::list<boost::shared_ptr<Font> > _fonts;
 215         boost::optional<dcp::Colour> _colour;
 216         boost::optional<dcp::Effect> _effect;
 217         boost::optional<dcp::Colour> _effect_colour;
 218         /** scaling factor for line spacing; 1 is "standard", < 1 is closer together, > 1 is further apart */
 219         double _line_spacing;
 220         boost::optional<ContentTime> _fade_in;
 221         boost::optional<ContentTime> _fade_out;
 222         int _outline_width;
 223         /** what these captions will be used for in the output DCP (not necessarily what
 224          *  they were originally).
 225          */
 226         TextType _type;
 227         /** the original type of these captions in their content */
 228         TextType _original_type;
 229 };
 230
 231 #endif