/*
- Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2014-2021 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 "config.h"
+#include "constants.h"
#include "dcp_content.h"
+#include "dcp_examiner.h"
+#include "dcpomatic_log.h"
#include "exceptions.h"
#include "image.h"
-#include "config.h"
-#include <dcp/dcp.h>
+#include "text_content.h"
+#include "util.h"
#include <dcp/cpl.h>
+#include <dcp/dcp.h>
+#include <dcp/decrypted_kdm.h>
+#include <dcp/mono_picture_asset.h>
+#include <dcp/mono_picture_asset_reader.h>
+#include <dcp/mono_picture_frame.h>
#include <dcp/reel.h>
+#include <dcp/reel_atmos_asset.h>
+#include <dcp/reel_closed_caption_asset.h>
+#include <dcp/reel_markers_asset.h>
#include <dcp/reel_picture_asset.h>
#include <dcp/reel_sound_asset.h>
-#include <dcp/mono_picture_asset.h>
-#include <dcp/mono_picture_frame.h>
+#include <dcp/reel_subtitle_asset.h>
+#include <dcp/search.h>
+#include <dcp/sound_asset.h>
+#include <dcp/sound_asset.h>
+#include <dcp/sound_asset_reader.h>
#include <dcp/stereo_picture_asset.h>
+#include <dcp/stereo_picture_asset_reader.h>
#include <dcp/stereo_picture_frame.h>
-#include <dcp/sound_asset.h>
+#include <dcp/subtitle_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::dynamic_pointer_cast;
+using std::make_shared;
+using std::shared_ptr;
+using std::string;
+using std::vector;
+using boost::optional;
+
+
+DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
{
- dcp::DCP dcp (content->directory ());
- dcp.read ();
+ shared_ptr<dcp::CPL> selected_cpl;
+
+ auto cpls = dcp::find_and_resolve_cpls (content->directories(), tolerant);
+
+ if (content->cpl ()) {
+ /* Use the CPL that was specified, or that the content was using before */
+ auto iter = std::find_if(cpls.begin(), cpls.end(), [content](shared_ptr<dcp::CPL> cpl) { return cpl->id() == content->cpl().get(); });
+ if (iter == cpls.end()) {
+ throw CPLNotFoundError(content->cpl().get());
+ }
+ selected_cpl = *iter;
+ } else {
+ /* Choose the CPL with the fewest unsatisfied references */
+
+ int least_unsatisfied = INT_MAX;
- if (content->kdm ()) {
- dcp.add (dcp::DecryptedKDM (content->kdm().get(), Config::instance()->decryption_private_key ()));
+ for (auto cpl: cpls) {
+ int unsatisfied = 0;
+ for (auto const& reel: cpl->reels()) {
+ if (reel->main_picture() && !reel->main_picture()->asset_ref().resolved()) {
+ ++unsatisfied;
+ }
+ if (reel->main_sound() && !reel->main_sound()->asset_ref().resolved()) {
+ ++unsatisfied;
+ }
+ if (reel->main_subtitle() && !reel->main_subtitle()->asset_ref().resolved()) {
+ ++unsatisfied;
+ }
+ if (reel->atmos() && !reel->atmos()->asset_ref().resolved()) {
+ ++unsatisfied;
+ }
+ }
+
+ if (unsatisfied < least_unsatisfied) {
+ least_unsatisfied = unsatisfied;
+ selected_cpl = cpl;
+ }
+ }
}
- if (dcp.cpls().size() == 0) {
+ if (!selected_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 ();
+ if (content->kdm()) {
+ selected_cpl->add(decrypt_kdm_with_helpful_error(content->kdm().get()));
+ }
+
+ _cpl = selected_cpl->id();
+ _name = selected_cpl->content_title_text();
+ _content_kind = selected_cpl->content_kind();
+
+ LOG_GENERAL ("Selected CPL %1", _cpl);
+
+ auto try_to_parse_language = [](optional<string> lang) -> boost::optional<dcp::LanguageTag> {
+ try {
+ if (lang) {
+ return dcp::LanguageTag (*lang);
+ }
+ } catch (...) {}
+ return boost::none;
+ };
+
+ LOG_GENERAL("Looking at %1 reels", selected_cpl->reels().size());
+
+ int reel_index = 0;
+ for (auto reel: selected_cpl->reels()) {
+ LOG_GENERAL("Reel %1", reel->id());
- 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) {
+ if (reel->main_picture()) {
+ if (!reel->main_picture()->asset_ref().resolved()) {
+ /* We are missing this asset so we can't continue; examination will be repeated later */
+ _needs_assets = true;
+ LOG_GENERAL("Main picture %1 of reel %2 is missing", reel->main_picture()->id(), reel->id());
+ return;
+ }
+
+ LOG_GENERAL("Main picture %1 of reel %2 found", reel->main_picture()->id(), reel->id());
- if ((*i)->main_picture ()) {
- dcp::Fraction const frac = (*i)->main_picture()->frame_rate ();
+ auto const frac = reel->main_picture()->edit_rate();
float const fr = float(frac.numerator) / frac.denominator;
if (!_video_frame_rate) {
_video_frame_rate = fr;
throw DCPError (_("Mismatched frame rates in DCP"));
}
- shared_ptr<dcp::PictureAsset> asset = (*i)->main_picture()->asset ();
+ _has_video = true;
+ auto asset = reel->main_picture()->asset();
if (!_video_size) {
_video_size = asset->size ();
} else if (_video_size.get() != asset->size ()) {
throw DCPError (_("Mismatched video sizes in DCP"));
}
- _video_length += (*i)->main_picture()->duration();
+ _video_length += reel->main_picture()->actual_duration();
}
-
- if ((*i)->main_sound ()) {
- shared_ptr<dcp::SoundAsset> asset = (*i)->main_sound()->asset ();
+
+ if (reel->main_sound()) {
+ if (!reel->main_sound()->asset_ref().resolved()) {
+ /* We are missing this asset so we can't continue; examination will be repeated later */
+ _needs_assets = true;
+ LOG_GENERAL("Main sound %1 of reel %2 is missing", reel->main_sound()->id(), reel->id());
+ return;
+ }
+
+ LOG_GENERAL("Main sound %1 of reel %2 found", reel->main_sound()->id(), reel->id());
+
+ _has_audio = true;
+ auto asset = reel->main_sound()->asset();
if (!_audio_channels) {
- _audio_channels = asset->channels ();
- } else if (_audio_channels.get() != asset->channels ()) {
+ _audio_channels = asset->channels();
+ } else if (_audio_channels.get() != asset->channels()) {
throw DCPError (_("Mismatched audio channel counts in DCP"));
}
+ _active_audio_channels = std::max(_active_audio_channels.get_value_or(0), asset->active_channels());
+
if (!_audio_frame_rate) {
_audio_frame_rate = asset->sampling_rate ();
} else if (_audio_frame_rate.get() != asset->sampling_rate ()) {
- throw DCPError (_("Mismatched audio frame rates in DCP"));
+ throw DCPError (_("Mismatched audio sample rates in DCP"));
+ }
+
+ _audio_length += reel->main_sound()->actual_duration();
+ _audio_language = try_to_parse_language (asset->language());
+ }
+
+ if (reel->main_subtitle()) {
+ if (!reel->main_subtitle()->asset_ref().resolved()) {
+ /* We are missing this asset so we can't continue; examination will be repeated later */
+ _needs_assets = true;
+ LOG_GENERAL("Main subtitle %1 of reel %2 is missing", reel->main_subtitle()->id(), reel->id());
+ return;
}
- _audio_length += (*i)->main_sound()->duration();
+ LOG_GENERAL("Main subtitle %1 of reel %2 found", reel->main_subtitle()->id(), reel->id());
+
+ _text_count[TextType::OPEN_SUBTITLE] = 1;
+ _open_subtitle_language = try_to_parse_language(reel->main_subtitle()->language());
+
+ auto asset = reel->main_subtitle()->asset();
+ for (auto const& font: asset->font_data()) {
+ _fonts.push_back({reel_index, asset->id(), make_shared<dcpomatic::Font>(font.first, font.second)});
+ }
+ if (asset->font_data().empty()) {
+ _fonts.push_back({reel_index, asset->id(), make_shared<dcpomatic::Font>("")});
+ }
+ }
+
+ _text_count[TextType::CLOSED_CAPTION] = std::max(_text_count[TextType::CLOSED_CAPTION], static_cast<int>(reel->closed_captions().size()));
+ if (_dcp_text_tracks.size() < reel->closed_captions().size()) {
+ /* We only want to add 1 DCPTextTrack to _dcp_text_tracks per closed caption. I guess it's possible that different
+ * reels have different numbers of tracks (though I don't think they should) so make sure that _dcp_text_tracks ends
+ * up with the maximum.
+ */
+ _dcp_text_tracks.clear();
+ for (auto ccap: reel->closed_captions()) {
+ _dcp_text_tracks.push_back(DCPTextTrack(ccap->annotation_text().get_value_or(""), try_to_parse_language(ccap->language())));
+ }
+ }
+
+ for (auto ccap: reel->closed_captions()) {
+ if (!ccap->asset_ref().resolved()) {
+ /* We are missing this asset so we can't continue; examination will be repeated later */
+ _needs_assets = true;
+ LOG_GENERAL("Closed caption %1 of reel %2 is missing", ccap->id(), reel->id());
+ return;
+ }
+
+ LOG_GENERAL("Closed caption %1 of reel %2 found", ccap->id(), reel->id());
+
+ auto asset = ccap->asset();
+ for (auto const& font: asset->font_data()) {
+ _fonts.push_back({reel_index, asset->id(), make_shared<dcpomatic::Font>(font.first, font.second)});
+ }
+ if (asset->font_data().empty()) {
+ _fonts.push_back({reel_index, asset->id(), make_shared<dcpomatic::Font>("")});
+ }
}
- if ((*i)->main_subtitle ()) {
- _has_subtitles = true;
+ if (reel->main_markers ()) {
+ auto rm = reel->main_markers()->get();
+ _markers.insert (rm.begin(), rm.end());
+ }
+
+ if (reel->atmos()) {
+ _has_atmos = true;
+ _atmos_length += reel->atmos()->actual_duration();
+ if (_atmos_edit_rate != dcp::Fraction()) {
+ DCPOMATIC_ASSERT(reel->atmos()->edit_rate() == _atmos_edit_rate);
+ }
+ _atmos_edit_rate = reel->atmos()->edit_rate();
}
+
+ if (reel->main_picture()) {
+ _reel_lengths.push_back(reel->main_picture()->actual_duration());
+ } else if (reel->main_sound()) {
+ _reel_lengths.push_back(reel->main_sound()->actual_duration());
+ } else if (reel->main_subtitle()) {
+ _reel_lengths.push_back(reel->main_subtitle()->actual_duration());
+ } else if (!reel->closed_captions().empty()) {
+ _reel_lengths.push_back(reel->closed_captions().front()->actual_duration());
+ } else if (!reel->atmos()) {
+ _reel_lengths.push_back(reel->atmos()->actual_duration());
+ }
+
+ ++reel_index;
}
- _encrypted = dcp.encrypted ();
+ _encrypted = selected_cpl->any_encrypted();
_kdm_valid = true;
-
- /* Check that we can read the first picture frame */
+
+ LOG_GENERAL_NC ("Check that everything encrypted has a key");
+
+ /* 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::PictureAsset> asset = dcp.cpls().front()->reels().front()->main_picture()->asset ();
- shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (asset);
- shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (asset);
-
+ for (auto i: selected_cpl->reels()) {
+ LOG_GENERAL ("Reel %1", i->id());
+ auto pic = i->main_picture()->asset();
+ if (pic->encrypted() && !pic->key()) {
+ _kdm_valid = false;
+ LOG_GENERAL_NC ("Picture has no key");
+ break;
+ }
+ auto mono = dynamic_pointer_cast<dcp::MonoPictureAsset>(pic);
+ auto stereo = dynamic_pointer_cast<dcp::StereoPictureAsset>(pic);
+
if (mono) {
- mono->get_frame(0)->xyz_image ();
+ auto reader = mono->start_read();
+ reader->set_check_hmac (false);
+ reader->get_frame(0)->xyz_image();
} else {
- stereo->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()) {
+ auto sound = i->main_sound()->asset ();
+ if (sound->encrypted() && !sound->key()) {
+ _kdm_valid = false;
+ LOG_GENERAL_NC ("Sound has no key");
+ break;
+ }
+ 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;
+ LOG_GENERAL_NC ("Subtitle has no key");
+ break;
+ }
+ sub->subtitles ();
+ }
+
+ if (i->atmos()) {
+ auto atmos = i->atmos()->asset();
+ if (atmos->encrypted() && !atmos->key()) {
+ _kdm_valid = false;
+ LOG_GENERAL_NC ("ATMOS sound has no key");
+ break;
+ }
+ 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;
- 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"));
- }
+ LOG_GENERAL ("KDM is invalid: %1", e.what());
+ } catch (dcp::MiscError& e) {
+ _kdm_valid = false;
+ LOG_GENERAL ("KDM is invalid: %1", e.what());
+ }
+
+ _standard = selected_cpl->standard();
+ _three_d = !selected_cpl->reels().empty() && selected_cpl->reels().front()->main_picture() &&
+ dynamic_pointer_cast<dcp::StereoPictureAsset>(selected_cpl->reels().front()->main_picture()->asset());
+ _ratings = selected_cpl->ratings();
+ for (auto version: selected_cpl->content_versions()) {
+ _content_versions.push_back(version.label_text);
}
+
+ _cpl = selected_cpl->id();
}
+
+
+void
+DCPExaminer::add_fonts(shared_ptr<TextContent> content)
+{
+ for (auto const& font: _fonts) {
+ _font_id_allocator.add_font(font.reel_index, font.asset_id, font.font->id());
+ }
+
+ _font_id_allocator.allocate();
+
+ for (auto const& font: _fonts) {
+ auto font_copy = make_shared<dcpomatic::Font>(*font.font);
+ font_copy->set_id(_font_id_allocator.font_id(font.reel_index, font.asset_id, font.font->id()));
+ content->add_font(font_copy);
+ }
+}
+