2 Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
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.
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.
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.
21 #include <libcxml/cxml.h>
22 #include <libdcp/colour_matrix.h>
23 #include <libdcp/raw_convert.h>
24 #include "video_content.h"
25 #include "video_examiner.h"
26 #include "compose.hpp"
29 #include "colour_conversion.h"
32 #include "exceptions.h"
36 int const VideoContentProperty::VIDEO_SIZE = 0;
37 int const VideoContentProperty::VIDEO_FRAME_RATE = 1;
38 int const VideoContentProperty::VIDEO_FRAME_TYPE = 2;
39 int const VideoContentProperty::VIDEO_CROP = 3;
40 int const VideoContentProperty::VIDEO_SCALE = 4;
41 int const VideoContentProperty::COLOUR_CONVERSION = 5;
44 using std::stringstream;
45 using std::setprecision;
48 using boost::shared_ptr;
49 using boost::optional;
50 using boost::dynamic_pointer_cast;
51 using libdcp::raw_convert;
53 vector<VideoContentScale> VideoContentScale::_scales;
55 VideoContent::VideoContent (shared_ptr<const Film> f)
58 , _video_frame_rate (0)
59 , _video_frame_type (VIDEO_FRAME_TYPE_2D)
60 , _scale (Ratio::from_id ("185"))
62 setup_default_colour_conversion ();
65 VideoContent::VideoContent (shared_ptr<const Film> f, Time s, VideoContent::Frame len)
68 , _video_frame_rate (0)
69 , _video_frame_type (VIDEO_FRAME_TYPE_2D)
70 , _scale (Ratio::from_id ("185"))
72 setup_default_colour_conversion ();
75 VideoContent::VideoContent (shared_ptr<const Film> f, boost::filesystem::path p)
78 , _video_frame_rate (0)
79 , _video_frame_type (VIDEO_FRAME_TYPE_2D)
80 , _scale (Ratio::from_id ("185"))
82 setup_default_colour_conversion ();
85 VideoContent::VideoContent (shared_ptr<const Film> f, shared_ptr<const cxml::Node> node, int version)
88 _video_length = node->number_child<VideoContent::Frame> ("VideoLength");
89 _video_size.width = node->number_child<int> ("VideoWidth");
90 _video_size.height = node->number_child<int> ("VideoHeight");
91 _video_frame_rate = node->number_child<float> ("VideoFrameRate");
92 _video_frame_type = static_cast<VideoFrameType> (node->number_child<int> ("VideoFrameType"));
93 _crop.left = node->number_child<int> ("LeftCrop");
94 _crop.right = node->number_child<int> ("RightCrop");
95 _crop.top = node->number_child<int> ("TopCrop");
96 _crop.bottom = node->number_child<int> ("BottomCrop");
99 optional<string> r = node->optional_string_child ("Ratio");
101 _scale = VideoContentScale (Ratio::from_id (r.get ()));
104 _scale = VideoContentScale (node->node_child ("Scale"));
107 _colour_conversion = ColourConversion (node->node_child ("ColourConversion"));
110 VideoContent::VideoContent (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
114 shared_ptr<VideoContent> ref = dynamic_pointer_cast<VideoContent> (c[0]);
117 for (size_t i = 0; i < c.size(); ++i) {
118 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (c[i]);
120 if (vc->video_size() != ref->video_size()) {
121 throw JoinError (_("Content to be joined must have the same picture size."));
124 if (vc->video_frame_rate() != ref->video_frame_rate()) {
125 throw JoinError (_("Content to be joined must have the same video frame rate."));
128 if (vc->video_frame_type() != ref->video_frame_type()) {
129 throw JoinError (_("Content to be joined must have the same video frame type."));
132 if (vc->crop() != ref->crop()) {
133 throw JoinError (_("Content to be joined must have the same crop."));
136 if (vc->scale() != ref->scale()) {
137 throw JoinError (_("Content to be joined must have the same scale setting."));
140 if (vc->colour_conversion() != ref->colour_conversion()) {
141 throw JoinError (_("Content to be joined must have the same colour conversion."));
144 _video_length += vc->video_length ();
147 _video_size = ref->video_size ();
148 _video_frame_rate = ref->video_frame_rate ();
149 _video_frame_type = ref->video_frame_type ();
150 _crop = ref->crop ();
151 _scale = ref->scale ();
152 _colour_conversion = ref->colour_conversion ();
156 VideoContent::as_xml (xmlpp::Node* node) const
158 boost::mutex::scoped_lock lm (_mutex);
159 node->add_child("VideoLength")->add_child_text (raw_convert<string> (_video_length));
160 node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_video_size.width));
161 node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_video_size.height));
162 node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
163 node->add_child("VideoFrameType")->add_child_text (raw_convert<string> (static_cast<int> (_video_frame_type)));
165 _scale.as_xml (node->add_child("Scale"));
166 _colour_conversion.as_xml (node->add_child("ColourConversion"));
170 VideoContent::setup_default_colour_conversion ()
172 _colour_conversion = PresetColourConversion (_("sRGB"), 2.4, true, libdcp::colour_matrix::srgb_to_xyz, 2.6).conversion;
176 VideoContent::take_from_video_examiner (shared_ptr<VideoExaminer> d)
178 /* These examiner calls could call other content methods which take a lock on the mutex */
179 libdcp::Size const vs = d->video_size ();
180 float const vfr = d->video_frame_rate ();
183 boost::mutex::scoped_lock lm (_mutex);
185 _video_frame_rate = vfr;
188 signal_changed (VideoContentProperty::VIDEO_SIZE);
189 signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
194 VideoContent::information () const
196 if (video_size().width == 0 || video_size().height == 0) {
202 s << String::compose (
203 _("%1x%2 pixels (%3:1)"),
206 setprecision (3), video_size().ratio ()
213 VideoContent::set_left_crop (int c)
216 boost::mutex::scoped_lock lm (_mutex);
218 if (_crop.left == c) {
225 signal_changed (VideoContentProperty::VIDEO_CROP);
229 VideoContent::set_right_crop (int c)
232 boost::mutex::scoped_lock lm (_mutex);
233 if (_crop.right == c) {
240 signal_changed (VideoContentProperty::VIDEO_CROP);
244 VideoContent::set_top_crop (int c)
247 boost::mutex::scoped_lock lm (_mutex);
248 if (_crop.top == c) {
255 signal_changed (VideoContentProperty::VIDEO_CROP);
259 VideoContent::set_bottom_crop (int c)
262 boost::mutex::scoped_lock lm (_mutex);
263 if (_crop.bottom == c) {
270 signal_changed (VideoContentProperty::VIDEO_CROP);
274 VideoContent::set_scale (VideoContentScale s)
277 boost::mutex::scoped_lock lm (_mutex);
285 signal_changed (VideoContentProperty::VIDEO_SCALE);
288 /** @return string which includes everything about how this content looks */
290 VideoContent::identifier () const
293 s << Content::identifier()
294 << "_" << crop().left
295 << "_" << crop().right
297 << "_" << crop().bottom
298 << "_" << scale().id()
299 << "_" << colour_conversion().identifier ();
305 VideoContent::set_video_frame_type (VideoFrameType t)
308 boost::mutex::scoped_lock lm (_mutex);
309 _video_frame_type = t;
312 signal_changed (VideoContentProperty::VIDEO_FRAME_TYPE);
316 VideoContent::technical_summary () const
318 return String::compose (
319 "video: length %1, size %2x%3, rate %4",
320 video_length_after_3d_combine(), video_size().width, video_size().height, video_frame_rate()
325 VideoContent::video_size_after_3d_split () const
327 libdcp::Size const s = video_size ();
328 switch (video_frame_type ()) {
329 case VIDEO_FRAME_TYPE_2D:
330 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
331 case VIDEO_FRAME_TYPE_3D_LEFT:
332 case VIDEO_FRAME_TYPE_3D_RIGHT:
334 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
335 return libdcp::Size (s.width / 2, s.height);
336 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
337 return libdcp::Size (s.width, s.height / 2);
344 VideoContent::set_colour_conversion (ColourConversion c)
347 boost::mutex::scoped_lock lm (_mutex);
348 _colour_conversion = c;
351 signal_changed (VideoContentProperty::COLOUR_CONVERSION);
354 /** @return Video size after 3D split and crop */
356 VideoContent::video_size_after_crop () const
358 return crop().apply (video_size_after_3d_split ());
361 /** @param t A time offset from the start of this piece of content.
362 * @return Corresponding frame index.
365 VideoContent::time_to_content_video_frames (Time t) const
367 shared_ptr<const Film> film = _film.lock ();
370 FrameRateConversion frc (video_frame_rate(), film->video_frame_rate());
372 /* Here we are converting from time (in the DCP) to a frame number in the content.
373 Hence we need to use the DCP's frame rate and the double/skip correction, not
376 return t * film->video_frame_rate() / (frc.factor() * TIME_HZ);
379 VideoContentScale::VideoContentScale (Ratio const * r)
386 VideoContentScale::VideoContentScale ()
393 VideoContentScale::VideoContentScale (bool scale)
400 VideoContentScale::VideoContentScale (shared_ptr<cxml::Node> node)
404 optional<string> r = node->optional_string_child ("Ratio");
406 _ratio = Ratio::from_id (r.get ());
408 _scale = node->bool_child ("Scale");
413 VideoContentScale::as_xml (xmlpp::Node* node) const
416 node->add_child("Ratio")->add_child_text (_ratio->id ());
418 node->add_child("Scale")->add_child_text (_scale ? "1" : "0");
423 VideoContentScale::id () const
428 s << _ratio->id () << "_";
430 s << (_scale ? "S1" : "S0");
437 VideoContentScale::name () const
440 return _ratio->nickname ();
444 return _("No stretch");
447 return _("No scale");
450 /** @param display_container Size of the container that we are displaying this content in.
451 * @param film_container The size of the film's image.
454 VideoContentScale::size (shared_ptr<const VideoContent> c, libdcp::Size display_container, libdcp::Size film_container) const
457 return fit_ratio_within (_ratio->ratio (), display_container);
460 libdcp::Size const ac = c->video_size_after_crop ();
462 /* Force scale if the film_container is smaller than the content's image */
463 if (_scale || film_container.width < ac.width || film_container.height < ac.height) {
464 return fit_ratio_within (ac.ratio (), display_container);
467 /* Scale the image so that it will be in the right place in film_container, even if display_container is a
470 return libdcp::Size (
471 c->video_size().width * float(display_container.width) / film_container.width,
472 c->video_size().height * float(display_container.height) / film_container.height
477 VideoContentScale::setup_scales ()
479 vector<Ratio const *> ratios = Ratio::all ();
480 for (vector<Ratio const *>::const_iterator i = ratios.begin(); i != ratios.end(); ++i) {
481 _scales.push_back (VideoContentScale (*i));
484 _scales.push_back (VideoContentScale (true));
485 _scales.push_back (VideoContentScale (false));
489 operator== (VideoContentScale const & a, VideoContentScale const & b)
491 return (a.ratio() == b.ratio() && a.scale() == b.scale());
495 operator!= (VideoContentScale const & a, VideoContentScale const & b)
497 return (a.ratio() != b.ratio() || a.scale() != b.scale());