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