Ignore HMAC discrepencies when reading DCPs.
[dcpomatic.git] / src / lib / dcp_examiner.cc
index 9bf401125dda6dea75e3a880541603256588e079..ffdcad1c144fd0030a70eefc6215497fecc783f2 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2014-2019 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -23,6 +23,7 @@
 #include "exceptions.h"
 #include "image.h"
 #include "config.h"
+#include "util.h"
 #include <dcp/dcp.h>
 #include <dcp/decrypted_kdm.h>
 #include <dcp/cpl.h>
 #include <dcp/sound_asset.h>
 #include <dcp/sound_asset_reader.h>
 #include <dcp/subtitle_asset.h>
+#include <dcp/reel_atmos_asset.h>
 #include <dcp/reel_subtitle_asset.h>
 #include <dcp/reel_closed_caption_asset.h>
+#include <dcp/reel_markers_asset.h>
 #include <dcp/sound_asset.h>
-#include <boost/foreach.hpp>
 #include <iostream>
 
 #include "i18n.h"
 using std::list;
 using std::cout;
 using std::runtime_error;
-using boost::shared_ptr;
-using boost::dynamic_pointer_cast;
+using std::map;
+using std::shared_ptr;
+using std::string;
+using std::dynamic_pointer_cast;
+using boost::optional;
+
 
 DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
        : DCP (content, tolerant)
-       , _video_length (0)
-       , _audio_length (0)
-       , _has_video (false)
-       , _has_audio (false)
-       , _encrypted (false)
-       , _needs_assets (false)
-       , _kdm_valid (false)
-       , _three_d (false)
 {
        shared_ptr<dcp::CPL> cpl;
 
-       for (int i = 0; i < TEXT_COUNT; ++i) {
+       for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
                _text_count[i] = 0;
        }
 
        if (content->cpl ()) {
                /* Use the CPL that the content was using before */
-               BOOST_FOREACH (shared_ptr<dcp::CPL> i, cpls()) {
+               for (auto i: cpls()) {
                        if (i->id() == content->cpl().get()) {
                                cpl = i;
                        }
@@ -81,9 +79,9 @@ DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
 
                int least_unsatisfied = INT_MAX;
 
-               BOOST_FOREACH (shared_ptr<dcp::CPL> i, cpls()) {
+               for (auto i: cpls()) {
                        int unsatisfied = 0;
-                       BOOST_FOREACH (shared_ptr<dcp::Reel> j, i->reels()) {
+                       for (auto j: i->reels()) {
                                if (j->main_picture() && !j->main_picture()->asset_ref().resolved()) {
                                        ++unsatisfied;
                                }
@@ -93,6 +91,9 @@ DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
                                if (j->main_subtitle() && !j->main_subtitle()->asset_ref().resolved()) {
                                        ++unsatisfied;
                                }
+                               if (j->atmos() && !j->atmos()->asset_ref().resolved()) {
+                                       ++unsatisfied;
+                               }
                        }
 
                        if (unsatisfied < least_unsatisfied) {
@@ -110,7 +111,16 @@ DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
        _name = cpl->content_title_text ();
        _content_kind = cpl->content_kind ();
 
-       BOOST_FOREACH (shared_ptr<dcp::Reel> i, cpl->reels()) {
+       auto try_to_parse_language = [](optional<string> lang) -> boost::optional<dcp::LanguageTag> {
+               try {
+                       if (lang) {
+                               return dcp::LanguageTag (*lang);
+                       }
+               } catch (...) {}
+               return boost::none;
+       };
+
+       for (auto i: cpl->reels()) {
 
                if (i->main_picture ()) {
                        if (!i->main_picture()->asset_ref().resolved()) {
@@ -119,7 +129,7 @@ DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
                                return;
                        }
 
-                       dcp::Fraction const frac = i->main_picture()->edit_rate ();
+                       auto const frac = i->main_picture()->edit_rate ();
                        float const fr = float(frac.numerator) / frac.denominator;
                        if (!_video_frame_rate) {
                                _video_frame_rate = fr;
@@ -128,7 +138,7 @@ DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
                        }
 
                        _has_video = true;
-                       shared_ptr<dcp::PictureAsset> asset = i->main_picture()->asset ();
+                       auto asset = i->main_picture()->asset();
                        if (!_video_size) {
                                _video_size = asset->size ();
                        } else if (_video_size.get() != asset->size ()) {
@@ -146,7 +156,7 @@ DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
                        }
 
                        _has_audio = true;
-                       shared_ptr<dcp::SoundAsset> asset = i->main_sound()->asset ();
+                       auto asset = i->main_sound()->asset();
 
                        if (!_audio_channels) {
                                _audio_channels = asset->channels ();
@@ -161,6 +171,7 @@ DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
                        }
 
                        _audio_length += i->main_sound()->actual_duration();
+                       _audio_language = try_to_parse_language (asset->language());
                }
 
                if (i->main_subtitle ()) {
@@ -170,17 +181,33 @@ DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
                                return;
                        }
 
-                       _text_count[TEXT_OPEN_SUBTITLE] = 1;
+                       _text_count[static_cast<int>(TextType::OPEN_SUBTITLE)] = 1;
+                       _open_subtitle_language = try_to_parse_language (i->main_subtitle()->language());
                }
 
-               BOOST_FOREACH (shared_ptr<dcp::ReelClosedCaptionAsset> j, i->closed_captions()) {
+               for (auto j: i->closed_captions()) {
                        if (!j->asset_ref().resolved()) {
                                /* We are missing this asset so we can't continue; examination will be repeated later */
                                _needs_assets = true;
                                return;
                        }
 
-                       _text_count[TEXT_CLOSED_CAPTION]++;
+                       _text_count[static_cast<int>(TextType::CLOSED_CAPTION)]++;
+                       _dcp_text_tracks.push_back (DCPTextTrack(j->annotation_text(), try_to_parse_language(j->language())));
+               }
+
+               if (i->main_markers ()) {
+                       auto rm = i->main_markers()->get();
+                       _markers.insert (rm.begin(), rm.end());
+               }
+
+               if (i->atmos()) {
+                       _has_atmos = true;
+                       _atmos_length += i->atmos()->actual_duration();
+                       if (_atmos_edit_rate != dcp::Fraction()) {
+                               DCPOMATIC_ASSERT (i->atmos()->edit_rate() == _atmos_edit_rate);
+                       }
+                       _atmos_edit_rate = i->atmos()->edit_rate();
                }
 
                if (i->main_picture()) {
@@ -191,32 +218,65 @@ DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
                        _reel_lengths.push_back (i->main_subtitle()->actual_duration());
                } else if (!i->closed_captions().empty()) {
                        _reel_lengths.push_back (i->closed_captions().front()->actual_duration());
+               } else if (!i->atmos()) {
+                       _reel_lengths.push_back (i->atmos()->actual_duration());
                }
        }
 
-       _encrypted = cpl->encrypted ();
+       _encrypted = cpl->any_encrypted ();
        _kdm_valid = true;
 
-       /* Check that we can read the first picture, sound and subtitle frames of each reel */
+       /* Check first that anything encrypted has a key.  We must do this, as if we try to
+        * read encrypted data with asdcplib without even offering a key it will just return
+        * the encrypted data.  Secondly, check that we can read the first thing from each
+        * asset in each reel.  This checks that when we do have a key it's the right one.
+        */
        try {
-               BOOST_FOREACH (shared_ptr<dcp::Reel> i, cpl->reels()) {
-                       shared_ptr<dcp::PictureAsset> pic = i->main_picture()->asset ();
-                       shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (pic);
-                       shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (pic);
+               for (auto i: cpl->reels()) {
+                       auto pic = i->main_picture()->asset();
+                       if (pic->encrypted() && !pic->key()) {
+                               _kdm_valid = false;
+                       }
+                       auto mono = dynamic_pointer_cast<dcp::MonoPictureAsset>(pic);
+                       auto stereo = dynamic_pointer_cast<dcp::StereoPictureAsset>(pic);
 
                        if (mono) {
-                               mono->start_read()->get_frame(0)->xyz_image ();
+                               auto reader = mono->start_read();
+                               reader->set_check_hmac (false);
+                               reader->get_frame(0)->xyz_image();
                        } else {
-                               stereo->start_read()->get_frame(0)->xyz_image (dcp::EYE_LEFT);
+                               auto reader = stereo->start_read();
+                               reader->set_check_hmac (false);
+                               reader->get_frame(0)->xyz_image(dcp::Eye::LEFT);
                        }
 
                        if (i->main_sound()) {
-                               shared_ptr<dcp::SoundAsset> sound = i->main_sound()->asset ();
-                               i->main_sound()->asset()->start_read()->get_frame(0);
+                               auto sound = i->main_sound()->asset ();
+                               if (sound->encrypted() && !sound->key()) {
+                                       _kdm_valid = false;
+                               }
+                               auto reader = i->main_sound()->asset()->start_read();
+                               reader->set_check_hmac (false);
+                               reader->get_frame(0);
                        }
 
                        if (i->main_subtitle()) {
-                               i->main_subtitle()->asset()->subtitles ();
+                               auto sub = i->main_subtitle()->asset();
+                               auto mxf_sub = dynamic_pointer_cast<dcp::MXF>(sub);
+                               if (mxf_sub && mxf_sub->encrypted() && !mxf_sub->key()) {
+                                       _kdm_valid = false;
+                               }
+                               sub->subtitles ();
+                       }
+
+                       if (i->atmos()) {
+                               auto atmos = i->atmos()->asset();
+                               if (atmos->encrypted() && !atmos->key()) {
+                                       _kdm_valid = false;
+                               }
+                               auto reader = atmos->start_read();
+                               reader->set_check_hmac (false);
+                               reader->get_frame(0);
                        }
                }
        } catch (dcp::ReadError& e) {
@@ -225,10 +285,13 @@ DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
                _kdm_valid = false;
        }
 
-       DCPOMATIC_ASSERT (cpl->standard ());
-       _standard = cpl->standard().get();
+       _standard = cpl->standard();
        _three_d = !cpl->reels().empty() && cpl->reels().front()->main_picture() &&
                dynamic_pointer_cast<dcp::StereoPictureAsset> (cpl->reels().front()->main_picture()->asset());
+       _ratings = cpl->ratings();
+       for (auto i: cpl->content_versions()) {
+               _content_versions.push_back (i.label_text);
+       }
 
        _cpl = cpl->id ();
 }