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 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 };
  50
  51 /** @class SubtitleContent
  52  *  @brief Description of how some subtitle content should be presented.
  53  *
  54  *  There are `image' subtitles (bitmaps) and `text' subtitles (plain text),
  55  *  and not all of the settings in this class correspond to both types.
  56  */
  57 class SubtitleContent : public ContentPart
  58 {
  59 public:
  60         SubtitleContent (Content* parent);
  61         SubtitleContent (Content* parent, std::vector<boost::shared_ptr<Content> >);
  62
  63         void as_xml (xmlpp::Node *) const;
  64         std::string identifier () const;
  65         void take_settings_from (boost::shared_ptr<const SubtitleContent> c);
  66
  67         void add_font (boost::shared_ptr<Font> font);
  68
  69         void set_use (bool);
  70         void set_burn (bool);
  71         void set_x_offset (double);
  72         void set_y_offset (double);
  73         void set_x_scale (double);
  74         void set_y_scale (double);
  75         void set_language (std::string language);
  76         void set_colour (dcp::Colour);
  77         void unset_colour ();
  78         void set_effect (dcp::Effect);
  79         void set_effect_colour (dcp::Colour);
  80         void unset_effect_colour ();
  81         void set_line_spacing (double s);
  82         void set_fade_in (ContentTime);
  83         void set_fade_out (ContentTime);
  84         void set_outline_width (int);
  85
  86         bool use () const {
  87                 boost::mutex::scoped_lock lm (_mutex);
  88                 return _use;
  89         }
  90
  91         bool burn () const {
  92                 boost::mutex::scoped_lock lm (_mutex);
  93                 return _burn;
  94         }
  95
  96         double x_offset () const {
  97                 boost::mutex::scoped_lock lm (_mutex);
  98                 return _x_offset;
  99         }
 100
 101         double y_offset () const {
 102                 boost::mutex::scoped_lock lm (_mutex);
 103                 return _y_offset;
 104         }
 105
 106         double x_scale () const {
 107                 boost::mutex::scoped_lock lm (_mutex);
 108                 return _x_scale;
 109         }
 110
 111         double y_scale () const {
 112                 boost::mutex::scoped_lock lm (_mutex);
 113                 return _y_scale;
 114         }
 115
 116         std::list<boost::shared_ptr<Font> > fonts () const {
 117                 boost::mutex::scoped_lock lm (_mutex);
 118                 return _fonts;
 119         }
 120
 121         std::string language () const {
 122                 boost::mutex::scoped_lock lm (_mutex);
 123                 return _language;
 124         }
 125
 126         boost::optional<dcp::Colour> colour () const {
 127                 boost::mutex::scoped_lock lm (_mutex);
 128                 return _colour;
 129         }
 130
 131         dcp::Effect effect () const {
 132                 boost::mutex::scoped_lock lm (_mutex);
 133                 return _effect;
 134         }
 135
 136         boost::optional<dcp::Colour> effect_colour () const {
 137                 boost::mutex::scoped_lock lm (_mutex);
 138                 return _effect_colour;
 139         }
 140
 141         double line_spacing () const {
 142                 boost::mutex::scoped_lock lm (_mutex);
 143                 return _line_spacing;
 144         }
 145
 146         ContentTime fade_in () const {
 147                 boost::mutex::scoped_lock lm (_mutex);
 148                 return _fade_in;
 149         }
 150
 151         ContentTime fade_out () const {
 152                 boost::mutex::scoped_lock lm (_mutex);
 153                 return _fade_out;
 154         }
 155
 156         int outline_width () const {
 157                 boost::mutex::scoped_lock lm (_mutex);
 158                 return _outline_width;
 159         }
 160
 161         static boost::shared_ptr<SubtitleContent> from_xml (Content* parent, cxml::ConstNodePtr, int version);
 162
 163 protected:
 164         /** subtitle language (e.g. "German") or empty if it is not known */
 165         std::string _language;
 166
 167 private:
 168         friend struct ffmpeg_pts_offset_test;
 169
 170         SubtitleContent (Content* parent, cxml::ConstNodePtr, int version);
 171         void font_changed ();
 172         void connect_to_fonts ();
 173
 174         std::list<boost::signals2::connection> _font_connections;
 175
 176         bool _use;
 177         bool _burn;
 178         /** x offset for placing subtitles, as a proportion of the container width;
 179          * +ve is further right, -ve is further left.
 180          */
 181         double _x_offset;
 182         /** y offset for placing subtitles, as a proportion of the container height;
 183          *  +ve is further down the frame, -ve is further up.
 184          */
 185         double _y_offset;
 186         /** x scale factor to apply to subtitles */
 187         double _x_scale;
 188         /** y scale factor to apply to subtitles */
 189         double _y_scale;
 190         std::list<boost::shared_ptr<Font> > _fonts;
 191         boost::optional<dcp::Colour> _colour;
 192         dcp::Effect _effect;
 193         boost::optional<dcp::Colour> _effect_colour;
 194         /** scaling factor for line spacing; 1 is "standard", < 1 is closer together, > 1 is further apart */
 195         double _line_spacing;
 196         ContentTime _fade_in;
 197         ContentTime _fade_out;
 198         int _outline_width;
 199 };
 200
 201 #endif