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