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