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 (wxNullColour);
  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, max(0, (_panel_size.height - _out_size.height) / 2));
 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                 int const gap = (_panel_size.height - _out_size.height) / 2;
 336                 dc.DrawRectangle (0, 0, _panel_size.width, gap);
 337                 dc.DrawRectangle (0, gap + _out_size.height, _panel_size.width, gap);
 338         }
 339
 340         if (_outline_content) {
 341                 wxPen p (wxColour (255, 0, 0), 2);
 342                 dc.SetPen (p);
 343                 dc.SetBrush (*wxTRANSPARENT_BRUSH);
 344                 dc.DrawRectangle (_inter_position.x, _inter_position.y, _inter_size.width, _inter_size.height);
 345         }
 346 }
 347
 348 void
 349 FilmViewer::set_outline_content (bool o)
 350 {
 351         _outline_content = o;
 352         refresh_panel ();
 353 }
 354
 355 void
 356 FilmViewer::set_eyes (Eyes e)
 357 {
 358         _eyes = e;
 359         slow_refresh ();
 360 }
 361
 362 void
 363 FilmViewer::panel_sized (wxSizeEvent& ev)
 364 {
 365         _panel_size.width = ev.GetSize().GetWidth();
 366         _panel_size.height = ev.GetSize().GetHeight();
 367
 368         calculate_sizes ();
 369         if (!quick_refresh()) {
 370                 slow_refresh ();
 371         }
 372         PositionChanged ();
 373 }
 374
 375 void
 376 FilmViewer::calculate_sizes ()
 377 {
 378         if (!_film || !_player) {
 379                 return;
 380         }
 381
 382         Ratio const * container = _film->container ();
 383
 384         float const panel_ratio = _panel_size.ratio ();
 385         float const film_ratio = container ? container->ratio () : 1.78;
 386
 387         if (panel_ratio < film_ratio) {
 388                 /* panel is less widscreen than the film; clamp width */
 389                 _out_size.width = _panel_size.width;
 390                 _out_size.height = lrintf (_out_size.width / film_ratio);
 391         } else {
 392                 /* panel is more widescreen than the film; clamp height */
 393                 _out_size.height = _panel_size.height;
 394                 _out_size.width = lrintf (_out_size.height * film_ratio);
 395         }
 396
 397         /* Catch silly values */
 398         _out_size.width = max (64, _out_size.width);
 399         _out_size.height = max (64, _out_size.height);
 400
 401         _player->set_video_container_size (_out_size);
 402 }
 403
 404 void
 405 FilmViewer::start ()
 406 {
 407         if (!_film) {
 408                 return;
 409         }
 410
 411         optional<bool> v = PlaybackPermitted ();
 412         if (v && !*v) {
 413                 /* Computer says no */
 414                 return;
 415         }
 416
 417         if (_audio.isStreamOpen()) {
 418                 _audio.setStreamTime (_video_position.seconds());
 419                 _audio.startStream ();
 420         }
 421
 422         _playing = true;
 423         _dropped = 0;
 424         timer ();
 425         Started (position());
 426 }
 427
 428 bool
 429 FilmViewer::stop ()
 430 {
 431         if (_audio.isStreamRunning()) {
 432                 /* stop stream and discard any remaining queued samples */
 433                 _audio.abortStream ();
 434         }
 435
 436         if (!_playing) {
 437                 return false;
 438         }
 439
 440         _playing = false;
 441         Stopped (position());
 442         return true;
 443 }
 444
 445 void
 446 FilmViewer::player_change (ChangeType type, int property, bool frequent)
 447 {
 448         if (type != CHANGE_TYPE_DONE || frequent) {
 449                 return;
 450         }
 451
 452         if (_coalesce_player_changes) {
 453                 _pending_player_changes.push_back (property);
 454                 return;
 455         }
 456
 457         calculate_sizes ();
 458         bool refreshed = false;
 459         if (
 460                 property == VideoContentProperty::CROP ||
 461                 property == VideoContentProperty::SCALE ||
 462                 property == VideoContentProperty::FADE_IN ||
 463                 property == VideoContentProperty::FADE_OUT ||
 464                 property == VideoContentProperty::COLOUR_CONVERSION ||
 465                 property == PlayerProperty::VIDEO_CONTAINER_SIZE ||
 466                 property == PlayerProperty::FILM_CONTAINER
 467                 ) {
 468                 refreshed = quick_refresh ();
 469         }
 470
 471         if (!refreshed) {
 472                 slow_refresh ();
 473         }
 474         PositionChanged ();
 475 }
 476
 477 void
 478 FilmViewer::film_change (ChangeType type, Film::Property p)
 479 {
 480         if (type == CHANGE_TYPE_DONE && p == Film::AUDIO_CHANNELS) {
 481                 recreate_butler ();
 482         }
 483 }
 484
 485 /** Re-get the current frame slowly by seeking */
 486 void
 487 FilmViewer::slow_refresh ()
 488 {
 489         seek (_video_position, true);
 490 }
 491
 492 /** Try to re-get the current frame quickly by resetting the metadata
 493  *  in the PlayerVideo that we used last time.
 494  *  @return true if this was possible, false if not.
 495  */
 496 bool
 497 FilmViewer::quick_refresh ()
 498 {
 499         if (!_player_video.first) {
 500                 return false;
 501         }
 502
 503         if (!_player_video.first->reset_metadata (_player->video_container_size(), _film->frame_size())) {
 504                 return false;
 505         }
 506
 507         display_player_video ();
 508         return true;
 509 }
 510
 511 void
 512 FilmViewer::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
 513 {
 514         optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
 515         if (dt) {
 516                 seek (*dt, accurate);
 517         }
 518 }
 519
 520 void
 521 FilmViewer::set_coalesce_player_changes (bool c)
 522 {
 523         _coalesce_player_changes = c;
 524
 525         if (!c) {
 526                 BOOST_FOREACH (int i, _pending_player_changes) {
 527                         player_change (CHANGE_TYPE_DONE, i, false);
 528                 }
 529                 _pending_player_changes.clear ();
 530         }
 531 }
 532
 533 void
 534 FilmViewer::seek (DCPTime t, bool accurate)
 535 {
 536         if (!_butler) {
 537                 return;
 538         }
 539
 540         if (t < DCPTime ()) {
 541                 t = DCPTime ();
 542         }
 543
 544         if (t >= _film->length ()) {
 545                 t = _film->length ();
 546         }
 547
 548         bool const was_running = stop ();
 549
 550         _closed_captions_dialog->clear ();
 551         _butler->seek (t, accurate);
 552         get ();
 553
 554         if (was_running) {
 555                 start ();
 556         }
 557
 558         PositionChanged ();
 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 /** Open a dialog box showing our film's closed captions */
 696 void
 697 FilmViewer::show_closed_captions ()
 698 {
 699         _closed_captions_dialog->Show();
 700 }
 701
 702 void
 703 FilmViewer::seek_by (DCPTime by, bool accurate)
 704 {
 705         seek (_video_position + by, accurate);
 706 }