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 <dcp/raw_convert.h>
34 #include <libcxml/cxml.h>
35 #include <libxml++/libxml++.h>
41 #define LOG_GENERAL(...) _parent->film()->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
43 int const VideoContentProperty::SIZE = 0;
44 int const VideoContentProperty::FRAME_TYPE = 1;
45 int const VideoContentProperty::CROP = 2;
46 int const VideoContentProperty::SCALE = 3;
47 int const VideoContentProperty::COLOUR_CONVERSION = 4;
48 int const VideoContentProperty::FADE_IN = 5;
49 int const VideoContentProperty::FADE_OUT = 6;
52 using std::setprecision;
58 using std::setprecision;
61 using boost::shared_ptr;
62 using boost::optional;
63 using boost::dynamic_pointer_cast;
64 using dcp::raw_convert;
66 VideoContent::VideoContent (Content* parent)
67 : ContentPart (parent)
69 , _frame_type (VIDEO_FRAME_TYPE_2D)
70 , _scale (VideoContentScale (Ratio::from_id ("178")))
78 shared_ptr<VideoContent>
79 VideoContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
81 if (!node->optional_number_child<int> ("VideoWidth")) {
82 return shared_ptr<VideoContent> ();
85 return shared_ptr<VideoContent> (new VideoContent (parent, node, version));
88 VideoContent::VideoContent (Content* parent, cxml::ConstNodePtr node, int version)
89 : ContentPart (parent)
91 _size.width = node->number_child<int> ("VideoWidth");
92 _size.height = node->number_child<int> ("VideoHeight");
94 /* Backwards compatibility */
95 optional<double> r = node->optional_number_child<double>("VideoFrameRate");
97 _parent->set_video_frame_rate (r.get ());
100 _length = node->number_child<Frame> ("VideoLength");
103 /* Snapshot of the VideoFrameType enum at version 34 */
104 switch (node->number_child<int> ("VideoFrameType")) {
106 _frame_type = VIDEO_FRAME_TYPE_2D;
109 _frame_type = VIDEO_FRAME_TYPE_3D_LEFT_RIGHT;
112 _frame_type = VIDEO_FRAME_TYPE_3D_TOP_BOTTOM;
115 _frame_type = VIDEO_FRAME_TYPE_3D_ALTERNATE;
118 _frame_type = VIDEO_FRAME_TYPE_3D_LEFT;
121 _frame_type = VIDEO_FRAME_TYPE_3D_RIGHT;
125 _frame_type = string_to_video_frame_type (node->string_child ("VideoFrameType"));
128 _sample_aspect_ratio = node->optional_number_child<double> ("SampleAspectRatio");
129 _crop.left = node->number_child<int> ("LeftCrop");
130 _crop.right = node->number_child<int> ("RightCrop");
131 _crop.top = node->number_child<int> ("TopCrop");
132 _crop.bottom = node->number_child<int> ("BottomCrop");
135 optional<string> r = node->optional_string_child ("Ratio");
137 _scale = VideoContentScale (Ratio::from_id (r.get ()));
140 _scale = VideoContentScale (node->node_child ("Scale"));
143 if (node->optional_node_child ("ColourConversion")) {
144 _colour_conversion = ColourConversion (node->node_child ("ColourConversion"), version);
147 _yuv = node->optional_bool_child("YUV").get_value_or (true);
150 _fade_in = node->number_child<Frame> ("FadeIn");
151 _fade_out = node->number_child<Frame> ("FadeOut");
153 _fade_in = _fade_out = 0;
157 VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
158 : ContentPart (parent)
162 shared_ptr<VideoContent> ref = c[0]->video;
163 DCPOMATIC_ASSERT (ref);
165 for (size_t i = 1; i < c.size(); ++i) {
167 if (c[i]->video->size() != ref->size()) {
168 throw JoinError (_("Content to be joined must have the same picture size."));
171 if (c[i]->video->frame_type() != ref->frame_type()) {
172 throw JoinError (_("Content to be joined must have the same video frame type."));
175 if (c[i]->video->crop() != ref->crop()) {
176 throw JoinError (_("Content to be joined must have the same crop."));
179 if (c[i]->video->scale() != ref->scale()) {
180 throw JoinError (_("Content to be joined must have the same scale setting."));
183 if (c[i]->video->colour_conversion() != ref->colour_conversion()) {
184 throw JoinError (_("Content to be joined must have the same colour conversion."));
187 if (c[i]->video->fade_in() != ref->fade_in() || c[i]->video->fade_out() != ref->fade_out()) {
188 throw JoinError (_("Content to be joined must have the same fades."));
191 _length += c[i]->video->length ();
193 if (c[i]->video->yuv ()) {
198 _size = ref->size ();
199 _frame_type = ref->frame_type ();
200 _crop = ref->crop ();
201 _scale = ref->scale ();
202 _colour_conversion = ref->colour_conversion ();
203 _fade_in = ref->fade_in ();
204 _fade_out = ref->fade_out ();
208 VideoContent::as_xml (xmlpp::Node* node) const
210 boost::mutex::scoped_lock lm (_mutex);
211 node->add_child("VideoLength")->add_child_text (raw_convert<string> (_length));
212 node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_size.width));
213 node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_size.height));
214 node->add_child("VideoFrameType")->add_child_text (video_frame_type_to_string (_frame_type));
215 if (_sample_aspect_ratio) {
216 node->add_child("SampleAspectRatio")->add_child_text (raw_convert<string> (_sample_aspect_ratio.get ()));
219 _scale.as_xml (node->add_child("Scale"));
220 if (_colour_conversion) {
221 _colour_conversion.get().as_xml (node->add_child("ColourConversion"));
223 node->add_child("YUV")->add_child_text (_yuv ? "1" : "0");
224 node->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in));
225 node->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out));
229 VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
231 /* These examiner calls could call other content methods which take a lock on the mutex */
232 dcp::Size const vs = d->video_size ();
233 Frame vl = d->video_length ();
234 optional<double> const ar = d->sample_aspect_ratio ();
235 bool const yuv = d->yuv ();
238 boost::mutex::scoped_lock lm (_mutex);
241 _sample_aspect_ratio = ar;
244 /* Guess correct scale from size and sample aspect ratio */
245 _scale = VideoContentScale (
246 Ratio::nearest_from_ratio (double (_size.width) * ar.get_value_or (1) / _size.height)
250 LOG_GENERAL ("Video length obtained from header as %1 frames", _length);
252 if (d->video_frame_rate()) {
253 _parent->set_video_frame_rate (d->video_frame_rate().get());
256 _parent->signal_changed (VideoContentProperty::SIZE);
257 _parent->signal_changed (VideoContentProperty::SCALE);
258 _parent->signal_changed (ContentProperty::LENGTH);
261 /** @return string which includes everything about how this content looks */
263 VideoContent::identifier () const
267 buffer, sizeof(buffer), "%d_%d_%d_%d_%s_%" PRId64 "_%" PRId64,
272 scale().id().c_str(),
279 if (colour_conversion()) {
280 s += "_" + colour_conversion().get().identifier ();
287 VideoContent::technical_summary () const
289 string s = String::compose (
290 N_("video: length %1 frames, size %2x%3"),
291 length_after_3d_combine(),
296 if (sample_aspect_ratio ()) {
297 s += String::compose (N_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
304 VideoContent::size_after_3d_split () const
306 dcp::Size const s = size ();
307 switch (frame_type ()) {
308 case VIDEO_FRAME_TYPE_2D:
309 case VIDEO_FRAME_TYPE_3D:
310 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
311 case VIDEO_FRAME_TYPE_3D_LEFT:
312 case VIDEO_FRAME_TYPE_3D_RIGHT:
314 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
315 return dcp::Size (s.width / 2, s.height);
316 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
317 return dcp::Size (s.width, s.height / 2);
320 DCPOMATIC_ASSERT (false);
323 /** @return Video size after 3D split and crop */
325 VideoContent::size_after_crop () const
327 return crop().apply (size_after_3d_split ());
331 VideoContent::scale_and_crop_to_fit_width ()
333 shared_ptr<const Film> film = _parent->film ();
334 set_scale (VideoContentScale (film->container ()));
336 int const crop = max (0, int (size().height - double (film->frame_size().height) * size().width / film->frame_size().width));
339 set_top_crop (crop / 2);
340 set_bottom_crop (crop / 2);
344 VideoContent::scale_and_crop_to_fit_height ()
346 shared_ptr<const Film> film = _parent->film ();
347 set_scale (VideoContentScale (film->container ()));
349 int const crop = max (0, int (size().width - double (film->frame_size().width) * size().height / film->frame_size().height));
350 set_left_crop (crop / 2);
351 set_right_crop (crop / 2);
356 /** @param f Frame index within the whole (untrimmed) content */
358 VideoContent::fade (Frame f) const
360 DCPOMATIC_ASSERT (f >= 0);
362 shared_ptr<const Film> film = _parent->film ();
364 double const vfr = _parent->active_video_frame_rate ();
366 Frame const ts = _parent->trim_start().frames_round(vfr);
367 if ((f - ts) < fade_in()) {
368 return double (f - ts) / fade_in();
371 Frame fade_out_start = length() - _parent->trim_end().frames_round(vfr) - fade_out();
372 if (f >= fade_out_start) {
373 return 1 - double (f - fade_out_start) / fade_out();
376 return optional<double> ();
380 VideoContent::processing_description () const
385 if (size().width && size().height) {
386 d += String::compose (
387 _("Content video is %1x%2"),
388 size_after_3d_split().width,
389 size_after_3d_split().height
393 double ratio = size_after_3d_split().ratio ();
395 if (sample_aspect_ratio ()) {
396 snprintf (buffer, sizeof(buffer), _(", pixel aspect ratio %.2f:1"), sample_aspect_ratio().get());
398 ratio *= sample_aspect_ratio().get ();
401 snprintf (buffer, sizeof(buffer), _("\nDisplay aspect ratio %.2f:1"), ratio);
405 if ((crop().left || crop().right || crop().top || crop().bottom) && size() != dcp::Size (0, 0)) {
406 dcp::Size cropped = size_after_crop ();
407 d += String::compose (
408 _("\nCropped to %1x%2"),
409 cropped.width, cropped.height
412 snprintf (buffer, sizeof(buffer), " (%.2f:1)", cropped.ratio());
416 shared_ptr<const Film> film = _parent->film ();
417 dcp::Size const container_size = film->frame_size ();
418 dcp::Size const scaled = scale().size (shared_from_this(), container_size, container_size);
420 if (scaled != size_after_crop ()) {
421 d += String::compose (
422 _("\nScaled to %1x%2"),
423 scaled.width, scaled.height
426 snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), scaled.ratio());
430 if (scaled != container_size) {
431 d += String::compose (
432 _("\nPadded with black to fit container %1 (%2x%3)"),
433 film->container()->nickname (),
434 container_size.width, container_size.height
437 snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), container_size.ratio());
441 if (_parent->video_frame_rate()) {
442 double const vfr = _parent->video_frame_rate().get ();
444 snprintf (buffer, sizeof(buffer), _("\nContent frame rate %.4f\n"), vfr);
447 FrameRateChange frc (vfr, film->video_frame_rate ());
448 d += frc.description ();
455 VideoContent::add_properties (list<UserProperty>& p) const
457 p.push_back (UserProperty (UserProperty::VIDEO, _("Length"), length (), _("video frames")));
458 p.push_back (UserProperty (UserProperty::VIDEO, _("Size"), String::compose ("%1x%2", size().width, size().height)));
462 VideoContent::set_length (Frame len)
464 maybe_set (_length, len, ContentProperty::LENGTH);
468 VideoContent::set_left_crop (int c)
470 maybe_set (_crop.left, c, VideoContentProperty::CROP);
474 VideoContent::set_right_crop (int c)
476 maybe_set (_crop.right, c, VideoContentProperty::CROP);
480 VideoContent::set_top_crop (int c)
482 maybe_set (_crop.top, c, VideoContentProperty::CROP);
486 VideoContent::set_bottom_crop (int c)
488 maybe_set (_crop.bottom, c, VideoContentProperty::CROP);
492 VideoContent::set_scale (VideoContentScale s)
494 maybe_set (_scale, s, VideoContentProperty::SCALE);
498 VideoContent::set_frame_type (VideoFrameType t)
500 maybe_set (_frame_type, t, VideoContentProperty::FRAME_TYPE);
504 VideoContent::unset_colour_conversion ()
506 maybe_set (_colour_conversion, boost::optional<ColourConversion> (), VideoContentProperty::COLOUR_CONVERSION);
510 VideoContent::set_colour_conversion (ColourConversion c)
512 maybe_set (_colour_conversion, c, VideoContentProperty::COLOUR_CONVERSION);
516 VideoContent::set_fade_in (Frame t)
518 maybe_set (_fade_in, t, VideoContentProperty::FADE_IN);
522 VideoContent::set_fade_out (Frame t)
524 maybe_set (_fade_out, t, VideoContentProperty::FADE_OUT);
528 VideoContent::use_template (shared_ptr<const VideoContent> c)
530 _colour_conversion = c->_colour_conversion;
531 _frame_type = c->_frame_type;
534 _fade_in = c->_fade_in;
535 _fade_out = c->_fade_out;