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