Note correct/incorrect hashes when the verifier raises related errors.
[libdcp.git] / src / verify.cc
index 9a1c0dcc7a7bddc9e0860fb38c9741f08b422ef5..0ef4ada5c59b9add2a576e9e6596b84d410b188e 100644 (file)
@@ -385,15 +385,24 @@ enum class VerifyAssetResult {
 
 
 static VerifyAssetResult
-verify_asset (shared_ptr<const DCP> dcp, shared_ptr<const ReelFileAsset> reel_file_asset, function<void (float)> progress)
+verify_asset(
+       shared_ptr<const DCP> dcp,
+       shared_ptr<const ReelFileAsset> reel_file_asset,
+       function<void (float)> progress,
+       string* reference_hash,
+       string* calculated_hash
+       )
 {
+       DCP_ASSERT(reference_hash);
+       DCP_ASSERT(calculated_hash);
+
        /* When reading the DCP the hash will have been set to the one from the PKL/CPL.
         * We want to calculate the hash of the actual file contents here, so that we
         * can check it.  unset_hash() means that this calculation will happen on the
         * call to hash().
         */
        reel_file_asset->asset_ref()->unset_hash();
-       auto const actual_hash = reel_file_asset->asset_ref()->hash([progress](int64_t done, int64_t total) {
+       *calculated_hash = reel_file_asset->asset_ref()->hash([progress](int64_t done, int64_t total) {
                progress(float(done) / total);
        });
 
@@ -403,22 +412,23 @@ verify_asset (shared_ptr<const DCP> dcp, shared_ptr<const ReelFileAsset> reel_fi
 
        auto asset = reel_file_asset->asset_ref().asset();
 
-       optional<string> pkl_hash;
+       optional<string> maybe_pkl_hash;
        for (auto i: pkls) {
-               pkl_hash = i->hash (reel_file_asset->asset_ref()->id());
-               if (pkl_hash) {
+               maybe_pkl_hash = i->hash (reel_file_asset->asset_ref()->id());
+               if (maybe_pkl_hash) {
                        break;
                }
        }
 
-       DCP_ASSERT (pkl_hash);
+       DCP_ASSERT(maybe_pkl_hash);
+       *reference_hash = *maybe_pkl_hash;
 
        auto cpl_hash = reel_file_asset->hash();
-       if (cpl_hash && *cpl_hash != *pkl_hash) {
+       if (cpl_hash && *cpl_hash != *reference_hash) {
                return VerifyAssetResult::CPL_PKL_DIFFER;
        }
 
-       if (actual_hash != *pkl_hash) {
+       if (*calculated_hash != *reference_hash) {
                return VerifyAssetResult::BAD;
        }
 
@@ -438,9 +448,8 @@ verify_language_tag (string tag, vector<VerificationNote>& notes)
 
 
 static void
-verify_picture_asset (shared_ptr<const ReelFileAsset> reel_file_asset, boost::filesystem::path file, vector<VerificationNote>& notes, function<void (float)> progress)
+verify_picture_asset(shared_ptr<const ReelFileAsset> reel_file_asset, boost::filesystem::path file, int64_t start_frame, vector<VerificationNote>& notes, function<void (float)> progress)
 {
-       int biggest_frame = 0;
        auto asset = dynamic_pointer_cast<PictureAsset>(reel_file_asset->asset_ref().asset());
        auto const duration = asset->intrinsic_duration ();
 
@@ -452,14 +461,33 @@ verify_picture_asset (shared_ptr<const ReelFileAsset> reel_file_asset, boost::fi
                }
        };
 
+       int const max_frame =   rint(250 * 1000000 / (8 * asset->edit_rate().as_float()));
+       int const risky_frame = rint(230 * 1000000 / (8 * asset->edit_rate().as_float()));
+
+       auto check_frame_size = [max_frame, risky_frame, file, start_frame](int index, int size, int frame_rate, vector<VerificationNote>& notes) {
+               if (size > max_frame) {
+                       notes.push_back(
+                               VerificationNote(
+                                       VerificationNote::Type::ERROR, VerificationNote::Code::INVALID_PICTURE_FRAME_SIZE_IN_BYTES, file
+                                       ).set_frame(start_frame + index).set_frame_rate(frame_rate)
+                       );
+               } else if (size > risky_frame) {
+                       notes.push_back(
+                               VerificationNote(
+                                       VerificationNote::Type::WARNING, VerificationNote::Code::NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES, file
+                                       ).set_frame(start_frame + index).set_frame_rate(frame_rate)
+                       );
+               }
+       };
+
        if (auto mono_asset = dynamic_pointer_cast<MonoPictureAsset>(reel_file_asset->asset_ref().asset())) {
                auto reader = mono_asset->start_read ();
                for (int64_t i = 0; i < duration; ++i) {
                        auto frame = reader->get_frame (i);
-                       biggest_frame = max(biggest_frame, frame->size());
+                       check_frame_size(i, frame->size(), mono_asset->frame_rate().numerator, notes);
                        if (!mono_asset->encrypted() || mono_asset->key()) {
                                vector<VerificationNote> j2k_notes;
-                               verify_j2k(frame, i, mono_asset->frame_rate().numerator, j2k_notes);
+                               verify_j2k(frame, start_frame, i, mono_asset->frame_rate().numerator, j2k_notes);
                                check_and_add (j2k_notes);
                        }
                        progress (float(i) / duration);
@@ -468,29 +496,18 @@ verify_picture_asset (shared_ptr<const ReelFileAsset> reel_file_asset, boost::fi
                auto reader = stereo_asset->start_read ();
                for (int64_t i = 0; i < duration; ++i) {
                        auto frame = reader->get_frame (i);
-                       biggest_frame = max(biggest_frame, max(frame->left()->size(), frame->right()->size()));
+                       check_frame_size(i, frame->left()->size(), stereo_asset->frame_rate().numerator, notes);
+                       check_frame_size(i, frame->right()->size(), stereo_asset->frame_rate().numerator, notes);
                        if (!stereo_asset->encrypted() || stereo_asset->key()) {
                                vector<VerificationNote> 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);
+                               verify_j2k(frame->left(), start_frame, i, stereo_asset->frame_rate().numerator, j2k_notes);
+                               verify_j2k(frame->right(), start_frame, i, stereo_asset->frame_rate().numerator, j2k_notes);
                                check_and_add (j2k_notes);
                        }
                        progress (float(i) / duration);
                }
 
        }
-
-       static const int max_frame =   rint(250 * 1000000 / (8 * asset->edit_rate().as_float()));
-       static const int risky_frame = rint(230 * 1000000 / (8 * asset->edit_rate().as_float()));
-       if (biggest_frame > max_frame) {
-               notes.push_back ({
-                       VerificationNote::Type::ERROR, VerificationNote::Code::INVALID_PICTURE_FRAME_SIZE_IN_BYTES, file
-               });
-       } else if (biggest_frame > risky_frame) {
-               notes.push_back ({
-                       VerificationNote::Type::WARNING, VerificationNote::Code::NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES, file
-               });
-       }
 }
 
 
@@ -498,6 +515,7 @@ static void
 verify_main_picture_asset (
        shared_ptr<const DCP> dcp,
        shared_ptr<const ReelPictureAsset> reel_asset,
+       int64_t start_frame,
        function<void (string, optional<boost::filesystem::path>)> stage,
        function<void (float)> progress,
        VerificationOptions options,
@@ -509,12 +527,18 @@ verify_main_picture_asset (
 
        if (options.check_asset_hashes && (!options.maximum_asset_size_for_hash_check || filesystem::file_size(file) < *options.maximum_asset_size_for_hash_check)) {
                stage ("Checking picture asset hash", file);
-               auto const r = verify_asset (dcp, reel_asset, progress);
+               string reference_hash;
+               string calculated_hash;
+               auto const r = verify_asset(dcp, reel_asset, progress, &reference_hash, &calculated_hash);
                switch (r) {
                        case VerifyAssetResult::BAD:
-                               notes.push_back ({
-                                       VerificationNote::Type::ERROR, VerificationNote::Code::INCORRECT_PICTURE_HASH, file
-                               });
+                               notes.push_back(
+                                       dcp::VerificationNote(
+                                               VerificationNote::Type::ERROR,
+                                               VerificationNote::Code::INCORRECT_PICTURE_HASH,
+                                               file
+                                               ).set_reference_hash(reference_hash).set_calculated_hash(calculated_hash)
+                                       );
                                break;
                        case VerifyAssetResult::CPL_PKL_DIFFER:
                                notes.push_back ({
@@ -527,7 +551,7 @@ verify_main_picture_asset (
        }
 
        stage ("Checking picture frame sizes", asset->file());
-       verify_picture_asset (reel_asset, file, notes, progress);
+       verify_picture_asset(reel_asset, file, start_frame, notes, progress);
 
        /* Only flat/scope allowed by Bv2.1 */
        if (
@@ -605,10 +629,18 @@ verify_main_sound_asset (
 
        if (options.check_asset_hashes && (!options.maximum_asset_size_for_hash_check || filesystem::file_size(file) < *options.maximum_asset_size_for_hash_check)) {
                stage("Checking sound asset hash", file);
-               auto const r = verify_asset (dcp, reel_asset, progress);
+               string reference_hash;
+               string calculated_hash;
+               auto const r = verify_asset(dcp, reel_asset, progress, &reference_hash, &calculated_hash);
                switch (r) {
                        case VerifyAssetResult::BAD:
-                               notes.push_back({VerificationNote::Type::ERROR, VerificationNote::Code::INCORRECT_SOUND_HASH, file});
+                               notes.push_back(
+                                       dcp::VerificationNote(
+                                               VerificationNote::Type::ERROR,
+                                               VerificationNote::Code::INCORRECT_SOUND_HASH,
+                                               file
+                                               ).set_reference_hash(reference_hash).set_calculated_hash(calculated_hash)
+                                       );
                                break;
                        case VerifyAssetResult::CPL_PKL_DIFFER:
                                notes.push_back({VerificationNote::Type::ERROR, VerificationNote::Code::MISMATCHED_SOUND_HASHES, file});
@@ -1257,7 +1289,7 @@ verify_text_details(dcp::Standard standard, vector<shared_ptr<Reel>> reels, vect
                return;
        }
 
-       if (reels[0]->main_subtitle()) {
+       if (reels[0]->main_subtitle() && reels[0]->main_subtitle()->asset_ref().resolved()) {
                verify_text_details(standard, reels, reels[0]->main_subtitle()->edit_rate().numerator, notes,
                        [](shared_ptr<Reel> reel) {
                                return static_cast<bool>(reel->main_subtitle());
@@ -1384,6 +1416,7 @@ verify_reel(
        shared_ptr<const DCP> dcp,
        shared_ptr<const CPL> cpl,
        shared_ptr<const Reel> reel,
+       int64_t start_frame,
        optional<dcp::Size> main_picture_active_area,
        function<void (string, optional<boost::filesystem::path>)> stage,
        boost::filesystem::path xsd_dtd_directory,
@@ -1442,7 +1475,7 @@ verify_reel(
                }
                /* Check asset */
                if (reel->main_picture()->asset_ref().resolved()) {
-                       verify_main_picture_asset(dcp, reel->main_picture(), stage, progress, options, notes);
+                       verify_main_picture_asset(dcp, reel->main_picture(), start_frame, stage, progress, options, notes);
                        auto const asset_size = reel->main_picture()->asset()->size();
                        if (main_picture_active_area) {
                                if (main_picture_active_area->width > asset_size.width) {
@@ -1576,8 +1609,16 @@ verify_cpl(
        for (auto i: dcp->pkls()) {
                /* Check that the CPL's hash corresponds to the PKL */
                optional<string> h = i->hash(cpl->id());
-               if (h && make_digest(ArrayData(*cpl->file())) != *h) {
-                       notes.push_back({VerificationNote::Type::ERROR, VerificationNote::Code::MISMATCHED_CPL_HASHES, cpl->id(), cpl->file().get()});
+               auto calculated_cpl_hash = make_digest(ArrayData(*cpl->file()));
+               if (h && calculated_cpl_hash != *h) {
+                       notes.push_back(
+                               dcp::VerificationNote(
+                                       VerificationNote::Type::ERROR,
+                                       VerificationNote::Code::MISMATCHED_CPL_HASHES,
+                                       cpl->id(),
+                                       cpl->file().get()
+                                       ).set_calculated_hash(calculated_cpl_hash).set_reference_hash(*h)
+                               );
                }
 
                /* Check that any PKL with a single CPL has its AnnotationText the same as the CPL's ContentTitleText */
@@ -1630,12 +1671,14 @@ verify_cpl(
                        });
        }
 
+       int64_t frame = 0;
        for (auto reel: cpl->reels()) {
                stage("Checking reel", optional<boost::filesystem::path>());
                verify_reel(
                        dcp,
                        cpl,
                        reel,
+                       frame,
                        main_picture_active_area,
                        stage,
                        xsd_dtd_directory,
@@ -1649,6 +1692,7 @@ verify_cpl(
                        &fewest_closed_captions,
                        &markers_seen
                        );
+               frame += reel->duration();
        }
 
        verify_text_details(dcp->standard().get_value_or(dcp::Standard::SMPTE), cpl->reels(), notes);
@@ -1701,7 +1745,7 @@ verify_cpl(
 
                LinesCharactersResult result;
                for (auto reel: cpl->reels()) {
-                       if (reel->main_subtitle() && reel->main_subtitle()->asset()) {
+                       if (reel->main_subtitle() && reel->main_subtitle()->asset_ref().resolved()) {
                                verify_text_lines_and_characters(reel->main_subtitle()->asset(), 52, 79, &result);
                        }
                }
@@ -1807,6 +1851,7 @@ verify_assetmap(
 vector<VerificationNote>
 dcp::verify (
        vector<boost::filesystem::path> directories,
+       vector<dcp::DecryptedKDM> kdms,
        function<void (string, optional<boost::filesystem::path>)> stage,
        function<void (float)> progress,
        VerificationOptions options,
@@ -1854,6 +1899,10 @@ dcp::verify (
                        notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_STANDARD});
                }
 
+               for (auto kdm: kdms) {
+                       dcp->add(kdm);
+               }
+
                for (auto cpl: dcp->cpls()) {
                        verify_cpl(
                                dcp,
@@ -1901,15 +1950,15 @@ dcp::note_to_string (VerificationNote note)
        case VerificationNote::Code::FAILED_READ:
                return *note.note();
        case VerificationNote::Code::MISMATCHED_CPL_HASHES:
-               return String::compose("The hash of the CPL %1 in the PKL does not agree with the CPL file.", note.note().get());
+               return String::compose("The hash (%1) of the CPL (%2) in the PKL does not agree with the CPL file (%3).", note.reference_hash().get(), note.note().get(), note.calculated_hash().get());
        case VerificationNote::Code::INVALID_PICTURE_FRAME_RATE:
                return String::compose("The picture in a reel has an invalid frame rate %1.", note.note().get());
        case VerificationNote::Code::INCORRECT_PICTURE_HASH:
-               return String::compose("The hash of the picture asset %1 does not agree with the PKL file.", note.file()->filename());
+               return String::compose("The hash (%1) of the picture asset %2 does not agree with the PKL file (%3).", note.calculated_hash().get(), note.file()->filename(), note.reference_hash().get());
        case VerificationNote::Code::MISMATCHED_PICTURE_HASHES:
                return String::compose("The PKL and CPL hashes differ for the picture asset %1.", note.file()->filename());
        case VerificationNote::Code::INCORRECT_SOUND_HASH:
-               return String::compose("The hash of the sound asset %1 does not agree with the PKL file.", note.file()->filename());
+               return String::compose("The hash (%1) of the sound asset %2 does not agree with the PKL file (%3).", note.calculated_hash().get(), note.file()->filename(), note.reference_hash().get());
        case VerificationNote::Code::MISMATCHED_SOUND_HASHES:
                return String::compose("The PKL and CPL hashes differ for the sound asset %1.", note.file()->filename());
        case VerificationNote::Code::EMPTY_ASSET_PATH:
@@ -1927,9 +1976,19 @@ dcp::note_to_string (VerificationNote note)
        case VerificationNote::Code::INVALID_DURATION:
                return String::compose("The duration of the asset %1 is less than 1 second.", note.note().get());
        case VerificationNote::Code::INVALID_PICTURE_FRAME_SIZE_IN_BYTES:
-               return String::compose("The instantaneous bit rate of the picture asset %1 is larger than the limit of 250Mbit/s in at least one place.", note.file()->filename());
+               return String::compose(
+                       "Frame %1 (timecode %2) in asset %3 has an instantaneous bit rate that is larger than the limit of 250Mbit/s.",
+                       note.frame().get(),
+                       dcp::Time(note.frame().get(), note.frame_rate().get(), note.frame_rate().get()).as_string(dcp::Standard::SMPTE),
+                       note.file()->filename()
+                       );
        case VerificationNote::Code::NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES:
-               return String::compose("The instantaneous bit rate of the picture asset %1 is close to the limit of 250Mbit/s in at least one place.", note.file()->filename());
+               return String::compose(
+                       "Frame %1 (timecode %2) in asset %3 has an instantaneous bit rate that is close to the limit of 250Mbit/s.",
+                       note.frame().get(),
+                       dcp::Time(note.frame().get(), note.frame_rate().get(), note.frame_rate().get()).as_string(dcp::Standard::SMPTE),
+                       note.file()->filename()
+                       );
        case VerificationNote::Code::EXTERNAL_ASSET:
                return String::compose("The asset %1 that this DCP refers to is not included in the DCP.  It may be a VF.", note.note().get());
        case VerificationNote::Code::THREED_ASSET_MARKED_AS_TWOD:
@@ -2029,7 +2088,12 @@ dcp::note_to_string (VerificationNote note)
        case VerificationNote::Code::PARTIALLY_ENCRYPTED:
                return "Some assets are encrypted but some are not.";
        case VerificationNote::Code::INVALID_JPEG2000_CODESTREAM:
-               return String::compose("The JPEG2000 codestream for at least one frame is invalid (%1).", note.note().get());
+               return String::compose(
+                       "Frame %1 (timecode %2) has an invalid JPEG2000 codestream (%3).",
+                       note.frame().get(),
+                       dcp::Time(note.frame().get(), note.frame_rate().get(), note.frame_rate().get()).as_string(dcp::Standard::SMPTE),
+                       note.note().get()
+                       );
        case VerificationNote::Code::INVALID_JPEG2000_GUARD_BITS_FOR_2K:
                return String::compose("The JPEG2000 codestream uses %1 guard bits in a 2K image instead of 1.", note.note().get());
        case VerificationNote::Code::INVALID_JPEG2000_GUARD_BITS_FOR_4K:
@@ -2119,7 +2183,19 @@ dcp::note_to_string (VerificationNote note)
 bool
 dcp::operator== (dcp::VerificationNote const& a, dcp::VerificationNote const& b)
 {
-       return a.type() == b.type() && a.code() == b.code() && a.note() == b.note() && a.file() == b.file() && a.line() == b.line();
+       return a.type() == b.type() &&
+               a.code() == b.code() &&
+               a.note() == b.note() &&
+               a.file() == b.file() &&
+               a.line() == b.line() &&
+               a.frame() == b.frame() &&
+               a.component() == b.component() &&
+               a.size() == b.size() &&
+               a.id() == b.id() &&
+               a.other_id() == b.other_id() &&
+               a.frame_rate() == b.frame_rate() &&
+               a.reference_hash() == b.reference_hash() &&
+               a.calculated_hash() == b.calculated_hash();
 }
 
 
@@ -2142,7 +2218,31 @@ dcp::operator< (dcp::VerificationNote const& a, dcp::VerificationNote const& b)
                return a.file().get_value_or("") < b.file().get_value_or("");
        }
 
-       return a.line().get_value_or(0) < b.line().get_value_or(0);
+       if (a.line() != b.line()) {
+               return a.line().get_value_or(0) < b.line().get_value_or(0);
+       }
+
+       if (a.frame() != b.frame()) {
+               return a.frame().get_value_or(0) < b.frame().get_value_or(0);
+       }
+
+       if (a.component() != b.component()) {
+               return a.component().get_value_or(0) < b.component().get_value_or(0);
+       }
+
+       if (a.size() != b.size()) {
+               return a.size().get_value_or(0) < b.size().get_value_or(0);
+       }
+
+       if (a.id() != b.id()) {
+               return a.id().get_value_or("") < b.id().get_value_or("");
+       }
+
+       if (a.other_id() != b.other_id()) {
+               return a.other_id().get_value_or("") < b.other_id().get_value_or("");
+       }
+
+       return a.frame_rate().get_value_or(0) != b.frame_rate().get_value_or(0);
 }