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