Cleanup: move EqualityOptions into its own file.
[libdcp.git] / test / dcp_test.cc
index 4e667364010907ab4fb7aa057e5379e0b8285c14..5456092c9838ae1844adebb1c85a84230a15037e 100644 (file)
     files in the program, then also delete it here.
 */
 
+
+#include "atmos_asset.h"
+#include "compose.hpp"
+#include "cpl.h"
 #include "dcp.h"
+#include "equality_options.h"
 #include "metadata.h"
-#include "cpl.h"
 #include "mono_picture_asset.h"
-#include "stereo_picture_asset.h"
 #include "picture_asset_writer.h"
-#include "reel_picture_asset.h"
-#include "sound_asset_writer.h"
-#include "sound_asset.h"
-#include "atmos_asset.h"
 #include "reel.h"
-#include "test.h"
-#include "reel_mono_picture_asset.h"
-#include "reel_stereo_picture_asset.h"
-#include "reel_sound_asset.h"
 #include "reel_atmos_asset.h"
 #include "reel_markers_asset.h"
+#include "reel_mono_picture_asset.h"
+#include "reel_picture_asset.h"
+#include "reel_sound_asset.h"
+#include "reel_stereo_picture_asset.h"
+#include "sound_asset.h"
+#include "sound_asset_writer.h"
+#include "stereo_picture_asset.h"
+#include "test.h"
 #include <asdcp/KM_util.h>
 #include <sndfile.h>
 #include <boost/test/unit_test.hpp>
 
-using std::string;
-using std::vector;
+
 using std::dynamic_pointer_cast;
-using std::shared_ptr;
 using std::make_shared;
+using std::shared_ptr;
+using std::string;
+using std::vector;
 #if BOOST_VERSION >= 106100
 using namespace boost::placeholders;
 #endif
@@ -67,9 +71,12 @@ BOOST_AUTO_TEST_CASE (dcp_test1)
 {
        RNGFixer fixer;
 
-       make_simple("build/test/DCP/dcp_test1")->write_xml(
-               "OpenDCP 0.0.25", "OpenDCP 0.0.25", "2012-07-17T04:45:18+00:00", "A Test DCP"
-               );
+       auto dcp = make_simple("build/test/DCP/dcp_test1");
+       dcp->set_issuer("OpenDCP 0.0.25");
+       dcp->set_creator("OpenDCP 0.0.25");
+       dcp->set_issue_date("2012-07-17T04:45:18+00:00");
+       dcp->set_annotation_text("A Test DCP");
+       dcp->write_xml();
 
        /* build/test/DCP/dcp_test1 is checked against test/ref/DCP/dcp_test1 by run/tests */
 }
@@ -100,7 +107,7 @@ BOOST_AUTO_TEST_CASE (dcp_test2)
 
        auto mp = make_shared<dcp::StereoPictureAsset>(dcp::Fraction (24, 1), dcp::Standard::SMPTE);
        mp->set_metadata (mxf_meta);
-       auto picture_writer = mp->start_write ("build/test/DCP/dcp_test2/video.mxf", false);
+       auto picture_writer = mp->start_write("build/test/DCP/dcp_test2/video.mxf", dcp::PictureAsset::Behaviour::MAKE_NEW);
        dcp::ArrayData j2c ("test/data/flat_red.j2c");
        for (int i = 0; i < 24; ++i) {
                /* Left */
@@ -112,7 +119,7 @@ BOOST_AUTO_TEST_CASE (dcp_test2)
 
        auto ms = make_shared<dcp::SoundAsset>(dcp::Fraction(24, 1), 48000, 1, dcp::LanguageTag("en-GB"), dcp::Standard::SMPTE);
        ms->set_metadata (mxf_meta);
-       auto sound_writer = ms->start_write ("build/test/DCP/dcp_test2/audio.mxf");
+       auto sound_writer = ms->start_write("build/test/DCP/dcp_test2/audio.mxf", {}, dcp::SoundAsset::AtmosSync::DISABLED, dcp::SoundAsset::MCASubDescriptors::ENABLED);
 
        SF_INFO info;
        info.format = 0;
@@ -123,7 +130,7 @@ BOOST_AUTO_TEST_CASE (dcp_test2)
        channels[0] = buffer;
        while (true) {
                auto N = sf_readf_float (sndfile, buffer, 4096);
-               sound_writer->write (channels, N);
+               sound_writer->write(channels, 1, N);
                if (N < 4096) {
                        break;
                }
@@ -138,7 +145,11 @@ BOOST_AUTO_TEST_CASE (dcp_test2)
 
        d.add (cpl);
 
-       d.write_xml ("OpenDCP 0.0.25", "OpenDCP 0.0.25", "2012-07-17T04:45:18+00:00", "Created by libdcp");
+       d.set_issuer("OpenDCP 0.0.25");
+       d.set_creator("OpenDCP 0.0.25");
+       d.set_issue_date("2012-07-17T04:45:18+00:00");
+       d.set_annotation_text("Created by libdcp");
+       d.write_xml();
 
        /* build/test/DCP/dcp_test2 is checked against test/ref/DCP/dcp_test2 by run/tests */
 }
@@ -199,7 +210,7 @@ test_rewriting_sound(string name, bool modify)
 
        auto reader = A_sound->asset()->start_read();
        auto sound = make_shared<dcp::SoundAsset>(A_sound->asset()->edit_rate(), A_sound->asset()->sampling_rate(), A_sound->asset()->channels(), dcp::LanguageTag("en-US"), dcp::Standard::SMPTE);
-       auto writer = sound->start_write(path("build") / "test" / name / "pcm_8246f87f-e1df-4c42-a290-f3b3069ff021.mxf", {});
+       auto writer = sound->start_write(path("build") / "test" / name / "pcm_8246f87f-e1df-4c42-a290-f3b3069ff021.mxf", {}, dcp::SoundAsset::AtmosSync::DISABLED, dcp::SoundAsset::MCASubDescriptors::ENABLED);
 
        bool need_to_modify = modify;
        for (int i = 0; i < A_sound->asset()->intrinsic_duration(); ++i) {
@@ -217,7 +228,7 @@ test_rewriting_sound(string name, bool modify)
                                }
                        }
                }
-               writer->write (out, sf->samples());
+               writer->write(out, sf->channels(), sf->samples());
                for (int j = 0; j < sf->channels(); ++j) {
                        delete[] out[j];
                }
@@ -281,7 +292,7 @@ BOOST_AUTO_TEST_CASE (dcp_test5)
 
        auto mp = make_shared<dcp::MonoPictureAsset>(dcp::Fraction (24, 1), dcp::Standard::SMPTE);
        mp->set_metadata (mxf_meta);
-       shared_ptr<dcp::PictureAssetWriter> picture_writer = mp->start_write ("build/test/DCP/dcp_test5/video.mxf", false);
+       auto picture_writer = mp->start_write("build/test/DCP/dcp_test5/video.mxf", dcp::PictureAsset::Behaviour::MAKE_NEW);
        dcp::ArrayData j2c ("test/data/flat_red.j2c");
        for (int i = 0; i < 24; ++i) {
                picture_writer->write (j2c.data (), j2c.size ());
@@ -290,7 +301,7 @@ BOOST_AUTO_TEST_CASE (dcp_test5)
 
        auto ms = make_shared<dcp::SoundAsset>(dcp::Fraction(24, 1), 48000, 1, dcp::LanguageTag("en-GB"), dcp::Standard::SMPTE);
        ms->set_metadata (mxf_meta);
-       auto sound_writer = ms->start_write ("build/test/DCP/dcp_test5/audio.mxf");
+       auto sound_writer = ms->start_write("build/test/DCP/dcp_test5/audio.mxf", {}, dcp::SoundAsset::AtmosSync::DISABLED, dcp::SoundAsset::MCASubDescriptors::ENABLED);
 
        SF_INFO info;
        info.format = 0;
@@ -301,7 +312,7 @@ BOOST_AUTO_TEST_CASE (dcp_test5)
        channels[0] = buffer;
        while (true) {
                sf_count_t N = sf_readf_float (sndfile, buffer, 4096);
-               sound_writer->write (channels, N);
+               sound_writer->write(channels, 1, N);
                if (N < 4096) {
                        break;
                }
@@ -309,21 +320,23 @@ BOOST_AUTO_TEST_CASE (dcp_test5)
 
        sound_writer->finalize ();
 
-       shared_ptr<dcp::AtmosAsset> am (new dcp::AtmosAsset (private_test / "20160218_NameOfFilm_FTR_OV_EN_A_dcs_r01.mxf"));
+       auto am = make_shared<dcp::AtmosAsset>(private_test / "20160218_NameOfFilm_FTR_OV_EN_A_dcs_r01.mxf");
 
-       cpl->add (shared_ptr<dcp::Reel> (
-                         new dcp::Reel (
-                                 shared_ptr<dcp::ReelMonoPictureAsset> (new dcp::ReelMonoPictureAsset (mp, 0)),
-                                 shared_ptr<dcp::ReelSoundAsset> (new dcp::ReelSoundAsset (ms, 0)),
-                                 shared_ptr<dcp::ReelSubtitleAsset> (),
-                                 shared_ptr<dcp::ReelMarkersAsset> (),
-                                 shared_ptr<dcp::ReelAtmosAsset> (new dcp::ReelAtmosAsset (am, 0))
-                                 )
-                         ));
+       cpl->add(make_shared<dcp::Reel>(
+                       make_shared<dcp::ReelMonoPictureAsset>(mp, 0),
+                       make_shared<dcp::ReelSoundAsset>(ms, 0),
+                       shared_ptr<dcp::ReelSubtitleAsset>(),
+                       shared_ptr<dcp::ReelMarkersAsset>(),
+                       make_shared<dcp::ReelAtmosAsset>(am, 0)
+                       ));
 
        d.add (cpl);
 
-       d.write_xml ("OpenDCP 0.0.25", "OpenDCP 0.0.25", "2012-07-17T04:45:18+00:00", "Created by libdcp");
+       d.set_issuer("OpenDCP 0.0.25");
+       d.set_creator("OpenDCP 0.0.25");
+       d.set_issue_date("2012-07-17T04:45:18+00:00");
+       d.set_annotation_text("Created by libdcp");
+       d.write_xml();
 
        /* build/test/DCP/dcp_test5 is checked against test/ref/DCP/dcp_test5 by run/tests */
 }
@@ -334,8 +347,8 @@ BOOST_AUTO_TEST_CASE (dcp_test6)
        dcp::DCP dcp ("test/ref/DCP/dcp_test5");
        dcp.read ();
 
-       BOOST_REQUIRE_EQUAL (dcp.cpls().size(), 1);
-       BOOST_REQUIRE_EQUAL (dcp.cpls().front()->reels().size(), 1);
+       BOOST_REQUIRE_EQUAL (dcp.cpls().size(), 1U);
+       BOOST_REQUIRE_EQUAL (dcp.cpls()[0]->reels().size(), 1U);
        BOOST_CHECK (dcp.cpls().front()->reels().front()->main_picture());
        BOOST_CHECK (dcp.cpls().front()->reels().front()->main_sound());
        BOOST_CHECK (!dcp.cpls().front()->reels().front()->main_subtitle());
@@ -347,9 +360,12 @@ BOOST_AUTO_TEST_CASE (dcp_test7)
 {
        RNGFixer fix;
 
-       make_simple("build/test/DCP/dcp_test7", 1, 24, dcp::Standard::INTEROP)->write_xml(
-               "OpenDCP 0.0.25", "OpenDCP 0.0.25", "2012-07-17T04:45:18+00:00", "Created by libdcp"
-               );
+       auto dcp = make_simple("build/test/DCP/dcp_test7", 1, 24, dcp::Standard::INTEROP);
+       dcp->set_issuer("OpenDCP 0.0.25");
+       dcp->set_creator("OpenDCP 0.0.25");
+       dcp->set_issue_date("2012-07-17T04:45:18+00:00");
+       dcp->set_annotation_text("Created by libdcp");
+       dcp->write_xml();
 
        /* build/test/DCP/dcp_test7 is checked against test/ref/DCP/dcp_test7 by run/tests */
 }
@@ -360,7 +376,7 @@ BOOST_AUTO_TEST_CASE (dcp_test8)
        dcp::DCP dcp (private_test / "data/SMPTE_TST-B1PB2P_S_EN-EN-CCAP_5171-HI-VI_2K_ISDCF_20151123_DPPT_SMPTE_combo/");
        dcp.read ();
 
-       BOOST_REQUIRE_EQUAL (dcp.cpls().size(), 2);
+       BOOST_REQUIRE_EQUAL (dcp.cpls().size(), 2U);
 }
 
 
@@ -425,3 +441,106 @@ BOOST_AUTO_TEST_CASE (dcp_with_mixed_cpls)
        dcp.add(make_shared<dcp::CPL>("", dcp::ContentKind::FEATURE, dcp::Standard::SMPTE));
        BOOST_REQUIRE_THROW (dcp.write_xml(), dcp::MiscError);
 }
+
+
+BOOST_AUTO_TEST_CASE (dcp_add_kdm_test)
+{
+       /* Some CPLs, each with a reel */
+
+       shared_ptr<dcp::CPL> cpls[] = {
+               make_shared<dcp::CPL>("", dcp::ContentKind::FEATURE, dcp::Standard::SMPTE),
+               make_shared<dcp::CPL>("", dcp::ContentKind::FEATURE, dcp::Standard::SMPTE),
+               make_shared<dcp::CPL>("", dcp::ContentKind::FEATURE, dcp::Standard::SMPTE)
+       };
+
+       shared_ptr<dcp::Reel> reels[] = {
+               make_shared<dcp::Reel>(),
+               make_shared<dcp::Reel>(),
+               make_shared<dcp::Reel>()
+       };
+
+       for (auto i = 0; i < 3; ++i) {
+               cpls[i]->add(reels[i]);
+       }
+
+       dcp::DCP dcp ("build/test/dcp_add_kdm_test");
+       dcp.add(cpls[0]);
+       dcp.add(cpls[1]);
+       dcp.add(cpls[2]);
+
+       /* Simple KDM with one key that should be given to cpls[0] */
+
+       auto kdm_1 = dcp::DecryptedKDM({}, {}, "", "", "");
+       auto kdm_1_uuid = dcp::make_uuid();
+       kdm_1.add_key (dcp::DecryptedKDMKey(string("MDIK"), kdm_1_uuid, dcp::Key(), cpls[0]->id(), dcp::Standard::SMPTE));
+       dcp.add (kdm_1);
+       BOOST_REQUIRE_EQUAL (reels[0]->_kdms.size(), 1U);
+       BOOST_CHECK_EQUAL (reels[0]->_kdms[0].keys().size(), 1U);
+       BOOST_CHECK_EQUAL (reels[0]->_kdms[0].keys()[0].id(), kdm_1_uuid);
+       BOOST_CHECK_EQUAL (reels[1]->_kdms.size(), 0U);
+       BOOST_CHECK_EQUAL (reels[2]->_kdms.size(), 0U);
+
+       /* KDM with two keys that should be given to cpls[1] and cpls[2] */
+
+       auto kdm_2 = dcp::DecryptedKDM({}, {}, "", "", "");
+       auto kdm_2_uuid_1 = dcp::make_uuid();
+       kdm_2.add_key (dcp::DecryptedKDMKey(string("MDIK"), kdm_2_uuid_1, dcp::Key(), cpls[1]->id(), dcp::Standard::SMPTE));
+       auto kdm_2_uuid_2 = dcp::make_uuid();
+       kdm_2.add_key (dcp::DecryptedKDMKey(string("MDIK"), kdm_2_uuid_2, dcp::Key(), cpls[2]->id(), dcp::Standard::SMPTE));
+       dcp.add (kdm_2);
+       /* Unchanged from previous test */
+       BOOST_CHECK (reels[0]->_kdms.size() == 1);
+       /* kdm_2 should have been added to both the other CPLs */
+       BOOST_REQUIRE_EQUAL (reels[1]->_kdms.size(), 1U);
+       BOOST_REQUIRE_EQUAL (reels[1]->_kdms[0].keys().size(), 2U);
+       BOOST_CHECK_EQUAL (reels[1]->_kdms[0].keys()[0].id(), kdm_2_uuid_1);
+       BOOST_CHECK_EQUAL (reels[1]->_kdms[0].keys()[1].id(), kdm_2_uuid_2);
+       BOOST_REQUIRE_EQUAL (reels[2]->_kdms.size(), 1U);
+       BOOST_REQUIRE_EQUAL (reels[2]->_kdms[0].keys().size(), 2U);
+       BOOST_CHECK_EQUAL (reels[2]->_kdms[0].keys()[0].id(), kdm_2_uuid_1);
+       BOOST_CHECK_EQUAL (reels[2]->_kdms[0].keys()[1].id(), kdm_2_uuid_2);
+}
+
+
+BOOST_AUTO_TEST_CASE(hashes_preserved_when_loading_corrupted_dcp)
+{
+       boost::filesystem::path const dir = "build/test/hashes_preserved_when_loading_corrupted_dcp";
+       boost::filesystem::remove_all(dir);
+
+       auto dcp = make_simple(dir / "1");
+       dcp->write_xml();
+
+       auto asset_1_id = dcp::MonoPictureAsset(dir / "1" / "video.mxf").id();
+       auto asset_1_hash = dcp::MonoPictureAsset(dir / "1" / "video.mxf").hash();
+
+       /* Replace the hash in the CPL (the one that corresponds to the actual file)
+        * with an incorrect one new_hash.
+        */
+       string new_hash;
+       {
+               Editor editor(find_file(dir / "1", "cpl_"));
+               auto const after = "<Duration>24</Duration>";
+               editor.delete_lines_after(after, 1);
+
+               if (asset_1_hash[0] == 'A') {
+                       new_hash = 'B' + asset_1_hash.substr(1);
+               } else {
+                       new_hash = 'A' + asset_1_hash.substr(1);
+               }
+
+               editor.insert(after, dcp::String::compose("      <Hash>%1</Hash>", new_hash));
+       }
+
+       dcp::DCP read_back(dir / "1");
+       read_back.read();
+
+       BOOST_REQUIRE_EQUAL(read_back.cpls().size(), 1U);
+       auto cpl = read_back.cpls()[0];
+       BOOST_REQUIRE_EQUAL(cpl->reels().size(), 1U);
+       auto reel = cpl->reels()[0];
+       BOOST_REQUIRE(reel->main_picture());
+       /* Now the asset should think it has the wrong hash written to the PKL file; it shouldn't have
+        * checked the file again.
+        */
+       BOOST_CHECK_EQUAL(reel->main_picture()->asset_ref()->hash(), new_hash);
+}