src/wx/film_viewer.cc

   1 /*
   2     Copyright (C) 2012-2019 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 /** @file  src/film_viewer.cc
  22  *  @brief A wx widget to view a preview of a Film.
  23  */
  24
  25 #include "film_viewer.h"
  26 #include "playhead_to_timecode_dialog.h"
  27 #include "playhead_to_frame_dialog.h"
  28 #include "wx_util.h"
  29 #include "closed_captions_dialog.h"
  30 #include "gl_video_view.h"
  31 #include "simple_video_view.h"
  32 #include "lib/film.h"
  33 #include "lib/ratio.h"
  34 #include "lib/util.h"
  35 #include "lib/job_manager.h"
  36 #include "lib/image.h"
  37 #include "lib/exceptions.h"
  38 #include "lib/examine_content_job.h"
  39 #include "lib/filter.h"
  40 #include "lib/player.h"
  41 #include "lib/player_video.h"
  42 #include "lib/video_content.h"
  43 #include "lib/video_decoder.h"
  44 #include "lib/timer.h"
  45 #include "lib/butler.h"
  46 #include "lib/log.h"
  47 #include "lib/config.h"
  48 #include "lib/compose.hpp"
  49 #include "lib/dcpomatic_log.h"
  50 extern "C" {
  51 #include <libavutil/pixfmt.h>
  52 }
  53 #include <dcp/exceptions.h>
  54 #include <wx/tglbtn.h>
  55 #include <iostream>
  56 #include <iomanip>
  57
  58 using std::string;
  59 using std::pair;
  60 using std::min;
  61 using std::max;
  62 using std::cout;
  63 using std::list;
  64 using std::bad_alloc;
  65 using std::make_pair;
  66 using std::exception;
  67 using boost::shared_ptr;
  68 using boost::dynamic_pointer_cast;
  69 using boost::weak_ptr;
  70 using boost::optional;
  71 using dcp::Size;
  72 using namespace dcpomatic;
  73
  74 static
  75 int
  76 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
  77 {
  78         return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
  79 }
  80
  81 FilmViewer::FilmViewer (wxWindow* p)
  82         : _coalesce_player_changes (false)
  83         , _audio (DCPOMATIC_RTAUDIO_API)
  84         , _audio_channels (0)
  85         , _audio_block_size (1024)
  86         , _playing (false)
  87         , _latency_history_count (0)
  88         , _dropped (0)
  89         , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
  90         , _outline_content (false)
  91         , _eyes (EYES_LEFT)
  92         , _pad_black (false)
  93 #ifdef DCPOMATIC_VARIANT_SWAROOP
  94         , _background_image (false)
  95 #endif
  96         , _state_timer ("viewer")
  97         , _gets (0)
  98 {
  99         switch (Config::instance()->video_view_type()) {
 100         case Config::VIDEO_VIEW_OPENGL:
 101                 _video_view = new GLVideoView (this, p);
 102                 break;
 103         case Config::VIDEO_VIEW_SIMPLE:
 104                 _video_view = new SimpleVideoView (this, p);
 105                 break;
 106         }
 107
 108         _video_view->Sized.connect (boost::bind(&FilmViewer::video_view_sized, this));
 109         _timer.Bind (wxEVT_TIMER, boost::bind(&FilmViewer::timer, this));
 110
 111         set_film (shared_ptr<Film> ());
 112
 113         _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
 114         config_changed (Config::SOUND_OUTPUT);
 115 }
 116
 117 FilmViewer::~FilmViewer ()
 118 {
 119         stop ();
 120 }
 121
 122 void
 123 FilmViewer::set_film (shared_ptr<Film> film)
 124 {
 125         if (_film == film) {
 126                 return;
 127         }
 128
 129         _film = film;
 130         _video_position = DCPTime ();
 131         _player_video.first.reset ();
 132         _player_video.second = DCPTime ();
 133
 134         _video_view->set_image (shared_ptr<Image>());
 135         _closed_captions_dialog->clear ();
 136
 137         if (!_film) {
 138                 _player.reset ();
 139                 recreate_butler ();
 140                 refresh_view ();
 141                 return;
 142         }
 143
 144         try {
 145                 _player.reset (new Player (_film, _film->playlist ()));
 146                 _player->set_fast ();
 147                 if (_dcp_decode_reduction) {
 148                         _player->set_dcp_decode_reduction (_dcp_decode_reduction);
 149                 }
 150         } catch (bad_alloc &) {
 151                 error_dialog (_video_view->get(), _("There is not enough free memory to do that."));
 152                 _film.reset ();
 153                 return;
 154         }
 155
 156         _player->set_always_burn_open_subtitles ();
 157         _player->set_play_referenced ();
 158
 159         _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
 160         _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
 161
 162         /* Keep about 1 second's worth of history samples */
 163         _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
 164
 165         recreate_butler ();
 166
 167         calculate_sizes ();
 168         slow_refresh ();
 169 }
 170
 171 void
 172 FilmViewer::recreate_butler ()
 173 {
 174         bool const was_running = stop ();
 175         _butler.reset ();
 176
 177         if (!_film) {
 178                 return;
 179         }
 180
 181         AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
 182
 183         if (_audio_channels != 2 || _film->audio_channels() < 3) {
 184                 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
 185                         map.set (i, i, 1);
 186                 }
 187         } else {
 188                 /* Special case: stereo output, at least 3 channel input.
 189                    Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
 190                                Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
 191                 */
 192                 if (_film->audio_channels() > 0) {
 193                         map.set (dcp::LEFT,   0, 1 / sqrt(2)); // L -> Lt
 194                 }
 195                 if (_film->audio_channels() > 1) {
 196                         map.set (dcp::RIGHT,  1, 1 / sqrt(2)); // R -> Rt
 197                 }
 198                 if (_film->audio_channels() > 2) {
 199                         map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
 200                         map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
 201                 }
 202                 if (_film->audio_channels() > 3) {
 203                         map.set (dcp::LFE,    0, 1 / sqrt(10)); // Lfe -> Lt
 204                         map.set (dcp::LFE,    1, 1 / sqrt(10)); // Lfe -> Rt
 205                 }
 206                 if (_film->audio_channels() > 4) {
 207                         map.set (dcp::LS,     0, 1 / sqrt(2)); // Ls -> Lt
 208                 }
 209                 if (_film->audio_channels() > 5) {
 210                         map.set (dcp::RS,     1, 1 / sqrt(2)); // Rs -> Rt
 211                 }
 212         }
 213
 214         _butler.reset (new Butler(_player, map, _audio_channels, bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true));
 215         if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
 216                 _butler->disable_audio ();
 217         }
 218
 219         _closed_captions_dialog->set_film_and_butler (_film, _butler);
 220
 221         if (was_running) {
 222                 start ();
 223         }
 224 }
 225
 226 void
 227 FilmViewer::refresh_view ()
 228 {
 229         _state_timer.set ("update-view");
 230         _video_view->update ();
 231         _state_timer.unset ();
 232 }
 233
 234 void
 235 FilmViewer::get ()
 236 {
 237         DCPOMATIC_ASSERT (_butler);
 238         ++_gets;
 239
 240         do {
 241                 Butler::Error e;
 242                 _player_video = _butler->get_video (&e);
 243                 if (!_player_video.first && e == Butler::AGAIN) {
 244                         signal_manager->when_idle (boost::bind(&FilmViewer::get, this));
 245                         return;
 246                 }
 247         } while (
 248                 _player_video.first &&
 249                 _film->three_d() &&
 250                 _eyes != _player_video.first->eyes() &&
 251                 _player_video.first->eyes() != EYES_BOTH
 252                 );
 253
 254         try {
 255                 _butler->rethrow ();
 256         } catch (DecodeError& e) {
 257                 error_dialog (_video_view->get(), e.what());
 258         }
 259
 260         display_player_video ();
 261 }
 262
 263 void
 264 FilmViewer::display_player_video ()
 265 {
 266         if (!_player_video.first) {
 267                 _video_view->set_image (shared_ptr<Image>());
 268                 refresh_view ();
 269                 return;
 270         }
 271
 272         if (_playing && (time() - _player_video.second) > one_video_frame()) {
 273                 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
 274                    part if this frame is J2K).
 275                 */
 276                 _video_position = _player_video.second;
 277                 ++_dropped;
 278                 return;
 279         }
 280
 281         /* In an ideal world, what we would do here is:
 282          *
 283          * 1. convert to XYZ exactly as we do in the DCP creation path.
 284          * 2. convert back to RGB for the preview display, compensating
 285          *    for the monitor etc. etc.
 286          *
 287          * but this is inefficient if the source is RGB.  Since we don't
 288          * (currently) care too much about the precise accuracy of the preview's
 289          * colour mapping (and we care more about its speed) we try to short-
 290          * circuit this "ideal" situation in some cases.
 291          *
 292          * The content's specified colour conversion indicates the colourspace
 293          * which the content is in (according to the user).
 294          *
 295          * PlayerVideo::image (bound to PlayerVideo::force) will take the source
 296          * image and convert it (from whatever the user has said it is) to RGB.
 297          */
 298
 299         _state_timer.set ("get image");
 300
 301         _video_view->set_image (
 302                 _player_video.first->image(bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true)
 303                 );
 304
 305         _state_timer.set ("ImageChanged");
 306         ImageChanged (_player_video.first);
 307         _state_timer.unset ();
 308
 309         _video_position = _player_video.second;
 310         _inter_position = _player_video.first->inter_position ();
 311         _inter_size = _player_video.first->inter_size ();
 312
 313         refresh_view ();
 314
 315         _closed_captions_dialog->update (time());
 316 }
 317
 318 void
 319 FilmViewer::timer ()
 320 {
 321         if (!_film || !_playing) {
 322                 return;
 323         }
 324
 325         get ();
 326         PositionChanged ();
 327         DCPTime const next = _video_position + one_video_frame();
 328
 329         if (next >= _film->length()) {
 330                 stop ();
 331                 Finished ();
 332                 return;
 333         }
 334
 335         LOG_DEBUG_PLAYER("%1 -> %2; delay %3", next.seconds(), time().seconds(), max((next.seconds() - time().seconds()) * 1000, 1.0));
 336         _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
 337
 338         if (_butler) {
 339                 _butler->rethrow ();
 340         }
 341 }
 342
 343 void
 344 FilmViewer::set_outline_content (bool o)
 345 {
 346         _outline_content = o;
 347         refresh_view ();
 348 }
 349
 350 void
 351 FilmViewer::set_eyes (Eyes e)
 352 {
 353         _eyes = e;
 354         slow_refresh ();
 355 }
 356
 357 void
 358 FilmViewer::video_view_sized ()
 359 {
 360         calculate_sizes ();
 361         if (!quick_refresh()) {
 362                 slow_refresh ();
 363         }
 364         PositionChanged ();
 365 }
 366
 367 void
 368 FilmViewer::calculate_sizes ()
 369 {
 370         if (!_film || !_player) {
 371                 return;
 372         }
 373
 374         Ratio const * container = _film->container ();
 375
 376         float const view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
 377         float const film_ratio = container ? container->ratio () : 1.78;
 378
 379         if (view_ratio < film_ratio) {
 380                 /* panel is less widscreen than the film; clamp width */
 381                 _out_size.width = _video_view->get()->GetSize().x;
 382                 _out_size.height = lrintf (_out_size.width / film_ratio);
 383         } else {
 384                 /* panel is more widescreen than the film; clamp height */
 385                 _out_size.height = _video_view->get()->GetSize().y;
 386                 _out_size.width = lrintf (_out_size.height * film_ratio);
 387         }
 388
 389         /* Catch silly values */
 390         _out_size.width = max (64, _out_size.width);
 391         _out_size.height = max (64, _out_size.height);
 392
 393         _player->set_video_container_size (_out_size);
 394 }
 395
 396 void
 397 FilmViewer::start ()
 398 {
 399         if (!_film) {
 400                 return;
 401         }
 402
 403         optional<bool> v = PlaybackPermitted ();
 404         if (v && !*v) {
 405                 /* Computer says no */
 406                 return;
 407         }
 408
 409         if (_audio.isStreamOpen()) {
 410                 _audio.setStreamTime (_video_position.seconds());
 411                 _audio.startStream ();
 412         }
 413
 414         _playing = true;
 415         _dropped = 0;
 416         timer ();
 417         Started (position());
 418 }
 419
 420 bool
 421 FilmViewer::stop ()
 422 {
 423         if (_audio.isStreamRunning()) {
 424                 /* stop stream and discard any remaining queued samples */
 425                 _audio.abortStream ();
 426         }
 427
 428         if (!_playing) {
 429                 return false;
 430         }
 431
 432         _playing = false;
 433         Stopped (position());
 434         return true;
 435 }
 436
 437 void
 438 FilmViewer::player_change (ChangeType type, int property, bool frequent)
 439 {
 440         if (type != CHANGE_TYPE_DONE || frequent) {
 441                 return;
 442         }
 443
 444         if (_coalesce_player_changes) {
 445                 _pending_player_changes.push_back (property);
 446                 return;
 447         }
 448
 449         calculate_sizes ();
 450         bool refreshed = false;
 451         if (
 452                 property == VideoContentProperty::CROP ||
 453                 property == VideoContentProperty::SCALE ||
 454                 property == VideoContentProperty::FADE_IN ||
 455                 property == VideoContentProperty::FADE_OUT ||
 456                 property == VideoContentProperty::COLOUR_CONVERSION ||
 457                 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
 458                 property == PlayerProperty::FILM_CONTAINER
 459                 ) {
 460                 refreshed = quick_refresh ();
 461         }
 462
 463         if (!refreshed) {
 464                 slow_refresh ();
 465         }
 466         PositionChanged ();
 467 }
 468
 469 void
 470 FilmViewer::film_change (ChangeType type, Film::Property p)
 471 {
 472         if (type == CHANGE_TYPE_DONE && p == Film::AUDIO_CHANNELS) {
 473                 recreate_butler ();
 474         }
 475 }
 476
 477 /** Re-get the current frame slowly by seeking */
 478 void
 479 FilmViewer::slow_refresh ()
 480 {
 481         seek (_video_position, true);
 482 }
 483
 484 /** Try to re-get the current frame quickly by resetting the metadata
 485  *  in the PlayerVideo that we used last time.
 486  *  @return true if this was possible, false if not.
 487  */
 488 bool
 489 FilmViewer::quick_refresh ()
 490 {
 491         if (!_player_video.first) {
 492                 return false;
 493         }
 494
 495         if (!_player_video.first->reset_metadata (_film, _player->video_container_size(), _film->frame_size())) {
 496                 return false;
 497         }
 498
 499         display_player_video ();
 500         return true;
 501 }
 502
 503 void
 504 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
 505 {
 506         optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
 507         if (dt) {
 508                 seek (*dt, accurate);
 509         }
 510 }
 511
 512 void
 513 FilmViewer::set_coalesce_player_changes (bool c)
 514 {
 515         _coalesce_player_changes = c;
 516
 517         if (!c) {
 518                 BOOST_FOREACH (int i, _pending_player_changes) {
 519                         player_change (CHANGE_TYPE_DONE, i, false);
 520                 }
 521                 _pending_player_changes.clear ();
 522         }
 523 }
 524
 525 void
 526 FilmViewer::seek (DCPTime t, bool accurate)
 527 {
 528         if (!_butler) {
 529                 return;
 530         }
 531
 532         if (t < DCPTime ()) {
 533                 t = DCPTime ();
 534         }
 535
 536         if (t >= _film->length ()) {
 537                 t = _film->length ();
 538         }
 539
 540         bool const was_running = stop ();
 541
 542         _closed_captions_dialog->clear ();
 543         _butler->seek (t, accurate);
 544         get ();
 545
 546         if (was_running) {
 547                 start ();
 548         }
 549
 550         PositionChanged ();
 551 }
 552
 553 void
 554 FilmViewer::config_changed (Config::Property p)
 555 {
 556 #ifdef DCPOMATIC_VARIANT_SWAROOP
 557         if (p == Config::PLAYER_BACKGROUND_IMAGE) {
 558                 refresh_view ();
 559                 return;
 560         }
 561 #endif
 562
 563         if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
 564                 return;
 565         }
 566
 567         if (_audio.isStreamOpen ()) {
 568                 _audio.closeStream ();
 569         }
 570
 571         if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
 572                 unsigned int st = 0;
 573                 if (Config::instance()->sound_output()) {
 574                         while (st < _audio.getDeviceCount()) {
 575                                 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
 576                                         break;
 577                                 }
 578                                 ++st;
 579                         }
 580                         if (st == _audio.getDeviceCount()) {
 581                                 st = _audio.getDefaultOutputDevice();
 582                         }
 583                 } else {
 584                         st = _audio.getDefaultOutputDevice();
 585                 }
 586
 587                 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
 588
 589                 RtAudio::StreamParameters sp;
 590                 sp.deviceId = st;
 591                 sp.nChannels = _audio_channels;
 592                 sp.firstChannel = 0;
 593                 try {
 594                         _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
 595 #ifdef DCPOMATIC_USE_RTERROR
 596                 } catch (RtError& e) {
 597 #else
 598                 } catch (RtAudioError& e) {
 599 #endif
 600                         error_dialog (
 601                                 _video_view->get(),
 602                                 _("Could not set up audio output.  There will be no audio during the preview."), std_to_wx(e.what())
 603                                 );
 604                 }
 605                 recreate_butler ();
 606
 607         } else {
 608                 _audio_channels = 0;
 609                 recreate_butler ();
 610         }
 611 }
 612
 613 DCPTime
 614 FilmViewer::uncorrected_time () const
 615 {
 616         if (_audio.isStreamRunning ()) {
 617                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
 618         }
 619
 620         return _video_position;
 621 }
 622
 623 DCPTime
 624 FilmViewer::time () const
 625 {
 626         if (_audio.isStreamRunning ()) {
 627                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
 628                         DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
 629         }
 630
 631         return _video_position;
 632 }
 633
 634 int
 635 FilmViewer::audio_callback (void* out_p, unsigned int frames)
 636 {
 637         while (true) {
 638                 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
 639                 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
 640                         /* There was an underrun or this audio is on time; carry on */
 641                         break;
 642                 }
 643                 /* The audio we just got was (very) late; drop it and get some more. */
 644         }
 645
 646         boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
 647         if (lm) {
 648                 _latency_history.push_back (_audio.getStreamLatency ());
 649                 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
 650                         _latency_history.pop_front ();
 651                 }
 652         }
 653
 654         return 0;
 655 }
 656
 657 Frame
 658 FilmViewer::average_latency () const
 659 {
 660         boost::mutex::scoped_lock lm (_latency_history_mutex);
 661         if (_latency_history.empty()) {
 662                 return 0;
 663         }
 664
 665         Frame total = 0;
 666         BOOST_FOREACH (Frame i, _latency_history) {
 667                 total += i;
 668         }
 669
 670         return total / _latency_history.size();
 671 }
 672
 673 void
 674 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
 675 {
 676         _dcp_decode_reduction = reduction;
 677         if (_player) {
 678                 _player->set_dcp_decode_reduction (reduction);
 679         }
 680 }
 681
 682 optional<int>
 683 FilmViewer::dcp_decode_reduction () const
 684 {
 685         return _dcp_decode_reduction;
 686 }
 687
 688 DCPTime
 689 FilmViewer::one_video_frame () const
 690 {
 691         return DCPTime::from_frames (1, _film->video_frame_rate());
 692 }
 693
 694 /** Open a dialog box showing our film's closed captions */
 695 void
 696 FilmViewer::show_closed_captions ()
 697 {
 698         _closed_captions_dialog->Show();
 699 }
 700
 701 void
 702 FilmViewer::seek_by (DCPTime by, bool accurate)
 703 {
 704         seek (_video_position + by, accurate);
 705 }
 706
 707 void
 708 FilmViewer::set_pad_black (bool p)
 709 {
 710         _pad_black = p;
 711 }