src/lib/subtitle_content.h

   1 /*
   2     Copyright (C) 2013-2016 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_part.h"
  24 #include <libcxml/cxml.h>
  25 #include <boost/signals2.hpp>
  26
  27 class Font;
  28
  29 class SubtitleContentProperty
  30 {
  31 public:
  32         static int const SUBTITLE_X_OFFSET;
  33         static int const SUBTITLE_Y_OFFSET;
  34         static int const SUBTITLE_X_SCALE;
  35         static int const SUBTITLE_Y_SCALE;
  36         static int const USE_SUBTITLES;
  37         static int const BURN_SUBTITLES;
  38         static int const SUBTITLE_LANGUAGE;
  39         static int const FONTS;
  40         static int const SUBTITLE_VIDEO_FRAME_RATE;
  41 };
  42
  43 class SubtitleContent : public ContentPart
  44 {
  45 public:
  46         SubtitleContent (Content* parent, boost::shared_ptr<const Film>);
  47         SubtitleContent (Content* parent, boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
  48         SubtitleContent (Content* parent, boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
  49
  50         void as_xml (xmlpp::Node *) const;
  51         std::string identifier () const;
  52
  53         bool has_subtitles () const;
  54
  55         void add_font (boost::shared_ptr<Font> font);
  56
  57         void set_use_subtitles (bool);
  58         void set_burn_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         bool burn_subtitles () const {
  71                 boost::mutex::scoped_lock lm (_mutex);
  72                 return _burn_subtitles;
  73         }
  74
  75         double subtitle_x_offset () const {
  76                 boost::mutex::scoped_lock lm (_mutex);
  77                 return _subtitle_x_offset;
  78         }
  79
  80         double subtitle_y_offset () const {
  81                 boost::mutex::scoped_lock lm (_mutex);
  82                 return _subtitle_y_offset;
  83         }
  84
  85         double subtitle_x_scale () const {
  86                 boost::mutex::scoped_lock lm (_mutex);
  87                 return _subtitle_x_scale;
  88         }
  89
  90         double subtitle_y_scale () const {
  91                 boost::mutex::scoped_lock lm (_mutex);
  92                 return _subtitle_y_scale;
  93         }
  94
  95         std::list<boost::shared_ptr<Font> > fonts () const {
  96                 boost::mutex::scoped_lock lm (_mutex);
  97                 return _fonts;
  98         }
  99
 100         std::string subtitle_language () const {
 101                 boost::mutex::scoped_lock lm (_mutex);
 102                 return _subtitle_language;
 103         }
 104
 105 protected:
 106         /** subtitle language (e.g. "German") or empty if it is not known */
 107         std::string _subtitle_language;
 108
 109 private:
 110         friend struct ffmpeg_pts_offset_test;
 111         void font_changed ();
 112         void connect_to_fonts ();
 113
 114         bool _use_subtitles;
 115         bool _burn_subtitles;
 116         /** x offset for placing subtitles, as a proportion of the container width;
 117          * +ve is further right, -ve is further left.
 118          */
 119         double _subtitle_x_offset;
 120         /** y offset for placing subtitles, as a proportion of the container height;
 121          *  +ve is further down the frame, -ve is further up.
 122          */
 123         double _subtitle_y_offset;
 124         /** x scale factor to apply to subtitles */
 125         double _subtitle_x_scale;
 126         /** y scale factor to apply to subtitles */
 127         double _subtitle_y_scale;
 128         std::list<boost::shared_ptr<Font> > _fonts;
 129         std::list<boost::signals2::connection> _font_connections;
 130 };
 131
 132 #endif