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 /** @file  src/video_source.h
  21  *  @brief Parent class for classes which emit video data.
  22  */
  23
  24 #ifndef DCPOMATIC_VIDEO_SOURCE_H
  25 #define DCPOMATIC_VIDEO_SOURCE_H
  26
  27 #include <boost/shared_ptr.hpp>
  28 #include <boost/signals2.hpp>
  29 #include "util.h"
  30
  31 class VideoSink;
  32 class Subtitle;
  33 class Image;
  34
  35 /** @class VideoSource
  36  *  @param A class that emits video data without timestamps.
  37  */
  38 class VideoSource
  39 {
  40 public:
  41
  42         /** Emitted when a video frame is ready.
  43          *  First parameter is the video image.
  44          *  Second parameter is true if the image is the same as the last one that was emitted.
  45          *  Third parameter is either 0 or a subtitle that should be on this frame.
  46          *  Fourth parameter is the time relative to the start of this source's content.
  47          */
  48         boost::signals2::signal<void (boost::shared_ptr<const Image>, bool, boost::shared_ptr<Subtitle>, Time)> Video;
  49
  50         void connect_video (boost::shared_ptr<VideoSink>);
  51 };
  52
  53 #endif