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         if (dynamic_pointer_cast<GLVideoView>(_video_view) && _optimise_for_j2k) {
 233                 _butler->set_prepare_only_proxy (true);
 234         }
 235
 236         _closed_captions_dialog->set_butler (_butler);
 237
 238         resume ();
 239 }
 240
 241
 242 void
 243 FilmViewer::set_outline_content (bool o)
 244 {
 245         _outline_content = o;
 246         _video_view->update ();
 247 }
 248
 249
 250 void
 251 FilmViewer::set_outline_subtitles (optional<dcpomatic::Rect<double>> rect)
 252 {
 253         _outline_subtitles = rect;
 254         _video_view->update ();
 255 }
 256
 257
 258 void
 259 FilmViewer::set_eyes (Eyes e)
 260 {
 261         _video_view->set_eyes (e);
 262         slow_refresh ();
 263 }
 264
 265
 266 void
 267 FilmViewer::video_view_sized ()
 268 {
 269         calculate_sizes ();
 270         if (!quick_refresh()) {
 271                 slow_refresh ();
 272         }
 273 }
 274
 275
 276 void
 277 FilmViewer::calculate_sizes ()
 278 {
 279         if (!_film || !_player) {
 280                 return;
 281         }
 282
 283         auto const container = _film->container ();
 284
 285         auto const view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
 286         auto const film_ratio = container ? container->ratio () : 1.78;
 287
 288         dcp::Size out_size;
 289         if (view_ratio < film_ratio) {
 290                 /* panel is less widscreen than the film; clamp width */
 291                 out_size.width = _video_view->get()->GetSize().x;
 292                 out_size.height = lrintf (out_size.width / film_ratio);
 293         } else {
 294                 /* panel is more widescreen than the film; clamp height */
 295                 out_size.height = _video_view->get()->GetSize().y;
 296                 out_size.width = lrintf (out_size.height * film_ratio);
 297         }
 298
 299         /* Catch silly values */
 300         out_size.width = max (64, out_size.width);
 301         out_size.height = max (64, out_size.height);
 302
 303         _player->set_video_container_size (out_size);
 304 }
 305
 306
 307 void
 308 FilmViewer::suspend ()
 309 {
 310         ++_suspended;
 311         if (_audio.isStreamRunning()) {
 312                 _audio.abortStream();
 313         }
 314 }
 315
 316
 317 void
 318 FilmViewer::resume ()
 319 {
 320         DCPOMATIC_ASSERT (_suspended > 0);
 321         --_suspended;
 322         if (_playing && !_suspended) {
 323                 if (_audio.isStreamOpen()) {
 324                         _audio.setStreamTime (_video_view->position().seconds());
 325                         _audio.startStream ();
 326                 }
 327                 _video_view->start ();
 328         }
 329 }
 330
 331
 332 void
 333 FilmViewer::start ()
 334 {
 335         if (!_film) {
 336                 return;
 337         }
 338
 339         auto v = PlaybackPermitted ();
 340         if (v && !*v) {
 341                 /* Computer says no */
 342                 return;
 343         }
 344
 345         /* We are about to set up the audio stream from the position of the video view.
 346            If there is `lazy' seek in progress we need to wait for it to go through so that
 347            _video_view->position() gives us a sensible answer.
 348          */
 349         while (_idle_get) {
 350                 idle_handler ();
 351         }
 352
 353         /* Take the video view's idea of position as our `playhead' and start the
 354            audio stream (which is the timing reference) there.
 355          */
 356         if (_audio.isStreamOpen()) {
 357                 _audio.setStreamTime (_video_view->position().seconds());
 358                 try {
 359                         _audio.startStream ();
 360                 } catch (RtAudioError& e) {
 361                         _audio_channels = 0;
 362                         error_dialog (
 363                                 _video_view->get(),
 364                                 _("There was a problem starting audio playback.  Please try another audio output device in Preferences."), std_to_wx(e.what())
 365                                 );
 366                 }
 367         }
 368
 369         _playing = true;
 370         /* Calling start() below may directly result in Stopped being emitted, and if that
 371          * happens we want it to come after the Started signal, so do that first.
 372          */
 373         Started (position());
 374         _video_view->start ();
 375 }
 376
 377
 378 bool
 379 FilmViewer::stop ()
 380 {
 381         if (_audio.isStreamRunning()) {
 382                 /* stop stream and discard any remaining queued samples */
 383                 _audio.abortStream ();
 384         }
 385
 386         if (!_playing) {
 387                 return false;
 388         }
 389
 390         _playing = false;
 391         _video_view->stop ();
 392         Stopped (position());
 393
 394         _video_view->rethrow ();
 395         return true;
 396 }
 397
 398
 399 void
 400 FilmViewer::player_change (ChangeType type, int property, bool frequent)
 401 {
 402         if (type != ChangeType::DONE || frequent) {
 403                 return;
 404         }
 405
 406         if (_coalesce_player_changes) {
 407                 _pending_player_changes.push_back (property);
 408                 return;
 409         }
 410
 411         player_change ({property});
 412 }
 413
 414
 415 void
 416 FilmViewer::player_change (vector<int> properties)
 417 {
 418         calculate_sizes ();
 419
 420         bool try_quick_refresh = false;
 421         bool update_ccap_tracks = false;
 422
 423         for (auto i: properties) {
 424                 if (
 425                         i == VideoContentProperty::CROP ||
 426                         i == VideoContentProperty::CUSTOM_RATIO ||
 427                         i == VideoContentProperty::CUSTOM_SIZE ||
 428                         i == VideoContentProperty::FADE_IN ||
 429                         i == VideoContentProperty::FADE_OUT ||
 430                         i == VideoContentProperty::COLOUR_CONVERSION ||
 431                         i == PlayerProperty::VIDEO_CONTAINER_SIZE ||
 432                         i == PlayerProperty::FILM_CONTAINER
 433                    ) {
 434                         try_quick_refresh = true;
 435                 }
 436
 437                 if (i == TextContentProperty::USE || i == TextContentProperty::TYPE || i == TextContentProperty::DCP_TRACK) {
 438                         update_ccap_tracks = true;
 439                 }
 440         }
 441
 442         if (!try_quick_refresh || !quick_refresh()) {
 443                 slow_refresh ();
 444         }
 445
 446         if (update_ccap_tracks) {
 447                 _closed_captions_dialog->update_tracks (_film);
 448         }
 449 }
 450
 451
 452 void
 453 FilmViewer::film_change (ChangeType type, Film::Property p)
 454 {
 455         if (type != ChangeType::DONE) {
 456                 return;
 457         }
 458
 459         if (p == Film::Property::AUDIO_CHANNELS) {
 460                 recreate_butler ();
 461         } else if (p == Film::Property::VIDEO_FRAME_RATE) {
 462                 _video_view->set_video_frame_rate (_film->video_frame_rate());
 463         } else if (p == Film::Property::THREE_D) {
 464                 _video_view->set_three_d (_film->three_d());
 465         } else if (p == Film::Property::CONTENT) {
 466                 _closed_captions_dialog->update_tracks (_film);
 467         }
 468 }
 469
 470
 471 void
 472 FilmViewer::film_length_change ()
 473 {
 474         _video_view->set_length (_film->length());
 475 }
 476
 477
 478 /** Re-get the current frame slowly by seeking */
 479 void
 480 FilmViewer::slow_refresh ()
 481 {
 482         seek (_video_view->position(), true);
 483 }
 484
 485
 486 /** Try to re-get the current frame quickly by resetting the metadata
 487  *  in the PlayerVideo that we used last time.
 488  *  @return true if this was possible, false if not.
 489  */
 490 bool
 491 FilmViewer::quick_refresh ()
 492 {
 493         if (!_video_view || !_film || !_player) {
 494                 return true;
 495         }
 496         return _video_view->reset_metadata (_film, _player->video_container_size());
 497 }
 498
 499
 500 void
 501 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
 502 {
 503         auto dt = _player->content_time_to_dcp (content, t);
 504         if (dt) {
 505                 seek (*dt, accurate);
 506         }
 507 }
 508
 509
 510 void
 511 FilmViewer::set_coalesce_player_changes (bool c)
 512 {
 513         _coalesce_player_changes = c;
 514
 515         if (!c) {
 516                 player_change (_pending_player_changes);
 517                 _pending_player_changes.clear ();
 518         }
 519 }
 520
 521
 522 void
 523 FilmViewer::seek (DCPTime t, bool accurate)
 524 {
 525         if (!_butler) {
 526                 return;
 527         }
 528
 529         if (t < DCPTime()) {
 530                 t = DCPTime ();
 531         }
 532
 533         if (t >= _film->length()) {
 534                 t = _film->length() - one_video_frame();
 535         }
 536
 537         suspend ();
 538
 539         _closed_captions_dialog->clear ();
 540         _butler->seek (t, accurate);
 541
 542         if (!_playing) {
 543                 /* We're not playing, so let the GUI thread get on and
 544                    come back later to get the next frame after the seek.
 545                 */
 546                 request_idle_display_next_frame ();
 547         } else {
 548                 /* We're going to start playing again straight away
 549                    so wait for the seek to finish.
 550                 */
 551                 while (_video_view->display_next_frame(false) == VideoView::AGAIN) {}
 552         }
 553
 554         resume ();
 555 }
 556
 557
 558 void
 559 FilmViewer::config_changed (Config::Property p)
 560 {
 561         if (p == Config::AUDIO_MAPPING) {
 562                 recreate_butler ();
 563                 return;
 564         }
 565
 566         if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
 567                 return;
 568         }
 569
 570         if (_audio.isStreamOpen ()) {
 571                 _audio.closeStream ();
 572         }
 573
 574         if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
 575                 unsigned int st = 0;
 576                 if (Config::instance()->sound_output()) {
 577                         while (st < _audio.getDeviceCount()) {
 578                                 try {
 579                                         if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
 580                                                 break;
 581                                         }
 582                                 } catch (RtAudioError&) {
 583                                         /* Something went wrong with that device so we don't want to use it anyway */
 584                                 }
 585                                 ++st;
 586                         }
 587                         if (st == _audio.getDeviceCount()) {
 588                                 st = _audio.getDefaultOutputDevice();
 589                         }
 590                 } else {
 591                         st = _audio.getDefaultOutputDevice();
 592                 }
 593
 594                 try {
 595                         _audio_channels = _audio.getDeviceInfo(st).outputChannels;
 596                         RtAudio::StreamParameters sp;
 597                         sp.deviceId = st;
 598                         sp.nChannels = _audio_channels;
 599                         sp.firstChannel = 0;
 600                         _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
 601                 } catch (RtAudioError& e) {
 602                         _audio_channels = 0;
 603                         error_dialog (
 604                                 _video_view->get(),
 605                                 _("Could not set up audio output.  There will be no audio during the preview."), std_to_wx(e.what())
 606                                 );
 607                 }
 608                 recreate_butler ();
 609
 610         } else {
 611                 _audio_channels = 0;
 612                 recreate_butler ();
 613         }
 614 }
 615
 616
 617 DCPTime
 618 FilmViewer::uncorrected_time () const
 619 {
 620         if (_audio.isStreamRunning()) {
 621                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
 622         }
 623
 624         return _video_view->position();
 625 }
 626
 627
 628 optional<DCPTime>
 629 FilmViewer::audio_time () const
 630 {
 631         if (!_audio.isStreamRunning()) {
 632                 return {};
 633         }
 634
 635         return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
 636                 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
 637 }
 638
 639
 640 DCPTime
 641 FilmViewer::time () const
 642 {
 643         return audio_time().get_value_or(_video_view->position());
 644 }
 645
 646
 647 int
 648 FilmViewer::audio_callback (void* out_p, unsigned int frames)
 649 {
 650         while (true) {
 651                 auto t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
 652                 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
 653                         /* There was an underrun or this audio is on time; carry on */
 654                         break;
 655                 }
 656                 /* The audio we just got was (very) late; drop it and get some more. */
 657         }
 658
 659         boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
 660         if (lm) {
 661                 _latency_history.push_back (_audio.getStreamLatency ());
 662                 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
 663                         _latency_history.pop_front ();
 664                 }
 665         }
 666
 667         return 0;
 668 }
 669
 670
 671 Frame
 672 FilmViewer::average_latency () const
 673 {
 674         boost::mutex::scoped_lock lm (_latency_history_mutex);
 675         if (_latency_history.empty()) {
 676                 return 0;
 677         }
 678
 679         Frame total = 0;
 680         for (auto i: _latency_history) {
 681                 total += i;
 682         }
 683
 684         return total / _latency_history.size();
 685 }
 686
 687
 688 void
 689 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
 690 {
 691         _dcp_decode_reduction = reduction;
 692         if (_player) {
 693                 _player->set_dcp_decode_reduction (reduction);
 694         }
 695 }
 696
 697
 698 optional<int>
 699 FilmViewer::dcp_decode_reduction () const
 700 {
 701         return _dcp_decode_reduction;
 702 }
 703
 704
 705 DCPTime
 706 FilmViewer::one_video_frame () const
 707 {
 708         return DCPTime::from_frames (1, _film ? _film->video_frame_rate() : 24);
 709 }
 710
 711
 712 /** Open a dialog box showing our film's closed captions */
 713 void
 714 FilmViewer::show_closed_captions ()
 715 {
 716         _closed_captions_dialog->Show();
 717 }
 718
 719
 720 void
 721 FilmViewer::seek_by (DCPTime by, bool accurate)
 722 {
 723         seek (_video_view->position() + by, accurate);
 724 }
 725
 726
 727 void
 728 FilmViewer::set_pad_black (bool p)
 729 {
 730         _pad_black = p;
 731 }
 732
 733
 734 /** Called when a player has finished the current film.
 735  *  May be called from a non-UI thread.
 736  */
 737 void
 738 FilmViewer::finished ()
 739 {
 740         emit (boost::bind(&FilmViewer::ui_finished, this));
 741 }
 742
 743
 744 /** Called by finished() in the UI thread */
 745 void
 746 FilmViewer::ui_finished ()
 747 {
 748         stop ();
 749         Finished ();
 750 }
 751
 752
 753 int
 754 FilmViewer::dropped () const
 755 {
 756         return _video_view->dropped ();
 757 }
 758
 759
 760 int
 761 FilmViewer::errored () const
 762 {
 763         return _video_view->errored ();
 764 }
 765
 766
 767 int
 768 FilmViewer::gets () const
 769 {
 770         return _video_view->gets ();
 771 }
 772
 773
 774 void
 775 FilmViewer::image_changed (shared_ptr<PlayerVideo> pv)
 776 {
 777         emit (boost::bind(boost::ref(ImageChanged), pv));
 778 }
 779
 780
 781 void
 782 FilmViewer::set_optimise_for_j2k (bool o)
 783 {
 784         _optimise_for_j2k = o;
 785         _video_view->set_optimise_for_j2k (o);
 786 }
 787