src/lib/player_video.h

   1 /*
   2     Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #include "types.h"
  22 #include "position.h"
  23 #include "dcpomatic_time.h"
  24 #include "colour_conversion.h"
  25 #include "position_image.h"
  26 extern "C" {
  27 #include <libavutil/pixfmt.h>
  28 }
  29 #include <boost/shared_ptr.hpp>
  30
  31 class Image;
  32 class ImageProxy;
  33 class Socket;
  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                 Crop,
  45                 boost::optional<double>,
  46                 dcp::Size,
  47                 dcp::Size,
  48                 Eyes,
  49                 Part,
  50                 boost::optional<ColourConversion>
  51                 );
  52
  53         PlayerVideo (boost::shared_ptr<cxml::Node>, boost::shared_ptr<Socket>);
  54
  55         void set_subtitle (PositionImage);
  56
  57         boost::shared_ptr<Image> image (dcp::NoteHandler note, boost::function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast) const;
  58
  59         static AVPixelFormat always_rgb (AVPixelFormat);
  60         static AVPixelFormat keep_xyz_or_rgb (AVPixelFormat);
  61
  62         void add_metadata (xmlpp::Node* node) const;
  63         void send_binary (boost::shared_ptr<Socket> socket) const;
  64
  65         bool has_j2k () const;
  66         dcp::Data j2k () const;
  67
  68         Eyes eyes () const {
  69                 return _eyes;
  70         }
  71
  72         void set_eyes (Eyes e) {
  73                 _eyes = e;
  74         }
  75
  76         boost::optional<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         Crop _crop;
  93         boost::optional<double> _fade;
  94         dcp::Size _inter_size;
  95         dcp::Size _out_size;
  96         Eyes _eyes;
  97         Part _part;
  98         boost::optional<ColourConversion> _colour_conversion;
  99         boost::optional<PositionImage> _subtitle;
 100 };