src/wx/film_viewer.cc

   1 /*
   2     Copyright (C) 2012-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 /** @file  src/film_viewer.cc
  23  *  @brief A wx widget to view a preview of a Film.
  24  */
  25
  26
  27 #include "closed_captions_dialog.h"
  28 #include "film_viewer.h"
  29 #include "gl_video_view.h"
  30 #include "nag_dialog.h"
  31 #include "playhead_to_frame_dialog.h"
  32 #include "playhead_to_timecode_dialog.h"
  33 #include "simple_video_view.h"
  34 #include "wx_util.h"
  35 #include "lib/film.h"
  36 #include "lib/ratio.h"
  37 #include "lib/util.h"
  38 #include "lib/job_manager.h"
  39 #include "lib/image.h"
  40 #include "lib/exceptions.h"
  41 #include "lib/examine_content_job.h"
  42 #include "lib/filter.h"
  43 #include "lib/player.h"
  44 #include "lib/player_video.h"
  45 #include "lib/video_content.h"
  46 #include "lib/video_decoder.h"
  47 #include "lib/timer.h"
  48 #include "lib/butler.h"
  49 #include "lib/log.h"
  50 #include "lib/config.h"
  51 #include "lib/compose.hpp"
  52 #include "lib/dcpomatic_log.h"
  53 #include "lib/text_content.h"
  54 extern "C" {
  55 #include <libavutil/pixfmt.h>
  56 }
  57 #include <dcp/exceptions.h>
  58 #include <wx/tglbtn.h>
  59 #include <iostream>
  60 #include <iomanip>
  61
  62
  63 using std::bad_alloc;
  64 using std::cout;
  65 using std::dynamic_pointer_cast;
  66 using std::exception;
  67 using std::list;
  68 using std::make_pair;
  69 using std::make_shared;
  70 using std::max;
  71 using std::min;
  72 using std::pair;
  73 using std::shared_ptr;
  74 using std::string;
  75 using std::vector;
  76 using std::weak_ptr;
  77 using boost::optional;
  78 #if BOOST_VERSION >= 106100
  79 using namespace boost::placeholders;
  80 #endif
  81 using dcp::Size;
  82 using namespace dcpomatic;
  83
  84
  85 static
  86 int
  87 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
  88 {
  89         return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
  90 }
  91
  92
  93 FilmViewer::FilmViewer (wxWindow* p)
  94         : _audio (DCPOMATIC_RTAUDIO_API)
  95         , _closed_captions_dialog (new ClosedCaptionsDialog(p, this))
  96 {
  97         switch (Config::instance()->video_view_type()) {
  98         case Config::VIDEO_VIEW_OPENGL:
  99                 _video_view = std::make_shared<GLVideoView>(this, p);
 100                 break;
 101         case Config::VIDEO_VIEW_SIMPLE:
 102                 _video_view = std::make_shared<SimpleVideoView>(this, p);
 103                 break;
 104         }
 105
 106         _video_view->Sized.connect (boost::bind(&FilmViewer::video_view_sized, this));
 107         _video_view->TooManyDropped.connect (boost::bind(boost::ref(TooManyDropped)));
 108
 109         set_film (shared_ptr<Film>());
 110
 111         _config_changed_connection = Config::instance()->Changed.connect(bind(&FilmViewer::config_changed, this, _1));
 112         config_changed (Config::SOUND_OUTPUT);
 113 }
 114
 115
 116 FilmViewer::~FilmViewer ()
 117 {
 118         stop ();
 119 }
 120
 121
 122 /** Ask for ::get() to be called next time we are idle */
 123 void
 124 FilmViewer::request_idle_display_next_frame ()
 125 {
 126         if (_idle_get) {
 127                 return;
 128         }
 129
 130         _idle_get = true;
 131         DCPOMATIC_ASSERT (signal_manager);
 132         signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
 133 }
 134
 135
 136 void
 137 FilmViewer::idle_handler ()
 138 {
 139         if (!_idle_get) {
 140                 return;
 141         }
 142
 143         if (_video_view->display_next_frame(true) == VideoView::AGAIN) {
 144                 /* get() could not complete quickly so we'll try again later */
 145                 signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
 146         } else {
 147                 _idle_get = false;
 148         }
 149 }
 150
 151
 152 void
 153 FilmViewer::set_film (shared_ptr<Film> film)
 154 {
 155         if (_film == film) {
 156                 return;
 157         }
 158
 159         _film = film;
 160
 161         _video_view->clear ();
 162         _closed_captions_dialog->clear ();
 163
 164         if (!_film) {
 165                 _player.reset ();
 166                 recreate_butler ();
 167                 _video_view->update ();
 168                 return;
 169         }
 170
 171         try {
 172                 _player = make_shared<Player>(_film);
 173                 _player->set_fast ();
 174                 if (_dcp_decode_reduction) {
 175                         _player->set_dcp_decode_reduction (_dcp_decode_reduction);
 176                 }
 177         } catch (bad_alloc &) {
 178                 error_dialog (_video_view->get(), _("There is not enough free memory to do that."));
 179                 _film.reset ();
 180                 return;
 181         }
 182
 183         _player->set_always_burn_open_subtitles ();
 184         _player->set_play_referenced ();
 185
 186         _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
 187         _film->LengthChange.connect (boost::bind(&FilmViewer::film_length_change, this));
 188         _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
 189
 190         film_change (ChangeType::DONE, Film::Property::VIDEO_FRAME_RATE);
 191         film_change (ChangeType::DONE, Film::Property::THREE_D);
 192         film_length_change ();
 193
 194         /* Keep about 1 second's worth of history samples */
 195         _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
 196
 197         _closed_captions_dialog->update_tracks (_film);
 198
 199         recreate_butler ();
 200
 201         calculate_sizes ();
 202         slow_refresh ();
 203 }
 204
 205
 206 void
 207 FilmViewer::recreate_butler ()
 208 {
 209         suspend ();
 210         _butler.reset ();
 211
 212         if (!_film) {
 213                 resume ();
 214                 return;
 215         }
 216
 217         _butler = std::make_shared<Butler>(
 218                 _film,
 219                 _player,
 220                 Config::instance()->audio_mapping(_audio_channels),
 221                 _audio_channels,
 222                 bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24),
 223                 VideoRange::FULL,
 224                 false,
 225                 true
 226                 );
 227
 228         if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
 229                 _butler->disable_audio ();
 230         }
 231
 232         _closed_captions_dialog->set_butler (_butler);
 233
 234         resume ();
 235 }
 236
 237
 238 void
 239 FilmViewer::set_outline_content (bool o)
 240 {
 241         _outline_content = o;
 242         _video_view->update ();
 243 }
 244
 245
 246 void
 247 FilmViewer::set_outline_subtitles (optional<dcpomatic::Rect<double>> rect)
 248 {
 249         _outline_subtitles = rect;
 250         _video_view->update ();
 251 }
 252
 253
 254 void
 255 FilmViewer::set_eyes (Eyes e)
 256 {
 257         _video_view->set_eyes (e);
 258         slow_refresh ();
 259 }
 260
 261
 262 void
 263 FilmViewer::video_view_sized ()
 264 {
 265         calculate_sizes ();
 266         if (!quick_refresh()) {
 267                 slow_refresh ();
 268         }
 269 }
 270
 271
 272 void
 273 FilmViewer::calculate_sizes ()
 274 {
 275         if (!_film || !_player) {
 276                 return;
 277         }
 278
 279         auto const container = _film->container ();
 280
 281         auto const view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
 282         auto const film_ratio = container ? container->ratio () : 1.78;
 283
 284         dcp::Size out_size;
 285         if (view_ratio < film_ratio) {
 286                 /* panel is less widscreen than the film; clamp width */
 287                 out_size.width = _video_view->get()->GetSize().x;
 288                 out_size.height = lrintf (out_size.width / film_ratio);
 289         } else {
 290                 /* panel is more widescreen than the film; clamp height */
 291                 out_size.height = _video_view->get()->GetSize().y;
 292                 out_size.width = lrintf (out_size.height * film_ratio);
 293         }
 294
 295         /* Catch silly values */
 296         out_size.width = max (64, out_size.width);
 297         out_size.height = max (64, out_size.height);
 298
 299         _player->set_video_container_size (out_size);
 300 }
 301
 302
 303 void
 304 FilmViewer::suspend ()
 305 {
 306         ++_suspended;
 307         if (_audio.isStreamRunning()) {
 308                 _audio.abortStream();
 309         }
 310 }
 311
 312
 313 void
 314 FilmViewer::resume ()
 315 {
 316         DCPOMATIC_ASSERT (_suspended > 0);
 317         --_suspended;
 318         if (_playing && !_suspended) {
 319                 if (_audio.isStreamOpen()) {
 320                         _audio.setStreamTime (_video_view->position().seconds());
 321                         _audio.startStream ();
 322                 }
 323                 _video_view->start ();
 324         }
 325 }
 326
 327
 328 void
 329 FilmViewer::start ()
 330 {
 331         if (!_film) {
 332                 return;
 333         }
 334
 335         auto v = PlaybackPermitted ();
 336         if (v && !*v) {
 337                 /* Computer says no */
 338                 return;
 339         }
 340
 341         /* We are about to set up the audio stream from the position of the video view.
 342            If there is `lazy' seek in progress we need to wait for it to go through so that
 343            _video_view->position() gives us a sensible answer.
 344          */
 345         while (_idle_get) {
 346                 idle_handler ();
 347         }
 348
 349         /* Take the video view's idea of position as our `playhead' and start the
 350            audio stream (which is the timing reference) there.
 351          */
 352         if (_audio.isStreamOpen()) {
 353                 _audio.setStreamTime (_video_view->position().seconds());
 354                 try {
 355                         _audio.startStream ();
 356                 } catch (RtAudioError& e) {
 357                         _audio_channels = 0;
 358                         error_dialog (
 359                                 _video_view->get(),
 360                                 _("There was a problem starting audio playback.  Please try another audio output device in Preferences."), std_to_wx(e.what())
 361                                 );
 362                 }
 363         }
 364
 365         _playing = true;
 366         /* Calling start() below may directly result in Stopped being emitted, and if that
 367          * happens we want it to come after the Started signal, so do that first.
 368          */
 369         Started (position());
 370         _video_view->start ();
 371 }
 372
 373
 374 bool
 375 FilmViewer::stop ()
 376 {
 377         if (_audio.isStreamRunning()) {
 378                 /* stop stream and discard any remaining queued samples */
 379                 _audio.abortStream ();
 380         }
 381
 382         if (!_playing) {
 383                 return false;
 384         }
 385
 386         _playing = false;
 387         _video_view->stop ();
 388         Stopped (position());
 389
 390         _video_view->rethrow ();
 391         return true;
 392 }
 393
 394
 395 void
 396 FilmViewer::player_change (ChangeType type, int property, bool frequent)
 397 {
 398         if (type != ChangeType::DONE || frequent) {
 399                 return;
 400         }
 401
 402         if (_coalesce_player_changes) {
 403                 _pending_player_changes.push_back (property);
 404                 return;
 405         }
 406
 407         player_change ({property});
 408 }
 409
 410
 411 void
 412 FilmViewer::player_change (vector<int> properties)
 413 {
 414         calculate_sizes ();
 415
 416         bool try_quick_refresh = false;
 417         bool update_ccap_tracks = false;
 418
 419         for (auto i: properties) {
 420                 if (
 421                         i == VideoContentProperty::CROP ||
 422                         i == VideoContentProperty::CUSTOM_RATIO ||
 423                         i == VideoContentProperty::CUSTOM_SIZE ||
 424                         i == VideoContentProperty::FADE_IN ||
 425                         i == VideoContentProperty::FADE_OUT ||
 426                         i == VideoContentProperty::COLOUR_CONVERSION ||
 427                         i == PlayerProperty::VIDEO_CONTAINER_SIZE ||
 428                         i == PlayerProperty::FILM_CONTAINER
 429                    ) {
 430                         try_quick_refresh = true;
 431                 }
 432
 433                 if (i == TextContentProperty::USE || i == TextContentProperty::TYPE || i == TextContentProperty::DCP_TRACK) {
 434                         update_ccap_tracks = true;
 435                 }
 436         }
 437
 438         if (!try_quick_refresh || !quick_refresh()) {
 439                 slow_refresh ();
 440         }
 441
 442         if (update_ccap_tracks) {
 443                 _closed_captions_dialog->update_tracks (_film);
 444         }
 445 }
 446
 447
 448 void
 449 FilmViewer::film_change (ChangeType type, Film::Property p)
 450 {
 451         if (type != ChangeType::DONE) {
 452                 return;
 453         }
 454
 455         if (p == Film::Property::AUDIO_CHANNELS) {
 456                 recreate_butler ();
 457         } else if (p == Film::Property::VIDEO_FRAME_RATE) {
 458                 _video_view->set_video_frame_rate (_film->video_frame_rate());
 459         } else if (p == Film::Property::THREE_D) {
 460                 _video_view->set_three_d (_film->three_d());
 461         } else if (p == Film::Property::CONTENT) {
 462                 _closed_captions_dialog->update_tracks (_film);
 463         }
 464 }
 465
 466
 467 void
 468 FilmViewer::film_length_change ()
 469 {
 470         _video_view->set_length (_film->length());
 471 }
 472
 473
 474 /** Re-get the current frame slowly by seeking */
 475 void
 476 FilmViewer::slow_refresh ()
 477 {
 478         seek (_video_view->position(), true);
 479 }
 480
 481
 482 /** Try to re-get the current frame quickly by resetting the metadata
 483  *  in the PlayerVideo that we used last time.
 484  *  @return true if this was possible, false if not.
 485  */
 486 bool
 487 FilmViewer::quick_refresh ()
 488 {
 489         if (!_video_view || !_film || !_player) {
 490                 return true;
 491         }
 492         return _video_view->reset_metadata (_film, _player->video_container_size());
 493 }
 494
 495
 496 void
 497 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
 498 {
 499         auto dt = _player->content_time_to_dcp (content, t);
 500         if (dt) {
 501                 seek (*dt, accurate);
 502         }
 503 }
 504
 505
 506 void
 507 FilmViewer::set_coalesce_player_changes (bool c)
 508 {
 509         _coalesce_player_changes = c;
 510
 511         if (!c) {
 512                 player_change (_pending_player_changes);
 513                 _pending_player_changes.clear ();
 514         }
 515 }
 516
 517
 518 void
 519 FilmViewer::seek (DCPTime t, bool accurate)
 520 {
 521         if (!_butler) {
 522                 return;
 523         }
 524
 525         if (t < DCPTime()) {
 526                 t = DCPTime ();
 527         }
 528
 529         if (t >= _film->length()) {
 530                 t = _film->length() - one_video_frame();
 531         }
 532
 533         suspend ();
 534
 535         _closed_captions_dialog->clear ();
 536         _butler->seek (t, accurate);
 537
 538         if (!_playing) {
 539                 /* We're not playing, so let the GUI thread get on and
 540                    come back later to get the next frame after the seek.
 541                 */
 542                 request_idle_display_next_frame ();
 543         } else {
 544                 /* We're going to start playing again straight away
 545                    so wait for the seek to finish.
 546                 */
 547                 while (_video_view->display_next_frame(false) == VideoView::AGAIN) {}
 548         }
 549
 550         resume ();
 551 }
 552
 553
 554 void
 555 FilmViewer::config_changed (Config::Property p)
 556 {
 557         if (p == Config::AUDIO_MAPPING) {
 558                 recreate_butler ();
 559                 return;
 560         }
 561
 562         if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
 563                 return;
 564         }
 565
 566         if (_audio.isStreamOpen ()) {
 567                 _audio.closeStream ();
 568         }
 569
 570         if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
 571                 unsigned int st = 0;
 572                 if (Config::instance()->sound_output()) {
 573                         while (st < _audio.getDeviceCount()) {
 574                                 try {
 575                                         if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
 576                                                 break;
 577                                         }
 578                                 } catch (RtAudioError&) {
 579                                         /* Something went wrong with that device so we don't want to use it anyway */
 580                                 }
 581                                 ++st;
 582                         }
 583                         if (st == _audio.getDeviceCount()) {
 584                                 st = _audio.getDefaultOutputDevice();
 585                         }
 586                 } else {
 587                         st = _audio.getDefaultOutputDevice();
 588                 }
 589
 590                 try {
 591                         _audio_channels = _audio.getDeviceInfo(st).outputChannels;
 592                         RtAudio::StreamParameters sp;
 593                         sp.deviceId = st;
 594                         sp.nChannels = _audio_channels;
 595                         sp.firstChannel = 0;
 596                         _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
 597                 } catch (RtAudioError& e) {
 598                         _audio_channels = 0;
 599                         error_dialog (
 600                                 _video_view->get(),
 601                                 _("Could not set up audio output.  There will be no audio during the preview."), std_to_wx(e.what())
 602                                 );
 603                 }
 604                 recreate_butler ();
 605
 606         } else {
 607                 _audio_channels = 0;
 608                 recreate_butler ();
 609         }
 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_view->position();
 621 }
 622
 623
 624 optional<DCPTime>
 625 FilmViewer::audio_time () const
 626 {
 627         if (!_audio.isStreamRunning()) {
 628                 return {};
 629         }
 630
 631         return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
 632                 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
 633 }
 634
 635
 636 DCPTime
 637 FilmViewer::time () const
 638 {
 639         return audio_time().get_value_or(_video_view->position());
 640 }
 641
 642
 643 int
 644 FilmViewer::audio_callback (void* out_p, unsigned int frames)
 645 {
 646         while (true) {
 647                 auto t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
 648                 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
 649                         /* There was an underrun or this audio is on time; carry on */
 650                         break;
 651                 }
 652                 /* The audio we just got was (very) late; drop it and get some more. */
 653         }
 654
 655         boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
 656         if (lm) {
 657                 _latency_history.push_back (_audio.getStreamLatency ());
 658                 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
 659                         _latency_history.pop_front ();
 660                 }
 661         }
 662
 663         return 0;
 664 }
 665
 666
 667 Frame
 668 FilmViewer::average_latency () const
 669 {
 670         boost::mutex::scoped_lock lm (_latency_history_mutex);
 671         if (_latency_history.empty()) {
 672                 return 0;
 673         }
 674
 675         Frame total = 0;
 676         for (auto i: _latency_history) {
 677                 total += i;
 678         }
 679
 680         return total / _latency_history.size();
 681 }
 682
 683
 684 void
 685 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
 686 {
 687         _dcp_decode_reduction = reduction;
 688         if (_player) {
 689                 _player->set_dcp_decode_reduction (reduction);
 690         }
 691 }
 692
 693
 694 optional<int>
 695 FilmViewer::dcp_decode_reduction () const
 696 {
 697         return _dcp_decode_reduction;
 698 }
 699
 700
 701 DCPTime
 702 FilmViewer::one_video_frame () const
 703 {
 704         return DCPTime::from_frames (1, _film ? _film->video_frame_rate() : 24);
 705 }
 706
 707
 708 /** Open a dialog box showing our film's closed captions */
 709 void
 710 FilmViewer::show_closed_captions ()
 711 {
 712         _closed_captions_dialog->Show();
 713 }
 714
 715
 716 void
 717 FilmViewer::seek_by (DCPTime by, bool accurate)
 718 {
 719         seek (_video_view->position() + by, accurate);
 720 }
 721
 722
 723 void
 724 FilmViewer::set_pad_black (bool p)
 725 {
 726         _pad_black = p;
 727 }
 728
 729
 730 /** Called when a player has finished the current film.
 731  *  May be called from a non-UI thread.
 732  */
 733 void
 734 FilmViewer::finished ()
 735 {
 736         emit (boost::bind(&FilmViewer::ui_finished, this));
 737 }
 738
 739
 740 /** Called by finished() in the UI thread */
 741 void
 742 FilmViewer::ui_finished ()
 743 {
 744         stop ();
 745         Finished ();
 746 }
 747
 748
 749 int
 750 FilmViewer::dropped () const
 751 {
 752         return _video_view->dropped ();
 753 }
 754
 755
 756 int
 757 FilmViewer::errored () const
 758 {
 759         return _video_view->errored ();
 760 }
 761
 762
 763 int
 764 FilmViewer::gets () const
 765 {
 766         return _video_view->gets ();
 767 }
 768
 769
 770 void
 771 FilmViewer::image_changed (shared_ptr<PlayerVideo> pv)
 772 {
 773         emit (boost::bind(boost::ref(ImageChanged), pv));
 774 }