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 ((*_reel)->main_subtitle()) {
 208                 DCPOMATIC_ASSERT (decoder != text.end ());
 209                 pass_texts (
 210                         next,
 211                         (*_reel)->main_subtitle()->asset(),
 212                         _dcp_content->reference_text(TEXT_OPEN_SUBTITLE),
 213                         (*_reel)->main_subtitle()->entry_point(),
 214                         *decoder,
 215                         size
 216                         );
 217                 ++decoder;
 218         }
 219         BOOST_FOREACH (shared_ptr<dcp::ReelClosedCaptionAsset> i, (*_reel)->closed_captions()) {
 220                 DCPOMATIC_ASSERT (decoder != text.end ());
 221                 pass_texts (
 222                         next, i->asset(), _dcp_content->reference_text(TEXT_CLOSED_CAPTION), i->entry_point(), *decoder, size
 223                         );
 224                 ++decoder;
 225         }
 226 }
 227
 228 void
 229 DCPDecoder::pass_texts (
 230         ContentTime next, shared_ptr<dcp::SubtitleAsset> asset, bool reference, int64_t entry_point, shared_ptr<TextDecoder> decoder, dcp::Size size
 231         )
 232 {
 233         double const vfr = _dcp_content->active_video_frame_rate (film());
 234         /* Frame within the (played part of the) reel that is coming up next */
 235         int64_t const frame = next.frames_round (vfr);
 236
 237         if (_decode_referenced || !reference) {
 238                 list<shared_ptr<dcp::Subtitle> > subs = asset->subtitles_during (
 239                         dcp::Time (entry_point + frame, vfr, vfr),
 240                         dcp::Time (entry_point + frame + 1, vfr, vfr),
 241                         true
 242                         );
 243
 244                 list<dcp::SubtitleString> strings;
 245
 246                 BOOST_FOREACH (shared_ptr<dcp::Subtitle> i, subs) {
 247                         shared_ptr<dcp::SubtitleString> is = dynamic_pointer_cast<dcp::SubtitleString> (i);
 248                         if (is) {
 249                                 if (!strings.empty() && (strings.back().in() != is->in() || strings.back().out() != is->out())) {
 250                                         dcp::SubtitleString b = strings.back();
 251                                         decoder->emit_plain (
 252                                                 ContentTimePeriod (
 253                                                         ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.in().as_seconds()),
 254                                                         ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.out().as_seconds())
 255                                                         ),
 256                                                 strings
 257                                                 );
 258                                         strings.clear ();
 259                                 }
 260
 261                                 strings.push_back (*is);
 262                         }
 263
 264                         /* XXX: perhaps these image subs should also be collected together like the string ones are;
 265                            this would need to be done both here and in DCPSubtitleDecoder.
 266                         */
 267
 268                         shared_ptr<dcp::SubtitleImage> ii = dynamic_pointer_cast<dcp::SubtitleImage> (i);
 269                         if (ii) {
 270                                 emit_subtitle_image (
 271                                         ContentTimePeriod (
 272                                                 ContentTime::from_frames (_offset - entry_point, vfr) + ContentTime::from_seconds (i->in().as_seconds ()),
 273                                                 ContentTime::from_frames (_offset - entry_point, vfr) + ContentTime::from_seconds (i->out().as_seconds ())
 274                                                 ),
 275                                         *ii,
 276                                         size,
 277                                         decoder
 278                                         );
 279                         }
 280                 }
 281
 282                 if (!strings.empty()) {
 283                         dcp::SubtitleString b = strings.back();
 284                         decoder->emit_plain (
 285                                 ContentTimePeriod (
 286                                         ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.in().as_seconds()),
 287                                         ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.out().as_seconds())
 288                                         ),
 289                                 strings
 290                                 );
 291                         strings.clear ();
 292                 }
 293         }
 294 }
 295
 296 void
 297 DCPDecoder::next_reel ()
 298 {
 299         _offset += (*_reel)->main_picture()->duration();
 300         ++_reel;
 301         get_readers ();
 302 }
 303
 304 void
 305 DCPDecoder::get_readers ()
 306 {
 307         if (_reel == _reels.end() || !_dcp_content->can_be_played ()) {
 308                 _mono_reader.reset ();
 309                 _stereo_reader.reset ();
 310                 _sound_reader.reset ();
 311                 return;
 312         }
 313
 314         if ((*_reel)->main_picture()) {
 315                 shared_ptr<dcp::PictureAsset> asset = (*_reel)->main_picture()->asset ();
 316                 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (asset);
 317                 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (asset);
 318                 DCPOMATIC_ASSERT (mono || stereo);
 319                 if (mono) {
 320                         _mono_reader = mono->start_read ();
 321                         _stereo_reader.reset ();
 322                 } else {
 323                         _stereo_reader = stereo->start_read ();
 324                         _mono_reader.reset ();
 325                 }
 326         } else {
 327                 _mono_reader.reset ();
 328                 _stereo_reader.reset ();
 329         }
 330
 331         if ((*_reel)->main_sound()) {
 332                 _sound_reader = (*_reel)->main_sound()->asset()->start_read ();
 333         } else {
 334                 _sound_reader.reset ();
 335         }
 336 }
 337
 338 void
 339 DCPDecoder::seek (ContentTime t, bool accurate)
 340 {
 341         if (!_dcp_content->can_be_played ()) {
 342                 return;
 343         }
 344
 345         Decoder::seek (t, accurate);
 346
 347         _reel = _reels.begin ();
 348         _offset = 0;
 349         get_readers ();
 350
 351         int const pre_roll_seconds = 2;
 352
 353         /* Pre-roll for subs */
 354
 355         ContentTime pre = t - ContentTime::from_seconds (pre_roll_seconds);
 356         if (pre < ContentTime()) {
 357                 pre = ContentTime ();
 358         }
 359
 360         /* Seek to pre-roll position */
 361
 362         while (_reel != _reels.end() && pre >= ContentTime::from_frames ((*_reel)->main_picture()->duration(), _dcp_content->active_video_frame_rate(film()))) {
 363                 ContentTime rd = ContentTime::from_frames ((*_reel)->main_picture()->duration(), _dcp_content->active_video_frame_rate(film()));
 364                 pre -= rd;
 365                 t -= rd;
 366                 next_reel ();
 367         }
 368
 369         /* Pass texts in the pre-roll */
 370
 371         double const vfr = _dcp_content->active_video_frame_rate (film());
 372         for (int i = 0; i < pre_roll_seconds * vfr; ++i) {
 373                 pass_texts (pre, (*_reel)->main_picture()->asset()->size());
 374                 pre += ContentTime::from_frames (1, vfr);
 375         }
 376
 377         /* Seek to correct position */
 378
 379         while (_reel != _reels.end() && t >= ContentTime::from_frames ((*_reel)->main_picture()->duration(), _dcp_content->active_video_frame_rate(film()))) {
 380                 t -= ContentTime::from_frames ((*_reel)->main_picture()->duration(), _dcp_content->active_video_frame_rate(film()));
 381                 next_reel ();
 382         }
 383
 384         _next = t;
 385 }
 386
 387 void
 388 DCPDecoder::set_decode_referenced (bool r)
 389 {
 390         _decode_referenced = r;
 391
 392         if (video) {
 393                 video->set_ignore (_dcp_content->reference_video() && !_decode_referenced);
 394         }
 395         if (audio) {
 396                 audio->set_ignore (_dcp_content->reference_audio() && !_decode_referenced);
 397         }
 398 }
 399
 400 void
 401 DCPDecoder::set_forced_reduction (optional<int> reduction)
 402 {
 403         _forced_reduction = reduction;
 404 }