Ignore HMAC discrepencies when reading DCPs.
[dcpomatic.git] / src / lib / dcp_decoder.cc
index 1098bb87a8c94a8df56cf2ca0f3a7d40cd24f72c..9de63dc936401748c8956c9217ce24ee1990637a 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2014-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -18,6 +18,7 @@
 
 */
 
+#include "atmos_decoder.h"
 #include "dcp_decoder.h"
 #include "dcp_content.h"
 #include "audio_content.h"
@@ -28,6 +29,8 @@
 #include "ffmpeg_image_proxy.h"
 #include "image.h"
 #include "config.h"
+#include "digester.h"
+#include "frame_interval_checker.h"
 #include <dcp/dcp.h>
 #include <dcp/cpl.h>
 #include <dcp/reel.h>
 #include <dcp/sound_frame.h>
 #include <dcp/sound_asset_reader.h>
 #include <dcp/subtitle_image.h>
-#include <boost/foreach.hpp>
+#include <dcp/decrypted_kdm.h>
+#include <dcp/reel_atmos_asset.h>
 #include <iostream>
 
 #include "i18n.h"
 
 using std::list;
 using std::cout;
-using boost::shared_ptr;
-using boost::dynamic_pointer_cast;
+using std::map;
+using std::string;
+using std::vector;
+using std::shared_ptr;
+using std::dynamic_pointer_cast;
+using std::make_shared;
 using boost::optional;
+using namespace dcpomatic;
 
-DCPDecoder::DCPDecoder (shared_ptr<const Film> film, shared_ptr<const DCPContent> c, bool fast)
-       : DCP (c)
+DCPDecoder::DCPDecoder (shared_ptr<const Film> film, shared_ptr<const DCPContent> c, bool fast, bool tolerant, shared_ptr<DCPDecoder> old)
+       : DCP (c, tolerant)
        , Decoder (film)
-       , _decode_referenced (false)
 {
-       if (c->video) {
-               video.reset (new VideoDecoder (this, c));
-       }
-       if (c->audio) {
-               audio.reset (new AudioDecoder (this, c->audio, fast));
-       }
-       BOOST_FOREACH (shared_ptr<TextContent> i, c->text) {
-               /* XXX: this time here should be the time of the first subtitle, not 0 */
-               text.push_back (shared_ptr<TextDecoder> (new TextDecoder (this, i, ContentTime())));
+       if (c->can_be_played()) {
+               if (c->video) {
+                       video = make_shared<VideoDecoder>(this, c);
+               }
+               if (c->audio) {
+                       audio = make_shared<AudioDecoder>(this, c->audio, fast);
+               }
+               for (auto i: c->text) {
+                       /* XXX: this time here should be the time of the first subtitle, not 0 */
+                       text.push_back (make_shared<TextDecoder>(this, i, ContentTime()));
+               }
+               if (c->atmos) {
+                       atmos = make_shared<AtmosDecoder>(this, c);
+               }
        }
 
-       list<shared_ptr<dcp::CPL> > cpl_list = cpls ();
+       /* We try to avoid re-scanning the DCP's files every time we make a new DCPDecoder; we do this
+          by re-using the _reels list.  Before we do this we need to check that nothing too serious
+          has changed in the DCPContent.
 
-       if (cpl_list.empty()) {
-               throw DCPError (_("No CPLs found in DCP."));
-       }
+          We do this by storing a digest of the important bits of the DCPContent and then checking that's
+          the same before we re-use _reels.
+       */
 
-       shared_ptr<dcp::CPL> cpl;
-       BOOST_FOREACH (shared_ptr<dcp::CPL> i, cpl_list) {
-               if (_dcp_content->cpl() && i->id() == _dcp_content->cpl().get()) {
-                       cpl = i;
+       _lazy_digest = calculate_lazy_digest (c);
+
+       if (old && old->lazy_digest() == _lazy_digest) {
+               _reels = old->_reels;
+       } else {
+
+               auto cpl_list = cpls ();
+
+               if (cpl_list.empty()) {
+                       throw DCPError (_("No CPLs found in DCP."));
                }
-       }
 
-       if (!cpl) {
-               /* No CPL found; probably an old file that doesn't specify it;
-                  just use the first one.
-               */
-               cpl = cpls().front ();
+               shared_ptr<dcp::CPL> cpl;
+               for (auto i: cpl_list) {
+                       if (_dcp_content->cpl() && i->id() == _dcp_content->cpl().get()) {
+                               cpl = i;
+                       }
+               }
+
+               if (!cpl) {
+                       /* No CPL found; probably an old file that doesn't specify it;
+                          just use the first one.
+                       */
+                       cpl = cpls().front ();
+               }
+
+               _reels = cpl->reels ();
        }
 
        set_decode_referenced (false);
 
-       _reels = cpl->reels ();
-
        _reel = _reels.begin ();
-       _offset = 0;
        get_readers ();
 }
 
@@ -104,7 +131,14 @@ DCPDecoder::DCPDecoder (shared_ptr<const Film> film, shared_ptr<const DCPContent
 bool
 DCPDecoder::pass ()
 {
-       if (_reel == _reels.end () || !_dcp_content->can_be_played ()) {
+       if (!_dcp_content->can_be_played()) {
+               return true;
+       }
+
+       if (_reel == _reels.end()) {
+               if (audio) {
+                       audio->flush ();
+               }
                return true;
        }
 
@@ -122,7 +156,7 @@ DCPDecoder::pass ()
        pass_texts (_next, picture_asset->size());
 
        if ((_mono_reader || _stereo_reader) && (_decode_referenced || !_dcp_content->reference_video())) {
-               int64_t const entry_point = (*_reel)->main_picture()->entry_point ();
+               int64_t const entry_point = (*_reel)->main_picture()->entry_point().get_value_or(0);
                if (_mono_reader) {
                        video->emit (
                                film(),
@@ -143,7 +177,7 @@ DCPDecoder::pass ()
                                        new J2KImageProxy (
                                                _stereo_reader->get_frame (entry_point + frame),
                                                picture_asset->size(),
-                                               dcp::EYE_LEFT,
+                                               dcp::Eye::LEFT,
                                                AV_PIX_FMT_XYZ12LE,
                                                _forced_reduction
                                                )
@@ -157,7 +191,7 @@ DCPDecoder::pass ()
                                        new J2KImageProxy (
                                                _stereo_reader->get_frame (entry_point + frame),
                                                picture_asset->size(),
-                                               dcp::EYE_RIGHT,
+                                               dcp::Eye::RIGHT,
                                                AV_PIX_FMT_XYZ12LE,
                                                _forced_reduction
                                                )
@@ -168,7 +202,7 @@ DCPDecoder::pass ()
        }
 
        if (_sound_reader && (_decode_referenced || !_dcp_content->reference_audio())) {
-               int64_t const entry_point = (*_reel)->main_sound()->entry_point ();
+               int64_t const entry_point = (*_reel)->main_sound()->entry_point().get_value_or(0);
                shared_ptr<const dcp::SoundFrame> sf = _sound_reader->get_frame (entry_point + frame);
                uint8_t const * from = sf->data ();
 
@@ -186,6 +220,12 @@ DCPDecoder::pass ()
                audio->emit (film(), _dcp_content->audio->stream(), data, ContentTime::from_frames (_offset, vfr) + _next);
        }
 
+       if (_atmos_reader) {
+               DCPOMATIC_ASSERT (_atmos_metadata);
+               int64_t const entry_point = (*_reel)->atmos()->entry_point().get_value_or(0);
+               atmos->emit (film(), _atmos_reader->get_frame(entry_point + frame), _offset + frame, *_atmos_metadata);
+       }
+
        _next += ContentTime::from_frames (1, vfr);
 
        if ((*_reel)->main_picture ()) {
@@ -201,23 +241,29 @@ DCPDecoder::pass ()
 void
 DCPDecoder::pass_texts (ContentTime next, dcp::Size size)
 {
-       list<shared_ptr<TextDecoder> >::const_iterator decoder = text.begin ();
+       auto decoder = text.begin ();
+       if (decoder == text.end()) {
+               /* It's possible that there is now a main subtitle but no TextDecoders, for example if
+                  the CPL has just changed but the TextContent's texts have not been recreated yet.
+               */
+               return;
+       }
+
        if ((*_reel)->main_subtitle()) {
-               DCPOMATIC_ASSERT (decoder != text.end ());
                pass_texts (
                        next,
                        (*_reel)->main_subtitle()->asset(),
-                       _dcp_content->reference_text(TEXT_OPEN_SUBTITLE),
-                       (*_reel)->main_subtitle()->entry_point(),
+                       _dcp_content->reference_text(TextType::OPEN_SUBTITLE),
+                       (*_reel)->main_subtitle()->entry_point().get_value_or(0),
                        *decoder,
                        size
                        );
                ++decoder;
        }
-       BOOST_FOREACH (shared_ptr<dcp::ReelClosedCaptionAsset> i, (*_reel)->closed_captions()) {
-               DCPOMATIC_ASSERT (decoder != text.end ());
+
+       for (auto i: (*_reel)->closed_captions()) {
                pass_texts (
-                       next, i->asset(), _dcp_content->reference_text(TEXT_CLOSED_CAPTION), i->entry_point(), *decoder, size
+                       next, i->asset(), _dcp_content->reference_text(TextType::CLOSED_CAPTION), i->entry_point().get_value_or(0), *decoder, size
                        );
                ++decoder;
        }
@@ -233,7 +279,7 @@ DCPDecoder::pass_texts (
        int64_t const frame = next.frames_round (vfr);
 
        if (_decode_referenced || !reference) {
-               list<shared_ptr<dcp::Subtitle> > subs = asset->subtitles_during (
+               auto subs = asset->subtitles_during (
                        dcp::Time (entry_point + frame, vfr, vfr),
                        dcp::Time (entry_point + frame + 1, vfr, vfr),
                        true
@@ -241,11 +287,11 @@ DCPDecoder::pass_texts (
 
                list<dcp::SubtitleString> strings;
 
-               BOOST_FOREACH (shared_ptr<dcp::Subtitle> i, subs) {
-                       shared_ptr<dcp::SubtitleString> is = dynamic_pointer_cast<dcp::SubtitleString> (i);
+               for (auto i: subs) {
+                       auto is = dynamic_pointer_cast<const dcp::SubtitleString>(i);
                        if (is) {
                                if (!strings.empty() && (strings.back().in() != is->in() || strings.back().out() != is->out())) {
-                                       dcp::SubtitleString b = strings.back();
+                                       auto b = strings.back();
                                        decoder->emit_plain (
                                                ContentTimePeriod (
                                                        ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.in().as_seconds()),
@@ -259,51 +305,26 @@ DCPDecoder::pass_texts (
                                strings.push_back (*is);
                        }
 
-                       shared_ptr<dcp::SubtitleImage> ii = dynamic_pointer_cast<dcp::SubtitleImage> (i);
-                       if (ii) {
-                               FFmpegImageProxy proxy (ii->png_image());
-                               shared_ptr<Image> image = proxy.image().first;
-                               /* set up rect with height and width */
-                               dcpomatic::Rect<double> rect(0, 0, image->size().width / double(size.width), image->size().height / double(size.height));
-
-                               /* add in position */
-
-                               switch (ii->h_align()) {
-                               case dcp::HALIGN_LEFT:
-                                       rect.x += ii->h_position();
-                                       break;
-                               case dcp::HALIGN_CENTER:
-                                       rect.x += 0.5 + ii->h_position() - rect.width / 2;
-                                       break;
-                               case dcp::HALIGN_RIGHT:
-                                       rect.x += 1 - ii->h_position() - rect.width;
-                                       break;
-                               }
-
-                               switch (ii->v_align()) {
-                               case dcp::VALIGN_TOP:
-                                       rect.y += ii->v_position();
-                                       break;
-                               case dcp::VALIGN_CENTER:
-                                       rect.y += 0.5 + ii->v_position() - rect.height / 2;
-                                       break;
-                               case dcp::VALIGN_BOTTOM:
-                                       rect.y += 1 - ii->v_position() - rect.height;
-                                       break;
-                               }
+                       /* XXX: perhaps these image subs should also be collected together like the string ones are;
+                          this would need to be done both here and in DCPSubtitleDecoder.
+                       */
 
-                               decoder->emit_bitmap (
+                       auto ii = dynamic_pointer_cast<const dcp::SubtitleImage>(i);
+                       if (ii) {
+                               emit_subtitle_image (
                                        ContentTimePeriod (
                                                ContentTime::from_frames (_offset - entry_point, vfr) + ContentTime::from_seconds (i->in().as_seconds ()),
                                                ContentTime::from_frames (_offset - entry_point, vfr) + ContentTime::from_seconds (i->out().as_seconds ())
                                                ),
-                                       image, rect
+                                       *ii,
+                                       size,
+                                       decoder
                                        );
                        }
                }
 
                if (!strings.empty()) {
-                       dcp::SubtitleString b = strings.back();
+                       auto b = strings.back();
                        decoder->emit_plain (
                                ContentTimePeriod (
                                        ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.in().as_seconds()),
@@ -319,7 +340,7 @@ DCPDecoder::pass_texts (
 void
 DCPDecoder::next_reel ()
 {
-       _offset += (*_reel)->main_picture()->duration();
+       _offset += (*_reel)->main_picture()->actual_duration();
        ++_reel;
        get_readers ();
 }
@@ -331,6 +352,7 @@ DCPDecoder::get_readers ()
                _mono_reader.reset ();
                _stereo_reader.reset ();
                _sound_reader.reset ();
+               _atmos_reader.reset ();
                return;
        }
 
@@ -341,9 +363,11 @@ DCPDecoder::get_readers ()
                DCPOMATIC_ASSERT (mono || stereo);
                if (mono) {
                        _mono_reader = mono->start_read ();
+                       _mono_reader->set_check_hmac (false);
                        _stereo_reader.reset ();
                } else {
                        _stereo_reader = stereo->start_read ();
+                       _stereo_reader->set_check_hmac (false);
                        _mono_reader.reset ();
                }
        } else {
@@ -353,9 +377,20 @@ DCPDecoder::get_readers ()
 
        if ((*_reel)->main_sound()) {
                _sound_reader = (*_reel)->main_sound()->asset()->start_read ();
+               _sound_reader->set_check_hmac (false);
        } else {
                _sound_reader.reset ();
        }
+
+       if ((*_reel)->atmos()) {
+               shared_ptr<dcp::AtmosAsset> asset = (*_reel)->atmos()->asset();
+               _atmos_reader = asset->start_read();
+               _atmos_reader->set_check_hmac (false);
+               _atmos_metadata = AtmosMetadata (asset);
+       } else {
+               _atmos_reader.reset ();
+               _atmos_metadata = boost::none;
+       }
 }
 
 void
@@ -382,8 +417,12 @@ DCPDecoder::seek (ContentTime t, bool accurate)
 
        /* Seek to pre-roll position */
 
-       while (_reel != _reels.end() && pre >= ContentTime::from_frames ((*_reel)->main_picture()->duration(), _dcp_content->active_video_frame_rate(film()))) {
-               ContentTime rd = ContentTime::from_frames ((*_reel)->main_picture()->duration(), _dcp_content->active_video_frame_rate(film()));
+       while (
+               _reel != _reels.end() &&
+               pre >= ContentTime::from_frames ((*_reel)->main_picture()->actual_duration(), _dcp_content->active_video_frame_rate(film()))
+               ) {
+
+               ContentTime rd = ContentTime::from_frames ((*_reel)->main_picture()->actual_duration(), _dcp_content->active_video_frame_rate(film()));
                pre -= rd;
                t -= rd;
                next_reel ();
@@ -399,8 +438,12 @@ DCPDecoder::seek (ContentTime t, bool accurate)
 
        /* Seek to correct position */
 
-       while (_reel != _reels.end() && t >= ContentTime::from_frames ((*_reel)->main_picture()->duration(), _dcp_content->active_video_frame_rate(film()))) {
-               t -= ContentTime::from_frames ((*_reel)->main_picture()->duration(), _dcp_content->active_video_frame_rate(film()));
+       while (
+               _reel != _reels.end() &&
+               t >= ContentTime::from_frames ((*_reel)->main_picture()->actual_duration(), _dcp_content->active_video_frame_rate(film()))
+               ) {
+
+               t -= ContentTime::from_frames ((*_reel)->main_picture()->actual_duration(), _dcp_content->active_video_frame_rate(film()));
                next_reel ();
        }
 
@@ -425,3 +468,43 @@ DCPDecoder::set_forced_reduction (optional<int> reduction)
 {
        _forced_reduction = reduction;
 }
+
+string
+DCPDecoder::calculate_lazy_digest (shared_ptr<const DCPContent> c) const
+{
+       Digester d;
+       for (auto i: c->paths()) {
+               d.add (i.string());
+       }
+       if (_dcp_content->kdm()) {
+               d.add(_dcp_content->kdm()->id());
+       }
+       d.add (static_cast<bool>(c->cpl()));
+       if (c->cpl()) {
+               d.add (c->cpl().get());
+       }
+       return d.get ();
+}
+
+ContentTime
+DCPDecoder::position () const
+{
+       return ContentTime::from_frames(_offset, _dcp_content->active_video_frame_rate(film())) + _next;
+}
+
+
+vector<FontData>
+DCPDecoder::fonts () const
+{
+       vector<FontData> data;
+       for (auto i: _reels) {
+               if (i->main_subtitle() && i->main_subtitle()->asset()) {
+                       map<string, dcp::ArrayData> fm = i->main_subtitle()->asset()->font_data();
+                       for (map<string, dcp::ArrayData>::const_iterator j = fm.begin(); j != fm.end(); ++j) {
+                               data.push_back (FontData(j->first, j->second));
+                       }
+               }
+       }
+       return data;
+}
+