Merge master.

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

diff --git a/src/lib/subtitle_content.h b/src/lib/subtitle_content.h
index 1425c33cd695ff5a06941e11db27cd5386c7000b..97649f4d525590a2ad1fdb333a6b789bad9087e1 100644 (file)
--- a/src/lib/subtitle_content.h
+++ b/src/lib/subtitle_content.h
@@ -28,9 +28,15 @@ public:
        static int const SUBTITLE_X_OFFSET;
        static int const SUBTITLE_Y_OFFSET;
        static int const SUBTITLE_SCALE;
-       static int const SUBTITLE_USE;
+       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:
@@ -42,14 +48,16 @@ public:
        void as_xml (xmlpp::Node *) const;
        std::string identifier () const;
 
-       void set_subtitle_use (bool);
+       virtual bool has_subtitles () const = 0;
+
+       void set_use_subtitles (bool);
        void set_subtitle_x_offset (double);
        void set_subtitle_y_offset (double);
        void set_subtitle_scale (double);
 
-       bool subtitle_use () const {
+       bool use_subtitles () const {
                boost::mutex::scoped_lock lm (_mutex);
-               return _subtitle_use;
+               return _use_subtitles;
        }
 
        double subtitle_x_offset () const {
@@ -68,9 +76,9 @@ public:
        }
 
 private:
-       friend class ffmpeg_pts_offset_test;
+       friend struct ffmpeg_pts_offset_test;
 
-       bool _subtitle_use;
+       bool _use_subtitles;
        /** x offset for placing subtitles, as a proportion of the container width;
         * +ve is further right, -ve is further left.
         */