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