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 <dcp/colour_matrix.h>
23 #include <dcp/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"
33 #include "frame_rate_change.h"
35 #include "safe_stringstream.h"
39 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
41 int const VideoContentProperty::VIDEO_SIZE = 0;
42 int const VideoContentProperty::VIDEO_FRAME_RATE = 1;
43 int const VideoContentProperty::VIDEO_FRAME_TYPE = 2;
44 int const VideoContentProperty::VIDEO_CROP = 3;
45 int const VideoContentProperty::VIDEO_SCALE = 4;
46 int const VideoContentProperty::COLOUR_CONVERSION = 5;
49 using std::setprecision;
54 using boost::shared_ptr;
55 using boost::optional;
56 using boost::dynamic_pointer_cast;
57 using dcp::raw_convert;
59 VideoContent::VideoContent (shared_ptr<const Film> f)
62 , _video_frame_rate (0)
63 , _video_frame_type (VIDEO_FRAME_TYPE_2D)
64 , _scale (Config::instance()->default_scale ())
66 setup_default_colour_conversion ();
69 VideoContent::VideoContent (shared_ptr<const Film> f, DCPTime s, ContentTime len)
72 , _video_frame_rate (0)
73 , _video_frame_type (VIDEO_FRAME_TYPE_2D)
74 , _scale (Config::instance()->default_scale ())
76 setup_default_colour_conversion ();
79 VideoContent::VideoContent (shared_ptr<const Film> f, boost::filesystem::path p)
82 , _video_frame_rate (0)
83 , _video_frame_type (VIDEO_FRAME_TYPE_2D)
84 , _scale (Config::instance()->default_scale ())
86 setup_default_colour_conversion ();
89 VideoContent::VideoContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, int version)
92 _video_size.width = node->number_child<int> ("VideoWidth");
93 _video_size.height = node->number_child<int> ("VideoHeight");
94 _video_frame_rate = node->number_child<float> ("VideoFrameRate");
97 /* DCP-o-matic 1.0 branch */
98 _video_length = ContentTime::from_frames (node->number_child<int64_t> ("VideoLength"), _video_frame_rate);
100 _video_length = ContentTime (node->number_child<ContentTime::Type> ("VideoLength"));
103 _video_frame_type = static_cast<VideoFrameType> (node->number_child<int> ("VideoFrameType"));
104 _crop.left = node->number_child<int> ("LeftCrop");
105 _crop.right = node->number_child<int> ("RightCrop");
106 _crop.top = node->number_child<int> ("TopCrop");
107 _crop.bottom = node->number_child<int> ("BottomCrop");
110 optional<string> r = node->optional_string_child ("Ratio");
112 _scale = VideoContentScale (Ratio::from_id (r.get ()));
115 _scale = VideoContentScale (node->node_child ("Scale"));
118 _colour_conversion = ColourConversion (node->node_child ("ColourConversion"));
121 VideoContent::VideoContent (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
125 shared_ptr<VideoContent> ref = dynamic_pointer_cast<VideoContent> (c[0]);
128 for (size_t i = 0; i < c.size(); ++i) {
129 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (c[i]);
131 if (vc->video_size() != ref->video_size()) {
132 throw JoinError (_("Content to be joined must have the same picture size."));
135 if (vc->video_frame_rate() != ref->video_frame_rate()) {
136 throw JoinError (_("Content to be joined must have the same video frame rate."));
139 if (vc->video_frame_type() != ref->video_frame_type()) {
140 throw JoinError (_("Content to be joined must have the same video frame type."));
143 if (vc->crop() != ref->crop()) {
144 throw JoinError (_("Content to be joined must have the same crop."));
147 if (vc->scale() != ref->scale()) {
148 throw JoinError (_("Content to be joined must have the same scale setting."));
151 if (vc->colour_conversion() != ref->colour_conversion()) {
152 throw JoinError (_("Content to be joined must have the same colour conversion."));
155 _video_length += vc->video_length ();
158 _video_size = ref->video_size ();
159 _video_frame_rate = ref->video_frame_rate ();
160 _video_frame_type = ref->video_frame_type ();
161 _crop = ref->crop ();
162 _scale = ref->scale ();
163 _colour_conversion = ref->colour_conversion ();
167 VideoContent::as_xml (xmlpp::Node* node) const
169 boost::mutex::scoped_lock lm (_mutex);
170 node->add_child("VideoLength")->add_child_text (raw_convert<string> (_video_length.get ()));
171 node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_video_size.width));
172 node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_video_size.height));
173 node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
174 node->add_child("VideoFrameType")->add_child_text (raw_convert<string> (static_cast<int> (_video_frame_type)));
176 _scale.as_xml (node->add_child("Scale"));
177 _colour_conversion.as_xml (node->add_child("ColourConversion"));
181 VideoContent::setup_default_colour_conversion ()
183 _colour_conversion = PresetColourConversion (_("sRGB"), 2.4, true, dcp::colour_matrix::srgb_to_xyz, 2.6).conversion;
187 VideoContent::take_from_video_examiner (shared_ptr<VideoExaminer> d)
189 /* These examiner calls could call other content methods which take a lock on the mutex */
190 dcp::Size const vs = d->video_size ();
191 float const vfr = d->video_frame_rate ();
192 ContentTime vl = d->video_length ();
195 boost::mutex::scoped_lock lm (_mutex);
197 _video_frame_rate = vfr;
201 shared_ptr<const Film> film = _film.lock ();
203 LOG_GENERAL ("Video length obtained from header as %1 frames", _video_length.frames (_video_frame_rate));
205 signal_changed (VideoContentProperty::VIDEO_SIZE);
206 signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
207 signal_changed (ContentProperty::LENGTH);
212 VideoContent::information () const
214 if (video_size().width == 0 || video_size().height == 0) {
220 s << String::compose (
221 _("%1x%2 pixels (%3:1)"),
224 setprecision (3), video_size().ratio ()
231 VideoContent::set_left_crop (int c)
234 boost::mutex::scoped_lock lm (_mutex);
236 if (_crop.left == c) {
243 signal_changed (VideoContentProperty::VIDEO_CROP);
247 VideoContent::set_right_crop (int c)
250 boost::mutex::scoped_lock lm (_mutex);
251 if (_crop.right == c) {
258 signal_changed (VideoContentProperty::VIDEO_CROP);
262 VideoContent::set_top_crop (int c)
265 boost::mutex::scoped_lock lm (_mutex);
266 if (_crop.top == c) {
273 signal_changed (VideoContentProperty::VIDEO_CROP);
277 VideoContent::set_bottom_crop (int c)
280 boost::mutex::scoped_lock lm (_mutex);
281 if (_crop.bottom == c) {
288 signal_changed (VideoContentProperty::VIDEO_CROP);
292 VideoContent::set_scale (VideoContentScale s)
295 boost::mutex::scoped_lock lm (_mutex);
303 signal_changed (VideoContentProperty::VIDEO_SCALE);
306 /** @return string which includes everything about how this content looks */
308 VideoContent::identifier () const
311 s << Content::identifier()
312 << "_" << crop().left
313 << "_" << crop().right
315 << "_" << crop().bottom
316 << "_" << scale().id()
317 << "_" << colour_conversion().identifier ();
323 VideoContent::set_video_frame_type (VideoFrameType t)
326 boost::mutex::scoped_lock lm (_mutex);
327 _video_frame_type = t;
330 signal_changed (VideoContentProperty::VIDEO_FRAME_TYPE);
334 VideoContent::technical_summary () const
336 return String::compose (
337 "video: length %1, size %2x%3, rate %4",
338 video_length_after_3d_combine().seconds(),
346 VideoContent::video_size_after_3d_split () const
348 dcp::Size const s = video_size ();
349 switch (video_frame_type ()) {
350 case VIDEO_FRAME_TYPE_2D:
351 case VIDEO_FRAME_TYPE_3D_ALTERNATE:
352 case VIDEO_FRAME_TYPE_3D_LEFT:
353 case VIDEO_FRAME_TYPE_3D_RIGHT:
355 case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
356 return dcp::Size (s.width / 2, s.height);
357 case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
358 return dcp::Size (s.width, s.height / 2);
365 VideoContent::set_colour_conversion (ColourConversion c)
368 boost::mutex::scoped_lock lm (_mutex);
369 _colour_conversion = c;
372 signal_changed (VideoContentProperty::COLOUR_CONVERSION);
375 /** @return Video size after 3D split and crop */
377 VideoContent::video_size_after_crop () const
379 return crop().apply (video_size_after_3d_split ());
382 /** @param t A time offset from the start of this piece of content.
383 * @return Corresponding time with respect to the content.
386 VideoContent::dcp_time_to_content_time (DCPTime t) const
388 shared_ptr<const Film> film = _film.lock ();
390 return ContentTime (t, FrameRateChange (video_frame_rate(), film->video_frame_rate()));
394 VideoContent::scale_and_crop_to_fit_width ()
396 shared_ptr<const Film> film = _film.lock ();
399 set_scale (VideoContentScale (film->container ()));
401 int const crop = max (0, int (video_size().height - double (film->frame_size().height) * video_size().width / film->frame_size().width));
402 set_top_crop (crop / 2);
403 set_bottom_crop (crop / 2);
407 VideoContent::scale_and_crop_to_fit_height ()
409 shared_ptr<const Film> film = _film.lock ();
412 set_scale (VideoContentScale (film->container ()));
414 int const crop = max (0, int (video_size().width - double (film->frame_size().width) * video_size().height / film->frame_size().height));
415 set_left_crop (crop / 2);
416 set_right_crop (crop / 2);
420 VideoContent::set_video_frame_rate (float r)
423 boost::mutex::scoped_lock lm (_mutex);
424 if (_video_frame_rate == r) {
428 _video_frame_rate = r;
431 signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);