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_OFFSET;
  29         static int const SUBTITLE_SCALE;
  30 };
  31
  32 class SubtitleContent : public virtual Content
  33 {
  34 public:
  35         SubtitleContent (boost::shared_ptr<const Film>, boost::filesystem::path);
  36         SubtitleContent (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
  37
  38         void as_xml (xmlpp::Node *) const;
  39
  40         void set_subtitle_offset (double);
  41         void set_subtitle_scale (double);
  42
  43         double subtitle_offset () const {
  44                 boost::mutex::scoped_lock lm (_mutex);
  45                 return _subtitle_offset;
  46         }
  47
  48         double subtitle_scale () const {
  49                 boost::mutex::scoped_lock lm (_mutex);
  50                 return _subtitle_scale;
  51         }
  52
  53 private:
  54         /** y offset for placing subtitles, as a proportion of the container height;
  55             +ve is further down the frame, -ve is further up.
  56         */
  57         double _subtitle_offset;
  58         /** scale factor to apply to subtitles */
  59         double _subtitle_scale;
  60 };
  61
  62 #endif