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