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