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