src/lib/player_video.h

   1 /*
   2     Copyright (C) 2013-2020 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 #include <boost/weak_ptr.hpp>
  34 #include <boost/thread/mutex.hpp>
  35 #include <boost/noncopyable.hpp>
  36
  37 namespace dcpomatic {
  38         class Image;
  39 }
  40
  41 class ImageProxy;
  42 class Film;
  43 class Socket;
  44
  45 /** Everything needed to describe a video frame coming out of the player, but with the
  46  *  bits still their raw form.  We may want to combine the bits on a remote machine,
  47  *  or maybe not even bother to combine them at all.
  48  */
  49 class PlayerVideo : public boost::noncopyable
  50 {
  51 public:
  52         PlayerVideo (
  53                 boost::shared_ptr<const ImageProxy>,
  54                 Crop,
  55                 boost::optional<double>,
  56                 dcp::Size,
  57                 dcp::Size,
  58                 Eyes,
  59                 Part,
  60                 boost::optional<ColourConversion>,
  61                 VideoRange video_range,
  62                 boost::weak_ptr<Content>,
  63                 boost::optional<Frame>,
  64                 bool error
  65                 );
  66
  67         PlayerVideo (boost::shared_ptr<cxml::Node>, boost::shared_ptr<Socket>);
  68
  69         boost::shared_ptr<PlayerVideo> shallow_copy () const;
  70
  71         void set_text (PositionImage);
  72
  73         void prepare (boost::function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast);
  74         boost::shared_ptr<dcpomatic::Image> image (boost::function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast) const;
  75
  76         static AVPixelFormat force (AVPixelFormat, AVPixelFormat);
  77         static AVPixelFormat keep_xyz_or_rgb (AVPixelFormat);
  78
  79         void add_metadata (xmlpp::Node* node) const;
  80         void write_to_socket (boost::shared_ptr<Socket> socket) const;
  81
  82         bool reset_metadata (boost::shared_ptr<const Film> film, dcp::Size video_container_size, dcp::Size film_frame_size);
  83
  84         bool has_j2k () const;
  85         /* XXX: who's using this?! */
  86         dcp::Data j2k () const;
  87
  88         Eyes eyes () const {
  89                 return _eyes;
  90         }
  91
  92         void set_eyes (Eyes e) {
  93                 _eyes = e;
  94         }
  95
  96         boost::optional<ColourConversion> colour_conversion () const {
  97                 return _colour_conversion;
  98         }
  99
 100         /** @return Position of the content within the overall image once it has been scaled up */
 101         Position<int> inter_position () const;
 102
 103         /** @return Size of the content within the overall image once it has been scaled up */
 104         dcp::Size inter_size () const {
 105                 return _inter_size;
 106         }
 107
 108         bool same (boost::shared_ptr<const PlayerVideo> other) const;
 109
 110         size_t memory_used () const;
 111
 112         boost::weak_ptr<Content> content () const {
 113                 return _content;
 114         }
 115
 116         bool error () const {
 117                 return _error;
 118         }
 119
 120         boost::shared_ptr<const ImageProxy> image_proxy () const {
 121                 return _in;
 122         }
 123
 124 private:
 125         void make_image (boost::function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast) const;
 126
 127         boost::shared_ptr<const ImageProxy> _in;
 128         Crop _crop;
 129         boost::optional<double> _fade;
 130         dcp::Size _inter_size;
 131         dcp::Size _out_size;
 132         Eyes _eyes;
 133         Part _part;
 134         boost::optional<ColourConversion> _colour_conversion;
 135         VideoRange _video_range;
 136         boost::optional<PositionImage> _text;
 137         /** Content that we came from.  This is so that reset_metadata() can work, and also
 138          *  for variant:swaroop's non-skippable ads.
 139          */
 140         boost::weak_ptr<Content> _content;
 141         /** Video frame that we came from.  Again, this is for reset_metadata() */
 142         boost::optional<Frame> _video_frame;
 143
 144         mutable boost::mutex _mutex;
 145         mutable boost::shared_ptr<dcpomatic::Image> _image;
 146         /** _crop that was used to make _image */
 147         mutable Crop _image_crop;
 148         /** _inter_size that was used to make _image */
 149         mutable dcp::Size _image_inter_size;
 150         /** _out_size that was used to make _image */
 151         mutable dcp::Size _image_out_size;
 152         /** _fade that was used to make _image */
 153         mutable boost::optional<double> _image_fade;
 154         /** true if there was an error when decoding our image */
 155         mutable bool _error;
 156 };
 157
 158 #endif