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