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