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         std::string identifier () const;
  44
  45         void set_subtitle_use (bool);
  46         void set_subtitle_x_offset (double);
  47         void set_subtitle_y_offset (double);
  48         void set_subtitle_scale (double);
  49
  50         bool subtitle_use () const {
  51                 boost::mutex::scoped_lock lm (_mutex);
  52                 return _subtitle_use;
  53         }
  54
  55         double subtitle_x_offset () const {
  56                 boost::mutex::scoped_lock lm (_mutex);
  57                 return _subtitle_x_offset;
  58         }
  59
  60         double subtitle_y_offset () const {
  61                 boost::mutex::scoped_lock lm (_mutex);
  62                 return _subtitle_y_offset;
  63         }
  64
  65         double subtitle_scale () const {
  66                 boost::mutex::scoped_lock lm (_mutex);
  67                 return _subtitle_scale;
  68         }
  69
  70 private:
  71         friend class ffmpeg_pts_offset_test;
  72
  73         bool _subtitle_use;
  74         /** x offset for placing subtitles, as a proportion of the container width;
  75          * +ve is further right, -ve is further left.
  76          */
  77         double _subtitle_x_offset;
  78         /** y offset for placing subtitles, as a proportion of the container height;
  79          *  +ve is further down the frame, -ve is further up.
  80          */
  81         double _subtitle_y_offset;
  82         /** scale factor to apply to subtitles */
  83         double _subtitle_scale;
  84 };
  85
  86 #endif