src/lib/subtitle_content.h

   1 /*
   2     Copyright (C) 2013 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 SubtitleContentProperty
  26 {
  27 public:
  28         static int const SUBTITLE_X_OFFSET;
  29         static int const SUBTITLE_Y_OFFSET;
  30         static int const SUBTITLE_SCALE;
  31         static int const USE_SUBTITLES;
  32 };
  33
  34 /** @class SubtitleContent
  35  *  @brief Parent for content which has the potential to include subtitles.
  36  *
  37  *  Although inheriting from this class indicates that the content could
  38  *  have subtitles, it may not.  ::has_subtitles() will tell you.
  39  */
  40 class SubtitleContent : public virtual Content
  41 {
  42 public:
  43         SubtitleContent (boost::shared_ptr<const Film>);
  44         SubtitleContent (boost::shared_ptr<const Film>, boost::filesystem::path);
  45         SubtitleContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
  46         SubtitleContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
  47
  48         void as_xml (xmlpp::Node *) const;
  49         std::string identifier () const;
  50
  51         virtual bool has_subtitles () const = 0;
  52
  53         void set_use_subtitles (bool);
  54         void set_subtitle_x_offset (double);
  55         void set_subtitle_y_offset (double);
  56         void set_subtitle_scale (double);
  57
  58         bool use_subtitles () const {
  59                 boost::mutex::scoped_lock lm (_mutex);
  60                 return _use_subtitles;
  61         }
  62
  63         double subtitle_x_offset () const {
  64                 boost::mutex::scoped_lock lm (_mutex);
  65                 return _subtitle_x_offset;
  66         }
  67
  68         double subtitle_y_offset () const {
  69                 boost::mutex::scoped_lock lm (_mutex);
  70                 return _subtitle_y_offset;
  71         }
  72
  73         double subtitle_scale () const {
  74                 boost::mutex::scoped_lock lm (_mutex);
  75                 return _subtitle_scale;
  76         }
  77
  78 private:
  79         friend struct ffmpeg_pts_offset_test;
  80
  81         bool _use_subtitles;
  82         /** x offset for placing subtitles, as a proportion of the container width;
  83          * +ve is further right, -ve is further left.
  84          */
  85         double _subtitle_x_offset;
  86         /** y offset for placing subtitles, as a proportion of the container height;
  87          *  +ve is further down the frame, -ve is further up.
  88          */
  89         double _subtitle_y_offset;
  90         /** scale factor to apply to subtitles */
  91         double _subtitle_scale;
  92 };
  93
  94 #endif