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 OUTLINE_COLOUR;
  45 };
  46
  47 /** @class SubtitleContent
  48  *  @brief Description of how some subtitle content should be presented.
  49  *
  50  *  There are `image' subtitles (bitmaps) and `text' subtitles (plain text),
  51  *  and not all of the settings in this class correspond to both types.
  52  */
  53 class SubtitleContent : public ContentPart
  54 {
  55 public:
  56         SubtitleContent (Content* parent);
  57         SubtitleContent (Content* parent, std::vector<boost::shared_ptr<Content> >);
  58
  59         void as_xml (xmlpp::Node *) const;
  60         std::string identifier () const;
  61
  62         void add_font (boost::shared_ptr<Font> font);
  63
  64         void set_use (bool);
  65         void set_burn (bool);
  66         void set_x_offset (double);
  67         void set_y_offset (double);
  68         void set_x_scale (double);
  69         void set_y_scale (double);
  70         void set_language (std::string language);
  71
  72         bool use () const {
  73                 boost::mutex::scoped_lock lm (_mutex);
  74                 return _use;
  75         }
  76
  77         bool burn () const {
  78                 boost::mutex::scoped_lock lm (_mutex);
  79                 return _burn;
  80         }
  81
  82         double x_offset () const {
  83                 boost::mutex::scoped_lock lm (_mutex);
  84                 return _x_offset;
  85         }
  86
  87         double y_offset () const {
  88                 boost::mutex::scoped_lock lm (_mutex);
  89                 return _y_offset;
  90         }
  91
  92         double x_scale () const {
  93                 boost::mutex::scoped_lock lm (_mutex);
  94                 return _x_scale;
  95         }
  96
  97         double y_scale () const {
  98                 boost::mutex::scoped_lock lm (_mutex);
  99                 return _y_scale;
 100         }
 101
 102         std::list<boost::shared_ptr<Font> > fonts () const {
 103                 boost::mutex::scoped_lock lm (_mutex);
 104                 return _fonts;
 105         }
 106
 107         std::string language () const {
 108                 boost::mutex::scoped_lock lm (_mutex);
 109                 return _language;
 110         }
 111
 112         void set_colour (dcp::Colour);
 113
 114         dcp::Colour colour () const {
 115                 boost::mutex::scoped_lock lm (_mutex);
 116                 return _colour;
 117         }
 118
 119         void set_outline (bool);
 120
 121         bool outline () const {
 122                 boost::mutex::scoped_lock lm (_mutex);
 123                 return _outline;
 124         }
 125
 126         void set_outline_colour (dcp::Colour);
 127
 128         dcp::Colour outline_colour () const {
 129                 boost::mutex::scoped_lock lm (_mutex);
 130                 return _outline_colour;
 131         }
 132
 133         static boost::shared_ptr<SubtitleContent> from_xml (Content* parent, cxml::ConstNodePtr, int version);
 134
 135 protected:
 136         /** subtitle language (e.g. "German") or empty if it is not known */
 137         std::string _language;
 138
 139 private:
 140         friend struct ffmpeg_pts_offset_test;
 141
 142         SubtitleContent (Content* parent, cxml::ConstNodePtr, int version);
 143         void font_changed ();
 144         void connect_to_fonts ();
 145
 146         bool _use;
 147         bool _burn;
 148         /** x offset for placing subtitles, as a proportion of the container width;
 149          * +ve is further right, -ve is further left.
 150          */
 151         double _x_offset;
 152         /** y offset for placing subtitles, as a proportion of the container height;
 153          *  +ve is further down the frame, -ve is further up.
 154          */
 155         double _y_offset;
 156         /** x scale factor to apply to subtitles */
 157         double _x_scale;
 158         /** y scale factor to apply to subtitles */
 159         double _y_scale;
 160         std::list<boost::shared_ptr<Font> > _fonts;
 161         dcp::Colour _colour;
 162         bool _outline;
 163         dcp::Colour _outline_colour;
 164         std::list<boost::signals2::connection> _font_connections;
 165 };
 166
 167 #endif