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