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