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