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