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         static int const SUBTITLE_VIDEO_FRAME_RATE;
  39 };
  40
  41 /** @class SubtitleContent
  42  *  @brief Parent for content which has the potential to include subtitles.
  43  *
  44  *  Although inheriting from this class indicates that the content could
  45  *  have subtitles, it may not.  ::has_subtitles() will tell you.
  46  */
  47 class SubtitleContent : public virtual Content
  48 {
  49 public:
  50         SubtitleContent (boost::shared_ptr<const Film>);
  51         SubtitleContent (boost::shared_ptr<const Film>, boost::filesystem::path);
  52         SubtitleContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
  53         SubtitleContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
  54
  55         void as_xml (xmlpp::Node *) const;
  56         std::string identifier () const;
  57
  58         bool has_subtitles () const;
  59         virtual bool has_text_subtitles () const = 0;
  60         virtual bool has_image_subtitles () const = 0;
  61         virtual double subtitle_video_frame_rate () const = 0;
  62
  63         void add_font (boost::shared_ptr<Font> font);
  64
  65         void set_use_subtitles (bool);
  66         void set_burn_subtitles (bool);
  67         void set_subtitle_x_offset (double);
  68         void set_subtitle_y_offset (double);
  69         void set_subtitle_x_scale (double);
  70         void set_subtitle_y_scale (double);
  71         void set_subtitle_language (std::string language);
  72
  73         bool use_subtitles () const {
  74                 boost::mutex::scoped_lock lm (_mutex);
  75                 return _use_subtitles;
  76         }
  77
  78         bool burn_subtitles () const {
  79                 boost::mutex::scoped_lock lm (_mutex);
  80                 return _burn_subtitles;
  81         }
  82
  83         double subtitle_x_offset () const {
  84                 boost::mutex::scoped_lock lm (_mutex);
  85                 return _subtitle_x_offset;
  86         }
  87
  88         double subtitle_y_offset () const {
  89                 boost::mutex::scoped_lock lm (_mutex);
  90                 return _subtitle_y_offset;
  91         }
  92
  93         double subtitle_x_scale () const {
  94                 boost::mutex::scoped_lock lm (_mutex);
  95                 return _subtitle_x_scale;
  96         }
  97
  98         double subtitle_y_scale () const {
  99                 boost::mutex::scoped_lock lm (_mutex);
 100                 return _subtitle_y_scale;
 101         }
 102
 103         std::list<boost::shared_ptr<Font> > fonts () const {
 104                 boost::mutex::scoped_lock lm (_mutex);
 105                 return _fonts;
 106         }
 107
 108         std::string subtitle_language () const {
 109                 boost::mutex::scoped_lock lm (_mutex);
 110                 return _subtitle_language;
 111         }
 112
 113 protected:
 114         /** subtitle language (e.g. "German") or empty if it is not known */
 115         std::string _subtitle_language;
 116
 117 private:
 118         friend struct ffmpeg_pts_offset_test;
 119         void font_changed ();
 120         void connect_to_fonts ();
 121
 122         bool _use_subtitles;
 123         bool _burn_subtitles;
 124         /** x offset for placing subtitles, as a proportion of the container width;
 125          * +ve is further right, -ve is further left.
 126          */
 127         double _subtitle_x_offset;
 128         /** y offset for placing subtitles, as a proportion of the container height;
 129          *  +ve is further down the frame, -ve is further up.
 130          */
 131         double _subtitle_y_offset;
 132         /** x scale factor to apply to subtitles */
 133         double _subtitle_x_scale;
 134         /** y scale factor to apply to subtitles */
 135         double _subtitle_y_scale;
 136         std::list<boost::shared_ptr<Font> > _fonts;
 137         std::list<boost::signals2::connection> _font_connections;
 138 };
 139
 140 #endif