Log failure to hard-link.

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

diff --git a/src/lib/video_source.h b/src/lib/video_source.h
index a93bd39d41e623bee5d388cbef05475f1b1cc1d1..893629160eb4bc61a7327302e07923671bfd0b3e 100644 (file)
--- a/src/lib/video_source.h
+++ b/src/lib/video_source.h
@@ -1,3 +1,26 @@
+/*
+    Copyright (C) 2012 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
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
+/** @file  src/video_source.h
+ *  @brief Parent class for classes which emit video data.
+ */
+
 #ifndef DVDOMATIC_VIDEO_SOURCE_H
 #define DVDOMATIC_VIDEO_SOURCE_H
 
@@ -9,15 +32,19 @@ class VideoSink;
 class Subtitle;
 class Image;
 
+/** @class VideoSink
+ *  @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.
         */
-       boost::signals2::signal<void (boost::shared_ptr<Image>, boost::shared_ptr<Subtitle>)> Video;
+       boost::signals2::signal<void (boost::shared_ptr<Image>, bool, boost::shared_ptr<Subtitle>)> Video;
 
        void connect_video (boost::shared_ptr<VideoSink>);
 };