Fix subtitle_file() to find both Interop and SMPTE subtitles.
[dcpomatic.git] / test / test.cc
index 292b4e1d9436b60365c6ad5e604a512f52cc108e..f1fd40fb791597c4bf5da7e960a05b523b5878cb 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
+
+
 /** @file  test/test.cc
  *  @brief Overall test stuff and useful methods for tests.
  */
 
+
 #include "lib/compose.hpp"
 #include "lib/config.h"
 #include "lib/cross.h"
@@ -35,6 +38,7 @@
 #include "lib/job.h"
 #include "lib/job_manager.h"
 #include "lib/log_entry.h"
+#include "lib/make_dcp.h"
 #include "lib/ratio.h"
 #include "lib/signal_manager.h"
 #include "lib/util.h"
@@ -46,6 +50,7 @@
 #include <dcp/openjpeg_image.h>
 #include <dcp/reel.h>
 #include <dcp/reel_picture_asset.h>
+#include <dcp/warnings.h>
 #include <asdcp/AS_DCP.h>
 #include <png.h>
 #include <sndfile.h>
@@ -55,12 +60,16 @@ extern "C" {
 }
 #define BOOST_TEST_DYN_LINK
 #define BOOST_TEST_MODULE dcpomatic_test
-#include <boost/test/unit_test.hpp>
 #include <boost/algorithm/string.hpp>
+LIBDCP_DISABLE_WARNINGS
+#include <boost/random.hpp>
+LIBDCP_ENABLE_WARNINGS
+#include <boost/test/unit_test.hpp>
 #include <iostream>
 #include <list>
 #include <vector>
 
+
 using std::abs;
 using std::cerr;
 using std::cout;
@@ -95,13 +104,12 @@ boost::filesystem::path TestPaths::xsd ()
 }
 
 
-void
+static void
 setup_test_config ()
 {
-       Config::instance()->set_master_encoding_threads (boost::thread::hardware_concurrency());
+       Config::instance()->set_master_encoding_threads (boost::thread::hardware_concurrency() / 2);
        Config::instance()->set_server_encoding_threads (1);
        Config::instance()->set_server_port_base (61921);
-       Config::instance()->set_default_isdcf_metadata (ISDCFMetadata ());
        Config::instance()->set_default_container (Ratio::from_id ("185"));
        Config::instance()->set_default_dcp_content_type (static_cast<DCPContentType*> (0));
        Config::instance()->set_default_audio_delay (0);
@@ -110,18 +118,23 @@ setup_test_config ()
        Config::instance()->set_default_still_length (10);
        Config::instance()->set_log_types (
                LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING |
-               LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_THREE_D |
-               LogEntry::TYPE_DEBUG_ENCODE | LogEntry::TYPE_DEBUG_PLAYER |
-               LogEntry::TYPE_DISK
+               LogEntry::TYPE_ERROR | LogEntry::TYPE_DISK
                );
        Config::instance()->set_automatic_audio_analysis (false);
+       auto signer = make_shared<dcp::CertificateChain>(dcp::file_to_string("test/data/signer_chain"));
+       signer->set_key(dcp::file_to_string("test/data/signer_key"));
+       Config::instance()->set_signer_chain (signer);
+       auto decryption = make_shared<dcp::CertificateChain>(dcp::file_to_string("test/data/decryption_chain"));
+       decryption->set_key(dcp::file_to_string("test/data/decryption_key"));
+       Config::instance()->set_decryption_chain (decryption);
 }
 
+
 class TestSignalManager : public SignalManager
 {
 public:
        /* No wakes in tests: we call ui_idle ourselves */
-       void wake_ui ()
+       void wake_ui () override
        {
 
        }
@@ -150,8 +163,10 @@ struct TestConfig
        }
 };
 
+
 BOOST_GLOBAL_FIXTURE (TestConfig);
 
+
 boost::filesystem::path
 test_film_dir (string name)
 {
@@ -162,6 +177,7 @@ test_film_dir (string name)
        return p;
 }
 
+
 shared_ptr<Film>
 new_test_film (string name)
 {
@@ -175,8 +191,9 @@ new_test_film (string name)
        return film;
 }
 
+
 shared_ptr<Film>
-new_test_film2 (string name, Cleanup* cleanup)
+new_test_film2 (string name, vector<shared_ptr<Content>> content, Cleanup* cleanup)
 {
        auto p = test_film_dir (name);
        if (boost::filesystem::exists (p)) {
@@ -190,9 +207,16 @@ new_test_film2 (string name, Cleanup* cleanup)
        film->set_dcp_content_type (DCPContentType::from_isdcf_name ("TST"));
        film->set_container (Ratio::from_id ("185"));
        film->write_metadata ();
+
+       for (auto i: content) {
+               film->examine_and_add_content (i);
+               BOOST_REQUIRE (!wait_for_jobs());
+       }
+
        return film;
 }
 
+
 void
 check_wav_file (boost::filesystem::path ref, boost::filesystem::path check)
 {
@@ -236,6 +260,7 @@ check_wav_file (boost::filesystem::path ref, boost::filesystem::path check)
        }
 }
 
+
 void
 check_mxf_audio_file (boost::filesystem::path ref, boost::filesystem::path check)
 {
@@ -343,13 +368,15 @@ static
 double
 rms_error (boost::filesystem::path ref, boost::filesystem::path check)
 {
-       FFmpegImageProxy ref_proxy (ref, VideoRange::FULL);
-       auto ref_image = ref_proxy.image().image;
-       FFmpegImageProxy check_proxy (check, VideoRange::FULL);
-       auto check_image = check_proxy.image().image;
+       FFmpegImageProxy ref_proxy (ref);
+       auto ref_image = ref_proxy.image(Image::Alignment::COMPACT).image;
+       FFmpegImageProxy check_proxy (check);
+       auto check_image = check_proxy.image(Image::Alignment::COMPACT).image;
+
+       BOOST_REQUIRE_EQUAL (ref_image->planes(), check_image->planes());
 
        BOOST_REQUIRE_EQUAL (ref_image->pixel_format(), check_image->pixel_format());
-       AVPixelFormat const format = ref_image->pixel_format();
+       auto const format = ref_image->pixel_format();
 
        BOOST_REQUIRE (ref_image->size() == check_image->size());
        int const width = ref_image->size().width;
@@ -396,6 +423,19 @@ rms_error (boost::filesystem::path ref, boost::filesystem::path check)
                        }
                        break;
                }
+               case AV_PIX_FMT_YUVJ420P:
+               {
+                       for (int c = 0; c < ref_image->planes(); ++c) {
+                               for (int y = 0; y < height / ref_image->vertical_factor(c); ++y) {
+                                       auto p = ref_image->data()[c] + y * ref_image->stride()[c];
+                                       auto q = check_image->data()[c] + y * check_image->stride()[c];
+                                       for (int x = 0; x < ref_image->line_size()[c]; ++x) {
+                                               sum_square += pow((*p++ - *q++), 2);
+                                       }
+                               }
+                       }
+                       break;
+               }
                default:
                        BOOST_REQUIRE_MESSAGE (false, "unrecognised pixel format " << format);
        }
@@ -426,39 +466,60 @@ check_file (boost::filesystem::path ref, boost::filesystem::path check)
 {
        auto N = boost::filesystem::file_size (ref);
        BOOST_CHECK_EQUAL (N, boost::filesystem::file_size (check));
-       auto ref_file = fopen_boost (ref, "rb");
+       dcp::File ref_file(ref, "rb");
        BOOST_CHECK (ref_file);
-       auto check_file = fopen_boost (check, "rb");
+       dcp::File check_file(check, "rb");
        BOOST_CHECK (check_file);
 
        int const buffer_size = 65536;
-       uint8_t* ref_buffer = new uint8_t[buffer_size];
-       uint8_t* check_buffer = new uint8_t[buffer_size];
+       std::vector<uint8_t> ref_buffer(buffer_size);
+       std::vector<uint8_t> check_buffer(buffer_size);
 
        string error = "File " + check.string() + " differs from reference " + ref.string();
 
        while (N) {
                uintmax_t this_time = min (uintmax_t (buffer_size), N);
-               size_t r = fread (ref_buffer, 1, this_time, ref_file);
+               size_t r = ref_file.read (ref_buffer.data(), 1, this_time);
                BOOST_CHECK_EQUAL (r, this_time);
-               r = fread (check_buffer, 1, this_time, check_file);
+               r = check_file.read(check_buffer.data(), 1, this_time);
                BOOST_CHECK_EQUAL (r, this_time);
 
-               BOOST_CHECK_MESSAGE (memcmp (ref_buffer, check_buffer, this_time) == 0, error);
-               if (memcmp (ref_buffer, check_buffer, this_time)) {
+               BOOST_CHECK_MESSAGE (memcmp (ref_buffer.data(), check_buffer.data(), this_time) == 0, error);
+               if (memcmp (ref_buffer.data(), check_buffer.data(), this_time)) {
                        break;
                }
 
                N -= this_time;
        }
+}
+
+
+void
+check_text_file (boost::filesystem::path ref, boost::filesystem::path check)
+{
+       dcp::File ref_file(ref, "r");
+       BOOST_CHECK (ref_file);
+       dcp::File check_file(check, "r");
+       BOOST_CHECK (check_file);
 
-       delete[] ref_buffer;
-       delete[] check_buffer;
+       int const buffer_size = std::max(
+               boost::filesystem::file_size(ref),
+               boost::filesystem::file_size(check)
+               );
+
+       DCPOMATIC_ASSERT (buffer_size < 1024 * 1024);
+
+       std::vector<uint8_t> ref_buffer(buffer_size);
+       auto ref_read = ref_file.read(ref_buffer.data(), 1, buffer_size);
+       std::vector<uint8_t> check_buffer(buffer_size);
+       auto check_read = check_file.read(check_buffer.data(), 1, buffer_size);
+       BOOST_CHECK_EQUAL (ref_read, check_read);
 
-       fclose (ref_file);
-       fclose (check_file);
+       string const error = "File " + check.string() + " differs from reference " + ref.string();
+       BOOST_CHECK_MESSAGE(memcmp(ref_buffer.data(), check_buffer.data(), ref_read) == 0, error);
 }
 
+
 static void
 note (dcp::NoteType t, string n)
 {
@@ -645,24 +706,22 @@ png_flush (png_structp)
 
 
 static void
-png_error_fn (png_structp png_ptr, char const * message)
+png_error_fn (png_structp, char const * message)
 {
-       reinterpret_cast<Image*>(png_get_error_ptr(png_ptr))->png_error (message);
+       throw EncodeError (String::compose("Error during PNG write: %1", message));
 }
 
 
 void
 write_image (shared_ptr<const Image> image, boost::filesystem::path file)
 {
-       int png_color_type = 0;
+       int png_color_type = PNG_COLOR_TYPE_RGB;
        int bits_per_pixel = 0;
        switch (image->pixel_format()) {
        case AV_PIX_FMT_RGB24:
-               png_color_type = PNG_COLOR_TYPE_RGB;
                bits_per_pixel = 8;
                break;
        case AV_PIX_FMT_XYZ12LE:
-               png_color_type = PNG_COLOR_TYPE_RGB;
                bits_per_pixel = 16;
                break;
        default:
@@ -682,9 +741,40 @@ write_image (shared_ptr<const Image> image, boost::filesystem::path file)
 
        png_set_IHDR (png_ptr, info_ptr, image->size().width, image->size().height, bits_per_pixel, png_color_type, PNG_INTERLACE_NONE, PNG_COMPRESSION_TYPE_DEFAULT, PNG_FILTER_TYPE_DEFAULT);
 
-       png_byte ** row_pointers = reinterpret_cast<png_byte **>(png_malloc(png_ptr, image->size().height * sizeof(png_byte *)));
-       for (int i = 0; i < image->size().height; ++i) {
-               row_pointers[i] = (png_byte *) (image->data()[0] + i * image->stride()[0]);
+       auto const width = image->size().width;
+       auto const height = image->size().height;
+       auto const stride = image->stride()[0];
+
+       vector<vector<uint8_t>> data_to_write(height);
+       for (int y = 0; y < height; ++y) {
+               data_to_write[y].resize(stride);
+       }
+
+       switch (image->pixel_format()) {
+       case AV_PIX_FMT_RGB24:
+               for (int y = 0; y < height; ++y) {
+                       memcpy(data_to_write[y].data(), image->data()[0] + y * stride, stride);
+               }
+               break;
+       case AV_PIX_FMT_XYZ12LE:
+               /* 16-bit pixel values must be written MSB first */
+               for (int y = 0; y < height; ++y) {
+                       data_to_write[y].resize(stride);
+                       uint8_t* original = image->data()[0] + y * stride;
+                       for (int x = 0; x < width * 3; ++x) {
+                               data_to_write[y][x * 2] = original[1];
+                               data_to_write[y][x * 2 + 1] = original[0];
+                               original += 2;
+                       }
+               }
+               break;
+       default:
+               break;
+       }
+
+       png_byte ** row_pointers = reinterpret_cast<png_byte**>(png_malloc(png_ptr, image->size().height * sizeof(png_byte *)));
+       for (int y = 0; y < height; ++y) {
+               row_pointers[y] = reinterpret_cast<png_byte*>(data_to_write[y].data());
        }
 
        png_write_info (png_ptr, info_ptr);
@@ -734,25 +824,21 @@ check_one_frame (boost::filesystem::path dcp_dir, int64_t index, boost::filesyst
 boost::filesystem::path
 dcp_file (shared_ptr<const Film> film, string prefix)
 {
-       auto i = boost::filesystem::directory_iterator (film->dir(film->dcp_name()));
-       while (i != boost::filesystem::directory_iterator() && !boost::algorithm::starts_with (i->path().leaf().string(), prefix)) {
+       auto i = boost::filesystem::recursive_directory_iterator(film->dir(film->dcp_name()));
+       while (i != boost::filesystem::recursive_directory_iterator() && !boost::algorithm::starts_with(i->path().leaf().string(), prefix)) {
                ++i;
        }
 
-       BOOST_REQUIRE (i != boost::filesystem::directory_iterator());
+       BOOST_REQUIRE_MESSAGE(i != boost::filesystem::recursive_directory_iterator(), "Could not find file with prefix " << prefix);
        return i->path();
 }
 
 boost::filesystem::path
 subtitle_file (shared_ptr<Film> film)
 {
-       for (auto i: boost::filesystem::directory_iterator(film->directory().get() / film->dcp_name (false))) {
-               if (boost::filesystem::is_directory(i.path())) {
-                       for (auto j: boost::filesystem::directory_iterator(i.path())) {
-                               if (boost::algorithm::starts_with(j.path().leaf().string(), "sub_")) {
-                                       return j.path();
-                               }
-                       }
+       for (auto i: boost::filesystem::recursive_directory_iterator(film->directory().get() / film->dcp_name(false))) {
+               if (boost::algorithm::starts_with(i.path().leaf().string(), "sub_")) {
+                       return i.path();
                }
        }
 
@@ -761,16 +847,22 @@ subtitle_file (shared_ptr<Film> film)
        return boost::filesystem::path("/");
 }
 
+
 void
 make_random_file (boost::filesystem::path path, size_t size)
 {
-       auto t = fopen_boost(path, "wb");
-       BOOST_REQUIRE (t);
-       for (size_t i = 0; i < size; ++i) {
-               uint8_t r = rand() & 0xff;
-               fwrite (&r, 1, 1, t);
+       dcp::File random_file(path, "wb");
+       BOOST_REQUIRE (random_file);
+
+       boost::random::mt19937 rng(1);
+       boost::random::uniform_int_distribution<uint64_t> dist(0);
+
+       while (size > 0) {
+               auto this_time = std::min(size, size_t(8));
+               uint64_t random = dist(rng);
+               random_file.write(&random, this_time, 1);
+               size -= this_time;
        }
-       fclose (t);
 }
 
 
@@ -830,3 +922,61 @@ Cleanup::run ()
                boost::filesystem::remove_all (i, ec);
        }
 }
+
+
+void stage (string, boost::optional<boost::filesystem::path>) {}
+void progress (float) {}
+
+
+void
+make_and_verify_dcp (shared_ptr<Film> film, vector<dcp::VerificationNote::Code> ignore)
+{
+       film->write_metadata ();
+       make_dcp (film, TranscodeJob::ChangedBehaviour::IGNORE);
+       BOOST_REQUIRE (!wait_for_jobs());
+       auto notes = dcp::verify ({film->dir(film->dcp_name())}, &stage, &progress, TestPaths::xsd());
+       bool ok = true;
+       for (auto i: notes) {
+               if (find(ignore.begin(), ignore.end(), i.code()) == ignore.end()) {
+                       std::cout << "\t" << dcp::note_to_string(i) << "\n";
+                       ok = false;
+               }
+       }
+       BOOST_CHECK(ok);
+}
+
+
+void
+check_int_close (int a, int b, int d)
+{
+       BOOST_CHECK_MESSAGE (std::abs(a - b) < d, a << " differs from " << b << " by more than " << d);
+}
+
+
+void
+check_int_close (std::pair<int, int> a, std::pair<int, int> b, int d)
+{
+       check_int_close (a.first, b.first, d);
+       check_int_close (a.second, b.second, d);
+}
+
+
+ConfigRestorer::~ConfigRestorer()
+{
+       setup_test_config();
+}
+
+
+boost::filesystem::path
+find_file (boost::filesystem::path dir, string filename_part)
+{
+       boost::optional<boost::filesystem::path> found;
+       for (auto i: boost::filesystem::directory_iterator(dir)) {
+               if (i.path().filename().string().find(filename_part) != string::npos) {
+                       BOOST_REQUIRE (!found);
+                       found = i;
+               }
+       }
+       BOOST_REQUIRE (found);
+       return *found;
+}