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         , _suspended (0)
  88         , _latency_history_count (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         , _idle_get (false)
  99 {
 100         switch (Config::instance()->video_view_type()) {
 101         case Config::VIDEO_VIEW_OPENGL:
 102                 _video_view = new GLVideoView (this, p);
 103                 break;
 104         case Config::VIDEO_VIEW_SIMPLE:
 105                 _video_view = new SimpleVideoView (this, p);
 106                 break;
 107         }
 108
 109         _video_view->Sized.connect (boost::bind(&FilmViewer::video_view_sized, 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 /** 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 void
 136 FilmViewer::idle_handler ()
 137 {
 138         if (!_idle_get) {
 139                 return;
 140         }
 141
 142         if (_video_view->display_next_frame(true)) {
 143                 _idle_get = false;
 144         } else {
 145                 /* get() could not complete quickly so we'll try again later */
 146                 signal_manager->when_idle (boost::bind(&FilmViewer::idle_handler, this));
 147         }
 148 }
 149
 150 void
 151 FilmViewer::set_film (shared_ptr<Film> film)
 152 {
 153         if (_film == film) {
 154                 return;
 155         }
 156
 157         _film = film;
 158
 159         _video_view->clear ();
 160         _closed_captions_dialog->clear ();
 161
 162         if (!_film) {
 163                 _player.reset ();
 164                 recreate_butler ();
 165                 refresh_view ();
 166                 return;
 167         }
 168
 169         try {
 170                 _player.reset (new Player (_film, _film->playlist ()));
 171                 _player->set_fast ();
 172                 if (_dcp_decode_reduction) {
 173                         _player->set_dcp_decode_reduction (_dcp_decode_reduction);
 174                 }
 175         } catch (bad_alloc &) {
 176                 error_dialog (_video_view->get(), _("There is not enough free memory to do that."));
 177                 _film.reset ();
 178                 return;
 179         }
 180
 181         _player->set_always_burn_open_subtitles ();
 182         _player->set_play_referenced ();
 183
 184         _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
 185         _film->LengthChange.connect (boost::bind(&FilmViewer::film_length_change, this));
 186         _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
 187
 188         /* Keep about 1 second's worth of history samples */
 189         _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
 190
 191         recreate_butler ();
 192
 193         calculate_sizes ();
 194         slow_refresh ();
 195 }
 196
 197 void
 198 FilmViewer::recreate_butler ()
 199 {
 200         suspend ();
 201         _butler.reset ();
 202
 203         if (!_film) {
 204                 resume ();
 205                 return;
 206         }
 207
 208         _butler.reset(
 209                 new Butler(
 210                         _player,
 211                         Config::instance()->audio_mapping(_audio_channels),
 212                         _audio_channels,
 213                         bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24),
 214                         false,
 215                         true
 216                         )
 217                 );
 218
 219         if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
 220                 _butler->disable_audio ();
 221         }
 222
 223         _closed_captions_dialog->set_film_and_butler (_film, _butler);
 224
 225         resume ();
 226 }
 227
 228 void
 229 FilmViewer::refresh_view ()
 230 {
 231         _state_timer.set ("update-view");
 232         _video_view->update ();
 233         _state_timer.unset ();
 234 }
 235
 236 void
 237 FilmViewer::set_outline_content (bool o)
 238 {
 239         _outline_content = o;
 240         refresh_view ();
 241 }
 242
 243 void
 244 FilmViewer::set_eyes (Eyes e)
 245 {
 246         _eyes = e;
 247         slow_refresh ();
 248 }
 249
 250 void
 251 FilmViewer::video_view_sized ()
 252 {
 253         calculate_sizes ();
 254         if (!quick_refresh()) {
 255                 slow_refresh ();
 256         }
 257 }
 258
 259 void
 260 FilmViewer::calculate_sizes ()
 261 {
 262         if (!_film || !_player) {
 263                 return;
 264         }
 265
 266         Ratio const * container = _film->container ();
 267
 268         float const view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
 269         float const film_ratio = container ? container->ratio () : 1.78;
 270
 271         if (view_ratio < film_ratio) {
 272                 /* panel is less widscreen than the film; clamp width */
 273                 _out_size.width = _video_view->get()->GetSize().x;
 274                 _out_size.height = lrintf (_out_size.width / film_ratio);
 275         } else {
 276                 /* panel is more widescreen than the film; clamp height */
 277                 _out_size.height = _video_view->get()->GetSize().y;
 278                 _out_size.width = lrintf (_out_size.height * film_ratio);
 279         }
 280
 281         /* Catch silly values */
 282         _out_size.width = max (64, _out_size.width);
 283         _out_size.height = max (64, _out_size.height);
 284
 285         _player->set_video_container_size (_out_size);
 286 }
 287
 288 void
 289 FilmViewer::suspend ()
 290 {
 291         ++_suspended;
 292         if (_audio.isStreamRunning()) {
 293                 _audio.abortStream();
 294         }
 295 }
 296
 297 void
 298 FilmViewer::resume ()
 299 {
 300         --_suspended;
 301         if (_playing && !_suspended) {
 302                 if (_audio.isStreamOpen()) {
 303                         _audio.setStreamTime (_video_view->position().seconds());
 304                         _audio.startStream ();
 305                 }
 306                 _video_view->start ();
 307         }
 308 }
 309
 310 void
 311 FilmViewer::start ()
 312 {
 313         if (!_film) {
 314                 return;
 315         }
 316
 317         optional<bool> v = PlaybackPermitted ();
 318         if (v && !*v) {
 319                 /* Computer says no */
 320                 return;
 321         }
 322
 323         if (_audio.isStreamOpen()) {
 324                 _audio.setStreamTime (_video_view->position().seconds());
 325                 _audio.startStream ();
 326         }
 327
 328         _playing = true;
 329         _video_view->start ();
 330         Started (position());
 331 }
 332
 333 bool
 334 FilmViewer::stop ()
 335 {
 336         if (_audio.isStreamRunning()) {
 337                 /* stop stream and discard any remaining queued samples */
 338                 _audio.abortStream ();
 339         }
 340
 341         if (!_playing) {
 342                 return false;
 343         }
 344
 345         _playing = false;
 346         _video_view->stop ();
 347         Stopped (position());
 348         return true;
 349 }
 350
 351 void
 352 FilmViewer::player_change (ChangeType type, int property, bool frequent)
 353 {
 354         if (type != CHANGE_TYPE_DONE || frequent) {
 355                 return;
 356         }
 357
 358         if (_coalesce_player_changes) {
 359                 _pending_player_changes.push_back (property);
 360                 return;
 361         }
 362
 363         calculate_sizes ();
 364         bool refreshed = false;
 365         if (
 366                 property == VideoContentProperty::CROP ||
 367                 property == VideoContentProperty::SCALE ||
 368                 property == VideoContentProperty::FADE_IN ||
 369                 property == VideoContentProperty::FADE_OUT ||
 370                 property == VideoContentProperty::COLOUR_CONVERSION ||
 371                 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
 372                 property == PlayerProperty::FILM_CONTAINER
 373                 ) {
 374                 refreshed = quick_refresh ();
 375         }
 376
 377         if (!refreshed) {
 378                 slow_refresh ();
 379         }
 380 }
 381
 382 void
 383 FilmViewer::film_change (ChangeType type, Film::Property p)
 384 {
 385         if (type != CHANGE_TYPE_DONE) {
 386                 return;
 387         }
 388
 389         if (p == Film::AUDIO_CHANNELS) {
 390                 recreate_butler ();
 391         } else if (p == Film::VIDEO_FRAME_RATE) {
 392                 _video_view->set_video_frame_rate (_film->video_frame_rate());
 393         }
 394 }
 395
 396 void
 397 FilmViewer::film_length_change ()
 398 {
 399         _video_view->set_length (_film->length());
 400 }
 401
 402 /** Re-get the current frame slowly by seeking */
 403 void
 404 FilmViewer::slow_refresh ()
 405 {
 406         seek (_video_view->position(), true);
 407 }
 408
 409 /** Try to re-get the current frame quickly by resetting the metadata
 410  *  in the PlayerVideo that we used last time.
 411  *  @return true if this was possible, false if not.
 412  */
 413 bool
 414 FilmViewer::quick_refresh ()
 415 {
 416         if (!_video_view->_player_video.first) {
 417                 return false;
 418         }
 419
 420         if (!_video_view->_player_video.first->reset_metadata (_film, _player->video_container_size(), _film->frame_size())) {
 421                 return false;
 422         }
 423
 424         _video_view->display_player_video ();
 425         return true;
 426 }
 427
 428 void
 429 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
 430 {
 431         optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
 432         if (dt) {
 433                 seek (*dt, accurate);
 434         }
 435 }
 436
 437 void
 438 FilmViewer::set_coalesce_player_changes (bool c)
 439 {
 440         _coalesce_player_changes = c;
 441
 442         if (!c) {
 443                 BOOST_FOREACH (int i, _pending_player_changes) {
 444                         player_change (CHANGE_TYPE_DONE, i, false);
 445                 }
 446                 _pending_player_changes.clear ();
 447         }
 448 }
 449
 450 void
 451 FilmViewer::seek (DCPTime t, bool accurate)
 452 {
 453         if (!_butler) {
 454                 return;
 455         }
 456
 457         if (t < DCPTime ()) {
 458                 t = DCPTime ();
 459         }
 460
 461         if (t >= _film->length ()) {
 462                 t = _film->length ();
 463         }
 464
 465         suspend ();
 466
 467         _closed_captions_dialog->clear ();
 468         _butler->seek (t, accurate);
 469
 470         if (!_playing) {
 471                 request_idle_display_next_frame ();
 472         } else {
 473                 while (!_video_view->display_next_frame(false)) {}
 474         }
 475
 476         resume ();
 477 }
 478
 479 void
 480 FilmViewer::config_changed (Config::Property p)
 481 {
 482 #ifdef DCPOMATIC_VARIANT_SWAROOP
 483         if (p == Config::PLAYER_BACKGROUND_IMAGE) {
 484                 refresh_view ();
 485                 return;
 486         }
 487 #endif
 488
 489         if (p == Config::AUDIO_MAPPING) {
 490                 recreate_butler ();
 491                 return;
 492         }
 493
 494         if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
 495                 return;
 496         }
 497
 498         if (_audio.isStreamOpen ()) {
 499                 _audio.closeStream ();
 500         }
 501
 502         if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
 503                 unsigned int st = 0;
 504                 if (Config::instance()->sound_output()) {
 505                         while (st < _audio.getDeviceCount()) {
 506                                 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
 507                                         break;
 508                                 }
 509                                 ++st;
 510                         }
 511                         if (st == _audio.getDeviceCount()) {
 512                                 st = _audio.getDefaultOutputDevice();
 513                         }
 514                 } else {
 515                         st = _audio.getDefaultOutputDevice();
 516                 }
 517
 518                 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
 519
 520                 RtAudio::StreamParameters sp;
 521                 sp.deviceId = st;
 522                 sp.nChannels = _audio_channels;
 523                 sp.firstChannel = 0;
 524                 try {
 525                         _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
 526 #ifdef DCPOMATIC_USE_RTERROR
 527                 } catch (RtError& e) {
 528 #else
 529                 } catch (RtAudioError& e) {
 530 #endif
 531                         error_dialog (
 532                                 _video_view->get(),
 533                                 _("Could not set up audio output.  There will be no audio during the preview."), std_to_wx(e.what())
 534                                 );
 535                 }
 536                 recreate_butler ();
 537
 538         } else {
 539                 _audio_channels = 0;
 540                 recreate_butler ();
 541         }
 542 }
 543
 544 DCPTime
 545 FilmViewer::uncorrected_time () const
 546 {
 547         if (_audio.isStreamRunning ()) {
 548                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
 549         }
 550
 551         return _video_view->position();
 552 }
 553
 554 optional<DCPTime>
 555 FilmViewer::audio_time () const
 556 {
 557         if (!_audio.isStreamRunning()) {
 558                 return optional<DCPTime>();
 559         }
 560
 561         return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
 562                 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
 563 }
 564
 565 DCPTime
 566 FilmViewer::time () const
 567 {
 568         return audio_time().get_value_or(_video_view->position());
 569 }
 570
 571 int
 572 FilmViewer::audio_callback (void* out_p, unsigned int frames)
 573 {
 574         while (true) {
 575                 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
 576                 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
 577                         /* There was an underrun or this audio is on time; carry on */
 578                         break;
 579                 }
 580                 /* The audio we just got was (very) late; drop it and get some more. */
 581         }
 582
 583         boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
 584         if (lm) {
 585                 _latency_history.push_back (_audio.getStreamLatency ());
 586                 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
 587                         _latency_history.pop_front ();
 588                 }
 589         }
 590
 591         return 0;
 592 }
 593
 594 Frame
 595 FilmViewer::average_latency () const
 596 {
 597         boost::mutex::scoped_lock lm (_latency_history_mutex);
 598         if (_latency_history.empty()) {
 599                 return 0;
 600         }
 601
 602         Frame total = 0;
 603         BOOST_FOREACH (Frame i, _latency_history) {
 604                 total += i;
 605         }
 606
 607         return total / _latency_history.size();
 608 }
 609
 610 void
 611 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
 612 {
 613         _dcp_decode_reduction = reduction;
 614         if (_player) {
 615                 _player->set_dcp_decode_reduction (reduction);
 616         }
 617 }
 618
 619 optional<int>
 620 FilmViewer::dcp_decode_reduction () const
 621 {
 622         return _dcp_decode_reduction;
 623 }
 624
 625 DCPTime
 626 FilmViewer::one_video_frame () const
 627 {
 628         return DCPTime::from_frames (1, _film ? _film->video_frame_rate() : 24);
 629 }
 630
 631 /** Open a dialog box showing our film's closed captions */
 632 void
 633 FilmViewer::show_closed_captions ()
 634 {
 635         _closed_captions_dialog->Show();
 636 }
 637
 638 void
 639 FilmViewer::seek_by (DCPTime by, bool accurate)
 640 {
 641         seek (_video_view->position() + by, accurate);
 642 }
 643
 644 void
 645 FilmViewer::set_pad_black (bool p)
 646 {
 647         _pad_black = p;
 648 }
 649
 650 /* May be called from a non-UI thread */
 651 void
 652 FilmViewer::emit_finished ()
 653 {
 654         emit (boost::bind(boost::ref(Finished)));
 655 }
 656
 657 int
 658 FilmViewer::dropped () const
 659 {
 660         return _video_view->dropped ();
 661 }
 662