src/lib/player_video.h

   1 /*
   2     Copyright (C) 2013-2021 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
  22 #ifndef DCPOMATIC_PLAYER_VIDEO_H
  23 #define DCPOMATIC_PLAYER_VIDEO_H
  24
  25
  26 #include "colour_conversion.h"
  27 #include "dcpomatic_time.h"
  28 #include "image.h"
  29 #include "pixel_quanta.h"
  30 #include "position.h"
  31 #include "position_image.h"
  32 #include "types.h"
  33 extern "C" {
  34 #include <libavutil/pixfmt.h>
  35 }
  36 #include <boost/thread/mutex.hpp>
  37
  38
  39 class Image;
  40 class ImageProxy;
  41 class Film;
  42 class Socket;
  43
  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
  50 {
  51 public:
  52         PlayerVideo (
  53                 std::shared_ptr<const ImageProxy> image,
  54                 Crop crop,
  55                 boost::optional<double> fade,
  56                 dcp::Size size_in_film,
  57                 PixelQuanta pixel_quanta,
  58                 Eyes eyes,
  59                 Part part,
  60                 boost::optional<ColourConversion> colour_conversion,
  61                 VideoRange video_range,
  62                 std::weak_ptr<Content> content,
  63                 boost::optional<Frame> video_frame,
  64                 bool error
  65                 );
  66
  67         PlayerVideo (std::shared_ptr<cxml::Node>, std::shared_ptr<Socket>);
  68
  69         PlayerVideo (PlayerVideo const&) = delete;
  70         PlayerVideo& operator= (PlayerVideo const&) = delete;
  71
  72         std::shared_ptr<PlayerVideo> shallow_copy () const;
  73
  74         void set_text (PositionImage);
  75         boost::optional<PositionImage> text () const {
  76                 return _text;
  77         }
  78
  79         void prepare(
  80                 std::function<AVPixelFormat (AVPixelFormat)> pixel_format,
  81                 dcp::Size display_container,
  82                 dcp::Size film_container,
  83                 VideoRange video_range,
  84                 Image::Alignment alignment,
  85                 bool fast,
  86                 bool proxy_only
  87                 );
  88
  89         std::shared_ptr<Image> image(
  90                 std::function<AVPixelFormat (AVPixelFormat)> pixel_format,
  91                 dcp::Size display_container,
  92                 dcp::Size film_container,
  93                 VideoRange video_range,
  94                 bool fast
  95                 ) const;
  96
  97         std::shared_ptr<const Image> raw_image(
  98                 dcp::Size display_container,
  99                 dcp::Size film_container
 100                 ) const;
 101
 102         static AVPixelFormat force (AVPixelFormat);
 103         static AVPixelFormat keep_xyz_or_rgb (AVPixelFormat);
 104
 105         void add_metadata (xmlpp::Node* node) const;
 106         void write_to_socket (std::shared_ptr<Socket> socket) const;
 107
 108         bool reset_metadata(std::shared_ptr<const Film> film);
 109
 110         bool has_j2k(
 111                 dcp::Size display_container,
 112                 dcp::Size film_container
 113                 ) const;
 114
 115         std::shared_ptr<const dcp::Data> j2k () const;
 116
 117         Eyes eyes () const {
 118                 return _eyes;
 119         }
 120
 121         void set_eyes (Eyes e) {
 122                 _eyes = e;
 123         }
 124
 125         boost::optional<ColourConversion> colour_conversion () const {
 126                 return _colour_conversion;
 127         }
 128
 129         bool same (std::shared_ptr<const PlayerVideo> other) const;
 130
 131         size_t memory_used () const;
 132
 133         std::weak_ptr<Content> content () const {
 134                 return _content;
 135         }
 136
 137         bool error () const {
 138                 return _error;
 139         }
 140
 141 private:
 142         void make_image(
 143                 std::function<AVPixelFormat (AVPixelFormat)> pixel_format,
 144                 dcp::Size display_container,
 145                 dcp::Size film_container,
 146                 VideoRange video_range,
 147                 bool fast
 148                 ) const;
 149
 150         std::shared_ptr<const ImageProxy> _in;
 151         Crop _crop;
 152         boost::optional<double> _fade;
 153         dcp::Size _size_in_film;
 154         PixelQuanta _pixel_quanta;
 155         Eyes _eyes;
 156         Part _part;
 157         boost::optional<ColourConversion> _colour_conversion;
 158         VideoRange _video_range;
 159         boost::optional<PositionImage> _text;
 160         /** Content that we came from.  This is so that reset_metadata() can work. */
 161         std::weak_ptr<Content> _content;
 162         /** Video frame that we came from.  Again, this is for reset_metadata() */
 163         boost::optional<Frame> _video_frame;
 164
 165         mutable boost::mutex _mutex;
 166         mutable std::shared_ptr<Image> _image;
 167         /** _crop that was used to make _image */
 168         mutable Crop _image_crop;
 169         /** _size_in_film that was used to make _image */
 170         mutable dcp::Size _image_size_in_film;
 171         /** _pixel_quanta that was used to make _image */
 172         mutable PixelQuanta _image_pixel_quanta;
 173         /** _fade that was used to make _image */
 174         mutable boost::optional<double> _image_fade;
 175         /** true if there was an error when decoding our image */
 176         mutable bool _error;
 177 };
 178
 179
 180 #endif