src/lib/player_video_frame.h

   1 /*
   2     Copyright (C) 2013-2014 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 #include <boost/shared_ptr.hpp>
  21 #include "types.h"
  22 #include "position.h"
  23 #include "colour_conversion.h"
  24
  25 class Image;
  26 class ImageProxy;
  27 class Scaler;
  28 class Socket;
  29
  30 /** Everything needed to describe a video frame coming out of the player, but with the
  31  *  bits still their raw form.  We may want to combine the bits on a remote machine,
  32  *  or maybe not even bother to combine them at all.
  33  */
  34 class PlayerVideoFrame
  35 {
  36 public:
  37         PlayerVideoFrame (boost::shared_ptr<const ImageProxy>, Crop, libdcp::Size, libdcp::Size, Scaler const *, Eyes, Part, ColourConversion);
  38         PlayerVideoFrame (boost::shared_ptr<cxml::Node>, boost::shared_ptr<Socket>);
  39
  40         void set_subtitle (boost::shared_ptr<const Image>, Position<int>);
  41
  42         boost::shared_ptr<Image> image () const;
  43
  44         void add_metadata (xmlpp::Node* node) const;
  45         void send_binary (boost::shared_ptr<Socket> socket) const;
  46
  47         Eyes eyes () const {
  48                 return _eyes;
  49         }
  50
  51         ColourConversion colour_conversion () const {
  52                 return _colour_conversion;
  53         }
  54
  55 private:
  56         boost::shared_ptr<const ImageProxy> _in;
  57         Crop _crop;
  58         libdcp::Size _inter_size;
  59         libdcp::Size _out_size;
  60         Scaler const * _scaler;
  61         Eyes _eyes;
  62         Part _part;
  63         ColourConversion _colour_conversion;
  64         boost::shared_ptr<const Image> _subtitle_image;
  65         Position<int> _subtitle_position;
  66 };