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