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