Logging improvements to allow prettier displays in the server GUI.
[dcpomatic.git] / src / lib / subtitle_content.h
index 92d072ca6540aa0bdfcde06766f96c193655c532..e9017e40da4d51d500a4704235cf160ee6e13b4f 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 #include "content.h"
 
+class Font;
+
 class SubtitleContentProperty
 {
 public:
        static int const SUBTITLE_X_OFFSET;
        static int const SUBTITLE_Y_OFFSET;
-       static int const SUBTITLE_SCALE;
+       static int const SUBTITLE_X_SCALE;
+       static int const SUBTITLE_Y_SCALE;
+       static int const USE_SUBTITLES;
+       static int const BURN_SUBTITLES;
+       static int const SUBTITLE_LANGUAGE;
+       static int const FONTS;
+       static int const SUBTITLE_VIDEO_FRAME_RATE;
 };
 
+/** @class SubtitleContent
+ *  @brief Parent for content which has the potential to include subtitles.
+ *
+ *  Although inheriting from this class indicates that the content could
+ *  have subtitles, it may not.  ::has_subtitles() will tell you.
+ */
 class SubtitleContent : public virtual Content
 {
 public:
+       SubtitleContent (boost::shared_ptr<const Film>);
        SubtitleContent (boost::shared_ptr<const Film>, boost::filesystem::path);
        SubtitleContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
        SubtitleContent (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
-       
+
        void as_xml (xmlpp::Node *) const;
+       std::string identifier () const;
+
+       bool has_subtitles () const;
+       virtual bool has_text_subtitles () const = 0;
+       virtual bool has_image_subtitles () const = 0;
+       virtual double subtitle_video_frame_rate () const = 0;
 
+       void add_font (boost::shared_ptr<Font> font);
+
+       void set_use_subtitles (bool);
+       void set_burn_subtitles (bool);
        void set_subtitle_x_offset (double);
        void set_subtitle_y_offset (double);
-       void set_subtitle_scale (double);
+       void set_subtitle_x_scale (double);
+       void set_subtitle_y_scale (double);
+       void set_subtitle_language (std::string language);
+
+       bool use_subtitles () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _use_subtitles;
+       }
+
+       bool burn_subtitles () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _burn_subtitles;
+       }
 
        double subtitle_x_offset () const {
                boost::mutex::scoped_lock lm (_mutex);
@@ -53,14 +90,37 @@ public:
                return _subtitle_y_offset;
        }
 
-       double subtitle_scale () const {
+       double subtitle_x_scale () const {
                boost::mutex::scoped_lock lm (_mutex);
-               return _subtitle_scale;
+               return _subtitle_x_scale;
        }
-       
+
+       double subtitle_y_scale () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _subtitle_y_scale;
+       }
+
+       std::list<boost::shared_ptr<Font> > fonts () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _fonts;
+       }
+
+       std::string subtitle_language () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _subtitle_language;
+       }
+
+protected:
+       /** subtitle language (e.g. "German") or empty if it is not known */
+       std::string _subtitle_language;
+
 private:
-       friend class ffmpeg_pts_offset_test;
+       friend struct ffmpeg_pts_offset_test;
+       void font_changed ();
+       void connect_to_fonts ();
 
+       bool _use_subtitles;
+       bool _burn_subtitles;
        /** x offset for placing subtitles, as a proportion of the container width;
         * +ve is further right, -ve is further left.
         */
@@ -69,8 +129,12 @@ private:
         *  +ve is further down the frame, -ve is further up.
         */
        double _subtitle_y_offset;
-       /** scale factor to apply to subtitles */
-       double _subtitle_scale;
+       /** x scale factor to apply to subtitles */
+       double _subtitle_x_scale;
+       /** y scale factor to apply to subtitles */
+       double _subtitle_y_scale;
+       std::list<boost::shared_ptr<Font> > _fonts;
+       std::list<boost::signals2::connection> _font_connections;
 };
 
 #endif