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