Ignore HMAC discrepencies when reading DCPs.
[dcpomatic.git] / src / lib / dcp_examiner.cc
index 1e4cc899df96df614fd6a9b1413d3101245247a4..ffdcad1c144fd0030a70eefc6215497fecc783f2 100644 (file)
 /*
-    Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2020 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
+#include "dcp_examiner.h"
+#include "dcp_content.h"
+#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/reel.h>
 #include <dcp/reel_picture_asset.h>
 #include <dcp/reel_sound_asset.h>
-#include <dcp/mono_picture_mxf.h>
+#include <dcp/mono_picture_asset.h>
+#include <dcp/mono_picture_asset_reader.h>
 #include <dcp/mono_picture_frame.h>
-#include <dcp/stereo_picture_mxf.h>
+#include <dcp/stereo_picture_asset.h>
+#include <dcp/stereo_picture_asset_reader.h>
 #include <dcp/stereo_picture_frame.h>
-#include <dcp/sound_mxf.h>
-#include "dcp_examiner.h"
-#include "dcp_content.h"
-#include "exceptions.h"
-#include "image.h"
-#include "config.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 <iostream>
 
 #include "i18n.h"
 
 using std::list;
 using std::cout;
-using boost::shared_ptr;
-using boost::dynamic_pointer_cast;
-
-DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content)
-       : _video_length (0)
-       , _audio_length (0)
-       , _has_subtitles (false)
-       , _encrypted (false)
-       , _kdm_valid (false)
+using std::runtime_error;
+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)
 {
-       dcp::DCP dcp (content->directory ());
-       dcp.read ();
+       shared_ptr<dcp::CPL> cpl;
 
-       if (content->kdm ()) {
-               dcp.add (dcp::DecryptedKDM (content->kdm().get(), Config::instance()->decryption_private_key ()));
+       for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
+               _text_count[i] = 0;
        }
 
-       if (dcp.cpls().size() == 0) {
+       if (content->cpl ()) {
+               /* Use the CPL that the content was using before */
+               for (auto i: cpls()) {
+                       if (i->id() == content->cpl().get()) {
+                               cpl = i;
+                       }
+               }
+       } else {
+               /* Choose the CPL with the fewest unsatisfied references */
+
+               int least_unsatisfied = INT_MAX;
+
+               for (auto i: cpls()) {
+                       int unsatisfied = 0;
+                       for (auto j: i->reels()) {
+                               if (j->main_picture() && !j->main_picture()->asset_ref().resolved()) {
+                                       ++unsatisfied;
+                               }
+                               if (j->main_sound() && !j->main_sound()->asset_ref().resolved()) {
+                                       ++unsatisfied;
+                               }
+                               if (j->main_subtitle() && !j->main_subtitle()->asset_ref().resolved()) {
+                                       ++unsatisfied;
+                               }
+                               if (j->atmos() && !j->atmos()->asset_ref().resolved()) {
+                                       ++unsatisfied;
+                               }
+                       }
+
+                       if (unsatisfied < least_unsatisfied) {
+                               least_unsatisfied = unsatisfied;
+                               cpl = i;
+                       }
+               }
+       }
+
+       if (!cpl) {
                throw DCPError ("No CPLs found in DCP");
-       } else if (dcp.cpls().size() > 1) {
-               throw DCPError ("Multiple CPLs found in DCP");
        }
 
-       _name = dcp.cpls().front()->content_title_text ();
+       _cpl = cpl->id ();
+       _name = cpl->content_title_text ();
+       _content_kind = cpl->content_kind ();
+
+       auto try_to_parse_language = [](optional<string> lang) -> boost::optional<dcp::LanguageTag> {
+               try {
+                       if (lang) {
+                               return dcp::LanguageTag (*lang);
+                       }
+               } catch (...) {}
+               return boost::none;
+       };
 
-       list<shared_ptr<dcp::Reel> > reels = dcp.cpls().front()->reels ();
-       for (list<shared_ptr<dcp::Reel> >::const_iterator i = reels.begin(); i != reels.end(); ++i) {
+       for (auto i: cpl->reels()) {
 
-               if ((*i)->main_picture ()) {
-                       dcp::Fraction const frac = (*i)->main_picture()->frame_rate ();
+               if (i->main_picture ()) {
+                       if (!i->main_picture()->asset_ref().resolved()) {
+                               /* We are missing this asset so we can't continue; examination will be repeated later */
+                               _needs_assets = true;
+                               return;
+                       }
+
+                       auto const frac = i->main_picture()->edit_rate ();
                        float const fr = float(frac.numerator) / frac.denominator;
                        if (!_video_frame_rate) {
                                _video_frame_rate = fr;
@@ -74,63 +137,161 @@ DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content)
                                throw DCPError (_("Mismatched frame rates in DCP"));
                        }
 
-                       shared_ptr<dcp::PictureMXF> mxf = (*i)->main_picture()->mxf ();
+                       _has_video = true;
+                       auto asset = i->main_picture()->asset();
                        if (!_video_size) {
-                               _video_size = mxf->size ();
-                       } else if (_video_size.get() != mxf->size ()) {
+                               _video_size = asset->size ();
+                       } else if (_video_size.get() != asset->size ()) {
                                throw DCPError (_("Mismatched video sizes in DCP"));
                        }
 
-                       _video_length += ContentTime::from_frames ((*i)->main_picture()->duration(), _video_frame_rate.get ());
+                       _video_length += i->main_picture()->actual_duration();
                }
-                       
-               if ((*i)->main_sound ()) {
-                       shared_ptr<dcp::SoundMXF> mxf = (*i)->main_sound()->mxf ();
+
+               if (i->main_sound ()) {
+                       if (!i->main_sound()->asset_ref().resolved()) {
+                               /* We are missing this asset so we can't continue; examination will be repeated later */
+                               _needs_assets = true;
+                               return;
+                       }
+
+                       _has_audio = true;
+                       auto asset = i->main_sound()->asset();
 
                        if (!_audio_channels) {
-                               _audio_channels = mxf->channels ();
-                       } else if (_audio_channels.get() != mxf->channels ()) {
+                               _audio_channels = asset->channels ();
+                       } else if (_audio_channels.get() != asset->channels ()) {
                                throw DCPError (_("Mismatched audio channel counts in DCP"));
                        }
 
                        if (!_audio_frame_rate) {
-                               _audio_frame_rate = mxf->sampling_rate ();
-                       } else if (_audio_frame_rate.get() != mxf->sampling_rate ()) {
-                               throw DCPError (_("Mismatched audio frame rates in DCP"));
+                               _audio_frame_rate = asset->sampling_rate ();
+                       } else if (_audio_frame_rate.get() != asset->sampling_rate ()) {
+                               throw DCPError (_("Mismatched audio sample rates in DCP"));
+                       }
+
+                       _audio_length += i->main_sound()->actual_duration();
+                       _audio_language = try_to_parse_language (asset->language());
+               }
+
+               if (i->main_subtitle ()) {
+                       if (!i->main_subtitle()->asset_ref().resolved()) {
+                               /* We are missing this asset so we can't continue; examination will be repeated later */
+                               _needs_assets = true;
+                               return;
+                       }
+
+                       _text_count[static_cast<int>(TextType::OPEN_SUBTITLE)] = 1;
+                       _open_subtitle_language = try_to_parse_language (i->main_subtitle()->language());
+               }
+
+               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;
                        }
 
-                       _audio_length += ContentTime::from_frames ((*i)->main_sound()->duration(), _video_frame_rate.get ());
+                       _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_subtitle ()) {
-                       _has_subtitles = true;
+               if (i->main_picture()) {
+                       _reel_lengths.push_back (i->main_picture()->actual_duration());
+               } else if (i->main_sound()) {
+                       _reel_lengths.push_back (i->main_sound()->actual_duration());
+               } else if (i->main_subtitle()) {
+                       _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 = dcp.encrypted ();
+       _encrypted = cpl->any_encrypted ();
        _kdm_valid = true;
-       
-       /* Check that we can read the first picture frame */
+
+       /* 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 {
-               if (!dcp.cpls().empty () && !dcp.cpls().front()->reels().empty ()) {
-                       shared_ptr<dcp::PictureMXF> mxf = dcp.cpls().front()->reels().front()->main_picture()->mxf ();
-                       shared_ptr<dcp::MonoPictureMXF> mono = dynamic_pointer_cast<dcp::MonoPictureMXF> (mxf);
-                       shared_ptr<dcp::StereoPictureMXF> stereo = dynamic_pointer_cast<dcp::StereoPictureMXF> (mxf);
-                       
-                       shared_ptr<Image> image (new Image (PIX_FMT_RGB24, _video_size.get(), false));
-                       
+               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->get_frame(0)->rgb_frame (image->data()[0]);
+                               auto reader = mono->start_read();
+                               reader->set_check_hmac (false);
+                               reader->get_frame(0)->xyz_image();
                        } else {
-                               stereo->get_frame(0)->rgb_frame (dcp::EYE_LEFT, image->data()[0]);
+                               auto reader = stereo->start_read();
+                               reader->set_check_hmac (false);
+                               reader->get_frame(0)->xyz_image(dcp::Eye::LEFT);
+                       }
+
+                       if (i->main_sound()) {
+                               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()) {
+                               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::DCPReadError& e) {
+       } catch (dcp::ReadError& e) {
+               _kdm_valid = false;
+       } catch (dcp::MiscError& e) {
                _kdm_valid = false;
-               if (_encrypted && content->kdm ()) {
-                       /* XXX: maybe don't use an exception for this */
-                       throw StringError (_("The KDM does not decrypt the DCP.  Perhaps it is targeted at the wrong CPL"));
-               }
        }
+
+       _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 ();
 }