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