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