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