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