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