src/wx/film_viewer.cc

   1 /*
   2     Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file  src/film_viewer.cc
  22  *  @brief A wx widget to view a preview of a Film.
  23  */
  24
  25 #include "film_viewer.h"
  26 #include "playhead_to_timecode_dialog.h"
  27 #include "playhead_to_frame_dialog.h"
  28 #include "wx_util.h"
  29 #include "closed_captions_dialog.h"
  30 #include "gl_video_view.h"
  31 #include "lib/film.h"
  32 #include "lib/ratio.h"
  33 #include "lib/util.h"
  34 #include "lib/job_manager.h"
  35 #include "lib/image.h"
  36 #include "lib/exceptions.h"
  37 #include "lib/examine_content_job.h"
  38 #include "lib/filter.h"
  39 #include "lib/player.h"
  40 #include "lib/player_video.h"
  41 #include "lib/video_content.h"
  42 #include "lib/video_decoder.h"
  43 #include "lib/timer.h"
  44 #include "lib/butler.h"
  45 #include "lib/log.h"
  46 #include "lib/config.h"
  47 #include "lib/compose.hpp"
  48 #include "lib/dcpomatic_log.h"
  49 extern "C" {
  50 #include <libavutil/pixfmt.h>
  51 }
  52 #include <dcp/exceptions.h>
  53 #include <wx/tglbtn.h>
  54 #include <iostream>
  55 #include <iomanip>
  56
  57 using std::string;
  58 using std::pair;
  59 using std::min;
  60 using std::max;
  61 using std::cout;
  62 using std::list;
  63 using std::bad_alloc;
  64 using std::make_pair;
  65 using std::exception;
  66 using boost::shared_ptr;
  67 using boost::dynamic_pointer_cast;
  68 using boost::weak_ptr;
  69 using boost::optional;
  70 using dcp::Size;
  71 using namespace dcpomatic;
  72
  73 static
  74 int
  75 rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
  76 {
  77         return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
  78 }
  79
  80 FilmViewer::FilmViewer (wxWindow* p)
  81         /* XXX: make this configurable */
  82         : _video_view (new GLVideoView(p))
  83         , _coalesce_player_changes (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(p, this))
  91         , _outline_content (false)
  92         , _eyes (EYES_LEFT)
  93         , _pad_black (false)
  94 #ifdef DCPOMATIC_VARIANT_SWAROOP
  95         , _in_watermark (false)
  96         , _background_image (false)
  97 #endif
  98         , _state_timer ("viewer")
  99         , _gets (0)
 100 {
 101         /* XXX: maybe this should be proxied through the VideoView */
 102         _video_view->get()->Bind (wxEVT_SIZE, boost::bind (&FilmViewer::video_view_sized, this));
 103         _timer.Bind  (wxEVT_TIMER, boost::bind (&FilmViewer::timer, this));
 104
 105         set_film (shared_ptr<Film> ());
 106
 107         _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
 108         config_changed (Config::SOUND_OUTPUT);
 109 }
 110
 111 FilmViewer::~FilmViewer ()
 112 {
 113         stop ();
 114 }
 115
 116 void
 117 FilmViewer::set_film (shared_ptr<Film> film)
 118 {
 119         if (_film == film) {
 120                 return;
 121         }
 122
 123         _film = film;
 124         _video_position = DCPTime ();
 125         _player_video.first.reset ();
 126         _player_video.second = DCPTime ();
 127
 128         _frame.reset ();
 129         _closed_captions_dialog->clear ();
 130
 131         if (!_film) {
 132                 _player.reset ();
 133                 recreate_butler ();
 134                 _frame.reset ();
 135                 refresh_panel ();
 136                 return;
 137         }
 138
 139         try {
 140                 _player.reset (new Player (_film, _film->playlist ()));
 141                 _player->set_fast ();
 142                 if (_dcp_decode_reduction) {
 143                         _player->set_dcp_decode_reduction (_dcp_decode_reduction);
 144                 }
 145         } catch (bad_alloc &) {
 146                 error_dialog (_video_view->get(), _("There is not enough free memory to do that."));
 147                 _film.reset ();
 148                 return;
 149         }
 150
 151         _player->set_always_burn_open_subtitles ();
 152         _player->set_play_referenced ();
 153
 154         _film->Change.connect (boost::bind (&FilmViewer::film_change, this, _1, _2));
 155         _player->Change.connect (boost::bind (&FilmViewer::player_change, this, _1, _2, _3));
 156
 157         /* Keep about 1 second's worth of history samples */
 158         _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
 159
 160         recreate_butler ();
 161
 162         calculate_sizes ();
 163         slow_refresh ();
 164 }
 165
 166 void
 167 FilmViewer::recreate_butler ()
 168 {
 169         bool const was_running = stop ();
 170         _butler.reset ();
 171
 172         if (!_film) {
 173                 return;
 174         }
 175
 176         AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
 177
 178         if (_audio_channels != 2 || _film->audio_channels() < 3) {
 179                 for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
 180                         map.set (i, i, 1);
 181                 }
 182         } else {
 183                 /* Special case: stereo output, at least 3 channel input.
 184                    Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
 185                                Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
 186                 */
 187                 map.set (dcp::LEFT,   0, 1 / sqrt(2)); // L -> Lt
 188                 map.set (dcp::RIGHT,  1, 1 / sqrt(2)); // R -> Rt
 189                 map.set (dcp::CENTRE, 0, 1 / 2.0); // C -> Lt
 190                 map.set (dcp::CENTRE, 1, 1 / 2.0); // C -> Rt
 191                 map.set (dcp::LFE,    0, 1 / sqrt(10)); // Lfe -> Lt
 192                 map.set (dcp::LFE,    1, 1 / sqrt(10)); // Lfe -> Rt
 193                 map.set (dcp::LS,     0, 1 / sqrt(2)); // Ls -> Lt
 194                 map.set (dcp::RS,     1, 1 / sqrt(2)); // Rs -> Rt
 195         }
 196
 197         _butler.reset (new Butler(_player, map, _audio_channels, bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true));
 198         if (!Config::instance()->sound() && !_audio.isStreamOpen()) {
 199                 _butler->disable_audio ();
 200         }
 201
 202         _closed_captions_dialog->set_film_and_butler (_film, _butler);
 203
 204         if (was_running) {
 205                 start ();
 206         }
 207 }
 208
 209 void
 210 FilmViewer::refresh_panel ()
 211 {
 212         /* XXX */
 213
 214         /*
 215         _state_timer.set ("refresh-panel");
 216         _panel->Refresh ();
 217         _panel->Update ();
 218         _state_timer.unset ();
 219         */
 220 }
 221
 222 void
 223 FilmViewer::get ()
 224 {
 225         DCPOMATIC_ASSERT (_butler);
 226         ++_gets;
 227
 228         do {
 229                 Butler::Error e;
 230                 _player_video = _butler->get_video (&e);
 231                 if (!_player_video.first && e == Butler::AGAIN) {
 232                         signal_manager->when_idle (boost::bind(&FilmViewer::get, this));
 233                         return;
 234                 }
 235         } while (
 236                 _player_video.first &&
 237                 _film->three_d() &&
 238                 _eyes != _player_video.first->eyes() &&
 239                 _player_video.first->eyes() != EYES_BOTH
 240                 );
 241
 242         _butler->rethrow ();
 243
 244         display_player_video ();
 245 }
 246
 247 void
 248 FilmViewer::display_player_video ()
 249 {
 250         if (!_player_video.first) {
 251                 _frame.reset ();
 252                 refresh_panel ();
 253                 return;
 254         }
 255
 256         if (_playing && (time() - _player_video.second) > one_video_frame()) {
 257                 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
 258                    part if this frame is J2K).
 259                 */
 260                 _video_position = _player_video.second;
 261                 ++_dropped;
 262                 return;
 263         }
 264
 265         /* In an ideal world, what we would do here is:
 266          *
 267          * 1. convert to XYZ exactly as we do in the DCP creation path.
 268          * 2. convert back to RGB for the preview display, compensating
 269          *    for the monitor etc. etc.
 270          *
 271          * but this is inefficient if the source is RGB.  Since we don't
 272          * (currently) care too much about the precise accuracy of the preview's
 273          * colour mapping (and we care more about its speed) we try to short-
 274          * circuit this "ideal" situation in some cases.
 275          *
 276          * The content's specified colour conversion indicates the colourspace
 277          * which the content is in (according to the user).
 278          *
 279          * PlayerVideo::image (bound to PlayerVideo::force) will take the source
 280          * image and convert it (from whatever the user has said it is) to RGB.
 281          */
 282
 283         _state_timer.set ("get image");
 284
 285         /* XXX: do we need to store _frame? */
 286         _frame = _player_video.first->image (bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true);
 287         _video_view->set_image (_frame);
 288
 289         _state_timer.set ("ImageChanged");
 290         ImageChanged (_player_video.first);
 291         _state_timer.unset ();
 292
 293         _video_position = _player_video.second;
 294         _inter_position = _player_video.first->inter_position ();
 295         _inter_size = _player_video.first->inter_size ();
 296
 297         refresh_panel ();
 298
 299         _closed_captions_dialog->update (time());
 300 }
 301
 302 void
 303 FilmViewer::timer ()
 304 {
 305         if (!_film || !_playing) {
 306                 return;
 307         }
 308
 309         get ();
 310         PositionChanged ();
 311         DCPTime const next = _video_position + one_video_frame();
 312
 313         if (next >= _film->length()) {
 314                 stop ();
 315                 Finished ();
 316                 return;
 317         }
 318
 319         LOG_DEBUG_PLAYER("%1 -> %2; delay %3", next.seconds(), time().seconds(), max((next.seconds() - time().seconds()) * 1000, 1.0));
 320         _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
 321
 322         if (_butler) {
 323                 _butler->rethrow ();
 324         }
 325 }
 326
 327 bool
 328 #ifdef DCPOMATIC_VARIANT_SWAROOP
 329 XXX
 330 FilmViewer::maybe_draw_background_image (wxPaintDC& dc)
 331 {
 332         optional<boost::filesystem::path> bg = Config::instance()->player_background_image();
 333         if (bg) {
 334                 wxImage image (std_to_wx(bg->string()));
 335                 wxBitmap bitmap (image);
 336                 dc.DrawBitmap (bitmap, max(0, (_panel_size.width - image.GetSize().GetWidth()) / 2), max(0, (_panel_size.height - image.GetSize().GetHeight()) / 2));
 337                 return true;
 338         }
 339
 340         return false;
 341 }
 342 #else
 343 FilmViewer::maybe_draw_background_image (wxPaintDC &)
 344 {
 345         return false;
 346 }
 347 #endif
 348
 349 void
 350 FilmViewer::set_outline_content (bool o)
 351 {
 352         _outline_content = o;
 353         refresh_panel ();
 354 }
 355
 356 void
 357 FilmViewer::set_eyes (Eyes e)
 358 {
 359         _eyes = e;
 360         slow_refresh ();
 361 }
 362
 363 void
 364 FilmViewer::video_view_sized ()
 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 view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
 383         float const film_ratio = container ? container->ratio () : 1.78;
 384
 385         if (view_ratio < film_ratio) {
 386                 /* panel is less widscreen than the film; clamp width */
 387                 _out_size.width = _video_view->get()->GetSize().x;
 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 = _video_view->get()->GetSize().y;
 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         /* Make OpenGL happy; XXX: only do this in GLVideoView? Is the round-to-4 constraint a thing? */
 400         _out_size.width &= ~3;
 401         _out_size.height &= ~3;
 402
 403         _player->set_video_container_size (_out_size);
 404 }
 405
 406 void
 407 FilmViewer::start ()
 408 {
 409         if (!_film) {
 410                 return;
 411         }
 412
 413         optional<bool> v = PlaybackPermitted ();
 414         if (v && !*v) {
 415                 /* Computer says no */
 416                 return;
 417         }
 418
 419         if (_audio.isStreamOpen()) {
 420                 _audio.setStreamTime (_video_position.seconds());
 421                 _audio.startStream ();
 422         }
 423
 424         _playing = true;
 425         _dropped = 0;
 426         timer ();
 427         Started (position());
 428 }
 429
 430 bool
 431 FilmViewer::stop ()
 432 {
 433         if (_audio.isStreamRunning()) {
 434                 /* stop stream and discard any remaining queued samples */
 435                 _audio.abortStream ();
 436         }
 437
 438         if (!_playing) {
 439                 return false;
 440         }
 441
 442         _playing = false;
 443         Stopped (position());
 444         return true;
 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 (_film, _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::seek (shared_ptr<Content> content, ContentTime t, bool accurate)
 515 {
 516         optional<DCPTime> dt = _player->content_time_to_dcp (content, t);
 517         if (dt) {
 518                 seek (*dt, accurate);
 519         }
 520 }
 521
 522 void
 523 FilmViewer::set_coalesce_player_changes (bool c)
 524 {
 525         _coalesce_player_changes = c;
 526
 527         if (!c) {
 528                 BOOST_FOREACH (int i, _pending_player_changes) {
 529                         player_change (CHANGE_TYPE_DONE, i, false);
 530                 }
 531                 _pending_player_changes.clear ();
 532         }
 533 }
 534
 535 void
 536 FilmViewer::seek (DCPTime t, bool accurate)
 537 {
 538         if (!_butler) {
 539                 return;
 540         }
 541
 542         if (t < DCPTime ()) {
 543                 t = DCPTime ();
 544         }
 545
 546         if (t >= _film->length ()) {
 547                 t = _film->length ();
 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         PositionChanged ();
 561 }
 562
 563 void
 564 FilmViewer::config_changed (Config::Property p)
 565 {
 566 #ifdef DCPOMATIC_VARIANT_SWAROOP
 567         if (p == Config::PLAYER_BACKGROUND_IMAGE) {
 568                 refresh_panel ();
 569                 return;
 570         }
 571 #endif
 572
 573         if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
 574                 return;
 575         }
 576
 577         if (_audio.isStreamOpen ()) {
 578                 _audio.closeStream ();
 579         }
 580
 581         if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
 582                 unsigned int st = 0;
 583                 if (Config::instance()->sound_output()) {
 584                         while (st < _audio.getDeviceCount()) {
 585                                 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
 586                                         break;
 587                                 }
 588                                 ++st;
 589                         }
 590                         if (st == _audio.getDeviceCount()) {
 591                                 st = _audio.getDefaultOutputDevice();
 592                         }
 593                 } else {
 594                         st = _audio.getDefaultOutputDevice();
 595                 }
 596
 597                 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
 598
 599                 RtAudio::StreamParameters sp;
 600                 sp.deviceId = st;
 601                 sp.nChannels = _audio_channels;
 602                 sp.firstChannel = 0;
 603                 try {
 604                         _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
 605 #ifdef DCPOMATIC_USE_RTERROR
 606                 } catch (RtError& e) {
 607 #else
 608                 } catch (RtAudioError& e) {
 609 #endif
 610                         error_dialog (
 611                                 _video_view->get(),
 612                                 _("Could not set up audio output.  There will be no audio during the preview."), std_to_wx(e.what())
 613                                 );
 614                 }
 615                 recreate_butler ();
 616
 617         } else {
 618                 _audio_channels = 0;
 619                 recreate_butler ();
 620         }
 621 }
 622
 623 DCPTime
 624 FilmViewer::uncorrected_time () const
 625 {
 626         if (_audio.isStreamRunning ()) {
 627                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
 628         }
 629
 630         return _video_position;
 631 }
 632
 633 DCPTime
 634 FilmViewer::time () const
 635 {
 636         if (_audio.isStreamRunning ()) {
 637                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
 638                         DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
 639         }
 640
 641         return _video_position;
 642 }
 643
 644 int
 645 FilmViewer::audio_callback (void* out_p, unsigned int frames)
 646 {
 647         while (true) {
 648                 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
 649                 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
 650                         /* There was an underrun or this audio is on time; carry on */
 651                         break;
 652                 }
 653                 /* The audio we just got was (very) late; drop it and get some more. */
 654         }
 655
 656         boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
 657         if (lm) {
 658                 _latency_history.push_back (_audio.getStreamLatency ());
 659                 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
 660                         _latency_history.pop_front ();
 661                 }
 662         }
 663
 664         return 0;
 665 }
 666
 667 Frame
 668 FilmViewer::average_latency () const
 669 {
 670         boost::mutex::scoped_lock lm (_latency_history_mutex);
 671         if (_latency_history.empty()) {
 672                 return 0;
 673         }
 674
 675         Frame total = 0;
 676         BOOST_FOREACH (Frame i, _latency_history) {
 677                 total += i;
 678         }
 679
 680         return total / _latency_history.size();
 681 }
 682
 683 void
 684 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
 685 {
 686         _dcp_decode_reduction = reduction;
 687         if (_player) {
 688                 _player->set_dcp_decode_reduction (reduction);
 689         }
 690 }
 691
 692 optional<int>
 693 FilmViewer::dcp_decode_reduction () const
 694 {
 695         return _dcp_decode_reduction;
 696 }
 697
 698 DCPTime
 699 FilmViewer::one_video_frame () const
 700 {
 701         return DCPTime::from_frames (1, _film->video_frame_rate());
 702 }
 703
 704 /** Open a dialog box showing our film's closed captions */
 705 void
 706 FilmViewer::show_closed_captions ()
 707 {
 708         _closed_captions_dialog->Show();
 709 }
 710
 711 void
 712 FilmViewer::seek_by (DCPTime by, bool accurate)
 713 {
 714         seek (_video_position + by, accurate);
 715 }
 716
 717 void
 718 FilmViewer::set_pad_black (bool p)
 719 {
 720         _pad_black = p;
 721 }