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