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 #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)) {
 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                         _film,
 216                         _player,
 217                         Config::instance()->audio_mapping(_audio_channels),
 218                         _audio_channels,
 219                         bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24),
 220                         VIDEO_RANGE_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         _video_view->start ();
 350         Started (position());
 351 }
 352
 353 bool
 354 FilmViewer::stop ()
 355 {
 356         if (_audio.isStreamRunning()) {
 357                 /* stop stream and discard any remaining queued samples */
 358                 _audio.abortStream ();
 359         }
 360
 361         if (!_playing) {
 362                 return false;
 363         }
 364
 365         _playing = false;
 366         _video_view->stop ();
 367         Stopped (position());
 368
 369         _video_view->rethrow ();
 370         return true;
 371 }
 372
 373 void
 374 FilmViewer::player_change (ChangeType type, int property, bool frequent)
 375 {
 376         if (type != CHANGE_TYPE_DONE || frequent) {
 377                 return;
 378         }
 379
 380         if (_coalesce_player_changes) {
 381                 _pending_player_changes.push_back (property);
 382                 return;
 383         }
 384
 385         calculate_sizes ();
 386         bool refreshed = false;
 387         if (
 388                 property == VideoContentProperty::CROP ||
 389                 property == VideoContentProperty::SCALE ||
 390                 property == VideoContentProperty::FADE_IN ||
 391                 property == VideoContentProperty::FADE_OUT ||
 392                 property == VideoContentProperty::COLOUR_CONVERSION ||
 393                 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
 394                 property == PlayerProperty::FILM_CONTAINER
 395                 ) {
 396                 refreshed = quick_refresh ();
 397         }
 398
 399         if (!refreshed) {
 400                 slow_refresh ();
 401         }
 402 }
 403
 404 void
 405 FilmViewer::film_change (ChangeType type, Film::Property p)
 406 {
 407         if (type != CHANGE_TYPE_DONE) {
 408                 return;
 409         }
 410
 411         if (p == Film::AUDIO_CHANNELS) {
 412                 recreate_butler ();
 413         } else if (p == Film::VIDEO_FRAME_RATE) {
 414                 _video_view->set_video_frame_rate (_film->video_frame_rate());
 415         } else if (p == Film::THREE_D) {
 416                 _video_view->set_three_d (_film->three_d());
 417         } else if (p == Film::CONTENT) {
 418                 _closed_captions_dialog->update_tracks (_film);
 419         }
 420 }
 421
 422 void
 423 FilmViewer::film_length_change ()
 424 {
 425         _video_view->set_length (_film->length());
 426 }
 427
 428 /** Re-get the current frame slowly by seeking */
 429 void
 430 FilmViewer::slow_refresh ()
 431 {
 432         seek (_video_view->position(), true);
 433 }
 434
 435 /** Try to re-get the current frame quickly by resetting the metadata
 436  *  in the PlayerVideo that we used last time.
 437  *  @return true if this was possible, false if not.
 438  */
 439 bool
 440 FilmViewer::quick_refresh ()
 441 {
 442         if (!_video_view || !_film || !_player) {
 443                 return true;
 444         }
 445         return _video_view->refresh_metadata (_film, _player->video_container_size());
 446 }
 447
 448 void
 449 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
 450 {
 451         optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
 452         if (dt) {
 453                 seek (*dt, accurate);
 454         }
 455 }
 456
 457 void
 458 FilmViewer::set_coalesce_player_changes (bool c)
 459 {
 460         _coalesce_player_changes = c;
 461
 462         if (!c) {
 463                 BOOST_FOREACH (int i, _pending_player_changes) {
 464                         player_change (CHANGE_TYPE_DONE, i, false);
 465                 }
 466                 _pending_player_changes.clear ();
 467         }
 468 }
 469
 470 void
 471 FilmViewer::seek (DCPTime t, bool accurate)
 472 {
 473         if (!_butler) {
 474                 return;
 475         }
 476
 477         if (t < DCPTime ()) {
 478                 t = DCPTime ();
 479         }
 480
 481         if (t >= _film->length ()) {
 482                 t = _film->length() - one_video_frame();
 483         }
 484
 485         suspend ();
 486
 487         _closed_captions_dialog->clear ();
 488         _butler->seek (t, accurate);
 489
 490         if (!_playing) {
 491                 /* We're not playing, so let the GUI thread get on and
 492                    come back later to get the next frame after the seek.
 493                 */
 494                 request_idle_display_next_frame ();
 495         } else {
 496                 /* We're going to start playing again straight away
 497                    so wait for the seek to finish.
 498                 */
 499                 while (!_video_view->display_next_frame(false)) {}
 500         }
 501
 502         resume ();
 503 }
 504
 505 void
 506 FilmViewer::config_changed (Config::Property p)
 507 {
 508         if (p == Config::AUDIO_MAPPING) {
 509                 recreate_butler ();
 510                 return;
 511         }
 512
 513         if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
 514                 return;
 515         }
 516
 517         if (_audio.isStreamOpen ()) {
 518                 _audio.closeStream ();
 519         }
 520
 521         if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
 522                 unsigned int st = 0;
 523                 if (Config::instance()->sound_output()) {
 524                         while (st < _audio.getDeviceCount()) {
 525                                 try {
 526                                         if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
 527                                                 break;
 528                                         }
 529                                 } catch (RtAudioError&) {
 530                                         /* Something went wrong with that device so we don't want to use it anyway */
 531                                 }
 532                                 ++st;
 533                         }
 534                         if (st == _audio.getDeviceCount()) {
 535                                 st = _audio.getDefaultOutputDevice();
 536                         }
 537                 } else {
 538                         st = _audio.getDefaultOutputDevice();
 539                 }
 540
 541                 try {
 542                         _audio_channels = _audio.getDeviceInfo(st).outputChannels;
 543                         RtAudio::StreamParameters sp;
 544                         sp.deviceId = st;
 545                         sp.nChannels = _audio_channels;
 546                         sp.firstChannel = 0;
 547                         _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
 548                 } catch (RtAudioError& e) {
 549                         _audio_channels = 0;
 550                         error_dialog (
 551                                 _video_view->get(),
 552                                 _("Could not set up audio output.  There will be no audio during the preview."), std_to_wx(e.what())
 553                                 );
 554                 }
 555                 recreate_butler ();
 556
 557         } else {
 558                 _audio_channels = 0;
 559                 recreate_butler ();
 560         }
 561 }
 562
 563 DCPTime
 564 FilmViewer::uncorrected_time () const
 565 {
 566         if (_audio.isStreamRunning ()) {
 567                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
 568         }
 569
 570         return _video_view->position();
 571 }
 572
 573 optional<DCPTime>
 574 FilmViewer::audio_time () const
 575 {
 576         if (!_audio.isStreamRunning()) {
 577                 return optional<DCPTime>();
 578         }
 579
 580         return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
 581                 DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
 582 }
 583
 584 DCPTime
 585 FilmViewer::time () const
 586 {
 587         return audio_time().get_value_or(_video_view->position());
 588 }
 589
 590 int
 591 FilmViewer::audio_callback (void* out_p, unsigned int frames)
 592 {
 593         while (true) {
 594                 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
 595                 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
 596                         /* There was an underrun or this audio is on time; carry on */
 597                         break;
 598                 }
 599                 /* The audio we just got was (very) late; drop it and get some more. */
 600         }
 601
 602         boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
 603         if (lm) {
 604                 _latency_history.push_back (_audio.getStreamLatency ());
 605                 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
 606                         _latency_history.pop_front ();
 607                 }
 608         }
 609
 610         return 0;
 611 }
 612
 613 Frame
 614 FilmViewer::average_latency () const
 615 {
 616         boost::mutex::scoped_lock lm (_latency_history_mutex);
 617         if (_latency_history.empty()) {
 618                 return 0;
 619         }
 620
 621         Frame total = 0;
 622         BOOST_FOREACH (Frame i, _latency_history) {
 623                 total += i;
 624         }
 625
 626         return total / _latency_history.size();
 627 }
 628
 629 void
 630 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
 631 {
 632         _dcp_decode_reduction = reduction;
 633         if (_player) {
 634                 _player->set_dcp_decode_reduction (reduction);
 635         }
 636 }
 637
 638 optional<int>
 639 FilmViewer::dcp_decode_reduction () const
 640 {
 641         return _dcp_decode_reduction;
 642 }
 643
 644 DCPTime
 645 FilmViewer::one_video_frame () const
 646 {
 647         return DCPTime::from_frames (1, _film ? _film->video_frame_rate() : 24);
 648 }
 649
 650 /** Open a dialog box showing our film's closed captions */
 651 void
 652 FilmViewer::show_closed_captions ()
 653 {
 654         _closed_captions_dialog->Show();
 655 }
 656
 657 void
 658 FilmViewer::seek_by (DCPTime by, bool accurate)
 659 {
 660         seek (_video_view->position() + by, accurate);
 661 }
 662
 663 void
 664 FilmViewer::set_pad_black (bool p)
 665 {
 666         _pad_black = p;
 667 }
 668
 669 /** Called when a player has finished the current film.
 670  *  May be called from a non-UI thread.
 671  */
 672 void
 673 FilmViewer::finished ()
 674 {
 675         emit (boost::bind(&FilmViewer::ui_finished, this));
 676 }
 677
 678 /** Called by finished() in the UI thread */
 679 void
 680 FilmViewer::ui_finished ()
 681 {
 682         stop ();
 683         Finished ();
 684 }
 685
 686 int
 687 FilmViewer::dropped () const
 688 {
 689         return _video_view->dropped ();
 690 }
 691
 692
 693 int
 694 FilmViewer::errored () const
 695 {
 696         return _video_view->errored ();
 697 }
 698
 699
 700 int
 701 FilmViewer::gets () const
 702 {
 703         return _video_view->gets ();
 704 }
 705
 706
 707 void
 708 FilmViewer::content_change (ChangeType type, int property)
 709 {
 710         if (type != CHANGE_TYPE_DONE) {
 711                 return;
 712         }
 713
 714         if (property == TextContentProperty::USE || property == TextContentProperty::TYPE || property == TextContentProperty::DCP_TRACK) {
 715                 _closed_captions_dialog->update_tracks (_film);
 716         }
 717 }
 718
 719
 720 void
 721 FilmViewer::image_changed (shared_ptr<PlayerVideo> pv)
 722 {
 723         emit (boost::bind(boost::ref(ImageChanged), pv));
 724 }
 725