Some more tidying up.

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

diff --git a/src/lib/video_source.h b/src/lib/video_source.h
index de0635ac72895d809320ff981b4b1805e0d61913..c94b5a20a5ccdfe9ef720c276428b5b43880e522 100644 (file)
--- a/src/lib/video_source.h
+++ b/src/lib/video_source.h
@@ -17,8 +17,12 @@
 
 */
 
-#ifndef DVDOMATIC_VIDEO_SOURCE_H
-#define DVDOMATIC_VIDEO_SOURCE_H
+/** @file  src/video_source.h
+ *  @brief Parent class for classes which emit video data.
+ */
+
+#ifndef DCPOMATIC_VIDEO_SOURCE_H
+#define DCPOMATIC_VIDEO_SOURCE_H
 
 #include <boost/shared_ptr.hpp>
 #include <boost/signals2.hpp>
@@ -28,15 +32,20 @@ class VideoSink;
 class Subtitle;
 class Image;
 
+/** @class VideoSource
+ *  @param A class that emits video data.
+ */
 class VideoSource
 {
 public:
 
        /** Emitted when a video frame is ready.
-        *  First parameter is the frame within the source.
-        *  Second parameter is either 0 or a subtitle that should be on this frame.
+        *  First parameter is the video image.
+        *  Second parameter is true if the image is the same as the last one that was emitted.
+        *  Third parameter is either 0 or a subtitle that should be on this frame.
+        *  Fourth parameter is the time relative to the start of this source's content.
         */
-       boost::signals2::signal<void (boost::shared_ptr<Image>, boost::shared_ptr<Subtitle>)> Video;
+       boost::signals2::signal<void (boost::shared_ptr<const Image>, bool, boost::shared_ptr<Subtitle>, Time)> Video;
 
        void connect_video (boost::shared_ptr<VideoSink>);
 };