src/lib/video_decoder.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 DCPOMATIC_VIDEO_DECODER_H
  21 #define DCPOMATIC_VIDEO_DECODER_H
  22
  23 #include <boost/signals2.hpp>
  24 #include <boost/shared_ptr.hpp>
  25 #include "decoder.h"
  26 #include "video_content.h"
  27 #include "util.h"
  28
  29 class VideoContent;
  30 class ImageProxy;
  31
  32 class VideoDecoder : public virtual Decoder
  33 {
  34 public:
  35         VideoDecoder (boost::shared_ptr<const Film>, boost::shared_ptr<const VideoContent>);
  36
  37         /** Seek so that the next pass() will yield (approximately) the requested frame.
  38          *  Pass accurate = true to try harder to get close to the request.
  39          */
  40         virtual void seek (VideoContent::Frame frame, bool accurate) = 0;
  41
  42         /** Emitted when a video frame is ready.
  43          *  First parameter is the video image.
  44          *  Second parameter is the eye(s) which should see this image.
  45          *  Third parameter is the part of this image that should be used.
  46          *  Fourth parameter is true if the image is the same as the last one that was emitted for this Eyes value.
  47          *  Fourth parameter is the frame within our source.
  48          */
  49         boost::signals2::signal<void (boost::shared_ptr<const ImageProxy>, Eyes, Part, bool, VideoContent::Frame)> Video;
  50
  51 protected:
  52
  53         void video (boost::shared_ptr<const ImageProxy>, bool, VideoContent::Frame);
  54         boost::shared_ptr<const VideoContent> _video_content;
  55         /** This is in frames without taking 3D into account (e.g. if we are doing 3D alternate,
  56          *  this would equal 2 on the left-eye second frame (not 1)).
  57          */
  58         VideoContent::Frame _video_position;
  59 };
  60
  61 #endif