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