src/lib/subtitle_content.h

   1 /*
   2     Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef DCPOMATIC_SUBTITLE_CONTENT_H
  21 #define DCPOMATIC_SUBTITLE_CONTENT_H
  22
  23 #include "content.h"
  24
  25 class Font;
  26
  27 class SubtitleContentProperty
  28 {
  29 public:
  30         static int const SUBTITLE_X_OFFSET;
  31         static int const SUBTITLE_Y_OFFSET;
  32         static int const SUBTITLE_X_SCALE;
  33         static int const SUBTITLE_Y_SCALE;
  34         static int const USE_SUBTITLES;
  35         static int const BURN_SUBTITLES;
  36         static int const SUBTITLE_LANGUAGE;
  37         static int const FONTS;
  38 };
  39
  40 /** @class SubtitleContent
  41  *  @brief Parent for content which has the potential to include subtitles.
  42  *
  43  *  Although inheriting from this class indicates that the content could
  44  *  have subtitles, it may not.  ::has_subtitles() will tell you.
  45  */
  46 class SubtitleContent : public virtual Content
  47 {
  48 public:
  49         SubtitleContent (boost::shared_ptr<const Film>);
  50         SubtitleContent (boost::shared_ptr<const Film>, boost::filesystem::path);
  51         SubtitleContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
  52         SubtitleContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
  53
  54         void as_xml (xmlpp::Node *) const;
  55         std::string identifier () const;
  56
  57         bool has_subtitles () const;
  58         virtual bool has_text_subtitles () const = 0;
  59         virtual bool has_image_subtitles () const = 0;
  60
  61         void add_font (boost::shared_ptr<Font> font);
  62
  63         void set_use_subtitles (bool);
  64         void set_burn_subtitles (bool);
  65         void set_subtitle_x_offset (double);
  66         void set_subtitle_y_offset (double);
  67         void set_subtitle_x_scale (double);
  68         void set_subtitle_y_scale (double);
  69         void set_subtitle_language (std::string language);
  70
  71         bool use_subtitles () const {
  72                 boost::mutex::scoped_lock lm (_mutex);
  73                 return _use_subtitles;
  74         }
  75
  76         bool burn_subtitles () const {
  77                 boost::mutex::scoped_lock lm (_mutex);
  78                 return _burn_subtitles;
  79         }
  80
  81         double subtitle_x_offset () const {
  82                 boost::mutex::scoped_lock lm (_mutex);
  83                 return _subtitle_x_offset;
  84         }
  85
  86         double subtitle_y_offset () const {
  87                 boost::mutex::scoped_lock lm (_mutex);
  88                 return _subtitle_y_offset;
  89         }
  90
  91         double subtitle_x_scale () const {
  92                 boost::mutex::scoped_lock lm (_mutex);
  93                 return _subtitle_x_scale;
  94         }
  95
  96         double subtitle_y_scale () const {
  97                 boost::mutex::scoped_lock lm (_mutex);
  98                 return _subtitle_y_scale;
  99         }
 100
 101         std::list<boost::shared_ptr<Font> > fonts () const {
 102                 boost::mutex::scoped_lock lm (_mutex);
 103                 return _fonts;
 104         }
 105
 106         std::string subtitle_language () const {
 107                 boost::mutex::scoped_lock lm (_mutex);
 108                 return _subtitle_language;
 109         }
 110
 111 protected:
 112         /** subtitle language (e.g. "German") or empty if it is not known */
 113         std::string _subtitle_language;
 114
 115 private:
 116         friend struct ffmpeg_pts_offset_test;
 117         void font_changed ();
 118         void connect_to_fonts ();
 119
 120         bool _use_subtitles;
 121         bool _burn_subtitles;
 122         /** x offset for placing subtitles, as a proportion of the container width;
 123          * +ve is further right, -ve is further left.
 124          */
 125         double _subtitle_x_offset;
 126         /** y offset for placing subtitles, as a proportion of the container height;
 127          *  +ve is further down the frame, -ve is further up.
 128          */
 129         double _subtitle_y_offset;
 130         /** x scale factor to apply to subtitles */
 131         double _subtitle_x_scale;
 132         /** y scale factor to apply to subtitles */
 133         double _subtitle_y_scale;
 134         std::list<boost::shared_ptr<Font> > _fonts;
 135         std::list<boost::signals2::connection> _font_connections;
 136 };
 137
 138 #endif