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