2 Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
22 #ifndef DCPOMATIC_PLAYER_VIDEO_H
23 #define DCPOMATIC_PLAYER_VIDEO_H
26 #include "colour_conversion.h"
27 #include "dcpomatic_time.h"
30 #include "position_image.h"
33 #include <libavutil/pixfmt.h>
35 #include <boost/thread/mutex.hpp>
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.
52 std::shared_ptr<const ImageProxy> image,
54 boost::optional<double> fade,
59 boost::optional<ColourConversion> colour_conversion,
60 VideoRange video_range,
61 std::weak_ptr<Content> content,
62 boost::optional<Frame> video_frame,
66 PlayerVideo (std::shared_ptr<cxml::Node>, std::shared_ptr<Socket>);
68 PlayerVideo (PlayerVideo const&) = delete;
69 PlayerVideo& operator= (PlayerVideo const&) = delete;
71 std::shared_ptr<PlayerVideo> shallow_copy () const;
73 void set_text (PositionImage);
74 boost::optional<PositionImage> text () const {
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;
82 static AVPixelFormat force (AVPixelFormat, AVPixelFormat);
83 static AVPixelFormat keep_xyz_or_rgb (AVPixelFormat);
85 void add_metadata (xmlpp::Node* node) const;
86 void write_to_socket (std::shared_ptr<Socket> socket) const;
88 bool reset_metadata (std::shared_ptr<const Film> film, dcp::Size player_video_container_size);
90 bool has_j2k () const;
91 std::shared_ptr<const dcp::Data> j2k () const;
97 void set_eyes (Eyes e) {
101 boost::optional<ColourConversion> colour_conversion () const {
102 return _colour_conversion;
105 /** @return Position of the content within the overall image once it has been scaled up */
106 Position<int> inter_position () const;
108 /** @return Size of the content within the overall image once it has been scaled up */
109 dcp::Size inter_size () const {
113 dcp::Size out_size () const {
117 bool same (std::shared_ptr<const PlayerVideo> other) const;
119 size_t memory_used () const;
121 std::weak_ptr<Content> content () const {
125 bool error () const {
130 void make_image (std::function<AVPixelFormat (AVPixelFormat)> pixel_format, VideoRange video_range, bool fast) const;
132 std::shared_ptr<const ImageProxy> _in;
134 boost::optional<double> _fade;
135 dcp::Size _inter_size;
139 boost::optional<ColourConversion> _colour_conversion;
140 VideoRange _video_range;
141 boost::optional<PositionImage> _text;
142 /** Content that we came from. This is so that reset_metadata() can work. */
143 std::weak_ptr<Content> _content;
144 /** Video frame that we came from. Again, this is for reset_metadata() */
145 boost::optional<Frame> _video_frame;
147 mutable boost::mutex _mutex;
148 mutable std::shared_ptr<Image> _image;
149 /** _crop that was used to make _image */
150 mutable Crop _image_crop;
151 /** _inter_size that was used to make _image */
152 mutable dcp::Size _image_inter_size;
153 /** _out_size that was used to make _image */
154 mutable dcp::Size _image_out_size;
155 /** _fade that was used to make _image */
156 mutable boost::optional<double> _image_fade;
157 /** true if there was an error when decoding our image */