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_view ();
 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_view ()
 211 {
 212         _state_timer.set ("refresh-view");
 213         _video_view->get()->Refresh ();
 214         _video_view->get()->Update ();
 215         _state_timer.unset ();
 216 }
 217
 218 void
 219 FilmViewer::get ()
 220 {
 221         DCPOMATIC_ASSERT (_butler);
 222         ++_gets;
 223
 224         do {
 225                 Butler::Error e;
 226                 _player_video = _butler->get_video (&e);
 227                 if (!_player_video.first && e == Butler::AGAIN) {
 228                         signal_manager->when_idle (boost::bind(&FilmViewer::get, this));
 229                         return;
 230                 }
 231         } while (
 232                 _player_video.first &&
 233                 _film->three_d() &&
 234                 _eyes != _player_video.first->eyes() &&
 235                 _player_video.first->eyes() != EYES_BOTH
 236                 );
 237
 238         _butler->rethrow ();
 239
 240         display_player_video ();
 241 }
 242
 243 void
 244 FilmViewer::display_player_video ()
 245 {
 246         if (!_player_video.first) {
 247                 _frame.reset ();
 248                 refresh_view ();
 249                 return;
 250         }
 251
 252         if (_playing && (time() - _player_video.second) > one_video_frame()) {
 253                 /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
 254                    part if this frame is J2K).
 255                 */
 256                 _video_position = _player_video.second;
 257                 ++_dropped;
 258                 return;
 259         }
 260
 261         /* In an ideal world, what we would do here is:
 262          *
 263          * 1. convert to XYZ exactly as we do in the DCP creation path.
 264          * 2. convert back to RGB for the preview display, compensating
 265          *    for the monitor etc. etc.
 266          *
 267          * but this is inefficient if the source is RGB.  Since we don't
 268          * (currently) care too much about the precise accuracy of the preview's
 269          * colour mapping (and we care more about its speed) we try to short-
 270          * circuit this "ideal" situation in some cases.
 271          *
 272          * The content's specified colour conversion indicates the colourspace
 273          * which the content is in (according to the user).
 274          *
 275          * PlayerVideo::image (bound to PlayerVideo::force) will take the source
 276          * image and convert it (from whatever the user has said it is) to RGB.
 277          */
 278
 279         _state_timer.set ("get image");
 280
 281         /* XXX: do we need to store _frame? */
 282         _frame = _player_video.first->image (bind(&PlayerVideo::force, _1, AV_PIX_FMT_RGB24), false, true);
 283         _video_view->set_image (_frame);
 284
 285         _state_timer.set ("ImageChanged");
 286         ImageChanged (_player_video.first);
 287         _state_timer.unset ();
 288
 289         _video_position = _player_video.second;
 290         _inter_position = _player_video.first->inter_position ();
 291         _inter_size = _player_video.first->inter_size ();
 292
 293         refresh_view ();
 294
 295         _closed_captions_dialog->update (time());
 296 }
 297
 298 void
 299 FilmViewer::timer ()
 300 {
 301         if (!_film || !_playing) {
 302                 return;
 303         }
 304
 305         get ();
 306         PositionChanged ();
 307         DCPTime const next = _video_position + one_video_frame();
 308
 309         if (next >= _film->length()) {
 310                 stop ();
 311                 Finished ();
 312                 return;
 313         }
 314
 315         LOG_DEBUG_PLAYER("%1 -> %2; delay %3", next.seconds(), time().seconds(), max((next.seconds() - time().seconds()) * 1000, 1.0));
 316         _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
 317
 318         if (_butler) {
 319                 _butler->rethrow ();
 320         }
 321 }
 322
 323 bool
 324 #ifdef DCPOMATIC_VARIANT_SWAROOP
 325 XXX
 326 FilmViewer::maybe_draw_background_image (wxPaintDC& dc)
 327 {
 328         optional<boost::filesystem::path> bg = Config::instance()->player_background_image();
 329         if (bg) {
 330                 wxImage image (std_to_wx(bg->string()));
 331                 wxBitmap bitmap (image);
 332                 dc.DrawBitmap (bitmap, max(0, (_panel_size.width - image.GetSize().GetWidth()) / 2), max(0, (_panel_size.height - image.GetSize().GetHeight()) / 2));
 333                 return true;
 334         }
 335
 336         return false;
 337 }
 338 #else
 339 FilmViewer::maybe_draw_background_image (wxPaintDC &)
 340 {
 341         return false;
 342 }
 343 #endif
 344
 345 void
 346 FilmViewer::set_outline_content (bool o)
 347 {
 348         _outline_content = o;
 349         refresh_view ();
 350 }
 351
 352 void
 353 FilmViewer::set_eyes (Eyes e)
 354 {
 355         _eyes = e;
 356         slow_refresh ();
 357 }
 358
 359 void
 360 FilmViewer::video_view_sized ()
 361 {
 362         calculate_sizes ();
 363         if (!quick_refresh()) {
 364                 slow_refresh ();
 365         }
 366         PositionChanged ();
 367 }
 368
 369 void
 370 FilmViewer::calculate_sizes ()
 371 {
 372         if (!_film || !_player) {
 373                 return;
 374         }
 375
 376         Ratio const * container = _film->container ();
 377
 378         float const view_ratio = float(_video_view->get()->GetSize().x) / _video_view->get()->GetSize().y;
 379         float const film_ratio = container ? container->ratio () : 1.78;
 380
 381         if (view_ratio < film_ratio) {
 382                 /* panel is less widscreen than the film; clamp width */
 383                 _out_size.width = _video_view->get()->GetSize().x;
 384                 _out_size.height = lrintf (_out_size.width / film_ratio);
 385         } else {
 386                 /* panel is more widescreen than the film; clamp height */
 387                 _out_size.height = _video_view->get()->GetSize().y;
 388                 _out_size.width = lrintf (_out_size.height * film_ratio);
 389         }
 390
 391         /* Catch silly values */
 392         _out_size.width = max (64, _out_size.width);
 393         _out_size.height = max (64, _out_size.height);
 394
 395         /* Make OpenGL happy; XXX: only do this in GLVideoView? Is the round-to-4 constraint a thing? */
 396         _out_size.width &= ~3;
 397         _out_size.height &= ~3;
 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 (position());
 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 (position());
 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 (_film, _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 #ifdef DCPOMATIC_VARIANT_SWAROOP
 563         if (p == Config::PLAYER_BACKGROUND_IMAGE) {
 564                 refresh_view ();
 565                 return;
 566         }
 567 #endif
 568
 569         if (p != Config::SOUND && p != Config::SOUND_OUTPUT) {
 570                 return;
 571         }
 572
 573         if (_audio.isStreamOpen ()) {
 574                 _audio.closeStream ();
 575         }
 576
 577         if (Config::instance()->sound() && _audio.getDeviceCount() > 0) {
 578                 unsigned int st = 0;
 579                 if (Config::instance()->sound_output()) {
 580                         while (st < _audio.getDeviceCount()) {
 581                                 if (_audio.getDeviceInfo(st).name == Config::instance()->sound_output().get()) {
 582                                         break;
 583                                 }
 584                                 ++st;
 585                         }
 586                         if (st == _audio.getDeviceCount()) {
 587                                 st = _audio.getDefaultOutputDevice();
 588                         }
 589                 } else {
 590                         st = _audio.getDefaultOutputDevice();
 591                 }
 592
 593                 _audio_channels = _audio.getDeviceInfo(st).outputChannels;
 594
 595                 RtAudio::StreamParameters sp;
 596                 sp.deviceId = st;
 597                 sp.nChannels = _audio_channels;
 598                 sp.firstChannel = 0;
 599                 try {
 600                         _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
 601 #ifdef DCPOMATIC_USE_RTERROR
 602                 } catch (RtError& e) {
 603 #else
 604                 } catch (RtAudioError& e) {
 605 #endif
 606                         error_dialog (
 607                                 _video_view->get(),
 608                                 _("Could not set up audio output.  There will be no audio during the preview."), std_to_wx(e.what())
 609                                 );
 610                 }
 611                 recreate_butler ();
 612
 613         } else {
 614                 _audio_channels = 0;
 615                 recreate_butler ();
 616         }
 617 }
 618
 619 DCPTime
 620 FilmViewer::uncorrected_time () const
 621 {
 622         if (_audio.isStreamRunning ()) {
 623                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime());
 624         }
 625
 626         return _video_position;
 627 }
 628
 629 DCPTime
 630 FilmViewer::time () const
 631 {
 632         if (_audio.isStreamRunning ()) {
 633                 return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
 634                         DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
 635         }
 636
 637         return _video_position;
 638 }
 639
 640 int
 641 FilmViewer::audio_callback (void* out_p, unsigned int frames)
 642 {
 643         while (true) {
 644                 optional<DCPTime> t = _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
 645                 if (!t || DCPTime(uncorrected_time() - *t) < one_video_frame()) {
 646                         /* There was an underrun or this audio is on time; carry on */
 647                         break;
 648                 }
 649                 /* The audio we just got was (very) late; drop it and get some more. */
 650         }
 651
 652         boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
 653         if (lm) {
 654                 _latency_history.push_back (_audio.getStreamLatency ());
 655                 if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
 656                         _latency_history.pop_front ();
 657                 }
 658         }
 659
 660         return 0;
 661 }
 662
 663 Frame
 664 FilmViewer::average_latency () const
 665 {
 666         boost::mutex::scoped_lock lm (_latency_history_mutex);
 667         if (_latency_history.empty()) {
 668                 return 0;
 669         }
 670
 671         Frame total = 0;
 672         BOOST_FOREACH (Frame i, _latency_history) {
 673                 total += i;
 674         }
 675
 676         return total / _latency_history.size();
 677 }
 678
 679 void
 680 FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
 681 {
 682         _dcp_decode_reduction = reduction;
 683         if (_player) {
 684                 _player->set_dcp_decode_reduction (reduction);
 685         }
 686 }
 687
 688 optional<int>
 689 FilmViewer::dcp_decode_reduction () const
 690 {
 691         return _dcp_decode_reduction;
 692 }
 693
 694 DCPTime
 695 FilmViewer::one_video_frame () const
 696 {
 697         return DCPTime::from_frames (1, _film->video_frame_rate());
 698 }
 699
 700 /** Open a dialog box showing our film's closed captions */
 701 void
 702 FilmViewer::show_closed_captions ()
 703 {
 704         _closed_captions_dialog->Show();
 705 }
 706
 707 void
 708 FilmViewer::seek_by (DCPTime by, bool accurate)
 709 {
 710         seek (_video_position + by, accurate);
 711 }
 712
 713 void
 714 FilmViewer::set_pad_black (bool p)
 715 {
 716         _pad_black = p;
 717 }