Merge branch 'content-burn-subs' into 2.0
[dcpomatic.git] / src / lib / player_video.cc
1 /*
2     Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #include "player_video.h"
21 #include "image.h"
22 #include "image_proxy.h"
23 #include "j2k_image_proxy.h"
24 #include "film.h"
25 #include "raw_convert.h"
26
27 using std::string;
28 using std::cout;
29 using boost::shared_ptr;
30 using boost::dynamic_pointer_cast;
31 using boost::optional;
32
33 PlayerVideo::PlayerVideo (
34         shared_ptr<const ImageProxy> in,
35         DCPTime time,
36         Crop crop,
37         boost::optional<float> fade,
38         dcp::Size inter_size,
39         dcp::Size out_size,
40         Eyes eyes,
41         Part part,
42         optional<ColourConversion> colour_conversion
43         )
44         : _in (in)
45         , _time (time)
46         , _crop (crop)
47         , _fade (fade)
48         , _inter_size (inter_size)
49         , _out_size (out_size)
50         , _eyes (eyes)
51         , _part (part)
52         , _colour_conversion (colour_conversion)
53 {
54
55 }
56
57 PlayerVideo::PlayerVideo (shared_ptr<cxml::Node> node, shared_ptr<Socket> socket)
58 {
59         _time = DCPTime (node->number_child<DCPTime::Type> ("Time"));
60         _crop = Crop (node);
61         _fade = node->optional_number_child<float> ("Fade");
62
63         _inter_size = dcp::Size (node->number_child<int> ("InterWidth"), node->number_child<int> ("InterHeight"));
64         _out_size = dcp::Size (node->number_child<int> ("OutWidth"), node->number_child<int> ("OutHeight"));
65         _eyes = (Eyes) node->number_child<int> ("Eyes");
66         _part = (Part) node->number_child<int> ("Part");
67
68         /* Assume that the ColourConversion uses the current state version */
69         _colour_conversion = ColourConversion::from_xml (node, Film::current_state_version);
70
71         _in = image_proxy_factory (node->node_child ("In"), socket);
72
73         if (node->optional_number_child<int> ("SubtitleX")) {
74
75                 shared_ptr<Image> image (
76                         new Image (PIX_FMT_RGBA, dcp::Size (node->number_child<int> ("SubtitleWidth"), node->number_child<int> ("SubtitleHeight")), true)
77                         );
78
79                 image->read_from_socket (socket);
80
81                 _subtitle = PositionImage (image, Position<int> (node->number_child<int> ("SubtitleX"), node->number_child<int> ("SubtitleY")));
82         }
83 }
84
85 void
86 PlayerVideo::set_subtitle (PositionImage image)
87 {
88         _subtitle = image;
89 }
90
91 shared_ptr<Image>
92 PlayerVideo::image (AVPixelFormat pixel_format, dcp::NoteHandler note) const
93 {
94         shared_ptr<Image> im = _in->image (optional<dcp::NoteHandler> (note));
95
96         Crop total_crop = _crop;
97         switch (_part) {
98         case PART_LEFT_HALF:
99                 total_crop.right += im->size().width / 2;
100                 break;
101         case PART_RIGHT_HALF:
102                 total_crop.left += im->size().width / 2;
103                 break;
104         case PART_TOP_HALF:
105                 total_crop.bottom += im->size().height / 2;
106                 break;
107         case PART_BOTTOM_HALF:
108                 total_crop.top += im->size().height / 2;
109                 break;
110         default:
111                 break;
112         }
113
114         dcp::YUVToRGB yuv_to_rgb = dcp::YUV_TO_RGB_REC601;
115         if (_colour_conversion) {
116                 yuv_to_rgb = _colour_conversion.get().yuv_to_rgb();
117         }
118
119         shared_ptr<Image> out = im->crop_scale_window (total_crop, _inter_size, _out_size, yuv_to_rgb, pixel_format, true);
120
121         if (_subtitle) {
122                 out->alpha_blend (_subtitle->image, _subtitle->position);
123         }
124
125         if (_fade) {
126                 out->fade (_fade.get ());
127         }
128
129         return out;
130 }
131
132 void
133 PlayerVideo::add_metadata (xmlpp::Node* node) const
134 {
135         node->add_child("Time")->add_child_text (raw_convert<string> (_time.get ()));
136         _crop.as_xml (node);
137         if (_fade) {
138                 node->add_child("Fade")->add_child_text (raw_convert<string> (_fade.get ()));
139         }
140         _in->add_metadata (node->add_child ("In"));
141         node->add_child("InterWidth")->add_child_text (raw_convert<string> (_inter_size.width));
142         node->add_child("InterHeight")->add_child_text (raw_convert<string> (_inter_size.height));
143         node->add_child("OutWidth")->add_child_text (raw_convert<string> (_out_size.width));
144         node->add_child("OutHeight")->add_child_text (raw_convert<string> (_out_size.height));
145         node->add_child("Eyes")->add_child_text (raw_convert<string> (_eyes));
146         node->add_child("Part")->add_child_text (raw_convert<string> (_part));
147         if (_colour_conversion) {
148                 _colour_conversion.get().as_xml (node);
149         }
150         if (_subtitle) {
151                 node->add_child ("SubtitleWidth")->add_child_text (raw_convert<string> (_subtitle->image->size().width));
152                 node->add_child ("SubtitleHeight")->add_child_text (raw_convert<string> (_subtitle->image->size().height));
153                 node->add_child ("SubtitleX")->add_child_text (raw_convert<string> (_subtitle->position.x));
154                 node->add_child ("SubtitleY")->add_child_text (raw_convert<string> (_subtitle->position.y));
155         }
156 }
157
158 void
159 PlayerVideo::send_binary (shared_ptr<Socket> socket) const
160 {
161         _in->send_binary (socket);
162         if (_subtitle) {
163                 _subtitle->image->write_to_socket (socket);
164         }
165 }
166
167 bool
168 PlayerVideo::has_j2k () const
169 {
170         /* XXX: burnt-in subtitle; maybe other things */
171
172         shared_ptr<const J2KImageProxy> j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
173         if (!j2k) {
174                 return false;
175         }
176
177         return _crop == Crop () && _inter_size == j2k->size();
178 }
179
180 Data
181 PlayerVideo::j2k () const
182 {
183         shared_ptr<const J2KImageProxy> j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
184         DCPOMATIC_ASSERT (j2k);
185         return j2k->j2k ();
186 }
187
188 Position<int>
189 PlayerVideo::inter_position () const
190 {
191         return Position<int> ((_out_size.width - _inter_size.width) / 2, (_out_size.height - _inter_size.height) / 2);
192 }
193
194 /** @return true if this PlayerVideo is definitely the same as another
195  * (apart from _time), false if it is probably not
196  */
197 bool
198 PlayerVideo::same (shared_ptr<const PlayerVideo> other) const
199 {
200         if (_crop != other->_crop ||
201             _fade.get_value_or(0) != other->_fade.get_value_or(0) ||
202             _inter_size != other->_inter_size ||
203             _out_size != other->_out_size ||
204             _eyes != other->_eyes ||
205             _part != other->_part ||
206             _colour_conversion != other->_colour_conversion) {
207                 return false;
208         }
209
210         if ((!_subtitle && other->_subtitle) || (_subtitle && !other->_subtitle)) {
211                 /* One has a subtitle and the other doesn't */
212                 return false;
213         }
214
215         if (_subtitle && other->_subtitle && !_subtitle->same (other->_subtitle.get ())) {
216                 /* They both have subtitles but they are different */
217                 return false;
218         }
219
220         /* Now neither has subtitles */
221
222         return _in->same (other->_in);
223 }