GPL boilerplate.
[dcpomatic.git] / src / lib / video_source.h
1 /*
2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #ifndef DVDOMATIC_VIDEO_SOURCE_H
21 #define DVDOMATIC_VIDEO_SOURCE_H
22
23 #include <boost/shared_ptr.hpp>
24 #include <boost/signals2.hpp>
25 #include "util.h"
26
27 class VideoSink;
28 class Subtitle;
29 class Image;
30
31 class VideoSource
32 {
33 public:
34
35         /** Emitted when a video frame is ready.
36          *  First parameter is the frame within the source.
37          *  Second parameter is either 0 or a subtitle that should be on this frame.
38          */
39         boost::signals2::signal<void (boost::shared_ptr<Image>, boost::shared_ptr<Subtitle>)> Video;
40
41         void connect_video (boost::shared_ptr<VideoSink>);
42 };
43
44 #endif