src/lib/player_video.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 class Log;
  31 class EncodedData;
  32
  33 /** Everything needed to describe a video frame coming out of the player, but with the
  34  *  bits still their raw form.  We may want to combine the bits on a remote machine,
  35  *  or maybe not even bother to combine them at all.
  36  */
  37 class PlayerVideo
  38 {
  39 public:
  40         PlayerVideo (
  41                 boost::shared_ptr<const ImageProxy>,
  42                 DCPTime,
  43                 Crop,
  44                 boost::optional<float>,
  45                 dcp::Size,
  46                 dcp::Size,
  47                 Scaler const *,
  48                 Eyes,
  49                 Part,
  50                 ColourConversion
  51                 );
  52
  53         PlayerVideo (boost::shared_ptr<cxml::Node>, boost::shared_ptr<Socket>, boost::shared_ptr<Log>);
  54
  55         void set_subtitle (PositionImage);
  56
  57         boost::shared_ptr<Image> image (bool burn_subtitle) const;
  58
  59         void add_metadata (xmlpp::Node* node, bool send_subtitles) const;
  60         void send_binary (boost::shared_ptr<Socket> socket, bool send_subtitles) const;
  61
  62         bool has_j2k () const;
  63         boost::shared_ptr<EncodedData> j2k () const;
  64
  65         DCPTime time () const {
  66                 return _time;
  67         }
  68
  69         Eyes eyes () const {
  70                 return _eyes;
  71         }
  72
  73         ColourConversion colour_conversion () const {
  74                 return _colour_conversion;
  75         }
  76
  77         /** @return Position of the content within the overall image once it has been scaled up */
  78         Position<int> inter_position () const;
  79
  80         /** @return Size of the content within the overall image once it has been scaled up */
  81         dcp::Size inter_size () const {
  82                 return _inter_size;
  83         }
  84
  85         bool same (boost::shared_ptr<const PlayerVideo> other) const;
  86
  87 private:
  88         boost::shared_ptr<const ImageProxy> _in;
  89         DCPTime _time;
  90         Crop _crop;
  91         boost::optional<float> _fade;
  92         dcp::Size _inter_size;
  93         dcp::Size _out_size;
  94         Scaler const * _scaler;
  95         Eyes _eyes;
  96         Part _part;
  97         ColourConversion _colour_conversion;
  98         PositionImage _subtitle;
  99 };