src/lib/subtitle_content.h

   1 /*
   2     Copyright (C) 2013-2016 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 };
  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
  66         void add_font (boost::shared_ptr<Font> font);
  67
  68         void set_use (bool);
  69         void set_burn (bool);
  70         void set_x_offset (double);
  71         void set_y_offset (double);
  72         void set_x_scale (double);
  73         void set_y_scale (double);
  74         void set_language (std::string language);
  75         void set_colour (dcp::Colour);
  76         void set_outline (bool);
  77         void set_shadow (bool);
  78         void set_effect_colour (dcp::Colour);
  79         void set_line_spacing (double s);
  80         void set_fade_in (ContentTime);
  81         void set_fade_out (ContentTime);
  82
  83         bool use () const {
  84                 boost::mutex::scoped_lock lm (_mutex);
  85                 return _use;
  86         }
  87
  88         bool burn () const {
  89                 boost::mutex::scoped_lock lm (_mutex);
  90                 return _burn;
  91         }
  92
  93         double x_offset () const {
  94                 boost::mutex::scoped_lock lm (_mutex);
  95                 return _x_offset;
  96         }
  97
  98         double y_offset () const {
  99                 boost::mutex::scoped_lock lm (_mutex);
 100                 return _y_offset;
 101         }
 102
 103         double x_scale () const {
 104                 boost::mutex::scoped_lock lm (_mutex);
 105                 return _x_scale;
 106         }
 107
 108         double y_scale () const {
 109                 boost::mutex::scoped_lock lm (_mutex);
 110                 return _y_scale;
 111         }
 112
 113         std::list<boost::shared_ptr<Font> > fonts () const {
 114                 boost::mutex::scoped_lock lm (_mutex);
 115                 return _fonts;
 116         }
 117
 118         std::string language () const {
 119                 boost::mutex::scoped_lock lm (_mutex);
 120                 return _language;
 121         }
 122
 123         dcp::Colour colour () const {
 124                 boost::mutex::scoped_lock lm (_mutex);
 125                 return _colour;
 126         }
 127
 128         bool outline () const {
 129                 boost::mutex::scoped_lock lm (_mutex);
 130                 return _outline;
 131         }
 132
 133         bool shadow () const {
 134                 boost::mutex::scoped_lock lm (_mutex);
 135                 return _shadow;
 136         }
 137
 138         dcp::Colour effect_colour () const {
 139                 boost::mutex::scoped_lock lm (_mutex);
 140                 return _effect_colour;
 141         }
 142
 143         double line_spacing () const {
 144                 boost::mutex::scoped_lock lm (_mutex);
 145                 return _line_spacing;
 146         }
 147
 148         ContentTime fade_in () const {
 149                 boost::mutex::scoped_lock lm (_mutex);
 150                 return _fade_in;
 151         }
 152
 153         ContentTime fade_out () const {
 154                 boost::mutex::scoped_lock lm (_mutex);
 155                 return _fade_out;
 156         }
 157
 158         static boost::shared_ptr<SubtitleContent> from_xml (Content* parent, cxml::ConstNodePtr, int version);
 159
 160 protected:
 161         /** subtitle language (e.g. "German") or empty if it is not known */
 162         std::string _language;
 163
 164 private:
 165         friend struct ffmpeg_pts_offset_test;
 166
 167         SubtitleContent (Content* parent, cxml::ConstNodePtr, int version);
 168         void font_changed ();
 169         void connect_to_fonts ();
 170
 171         std::list<boost::signals2::connection> _font_connections;
 172
 173         bool _use;
 174         bool _burn;
 175         /** x offset for placing subtitles, as a proportion of the container width;
 176          * +ve is further right, -ve is further left.
 177          */
 178         double _x_offset;
 179         /** y offset for placing subtitles, as a proportion of the container height;
 180          *  +ve is further down the frame, -ve is further up.
 181          */
 182         double _y_offset;
 183         /** x scale factor to apply to subtitles */
 184         double _x_scale;
 185         /** y scale factor to apply to subtitles */
 186         double _y_scale;
 187         std::list<boost::shared_ptr<Font> > _fonts;
 188         dcp::Colour _colour;
 189         bool _outline;
 190         bool _shadow;
 191         dcp::Colour _effect_colour;
 192         /** scaling factor for line spacing; 1 is "standard", < 1 is closer together, > 1 is further apart */
 193         double _line_spacing;
 194         ContentTime _fade_in;
 195         ContentTime _fade_out;
 196 };
 197
 198 #endif