src/wx/film_viewer.cc

   1 /*
   2     Copyright (C) 2012-2018 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 "lib/film.h"
  31 #include "lib/ratio.h"
  32 #include "lib/util.h"
  33 #include "lib/job_manager.h"
  34 #include "lib/image.h"
  35 #include "lib/exceptions.h"
  36 #include "lib/examine_content_job.h"
  37 #include "lib/filter.h"
  38 #include "lib/player.h"
  39 #include "lib/player_video.h"
  40 #include "lib/video_content.h"
  41 #include "lib/video_decoder.h"
  42 #include "lib/timer.h"
  43 #include "lib/butler.h"
  44 #include "lib/log.h"
  45 #include "lib/config.h"
  46 extern "C" {
  47 #include <libavutil/pixfmt.h>
  48 }
  49 #include <dcp/exceptions.h>
  50 #include <wx/tglbtn.h>
  51 #include <iostream>
  52 #include <iomanip>
  53
  54 using std::string;
  55 using std::pair;
  56 using std::min;
  57 using std::max;
  58 using std::cout;
  59 using std::list;
  60 using std::bad_alloc;
  61 using std::make_pair;
  62 using std::exception;
  63 using boost::shared_ptr;
  64 using boost::dynamic_pointer_cast;
  65 using boost::weak_ptr;
  66 using boost::optional;
  67 using dcp::Size;
  68
  69 static
  70 int
  71 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
  72 {
  73         return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
  74 }
  75
  76 FilmViewer::FilmViewer (wxWindow* p, bool outline_content, bool jump_to_selected)
  77         : _panel (new wxPanel (p))
  78         , _outline_content (0)
  79         , _eye (0)
  80         , _jump_to_selected (0)
  81         , _coalesce_player_changes (false)
  82         , _slider_being_moved (false)
  83         , _was_running_before_slider (false)
  84         , _audio (DCPOMATIC_RTAUDIO_API)
  85         , _audio_channels (0)
  86         , _audio_block_size (1024)
  87         , _playing (false)
  88         , _latency_history_count (0)
  89         , _dropped (0)
  90         , _closed_captions_dialog (new ClosedCaptionsDialog(GetParent()))
  91 {
  92 #ifndef __WXOSX__
  93         _panel->SetDoubleBuffered (true);
  94 #endif
  95
  96         _panel->SetBackgroundStyle (wxBG_STYLE_PAINT);
  97
  98         _panel->Bind            (wxEVT_PAINT,               boost::bind (&FilmViewer::paint_panel,     this));
  99         _panel->Bind            (wxEVT_SIZE,                boost::bind (&FilmViewer::panel_sized,     this, _1));
 100         if (_outline_content) {
 101                 _outline_content->Bind  (wxEVT_CHECKBOX,    boost::bind (&FilmViewer::refresh_panel,   this));
 102         }
 103         _timer.Bind             (wxEVT_TIMER,               boost::bind (&FilmViewer::timer,           this));
 104
 105         set_film (shared_ptr<Film> ());
 106
 107         JobManager::instance()->ActiveJobsChanged.connect (
 108                 bind (&FilmViewer::active_jobs_changed, this, _2)
 109                 );
 110
 111         setup_sensitivity ();
 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
 131         _frame.reset ();
 132         _closed_captions_dialog->clear ();
 133
 134         if (!_film) {
 135                 _player.reset ();
 136                 recreate_butler ();
 137                 _frame.reset ();
 138                 refresh_panel ();
 139                 return;
 140         }
 141
 142         try {
 143                 _player.reset (new Player (_film, _film->playlist ()));
 144                 _player->set_fast ();
 145                 if (_dcp_decode_reduction) {
 146                         _player->set_dcp_decode_reduction (_dcp_decode_reduction);
 147                 }
 148         } catch (bad_alloc) {
 149                 error_dialog (this, _("There is not enough free memory to do that."));
 150                 _film.reset ();
 151                 return;
 152         }
 153
 154         _player->set_always_burn_open_subtitles ();
 155         _player->set_play_referenced ();
 156
 157         _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
 158         _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
 159
 160         /* Keep about 1 second's worth of history samples */
 161         _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
 162
 163         recreate_butler ();
 164
 165         calculate_sizes ();
 166         slow_refresh ();
 167
 168         setup_sensitivity ();
 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                 map.set (dcp::LEFT,   0, 1 / sqrt(2)); // L -> Lt
 193                 map.set (dcp::RIGHT,  1, 1 / sqrt(2)); // R -> Rt
 194                 map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
 195                 map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
 196                 map.set (dcp::LFE,    0, 1 / sqrt(10)); // Lfe -> Lt
 197                 map.set (dcp::LFE,    1, 1 / sqrt(10)); // Lfe -> Rt
 198                 map.set (dcp::LS,     0, 1 / sqrt(2)); // Ls -> Lt
 199                 map.set (dcp::RS,     1, 1 / sqrt(2)); // Rs -> Rt
 200         }
 201
 202         _butler.reset (new Butler (_player, _film->log(), map, _audio_channels));
 203         if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
 204                 _butler->disable_audio ();
 205         }
 206
 207         _closed_captions_dialog->set_butler (_butler);
 208
 209         if (was_running) {
 210                 start ();
 211         }
 212 }
 213
 214 void
 215 FilmViewer::refresh_panel ()
 216 {
 217         _panel->Refresh ();
 218         _panel->Update ();
 219 }
 220
 221 void
 222 FilmViewer::get ()
 223 {
 224         DCPOMATIC_ASSERT (_butler);
 225
 226         do {
 227                 Butler::Error e;
 228                 _player_video = _butler->get_video (&e);
 229                 if (!_player_video.first && e == Butler::AGAIN) {
 230                         signal_manager->when_idle (boost::bind(&FilmViewer::get, this));
 231                         return;
 232                 }
 233         } while (
 234                 _player_video.first &&
 235                 _film->three_d() &&
 236                 ((_eye->GetSelection() == 0 && _player_video.first->eyes() == EYES_RIGHT) || (_eye->GetSelection() == 1 && _player_video.first->eyes() == EYES_LEFT))
 237                 );
 238
 239         _butler->rethrow ();
 240
 241         display_player_video ();
 242 }
 243
 244 void
 245 FilmViewer::display_player_video ()
 246 {
 247         if (!_player_video.first) {
 248                 _frame.reset ();
 249                 refresh_panel ();
 250                 return;
 251         }
 252
 253         if (_playing && (time() - _player_video.second) > one_video_frame()) {
 254                 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
 255                    part if this frame is J2K).
 256                 */
 257                 _video_position = _player_video.second;
 258                 ++_dropped;
 259                 return;
 260         }
 261
 262         /* In an ideal world, what we would do here is:
 263          *
 264          * 1. convert to XYZ exactly as we do in the DCP creation path.
 265          * 2. convert back to RGB for the preview display, compensating
 266          *    for the monitor etc. etc.
 267          *
 268          * but this is inefficient if the source is RGB.  Since we don't
 269          * (currently) care too much about the precise accuracy of the preview's
 270          * colour mapping (and we care more about its speed) we try to short-
 271          * circuit this "ideal" situation in some cases.
 272          *
 273          * The content's specified colour conversion indicates the colourspace
 274          * which the content is in (according to the user).
 275          *
 276          * PlayerVideo::image (bound to PlayerVideo::always_rgb) will take the source
 277          * image and convert it (from whatever the user has said it is) to RGB.
 278          */
 279
 280         _frame = _player_video.first->image (
 281                 bind (&Log::dcp_log, _film->log().get(), _1, _2),
 282                 bind (&PlayerVideo::always_rgb, _1),
 283                 false, true
 284                 );
 285
 286         ImageChanged (_player_video.first);
 287
 288         _video_position = _player_video.second;
 289         _inter_position = _player_video.first->inter_position ();
 290         _inter_size = _player_video.first->inter_size ();
 291
 292         refresh_panel ();
 293
 294         _closed_captions_dialog->update (time());
 295 }
 296
 297 void
 298 FilmViewer::timer ()
 299 {
 300         if (!_film || !_playing) {
 301                 return;
 302         }
 303
 304         get ();
 305         update_position_label ();
 306         update_position_slider ();
 307         DCPTime const next = _video_position + one_video_frame();
 308
 309         if (next >= _film->length()) {
 310                 stop ();
 311         }
 312
 313         _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
 314
 315         if (_butler) {
 316                 _butler->rethrow ();
 317         }
 318 }
 319
 320 void
 321 FilmViewer::paint_panel ()
 322 {
 323         wxPaintDC dc (_panel);
 324
 325         if (!_frame || !_film || !_out_size.width || !_out_size.height || _out_size != _frame->size()) {
 326                 dc.Clear ();
 327                 return;
 328         }
 329
 330         wxImage frame (_out_size.width, _out_size.height, _frame->data()[0], true);
 331         wxBitmap frame_bitmap (frame);
 332         dc.DrawBitmap (frame_bitmap, 0, 0);
 333
 334         if (_out_size.width < _panel_size.width) {
 335                 wxPen p (GetBackgroundColour ());
 336                 wxBrush b (GetBackgroundColour ());
 337                 dc.SetPen (p);
 338                 dc.SetBrush (b);
 339                 dc.DrawRectangle (_out_size.width, 0, _panel_size.width - _out_size.width, _panel_size.height);
 340         }
 341
 342         if (_out_size.height < _panel_size.height) {
 343                 wxPen p (GetBackgroundColour ());
 344                 wxBrush b (GetBackgroundColour ());
 345                 dc.SetPen (p);
 346                 dc.SetBrush (b);
 347                 dc.DrawRectangle (0, _out_size.height, _panel_size.width, _panel_size.height - _out_size.height);
 348         }
 349
 350         if (_outline_content && _outline_content->GetValue ()) {
 351                 wxPen p (wxColour (255, 0, 0), 2);
 352                 dc.SetPen (p);
 353                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
 354                 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
 355         }
 356 }
 357
 358 void
 359 FilmViewer::panel_sized (wxSizeEvent& ev)
 360 {
 361         _panel_size.width = ev.GetSize().GetWidth();
 362         _panel_size.height = ev.GetSize().GetHeight();
 363
 364         calculate_sizes ();
 365         if (!quick_refresh()) {
 366                 slow_refresh ();
 367         }
 368         update_position_label ();
 369         update_position_slider ();
 370 }
 371
 372 void
 373 FilmViewer::calculate_sizes ()
 374 {
 375         if (!_film || !_player) {
 376                 return;
 377         }
 378
 379         Ratio const * container = _film->container ();
 380
 381         float const panel_ratio = _panel_size.ratio ();
 382         float const film_ratio = container ? container->ratio () : 1.78;
 383
 384         if (panel_ratio < film_ratio) {
 385                 /* panel is less widscreen than the film; clamp width */
 386                 _out_size.width = _panel_size.width;
 387                 _out_size.height = lrintf (_out_size.width / film_ratio);
 388         } else {
 389                 /* panel is more widescreen than the film; clamp height */
 390                 _out_size.height = _panel_size.height;
 391                 _out_size.width = lrintf (_out_size.height * film_ratio);
 392         }
 393
 394         /* Catch silly values */
 395         _out_size.width = max (64, _out_size.width);
 396         _out_size.height = max (64, _out_size.height);
 397
 398         _player->set_video_container_size (_out_size);
 399 }
 400
 401 void
 402 FilmViewer::start ()
 403 {
 404         if (!_film) {
 405                 return;
 406         }
 407
 408         if (_audio.isStreamOpen()) {
 409                 _audio.setStreamTime (_video_position.seconds());
 410                 _audio.startStream ();
 411         }
 412
 413         _playing = true;
 414         _dropped = 0;
 415         timer ();
 416         _play_button->SetValue (true);
 417 }
 418
 419 bool
 420 FilmViewer::stop ()
 421 {
 422         if (_audio.isStreamRunning()) {
 423                 /* stop stream and discard any remaining queued samples */
 424                 _audio.abortStream ();
 425         }
 426
 427         if (!_playing) {
 428                 return false;
 429         }
 430
 431         _playing = false;
 432         _play_button->SetValue (false);
 433         return true;
 434 }
 435
 436 void
 437 FilmViewer::go_to (DCPTime t)
 438 {
 439         if (t < DCPTime ()) {
 440                 t = DCPTime ();
 441         }
 442
 443         if (t >= _film->length ()) {
 444                 t = _film->length ();
 445         }
 446
 447         seek (t, true);
 448         update_position_label ();
 449         update_position_slider ();
 450 }
 451
 452 void
 453 FilmViewer::player_change (ChangeType type, int property, bool frequent)
 454 {
 455         if (type != CHANGE_TYPE_DONE || frequent) {
 456                 return;
 457         }
 458
 459         if (_coalesce_player_changes) {
 460                 _pending_player_changes.push_back (property);
 461                 return;
 462         }
 463
 464         calculate_sizes ();
 465         bool refreshed = false;
 466         if (
 467                 property == VideoContentProperty::CROP ||
 468                 property == VideoContentProperty::SCALE ||
 469                 property == VideoContentProperty::FADE_IN ||
 470                 property == VideoContentProperty::FADE_OUT ||
 471                 property == VideoContentProperty::COLOUR_CONVERSION ||
 472                 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
 473                 property == PlayerProperty::FILM_CONTAINER
 474                 ) {
 475                 refreshed = quick_refresh ();
 476         }
 477
 478         if (!refreshed) {
 479                 slow_refresh ();
 480         }
 481         update_position_label ();
 482         update_position_slider ();
 483 }
 484
 485 void
 486 FilmViewer::film_change (ChangeType type, Film::Property p)
 487 {
 488         if (type != CHANGE_TYPE_DONE) {
 489                 return;
 490         }
 491
 492         if (p == Film::CONTENT || p == Film::THREE_D) {
 493                 setup_sensitivity ();
 494         } else if (p == Film::AUDIO_CHANNELS) {
 495                 recreate_butler ();
 496         }
 497 }
 498
 499 /** Re-get the current frame slowly by seeking */
 500 void
 501 FilmViewer::slow_refresh ()
 502 {
 503         seek (_video_position, true);
 504 }
 505
 506 /** Try to re-get the current frame quickly by resetting the metadata
 507  *  in the PlayerVideo that we used last time.
 508  *  @return true if this was possible, false if not.
 509  */
 510 bool
 511 FilmViewer::quick_refresh ()
 512 {
 513         if (!_player_video.first) {
 514                 return false;
 515         }
 516
 517         if (!_player_video.first->reset_metadata (_player->video_container_size(), _film->frame_size())) {
 518                 return false;
 519         }
 520
 521         display_player_video ();
 522         return true;
 523 }
 524
 525 void
 526 FilmViewer::set_position (DCPTime p)
 527 {
 528         _video_position = p;
 529         seek (p, true);
 530         update_position_label ();
 531         update_position_slider ();
 532 }
 533
 534 void
 535 FilmViewer::set_position (shared_ptr<Content> content, ContentTime t)
 536 {
 537         optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
 538         if (dt) {
 539                 set_position (*dt);
 540         }
 541 }
 542
 543 void
 544 FilmViewer::set_coalesce_player_changes (bool c)
 545 {
 546         _coalesce_player_changes = c;
 547
 548         if (!c) {
 549                 BOOST_FOREACH (int i, _pending_player_changes) {
 550                         player_change (CHANGE_TYPE_DONE, i, false);
 551                 }
 552                 _pending_player_changes.clear ();
 553         }
 554 }
 555
 556 void
 557 FilmViewer::seek (DCPTime t, bool accurate)
 558 {
 559         if (!_butler) {
 560                 return;
 561         }
 562
 563         bool const was_running = stop ();
 564
 565         _closed_captions_dialog->clear ();
 566         _butler->seek (t, accurate);
 567         get ();
 568
 569         if (was_running) {
 570                 start ();
 571         }
 572 }
 573
 574 void
 575 FilmViewer::config_changed (Config::Property p)
 576 {
 577         if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
 578                 return;
 579         }
 580
 581         if (_audio.isStreamOpen ()) {
 582                 _audio.closeStream ();
 583         }
 584
 585         if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
 586                 unsigned int st = 0;
 587                 if (Config::instance()->sound_output()) {
 588                         while (st < _audio.getDeviceCount()) {
 589                                 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
 590                                         break;
 591                                 }
 592                                 ++st;
 593                         }
 594                         if (st == _audio.getDeviceCount()) {
 595                                 st = _audio.getDefaultOutputDevice();
 596                         }
 597                 } else {
 598                         st = _audio.getDefaultOutputDevice();
 599                 }
 600
 601                 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
 602
 603                 RtAudio::StreamParameters sp;
 604                 sp.deviceId = st;
 605                 sp.nChannels = _audio_channels;
 606                 sp.firstChannel = 0;
 607                 try {
 608                         _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
 609 #ifdef DCPOMATIC_USE_RTERROR
 610                 } catch (RtError& e) {
 611 #else
 612                 } catch (RtAudioError& e) {
 613 #endif
 614                         error_dialog (
 615                                 this,
 616                                 _("Could not set up audio output.  There will be no audio during the preview."), std_to_wx(e.what())
 617                                 );
 618                 }
 619                 recreate_butler ();
 620
 621         } else {
 622                 _audio_channels = 0;
 623                 recreate_butler ();
 624         }
 625 }
 626
 627 DCPTime
 628 FilmViewer::uncorrected_time () const
 629 {
 630         if (_audio.isStreamRunning ()) {
 631                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
 632         }
 633
 634         return _video_position;
 635 }
 636
 637 DCPTime
 638 FilmViewer::time () const
 639 {
 640         if (_audio.isStreamRunning ()) {
 641                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
 642                         DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
 643         }
 644
 645         return _video_position;
 646 }
 647
 648 int
 649 FilmViewer::audio_callback (void* out_p, unsigned int frames)
 650 {
 651         while (true) {
 652                 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
 653                 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
 654                         /* There was an underrun or this audio is on time; carry on */
 655                         break;
 656                 }
 657                 /* The audio we just got was (very) late; drop it and get some more. */
 658         }
 659
 660         boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
 661         if (lm) {
 662                 _latency_history.push_back (_audio.getStreamLatency ());
 663                 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
 664                         _latency_history.pop_front ();
 665                 }
 666         }
 667
 668         return 0;
 669 }
 670
 671 Frame
 672 FilmViewer::average_latency () const
 673 {
 674         boost::mutex::scoped_lock lm (_latency_history_mutex);
 675         if (_latency_history.empty()) {
 676                 return 0;
 677         }
 678
 679         Frame total = 0;
 680         BOOST_FOREACH (Frame i, _latency_history) {
 681                 total += i;
 682         }
 683
 684         return total / _latency_history.size();
 685 }
 686
 687 void
 688 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
 689 {
 690         _dcp_decode_reduction = reduction;
 691         if (_player) {
 692                 _player->set_dcp_decode_reduction (reduction);
 693         }
 694 }
 695
 696 optional<int>
 697 FilmViewer::dcp_decode_reduction () const
 698 {
 699         return _dcp_decode_reduction;
 700 }
 701
 702 DCPTime
 703 FilmViewer::one_video_frame () const
 704 {
 705         return DCPTime::from_frames (1, _film->video_frame_rate());
 706 }
 707
 708 void
 709 FilmViewer::show_closed_captions ()
 710 {
 711         _closed_captions_dialog->Show();
 712 }
 713
 714 void
 715 FilmViewer::back_frame (DCPTime by)
 716 {
 717         if (!_film) {
 718                 return;
 719         }
 720
 721         go_to (_video_position + by);
 722 }