2 Copyright (C) 2013-2020 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/>.
21 #ifndef DCPOMATIC_PLAYER_VIDEO_H
22 #define DCPOMATIC_PLAYER_VIDEO_H
26 #include "dcpomatic_time.h"
27 #include "colour_conversion.h"
28 #include "position_image.h"
30 #include <libavutil/pixfmt.h>
32 #include <boost/shared_ptr.hpp>
33 #include <boost/weak_ptr.hpp>
34 #include <boost/thread/mutex.hpp>
35 #include <boost/noncopyable.hpp>
42 /** Everything needed to describe a video frame coming out of the player, but with the
43 * bits still their raw form. We may want to combine the bits on a remote machine,
44 * or maybe not even bother to combine them at all.
46 class PlayerVideo : public boost::noncopyable
50 boost::shared_ptr<const ImageProxy>,
52 boost::optional<double>,
57 boost::optional<ColourConversion>,
58 VideoRange video_range,
59 boost::weak_ptr<Content>,
60 boost::optional<Frame>,
64 PlayerVideo (boost::shared_ptr<cxml::Node>, boost::shared_ptr<Socket>);
66 boost::shared_ptr<PlayerVideo> shallow_copy () const;
68 void set_text (PositionImage);
70 void prepare (boost::function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast);
71 boost::shared_ptr<Image> image (boost::function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast) const;
73 static AVPixelFormat force (AVPixelFormat, AVPixelFormat);
74 static AVPixelFormat keep_xyz_or_rgb (AVPixelFormat);
76 void add_metadata (xmlpp::Node* node) const;
77 void write_to_socket (boost::shared_ptr<Socket> socket) const;
79 bool reset_metadata (boost::shared_ptr<const Film> film, dcp::Size video_container_size, dcp::Size film_frame_size);
81 bool has_j2k () const;
82 dcp::Data j2k () const;
88 void set_eyes (Eyes e) {
92 boost::optional<ColourConversion> colour_conversion () const {
93 return _colour_conversion;
96 /** @return Position of the content within the overall image once it has been scaled up */
97 Position<int> inter_position () const;
99 /** @return Size of the content within the overall image once it has been scaled up */
100 dcp::Size inter_size () const {
104 bool same (boost::shared_ptr<const PlayerVideo> other) const;
106 size_t memory_used () const;
108 boost::weak_ptr<Content> content () const {
112 bool error () const {
117 void make_image (boost::function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast) const;
119 boost::shared_ptr<const ImageProxy> _in;
121 boost::optional<double> _fade;
122 dcp::Size _inter_size;
126 boost::optional<ColourConversion> _colour_conversion;
127 VideoRange _video_range;
128 boost::optional<PositionImage> _text;
129 /** Content that we came from. This is so that reset_metadata() can work, and also
130 * for variant:swaroop's non-skippable ads.
132 boost::weak_ptr<Content> _content;
133 /** Video frame that we came from. Again, this is for reset_metadata() */
134 boost::optional<Frame> _video_frame;
136 mutable boost::mutex _mutex;
137 mutable boost::shared_ptr<Image> _image;
138 /** _crop that was used to make _image */
139 mutable Crop _image_crop;
140 /** _inter_size that was used to make _image */
141 mutable dcp::Size _image_inter_size;
142 /** _out_size that was used to make _image */
143 mutable dcp::Size _image_out_size;
144 /** _fade that was used to make _image */
145 mutable boost::optional<double> _image_fade;
146 /** true if there was an error when decoding our image */