Add dcpomatic2_map tool (#2445).
[dcpomatic.git] / test / test.cc
1 /*
2     Copyright (C) 2012-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
23 /** @file  test/test.cc
24  *  @brief Overall test stuff and useful methods for tests.
25  */
26
27
28 #include "lib/compose.hpp"
29 #include "lib/config.h"
30 #include "lib/cross.h"
31 #include "lib/dcp_content_type.h"
32 #include "lib/dcpomatic_log.h"
33 #include "lib/encode_server_finder.h"
34 #include "lib/ffmpeg_image_proxy.h"
35 #include "lib/file_log.h"
36 #include "lib/film.h"
37 #include "lib/image.h"
38 #include "lib/job.h"
39 #include "lib/job_manager.h"
40 #include "lib/log_entry.h"
41 #include "lib/make_dcp.h"
42 #include "lib/ratio.h"
43 #include "lib/signal_manager.h"
44 #include "lib/util.h"
45 #include "test.h"
46 #include <dcp/cpl.h>
47 #include <dcp/dcp.h>
48 #include <dcp/mono_picture_asset.h>
49 #include <dcp/mono_picture_frame.h>
50 #include <dcp/openjpeg_image.h>
51 #include <dcp/reel.h>
52 #include <dcp/reel_picture_asset.h>
53 #include <dcp/warnings.h>
54 #include <asdcp/AS_DCP.h>
55 #include <png.h>
56 #include <sndfile.h>
57 #include <libxml++/libxml++.h>
58 extern "C" {
59 #include <libavformat/avformat.h>
60 }
61 #define BOOST_TEST_DYN_LINK
62 #define BOOST_TEST_MODULE dcpomatic_test
63 #include <boost/algorithm/string.hpp>
64 LIBDCP_DISABLE_WARNINGS
65 #include <boost/random.hpp>
66 LIBDCP_ENABLE_WARNINGS
67 #include <boost/test/unit_test.hpp>
68 #include <iostream>
69 #include <list>
70 #include <vector>
71
72
73 using std::abs;
74 using std::cerr;
75 using std::cout;
76 using std::list;
77 using std::make_shared;
78 using std::min;
79 using std::shared_ptr;
80 using std::string;
81 using std::vector;
82 using boost::scoped_array;
83 using std::dynamic_pointer_cast;
84 #if BOOST_VERSION >= 106100
85 using namespace boost::placeholders;
86 #endif
87
88
89 boost::filesystem::path
90 TestPaths::TestPaths::private_data ()
91 {
92         char* env = getenv("DCPOMATIC_TEST_PRIVATE");
93         if (env) {
94                 return boost::filesystem::path(env);
95         }
96
97         auto relative = boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private");
98         if (!boost::filesystem::exists(relative)) {
99                 std::cerr << "No private test data found! Tests may fail.\n";
100                 return relative;
101         }
102
103         return boost::filesystem::canonical(relative);
104 }
105
106
107 boost::filesystem::path TestPaths::xsd ()
108 {
109         return boost::filesystem::canonical(boost::filesystem::path("..") / boost::filesystem::path("libdcp") / boost::filesystem::path("xsd"));
110 }
111
112
113 static void
114 setup_test_config ()
115 {
116         Config::instance()->set_master_encoding_threads (boost::thread::hardware_concurrency() / 2);
117         Config::instance()->set_server_encoding_threads (1);
118         Config::instance()->set_server_port_base (61921);
119         Config::instance()->set_default_dcp_content_type (static_cast<DCPContentType*> (0));
120         Config::instance()->set_default_audio_delay (0);
121         Config::instance()->set_default_j2k_bandwidth (100000000);
122         Config::instance()->set_default_interop (false);
123         Config::instance()->set_default_still_length (10);
124         Config::instance()->set_log_types (
125                 LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING |
126                 LogEntry::TYPE_ERROR | LogEntry::TYPE_DISK
127                 );
128         Config::instance()->set_automatic_audio_analysis (false);
129         auto signer = make_shared<dcp::CertificateChain>(dcp::file_to_string("test/data/signer_chain"));
130         signer->set_key(dcp::file_to_string("test/data/signer_key"));
131         Config::instance()->set_signer_chain (signer);
132         auto decryption = make_shared<dcp::CertificateChain>(dcp::file_to_string("test/data/decryption_chain"));
133         decryption->set_key(dcp::file_to_string("test/data/decryption_key"));
134         Config::instance()->set_decryption_chain (decryption);
135         Config::instance()->set_dcp_asset_filename_format(dcp::NameFormat("%t"));
136 }
137
138
139 class TestSignalManager : public SignalManager
140 {
141 public:
142         /* No wakes in tests: we call ui_idle ourselves */
143         void wake_ui () override
144         {
145
146         }
147 };
148
149 struct TestConfig
150 {
151         TestConfig ()
152         {
153                 State::override_path = "build/test/state";
154                 boost::filesystem::remove_all (*State::override_path);
155
156                 dcpomatic_setup ();
157                 setup_test_config ();
158
159                 EncodeServerFinder::instance()->stop ();
160
161                 signal_manager = new TestSignalManager ();
162
163                 dcpomatic_log.reset (new FileLog("build/test/log"));
164         }
165
166         ~TestConfig ()
167         {
168                 JobManager::drop ();
169         }
170 };
171
172
173 BOOST_GLOBAL_FIXTURE (TestConfig);
174
175
176 boost::filesystem::path
177 test_film_dir (string name)
178 {
179         boost::filesystem::path p;
180         p /= "build";
181         p /= "test";
182         p /= name;
183         return p;
184 }
185
186
187 shared_ptr<Film>
188 new_test_film (string name)
189 {
190         auto p = test_film_dir (name);
191         if (boost::filesystem::exists (p)) {
192                 boost::filesystem::remove_all (p);
193         }
194
195         auto film = make_shared<Film>(p);
196         film->write_metadata ();
197         return film;
198 }
199
200
201 shared_ptr<Film>
202 new_test_film2 (string name, vector<shared_ptr<Content>> content, Cleanup* cleanup)
203 {
204         auto p = test_film_dir (name);
205         if (boost::filesystem::exists (p)) {
206                 boost::filesystem::remove_all (p);
207         }
208         if (cleanup) {
209                 cleanup->add (p);
210         }
211
212         auto film = make_shared<Film>(p);
213         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
214         film->set_container (Ratio::from_id ("185"));
215         film->write_metadata ();
216
217         for (auto i: content) {
218                 film->examine_and_add_content (i);
219                 BOOST_REQUIRE (!wait_for_jobs());
220         }
221
222         return film;
223 }
224
225
226 void
227 check_wav_file (boost::filesystem::path ref, boost::filesystem::path check)
228 {
229         SF_INFO ref_info;
230         ref_info.format = 0;
231         auto ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
232         BOOST_CHECK (ref_file);
233
234         SF_INFO check_info;
235         check_info.format = 0;
236         auto check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
237         BOOST_CHECK (check_file);
238
239         BOOST_CHECK_EQUAL (ref_info.frames, check_info.frames);
240         BOOST_CHECK_EQUAL (ref_info.samplerate, check_info.samplerate);
241         BOOST_CHECK_EQUAL (ref_info.channels, check_info.channels);
242         BOOST_CHECK_EQUAL (ref_info.format, check_info.format);
243
244         /* buffer_size is in frames */
245         sf_count_t const buffer_size = 65536 * ref_info.channels;
246         scoped_array<int32_t> ref_buffer (new int32_t[buffer_size]);
247         scoped_array<int32_t> check_buffer (new int32_t[buffer_size]);
248
249         sf_count_t N = ref_info.frames;
250         while (N) {
251                 sf_count_t this_time = min (buffer_size, N);
252                 sf_count_t r = sf_readf_int (ref_file, ref_buffer.get(), this_time);
253                 BOOST_CHECK_EQUAL (r, this_time);
254                 r = sf_readf_int (check_file, check_buffer.get(), this_time);
255                 BOOST_CHECK_EQUAL (r, this_time);
256
257                 for (sf_count_t i = 0; i < this_time; ++i) {
258                         BOOST_REQUIRE_MESSAGE (
259                                 abs (ref_buffer[i] - check_buffer[i]) <= 65536,
260                                 ref << " differs from " << check << " at " << (ref_info.frames - N + i) << " of " << ref_info.frames
261                                 << "(" << ref_buffer[i] << " vs " << check_buffer[i] << ")"
262                                 );
263                 }
264
265                 N -= this_time;
266         }
267 }
268
269
270 void
271 check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
272 {
273         ASDCP::PCM::MXFReader ref_reader;
274         BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.OpenRead (ref.string().c_str())));
275
276         ASDCP::PCM::AudioDescriptor ref_desc;
277         BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.FillAudioDescriptor (ref_desc)));
278
279         ASDCP::PCM::MXFReader check_reader;
280         BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.OpenRead (check.string().c_str())));
281
282         ASDCP::PCM::AudioDescriptor check_desc;
283         BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.FillAudioDescriptor (check_desc)));
284
285         BOOST_REQUIRE_EQUAL (ref_desc.ContainerDuration, check_desc.ContainerDuration);
286
287         ASDCP::PCM::FrameBuffer ref_buffer (Kumu::Megabyte);
288         ASDCP::PCM::FrameBuffer check_buffer (Kumu::Megabyte);
289         for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
290                 ref_reader.ReadFrame (i, ref_buffer, 0);
291                 check_reader.ReadFrame (i, check_buffer, 0);
292                 BOOST_REQUIRE_MESSAGE(memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size()) == 0, "Audio MXF differs in frame " << i);
293         }
294 }
295
296
297 /** @return true if the files are the same, otherwise false */
298 bool
299 mxf_atmos_files_same (boost::filesystem::path ref, boost::filesystem::path check, bool verbose)
300 {
301         ASDCP::ATMOS::MXFReader ref_reader;
302         BOOST_REQUIRE (!ASDCP_FAILURE(ref_reader.OpenRead(ref.string().c_str())));
303
304         ASDCP::ATMOS::AtmosDescriptor ref_desc;
305         BOOST_REQUIRE (!ASDCP_FAILURE(ref_reader.FillAtmosDescriptor(ref_desc)));
306
307         ASDCP::ATMOS::MXFReader check_reader;
308         BOOST_REQUIRE (!ASDCP_FAILURE(check_reader.OpenRead(check.string().c_str())));
309
310         ASDCP::ATMOS::AtmosDescriptor check_desc;
311         BOOST_REQUIRE (!ASDCP_FAILURE(check_reader.FillAtmosDescriptor(check_desc)));
312
313         if (ref_desc.EditRate.Numerator != check_desc.EditRate.Numerator) {
314                 if (verbose) {
315                         std::cout << "EditRate.Numerator differs.\n";
316                 }
317                 return false;
318         }
319         if (ref_desc.EditRate.Denominator != check_desc.EditRate.Denominator) {
320                 if (verbose) {
321                         std::cout << "EditRate.Denominator differs.\n";
322                 }
323                 return false;
324         }
325         if (ref_desc.ContainerDuration != check_desc.ContainerDuration) {
326                 if (verbose) {
327                         std::cout << "EditRate.ContainerDuration differs.\n";
328                 }
329                 return false;
330         }
331         if (ref_desc.FirstFrame != check_desc.FirstFrame) {
332                 if (verbose) {
333                         std::cout << "EditRate.FirstFrame differs.\n";
334                 }
335                 return false;
336         }
337         if (ref_desc.MaxChannelCount != check_desc.MaxChannelCount) {
338                 if (verbose) {
339                         std::cout << "EditRate.MaxChannelCount differs.\n";
340                 }
341                 return false;
342         }
343         if (ref_desc.MaxObjectCount != check_desc.MaxObjectCount) {
344                 if (verbose) {
345                         std::cout << "EditRate.MaxObjectCount differs.\n";
346                 }
347                 return false;
348         }
349         if (ref_desc.AtmosVersion != check_desc.AtmosVersion) {
350                 if (verbose) {
351                         std::cout << "EditRate.AtmosVersion differs.\n";
352                 }
353                 return false;
354         }
355
356         ASDCP::DCData::FrameBuffer ref_buffer (Kumu::Megabyte);
357         ASDCP::DCData::FrameBuffer check_buffer (Kumu::Megabyte);
358         for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
359                 ref_reader.ReadFrame (i, ref_buffer, 0);
360                 check_reader.ReadFrame (i, check_buffer, 0);
361                 if (memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size())) {
362                         if (verbose) {
363                                 std::cout << "data differs.\n";
364                         }
365                         return false;
366                 }
367         }
368
369         return true;
370 }
371
372
373 static
374 double
375 rms_error (boost::filesystem::path ref, boost::filesystem::path check)
376 {
377         FFmpegImageProxy ref_proxy (ref);
378         auto ref_image = ref_proxy.image(Image::Alignment::COMPACT).image;
379         FFmpegImageProxy check_proxy (check);
380         auto check_image = check_proxy.image(Image::Alignment::COMPACT).image;
381
382         BOOST_REQUIRE_EQUAL (ref_image->planes(), check_image->planes());
383
384         BOOST_REQUIRE_EQUAL (ref_image->pixel_format(), check_image->pixel_format());
385         auto const format = ref_image->pixel_format();
386
387         BOOST_REQUIRE (ref_image->size() == check_image->size());
388         int const width = ref_image->size().width;
389         int const height = ref_image->size().height;
390
391         double sum_square = 0;
392         switch (format) {
393                 case AV_PIX_FMT_RGBA:
394                 {
395                         for (int y = 0; y < height; ++y) {
396                                 uint8_t* p = ref_image->data()[0] + y * ref_image->stride()[0];
397                                 uint8_t* q = check_image->data()[0] + y * check_image->stride()[0];
398                                 for (int x = 0; x < width; ++x) {
399                                         for (int c = 0; c < 4; ++c) {
400                                                 sum_square += pow((*p++ - *q++), 2);
401                                         }
402                                 }
403                         }
404                         break;
405                 }
406                 case AV_PIX_FMT_RGB24:
407                 {
408                         for (int y = 0; y < height; ++y) {
409                                 uint8_t* p = ref_image->data()[0] + y * ref_image->stride()[0];
410                                 uint8_t* q = check_image->data()[0] + y * check_image->stride()[0];
411                                 for (int x = 0; x < width; ++x) {
412                                         for (int c = 0; c < 3; ++c) {
413                                                 sum_square += pow((*p++ - *q++), 2);
414                                         }
415                                 }
416                         }
417                         break;
418                 }
419                 case AV_PIX_FMT_RGB48BE:
420                 {
421                         for (int y = 0; y < height; ++y) {
422                                 uint16_t* p = reinterpret_cast<uint16_t*>(ref_image->data()[0] + y * ref_image->stride()[0]);
423                                 uint16_t* q = reinterpret_cast<uint16_t*>(check_image->data()[0] + y * check_image->stride()[0]);
424                                 for (int x = 0; x < width; ++x) {
425                                         for (int c = 0; c < 3; ++c) {
426                                                 sum_square += pow((*p++ - *q++), 2);
427                                         }
428                                 }
429                         }
430                         break;
431                 }
432                 case AV_PIX_FMT_YUVJ420P:
433                 {
434                         for (int c = 0; c < ref_image->planes(); ++c) {
435                                 for (int y = 0; y < height / ref_image->vertical_factor(c); ++y) {
436                                         auto p = ref_image->data()[c] + y * ref_image->stride()[c];
437                                         auto q = check_image->data()[c] + y * check_image->stride()[c];
438                                         for (int x = 0; x < ref_image->line_size()[c]; ++x) {
439                                                 sum_square += pow((*p++ - *q++), 2);
440                                         }
441                                 }
442                         }
443                         break;
444                 }
445                 default:
446                         BOOST_REQUIRE_MESSAGE (false, "unrecognised pixel format " << format);
447         }
448
449         return sqrt(sum_square / (height * width));
450 }
451
452
453 BOOST_AUTO_TEST_CASE (rms_error_test)
454 {
455         BOOST_CHECK_CLOSE (rms_error("test/data/check_image0.png", "test/data/check_image0.png"), 0, 0.001);
456         BOOST_CHECK_CLOSE (rms_error("test/data/check_image0.png", "test/data/check_image1.png"), 2.2778, 0.001);
457         BOOST_CHECK_CLOSE (rms_error("test/data/check_image0.png", "test/data/check_image2.png"), 59.8896, 0.001);
458         BOOST_CHECK_CLOSE (rms_error("test/data/check_image0.png", "test/data/check_image3.png"), 0.89164, 0.001);
459 }
460
461
462 void
463 check_image (boost::filesystem::path ref, boost::filesystem::path check, double threshold)
464 {
465         double const e = rms_error (ref, check);
466         BOOST_CHECK_MESSAGE (e < threshold, ref << " differs from " << check << " " << e);
467 }
468
469
470 void
471 check_file (boost::filesystem::path ref, boost::filesystem::path check)
472 {
473         auto N = boost::filesystem::file_size (ref);
474         BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
475         dcp::File ref_file(ref, "rb");
476         BOOST_CHECK (ref_file);
477         dcp::File check_file(check, "rb");
478         BOOST_CHECK (check_file);
479
480         int const buffer_size = 65536;
481         std::vector<uint8_t> ref_buffer(buffer_size);
482         std::vector<uint8_t> check_buffer(buffer_size);
483
484         string error = "File " + check.string() + " differs from reference " + ref.string();
485
486         while (N) {
487                 uintmax_t this_time = min (uintmax_t (buffer_size), N);
488                 size_t r = ref_file.read (ref_buffer.data(), 1, this_time);
489                 BOOST_CHECK_EQUAL (r, this_time);
490                 r = check_file.read(check_buffer.data(), 1, this_time);
491                 BOOST_CHECK_EQUAL (r, this_time);
492
493                 BOOST_CHECK_MESSAGE (memcmp (ref_buffer.data(), check_buffer.data(), this_time) == 0, error);
494                 if (memcmp (ref_buffer.data(), check_buffer.data(), this_time)) {
495                         break;
496                 }
497
498                 N -= this_time;
499         }
500 }
501
502
503 void
504 check_text_file (boost::filesystem::path ref, boost::filesystem::path check)
505 {
506         dcp::File ref_file(ref, "r");
507         BOOST_CHECK (ref_file);
508         dcp::File check_file(check, "r");
509         BOOST_CHECK (check_file);
510
511         int const buffer_size = std::max(
512                 boost::filesystem::file_size(ref),
513                 boost::filesystem::file_size(check)
514                 );
515
516         DCPOMATIC_ASSERT (buffer_size < 1024 * 1024);
517
518         std::vector<uint8_t> ref_buffer(buffer_size);
519         auto ref_read = ref_file.read(ref_buffer.data(), 1, buffer_size);
520         std::vector<uint8_t> check_buffer(buffer_size);
521         auto check_read = check_file.read(check_buffer.data(), 1, buffer_size);
522         BOOST_CHECK_EQUAL (ref_read, check_read);
523
524         string const error = "File " + check.string() + " differs from reference " + ref.string();
525         BOOST_CHECK_MESSAGE(memcmp(ref_buffer.data(), check_buffer.data(), ref_read) == 0, error);
526 }
527
528
529 static void
530 note (dcp::NoteType t, string n)
531 {
532         if (t == dcp::NoteType::ERROR) {
533                 cerr << n << "\n";
534         }
535 }
536
537
538 void
539 check_dcp (boost::filesystem::path ref, shared_ptr<const Film> film)
540 {
541         check_dcp (ref, film->dir(film->dcp_name()));
542 }
543
544
545 void
546 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
547 {
548         dcp::DCP ref_dcp (ref);
549         ref_dcp.read ();
550         dcp::DCP check_dcp (check);
551         check_dcp.read ();
552
553         dcp::EqualityOptions options;
554         options.max_mean_pixel_error = 5;
555         options.max_std_dev_pixel_error = 5;
556         options.max_audio_sample_error = 255;
557         options.cpl_annotation_texts_can_differ = true;
558         options.reel_annotation_texts_can_differ = true;
559         options.reel_hashes_can_differ = true;
560         options.issue_dates_can_differ = true;
561         options.max_subtitle_vertical_position_error = 0.001;
562
563         BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
564 }
565
566 void
567 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
568 {
569         BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
570         BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
571
572         if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
573                 return;
574         }
575
576         auto ref_children = ref->get_children ();
577         auto test_children = test->get_children ();
578         BOOST_REQUIRE_MESSAGE (
579                 ref_children.size() == test_children.size(),
580                 ref->get_name() << " has " << ref_children.size() << " or " << test_children.size() << " children"
581                 );
582
583         auto k = ref_children.begin ();
584         auto l = test_children.begin ();
585         while (k != ref_children.end ()) {
586
587                 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
588
589                 auto ref_el = dynamic_cast<xmlpp::Element*>(*k);
590                 auto test_el = dynamic_cast<xmlpp::Element*>(*l);
591                 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
592                 if (ref_el && test_el) {
593                         check_xml (ref_el, test_el, ignore);
594                 }
595
596                 auto ref_cn = dynamic_cast<xmlpp::ContentNode*>(*k);
597                 auto test_cn = dynamic_cast<xmlpp::ContentNode*>(*l);
598                 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
599                 if (ref_cn && test_cn) {
600                         BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
601                 }
602
603                 ++k;
604                 ++l;
605         }
606
607         auto ref_attributes = ref->get_attributes ();
608         auto test_attributes = test->get_attributes ();
609         BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
610
611         auto m = ref_attributes.begin();
612         auto n = test_attributes.begin();
613         while (m != ref_attributes.end ()) {
614                 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
615                 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
616
617                 ++m;
618                 ++n;
619         }
620 }
621
622 void
623 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
624 {
625         auto ref_parser = new xmlpp::DomParser(ref.string());
626         auto ref_root = ref_parser->get_document()->get_root_node();
627         auto test_parser = new xmlpp::DomParser(test.string());
628         auto test_root = test_parser->get_document()->get_root_node();
629
630         check_xml (ref_root, test_root, ignore);
631 }
632
633 bool
634 wait_for_jobs ()
635 {
636         auto jm = JobManager::instance ();
637         while (jm->work_to_do()) {
638                 while (signal_manager->ui_idle()) {}
639                 dcpomatic_sleep_seconds (1);
640         }
641
642         if (jm->errors ()) {
643                 int N = 0;
644                 for (auto i: jm->_jobs) {
645                         if (i->finished_in_error()) {
646                                 ++N;
647                         }
648                 }
649                 cerr << N << " errors.\n";
650
651                 for (auto i: jm->_jobs) {
652                         if (i->finished_in_error()) {
653                                 cerr << i->name() << ":\n"
654                                      << "\tsummary: " << i->error_summary() << "\n"
655                                      << "\tdetails: " << i->error_details() << "\n";
656                         }
657                 }
658         }
659
660         while (signal_manager->ui_idle ()) {}
661
662         if (jm->errors ()) {
663                 JobManager::drop ();
664                 return true;
665         }
666
667         return false;
668 }
669
670
671 class Memory
672 {
673 public:
674         Memory () {}
675
676         ~Memory ()
677         {
678                 free (data);
679         }
680
681         Memory (Memory const&) = delete;
682         Memory& operator= (Memory const&) = delete;
683
684         uint8_t* data = nullptr;
685         size_t size = 0;
686 };
687
688
689 static void
690 png_write_data (png_structp png_ptr, png_bytep data, png_size_t length)
691 {
692         auto mem = reinterpret_cast<Memory*>(png_get_io_ptr(png_ptr));
693         size_t size = mem->size + length;
694
695         if (mem->data) {
696                 mem->data = reinterpret_cast<uint8_t*>(realloc(mem->data, size));
697         } else {
698                 mem->data = reinterpret_cast<uint8_t*>(malloc(size));
699         }
700
701         BOOST_REQUIRE (mem->data);
702
703         memcpy (mem->data + mem->size, data, length);
704         mem->size += length;
705 }
706
707
708 static void
709 png_flush (png_structp)
710 {
711
712 }
713
714
715 static void
716 png_error_fn (png_structp, char const * message)
717 {
718         throw EncodeError (String::compose("Error during PNG write: %1", message));
719 }
720
721
722 void
723 write_image (shared_ptr<const Image> image, boost::filesystem::path file)
724 {
725         int png_color_type = PNG_COLOR_TYPE_RGB;
726         int bits_per_pixel = 0;
727         switch (image->pixel_format()) {
728         case AV_PIX_FMT_RGB24:
729                 bits_per_pixel = 8;
730                 break;
731         case AV_PIX_FMT_XYZ12LE:
732                 bits_per_pixel = 16;
733                 break;
734         default:
735                 BOOST_REQUIRE_MESSAGE (false, "unexpected pixel format " << image->pixel_format());
736         }
737
738         /* error handling? */
739         png_structp png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING, reinterpret_cast<void*>(const_cast<Image*>(image.get())), png_error_fn, 0);
740         BOOST_REQUIRE (png_ptr);
741
742         Memory state;
743
744         png_set_write_fn (png_ptr, &state, png_write_data, png_flush);
745
746         png_infop info_ptr = png_create_info_struct(png_ptr);
747         BOOST_REQUIRE (info_ptr);
748
749         png_set_IHDR (png_ptr, info_ptr, image->size().width, image->size().height, bits_per_pixel, png_color_type, PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);
750
751         auto const width = image->size().width;
752         auto const height = image->size().height;
753         auto const stride = image->stride()[0];
754
755         vector<vector<uint8_t>> data_to_write(height);
756         for (int y = 0; y < height; ++y) {
757                 data_to_write[y].resize(stride);
758         }
759
760         switch (image->pixel_format()) {
761         case AV_PIX_FMT_RGB24:
762                 for (int y = 0; y < height; ++y) {
763                         memcpy(data_to_write[y].data(), image->data()[0] + y * stride, stride);
764                 }
765                 break;
766         case AV_PIX_FMT_XYZ12LE:
767                 /* 16-bit pixel values must be written MSB first */
768                 for (int y = 0; y < height; ++y) {
769                         data_to_write[y].resize(stride);
770                         uint8_t* original = image->data()[0] + y * stride;
771                         for (int x = 0; x < width * 3; ++x) {
772                                 data_to_write[y][x * 2] = original[1];
773                                 data_to_write[y][x * 2 + 1] = original[0];
774                                 original += 2;
775                         }
776                 }
777                 break;
778         default:
779                 break;
780         }
781
782         png_byte ** row_pointers = reinterpret_cast<png_byte**>(png_malloc(png_ptr, image->size().height * sizeof(png_byte *)));
783         for (int y = 0; y < height; ++y) {
784                 row_pointers[y] = reinterpret_cast<png_byte*>(data_to_write[y].data());
785         }
786
787         png_write_info (png_ptr, info_ptr);
788         png_write_image (png_ptr, row_pointers);
789         png_write_end (png_ptr, info_ptr);
790
791         png_destroy_write_struct (&png_ptr, &info_ptr);
792         png_free (png_ptr, row_pointers);
793
794         dcp::ArrayData(state.data, state.size).write(file);
795 }
796
797
798 void
799 check_ffmpeg (boost::filesystem::path ref, boost::filesystem::path check, int audio_tolerance)
800 {
801         int const r = system (String::compose("ffcmp -t %1 %2 %3", audio_tolerance, ref.string(), check.string()).c_str());
802         BOOST_REQUIRE_EQUAL (WEXITSTATUS(r), 0);
803 }
804
805 void
806 check_one_frame (boost::filesystem::path dcp_dir, int64_t index, boost::filesystem::path ref)
807 {
808         dcp::DCP dcp (dcp_dir);
809         dcp.read ();
810         auto asset = dynamic_pointer_cast<dcp::MonoPictureAsset> (dcp.cpls().front()->reels().front()->main_picture()->asset());
811         BOOST_REQUIRE (asset);
812         auto frame = asset->start_read()->get_frame(index);
813         auto ref_frame (new dcp::MonoPictureFrame (ref));
814
815         auto image = frame->xyz_image ();
816         auto ref_image = ref_frame->xyz_image ();
817
818         BOOST_REQUIRE (image->size() == ref_image->size());
819
820         int off = 0;
821         for (int y = 0; y < ref_image->size().height; ++y) {
822                 for (int x = 0; x < ref_image->size().width; ++x) {
823                         BOOST_REQUIRE_EQUAL (ref_image->data(0)[off], image->data(0)[off]);
824                         BOOST_REQUIRE_EQUAL (ref_image->data(1)[off], image->data(1)[off]);
825                         BOOST_REQUIRE_EQUAL (ref_image->data(2)[off], image->data(2)[off]);
826                         ++off;
827                 }
828         }
829 }
830
831 boost::filesystem::path
832 dcp_file (shared_ptr<const Film> film, string prefix)
833 {
834         using namespace boost::filesystem;
835
836         vector<directory_entry> matches;
837         std::copy_if(recursive_directory_iterator(film->dir(film->dcp_name())), recursive_directory_iterator(), std::back_inserter(matches), [&prefix](directory_entry const& entry) {
838                 return boost::algorithm::starts_with(entry.path().leaf().string(), prefix);
839         });
840
841         BOOST_REQUIRE_MESSAGE(matches.size() == 1, "Found " << matches.size() << " files with prefix " << prefix);
842         return matches[0].path();
843 }
844
845 boost::filesystem::path
846 subtitle_file (shared_ptr<Film> film)
847 {
848         for (auto i: boost::filesystem::recursive_directory_iterator(film->directory().get() / film->dcp_name(false))) {
849                 if (boost::algorithm::starts_with(i.path().leaf().string(), "sub_")) {
850                         return i.path();
851                 }
852         }
853
854         BOOST_REQUIRE (false);
855         /* Remove warning */
856         return boost::filesystem::path("/");
857 }
858
859
860 void
861 make_random_file (boost::filesystem::path path, size_t size)
862 {
863         dcp::File random_file(path, "wb");
864         BOOST_REQUIRE (random_file);
865
866         boost::random::mt19937 rng(1);
867         boost::random::uniform_int_distribution<uint64_t> dist(0);
868
869         while (size > 0) {
870                 auto this_time = std::min(size, size_t(8));
871                 uint64_t random = dist(rng);
872                 random_file.write(&random, this_time, 1);
873                 size -= this_time;
874         }
875 }
876
877
878 LogSwitcher::LogSwitcher (shared_ptr<Log> log)
879         : _old (dcpomatic_log)
880 {
881         dcpomatic_log = log;
882 }
883
884
885 LogSwitcher::~LogSwitcher ()
886 {
887         dcpomatic_log = _old;
888 }
889
890 std::ostream&
891 dcp::operator<< (std::ostream& s, dcp::Size i)
892 {
893         s << i.width << "x" << i.height;
894         return s;
895 }
896
897 std::ostream&
898 dcp::operator<< (std::ostream& s, dcp::Standard t)
899 {
900         switch (t) {
901         case Standard::INTEROP:
902                 s << "interop";
903                 break;
904         case Standard::SMPTE:
905                 s << "smpte";
906                 break;
907         }
908         return s;
909 }
910
911 std::ostream&
912 operator<< (std::ostream&s, VideoFrameType f)
913 {
914         s << video_frame_type_to_string(f);
915         return s;
916 }
917
918
919 void
920 Cleanup::add (boost::filesystem::path path)
921 {
922         _paths.push_back (path);
923 }
924
925
926 void
927 Cleanup::run ()
928 {
929         boost::system::error_code ec;
930         for (auto i: _paths) {
931                 boost::filesystem::remove_all (i, ec);
932         }
933 }
934
935
936 void stage (string, boost::optional<boost::filesystem::path>) {}
937 void progress (float) {}
938
939
940 void
941 verify_dcp(boost::filesystem::path dir, vector<dcp::VerificationNote::Code> ignore)
942 {
943         auto notes = dcp::verify({dir}, &stage, &progress, {}, TestPaths::xsd());
944         bool ok = true;
945         for (auto i: notes) {
946                 if (find(ignore.begin(), ignore.end(), i.code()) == ignore.end()) {
947                         std::cout << "\t" << dcp::note_to_string(i) << "\n";
948                         ok = false;
949                 }
950         }
951         BOOST_CHECK(ok);
952 }
953
954
955 void
956 make_and_verify_dcp (shared_ptr<Film> film, vector<dcp::VerificationNote::Code> ignore)
957 {
958         film->write_metadata ();
959         make_dcp (film, TranscodeJob::ChangedBehaviour::IGNORE);
960         BOOST_REQUIRE (!wait_for_jobs());
961         verify_dcp({film->dir(film->dcp_name())}, ignore);
962 }
963
964
965 void
966 check_int_close (int a, int b, int d)
967 {
968         BOOST_CHECK_MESSAGE (std::abs(a - b) < d, a << " differs from " << b << " by more than " << d);
969 }
970
971
972 void
973 check_int_close (std::pair<int, int> a, std::pair<int, int> b, int d)
974 {
975         check_int_close (a.first, b.first, d);
976         check_int_close (a.second, b.second, d);
977 }
978
979
980 ConfigRestorer::~ConfigRestorer()
981 {
982         setup_test_config();
983 }
984
985
986 boost::filesystem::path
987 find_file (boost::filesystem::path dir, string filename_part)
988 {
989         boost::optional<boost::filesystem::path> found;
990         for (auto i: boost::filesystem::directory_iterator(dir)) {
991                 if (i.path().filename().string().find(filename_part) != string::npos) {
992                         BOOST_REQUIRE (!found);
993                         found = i;
994                 }
995         }
996         BOOST_REQUIRE (found);
997         return *found;
998 }
999
1000
1001 Editor::Editor(boost::filesystem::path path)
1002         : _path(path)
1003         , _content(dcp::file_to_string(path))
1004 {
1005
1006 }
1007
1008 Editor::~Editor()
1009 {
1010         auto f = fopen(_path.string().c_str(), "w");
1011         BOOST_REQUIRE(f);
1012         fwrite(_content.c_str(), _content.length(), 1, f);
1013         fclose(f);
1014 }
1015
1016 void
1017 Editor::replace(string a, string b)
1018 {
1019         auto old_content = _content;
1020         boost::algorithm::replace_all(_content, a, b);
1021         BOOST_REQUIRE(_content != old_content);
1022 }