2 Copyright (C) 2013-2016 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 #include "video_content.h"
23 #include "video_examiner.h"
24 #include "compose.hpp"
27 #include "colour_conversion.h"
30 #include "exceptions.h"
31 #include "frame_rate_change.h"
33 #include "safe_stringstream.h"
34 #include "raw_convert.h"
35 #include <libcxml/cxml.h>
36 #include <dcp/colour_matrix.h>
37 #include <libxml++/libxml++.h>
43 #define LOG_GENERAL(...) _parent->film()->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
45 int const VideoContentProperty::SIZE = 0;
46 int const VideoContentProperty::FRAME_TYPE = 1;
47 int const VideoContentProperty::CROP = 2;
48 int const VideoContentProperty::SCALE = 3;
49 int const VideoContentProperty::COLOUR_CONVERSION = 4;
50 int const VideoContentProperty::FADE_IN = 5;
51 int const VideoContentProperty::FADE_OUT = 6;
54 using std::setprecision;
60 using std::setprecision;
63 using boost::shared_ptr;
64 using boost::optional;
65 using boost::dynamic_pointer_cast;
67 VideoContent::VideoContent (Content* parent)
68 : ContentPart (parent)
70 , _frame_type (VIDEO_FRAME_TYPE_2D)
71 , _scale (VideoContentScale (Ratio::from_id ("178")))
79 shared_ptr<VideoContent>
80 VideoContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
82 if (!node->optional_number_child<int> ("VideoWidth")) {
83 return shared_ptr<VideoContent> ();
86 /* Can't use make_shared here as the constructor is private */
87 return shared_ptr<VideoContent> (new VideoContent (parent, node, version));
90 VideoContent::VideoContent (Content* parent, cxml::ConstNodePtr node, int version)
91 : ContentPart (parent)
93 _size.width = node->number_child<int> ("VideoWidth");
94 _size.height = node->number_child<int> ("VideoHeight");
96 /* Backwards compatibility */
97 optional<double> r = node->optional_number_child<double>("VideoFrameRate");
99 _parent->set_video_frame_rate (r.get ());
102 _length = node->number_child<Frame> ("VideoLength");
105 /* Snapshot of the VideoFrameType enum at version 34 */
106 switch (node->number_child<int> ("VideoFrameType")) {
108 _frame_type = VIDEO_FRAME_TYPE_2D;
111 _frame_type = VIDEO_FRAME_TYPE_3D_LEFT_RIGHT;
114 _frame_type = VIDEO_FRAME_TYPE_3D_TOP_BOTTOM;
117 _frame_type = VIDEO_FRAME_TYPE_3D_ALTERNATE;
120 _frame_type = VIDEO_FRAME_TYPE_3D_LEFT;
123 _frame_type = VIDEO_FRAME_TYPE_3D_RIGHT;
127 _frame_type = string_to_video_frame_type (node->string_child ("VideoFrameType"));
130 _sample_aspect_ratio = node->optional_number_child<double> ("SampleAspectRatio");
131 _crop.left = node->number_child<int> ("LeftCrop");
132 _crop.right = node->number_child<int> ("RightCrop");
133 _crop.top = node->number_child<int> ("TopCrop");
134 _crop.bottom = node->number_child<int> ("BottomCrop");
137 optional<string> r = node->optional_string_child ("Ratio");
139 _scale = VideoContentScale (Ratio::from_id (r.get ()));
142 _scale = VideoContentScale (node->node_child ("Scale"));
146 if (node->optional_node_child ("ColourConversion")) {
147 _colour_conversion = ColourConversion (node->node_child ("ColourConversion"), version);
150 _yuv = node->optional_bool_child("YUV").get_value_or (true);
153 _fade_in = node->number_child<Frame> ("FadeIn");
154 _fade_out = node->number_child<Frame> ("FadeOut");
156 _fade_in = _fade_out = 0;
160 VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
161 : ContentPart (parent)
165 shared_ptr<VideoContent> ref = c[0]->video;
166 DCPOMATIC_ASSERT (ref);
168 for (size_t i = 1; i < c.size(); ++i) {
170 if (c[i]->video->size() != ref->size()) {
171 throw JoinError (_("Content to be joined must have the same picture size."));
174 if (c[i]->video->frame_type() != ref->frame_type()) {
175 throw JoinError (_("Content to be joined must have the same video frame type."));
178 if (c[i]->video->crop() != ref->crop()) {
179 throw JoinError (_("Content to be joined must have the same crop."));
182 if (c[i]->video->scale() != ref->scale()) {
183 throw JoinError (_("Content to be joined must have the same scale setting."));
186 if (c[i]->video->colour_conversion() != ref->colour_conversion()) {
187 throw JoinError (_("Content to be joined must have the same colour conversion."));
190 if (c[i]->video->fade_in() != ref->fade_in() || c[i]->video->fade_out() != ref->fade_out()) {
191 throw JoinError (_("Content to be joined must have the same fades."));
194 _length += c[i]->video->length ();
196 if (c[i]->video->yuv ()) {
201 _size = ref->size ();
202 _frame_type = ref->frame_type ();
203 _crop = ref->crop ();
204 _scale = ref->scale ();
205 _colour_conversion = ref->colour_conversion ();
206 _fade_in = ref->fade_in ();
207 _fade_out = ref->fade_out ();
211 VideoContent::as_xml (xmlpp::Node* node) const
213 boost::mutex::scoped_lock lm (_mutex);
214 node->add_child("VideoLength")->add_child_text (raw_convert<string> (_length));
215 node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_size.width));
216 node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_size.height));
217 node->add_child("VideoFrameType")->add_child_text (video_frame_type_to_string (_frame_type));
218 if (_sample_aspect_ratio) {
219 node->add_child("SampleAspectRatio")->add_child_text (raw_convert<string> (_sample_aspect_ratio.get ()));
222 _scale.as_xml (node->add_child("Scale"));
223 if (_colour_conversion) {
224 _colour_conversion.get().as_xml (node->add_child("ColourConversion"));
226 node->add_child("YUV")->add_child_text (_yuv ? "1" : "0");
227 node->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in));
228 node->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out));
232 VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
234 /* These examiner calls could call other content methods which take a lock on the mutex */
235 dcp::Size const vs = d->video_size ();
236 Frame vl = d->video_length ();
237 optional<double> const ar = d->sample_aspect_ratio ();
238 bool const yuv = d->yuv ();
241 boost::mutex::scoped_lock lm (_mutex);
244 _sample_aspect_ratio = ar;
247 /* Guess correct scale from size and sample aspect ratio */
248 _scale = VideoContentScale (
249 Ratio::nearest_from_ratio (double (_size.width) * ar.get_value_or (1) / _size.height)
253 LOG_GENERAL ("Video length obtained from header as %1 frames", _length);
255 if (d->video_frame_rate()) {
256 _parent->set_video_frame_rate (d->video_frame_rate().get());
259 _parent->signal_changed (VideoContentProperty::SIZE);
260 _parent->signal_changed (VideoContentProperty::SCALE);
261 _parent->signal_changed (ContentProperty::LENGTH);
264 /** @return string which includes everything about how this content looks */
266 VideoContent::identifier () const
270 << "_" << crop().right
272 << "_" << crop().bottom
273 << "_" << scale().id()
277 if (colour_conversion()) {
278 s << "_" << colour_conversion().get().identifier ();
285 VideoContent::technical_summary () const
287 string s = String::compose (
288 N_("video: length %1 frames, size %2x%3"),
289 length_after_3d_combine(),
294 if (sample_aspect_ratio ()) {
295 s += String::compose (N_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
302 VideoContent::size_after_3d_split () const
304 dcp::Size const s = size ();
305 switch (frame_type ()) {
306 case VIDEO_FRAME_TYPE_2D:
307 case VIDEO_FRAME_TYPE_3D:
308 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
309 case VIDEO_FRAME_TYPE_3D_LEFT:
310 case VIDEO_FRAME_TYPE_3D_RIGHT:
312 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
313 return dcp::Size (s.width / 2, s.height);
314 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
315 return dcp::Size (s.width, s.height / 2);
318 DCPOMATIC_ASSERT (false);
321 /** @return Video size after 3D split and crop */
323 VideoContent::size_after_crop () const
325 return crop().apply (size_after_3d_split ());
329 VideoContent::scale_and_crop_to_fit_width ()
331 shared_ptr<const Film> film = _parent->film ();
332 set_scale (VideoContentScale (film->container ()));
334 int const crop = max (0, int (size().height - double (film->frame_size().height) * size().width / film->frame_size().width));
337 set_top_crop (crop / 2);
338 set_bottom_crop (crop / 2);
342 VideoContent::scale_and_crop_to_fit_height ()
344 shared_ptr<const Film> film = _parent->film ();
345 set_scale (VideoContentScale (film->container ()));
347 int const crop = max (0, int (size().width - double (film->frame_size().width) * size().height / film->frame_size().height));
348 set_left_crop (crop / 2);
349 set_right_crop (crop / 2);
354 /** @param f Frame index within the whole (untrimmed) content */
356 VideoContent::fade (Frame f) const
358 DCPOMATIC_ASSERT (f >= 0);
360 shared_ptr<const Film> film = _parent->film ();
362 double const vfr = _parent->active_video_frame_rate ();
364 Frame const ts = _parent->trim_start().frames_round(vfr);
365 if ((f - ts) < fade_in()) {
366 return double (f - ts) / fade_in();
369 Frame fade_out_start = length() - _parent->trim_end().frames_round(vfr) - fade_out();
370 if (f >= fade_out_start) {
371 return 1 - double (f - fade_out_start) / fade_out();
374 return optional<double> ();
378 VideoContent::processing_description () const
380 /* stringstream is OK here as this string is just for presentation to the user */
383 if (size().width && size().height) {
384 d << String::compose (
385 _("Content video is %1x%2"),
386 size_after_3d_split().width,
387 size_after_3d_split().height
391 double ratio = size_after_3d_split().ratio ();
393 if (sample_aspect_ratio ()) {
394 d << ", " << _("pixel aspect ratio") << " " << fixed << setprecision(2) << sample_aspect_ratio().get () << ":1";
395 ratio *= sample_aspect_ratio().get ();
398 d << "\n" << _("Display aspect ratio") << " " << fixed << setprecision(2) << ratio << ":1\n";
401 if ((crop().left || crop().right || crop().top || crop().bottom) && size() != dcp::Size (0, 0)) {
402 dcp::Size cropped = size_after_crop ();
403 d << String::compose (
404 _("Cropped to %1x%2"),
405 cropped.width, cropped.height
408 d << " (" << fixed << setprecision(2) << cropped.ratio () << ":1)\n";
411 shared_ptr<const Film> film = _parent->film ();
412 dcp::Size const container_size = film->frame_size ();
413 dcp::Size const scaled = scale().size (shared_from_this(), container_size, container_size);
415 if (scaled != size_after_crop ()) {
416 d << String::compose (
417 _("Scaled to %1x%2"),
418 scaled.width, scaled.height
421 d << " (" << fixed << setprecision(2) << scaled.ratio() << ":1)\n";
424 if (scaled != container_size) {
425 d << String::compose (
426 _("Padded with black to fit container %1 (%2x%3)"),
427 film->container()->nickname (),
428 container_size.width, container_size.height
431 d << " (" << fixed << setprecision(2) << container_size.ratio () << ":1)\n";
434 if (_parent->video_frame_rate()) {
435 double const vfr = _parent->video_frame_rate().get ();
437 d << _("Content frame rate");
438 d << " " << fixed << setprecision(4) << vfr << "\n";
440 FrameRateChange frc (vfr, film->video_frame_rate ());
441 d << frc.description () << "\n";
448 VideoContent::add_properties (list<UserProperty>& p) const
450 p.push_back (UserProperty (UserProperty::VIDEO, _("Length"), raw_convert<string> (length ()), _("video frames")));
451 p.push_back (UserProperty (UserProperty::VIDEO, _("Size"), raw_convert<string> (size().width) + "x" + raw_convert<string> (size().height)));
455 VideoContent::set_length (Frame len)
457 maybe_set (_length, len, ContentProperty::LENGTH);
461 VideoContent::set_left_crop (int c)
463 maybe_set (_crop.left, c, VideoContentProperty::CROP);
467 VideoContent::set_right_crop (int c)
469 maybe_set (_crop.right, c, VideoContentProperty::CROP);
473 VideoContent::set_top_crop (int c)
475 maybe_set (_crop.top, c, VideoContentProperty::CROP);
479 VideoContent::set_bottom_crop (int c)
481 maybe_set (_crop.bottom, c, VideoContentProperty::CROP);
485 VideoContent::set_scale (VideoContentScale s)
487 maybe_set (_scale, s, VideoContentProperty::SCALE);
491 VideoContent::set_frame_type (VideoFrameType t)
493 maybe_set (_frame_type, t, VideoContentProperty::FRAME_TYPE);
497 VideoContent::unset_colour_conversion ()
499 maybe_set (_colour_conversion, boost::optional<ColourConversion> (), VideoContentProperty::COLOUR_CONVERSION);
503 VideoContent::set_colour_conversion (ColourConversion c)
505 maybe_set (_colour_conversion, c, VideoContentProperty::COLOUR_CONVERSION);
509 VideoContent::set_fade_in (Frame t)
511 maybe_set (_fade_in, t, VideoContentProperty::FADE_IN);
515 VideoContent::set_fade_out (Frame t)
517 maybe_set (_fade_out, t, VideoContentProperty::FADE_OUT);