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