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