summaryrefslogtreecommitdiff
path: root/src/lib/video_source.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2012-11-18 22:46:15 +0000
committerCarl Hetherington <cth@carlh.net>2012-11-18 22:46:15 +0000
commitb1defe9019642dc4b80697291d40ed88f09de8be (patch)
tree80f29e64acb805c21ea96e7e4ec070a88ca2397d /src/lib/video_source.h
parent81dab3aaea745ddef97166448cb0730520798356 (diff)
Fix mis-alignment of copied AlignedImages; add some asserts; some docs.
Diffstat (limited to 'src/lib/video_source.h')
-rw-r--r--src/lib/video_source.h9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/lib/video_source.h b/src/lib/video_source.h
index de0635ac7..d53589e2e 100644
--- a/src/lib/video_source.h
+++ b/src/lib/video_source.h
@@ -17,6 +17,10 @@
*/
+/** @file src/video_source.h
+ * @brief Parent class for classes which emit video data.
+ */
+
#ifndef DVDOMATIC_VIDEO_SOURCE_H
#define DVDOMATIC_VIDEO_SOURCE_H
@@ -28,12 +32,15 @@ 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.
+ * First parameter is the video image.
* Second 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;