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