Merge branch '2.0' of ssh://main.carlh.net/home/carl/git/dcpomatic into 2.0
[dcpomatic.git] / src / lib / subtitle_decoder.h
index 142cfa42b766b0813fb1570d530268d886beee2c..d7faaa0145900658edb2441597a47b0d5e3af968 100644 (file)
 #ifndef DCPOMATIC_SUBTITLE_DECODER_H
 #define DCPOMATIC_SUBTITLE_DECODER_H
 
-#include <dcp/subtitle_string.h>
 #include "decoder.h"
 #include "rect.h"
 #include "types.h"
 #include "content_subtitle.h"
+#include <dcp/subtitle_string.h>
 
 class Film;
 class DCPTimedSubtitle;
@@ -51,7 +51,10 @@ private:
        template <class T>
        std::list<T> get (std::list<T> const & subs, ContentTimePeriod period, bool starting);
 
-       virtual std::list<ContentTimePeriod> subtitles_during (ContentTimePeriod, bool starting) const = 0;
+       /** @param starting true if we want only subtitles that start during the period, otherwise
+        *  we want subtitles that overlap the period.
+        */
+       virtual std::list<ContentTimePeriod> subtitles_during (ContentTimePeriod period, bool starting) const = 0;
        
        boost::shared_ptr<const SubtitleContent> _subtitle_content;
 };