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/log_entry.h"
37 #include <asdcp/AS_DCP.h>
39 #include <libxml++/libxml++.h>
42 #include <libavformat/avformat.h>
44 #define BOOST_TEST_DYN_LINK
45 #define BOOST_TEST_MODULE dcpomatic_test
46 #include <boost/test/unit_test.hpp>
58 using boost::shared_ptr;
59 using boost::scoped_array;
61 boost::filesystem::path private_data = boost::filesystem::path ("..") / boost::filesystem::path ("dcpomatic-test-private");
63 class TestSignalManager : public SignalManager
66 /* No wakes in tests: we call ui_idle ourselves */
79 Config::instance()->set_master_encoding_threads (1);
80 Config::instance()->set_server_encoding_threads (1);
81 Config::instance()->set_server_port_base (61921);
82 Config::instance()->set_default_isdcf_metadata (ISDCFMetadata ());
83 Config::instance()->set_default_container (Ratio::from_id ("185"));
84 Config::instance()->set_default_dcp_content_type (static_cast<DCPContentType*> (0));
85 Config::instance()->set_default_audio_delay (0);
86 Config::instance()->set_default_j2k_bandwidth (100000000);
87 Config::instance()->set_default_interop (false);
88 Config::instance()->set_default_still_length (10);
89 Config::instance()->set_log_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
91 EncodeServerFinder::instance()->stop ();
93 signal_manager = new TestSignalManager ();
102 BOOST_GLOBAL_FIXTURE (TestConfig);
104 boost::filesystem::path
105 test_film_dir (string name)
107 boost::filesystem::path p;
115 new_test_film (string name)
117 boost::filesystem::path p = test_film_dir (name);
118 if (boost::filesystem::exists (p)) {
119 boost::filesystem::remove_all (p);
122 shared_ptr<Film> film = shared_ptr<Film> (new Film (p));
123 film->write_metadata ();
128 check_wav_file (boost::filesystem::path ref, boost::filesystem::path check)
132 SNDFILE* ref_file = sf_open (ref.string().c_str(), SFM_READ, &ref_info);
133 BOOST_CHECK (ref_file);
136 check_info.format = 0;
137 SNDFILE* check_file = sf_open (check.string().c_str(), SFM_READ, &check_info);
138 BOOST_CHECK (check_file);
140 BOOST_CHECK_EQUAL (ref_info.frames, check_info.frames);
141 BOOST_CHECK_EQUAL (ref_info.samplerate, check_info.samplerate);
142 BOOST_CHECK_EQUAL (ref_info.channels, check_info.channels);
143 BOOST_CHECK_EQUAL (ref_info.format, check_info.format);
145 /* buffer_size is in frames */
146 sf_count_t const buffer_size = 65536 * ref_info.channels;
147 scoped_array<int32_t> ref_buffer (new int32_t[buffer_size]);
148 scoped_array<int32_t> check_buffer (new int32_t[buffer_size]);
150 sf_count_t N = ref_info.frames;
152 sf_count_t this_time = min (buffer_size, N);
153 sf_count_t r = sf_readf_int (ref_file, ref_buffer.get(), this_time);
154 BOOST_CHECK_EQUAL (r, this_time);
155 r = sf_readf_int (check_file, check_buffer.get(), this_time);
156 BOOST_CHECK_EQUAL (r, this_time);
158 for (sf_count_t i = 0; i < this_time; ++i) {
159 BOOST_REQUIRE_MESSAGE (
160 abs (ref_buffer[i] - check_buffer[i]) <= 65536,
161 ref << " differs from " << check << " at " << (ref_info.frames - N + i) << " of " << ref_info.frames
162 << "(" << ref_buffer[i] << " vs " << check_buffer[i] << ")"
171 check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
173 ASDCP::PCM::MXFReader ref_reader;
174 BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.OpenRead (ref.string().c_str())));
176 ASDCP::PCM::AudioDescriptor ref_desc;
177 BOOST_REQUIRE (!ASDCP_FAILURE (ref_reader.FillAudioDescriptor (ref_desc)));
179 ASDCP::PCM::MXFReader check_reader;
180 BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.OpenRead (check.string().c_str())));
182 ASDCP::PCM::AudioDescriptor check_desc;
183 BOOST_REQUIRE (!ASDCP_FAILURE (check_reader.FillAudioDescriptor (check_desc)));
185 BOOST_REQUIRE_EQUAL (ref_desc.ContainerDuration, check_desc.ContainerDuration);
187 ASDCP::PCM::FrameBuffer ref_buffer (Kumu::Megabyte);
188 ASDCP::PCM::FrameBuffer check_buffer (Kumu::Megabyte);
189 for (size_t i = 0; i < ref_desc.ContainerDuration; ++i) {
190 ref_reader.ReadFrame (i, ref_buffer, 0);
191 check_reader.ReadFrame (i, check_buffer, 0);
192 BOOST_REQUIRE (memcmp(ref_buffer.RoData(), check_buffer.RoData(), ref_buffer.Size()) == 0);
197 check_image (boost::filesystem::path ref, boost::filesystem::path check)
199 #ifdef DCPOMATIC_IMAGE_MAGICK
200 using namespace MagickCore;
202 using namespace MagickLib;
205 Magick::Image ref_image;
206 ref_image.read (ref.string ());
207 Magick::Image check_image;
208 check_image.read (check.string ());
209 BOOST_CHECK_MESSAGE (ref_image.compare (check_image), ref << " differs from " << check);
213 check_file (boost::filesystem::path ref, boost::filesystem::path check)
215 uintmax_t N = boost::filesystem::file_size (ref);
216 BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
217 FILE* ref_file = fopen_boost (ref, "rb");
218 BOOST_CHECK (ref_file);
219 FILE* check_file = fopen_boost (check, "rb");
220 BOOST_CHECK (check_file);
222 int const buffer_size = 65536;
223 uint8_t* ref_buffer = new uint8_t[buffer_size];
224 uint8_t* check_buffer = new uint8_t[buffer_size];
226 string error = "File " + check.string() + " differs from reference " + ref.string();
229 uintmax_t this_time = min (uintmax_t (buffer_size), N);
230 size_t r = fread (ref_buffer, 1, this_time, ref_file);
231 BOOST_CHECK_EQUAL (r, this_time);
232 r = fread (check_buffer, 1, this_time, check_file);
233 BOOST_CHECK_EQUAL (r, this_time);
235 BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error);
236 if (memcmp (ref_buffer, check_buffer, this_time)) {
244 delete[] check_buffer;
251 note (dcp::NoteType t, string n)
253 if (t == dcp::DCP_ERROR) {
259 check_dcp (boost::filesystem::path ref, boost::filesystem::path check)
261 dcp::DCP ref_dcp (ref);
263 dcp::DCP check_dcp (check);
266 dcp::EqualityOptions options;
267 options.max_mean_pixel_error = 5;
268 options.max_std_dev_pixel_error = 5;
269 options.max_audio_sample_error = 255;
270 options.cpl_annotation_texts_can_differ = true;
271 options.reel_annotation_texts_can_differ = true;
272 options.reel_hashes_can_differ = true;
273 options.issue_dates_can_differ = true;
275 BOOST_CHECK (ref_dcp.equals (check_dcp, options, boost::bind (note, _1, _2)));
279 check_xml (xmlpp::Element* ref, xmlpp::Element* test, list<string> ignore)
281 BOOST_CHECK_EQUAL (ref->get_name (), test->get_name ());
282 BOOST_CHECK_EQUAL (ref->get_namespace_prefix (), test->get_namespace_prefix ());
284 if (find (ignore.begin(), ignore.end(), ref->get_name()) != ignore.end ()) {
288 xmlpp::Element::NodeList ref_children = ref->get_children ();
289 xmlpp::Element::NodeList test_children = test->get_children ();
290 BOOST_REQUIRE_MESSAGE (
291 ref_children.size() == test_children.size(),
292 ref->get_name() << " has " << ref_children.size() << " or " << test_children.size() << " children"
295 xmlpp::Element::NodeList::iterator k = ref_children.begin ();
296 xmlpp::Element::NodeList::iterator l = test_children.begin ();
297 while (k != ref_children.end ()) {
299 /* XXX: should be doing xmlpp::EntityReference, xmlpp::XIncludeEnd, xmlpp::XIncludeStart */
301 xmlpp::Element* ref_el = dynamic_cast<xmlpp::Element*> (*k);
302 xmlpp::Element* test_el = dynamic_cast<xmlpp::Element*> (*l);
303 BOOST_CHECK ((ref_el && test_el) || (!ref_el && !test_el));
304 if (ref_el && test_el) {
305 check_xml (ref_el, test_el, ignore);
308 xmlpp::ContentNode* ref_cn = dynamic_cast<xmlpp::ContentNode*> (*k);
309 xmlpp::ContentNode* test_cn = dynamic_cast<xmlpp::ContentNode*> (*l);
310 BOOST_CHECK ((ref_cn && test_cn) || (!ref_cn && !test_cn));
311 if (ref_cn && test_cn) {
312 BOOST_CHECK_EQUAL (ref_cn->get_content(), test_cn->get_content ());
319 xmlpp::Element::AttributeList ref_attributes = ref->get_attributes ();
320 xmlpp::Element::AttributeList test_attributes = test->get_attributes ();
321 BOOST_CHECK_EQUAL (ref_attributes.size(), test_attributes.size ());
323 xmlpp::Element::AttributeList::const_iterator m = ref_attributes.begin();
324 xmlpp::Element::AttributeList::const_iterator n = test_attributes.begin();
325 while (m != ref_attributes.end ()) {
326 BOOST_CHECK_EQUAL ((*m)->get_name(), (*n)->get_name());
327 BOOST_CHECK_EQUAL ((*m)->get_value(), (*n)->get_value());
335 check_xml (boost::filesystem::path ref, boost::filesystem::path test, list<string> ignore)
337 xmlpp::DomParser* ref_parser = new xmlpp::DomParser (ref.string ());
338 xmlpp::Element* ref_root = ref_parser->get_document()->get_root_node ();
339 xmlpp::DomParser* test_parser = new xmlpp::DomParser (test.string ());
340 xmlpp::Element* test_root = test_parser->get_document()->get_root_node ();
342 check_xml (ref_root, test_root, ignore);
348 JobManager* jm = JobManager::instance ();
349 while (jm->work_to_do ()) {
350 while (signal_manager->ui_idle ()) {}
356 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
357 if ((*i)->finished_in_error ()) {
361 cerr << N << " errors.\n";
363 for (list<shared_ptr<Job> >::iterator i = jm->_jobs.begin(); i != jm->_jobs.end(); ++i) {
364 if ((*i)->finished_in_error ()) {
365 cerr << (*i)->name() << ":\n"
366 << "\tsummary: " << (*i)->error_summary () << "\n"
367 << "\tdetails: " << (*i)->error_details () << "\n";
372 while (signal_manager->ui_idle ()) {}
383 write_image (shared_ptr<const Image> image, boost::filesystem::path file, string format)
385 #ifdef DCPOMATIC_IMAGE_MAGICK
386 using namespace MagickCore;
388 using namespace MagickLib;
391 Magick::Image m (image->size().width, image->size().height, format.c_str(), CharPixel, (void *) image->data()[0]);
392 m.write (file.string ());
398 Reader (boost::filesystem::path file)
400 format_context = avformat_alloc_context ();
401 BOOST_REQUIRE (format_context);
402 BOOST_REQUIRE (avformat_open_input (&format_context, file.string().c_str(), 0, 0) >= 0);
403 BOOST_REQUIRE (avformat_find_stream_info (format_context, 0) >= 0);
408 avformat_close_input (&format_context);
411 AVFormatContext* format_context;
416 check_ffmpeg (boost::filesystem::path ref, boost::filesystem::path check, int skip_packet_stream)
419 Reader check_r (check);
421 BOOST_REQUIRE_EQUAL (ref_r.format_context->nb_streams, check_r.format_context->nb_streams);
426 bool skipped = false;
429 int p = av_read_frame (ref_r.format_context, &ref_p);
430 int q = av_read_frame (check_r.format_context, &check_p);
431 if (ref_p.stream_index == skip_packet_stream && check_p.stream_index == skip_packet_stream && !skipped) {
435 BOOST_REQUIRE_EQUAL (p, q);
436 BOOST_REQUIRE (p == 0 || p == AVERROR_EOF);
437 if (p == AVERROR_EOF) {
441 BOOST_REQUIRE_EQUAL (ref_p.buf->size, check_p.buf->size);
442 BOOST_REQUIRE_EQUAL (memcmp (ref_p.buf->data, check_p.buf->data, ref_p.buf->size), 0);