Fix DCP playback when an incorrect KDM is added, followed by
[dcpomatic.git] / src / lib / dcp_decoder.cc
index 9893cf7fc7318740aef7a8347b89219839e54d28..ab724cd6c75bbb7a5f02326e15b92f3a964a0322 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2014-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2019 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 #include "video_decoder.h"
 #include "audio_decoder.h"
 #include "j2k_image_proxy.h"
-#include "subtitle_decoder.h"
+#include "text_decoder.h"
+#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/reel_picture_asset.h>
 #include <dcp/reel_sound_asset.h>
 #include <dcp/reel_subtitle_asset.h>
+#include <dcp/reel_closed_caption_asset.h>
 #include <dcp/mono_picture_frame.h>
 #include <dcp/stereo_picture_frame.h>
 #include <dcp/sound_frame.h>
 #include <dcp/sound_asset_reader.h>
+#include <dcp/subtitle_image.h>
+#include <dcp/decrypted_kdm.h>
 #include <boost/foreach.hpp>
 #include <iostream>
 
 
 using std::list;
 using std::cout;
+using std::string;
 using boost::shared_ptr;
 using boost::dynamic_pointer_cast;
 using boost::optional;
+using namespace dcpomatic;
 
-DCPDecoder::DCPDecoder (shared_ptr<const DCPContent> c, shared_ptr<Log> log, 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, log));
-       }
-       if (c->audio) {
-               audio.reset (new AudioDecoder (this, c->audio, log, fast));
-       }
-       if (c->subtitle) {
-               /* XXX: this time here should be the time of the first subtitle, not 0 */
-               subtitle.reset (new SubtitleDecoder (this, c->subtitle, log, ContentTime()));
+       if (c->can_be_played()) {
+               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())));
+               }
        }
 
-       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 {
+
+               list<shared_ptr<dcp::CPL> > 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;
+               BOOST_FOREACH (shared_ptr<dcp::CPL> 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 ();
@@ -100,29 +126,39 @@ DCPDecoder::DCPDecoder (shared_ptr<const DCPContent> c, shared_ptr<Log> log, boo
 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;
        }
 
-       double const vfr = _dcp_content->active_video_frame_rate ();
+       double const vfr = _dcp_content->active_video_frame_rate (film());
 
        /* Frame within the (played part of the) reel that is coming up next */
        int64_t const frame = _next.frames_round (vfr);
 
-       /* We must emit subtitles first as when we emit the video for this frame
-          it will expect already to have the subs.
+       shared_ptr<dcp::PictureAsset> picture_asset = (*_reel)->main_picture()->asset();
+       DCPOMATIC_ASSERT (picture_asset);
+
+       /* We must emit texts first as when we emit the video for this frame
+          it will expect already to have the texts.
        */
-       pass_subtitles (_next);
+       pass_texts (_next, picture_asset->size());
 
        if ((_mono_reader || _stereo_reader) && (_decode_referenced || !_dcp_content->reference_video())) {
-               shared_ptr<dcp::PictureAsset> asset = (*_reel)->main_picture()->asset ();
-               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(),
                                shared_ptr<ImageProxy> (
                                        new J2KImageProxy (
                                                _mono_reader->get_frame (entry_point + frame),
-                                               asset->size(),
+                                               picture_asset->size(),
                                                AV_PIX_FMT_XYZ12LE,
                                                _forced_reduction
                                                )
@@ -131,10 +167,11 @@ DCPDecoder::pass ()
                                );
                } else {
                        video->emit (
+                               film(),
                                shared_ptr<ImageProxy> (
                                        new J2KImageProxy (
                                                _stereo_reader->get_frame (entry_point + frame),
-                                               asset->size(),
+                                               picture_asset->size(),
                                                dcp::EYE_LEFT,
                                                AV_PIX_FMT_XYZ12LE,
                                                _forced_reduction
@@ -144,10 +181,11 @@ DCPDecoder::pass ()
                                );
 
                        video->emit (
+                               film(),
                                shared_ptr<ImageProxy> (
                                        new J2KImageProxy (
                                                _stereo_reader->get_frame (entry_point + frame),
-                                               asset->size(),
+                                               picture_asset->size(),
                                                dcp::EYE_RIGHT,
                                                AV_PIX_FMT_XYZ12LE,
                                                _forced_reduction
@@ -159,7 +197,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 ();
 
@@ -174,7 +212,7 @@ DCPDecoder::pass ()
                        }
                }
 
-               audio->emit (_dcp_content->audio->stream(), data, ContentTime::from_frames (_offset, vfr) + _next);
+               audio->emit (film(), _dcp_content->audio->stream(), data, ContentTime::from_frames (_offset, vfr) + _next);
        }
 
        _next += ContentTime::from_frames (1, vfr);
@@ -190,35 +228,100 @@ DCPDecoder::pass ()
 }
 
 void
-DCPDecoder::pass_subtitles (ContentTime next)
+DCPDecoder::pass_texts (ContentTime next, dcp::Size size)
+{
+       list<shared_ptr<TextDecoder> >::const_iterator 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()) {
+               pass_texts (
+                       next,
+                       (*_reel)->main_subtitle()->asset(),
+                       _dcp_content->reference_text(TEXT_OPEN_SUBTITLE),
+                       (*_reel)->main_subtitle()->entry_point().get_value_or(0),
+                       *decoder,
+                       size
+                       );
+               ++decoder;
+       }
+
+       BOOST_FOREACH (shared_ptr<dcp::ReelClosedCaptionAsset> i, (*_reel)->closed_captions()) {
+               pass_texts (
+                       next, i->asset(), _dcp_content->reference_text(TEXT_CLOSED_CAPTION), i->entry_point().get_value_or(0), *decoder, size
+                       );
+               ++decoder;
+       }
+}
+
+void
+DCPDecoder::pass_texts (
+       ContentTime next, shared_ptr<dcp::SubtitleAsset> asset, bool reference, int64_t entry_point, shared_ptr<TextDecoder> decoder, dcp::Size size
+       )
 {
-       double const vfr = _dcp_content->active_video_frame_rate ();
+       double const vfr = _dcp_content->active_video_frame_rate (film());
        /* Frame within the (played part of the) reel that is coming up next */
        int64_t const frame = next.frames_round (vfr);
 
-       if ((*_reel)->main_subtitle() && (_decode_referenced || !_dcp_content->reference_subtitle())) {
-               int64_t const entry_point = (*_reel)->main_subtitle()->entry_point ();
-               list<shared_ptr<dcp::Subtitle> > subs = (*_reel)->main_subtitle()->asset()->subtitles_during (
+       if (_decode_referenced || !reference) {
+               list<shared_ptr<dcp::Subtitle> > subs = asset->subtitles_during (
                        dcp::Time (entry_point + frame, vfr, vfr),
                        dcp::Time (entry_point + frame + 1, vfr, vfr),
                        true
                        );
 
+               list<dcp::SubtitleString> strings;
+
                BOOST_FOREACH (shared_ptr<dcp::Subtitle> i, subs) {
                        shared_ptr<dcp::SubtitleString> is = dynamic_pointer_cast<dcp::SubtitleString> (i);
                        if (is) {
-                               list<dcp::SubtitleString> s;
-                               s.push_back (*is);
-                               subtitle->emit_text (
+                               if (!strings.empty() && (strings.back().in() != is->in() || strings.back().out() != is->out())) {
+                                       dcp::SubtitleString b = strings.back();
+                                       decoder->emit_plain (
+                                               ContentTimePeriod (
+                                                       ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.in().as_seconds()),
+                                                       ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.out().as_seconds())
+                                                       ),
+                                               strings
+                                               );
+                                       strings.clear ();
+                               }
+
+                               strings.push_back (*is);
+                       }
+
+                       /* 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.
+                       */
+
+                       shared_ptr<dcp::SubtitleImage> ii = dynamic_pointer_cast<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 ())
                                                ),
-                                       s
+                                       *ii,
+                                       size,
+                                       decoder
                                        );
                        }
+               }
 
-                       /* XXX: image subtitles */
+               if (!strings.empty()) {
+                       dcp::SubtitleString b = strings.back();
+                       decoder->emit_plain (
+                               ContentTimePeriod (
+                                       ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.in().as_seconds()),
+                                       ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.out().as_seconds())
+                                       ),
+                               strings
+                               );
+                       strings.clear ();
                }
        }
 }
@@ -226,7 +329,7 @@ DCPDecoder::pass_subtitles (ContentTime next)
 void
 DCPDecoder::next_reel ()
 {
-       _offset += (*_reel)->main_picture()->duration();
+       _offset += (*_reel)->main_picture()->actual_duration();
        ++_reel;
        get_readers ();
 }
@@ -289,25 +392,33 @@ 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 ())) {
-               ContentTime rd = ContentTime::from_frames ((*_reel)->main_picture()->duration(), _dcp_content->active_video_frame_rate ());
+       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 ();
        }
 
-       /* Pass subtitles in the pre-roll */
+       /* Pass texts in the pre-roll */
 
-       double const vfr = _dcp_content->active_video_frame_rate ();
+       double const vfr = _dcp_content->active_video_frame_rate (film());
        for (int i = 0; i < pre_roll_seconds * vfr; ++i) {
-               pass_subtitles (pre);
+               pass_texts (pre, (*_reel)->main_picture()->asset()->size());
                pre += ContentTime::from_frames (1, vfr);
        }
 
        /* Seek to correct position */
 
-       while (_reel != _reels.end() && t >= ContentTime::from_frames ((*_reel)->main_picture()->duration(), _dcp_content->active_video_frame_rate ())) {
-               t -= ContentTime::from_frames ((*_reel)->main_picture()->duration(), _dcp_content->active_video_frame_rate ());
+       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 ();
        }
 
@@ -332,3 +443,26 @@ DCPDecoder::set_forced_reduction (optional<int> reduction)
 {
        _forced_reduction = reduction;
 }
+
+string
+DCPDecoder::calculate_lazy_digest (shared_ptr<const DCPContent> c) const
+{
+       Digester d;
+       BOOST_FOREACH (boost::filesystem::path 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;
+}