Rename MISSING_LOAD_FONT -> MISSING_LOAD_FONT_FOR_FONT.
[libdcp.git] / src / verify.cc
index ed6c78d600b70109fe7ae6ab7c2bcfe2f2ce0d7d..fc58cf78473f60fc9b5652d7dd8e62f0db02c197 100644 (file)
@@ -58,6 +58,7 @@
 #include "stereo_picture_frame.h"
 #include "verify.h"
 #include "verify_j2k.h"
+#include <libxml/parserInternals.h>
 #include <xercesc/dom/DOMAttr.hpp>
 #include <xercesc/dom/DOMDocument.hpp>
 #include <xercesc/dom/DOMError.hpp>
@@ -242,7 +243,8 @@ public:
                add("http://www.digicine.com/PROTO-ASDCP-AM-20040311.xsd", "PROTO-ASDCP-AM-20040311.xsd");
                add("http://www.digicine.com/PROTO-ASDCP-CC-CPL-20070926#", "PROTO-ASDCP-CC-CPL-20070926.xsd");
                add("interop-subs", "DCSubtitle.v1.mattsson.xsd");
-               add("http://www.smpte-ra.org/schemas/428-7/2010/DCST.xsd", "SMPTE-428-7-2010-DCST.xsd");
+               add("http://www.smpte-ra.org/schemas/428-7/2010/DCST.xsd", "DCDMSubtitle-2010.xsd");
+               add("http://www.smpte-ra.org/schemas/428-7/2014/DCST.xsd", "DCDMSubtitle-2014.xsd");
                add("http://www.smpte-ra.org/schemas/429-16/2014/CPL-Metadata", "SMPTE-429-16.xsd");
                add("http://www.dolby.com/schemas/2012/AD", "Dolby-2012-AD.xsd");
                add("http://www.smpte-ra.org/schemas/429-10/2008/Main-Stereo-Picture-CPL", "SMPTE-429-10-2008.xsd");
@@ -321,6 +323,7 @@ validate_xml (T xml, boost::filesystem::path xsd_dtd_directory, vector<Verificat
                schema.push_back("PROTO-ASDCP-AM-20040311.xsd");
                schema.push_back("DCSubtitle.v1.mattsson.xsd");
                schema.push_back("DCDMSubtitle-2010.xsd");
+               schema.push_back("DCDMSubtitle-2014.xsd");
                schema.push_back("PROTO-ASDCP-CC-CPL-20070926.xsd");
                schema.push_back("SMPTE-429-16.xsd");
                schema.push_back("Dolby-2012-AD.xsd");
@@ -447,7 +450,7 @@ verify_picture_asset (shared_ptr<const ReelFileAsset> reel_file_asset, boost::fi
                        biggest_frame = max(biggest_frame, frame->size());
                        if (!mono_asset->encrypted() || mono_asset->key()) {
                                vector<VerificationNote> j2k_notes;
-                               verify_j2k (frame, j2k_notes);
+                               verify_j2k(frame, i, mono_asset->frame_rate().numerator, j2k_notes);
                                check_and_add (j2k_notes);
                        }
                        progress (float(i) / duration);
@@ -459,8 +462,8 @@ verify_picture_asset (shared_ptr<const ReelFileAsset> reel_file_asset, boost::fi
                        biggest_frame = max(biggest_frame, max(frame->left()->size(), frame->right()->size()));
                        if (!stereo_asset->encrypted() || stereo_asset->key()) {
                                vector<VerificationNote> j2k_notes;
-                               verify_j2k (frame->left(), j2k_notes);
-                               verify_j2k (frame->right(), j2k_notes);
+                               verify_j2k(frame->left(), i, stereo_asset->frame_rate().numerator, j2k_notes);
+                               verify_j2k(frame->right(), i, stereo_asset->frame_rate().numerator, j2k_notes);
                                check_and_add (j2k_notes);
                        }
                        progress (float(i) / duration);
@@ -570,6 +573,13 @@ verify_main_picture_asset (
 }
 
 
+struct State
+{
+       boost::optional<string> subtitle_language;
+       boost::optional<int> audio_channels;
+};
+
+
 static void
 verify_main_sound_asset (
        shared_ptr<const DCP> dcp,
@@ -577,7 +587,8 @@ verify_main_sound_asset (
        function<void (string, optional<boost::filesystem::path>)> stage,
        function<void (float)> progress,
        VerificationOptions options,
-       vector<VerificationNote>& notes
+       vector<VerificationNote>& notes,
+       State& state
        )
 {
        auto asset = reel_asset->asset();
@@ -598,6 +609,12 @@ verify_main_sound_asset (
                }
        }
 
+       if (!state.audio_channels) {
+               state.audio_channels = asset->channels();
+       } else if (*state.audio_channels != asset->channels()) {
+               notes.push_back({ VerificationNote::Type::ERROR, VerificationNote::Code::MISMATCHED_SOUND_CHANNEL_COUNTS, file });
+       }
+
        stage ("Checking sound asset metadata", file);
 
        if (auto lang = asset->language()) {
@@ -641,12 +658,6 @@ verify_closed_caption_reel (shared_ptr<const ReelClosedCaptionAsset> reel_asset,
 }
 
 
-struct State
-{
-       boost::optional<string> subtitle_language;
-};
-
-
 /** Verify stuff that is common to both subtitles and closed captions */
 void
 verify_smpte_timed_text_asset (
@@ -705,6 +716,10 @@ verify_interop_subtitle_asset(shared_ptr<const InteropSubtitleAsset> asset, vect
        if (asset->subtitles().empty()) {
                notes.push_back({VerificationNote::Type::ERROR, VerificationNote::Code::MISSING_SUBTITLE, asset->id(), asset->file().get() });
        }
+       auto const unresolved = asset->unresolved_fonts();
+       if (!unresolved.empty()) {
+               notes.push_back({VerificationNote::Type::ERROR, VerificationNote::Code::MISSING_FONT, unresolved.front() });
+       }
 }
 
 
@@ -772,15 +787,33 @@ verify_subtitle_asset (
                notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::MISSED_CHECK_OF_ENCRYPTED});
        }
 
+       auto namespace_count = [](shared_ptr<const SubtitleAsset> asset, string root_node) {
+               cxml::Document doc(root_node);
+               doc.read_string(asset->raw_xml().get());
+               auto root = dynamic_cast<xmlpp::Element*>(doc.node())->cobj();
+               int count = 0;
+               for (auto ns = root->nsDef; ns != nullptr; ns = ns->next) {
+                       ++count;
+               }
+               return count;
+       };
+
        auto interop = dynamic_pointer_cast<const InteropSubtitleAsset>(asset);
        if (interop) {
                verify_interop_subtitle_asset(interop, notes);
+               if (namespace_count(asset, "DCSubtitle") > 1) {
+                       notes.push_back({ VerificationNote::Type::WARNING, VerificationNote::Code::INCORRECT_SUBTITLE_NAMESPACE_COUNT, asset->id() });
+               }
        }
 
        auto smpte = dynamic_pointer_cast<const SMPTESubtitleAsset>(asset);
        if (smpte) {
                verify_smpte_timed_text_asset (smpte, reel_asset_duration, notes);
                verify_smpte_subtitle_asset (smpte, notes, state);
+               /* This asset may be encrypted and in that case we'll have no raw_xml() */
+               if (asset->raw_xml() && namespace_count(asset, "SubtitleReel") > 1) {
+                       notes.push_back({ VerificationNote::Type::WARNING, VerificationNote::Code::INCORRECT_SUBTITLE_NAMESPACE_COUNT, asset->id()});
+               }
        }
 }
 
@@ -816,7 +849,7 @@ verify_closed_caption_asset (
 }
 
 
-/** Check the timing of the individual subtitles and make sure there are no empty <Text> nodes */
+/** Check the timing of the individual subtitles and make sure there are no empty <Text> nodes etc. */
 static
 void
 verify_text_details (
@@ -837,9 +870,11 @@ verify_text_details (
        auto empty_text = false;
        /* current reel start time (in editable units) */
        int64_t reel_offset = 0;
+       vector<string> font_ids;
+       optional<string> missing_load_font_id;
 
        std::function<void (cxml::ConstNodePtr, optional<int>, optional<Time>, int, bool)> parse;
-       parse = [&parse, &last_out, &too_short, &too_close, &too_early, &empty_text, &reel_offset](cxml::ConstNodePtr node, optional<int> tcr, optional<Time> start_time, int er, bool first_reel) {
+       parse = [&parse, &last_out, &too_short, &too_close, &too_early, &empty_text, &reel_offset, &font_ids, &missing_load_font_id](cxml::ConstNodePtr node, optional<int> tcr, optional<Time> start_time, int er, bool first_reel) {
                if (node->name() == "Subtitle") {
                        Time in (node->string_attribute("TimeIn"), tcr);
                        if (start_time) {
@@ -879,8 +914,17 @@ verify_text_details (
                        if (!node_has_content(node)) {
                                empty_text = true;
                        }
+               } else if (node->name() == "LoadFont") {
+                       if (auto const id = node->optional_string_attribute("Id")) {
+                               font_ids.push_back(*id);
+                       }
+               } else if (node->name() == "Font") {
+                       if (auto const font_id = node->optional_string_attribute("Id")) {
+                               if (std::find_if(font_ids.begin(), font_ids.end(), [font_id](string const& id) { return id == font_id; }) == font_ids.end()) {
+                                       missing_load_font_id = font_id;
+                               }
+                       }
                }
-
                for (auto i: node->node_children()) {
                        parse(i, tcr, start_time, er, first_reel);
                }
@@ -957,6 +1001,10 @@ verify_text_details (
                        VerificationNote::Type::WARNING, VerificationNote::Code::EMPTY_TEXT
                });
        }
+
+       if (missing_load_font_id) {
+               notes.push_back(dcp::VerificationNote(VerificationNote::Type::ERROR, VerificationNote::Code::MISSING_LOAD_FONT_FOR_FONT).set_id(*missing_load_font_id));
+       }
 }
 
 
@@ -1383,7 +1431,7 @@ verify_reel(
        }
 
        if (reel->main_sound() && reel->main_sound()->asset_ref().resolved()) {
-               verify_main_sound_asset(dcp, reel->main_sound(), stage, progress, options, notes);
+               verify_main_sound_asset(dcp, reel->main_sound(), stage, progress, options, notes, state);
        }
 
        if (reel->main_subtitle()) {
@@ -1561,6 +1609,16 @@ verify_cpl(
        verify_text_details(cpl->reels(), notes);
 
        if (dcp->standard() == Standard::SMPTE) {
+               if (auto msc = cpl->main_sound_configuration()) {
+                       if (state.audio_channels && msc->channels() != *state.audio_channels) {
+                               notes.push_back({
+                                               VerificationNote::Type::ERROR,
+                                               VerificationNote::Code::INVALID_MAIN_SOUND_CONFIGURATION,
+                                               String::compose("MainSoundConfiguration has %1 channels but sound assets have %2", msc->channels(), *state.audio_channels),
+                                               cpl->file().get()
+                                       });
+                       }
+               }
 
                if (have_main_subtitle && have_no_main_subtitle) {
                        notes.push_back({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_MAIN_SUBTITLE_FROM_SOME_REELS});
@@ -1737,6 +1795,8 @@ dcp::verify (
                        notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
                } catch (MXFFileError& e) {
                        notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
+               } catch (BadURNUUIDError& e) {
+                       notes.push_back({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
                } catch (cxml::Error& e) {
                        notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
                }
@@ -1816,7 +1876,7 @@ dcp::note_to_string (VerificationNote note)
        case VerificationNote::Code::INVALID_XML:
                return String::compose("An XML file is badly formed: %1 (%2:%3)", note.note().get(), note.file()->filename(), note.line().get());
        case VerificationNote::Code::MISSING_ASSETMAP:
-               return "No ASSETMAP or ASSETMAP.xml was found.";
+               return "No valid ASSETMAP or ASSETMAP.xml was found.";
        case VerificationNote::Code::INVALID_INTRINSIC_DURATION:
                return String::compose("The intrinsic duration of the asset %1 is less than 1 second.", note.note().get());
        case VerificationNote::Code::INVALID_DURATION:
@@ -1977,13 +2037,28 @@ dcp::note_to_string (VerificationNote note)
        case VerificationNote::Code::INVALID_MAIN_PICTURE_ACTIVE_AREA:
                return String::compose("<MainPictureActiveaArea> has an invalid value: %1", note.note().get());
        case VerificationNote::Code::DUPLICATE_ASSET_ID_IN_PKL:
-               return String::compose("The PKL %1 has more than one asset with the same ID", note.note().get());
+               return String::compose("The PKL %1 has more than one asset with the same ID.", note.note().get());
        case VerificationNote::Code::DUPLICATE_ASSET_ID_IN_ASSETMAP:
-               return String::compose("The ASSETMAP %1 has more than one asset with the same ID", note.note().get());
+               return String::compose("The ASSETMAP %1 has more than one asset with the same ID.", note.note().get());
        case VerificationNote::Code::MISSING_SUBTITLE:
-               return String::compose("The subtitle asset %1 has no subtitles", note.note().get());
+               return String::compose("The subtitle asset %1 has no subtitles.", note.note().get());
        case VerificationNote::Code::INVALID_SUBTITLE_ISSUE_DATE:
                return String::compose("<IssueDate> has an invalid value: %1", note.note().get());
+       case VerificationNote::Code::MISMATCHED_SOUND_CHANNEL_COUNTS:
+               return String::compose("The sound assets do not all have the same channel count; the first to differ is %1", note.file()->filename());
+       case VerificationNote::Code::INVALID_MAIN_SOUND_CONFIGURATION:
+               return String::compose("<MainSoundConfiguration> has an invalid value: %1", note.note().get());
+       case VerificationNote::Code::MISSING_FONT:
+               return String::compose("The font file for font ID \"%1\" was not found, or was not referred to in the ASSETMAP.", note.note().get());
+       case VerificationNote::Code::INVALID_JPEG2000_TILE_PART_SIZE:
+               return String::compose(
+                       "Frame %1 has an image component that is too large (component %2 is %3 bytes in size).",
+                       note.frame().get(), note.component().get(), note.size().get()
+                       );
+       case VerificationNote::Code::INCORRECT_SUBTITLE_NAMESPACE_COUNT:
+               return String::compose("The XML in the subtitle asset %1 has more than one namespace declaration.", note.note().get());
+       case VerificationNote::Code::MISSING_LOAD_FONT_FOR_FONT:
+               return String::compose("A subtitle or closed caption refers to a font with ID %1 that does not have a corresponding <LoadFont> node", note.id().get());
        }
 
        return "";