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