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