Replace std::list with std::vector in the API.
[libdcp.git] / src / verify.cc
index bbae1ba4e76de1cdb3c5182aefd9d30bbefc2ffd..a72fb0d276bb02dbf28a737e8204ce2abf0ca36d 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2018-2020 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2018-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
 #include <xercesc/framework/LocalFileInputSource.hpp>
 #include <xercesc/framework/MemBufInputSource.hpp>
 #include <boost/noncopyable.hpp>
-#include <boost/foreach.hpp>
 #include <boost/algorithm/string.hpp>
 #include <map>
-#include <list>
 #include <vector>
 #include <iostream>
 
@@ -233,8 +231,8 @@ public:
                if (!system_id) {
                        return 0;
                }
-               string system_id_str = xml_ch_to_string (system_id);
-               boost::filesystem::path p = _xsd_dtd_directory;
+               auto system_id_str = xml_ch_to_string (system_id);
+               auto p = _xsd_dtd_directory;
                if (_files.find(system_id_str) == _files.end()) {
                        p /= system_id_str;
                } else {
@@ -272,7 +270,7 @@ parse (XercesDOMParser& parser, std::string xml)
 
 template <class T>
 void
-validate_xml (T xml, boost::filesystem::path xsd_dtd_directory, list<VerificationNote>& notes)
+validate_xml (T xml, boost::filesystem::path xsd_dtd_directory, vector<VerificationNote>& notes)
 {
        try {
                XMLPlatformUtils::Initialize ();
@@ -316,7 +314,7 @@ validate_xml (T xml, boost::filesystem::path xsd_dtd_directory, list<Verificatio
                 * they describe are not checked.
                 */
                string locations;
-               BOOST_FOREACH (string i, schema) {
+               for (auto i: schema) {
                        locations += String::compose("%1 %1 ", i, i);
                }
 
@@ -341,7 +339,7 @@ validate_xml (T xml, boost::filesystem::path xsd_dtd_directory, list<Verificatio
 
        XMLPlatformUtils::Terminate ();
 
-       BOOST_FOREACH (XMLValidationError i, error_handler.errors()) {
+       for (auto i: error_handler.errors()) {
                notes.push_back (
                        VerificationNote(
                                VerificationNote::VERIFY_ERROR,
@@ -365,16 +363,16 @@ enum VerifyAssetResult {
 static VerifyAssetResult
 verify_asset (shared_ptr<const DCP> dcp, shared_ptr<const ReelMXF> reel_mxf, function<void (float)> progress)
 {
-       string const actual_hash = reel_mxf->asset_ref()->hash(progress);
+       auto const actual_hash = reel_mxf->asset_ref()->hash(progress);
 
-       list<shared_ptr<PKL> > pkls = dcp->pkls();
+       auto pkls = dcp->pkls();
        /* We've read this DCP in so it must have at least one PKL */
        DCP_ASSERT (!pkls.empty());
 
-       shared_ptr<Asset> asset = reel_mxf->asset_ref().asset();
+       auto asset = reel_mxf->asset_ref().asset();
 
        optional<string> pkl_hash;
-       BOOST_FOREACH (shared_ptr<PKL> i, pkls) {
+       for (auto i: pkls) {
                pkl_hash = i->hash (reel_mxf->asset_ref()->id());
                if (pkl_hash) {
                        break;
@@ -383,7 +381,7 @@ verify_asset (shared_ptr<const DCP> dcp, shared_ptr<const ReelMXF> reel_mxf, fun
 
        DCP_ASSERT (pkl_hash);
 
-       optional<string> cpl_hash = reel_mxf->hash();
+       auto cpl_hash = reel_mxf->hash();
        if (cpl_hash && *cpl_hash != *pkl_hash) {
                return VERIFY_ASSET_RESULT_CPL_PKL_DIFFER;
        }
@@ -397,7 +395,7 @@ verify_asset (shared_ptr<const DCP> dcp, shared_ptr<const ReelMXF> reel_mxf, fun
 
 
 void
-verify_language_tag (string tag, list<VerificationNote>& notes)
+verify_language_tag (string tag, vector<VerificationNote>& notes)
 {
        try {
                dcp::LanguageTag test (tag);
@@ -432,14 +430,14 @@ template <class A, class R, class F>
 optional<VerifyPictureAssetResult>
 verify_picture_asset_type (shared_ptr<const ReelMXF> reel_mxf, function<void (float)> progress)
 {
-       shared_ptr<A> asset = dynamic_pointer_cast<A>(reel_mxf->asset_ref().asset());
+       auto asset = dynamic_pointer_cast<A>(reel_mxf->asset_ref().asset());
        if (!asset) {
                return optional<VerifyPictureAssetResult>();
        }
 
        int biggest_frame = 0;
-       shared_ptr<R> reader = asset->start_read ();
-       int64_t const duration = asset->intrinsic_duration ();
+       auto reader = asset->start_read ();
+       auto const duration = asset->intrinsic_duration ();
        for (int64_t i = 0; i < duration; ++i) {
                shared_ptr<const F> frame = reader->get_frame (i);
                biggest_frame = max(biggest_frame, biggest_frame_size(frame));
@@ -461,7 +459,7 @@ verify_picture_asset_type (shared_ptr<const ReelMXF> reel_mxf, function<void (fl
 static VerifyPictureAssetResult
 verify_picture_asset (shared_ptr<const ReelMXF> reel_mxf, function<void (float)> progress)
 {
-       optional<VerifyPictureAssetResult> r = verify_picture_asset_type<MonoPictureAsset, MonoPictureAssetReader, MonoPictureFrame>(reel_mxf, progress);
+       auto r = verify_picture_asset_type<MonoPictureAsset, MonoPictureAssetReader, MonoPictureFrame>(reel_mxf, progress);
        if (!r) {
                r = verify_picture_asset_type<StereoPictureAsset, StereoPictureAssetReader, StereoPictureFrame>(reel_mxf, progress);
        }
@@ -477,13 +475,13 @@ verify_main_picture_asset (
        shared_ptr<const ReelPictureAsset> reel_asset,
        function<void (string, optional<boost::filesystem::path>)> stage,
        function<void (float)> progress,
-       list<VerificationNote>& notes
+       vector<VerificationNote>& notes
        )
 {
-       shared_ptr<const PictureAsset> asset = reel_asset->asset();
-       boost::filesystem::path const file = *asset->file();
+       auto asset = reel_asset->asset();
+       auto const file = *asset->file();
        stage ("Checking picture asset hash", file);
-       VerifyAssetResult const r = verify_asset (dcp, reel_asset, progress);
+       auto const r = verify_asset (dcp, reel_asset, progress);
        switch (r) {
                case VERIFY_ASSET_RESULT_BAD:
                        notes.push_back (
@@ -503,7 +501,7 @@ verify_main_picture_asset (
                        break;
        }
        stage ("Checking picture frame sizes", asset->file());
-       VerifyPictureAssetResult const pr = verify_picture_asset (reel_asset, progress);
+       auto const pr = verify_picture_asset (reel_asset, progress);
        switch (pr) {
                case VERIFY_PICTURE_ASSET_RESULT_BAD:
                        notes.push_back (
@@ -589,12 +587,12 @@ verify_main_sound_asset (
        shared_ptr<const ReelSoundAsset> reel_asset,
        function<void (string, optional<boost::filesystem::path>)> stage,
        function<void (float)> progress,
-       list<VerificationNote>& notes
+       vector<VerificationNote>& notes
        )
 {
-       shared_ptr<const dcp::SoundAsset> asset = reel_asset->asset();
+       auto asset = reel_asset->asset();
        stage ("Checking sound asset hash", asset->file());
-       VerifyAssetResult const r = verify_asset (dcp, reel_asset, progress);
+       auto const r = verify_asset (dcp, reel_asset, progress);
        switch (r) {
                case VERIFY_ASSET_RESULT_BAD:
                        notes.push_back (
@@ -621,7 +619,7 @@ verify_main_sound_asset (
 
 
 static void
-verify_main_subtitle_reel (shared_ptr<const ReelSubtitleAsset> reel_asset, list<VerificationNote>& notes)
+verify_main_subtitle_reel (shared_ptr<const ReelSubtitleAsset> reel_asset, vector<VerificationNote>& notes)
 {
        /* XXX: is Language compulsory? */
        if (reel_asset->language()) {
@@ -631,7 +629,7 @@ verify_main_subtitle_reel (shared_ptr<const ReelSubtitleAsset> reel_asset, list<
 
 
 static void
-verify_closed_caption_reel (shared_ptr<const ReelClosedCaptionAsset> reel_asset, list<VerificationNote>& notes)
+verify_closed_caption_reel (shared_ptr<const ReelClosedCaptionAsset> reel_asset, vector<VerificationNote>& notes)
 {
        /* XXX: is Language compulsory? */
        if (reel_asset->language()) {
@@ -651,8 +649,9 @@ verify_subtitle_asset (
        shared_ptr<const SubtitleAsset> asset,
        function<void (string, optional<boost::filesystem::path>)> stage,
        boost::filesystem::path xsd_dtd_directory,
-       list<VerificationNote>& notes,
-       State& state
+       vector<VerificationNote>& notes,
+       State& state,
+       bool first_reel
        )
 {
        stage ("Checking subtitle XML", asset->file());
@@ -661,10 +660,10 @@ verify_subtitle_asset (
         */
        validate_xml (asset->raw_xml(), xsd_dtd_directory, notes);
 
-       shared_ptr<const SMPTESubtitleAsset> smpte = dynamic_pointer_cast<const SMPTESubtitleAsset>(asset);
+       auto smpte = dynamic_pointer_cast<const SMPTESubtitleAsset>(asset);
        if (smpte) {
                if (smpte->language()) {
-                       string const language = *smpte->language();
+                       auto const language = *smpte->language();
                        verify_language_tag (language, notes);
                        if (!state.subtitle_language) {
                                state.subtitle_language = language;
@@ -692,10 +691,10 @@ verify_subtitle_asset (
                /* XXX: I'm not sure what Bv2.1_7.2.1 means when it says "the font resource shall not be larger than 10MB"
                 * but I'm hoping that checking for the total size of all fonts being <= 10MB will do.
                 */
-               map<string, ArrayData> fonts = asset->font_data ();
+               auto fonts = asset->font_data ();
                int total_size = 0;
-               for (map<string, ArrayData>::const_iterator i = fonts.begin(); i != fonts.end(); ++i) {
-                       total_size += i->second.size();
+               for (auto i: fonts) {
+                       total_size += i.second.size();
                }
                if (total_size > 10 * 1024 * 1024) {
                        notes.push_back (
@@ -716,6 +715,20 @@ verify_subtitle_asset (
                                        VerificationNote::VERIFY_BV21_ERROR, VerificationNote::SUBTITLE_START_TIME_NON_ZERO, *asset->file())
                                );
                }
+
+               if (first_reel) {
+                       auto subs = smpte->subtitles();
+                       sort (subs.begin(), subs.end(), [](shared_ptr<Subtitle> a, shared_ptr<Subtitle> b) {
+                               return a->in() < b->in();
+                       });
+                       if (!subs.empty() && subs.front()->in() < dcp::Time(0, 0, 4, 0, 24)) {
+                               notes.push_back(
+                                       VerificationNote(
+                                               VerificationNote::VERIFY_WARNING, VerificationNote::FIRST_TEXT_TOO_EARLY
+                                               )
+                                       );
+                       }
+               }
        }
 }
 
@@ -725,11 +738,12 @@ verify_closed_caption_asset (
        shared_ptr<const SubtitleAsset> asset,
        function<void (string, optional<boost::filesystem::path>)> stage,
        boost::filesystem::path xsd_dtd_directory,
-       list<VerificationNote>& notes,
-       State& state
+       vector<VerificationNote>& notes,
+       State& state,
+       bool first_reel
        )
 {
-       verify_subtitle_asset (asset, stage, xsd_dtd_directory, notes, state);
+       verify_subtitle_asset (asset, stage, xsd_dtd_directory, notes, state, first_reel);
 
        if (asset->raw_xml().size() > 256 * 1024) {
                notes.push_back (
@@ -741,7 +755,7 @@ verify_closed_caption_asset (
 }
 
 
-list<VerificationNote>
+vector<VerificationNote>
 dcp::verify (
        vector<boost::filesystem::path> directories,
        function<void (string, optional<boost::filesystem::path>)> stage,
@@ -751,15 +765,15 @@ dcp::verify (
 {
        xsd_dtd_directory = boost::filesystem::canonical (xsd_dtd_directory);
 
-       list<VerificationNote> notes;
+       vector<VerificationNote> notes;
        State state;
 
-       list<shared_ptr<DCP> > dcps;
-       BOOST_FOREACH (boost::filesystem::path i, directories) {
+       vector<shared_ptr<DCP>> dcps;
+       for (auto i: directories) {
                dcps.push_back (shared_ptr<DCP> (new DCP (i)));
        }
 
-       BOOST_FOREACH (shared_ptr<DCP> dcp, dcps) {
+       for (auto dcp: dcps) {
                stage ("Checking DCP", dcp->directory());
                try {
                        dcp->read (&notes);
@@ -777,11 +791,11 @@ dcp::verify (
                        notes.push_back (VerificationNote(VerificationNote::VERIFY_BV21_ERROR, VerificationNote::NOT_SMPTE));
                }
 
-               BOOST_FOREACH (shared_ptr<CPL> cpl, dcp->cpls()) {
+               for (auto cpl: dcp->cpls()) {
                        stage ("Checking CPL", cpl->file());
                        validate_xml (cpl->file().get(), xsd_dtd_directory, notes);
 
-                       BOOST_FOREACH (string const& i, cpl->additional_subtitle_languages()) {
+                       for (auto const& i: cpl->additional_subtitle_languages()) {
                                verify_language_tag (i, notes);
                        }
 
@@ -790,17 +804,18 @@ dcp::verify (
                        }
 
                        /* Check that the CPL's hash corresponds to the PKL */
-                       BOOST_FOREACH (shared_ptr<PKL> i, dcp->pkls()) {
+                       for (auto i: dcp->pkls()) {
                                optional<string> h = i->hash(cpl->id());
                                if (h && make_digest(ArrayData(*cpl->file())) != *h) {
                                        notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::CPL_HASH_INCORRECT));
                                }
                        }
 
-                       BOOST_FOREACH (shared_ptr<Reel> reel, cpl->reels()) {
+                       bool first_reel = true;
+                       for (auto reel: cpl->reels()) {
                                stage ("Checking reel", optional<boost::filesystem::path>());
 
-                               BOOST_FOREACH (shared_ptr<ReelAsset> i, reel->assets()) {
+                               for (auto i: reel->assets()) {
                                        if (i->duration() && (i->duration().get() * i->edit_rate().denominator / i->edit_rate().numerator) < 1) {
                                                notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::DURATION_TOO_SMALL, i->id()));
                                        }
@@ -811,7 +826,7 @@ dcp::verify (
 
                                if (reel->main_picture()) {
                                        /* Check reel stuff */
-                                       Fraction const frame_rate = reel->main_picture()->frame_rate();
+                                       auto const frame_rate = reel->main_picture()->frame_rate();
                                        if (frame_rate.denominator != 1 ||
                                            (frame_rate.numerator != 24 &&
                                             frame_rate.numerator != 25 &&
@@ -835,20 +850,22 @@ dcp::verify (
                                if (reel->main_subtitle()) {
                                        verify_main_subtitle_reel (reel->main_subtitle(), notes);
                                        if (reel->main_subtitle()->asset_ref().resolved()) {
-                                               verify_subtitle_asset (reel->main_subtitle()->asset(), stage, xsd_dtd_directory, notes, state);
+                                               verify_subtitle_asset (reel->main_subtitle()->asset(), stage, xsd_dtd_directory, notes, state, first_reel);
                                        }
                                }
 
-                               BOOST_FOREACH (shared_ptr<dcp::ReelClosedCaptionAsset> i, reel->closed_captions()) {
+                               for (auto i: reel->closed_captions()) {
                                        verify_closed_caption_reel (i, notes);
                                        if (i->asset_ref().resolved()) {
-                                               verify_closed_caption_asset (i->asset(), stage, xsd_dtd_directory, notes, state);
+                                               verify_closed_caption_asset (i->asset(), stage, xsd_dtd_directory, notes, state, first_reel);
                                        }
                                }
+
+                               first_reel = false;
                        }
                }
 
-               BOOST_FOREACH (shared_ptr<PKL> pkl, dcp->pkls()) {
+               for (auto pkl: dcp->pkls()) {
                        stage ("Checking PKL", pkl->file());
                        validate_xml (pkl->file().get(), xsd_dtd_directory, notes);
                }
@@ -928,6 +945,8 @@ dcp::note_to_string (dcp::VerificationNote note)
                return String::compose("The XML for a SMPTE subtitle asset has no <StartTime> tag, which is required by Bv2.1", note.file()->filename());
        case dcp::VerificationNote::SUBTITLE_START_TIME_NON_ZERO:
                return String::compose("The XML for a SMPTE subtitle asset has a non-zero <StartTime> tag, which is disallowed by Bv2.1", note.file()->filename());
+       case dcp::VerificationNote::FIRST_TEXT_TOO_EARLY:
+               return "The first subtitle or closed caption is less than 4 seconds from the start of the DCP.";
        }
 
        return "";