src/lib/dcp_examiner.cc

   1 /*
   2     Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21
  22 #include "config.h"
  23 #include "constants.h"
  24 #include "dcp_content.h"
  25 #include "dcp_examiner.h"
  26 #include "dcpomatic_log.h"
  27 #include "exceptions.h"
  28 #include "font_id_allocator.h"
  29 #include "image.h"
  30 #include "text_content.h"
  31 #include "util.h"
  32 #include <dcp/cpl.h>
  33 #include <dcp/dcp.h>
  34 #include <dcp/decrypted_kdm.h>
  35 #include <dcp/mono_picture_asset.h>
  36 #include <dcp/mono_picture_asset_reader.h>
  37 #include <dcp/mono_picture_frame.h>
  38 #include <dcp/reel.h>
  39 #include <dcp/reel_atmos_asset.h>
  40 #include <dcp/reel_closed_caption_asset.h>
  41 #include <dcp/reel_markers_asset.h>
  42 #include <dcp/reel_picture_asset.h>
  43 #include <dcp/reel_sound_asset.h>
  44 #include <dcp/reel_subtitle_asset.h>
  45 #include <dcp/search.h>
  46 #include <dcp/sound_asset.h>
  47 #include <dcp/sound_asset.h>
  48 #include <dcp/sound_asset_reader.h>
  49 #include <dcp/stereo_picture_asset.h>
  50 #include <dcp/stereo_picture_asset_reader.h>
  51 #include <dcp/stereo_picture_frame.h>
  52 #include <dcp/subtitle_asset.h>
  53 #include <iostream>
  54
  55 #include "i18n.h"
  56
  57
  58 using std::cout;
  59 using std::dynamic_pointer_cast;
  60 using std::make_shared;
  61 using std::shared_ptr;
  62 using std::string;
  63 using std::vector;
  64 using boost::optional;
  65
  66
  67 DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
  68 {
  69         shared_ptr<dcp::CPL> selected_cpl;
  70
  71         auto cpls = dcp::find_and_resolve_cpls (content->directories(), tolerant);
  72
  73         if (content->cpl ()) {
  74                 /* Use the CPL that was specified, or that the content was using before */
  75                 auto iter = std::find_if(cpls.begin(), cpls.end(), [content](shared_ptr<dcp::CPL> cpl) { return cpl->id() == content->cpl().get(); });
  76                 if (iter == cpls.end()) {
  77                         throw CPLNotFoundError(content->cpl().get());
  78                 }
  79                 selected_cpl = *iter;
  80         } else {
  81                 /* Choose the CPL with the fewest unsatisfied references */
  82
  83                 int least_unsatisfied = INT_MAX;
  84
  85                 for (auto cpl: cpls) {
  86                         int unsatisfied = 0;
  87                         for (auto const& reel: cpl->reels()) {
  88                                 if (reel->main_picture() && !reel->main_picture()->asset_ref().resolved()) {
  89                                         ++unsatisfied;
  90                                 }
  91                                 if (reel->main_sound() && !reel->main_sound()->asset_ref().resolved()) {
  92                                         ++unsatisfied;
  93                                 }
  94                                 if (reel->main_subtitle() && !reel->main_subtitle()->asset_ref().resolved()) {
  95                                         ++unsatisfied;
  96                                 }
  97                                 if (reel->atmos() && !reel->atmos()->asset_ref().resolved()) {
  98                                         ++unsatisfied;
  99                                 }
 100                         }
 101
 102                         if (unsatisfied < least_unsatisfied) {
 103                                 least_unsatisfied = unsatisfied;
 104                                 selected_cpl = cpl;
 105                         }
 106                 }
 107         }
 108
 109         if (!selected_cpl) {
 110                 throw DCPError ("No CPLs found in DCP");
 111         }
 112
 113         if (content->kdm()) {
 114                 selected_cpl->add(decrypt_kdm_with_helpful_error(content->kdm().get()));
 115         }
 116
 117         _cpl = selected_cpl->id();
 118         _name = selected_cpl->content_title_text();
 119         _content_kind = selected_cpl->content_kind();
 120
 121         LOG_GENERAL ("Selected CPL %1", _cpl);
 122
 123         auto try_to_parse_language = [](optional<string> lang) -> boost::optional<dcp::LanguageTag> {
 124                 try {
 125                         if (lang) {
 126                                 return dcp::LanguageTag (*lang);
 127                         }
 128                 } catch (...) {}
 129                 return boost::none;
 130         };
 131
 132         LOG_GENERAL("Looking at %1 reels", selected_cpl->reels().size());
 133
 134         int reel_index = 0;
 135         for (auto reel: selected_cpl->reels()) {
 136                 LOG_GENERAL("Reel %1", reel->id());
 137
 138                 if (reel->main_picture()) {
 139                         /* This will mean a VF can be displayed in the timeline even if its picture asset
 140                          * is yet be resolved.
 141                          */
 142                         _has_video = true;
 143                         _video_length += reel->main_picture()->actual_duration();
 144
 145                         if (!reel->main_picture()->asset_ref().resolved()) {
 146                                 LOG_GENERAL("Main picture %1 of reel %2 is missing", reel->main_picture()->id(), reel->id());
 147                                 _needs_assets = true;
 148                                 /* Use a dummy value here; it will be replaced when the VF is re-examined. */
 149                                 _video_size = dcp::Size(1998, 1080);
 150                         } else {
 151                                 LOG_GENERAL("Main picture %1 of reel %2 found", reel->main_picture()->id(), reel->id());
 152
 153                                 auto const frac = reel->main_picture()->edit_rate();
 154                                 float const fr = float(frac.numerator) / frac.denominator;
 155                                 if (!_video_frame_rate) {
 156                                         _video_frame_rate = fr;
 157                                 } else if (_video_frame_rate.get() != fr) {
 158                                         throw DCPError (_("Mismatched frame rates in DCP"));
 159                                 }
 160
 161                                 auto asset = reel->main_picture()->asset();
 162                                 if (!_video_size) {
 163                                         _video_size = asset->size ();
 164                                 } else if (_video_size.get() != asset->size ()) {
 165                                         throw DCPError (_("Mismatched video sizes in DCP"));
 166                                 }
 167                         }
 168                 }
 169
 170                 if (reel->main_sound()) {
 171                         _has_audio = true;
 172                         _audio_length += reel->main_sound()->actual_duration();
 173
 174                         if (!reel->main_sound()->asset_ref().resolved()) {
 175                                 LOG_GENERAL("Main sound %1 of reel %2 is missing", reel->main_sound()->id(), reel->id());
 176                                 _needs_assets = true;
 177                         } else {
 178                                 LOG_GENERAL("Main sound %1 of reel %2 found", reel->main_sound()->id(), reel->id());
 179
 180                                 auto asset = reel->main_sound()->asset();
 181
 182                                 if (!_audio_channels) {
 183                                         _audio_channels = asset->channels();
 184                                 } else if (_audio_channels.get() != asset->channels()) {
 185                                         throw DCPError (_("Mismatched audio channel counts in DCP"));
 186                                 }
 187
 188                                 _active_audio_channels = std::max(_active_audio_channels.get_value_or(0), asset->active_channels());
 189
 190                                 if (!_audio_frame_rate) {
 191                                         _audio_frame_rate = asset->sampling_rate ();
 192                                 } else if (_audio_frame_rate.get() != asset->sampling_rate ()) {
 193                                         throw DCPError (_("Mismatched audio sample rates in DCP"));
 194                                 }
 195
 196                                 _audio_language = try_to_parse_language (asset->language());
 197                         }
 198                 }
 199
 200                 if (reel->main_subtitle()) {
 201                         if (!reel->main_subtitle()->asset_ref().resolved()) {
 202                                 LOG_GENERAL("Main subtitle %1 of reel %2 is missing", reel->main_subtitle()->id(), reel->id());
 203                                 _needs_assets = true;
 204                         } else {
 205                                 LOG_GENERAL("Main subtitle %1 of reel %2 found", reel->main_subtitle()->id(), reel->id());
 206
 207                                 _text_count[TextType::OPEN_SUBTITLE] = 1;
 208                                 _open_subtitle_language = try_to_parse_language(reel->main_subtitle()->language());
 209
 210                                 auto asset = reel->main_subtitle()->asset();
 211                                 for (auto const& font: asset->font_data()) {
 212                                         _fonts.push_back({reel_index, asset->id(), make_shared<dcpomatic::Font>(font.first, font.second)});
 213                                 }
 214                         }
 215                 }
 216
 217                 _text_count[TextType::CLOSED_CAPTION] = std::max(_text_count[TextType::CLOSED_CAPTION], static_cast<int>(reel->closed_captions().size()));
 218                 if (_dcp_text_tracks.size() < reel->closed_captions().size()) {
 219                         /* We only want to add 1 DCPTextTrack to _dcp_text_tracks per closed caption.  I guess it's possible that different
 220                          * reels have different numbers of tracks (though I don't think they should) so make sure that _dcp_text_tracks ends
 221                          * up with the maximum.
 222                          */
 223                         _dcp_text_tracks.clear();
 224                         for (auto ccap: reel->closed_captions()) {
 225                                 _dcp_text_tracks.push_back(DCPTextTrack(ccap->annotation_text().get_value_or(""), try_to_parse_language(ccap->language())));
 226                         }
 227                 }
 228
 229                 for (auto ccap: reel->closed_captions()) {
 230                         if (!ccap->asset_ref().resolved()) {
 231                                 LOG_GENERAL("Closed caption %1 of reel %2 is missing", ccap->id(), reel->id());
 232                                 _needs_assets = true;
 233                         } else {
 234                                 LOG_GENERAL("Closed caption %1 of reel %2 found", ccap->id(), reel->id());
 235
 236                                 auto asset = ccap->asset();
 237                                 for (auto const& font: asset->font_data()) {
 238                                         _fonts.push_back({reel_index, asset->id(), make_shared<dcpomatic::Font>(font.first, font.second)});
 239                                 }
 240                         }
 241                 }
 242
 243                 if (reel->main_markers ()) {
 244                         auto rm = reel->main_markers()->get();
 245                         _markers.insert (rm.begin(), rm.end());
 246                 }
 247
 248                 if (reel->atmos()) {
 249                         _has_atmos = true;
 250                         _atmos_length += reel->atmos()->actual_duration();
 251                         if (_atmos_edit_rate != dcp::Fraction()) {
 252                                 DCPOMATIC_ASSERT(reel->atmos()->edit_rate() == _atmos_edit_rate);
 253                         }
 254                         _atmos_edit_rate = reel->atmos()->edit_rate();
 255                 }
 256
 257                 if (reel->main_picture()) {
 258                         _reel_lengths.push_back(reel->main_picture()->actual_duration());
 259                 } else if (reel->main_sound()) {
 260                         _reel_lengths.push_back(reel->main_sound()->actual_duration());
 261                 } else if (reel->main_subtitle()) {
 262                         _reel_lengths.push_back(reel->main_subtitle()->actual_duration());
 263                 } else if (!reel->closed_captions().empty()) {
 264                         _reel_lengths.push_back(reel->closed_captions().front()->actual_duration());
 265                 } else if (!reel->atmos()) {
 266                         _reel_lengths.push_back(reel->atmos()->actual_duration());
 267                 }
 268
 269                 ++reel_index;
 270         }
 271
 272         _encrypted = selected_cpl->any_encrypted();
 273         _kdm_valid = true;
 274
 275         LOG_GENERAL_NC ("Check that everything encrypted has a key");
 276
 277         /* Check first that anything encrypted has a key.  We must do this, as if we try to
 278          * read encrypted data with asdcplib without even offering a key it will just return
 279          * the encrypted data.  Secondly, check that we can read the first thing from each
 280          * asset in each reel.  This checks that when we do have a key it's the right one.
 281          */
 282         try {
 283                 for (auto i: selected_cpl->reels()) {
 284                         LOG_GENERAL ("Reel %1", i->id());
 285                         if (i->main_picture() && i->main_picture()->asset_ref().resolved()) {
 286                                 auto pic = i->main_picture()->asset();
 287                                 if (pic->encrypted() && !pic->key()) {
 288                                         _kdm_valid = false;
 289                                         LOG_GENERAL_NC ("Picture has no key");
 290                                         break;
 291                                 }
 292                                 auto mono = dynamic_pointer_cast<dcp::MonoPictureAsset>(pic);
 293                                 auto stereo = dynamic_pointer_cast<dcp::StereoPictureAsset>(pic);
 294
 295                                 if (mono) {
 296                                         auto reader = mono->start_read();
 297                                         reader->set_check_hmac (false);
 298                                         reader->get_frame(0)->xyz_image();
 299                                 } else {
 300                                         auto reader = stereo->start_read();
 301                                         reader->set_check_hmac (false);
 302                                         reader->get_frame(0)->xyz_image(dcp::Eye::LEFT);
 303                                 }
 304                         }
 305
 306                         if (i->main_sound() && i->main_sound()->asset_ref().resolved()) {
 307                                 auto sound = i->main_sound()->asset();
 308                                 if (sound->encrypted() && !sound->key()) {
 309                                         _kdm_valid = false;
 310                                         LOG_GENERAL_NC ("Sound has no key");
 311                                         break;
 312                                 }
 313                                 auto reader = sound->start_read();
 314                                 reader->set_check_hmac (false);
 315                                 reader->get_frame(0);
 316                         }
 317
 318                         if (i->main_subtitle() && i->main_subtitle()->asset_ref().resolved()) {
 319                                 auto sub = i->main_subtitle()->asset();
 320                                 auto mxf_sub = dynamic_pointer_cast<dcp::MXF>(sub);
 321                                 if (mxf_sub && mxf_sub->encrypted() && !mxf_sub->key()) {
 322                                         _kdm_valid = false;
 323                                         LOG_GENERAL_NC ("Subtitle has no key");
 324                                         break;
 325                                 }
 326                                 sub->subtitles ();
 327                         }
 328
 329                         if (i->atmos() && i->atmos()->asset_ref().resolved()) {
 330                                 if (auto atmos = i->atmos()->asset()) {
 331                                         if (atmos->encrypted() && !atmos->key()) {
 332                                                 _kdm_valid = false;
 333                                                 LOG_GENERAL_NC ("ATMOS sound has no key");
 334                                                 break;
 335                                         }
 336                                         auto reader = atmos->start_read();
 337                                         reader->set_check_hmac (false);
 338                                         reader->get_frame(0);
 339                                 }
 340                         }
 341                 }
 342         } catch (dcp::ReadError& e) {
 343                 _kdm_valid = false;
 344                 LOG_GENERAL ("KDM is invalid: %1", e.what());
 345         } catch (dcp::MiscError& e) {
 346                 _kdm_valid = false;
 347                 LOG_GENERAL ("KDM is invalid: %1", e.what());
 348         }
 349
 350         _standard = selected_cpl->standard();
 351         if (!selected_cpl->reels().empty()) {
 352                 auto first_reel = selected_cpl->reels()[0];
 353                 _three_d = first_reel->main_picture() && first_reel->main_picture()->asset_ref().resolved() && dynamic_pointer_cast<dcp::StereoPictureAsset>(first_reel->main_picture()->asset());
 354         }
 355         _ratings = selected_cpl->ratings();
 356         for (auto version: selected_cpl->content_versions()) {
 357                 _content_versions.push_back(version.label_text);
 358         }
 359
 360         _cpl = selected_cpl->id();
 361 }
 362
 363
 364 void
 365 DCPExaminer::add_fonts(shared_ptr<TextContent> content)
 366 {
 367         FontIDAllocator font_id_allocator;
 368
 369         for (auto const& font: _fonts) {
 370                 font_id_allocator.add_font(font.reel_index, font.asset_id, font.font->id());
 371         }
 372
 373         font_id_allocator.allocate();
 374
 375         for (auto const& font: _fonts) {
 376                 auto font_copy = make_shared<dcpomatic::Font>(*font.font);
 377                 font_copy->set_id(font_id_allocator.font_id(font.reel_index, font.asset_id, font.font->id()));
 378                 content->add_font(font_copy);
 379         }
 380
 381         if (!font_id_allocator.has_default_font()) {
 382                 content->add_font(make_shared<dcpomatic::Font>(font_id_allocator.default_font_id(), default_font_file()));
 383         }
 384 }
 385