C++11 cleanup.
[dcpomatic.git] / src / lib / video_content.cc
1 /*
2     Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
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.
10
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.
15
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/>.
18
19 */
20
21
22 #include "colour_conversion.h"
23 #include "compose.hpp"
24 #include "config.h"
25 #include "content.h"
26 #include "dcpomatic_log.h"
27 #include "exceptions.h"
28 #include "film.h"
29 #include "frame_rate_change.h"
30 #include "log.h"
31 #include "ratio.h"
32 #include "util.h"
33 #include "video_content.h"
34 #include "video_examiner.h"
35 #include <dcp/raw_convert.h>
36 #include <libcxml/cxml.h>
37 #include <libxml++/libxml++.h>
38 #include <iomanip>
39 #include <iostream>
40
41 #include "i18n.h"
42
43
44 int const VideoContentProperty::USE               = 0;
45 int const VideoContentProperty::SIZE              = 1;
46 int const VideoContentProperty::FRAME_TYPE        = 2;
47 int const VideoContentProperty::CROP              = 3;
48 int const VideoContentProperty::COLOUR_CONVERSION = 4;
49 int const VideoContentProperty::FADE_IN           = 5;
50 int const VideoContentProperty::FADE_OUT          = 6;
51 int const VideoContentProperty::RANGE             = 7;
52 int const VideoContentProperty::CUSTOM_RATIO      = 8;
53 int const VideoContentProperty::CUSTOM_SIZE       = 9;
54 int const VideoContentProperty::BURNT_SUBTITLE_LANGUAGE = 10;
55
56
57 using std::cout;
58 using std::dynamic_pointer_cast;
59 using std::fixed;
60 using std::list;
61 using std::make_shared;
62 using std::max;
63 using std::min;
64 using std::pair;
65 using std::setprecision;
66 using std::setprecision;
67 using std::shared_ptr;
68 using std::string;
69 using std::vector;
70 using boost::optional;
71 using dcp::raw_convert;
72 using namespace dcpomatic;
73
74
75 VideoContent::VideoContent (Content* parent)
76         : ContentPart (parent)
77         , _use (true)
78         , _length (0)
79         , _frame_type (VideoFrameType::TWO_D)
80         , _yuv (true)
81         , _fade_in (0)
82         , _fade_out (0)
83         , _range (VideoRange::FULL)
84 {
85
86 }
87
88
89 shared_ptr<VideoContent>
90 VideoContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
91 {
92         if (!node->optional_number_child<int> ("VideoWidth")) {
93                 return {};
94         }
95
96         return make_shared<VideoContent>(parent, node, version);
97 }
98
99
100 VideoContent::VideoContent (Content* parent, cxml::ConstNodePtr node, int version)
101         : ContentPart (parent)
102 {
103         _size.width = node->number_child<int> ("VideoWidth");
104         _size.height = node->number_child<int> ("VideoHeight");
105
106         /* Backwards compatibility */
107         auto r = node->optional_number_child<double>("VideoFrameRate");
108         if (r) {
109                 _parent->set_video_frame_rate (r.get ());
110         }
111
112         _use = node->optional_bool_child("Use").get_value_or(true);
113         _length = node->number_child<Frame> ("VideoLength");
114
115         if (version <= 34) {
116                 /* Snapshot of the VideoFrameType enum at version 34 */
117                 switch (node->number_child<int> ("VideoFrameType")) {
118                 case 0:
119                         _frame_type = VideoFrameType::TWO_D;
120                         break;
121                 case 1:
122                         _frame_type = VideoFrameType::THREE_D_LEFT_RIGHT;
123                         break;
124                 case 2:
125                         _frame_type = VideoFrameType::THREE_D_TOP_BOTTOM;
126                         break;
127                 case 3:
128                         _frame_type = VideoFrameType::THREE_D_ALTERNATE;
129                         break;
130                 case 4:
131                         _frame_type = VideoFrameType::THREE_D_LEFT;
132                         break;
133                 case 5:
134                         _frame_type = VideoFrameType::THREE_D_RIGHT;
135                         break;
136                 }
137         } else {
138                 _frame_type = string_to_video_frame_type (node->string_child ("VideoFrameType"));
139         }
140
141         _sample_aspect_ratio = node->optional_number_child<double> ("SampleAspectRatio");
142         _crop.left = node->number_child<int> ("LeftCrop");
143         _crop.right = node->number_child<int> ("RightCrop");
144         _crop.top = node->number_child<int> ("TopCrop");
145         _crop.bottom = node->number_child<int> ("BottomCrop");
146
147         if (version <= 7) {
148                 auto r = node->optional_string_child ("Ratio");
149                 if (r) {
150                         _legacy_ratio = Ratio::from_id(r.get())->ratio();
151                 }
152         } else if (version <= 37) {
153                 auto ratio = node->node_child("Scale")->optional_string_child("Ratio");
154                 if (ratio) {
155                         _legacy_ratio = Ratio::from_id(ratio.get())->ratio();
156                 }
157                 auto scale = node->node_child("Scale")->optional_bool_child("Scale");
158                 if (scale) {
159                         if (*scale) {
160                                 /* This is what we used to call "no stretch" */
161                                 _legacy_ratio = _size.ratio();
162                         } else {
163                                 /* This is what we used to call "no scale" */
164                                 _custom_size = _size;
165                         }
166                 }
167
168         } else {
169                 _custom_ratio = node->optional_number_child<float>("CustomRatio");
170                 if (node->optional_number_child<int>("CustomWidth")) {
171                         _custom_size = dcp::Size (node->number_child<int>("CustomWidth"), node->number_child<int>("CustomHeight"));
172                 }
173         }
174
175         if (node->optional_node_child ("ColourConversion")) {
176                 _colour_conversion = ColourConversion (node->node_child ("ColourConversion"), version);
177         }
178
179         _yuv = node->optional_bool_child("YUV").get_value_or (true);
180
181         if (version >= 32) {
182                 _fade_in = node->optional_number_child<Frame>("VideoFadeIn").get_value_or(node->number_child<Frame>("FadeIn"));
183                 _fade_out = node->optional_number_child<Frame>("VideoFadeOut").get_value_or(node->number_child<Frame>("FadeOut"));
184         } else {
185                 _fade_in = _fade_out = 0;
186         }
187
188         _range = VideoRange::FULL;
189         if (node->optional_string_child("Range").get_value_or("full") == "video") {
190                 _range = VideoRange::VIDEO;
191         }
192
193         if (auto pixel_quanta = node->optional_node_child("PixelQuanta")) {
194                 _pixel_quanta = PixelQuanta(pixel_quanta);
195         }
196
197         auto burnt = node->optional_string_child("BurntSubtitleLanguage");
198         if (burnt) {
199                 _burnt_subtitle_language = dcp::LanguageTag (*burnt);
200         }
201
202 }
203
204
205 VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content>> c)
206         : ContentPart (parent)
207         , _length (0)
208         , _yuv (false)
209 {
210         auto ref = c[0]->video;
211         DCPOMATIC_ASSERT (ref);
212
213         for (size_t i = 1; i < c.size(); ++i) {
214
215                 if (c[i]->video->use() != ref->use()) {
216                         throw JoinError (_("Content to be joined must have all its video used or not used."));
217                 }
218
219                 if (c[i]->video->size() != ref->size()) {
220                         throw JoinError (_("Content to be joined must have the same picture size."));
221                 }
222
223                 if (c[i]->video->frame_type() != ref->frame_type()) {
224                         throw JoinError (_("Content to be joined must have the same video frame type."));
225                 }
226
227                 if (c[i]->video->requested_crop() != ref->requested_crop()) {
228                         throw JoinError (_("Content to be joined must have the same crop."));
229                 }
230
231                 if (c[i]->video->custom_ratio() != ref->custom_ratio()) {
232                         throw JoinError (_("Content to be joined must have the same custom ratio setting."));
233                 }
234
235                 if (c[i]->video->custom_size() != ref->custom_size()) {
236                         throw JoinError (_("Content to be joined must have the same custom size setting."));
237                 }
238
239                 if (c[i]->video->colour_conversion() != ref->colour_conversion()) {
240                         throw JoinError (_("Content to be joined must have the same colour conversion."));
241                 }
242
243                 if (c[i]->video->fade_in() != ref->fade_in() || c[i]->video->fade_out() != ref->fade_out()) {
244                         throw JoinError (_("Content to be joined must have the same fades."));
245                 }
246
247                 if (c[i]->video->burnt_subtitle_language() != ref->burnt_subtitle_language()) {
248                         throw JoinError (_("Content to be joined must have the same burnt subtitle language."));
249                 }
250
251                 _length += c[i]->video->length ();
252
253                 if (c[i]->video->yuv ()) {
254                         _yuv = true;
255                 }
256
257                 _pixel_quanta = max(_pixel_quanta, c[i]->video->_pixel_quanta);
258         }
259
260         _use = ref->use ();
261         _size = ref->size ();
262         _frame_type = ref->frame_type ();
263         _crop = ref->requested_crop ();
264         _custom_ratio = ref->custom_ratio ();
265         _colour_conversion = ref->colour_conversion ();
266         _fade_in = ref->fade_in ();
267         _fade_out = ref->fade_out ();
268         _range = ref->range ();
269         _burnt_subtitle_language = ref->burnt_subtitle_language ();
270 }
271
272
273 void
274 VideoContent::as_xml (xmlpp::Node* node) const
275 {
276         boost::mutex::scoped_lock lm (_mutex);
277         node->add_child("Use")->add_child_text (_use ? "1" : "0");
278         node->add_child("VideoLength")->add_child_text (raw_convert<string> (_length));
279         node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_size.width));
280         node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_size.height));
281         node->add_child("VideoFrameType")->add_child_text (video_frame_type_to_string (_frame_type));
282         if (_sample_aspect_ratio) {
283                 node->add_child("SampleAspectRatio")->add_child_text (raw_convert<string> (_sample_aspect_ratio.get ()));
284         }
285         _crop.as_xml (node);
286         if (_custom_ratio) {
287                 node->add_child("CustomRatio")->add_child_text(raw_convert<string>(*_custom_ratio));
288         }
289         if (_custom_size) {
290                 node->add_child("CustomWidth")->add_child_text(raw_convert<string>(_custom_size->width));
291                 node->add_child("CustomHeight")->add_child_text(raw_convert<string>(_custom_size->height));
292         }
293         if (_colour_conversion) {
294                 _colour_conversion.get().as_xml (node->add_child("ColourConversion"));
295         }
296         node->add_child("YUV")->add_child_text (_yuv ? "1" : "0");
297         node->add_child("VideoFadeIn")->add_child_text(raw_convert<string>(_fade_in));
298         node->add_child("VideoFadeOut")->add_child_text(raw_convert<string>(_fade_out));
299         node->add_child("Range")->add_child_text(_range == VideoRange::FULL ? "full" : "video");
300         _pixel_quanta.as_xml(node->add_child("PixelQuanta"));
301         if (_burnt_subtitle_language) {
302                 node->add_child("BurntSubtitleLanguage")->add_child_text(_burnt_subtitle_language->to_string());
303         }
304 }
305
306
307 void
308 VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
309 {
310         /* These examiner calls could call other content methods which take a lock on the mutex */
311         auto const vs = d->video_size ();
312         auto vl = d->video_length ();
313         auto const ar = d->sample_aspect_ratio ();
314         auto const yuv = d->yuv ();
315         auto const range = d->range ();
316         auto const pixel_quanta = d->pixel_quanta ();
317
318         ContentChangeSignaller cc1 (_parent, VideoContentProperty::SIZE);
319         ContentChangeSignaller cc2 (_parent, ContentProperty::LENGTH);
320         ContentChangeSignaller cc3 (_parent, VideoContentProperty::RANGE);
321
322         {
323                 boost::mutex::scoped_lock lm (_mutex);
324                 _size = vs;
325                 _length = vl;
326                 _sample_aspect_ratio = ar;
327                 _yuv = yuv;
328                 _range = range;
329                 _pixel_quanta = pixel_quanta;
330         }
331
332         LOG_GENERAL ("Video length obtained from header as %1 frames", _length);
333
334         if (d->video_frame_rate()) {
335                 _parent->set_video_frame_rate (d->video_frame_rate().get());
336         }
337 }
338
339
340 /** @return string which includes everything about how this content looks */
341 string
342 VideoContent::identifier () const
343 {
344         char buffer[256];
345         auto const crop = actual_crop();
346         snprintf (
347                 buffer, sizeof(buffer), "%d_%d_%d_%d_%d_%f_%d_%d%" PRId64 "_%" PRId64 "_%d",
348                 (_use ? 1 : 0),
349                 crop.left,
350                 crop.right,
351                 crop.top,
352                 crop.bottom,
353                 _custom_ratio.get_value_or(0),
354                 _custom_size ? _custom_size->width : 0,
355                 _custom_size ? _custom_size->height : 0,
356                 _fade_in,
357                 _fade_out,
358                 _range == VideoRange::FULL ? 0 : 1
359                 );
360
361         string s (buffer);
362
363         if (colour_conversion()) {
364                 s += "_" + colour_conversion().get().identifier ();
365         }
366
367         return s;
368 }
369
370
371 string
372 VideoContent::technical_summary () const
373 {
374         string s = String::compose (
375                 N_("video: length %1 frames, size %2x%3"),
376                 length_after_3d_combine(),
377                 size().width,
378                 size().height
379                 );
380
381         if (sample_aspect_ratio ()) {
382                 s += String::compose (N_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
383         }
384
385         return s;
386 }
387
388
389 dcp::Size
390 VideoContent::size_after_3d_split () const
391 {
392         auto const s = size ();
393         switch (frame_type ()) {
394         case VideoFrameType::TWO_D:
395         case VideoFrameType::THREE_D:
396         case VideoFrameType::THREE_D_ALTERNATE:
397         case VideoFrameType::THREE_D_LEFT:
398         case VideoFrameType::THREE_D_RIGHT:
399                 return s;
400         case VideoFrameType::THREE_D_LEFT_RIGHT:
401                 return dcp::Size (s.width / 2, s.height);
402         case VideoFrameType::THREE_D_TOP_BOTTOM:
403                 return dcp::Size (s.width, s.height / 2);
404         }
405
406         DCPOMATIC_ASSERT (false);
407 }
408
409
410 /** @return Video size after 3D split and crop */
411 dcp::Size
412 VideoContent::size_after_crop () const
413 {
414         return actual_crop().apply(size_after_3d_split());
415 }
416
417
418 /** @param f Frame index within the whole (untrimmed) content.
419  *  @return Fade factor (between 0 and 1) or unset if there is no fade.
420  */
421 optional<double>
422 VideoContent::fade (shared_ptr<const Film> film, Frame f) const
423 {
424         DCPOMATIC_ASSERT (f >= 0);
425
426         double const vfr = _parent->active_video_frame_rate(film);
427
428         auto const ts = _parent->trim_start().frames_round(vfr);
429         if ((f - ts) < fade_in()) {
430                 return double (f - ts) / fade_in();
431         }
432
433         auto fade_out_start = length() - _parent->trim_end().frames_round(vfr) - fade_out();
434         if (f >= fade_out_start) {
435                 return 1 - double (f - fade_out_start) / fade_out();
436         }
437
438         return {};
439 }
440
441
442 string
443 VideoContent::processing_description (shared_ptr<const Film> film)
444 {
445         string d;
446         char buffer[256];
447
448         if (size().width && size().height) {
449                 d += String::compose (
450                         _("Content video is %1x%2"),
451                         size_after_3d_split().width,
452                         size_after_3d_split().height
453                         );
454
455
456                 double ratio = size_after_3d_split().ratio ();
457
458                 if (sample_aspect_ratio ()) {
459                         snprintf (buffer, sizeof(buffer), _(", pixel aspect ratio %.2f:1"), sample_aspect_ratio().get());
460                         d += buffer;
461                         ratio *= sample_aspect_ratio().get ();
462                 }
463
464                 snprintf (buffer, sizeof(buffer), _("\nDisplay aspect ratio %.2f:1"), ratio);
465                 d += buffer;
466         }
467
468         auto const crop = actual_crop();
469
470         if ((crop.left || crop.right || crop.top || crop.bottom) && size() != dcp::Size(0, 0)) {
471                 auto const cropped = size_after_crop ();
472                 d += String::compose (
473                         _("\nCropped to %1x%2"),
474                         cropped.width, cropped.height
475                         );
476
477                 snprintf (buffer, sizeof(buffer), " (%.2f:1)", cropped.ratio());
478                 d += buffer;
479         }
480
481         auto const container_size = film->frame_size ();
482         auto const scaled = scaled_size (container_size);
483
484         if (scaled != size_after_crop ()) {
485                 d += String::compose (
486                         _("\nScaled to %1x%2"),
487                         scaled.width, scaled.height
488                         );
489
490                 snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), scaled.ratio());
491                 d += buffer;
492         }
493
494         if (scaled != container_size) {
495                 d += String::compose (
496                         _("\nPadded with black to fit container %1 (%2x%3)"),
497                         film->container()->container_nickname (),
498                         container_size.width, container_size.height
499                         );
500
501                 snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), container_size.ratio());
502                 d += buffer;
503         }
504
505         if (_parent->video_frame_rate()) {
506                 double const vfr = _parent->video_frame_rate().get ();
507
508                 snprintf (buffer, sizeof(buffer), _("\nContent frame rate %.4f\n"), vfr);
509                 d += buffer;
510
511                 FrameRateChange frc (vfr, film->video_frame_rate ());
512                 d += frc.description ();
513         }
514
515         return d;
516 }
517
518
519 void
520 VideoContent::add_properties (list<UserProperty>& p) const
521 {
522         p.push_back (UserProperty (UserProperty::VIDEO, _("Length"), length (), _("video frames")));
523         p.push_back (UserProperty (UserProperty::VIDEO, _("Size"), String::compose ("%1x%2", size().width, size().height)));
524 }
525
526
527 void
528 VideoContent::set_length (Frame len)
529 {
530         maybe_set (_length, len, ContentProperty::LENGTH);
531 }
532
533
534 void
535 VideoContent::set_crop (Crop c)
536 {
537         maybe_set (_crop, c, VideoContentProperty::CROP);
538 }
539
540 void
541 VideoContent::set_left_crop (int c)
542 {
543         maybe_set (_crop.left, c, VideoContentProperty::CROP);
544 }
545
546
547 void
548 VideoContent::set_right_crop (int c)
549 {
550         maybe_set (_crop.right, c, VideoContentProperty::CROP);
551 }
552
553
554 void
555 VideoContent::set_top_crop (int c)
556 {
557         maybe_set (_crop.top, c, VideoContentProperty::CROP);
558 }
559
560
561 void
562 VideoContent::set_bottom_crop (int c)
563 {
564         maybe_set (_crop.bottom, c, VideoContentProperty::CROP);
565 }
566
567
568 void
569 VideoContent::set_frame_type (VideoFrameType t)
570 {
571         maybe_set (_frame_type, t, VideoContentProperty::FRAME_TYPE);
572 }
573
574
575 void
576 VideoContent::unset_colour_conversion ()
577 {
578         maybe_set (_colour_conversion, boost::optional<ColourConversion> (), VideoContentProperty::COLOUR_CONVERSION);
579 }
580
581
582 void
583 VideoContent::set_colour_conversion (ColourConversion c)
584 {
585         maybe_set (_colour_conversion, c, VideoContentProperty::COLOUR_CONVERSION);
586 }
587
588
589 void
590 VideoContent::set_fade_in (Frame t)
591 {
592         maybe_set (_fade_in, t, VideoContentProperty::FADE_IN);
593 }
594
595
596 void
597 VideoContent::set_fade_out (Frame t)
598 {
599         maybe_set (_fade_out, t, VideoContentProperty::FADE_OUT);
600 }
601
602
603 void
604 VideoContent::set_range (VideoRange r)
605 {
606         maybe_set (_range, r, VideoContentProperty::RANGE);
607 }
608
609
610 void
611 VideoContent::set_use (bool u)
612 {
613         maybe_set (_use, u, VideoContentProperty::USE);
614 }
615
616
617 void
618 VideoContent::set_burnt_subtitle_language (boost::optional<dcp::LanguageTag> language)
619 {
620         maybe_set (_burnt_subtitle_language, language, VideoContentProperty::BURNT_SUBTITLE_LANGUAGE);
621 }
622
623
624 void
625 VideoContent::take_settings_from (shared_ptr<const VideoContent> c)
626 {
627         if (c->_colour_conversion) {
628                 set_colour_conversion (c->_colour_conversion.get());
629         } else {
630                 unset_colour_conversion ();
631         }
632         set_use (c->_use);
633         set_frame_type (c->_frame_type);
634         set_left_crop (c->_crop.left);
635         set_right_crop (c->_crop.right);
636         set_top_crop (c->_crop.top);
637         set_bottom_crop (c->_crop.bottom);
638         set_custom_ratio (c->_custom_ratio);
639         set_custom_size (c->_custom_size);
640         set_fade_in (c->_fade_in);
641         set_fade_out (c->_fade_out);
642         set_burnt_subtitle_language (c->_burnt_subtitle_language);
643 }
644
645
646 void
647 VideoContent::modify_position (shared_ptr<const Film> film, DCPTime& pos) const
648 {
649         pos = pos.round (film->video_frame_rate());
650 }
651
652
653 void
654 VideoContent::modify_trim_start (ContentTime& trim) const
655 {
656         if (_parent->video_frame_rate()) {
657                 trim = trim.round (_parent->video_frame_rate().get());
658         }
659 }
660
661
662 /** @param film_container The size of the container for the DCP that we are working on */
663 dcp::Size
664 VideoContent::scaled_size (dcp::Size film_container)
665 {
666         if (_custom_ratio) {
667                 return fit_ratio_within(*_custom_ratio, film_container);
668         }
669
670         if (_custom_size) {
671                 return *_custom_size;
672         }
673
674         auto size = size_after_crop ();
675         size.width *= _sample_aspect_ratio.get_value_or(1);
676
677         /* This is what we will return unless there is any legacy stuff to take into account */
678         auto auto_size = fit_ratio_within (size.ratio(), film_container);
679
680         if (_legacy_ratio) {
681                 if (fit_ratio_within(*_legacy_ratio, film_container) != auto_size) {
682                         _custom_ratio = *_legacy_ratio;
683                         _legacy_ratio = optional<float>();
684                         return fit_ratio_within(*_custom_ratio, film_container);
685                 }
686                 _legacy_ratio = boost::optional<float>();
687         }
688
689         return _pixel_quanta.round (auto_size);
690 }
691
692
693 void
694 VideoContent::set_custom_ratio (optional<float> ratio)
695 {
696         maybe_set (_custom_ratio, ratio, VideoContentProperty::CUSTOM_RATIO);
697 }
698
699
700 void
701 VideoContent::set_custom_size (optional<dcp::Size> size)
702 {
703         maybe_set (_custom_size, size, VideoContentProperty::CUSTOM_SIZE);
704 }
705
706
707 Crop
708 VideoContent::actual_crop () const
709 {
710         return Crop(
711                 _pixel_quanta.round_x(_crop.left),
712                 _pixel_quanta.round_x(_crop.right),
713                 _pixel_quanta.round_y(_crop.top),
714                 _pixel_quanta.round_y(_crop.bottom)
715         );
716 }
717