src/lib/dcp_decoder.cc

   1 /*
   2     Copyright (C) 2014-2018 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 #include "dcp_decoder.h"
  22 #include "dcp_content.h"
  23 #include "audio_content.h"
  24 #include "video_decoder.h"
  25 #include "audio_decoder.h"
  26 #include "j2k_image_proxy.h"
  27 #include "text_decoder.h"
  28 #include "ffmpeg_image_proxy.h"
  29 #include "image.h"
  30 #include "config.h"
  31 #include <dcp/dcp.h>
  32 #include <dcp/cpl.h>
  33 #include <dcp/reel.h>
  34 #include <dcp/mono_picture_asset.h>
  35 #include <dcp/mono_picture_asset_reader.h>
  36 #include <dcp/stereo_picture_asset.h>
  37 #include <dcp/stereo_picture_asset_reader.h>
  38 #include <dcp/reel_picture_asset.h>
  39 #include <dcp/reel_sound_asset.h>
  40 #include <dcp/reel_subtitle_asset.h>
  41 #include <dcp/reel_closed_caption_asset.h>
  42 #include <dcp/mono_picture_frame.h>
  43 #include <dcp/stereo_picture_frame.h>
  44 #include <dcp/sound_frame.h>
  45 #include <dcp/sound_asset_reader.h>
  46 #include <dcp/subtitle_image.h>
  47 #include <boost/foreach.hpp>
  48 #include <iostream>
  49
  50 #include "i18n.h"
  51
  52 using std::list;
  53 using std::cout;
  54 using boost::shared_ptr;
  55 using boost::dynamic_pointer_cast;
  56 using boost::optional;
  57
  58 DCPDecoder::DCPDecoder (shared_ptr<const Film> film, shared_ptr<const DCPContent> c, bool fast)
  59         : DCP (c)
  60         , Decoder (film)
  61         , _decode_referenced (false)
  62 {
  63         if (c->can_be_played()) {
  64                 if (c->video) {
  65                         video.reset (new VideoDecoder (this, c));
  66                 }
  67                 if (c->audio) {
  68                         audio.reset (new AudioDecoder (this, c->audio, fast));
  69                 }
  70                 BOOST_FOREACH (shared_ptr<TextContent> i, c->text) {
  71                         /* XXX: this time here should be the time of the first subtitle, not 0 */
  72                         text.push_back (shared_ptr<TextDecoder> (new TextDecoder (this, i, ContentTime())));
  73                 }
  74         }
  75
  76         list<shared_ptr<dcp::CPL> > cpl_list = cpls ();
  77
  78         if (cpl_list.empty()) {
  79                 throw DCPError (_("No CPLs found in DCP."));
  80         }
  81
  82         shared_ptr<dcp::CPL> cpl;
  83         BOOST_FOREACH (shared_ptr<dcp::CPL> i, cpl_list) {
  84                 if (_dcp_content->cpl() && i->id() == _dcp_content->cpl().get()) {
  85                         cpl = i;
  86                 }
  87         }
  88
  89         if (!cpl) {
  90                 /* No CPL found; probably an old file that doesn't specify it;
  91                    just use the first one.
  92                 */
  93                 cpl = cpls().front ();
  94         }
  95
  96         set_decode_referenced (false);
  97
  98         _reels = cpl->reels ();
  99
 100         _reel = _reels.begin ();
 101         _offset = 0;
 102         get_readers ();
 103 }
 104
 105
 106 bool
 107 DCPDecoder::pass ()
 108 {
 109         if (_reel == _reels.end () || !_dcp_content->can_be_played ()) {
 110                 return true;
 111         }
 112
 113         double const vfr = _dcp_content->active_video_frame_rate (film());
 114
 115         /* Frame within the (played part of the) reel that is coming up next */
 116         int64_t const frame = _next.frames_round (vfr);
 117
 118         shared_ptr<dcp::PictureAsset> picture_asset = (*_reel)->main_picture()->asset();
 119         DCPOMATIC_ASSERT (picture_asset);
 120
 121         /* We must emit texts first as when we emit the video for this frame
 122            it will expect already to have the texts.
 123         */
 124         pass_texts (_next, picture_asset->size());
 125
 126         if ((_mono_reader || _stereo_reader) && (_decode_referenced || !_dcp_content->reference_video())) {
 127                 int64_t const entry_point = (*_reel)->main_picture()->entry_point ();
 128                 if (_mono_reader) {
 129                         video->emit (
 130                                 film(),
 131                                 shared_ptr<ImageProxy> (
 132                                         new J2KImageProxy (
 133                                                 _mono_reader->get_frame (entry_point + frame),
 134                                                 picture_asset->size(),
 135                                                 AV_PIX_FMT_XYZ12LE,
 136                                                 _forced_reduction
 137                                                 )
 138                                         ),
 139                                 _offset + frame
 140                                 );
 141                 } else {
 142                         video->emit (
 143                                 film(),
 144                                 shared_ptr<ImageProxy> (
 145                                         new J2KImageProxy (
 146                                                 _stereo_reader->get_frame (entry_point + frame),
 147                                                 picture_asset->size(),
 148                                                 dcp::EYE_LEFT,
 149                                                 AV_PIX_FMT_XYZ12LE,
 150                                                 _forced_reduction
 151                                                 )
 152                                         ),
 153                                 _offset + frame
 154                                 );
 155
 156                         video->emit (
 157                                 film(),
 158                                 shared_ptr<ImageProxy> (
 159                                         new J2KImageProxy (
 160                                                 _stereo_reader->get_frame (entry_point + frame),
 161                                                 picture_asset->size(),
 162                                                 dcp::EYE_RIGHT,
 163                                                 AV_PIX_FMT_XYZ12LE,
 164                                                 _forced_reduction
 165                                                 )
 166                                         ),
 167                                 _offset + frame
 168                                 );
 169                 }
 170         }
 171
 172         if (_sound_reader && (_decode_referenced || !_dcp_content->reference_audio())) {
 173                 int64_t const entry_point = (*_reel)->main_sound()->entry_point ();
 174                 shared_ptr<const dcp::SoundFrame> sf = _sound_reader->get_frame (entry_point + frame);
 175                 uint8_t const * from = sf->data ();
 176
 177                 int const channels = _dcp_content->audio->stream()->channels ();
 178                 int const frames = sf->size() / (3 * channels);
 179                 shared_ptr<AudioBuffers> data (new AudioBuffers (channels, frames));
 180                 float** data_data = data->data();
 181                 for (int i = 0; i < frames; ++i) {
 182                         for (int j = 0; j < channels; ++j) {
 183                                 data_data[j][i] = static_cast<int> ((from[0] << 8) | (from[1] << 16) | (from[2] << 24)) / static_cast<float> (INT_MAX - 256);
 184                                 from += 3;
 185                         }
 186                 }
 187
 188                 audio->emit (film(), _dcp_content->audio->stream(), data, ContentTime::from_frames (_offset, vfr) + _next);
 189         }
 190
 191         _next += ContentTime::from_frames (1, vfr);
 192
 193         if ((*_reel)->main_picture ()) {
 194                 if (_next.frames_round (vfr) >= (*_reel)->main_picture()->duration()) {
 195                         next_reel ();
 196                         _next = ContentTime ();
 197                 }
 198         }
 199
 200         return false;
 201 }
 202
 203 void
 204 DCPDecoder::pass_texts (ContentTime next, dcp::Size size)
 205 {
 206         list<shared_ptr<TextDecoder> >::const_iterator decoder = text.begin ();
 207         if (decoder == text.end()) {
 208                 /* It's possible that there is now a main subtitle but no TextDecoders, for example if
 209                    the CPL has just changed but the TextContent's texts have not been recreated yet.
 210                 */
 211                 return;
 212         }
 213
 214         if ((*_reel)->main_subtitle()) {
 215                 pass_texts (
 216                         next,
 217                         (*_reel)->main_subtitle()->asset(),
 218                         _dcp_content->reference_text(TEXT_OPEN_SUBTITLE),
 219                         (*_reel)->main_subtitle()->entry_point(),
 220                         *decoder,
 221                         size
 222                         );
 223                 ++decoder;
 224         }
 225
 226         BOOST_FOREACH (shared_ptr<dcp::ReelClosedCaptionAsset> i, (*_reel)->closed_captions()) {
 227                 pass_texts (
 228                         next, i->asset(), _dcp_content->reference_text(TEXT_CLOSED_CAPTION), i->entry_point(), *decoder, size
 229                         );
 230                 ++decoder;
 231         }
 232 }
 233
 234 void
 235 DCPDecoder::pass_texts (
 236         ContentTime next, shared_ptr<dcp::SubtitleAsset> asset, bool reference, int64_t entry_point, shared_ptr<TextDecoder> decoder, dcp::Size size
 237         )
 238 {
 239         double const vfr = _dcp_content->active_video_frame_rate (film());
 240         /* Frame within the (played part of the) reel that is coming up next */
 241         int64_t const frame = next.frames_round (vfr);
 242
 243         if (_decode_referenced || !reference) {
 244                 list<shared_ptr<dcp::Subtitle> > subs = asset->subtitles_during (
 245                         dcp::Time (entry_point + frame, vfr, vfr),
 246                         dcp::Time (entry_point + frame + 1, vfr, vfr),
 247                         true
 248                         );
 249
 250                 list<dcp::SubtitleString> strings;
 251
 252                 BOOST_FOREACH (shared_ptr<dcp::Subtitle> i, subs) {
 253                         shared_ptr<dcp::SubtitleString> is = dynamic_pointer_cast<dcp::SubtitleString> (i);
 254                         if (is) {
 255                                 if (!strings.empty() && (strings.back().in() != is->in() || strings.back().out() != is->out())) {
 256                                         dcp::SubtitleString b = strings.back();
 257                                         decoder->emit_plain (
 258                                                 ContentTimePeriod (
 259                                                         ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.in().as_seconds()),
 260                                                         ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.out().as_seconds())
 261                                                         ),
 262                                                 strings
 263                                                 );
 264                                         strings.clear ();
 265                                 }
 266
 267                                 strings.push_back (*is);
 268                         }
 269
 270                         /* XXX: perhaps these image subs should also be collected together like the string ones are;
 271                            this would need to be done both here and in DCPSubtitleDecoder.
 272                         */
 273
 274                         shared_ptr<dcp::SubtitleImage> ii = dynamic_pointer_cast<dcp::SubtitleImage> (i);
 275                         if (ii) {
 276                                 emit_subtitle_image (
 277                                         ContentTimePeriod (
 278                                                 ContentTime::from_frames (_offset - entry_point, vfr) + ContentTime::from_seconds (i->in().as_seconds ()),
 279                                                 ContentTime::from_frames (_offset - entry_point, vfr) + ContentTime::from_seconds (i->out().as_seconds ())
 280                                                 ),
 281                                         *ii,
 282                                         size,
 283                                         decoder
 284                                         );
 285                         }
 286                 }
 287
 288                 if (!strings.empty()) {
 289                         dcp::SubtitleString b = strings.back();
 290                         decoder->emit_plain (
 291                                 ContentTimePeriod (
 292                                         ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.in().as_seconds()),
 293                                         ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.out().as_seconds())
 294                                         ),
 295                                 strings
 296                                 );
 297                         strings.clear ();
 298                 }
 299         }
 300 }
 301
 302 void
 303 DCPDecoder::next_reel ()
 304 {
 305         _offset += (*_reel)->main_picture()->duration();
 306         ++_reel;
 307         get_readers ();
 308 }
 309
 310 void
 311 DCPDecoder::get_readers ()
 312 {
 313         if (_reel == _reels.end() || !_dcp_content->can_be_played ()) {
 314                 _mono_reader.reset ();
 315                 _stereo_reader.reset ();
 316                 _sound_reader.reset ();
 317                 return;
 318         }
 319
 320         if ((*_reel)->main_picture()) {
 321                 shared_ptr<dcp::PictureAsset> asset = (*_reel)->main_picture()->asset ();
 322                 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (asset);
 323                 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (asset);
 324                 DCPOMATIC_ASSERT (mono || stereo);
 325                 if (mono) {
 326                         _mono_reader = mono->start_read ();
 327                         _stereo_reader.reset ();
 328                 } else {
 329                         _stereo_reader = stereo->start_read ();
 330                         _mono_reader.reset ();
 331                 }
 332         } else {
 333                 _mono_reader.reset ();
 334                 _stereo_reader.reset ();
 335         }
 336
 337         if ((*_reel)->main_sound()) {
 338                 _sound_reader = (*_reel)->main_sound()->asset()->start_read ();
 339         } else {
 340                 _sound_reader.reset ();
 341         }
 342 }
 343
 344 void
 345 DCPDecoder::seek (ContentTime t, bool accurate)
 346 {
 347         if (!_dcp_content->can_be_played ()) {
 348                 return;
 349         }
 350
 351         Decoder::seek (t, accurate);
 352
 353         _reel = _reels.begin ();
 354         _offset = 0;
 355         get_readers ();
 356
 357         int const pre_roll_seconds = 2;
 358
 359         /* Pre-roll for subs */
 360
 361         ContentTime pre = t - ContentTime::from_seconds (pre_roll_seconds);
 362         if (pre < ContentTime()) {
 363                 pre = ContentTime ();
 364         }
 365
 366         /* Seek to pre-roll position */
 367
 368         while (_reel != _reels.end() && pre >= ContentTime::from_frames ((*_reel)->main_picture()->duration(), _dcp_content->active_video_frame_rate(film()))) {
 369                 ContentTime rd = ContentTime::from_frames ((*_reel)->main_picture()->duration(), _dcp_content->active_video_frame_rate(film()));
 370                 pre -= rd;
 371                 t -= rd;
 372                 next_reel ();
 373         }
 374
 375         /* Pass texts in the pre-roll */
 376
 377         double const vfr = _dcp_content->active_video_frame_rate (film());
 378         for (int i = 0; i < pre_roll_seconds * vfr; ++i) {
 379                 pass_texts (pre, (*_reel)->main_picture()->asset()->size());
 380                 pre += ContentTime::from_frames (1, vfr);
 381         }
 382
 383         /* Seek to correct position */
 384
 385         while (_reel != _reels.end() && t >= ContentTime::from_frames ((*_reel)->main_picture()->duration(), _dcp_content->active_video_frame_rate(film()))) {
 386                 t -= ContentTime::from_frames ((*_reel)->main_picture()->duration(), _dcp_content->active_video_frame_rate(film()));
 387                 next_reel ();
 388         }
 389
 390         _next = t;
 391 }
 392
 393 void
 394 DCPDecoder::set_decode_referenced (bool r)
 395 {
 396         _decode_referenced = r;
 397
 398         if (video) {
 399                 video->set_ignore (_dcp_content->reference_video() && !_decode_referenced);
 400         }
 401         if (audio) {
 402                 audio->set_ignore (_dcp_content->reference_audio() && !_decode_referenced);
 403         }
 404 }
 405
 406 void
 407 DCPDecoder::set_forced_reduction (optional<int> reduction)
 408 {
 409         _forced_reduction = reduction;
 410 }