2 Copyright (C) 2012-2017 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 /** @file test/test.cc
22 * @brief Overall test stuff and useful methods for tests.
25 #include "lib/config.h"
27 #include "lib/signal_manager.h"
29 #include "lib/job_manager.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"
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>
46 #include <libxml++/libxml++.h>
49 #include <libavformat/avformat.h>
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>
66 using boost::shared_ptr;
67 using boost::scoped_array;
68 using boost::dynamic_pointer_cast;
70 boost::filesystem::path private_data = boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private");
72 class TestSignalManager : public SignalManager
75 /* No wakes in tests: we call ui_idle ourselves */
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);
101 EncodeServerFinder::instance()->stop ();
103 signal_manager = new TestSignalManager ();
105 char* env_private = getenv("DCPOMATIC_TEST_PRIVATE");
107 private_data = env_private;
117 BOOST_GLOBAL_FIXTURE (TestConfig);
119 boost::filesystem::path
120 test_film_dir (string name)
122 boost::filesystem::path p;
130 new_test_film (string name)
132 boost::filesystem::path p = test_film_dir (name);
133 if (boost::filesystem::exists (p)) {
134 boost::filesystem::remove_all (p);
137 shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
138 film->write_metadata ();
143 new_test_film2 (string name)
145 boost::filesystem::path p = test_film_dir (name);
146 if (boost::filesystem::exists (p)) {
147 boost::filesystem::remove_all (p);
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 ();
158 check_wav_file (boost::filesystem::path ref, boost::filesystem::path check)
162 SNDFILE* ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
163 BOOST_CHECK (ref_file);
166 check_info.format = 0;
167 SNDFILE* check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
168 BOOST_CHECK (check_file);
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);
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]);
180 sf_count_t N = ref_info.frames;
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);
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] << ")"
201 check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
203 ASDCP::PCM::MXFReader ref_reader;
204 BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.OpenRead (ref.string().c_str())));
206 ASDCP::PCM::AudioDescriptor ref_desc;
207 BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.FillAudioDescriptor (ref_desc)));
209 ASDCP::PCM::MXFReader check_reader;
210 BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.OpenRead (check.string().c_str())));
212 ASDCP::PCM::AudioDescriptor check_desc;
213 BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.FillAudioDescriptor (check_desc)));
215 BOOST_REQUIRE_EQUAL (ref_desc.ContainerDuration, check_desc.ContainerDuration);
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);
227 check_image (boost::filesystem::path ref, boost::filesystem::path check)
229 #ifdef DCPOMATIC_IMAGE_MAGICK
230 using namespace MagickCore;
232 using namespace MagickLib;
235 Magick::Image ref_image;
236 ref_image.read (ref.string ());
237 Magick::Image check_image;
238 check_image.read (check.string ());
239 /* XXX: this is a hack; we really want the ImageMagick call but GraphicsMagick doesn't have it;
240 this may cause random test failures on platforms that use GraphicsMagick.
242 #ifdef DCPOMATIC_IMAGE_MAGICK
243 double const dist = ref_image.compare(check_image, Magick::RootMeanSquaredErrorMetric);
244 BOOST_CHECK_MESSAGE (dist < 0.001, ref << " differs from " << check << " " << dist);
246 BOOST_CHECK_MESSAGE (!ref_image.compare(check_image), ref << " differs from " << check);
251 check_file (boost::filesystem::path ref, boost::filesystem::path check)
253 uintmax_t N = boost::filesystem::file_size (ref);
254 BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
255 FILE* ref_file = fopen_boost (ref, "rb");
256 BOOST_CHECK (ref_file);
257 FILE* check_file = fopen_boost (check, "rb");
258 BOOST_CHECK (check_file);
260 int const buffer_size = 65536;
261 uint8_t* ref_buffer = new uint8_t[buffer_size];
262 uint8_t* check_buffer = new uint8_t[buffer_size];
264 string error = "File " + check.string() + " differs from reference " + ref.string();
267 uintmax_t this_time = min (uintmax_t (buffer_size), N);
268 size_t r = fread (ref_buffer, 1, this_time, ref_file);
269 BOOST_CHECK_EQUAL (r, this_time);
270 r = fread (check_buffer, 1, this_time, check_file);
271 BOOST_CHECK_EQUAL (r, this_time);
273 BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error);
274 if (memcmp (ref_buffer, check_buffer, this_time)) {
282 delete[] check_buffer;
289 note (dcp::NoteType t, string n)
291 if (t == dcp::DCP_ERROR) {
297 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
299 dcp::DCP ref_dcp (ref);
301 dcp::DCP check_dcp (check);
304 dcp::EqualityOptions options;
305 options.max_mean_pixel_error = 5;
306 options.max_std_dev_pixel_error = 5;
307 options.max_audio_sample_error = 255;
308 options.cpl_annotation_texts_can_differ = true;
309 options.reel_annotation_texts_can_differ = true;
310 options.reel_hashes_can_differ = true;
311 options.issue_dates_can_differ = true;
313 BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
317 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
319 BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
320 BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
322 if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
326 xmlpp::Element::NodeList ref_children = ref->get_children ();
327 xmlpp::Element::NodeList test_children = test->get_children ();
328 BOOST_REQUIRE_MESSAGE (
329 ref_children.size() == test_children.size(),
330 ref->get_name() << " has " << ref_children.size() << " or " << test_children.size() << " children"
333 xmlpp::Element::NodeList::iterator k = ref_children.begin ();
334 xmlpp::Element::NodeList::iterator l = test_children.begin ();
335 while (k != ref_children.end ()) {
337 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
339 xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
340 xmlpp::Element* test_el = dynamic_cast<xmlpp::Element*> (*l);
341 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
342 if (ref_el && test_el) {
343 check_xml (ref_el, test_el, ignore);
346 xmlpp::ContentNode* ref_cn = dynamic_cast<xmlpp::ContentNode*> (*k);
347 xmlpp::ContentNode* test_cn = dynamic_cast<xmlpp::ContentNode*> (*l);
348 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
349 if (ref_cn && test_cn) {
350 BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
357 xmlpp::Element::AttributeList ref_attributes = ref->get_attributes ();
358 xmlpp::Element::AttributeList test_attributes = test->get_attributes ();
359 BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
361 xmlpp::Element::AttributeList::const_iterator m = ref_attributes.begin();
362 xmlpp::Element::AttributeList::const_iterator n = test_attributes.begin();
363 while (m != ref_attributes.end ()) {
364 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
365 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
373 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
375 xmlpp::DomParser* ref_parser = new xmlpp::DomParser (ref.string ());
376 xmlpp::Element* ref_root = ref_parser->get_document()->get_root_node ();
377 xmlpp::DomParser* test_parser = new xmlpp::DomParser (test.string ());
378 xmlpp::Element* test_root = test_parser->get_document()->get_root_node ();
380 check_xml (ref_root, test_root, ignore);
386 JobManager* jm = JobManager::instance ();
387 while (jm->work_to_do ()) {
388 while (signal_manager->ui_idle ()) {}
394 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
395 if ((*i)->finished_in_error ()) {
399 cerr << N << " errors.\n";
401 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
402 if ((*i)->finished_in_error ()) {
403 cerr << (*i)->name() << ":\n"
404 << "\tsummary: " << (*i)->error_summary () << "\n"
405 << "\tdetails: " << (*i)->error_details () << "\n";
410 while (signal_manager->ui_idle ()) {}
421 write_image (shared_ptr<const Image> image, boost::filesystem::path file, string format)
423 #ifdef DCPOMATIC_IMAGE_MAGICK
424 using namespace MagickCore;
426 using namespace MagickLib;
429 Magick::Image m (image->size().width, image->size().height, format.c_str(), CharPixel, (void *) image->data()[0]);
430 m.write (file.string ());
434 check_ffmpeg (boost::filesystem::path ref, boost::filesystem::path check)
436 int const r = system (string("ffcmp " + ref.string() + " " + check.string()).c_str());
437 BOOST_REQUIRE_EQUAL (WEXITSTATUS(r), 0);
441 check_one_frame (boost::filesystem::path dcp_dir, int64_t index, boost::filesystem::path ref)
443 dcp::DCP dcp (dcp_dir);
445 shared_ptr<dcp::MonoPictureAsset> asset = dynamic_pointer_cast<dcp::MonoPictureAsset> (dcp.cpls().front()->reels().front()->main_picture()->asset());
446 BOOST_REQUIRE (asset);
447 shared_ptr<const dcp::MonoPictureFrame> frame = asset->start_read()->get_frame(index);
449 boost::uintmax_t const ref_size = boost::filesystem::file_size(ref);
450 BOOST_CHECK_EQUAL (frame->j2k_size(), ref_size);
452 FILE* ref_file = fopen_boost(ref, "rb");
453 BOOST_REQUIRE (ref_file);
455 uint8_t* ref_data = new uint8_t[ref_size];
456 fread (ref_data, ref_size, 1, ref_file);
459 BOOST_CHECK (memcmp(ref_data, frame->j2k_data(), ref_size) == 0);
463 boost::filesystem::path
464 dcp_file (shared_ptr<const Film> film, string prefix)
466 boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->dir(film->dcp_name()));
467 while (i != boost::filesystem::directory_iterator() && !boost::algorithm::starts_with (i->path().leaf().string(), prefix)) {
471 BOOST_REQUIRE (i != boost::filesystem::directory_iterator());