Merge master.

[dcpomatic.git] / src / lib / subtitle_content.h

diff --git a/src/lib/subtitle_content.h b/src/lib/subtitle_content.h
index 854647d181dfc065f11ed191b051d5c939965683..97649f4d525590a2ad1fdb333a6b789bad9087e1 100644 (file)
--- a/src/lib/subtitle_content.h
+++ b/src/lib/subtitle_content.h
@@ -25,39 +25,68 @@
 class SubtitleContentProperty
 {
 public:
-       static int const SUBTITLE_OFFSET;
+       static int const SUBTITLE_X_OFFSET;
+       static int const SUBTITLE_Y_OFFSET;
        static int const SUBTITLE_SCALE;
+       static int const USE_SUBTITLES;
 };
 
+/** @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>, boost::shared_ptr<const cxml::Node>);
+       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;
+
+       virtual bool has_subtitles () const = 0;
 
-       void set_subtitle_offset (double);
+       void set_use_subtitles (bool);
+       void set_subtitle_x_offset (double);
+       void set_subtitle_y_offset (double);
        void set_subtitle_scale (double);
 
-       double subtitle_offset () const {
+       bool use_subtitles () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _use_subtitles;
+       }
+
+       double subtitle_x_offset () const {
                boost::mutex::scoped_lock lm (_mutex);
-               return _subtitle_offset;
+               return _subtitle_x_offset;
+       }
+
+       double subtitle_y_offset () const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _subtitle_y_offset;
        }
 
        double subtitle_scale () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _subtitle_scale;
        }
-       
+
 private:
-       friend class ffmpeg_pts_offset_test;
-       
+       friend struct ffmpeg_pts_offset_test;
+
+       bool _use_subtitles;
+       /** x offset for placing subtitles, as a proportion of the container width;
+        * +ve is further right, -ve is further left.
+        */
+       double _subtitle_x_offset;
        /** y offset for placing subtitles, as a proportion of the container height;
-           +ve is further down the frame, -ve is further up.
-       */
-       double _subtitle_offset;
+        *  +ve is further down the frame, -ve is further up.
+        */
+       double _subtitle_y_offset;
        /** scale factor to apply to subtitles */
        double _subtitle_scale;
 };