X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fvideo_source.h;h=893629160eb4bc61a7327302e07923671bfd0b3e;hb=7d262f9be3a4c5d8da07dce42f7e2da708f6c7f4;hp=a93bd39d41e623bee5d388cbef05475f1b1cc1d1;hpb=ac0a9000d5d6a62c4ef3e4902611b180501e09e1;p=dcpomatic.git diff --git a/src/lib/video_source.h b/src/lib/video_source.h index a93bd39d4..893629160 100644 --- a/src/lib/video_source.h +++ b/src/lib/video_source.h @@ -1,3 +1,26 @@ +/* + Copyright (C) 2012 Carl Hetherington + + 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, boost::shared_ptr)> Video; + boost::signals2::signal, bool, boost::shared_ptr)> Video; void connect_video (boost::shared_ptr); };