test/test.cc

   1 /*
   2     Copyright (C) 2012-2017 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 /** @file  test/test.cc
  22  *  @brief Overall test stuff and useful methods for tests.
  23  */
  24
  25 #include "lib/config.h"
  26 #include "lib/util.h"
  27 #include "lib/signal_manager.h"
  28 #include "lib/film.h"
  29 #include "lib/job_manager.h"
  30 #include "lib/job.h"
  31 #include "lib/cross.h"
  32 #include "lib/encode_server_finder.h"
  33 #include "lib/image.h"
  34 #include "lib/ratio.h"
  35 #include "lib/dcp_content_type.h"
  36 #include "lib/log_entry.h"
  37 #include <dcp/dcp.h>
  38 #include <dcp/cpl.h>
  39 #include <dcp/reel.h>
  40 #include <dcp/reel_picture_asset.h>
  41 #include <dcp/mono_picture_frame.h>
  42 #include <dcp/mono_picture_asset.h>
  43 #include <dcp/openjpeg_image.h>
  44 #include <asdcp/AS_DCP.h>
  45 #include <sndfile.h>
  46 #include <libxml++/libxml++.h>
  47 #include <Magick++.h>
  48 extern "C" {
  49 #include <libavformat/avformat.h>
  50 }
  51 #define BOOST_TEST_DYN_LINK
  52 #define BOOST_TEST_MODULE dcpomatic_test
  53 #include <boost/test/unit_test.hpp>
  54 #include <boost/algorithm/string.hpp>
  55 #include <list>
  56 #include <vector>
  57 #include <iostream>
  58
  59 using std::string;
  60 using std::vector;
  61 using std::min;
  62 using std::cout;
  63 using std::cerr;
  64 using std::list;
  65 using std::abs;
  66 using boost::shared_ptr;
  67 using boost::scoped_array;
  68 using boost::dynamic_pointer_cast;
  69
  70 boost::filesystem::path private_data = boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private");
  71
  72 class TestSignalManager : public SignalManager
  73 {
  74 public:
  75         /* No wakes in tests: we call ui_idle ourselves */
  76         void wake_ui ()
  77         {
  78
  79         }
  80 };
  81
  82 struct TestConfig
  83 {
  84         TestConfig ()
  85         {
  86                 dcpomatic_setup ();
  87
  88                 Config::instance()->set_master_encoding_threads (1);
  89                 Config::instance()->set_server_encoding_threads (1);
  90                 Config::instance()->set_server_port_base (61921);
  91                 Config::instance()->set_default_isdcf_metadata (ISDCFMetadata ());
  92                 Config::instance()->set_default_container (Ratio::from_id ("185"));
  93                 Config::instance()->set_default_dcp_content_type (static_cast<DCPContentType*> (0));
  94                 Config::instance()->set_default_audio_delay (0);
  95                 Config::instance()->set_default_j2k_bandwidth (100000000);
  96                 Config::instance()->set_default_interop (false);
  97                 Config::instance()->set_default_still_length (10);
  98                 Config::instance()->set_log_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
  99                 Config::instance()->set_automatic_audio_analysis (false);
 100
 101                 EncodeServerFinder::instance()->stop ();
 102
 103                 signal_manager = new TestSignalManager ();
 104
 105                 char* env_private = getenv("DCPOMATIC_TEST_PRIVATE");
 106                 if (env_private) {
 107                         private_data = env_private;
 108                 }
 109         }
 110
 111         ~TestConfig ()
 112         {
 113                 JobManager::drop ();
 114         }
 115 };
 116
 117 BOOST_GLOBAL_FIXTURE (TestConfig);
 118
 119 boost::filesystem::path
 120 test_film_dir (string name)
 121 {
 122         boost::filesystem::path p;
 123         p /= "build";
 124         p /= "test";
 125         p /= name;
 126         return p;
 127 }
 128
 129 shared_ptr<Film>
 130 new_test_film (string name)
 131 {
 132         boost::filesystem::path p = test_film_dir (name);
 133         if (boost::filesystem::exists (p)) {
 134                 boost::filesystem::remove_all (p);
 135         }
 136
 137         shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
 138         film->write_metadata ();
 139         return film;
 140 }
 141
 142 shared_ptr<Film>
 143 new_test_film2 (string name)
 144 {
 145         boost::filesystem::path p = test_film_dir (name);
 146         if (boost::filesystem::exists (p)) {
 147                 boost::filesystem::remove_all (p);
 148         }
 149
 150         shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
 151         film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
 152         film->set_container (Ratio::from_id ("185"));
 153         film->write_metadata ();
 154         return film;
 155 }
 156
 157 void
 158 check_wav_file (boost::filesystem::path ref, boost::filesystem::path check)
 159 {
 160         SF_INFO ref_info;
 161         ref_info.format = 0;
 162         SNDFILE* ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
 163         BOOST_CHECK (ref_file);
 164
 165         SF_INFO check_info;
 166         check_info.format = 0;
 167         SNDFILE* check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
 168         BOOST_CHECK (check_file);
 169
 170         BOOST_CHECK_EQUAL (ref_info.frames, check_info.frames);
 171         BOOST_CHECK_EQUAL (ref_info.samplerate, check_info.samplerate);
 172         BOOST_CHECK_EQUAL (ref_info.channels, check_info.channels);
 173         BOOST_CHECK_EQUAL (ref_info.format, check_info.format);
 174
 175         /* buffer_size is in frames */
 176         sf_count_t const buffer_size = 65536 * ref_info.channels;
 177         scoped_array<int32_t> ref_buffer (new int32_t[buffer_size]);
 178         scoped_array<int32_t> check_buffer (new int32_t[buffer_size]);
 179
 180         sf_count_t N = ref_info.frames;
 181         while (N) {
 182                 sf_count_t this_time = min (buffer_size, N);
 183                 sf_count_t r = sf_readf_int (ref_file, ref_buffer.get(), this_time);
 184                 BOOST_CHECK_EQUAL (r, this_time);
 185                 r = sf_readf_int (check_file, check_buffer.get(), this_time);
 186                 BOOST_CHECK_EQUAL (r, this_time);
 187
 188                 for (sf_count_t i = 0; i < this_time; ++i) {
 189                         BOOST_REQUIRE_MESSAGE (
 190                                 abs (ref_buffer[i] - check_buffer[i]) <= 65536,
 191                                 ref << " differs from " << check << " at " << (ref_info.frames - N + i) << " of " << ref_info.frames
 192                                 << "(" << ref_buffer[i] << " vs " << check_buffer[i] << ")"
 193                                 );
 194                 }
 195
 196                 N -= this_time;
 197         }
 198 }
 199
 200 void
 201 check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
 202 {
 203         ASDCP::PCM::MXFReader ref_reader;
 204         BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.OpenRead (ref.string().c_str())));
 205
 206         ASDCP::PCM::AudioDescriptor ref_desc;
 207         BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.FillAudioDescriptor (ref_desc)));
 208
 209         ASDCP::PCM::MXFReader check_reader;
 210         BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.OpenRead (check.string().c_str())));
 211
 212         ASDCP::PCM::AudioDescriptor check_desc;
 213         BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.FillAudioDescriptor (check_desc)));
 214
 215         BOOST_REQUIRE_EQUAL (ref_desc.ContainerDuration, check_desc.ContainerDuration);
 216
 217         ASDCP::PCM::FrameBuffer ref_buffer (Kumu::Megabyte);
 218         ASDCP::PCM::FrameBuffer check_buffer (Kumu::Megabyte);
 219         for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
 220                 ref_reader.ReadFrame (i, ref_buffer, 0);
 221                 check_reader.ReadFrame (i, check_buffer, 0);
 222                 BOOST_REQUIRE (memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size()) == 0);
 223         }
 224 }
 225
 226 void
 227 check_image (boost::filesystem::path ref, boost::filesystem::path check)
 228 {
 229 #ifdef DCPOMATIC_IMAGE_MAGICK
 230         using namespace MagickCore;
 231 #else
 232         using namespace MagickLib;
 233 #endif
 234
 235         Magick::Image ref_image;
 236         ref_image.read (ref.string ());
 237         Magick::Image check_image;
 238         check_image.read (check.string ());
 239         BOOST_CHECK_MESSAGE (ref_image.compare (check_image), ref << " differs from " << check);
 240 }
 241
 242 void
 243 check_file (boost::filesystem::path ref, boost::filesystem::path check)
 244 {
 245         uintmax_t N = boost::filesystem::file_size (ref);
 246         BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
 247         FILE* ref_file = fopen_boost (ref, "rb");
 248         BOOST_CHECK (ref_file);
 249         FILE* check_file = fopen_boost (check, "rb");
 250         BOOST_CHECK (check_file);
 251
 252         int const buffer_size = 65536;
 253         uint8_t* ref_buffer = new uint8_t[buffer_size];
 254         uint8_t* check_buffer = new uint8_t[buffer_size];
 255
 256         string error = "File " + check.string() + " differs from reference " + ref.string();
 257
 258         while (N) {
 259                 uintmax_t this_time = min (uintmax_t (buffer_size), N);
 260                 size_t r = fread (ref_buffer, 1, this_time, ref_file);
 261                 BOOST_CHECK_EQUAL (r, this_time);
 262                 r = fread (check_buffer, 1, this_time, check_file);
 263                 BOOST_CHECK_EQUAL (r, this_time);
 264
 265                 BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error);
 266                 if (memcmp (ref_buffer, check_buffer, this_time)) {
 267                         break;
 268                 }
 269
 270                 N -= this_time;
 271         }
 272
 273         delete[] ref_buffer;
 274         delete[] check_buffer;
 275
 276         fclose (ref_file);
 277         fclose (check_file);
 278 }
 279
 280 static void
 281 note (dcp::NoteType t, string n)
 282 {
 283         if (t == dcp::DCP_ERROR) {
 284                 cerr << n << "\n";
 285         }
 286 }
 287
 288 void
 289 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
 290 {
 291         dcp::DCP ref_dcp (ref);
 292         ref_dcp.read ();
 293         dcp::DCP check_dcp (check);
 294         check_dcp.read ();
 295
 296         dcp::EqualityOptions options;
 297         options.max_mean_pixel_error = 5;
 298         options.max_std_dev_pixel_error = 5;
 299         options.max_audio_sample_error = 255;
 300         options.cpl_annotation_texts_can_differ = true;
 301         options.reel_annotation_texts_can_differ = true;
 302         options.reel_hashes_can_differ = true;
 303         options.issue_dates_can_differ = true;
 304
 305         BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
 306 }
 307
 308 void
 309 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
 310 {
 311         BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
 312         BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
 313
 314         if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
 315                 return;
 316         }
 317
 318         xmlpp::Element::NodeList ref_children = ref->get_children ();
 319         xmlpp::Element::NodeList test_children = test->get_children ();
 320         BOOST_REQUIRE_MESSAGE (
 321                 ref_children.size() == test_children.size(),
 322                 ref->get_name() << " has " << ref_children.size() << " or " << test_children.size() << " children"
 323                 );
 324
 325         xmlpp::Element::NodeList::iterator k = ref_children.begin ();
 326         xmlpp::Element::NodeList::iterator l = test_children.begin ();
 327         while (k != ref_children.end ()) {
 328
 329                 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
 330
 331                 xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
 332                 xmlpp::Element* test_el = dynamic_cast<xmlpp::Element*> (*l);
 333                 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
 334                 if (ref_el && test_el) {
 335                         check_xml (ref_el, test_el, ignore);
 336                 }
 337
 338                 xmlpp::ContentNode* ref_cn = dynamic_cast<xmlpp::ContentNode*> (*k);
 339                 xmlpp::ContentNode* test_cn = dynamic_cast<xmlpp::ContentNode*> (*l);
 340                 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
 341                 if (ref_cn && test_cn) {
 342                         BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
 343                 }
 344
 345                 ++k;
 346                 ++l;
 347         }
 348
 349         xmlpp::Element::AttributeList ref_attributes = ref->get_attributes ();
 350         xmlpp::Element::AttributeList test_attributes = test->get_attributes ();
 351         BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
 352
 353         xmlpp::Element::AttributeList::const_iterator m = ref_attributes.begin();
 354         xmlpp::Element::AttributeList::const_iterator n = test_attributes.begin();
 355         while (m != ref_attributes.end ()) {
 356                 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
 357                 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
 358
 359                 ++m;
 360                 ++n;
 361         }
 362 }
 363
 364 void
 365 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
 366 {
 367         xmlpp::DomParser* ref_parser = new xmlpp::DomParser (ref.string ());
 368         xmlpp::Element* ref_root = ref_parser->get_document()->get_root_node ();
 369         xmlpp::DomParser* test_parser = new xmlpp::DomParser (test.string ());
 370         xmlpp::Element* test_root = test_parser->get_document()->get_root_node ();
 371
 372         check_xml (ref_root, test_root, ignore);
 373 }
 374
 375 bool
 376 wait_for_jobs ()
 377 {
 378         JobManager* jm = JobManager::instance ();
 379         while (jm->work_to_do ()) {
 380                 while (signal_manager->ui_idle ()) {}
 381                 dcpomatic_sleep (1);
 382         }
 383
 384         if (jm->errors ()) {
 385                 int N = 0;
 386                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 387                         if ((*i)->finished_in_error ()) {
 388                                 ++N;
 389                         }
 390                 }
 391                 cerr << N << " errors.\n";
 392
 393                 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
 394                         if ((*i)->finished_in_error ()) {
 395                                 cerr << (*i)->name() << ":\n"
 396                                      << "\tsummary: " << (*i)->error_summary () << "\n"
 397                                      << "\tdetails: " << (*i)->error_details () << "\n";
 398                         }
 399                 }
 400         }
 401
 402         while (signal_manager->ui_idle ()) {}
 403
 404         if (jm->errors ()) {
 405                 JobManager::drop ();
 406                 return true;
 407         }
 408
 409         return false;
 410 }
 411
 412 void
 413 write_image (shared_ptr<const Image> image, boost::filesystem::path file, string format)
 414 {
 415 #ifdef DCPOMATIC_IMAGE_MAGICK
 416                 using namespace MagickCore;
 417 #else
 418                 using namespace MagickLib;
 419 #endif
 420
 421         Magick::Image m (image->size().width, image->size().height, format.c_str(), CharPixel, (void *) image->data()[0]);
 422         m.write (file.string ());
 423 }
 424
 425 void
 426 check_ffmpeg (boost::filesystem::path ref, boost::filesystem::path check)
 427 {
 428         int const r = system (string("ffcmp " + ref.string() + " " + check.string()).c_str());
 429         BOOST_REQUIRE_EQUAL (WEXITSTATUS(r), 0);
 430 }
 431
 432 void
 433 check_one_frame (boost::filesystem::path dcp_dir, int64_t index, boost::filesystem::path ref)
 434 {
 435         dcp::DCP dcp (dcp_dir);
 436         dcp.read ();
 437         shared_ptr<dcp::MonoPictureAsset> asset = dynamic_pointer_cast<dcp::MonoPictureAsset> (dcp.cpls().front()->reels().front()->main_picture()->asset());
 438         BOOST_REQUIRE (asset);
 439         shared_ptr<const dcp::MonoPictureFrame> frame = asset->start_read()->get_frame(index);
 440
 441         boost::uintmax_t const ref_size = boost::filesystem::file_size(ref);
 442         BOOST_CHECK_EQUAL (frame->j2k_size(), ref_size);
 443
 444         FILE* ref_file = fopen_boost(ref, "rb");
 445         BOOST_REQUIRE (ref_file);
 446
 447         uint8_t* ref_data = new uint8_t[ref_size];
 448         fread (ref_data, ref_size, 1, ref_file);
 449         fclose (ref_file);
 450
 451         BOOST_CHECK (memcmp(ref_data, frame->j2k_data(), ref_size) == 0);
 452         delete[] ref_data;
 453 }
 454
 455 boost::filesystem::path
 456 dcp_file (shared_ptr<const Film> film, string prefix)
 457 {
 458         boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->dir(film->dcp_name()));
 459         while (i != boost::filesystem::directory_iterator() && !boost::algorithm::starts_with (i->path().leaf().string(), prefix)) {
 460                 ++i;
 461         }
 462
 463         BOOST_REQUIRE (i != boost::filesystem::directory_iterator());
 464         return i->path();
 465 }