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 ();
112 BOOST_GLOBAL_FIXTURE (TestConfig);
114 boost::filesystem::path
115 test_film_dir (string name)
117 boost::filesystem::path p;
125 new_test_film (string name)
127 boost::filesystem::path p = test_film_dir (name);
128 if (boost::filesystem::exists (p)) {
129 boost::filesystem::remove_all (p);
132 shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
133 film->write_metadata ();
138 new_test_film2 (string name)
140 boost::filesystem::path p = test_film_dir (name);
141 if (boost::filesystem::exists (p)) {
142 boost::filesystem::remove_all (p);
145 shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
146 film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
147 film->set_container (Ratio::from_id ("185"));
148 film->write_metadata ();
153 check_wav_file (boost::filesystem::path ref, boost::filesystem::path check)
157 SNDFILE* ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
158 BOOST_CHECK (ref_file);
161 check_info.format = 0;
162 SNDFILE* check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
163 BOOST_CHECK (check_file);
165 BOOST_CHECK_EQUAL (ref_info.frames, check_info.frames);
166 BOOST_CHECK_EQUAL (ref_info.samplerate, check_info.samplerate);
167 BOOST_CHECK_EQUAL (ref_info.channels, check_info.channels);
168 BOOST_CHECK_EQUAL (ref_info.format, check_info.format);
170 /* buffer_size is in frames */
171 sf_count_t const buffer_size = 65536 * ref_info.channels;
172 scoped_array<int32_t> ref_buffer (new int32_t[buffer_size]);
173 scoped_array<int32_t> check_buffer (new int32_t[buffer_size]);
175 sf_count_t N = ref_info.frames;
177 sf_count_t this_time = min (buffer_size, N);
178 sf_count_t r = sf_readf_int (ref_file, ref_buffer.get(), this_time);
179 BOOST_CHECK_EQUAL (r, this_time);
180 r = sf_readf_int (check_file, check_buffer.get(), this_time);
181 BOOST_CHECK_EQUAL (r, this_time);
183 for (sf_count_t i = 0; i < this_time; ++i) {
184 BOOST_REQUIRE_MESSAGE (
185 abs (ref_buffer[i] - check_buffer[i]) <= 65536,
186 ref << " differs from " << check << " at " << (ref_info.frames - N + i) << " of " << ref_info.frames
187 << "(" << ref_buffer[i] << " vs " << check_buffer[i] << ")"
196 check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
198 ASDCP::PCM::MXFReader ref_reader;
199 BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.OpenRead (ref.string().c_str())));
201 ASDCP::PCM::AudioDescriptor ref_desc;
202 BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.FillAudioDescriptor (ref_desc)));
204 ASDCP::PCM::MXFReader check_reader;
205 BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.OpenRead (check.string().c_str())));
207 ASDCP::PCM::AudioDescriptor check_desc;
208 BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.FillAudioDescriptor (check_desc)));
210 BOOST_REQUIRE_EQUAL (ref_desc.ContainerDuration, check_desc.ContainerDuration);
212 ASDCP::PCM::FrameBuffer ref_buffer (Kumu::Megabyte);
213 ASDCP::PCM::FrameBuffer check_buffer (Kumu::Megabyte);
214 for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
215 ref_reader.ReadFrame (i, ref_buffer, 0);
216 check_reader.ReadFrame (i, check_buffer, 0);
217 BOOST_REQUIRE (memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size()) == 0);
222 check_image (boost::filesystem::path ref, boost::filesystem::path check)
224 #ifdef DCPOMATIC_IMAGE_MAGICK
225 using namespace MagickCore;
227 using namespace MagickLib;
230 Magick::Image ref_image;
231 ref_image.read (ref.string ());
232 Magick::Image check_image;
233 check_image.read (check.string ());
234 BOOST_CHECK_MESSAGE (ref_image.compare (check_image), ref << " differs from " << check);
238 check_file (boost::filesystem::path ref, boost::filesystem::path check)
240 uintmax_t N = boost::filesystem::file_size (ref);
241 BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
242 FILE* ref_file = fopen_boost (ref, "rb");
243 BOOST_CHECK (ref_file);
244 FILE* check_file = fopen_boost (check, "rb");
245 BOOST_CHECK (check_file);
247 int const buffer_size = 65536;
248 uint8_t* ref_buffer = new uint8_t[buffer_size];
249 uint8_t* check_buffer = new uint8_t[buffer_size];
251 string error = "File " + check.string() + " differs from reference " + ref.string();
254 uintmax_t this_time = min (uintmax_t (buffer_size), N);
255 size_t r = fread (ref_buffer, 1, this_time, ref_file);
256 BOOST_CHECK_EQUAL (r, this_time);
257 r = fread (check_buffer, 1, this_time, check_file);
258 BOOST_CHECK_EQUAL (r, this_time);
260 BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error);
261 if (memcmp (ref_buffer, check_buffer, this_time)) {
269 delete[] check_buffer;
276 note (dcp::NoteType t, string n)
278 if (t == dcp::DCP_ERROR) {
284 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
286 dcp::DCP ref_dcp (ref);
288 dcp::DCP check_dcp (check);
291 dcp::EqualityOptions options;
292 options.max_mean_pixel_error = 5;
293 options.max_std_dev_pixel_error = 5;
294 options.max_audio_sample_error = 255;
295 options.cpl_annotation_texts_can_differ = true;
296 options.reel_annotation_texts_can_differ = true;
297 options.reel_hashes_can_differ = true;
298 options.issue_dates_can_differ = true;
300 BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
304 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
306 BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
307 BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
309 if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
313 xmlpp::Element::NodeList ref_children = ref->get_children ();
314 xmlpp::Element::NodeList test_children = test->get_children ();
315 BOOST_REQUIRE_MESSAGE (
316 ref_children.size() == test_children.size(),
317 ref->get_name() << " has " << ref_children.size() << " or " << test_children.size() << " children"
320 xmlpp::Element::NodeList::iterator k = ref_children.begin ();
321 xmlpp::Element::NodeList::iterator l = test_children.begin ();
322 while (k != ref_children.end ()) {
324 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
326 xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
327 xmlpp::Element* test_el = dynamic_cast<xmlpp::Element*> (*l);
328 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
329 if (ref_el && test_el) {
330 check_xml (ref_el, test_el, ignore);
333 xmlpp::ContentNode* ref_cn = dynamic_cast<xmlpp::ContentNode*> (*k);
334 xmlpp::ContentNode* test_cn = dynamic_cast<xmlpp::ContentNode*> (*l);
335 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
336 if (ref_cn && test_cn) {
337 BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
344 xmlpp::Element::AttributeList ref_attributes = ref->get_attributes ();
345 xmlpp::Element::AttributeList test_attributes = test->get_attributes ();
346 BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
348 xmlpp::Element::AttributeList::const_iterator m = ref_attributes.begin();
349 xmlpp::Element::AttributeList::const_iterator n = test_attributes.begin();
350 while (m != ref_attributes.end ()) {
351 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
352 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
360 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
362 xmlpp::DomParser* ref_parser = new xmlpp::DomParser (ref.string ());
363 xmlpp::Element* ref_root = ref_parser->get_document()->get_root_node ();
364 xmlpp::DomParser* test_parser = new xmlpp::DomParser (test.string ());
365 xmlpp::Element* test_root = test_parser->get_document()->get_root_node ();
367 check_xml (ref_root, test_root, ignore);
373 JobManager* jm = JobManager::instance ();
374 while (jm->work_to_do ()) {
375 while (signal_manager->ui_idle ()) {}
381 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
382 if ((*i)->finished_in_error ()) {
386 cerr << N << " errors.\n";
388 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
389 if ((*i)->finished_in_error ()) {
390 cerr << (*i)->name() << ":\n"
391 << "\tsummary: " << (*i)->error_summary () << "\n"
392 << "\tdetails: " << (*i)->error_details () << "\n";
397 while (signal_manager->ui_idle ()) {}
408 write_image (shared_ptr<const Image> image, boost::filesystem::path file, string format)
410 #ifdef DCPOMATIC_IMAGE_MAGICK
411 using namespace MagickCore;
413 using namespace MagickLib;
416 Magick::Image m (image->size().width, image->size().height, format.c_str(), CharPixel, (void *) image->data()[0]);
417 m.write (file.string ());
423 Reader (boost::filesystem::path file)
425 format_context = avformat_alloc_context ();
426 BOOST_REQUIRE (format_context);
427 BOOST_REQUIRE (avformat_open_input (&format_context, file.string().c_str(), 0, 0) >= 0);
428 BOOST_REQUIRE (avformat_find_stream_info (format_context, 0) >= 0);
433 avformat_close_input (&format_context);
436 AVFormatContext* format_context;
441 check_ffmpeg (boost::filesystem::path ref, boost::filesystem::path check, int skip_packet_stream)
444 Reader check_r (check);
446 BOOST_REQUIRE_EQUAL (ref_r.format_context->nb_streams, check_r.format_context->nb_streams);
451 bool skipped = false;
454 int p = av_read_frame (ref_r.format_context, &ref_p);
455 int q = av_read_frame (check_r.format_context, &check_p);
456 if (ref_p.stream_index == skip_packet_stream && check_p.stream_index == skip_packet_stream && !skipped) {
460 BOOST_REQUIRE_EQUAL (p, q);
461 BOOST_REQUIRE (p == 0 || p == AVERROR_EOF);
462 if (p == AVERROR_EOF) {
466 BOOST_REQUIRE_EQUAL (ref_p.buf->size, check_p.buf->size);
467 BOOST_REQUIRE_EQUAL (memcmp (ref_p.buf->data, check_p.buf->data, ref_p.buf->size), 0);
472 check_one_frame (boost::filesystem::path dcp_dir, int64_t index, boost::filesystem::path ref)
474 dcp::DCP dcp (dcp_dir);
476 shared_ptr<dcp::MonoPictureAsset> asset = dynamic_pointer_cast<dcp::MonoPictureAsset> (dcp.cpls().front()->reels().front()->main_picture()->asset());
477 BOOST_REQUIRE (asset);
478 shared_ptr<const dcp::MonoPictureFrame> frame = asset->start_read()->get_frame(index);
480 boost::uintmax_t const ref_size = boost::filesystem::file_size(ref);
481 BOOST_CHECK_EQUAL (frame->j2k_size(), ref_size);
483 FILE* ref_file = fopen_boost(ref, "rb");
484 BOOST_REQUIRE (ref_file);
486 uint8_t* ref_data = new uint8_t[ref_size];
487 fread (ref_data, ref_size, 1, ref_file);
490 BOOST_CHECK (memcmp(ref_data, frame->j2k_data(), ref_size) == 0);
494 boost::filesystem::path
495 video_file (shared_ptr<const Film> film)
497 boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->dir(film->dcp_name()));
498 while (i != boost::filesystem::directory_iterator() && !boost::algorithm::starts_with (i->path().leaf().string(), "j2c")) {
502 BOOST_REQUIRE (i != boost::filesystem::directory_iterator());