Supporters update.
[dcpomatic.git] / test / file_naming_test.cc
index d0db2f30a4a05743e403d6644a2b29174eeee835..1b5871bd2c80d008dbc738a9fa1a885066fdefc4 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2016-2020 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2016-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
+
 /** @file  test/file_naming_test.cc
  *  @brief Test how files in DCPs are named.
- *  @ingroup specific
+ *  @ingroup feature
  */
 
+
 #include "test.h"
 #include "lib/config.h"
-#include "lib/film.h"
-#include "lib/ffmpeg_content.h"
+#include "lib/content_factory.h"
 #include "lib/dcp_content_type.h"
+#include "lib/ffmpeg_content.h"
+#include "lib/film.h"
 #include "lib/video_content.h"
 #ifdef DCPOMATIC_WINDOWS
 #include <boost/locale.hpp>
 #include <boost/test/unit_test.hpp>
 #include <boost/regex.hpp>
 
+
+using std::make_shared;
 using std::string;
-using boost::shared_ptr;
 
-class Keep
-{
-public:
-       Keep ()
-       {
-               _format = Config::instance()->dcp_asset_filename_format ();
-       }
 
-       ~Keep ()
-       {
-               Config::instance()->set_dcp_asset_filename_format (_format);
-       }
-
-private:
-       dcp::NameFormat _format;
+static
+string
+mxf_regex(string part) {
+#ifdef DCPOMATIC_WINDOWS
+       /* Windows replaces . in filenames with _ */
+       return String::compose(".*flat_%1_png_.*\\.mxf", part);
+#else
+       return String::compose(".*flat_%1\\.png_.*\\.mxf", part);
+#endif
 };
 
+
+
 BOOST_AUTO_TEST_CASE (file_naming_test)
 {
-       Keep k;
-       Config::instance()->set_dcp_asset_filename_format (dcp::NameFormat ("%c"));
+       ConfigRestorer cr;
+       Config::instance()->set_dcp_asset_filename_format (dcp::NameFormat("%c"));
 
-       shared_ptr<Film> film = new_test_film ("file_naming_test");
+       auto film = new_test_film ("file_naming_test");
        film->set_name ("file_naming_test");
        film->set_video_frame_rate (24);
        film->set_dcp_content_type (DCPContentType::from_isdcf_name ("FTR"));
-       shared_ptr<FFmpegContent> r (new FFmpegContent("test/data/flat_red.png"));
+       auto r = make_shared<FFmpegContent>("test/data/flat_red.png");
        film->examine_and_add_content (r);
-       shared_ptr<FFmpegContent> g (new FFmpegContent("test/data/flat_green.png"));
+       auto g = make_shared<FFmpegContent>("test/data/flat_green.png");
        film->examine_and_add_content (g);
-       shared_ptr<FFmpegContent> b (new FFmpegContent("test/data/flat_blue.png"));
+       auto b = make_shared<FFmpegContent>("test/data/flat_blue.png");
        film->examine_and_add_content (b);
        BOOST_REQUIRE (!wait_for_jobs());
 
        r->set_position (film, dcpomatic::DCPTime::from_seconds(0));
-       r->set_video_frame_rate (24);
+       r->set_video_frame_rate(film, 24);
        r->video->set_length (24);
        g->set_position (film, dcpomatic::DCPTime::from_seconds(1));
-       g->set_video_frame_rate (24);
+       g->set_video_frame_rate(film, 24);
        g->video->set_length (24);
        b->set_position (film, dcpomatic::DCPTime::from_seconds(2));
-       b->set_video_frame_rate (24);
+       b->set_video_frame_rate(film, 24);
        b->video->set_length (24);
 
-       film->set_reel_type (REELTYPE_BY_VIDEO_CONTENT);
+       film->set_reel_type (ReelType::BY_VIDEO_CONTENT);
        film->write_metadata ();
-       film->make_dcp ();
-       BOOST_REQUIRE (!wait_for_jobs());
+       make_and_verify_dcp (
+               film,
+               {
+                       dcp::VerificationNote::Code::MISSING_FFMC_IN_FEATURE,
+                       dcp::VerificationNote::Code::MISSING_FFEC_IN_FEATURE
+               });
 
        int got[3] = { 0, 0, 0 };
-       for (
-               boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->file(film->dcp_name()));
-               i != boost::filesystem::directory_iterator();
-               ++i) {
-               if (boost::regex_match(i->path().string(), boost::regex(".*flat_red\\.png_.*\\.mxf"))) {
+       for (auto i: boost::filesystem::directory_iterator(film->file(film->dcp_name()))) {
+               if (boost::regex_match(i.path().string(), boost::regex(mxf_regex("red")))) {
                        ++got[0];
-               } else if (boost::regex_match(i->path().string(), boost::regex(".*flat_green\\.png_.*\\.mxf"))) {
+               } else if (boost::regex_match(i.path().string(), boost::regex(mxf_regex("green")))) {
                        ++got[1];
-               } else if (boost::regex_match(i->path().string(), boost::regex(".*flat_blue\\.png_.*\\.mxf"))) {
+               } else if (boost::regex_match(i.path().string(), boost::regex(mxf_regex("blue")))) {
                        ++got[2];
                }
        }
@@ -106,12 +108,14 @@ BOOST_AUTO_TEST_CASE (file_naming_test)
        }
 }
 
+
 BOOST_AUTO_TEST_CASE (file_naming_test2)
 {
-       Keep k;
+       ConfigRestorer cr;
+
        Config::instance()->set_dcp_asset_filename_format (dcp::NameFormat ("%c"));
 
-       shared_ptr<Film> film = new_test_film ("file_naming_test2");
+       auto film = new_test_film ("file_naming_test2");
        film->set_name ("file_naming_test2");
        film->set_dcp_content_type (DCPContentType::from_isdcf_name ("FTR"));
 
@@ -121,38 +125,39 @@ BOOST_AUTO_TEST_CASE (file_naming_test2)
        boost::filesystem::path::imbue(std::locale());
 #endif
 
-       shared_ptr<FFmpegContent> r (new FFmpegContent("test/data/flät_red.png"));
+       auto r = make_shared<FFmpegContent>("test/data/flät_red.png");
        film->examine_and_add_content (r);
-       shared_ptr<FFmpegContent> g (new FFmpegContent("test/data/flat_green.png"));
+       auto g = make_shared<FFmpegContent>("test/data/flat_green.png");
        film->examine_and_add_content (g);
-       shared_ptr<FFmpegContent> b (new FFmpegContent("test/data/flat_blue.png"));
+       auto b = make_shared<FFmpegContent>("test/data/flat_blue.png");
        film->examine_and_add_content (b);
        BOOST_REQUIRE (!wait_for_jobs());
 
        r->set_position (film, dcpomatic::DCPTime::from_seconds(0));
-       r->set_video_frame_rate (24);
+       r->set_video_frame_rate(film, 24);
        r->video->set_length (24);
        g->set_position (film, dcpomatic::DCPTime::from_seconds(1));
-       g->set_video_frame_rate (24);
+       g->set_video_frame_rate(film, 24);
        g->video->set_length (24);
        b->set_position (film, dcpomatic::DCPTime::from_seconds(2));
-       b->set_video_frame_rate (24);
+       b->set_video_frame_rate(film, 24);
        b->video->set_length (24);
 
-       film->set_reel_type (REELTYPE_BY_VIDEO_CONTENT);
-       film->make_dcp ();
-       BOOST_REQUIRE (!wait_for_jobs());
+       film->set_reel_type (ReelType::BY_VIDEO_CONTENT);
+       make_and_verify_dcp (
+               film,
+               {
+                       dcp::VerificationNote::Code::MISSING_FFMC_IN_FEATURE,
+                       dcp::VerificationNote::Code::MISSING_FFEC_IN_FEATURE
+               });
 
        int got[3] = { 0, 0, 0 };
-       for (
-               boost::filesystem::directory_iterator i = boost::filesystem::directory_iterator (film->file(film->dcp_name()));
-               i != boost::filesystem::directory_iterator();
-               ++i) {
-               if (boost::regex_match(i->path().string(), boost::regex(".*flt_red\\.png_.*\\.mxf"))) {
+       for (auto i: boost::filesystem::directory_iterator (film->file(film->dcp_name()))) {
+               if (boost::regex_match(i.path().string(), boost::regex(mxf_regex("red")))) {
                        ++got[0];
-               } else if (boost::regex_match(i->path().string(), boost::regex(".*flat_green\\.png_.*\\.mxf"))) {
+               } else if (boost::regex_match(i.path().string(), boost::regex(mxf_regex("green")))) {
                        ++got[1];
-               } else if (boost::regex_match(i->path().string(), boost::regex(".*flat_blue\\.png_.*\\.mxf"))) {
+               } else if (boost::regex_match(i.path().string(), boost::regex(mxf_regex("blue")))) {
                        ++got[2];
                }
        }
@@ -161,3 +166,54 @@ BOOST_AUTO_TEST_CASE (file_naming_test2)
                BOOST_CHECK (got[i] == 2);
        }
 }
+
+
+BOOST_AUTO_TEST_CASE (subtitle_file_naming)
+{
+       ConfigRestorer cr;
+
+       Config::instance()->set_dcp_asset_filename_format(dcp::NameFormat("%t ostrabagalous %c"));
+
+       auto content = content_factory("test/data/15s.srt");
+       auto film = new_test_film2("subtitle_file_naming", content);
+       film->set_interop(false);
+
+       make_and_verify_dcp (
+               film,
+               {
+                       dcp::VerificationNote::Code::MISSING_CPL_METADATA,
+                       dcp::VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE,
+                       dcp::VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME,
+               });
+
+       int got = 0;
+
+       for (auto i: boost::filesystem::directory_iterator(film->file(film->dcp_name()))) {
+               if (boost::regex_match(i.path().filename().string(), boost::regex("sub_ostrabagalous_15s.*\\.mxf"))) {
+                       ++got;
+               }
+       }
+
+       BOOST_CHECK_EQUAL(got, 1);
+}
+
+
+BOOST_AUTO_TEST_CASE(remove_bad_characters_from_template)
+{
+       ConfigRestorer cr;
+
+       /* %z is not recognised, so the % should be discarded so it won't trip
+        * an invalid URI check in make_and_verify_dcp
+        */
+       Config::instance()->set_dcp_asset_filename_format(dcp::NameFormat("%c%z"));
+
+       auto content = content_factory("test/data/flat_red.png");
+       auto film = new_test_film2("remove_bad_characters_from_template", content);
+       make_and_verify_dcp(
+               film,
+               {
+                       dcp::VerificationNote::Code::MISSING_FFMC_IN_FEATURE,
+                       dcp::VerificationNote::Code::MISSING_FFEC_IN_FEATURE
+               });
+}
+