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 SUBTITLE_USE;
  32 };
  33
  34 class SubtitleContent : public virtual Content
  35 {
  36 public:
  37         SubtitleContent (boost::shared_ptr<const Film>);
  38         SubtitleContent (boost::shared_ptr<const Film>, boost::filesystem::path);
  39         SubtitleContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
  40         SubtitleContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
  41
  42         void as_xml (xmlpp::Node *) const;
  43
  44         void set_subtitle_use (bool);
  45         void set_subtitle_x_offset (double);
  46         void set_subtitle_y_offset (double);
  47         void set_subtitle_scale (double);
  48
  49         bool subtitle_use () const {
  50                 boost::mutex::scoped_lock lm (_mutex);
  51                 return _subtitle_use;
  52         }
  53
  54         double subtitle_x_offset () const {
  55                 boost::mutex::scoped_lock lm (_mutex);
  56                 return _subtitle_x_offset;
  57         }
  58
  59         double subtitle_y_offset () const {
  60                 boost::mutex::scoped_lock lm (_mutex);
  61                 return _subtitle_y_offset;
  62         }
  63
  64         double subtitle_scale () const {
  65                 boost::mutex::scoped_lock lm (_mutex);
  66                 return _subtitle_scale;
  67         }
  68
  69 private:
  70         friend class ffmpeg_pts_offset_test;
  71
  72         bool _subtitle_use;
  73         /** x offset for placing subtitles, as a proportion of the container width;
  74          * +ve is further right, -ve is further left.
  75          */
  76         double _subtitle_x_offset;
  77         /** y offset for placing subtitles, as a proportion of the container height;
  78          *  +ve is further down the frame, -ve is further up.
  79          */
  80         double _subtitle_y_offset;
  81         /** scale factor to apply to subtitles */
  82         double _subtitle_scale;
  83 };
  84
  85 #endif