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