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