Primitive dropped frame count in display.
[dcpomatic.git] / src / wx / film_viewer.cc
index a5371fcf0adcdffbe48b6523104629f7dd278c45..036646ba5179f78aa62a21c9a39100341c821dc9 100644 (file)
@@ -39,6 +39,7 @@
 #include "lib/video_content.h"
 #include "lib/video_decoder.h"
 #include "lib/timer.h"
+#include "lib/butler.h"
 #include "lib/log.h"
 #include "lib/config.h"
 extern "C" {
@@ -64,7 +65,14 @@ using boost::weak_ptr;
 using boost::optional;
 using dcp::Size;
 
-FilmViewer::FilmViewer (wxWindow* p)
+static
+int
+rtaudio_callback (void* out, void *, unsigned int frames, double, RtAudioStreamStatus, void* data)
+{
+       return reinterpret_cast<FilmViewer*>(data)->audio_callback (out, frames);
+}
+
+FilmViewer::FilmViewer (wxWindow* p, bool outline_content, bool jump_to_selected)
        : wxPanel (p)
        , _panel (new wxPanel (this))
        , _outline_content (new wxCheckBox (this, wxID_ANY, _("Outline content")))
@@ -80,6 +88,12 @@ FilmViewer::FilmViewer (wxWindow* p)
        , _coalesce_player_changes (false)
        , _pending_player_change (false)
        , _last_seek_accurate (true)
+       , _audio (DCPOMATIC_RTAUDIO_API)
+       , _audio_channels (0)
+       , _audio_block_size (1024)
+       , _playing (false)
+       , _latency_history_count (0)
+       , _dropped (0)
 {
 #ifndef __WXOSX__
        _panel->SetDoubleBuffered (true);
@@ -93,10 +107,14 @@ FilmViewer::FilmViewer (wxWindow* p)
        _v_sizer->Add (_panel, 1, wxEXPAND);
 
        wxBoxSizer* view_options = new wxBoxSizer (wxHORIZONTAL);
-       view_options->Add (_outline_content, 0, wxRIGHT, DCPOMATIC_SIZER_GAP);
+       if (outline_content) {
+               view_options->Add (_outline_content, 0, wxRIGHT, DCPOMATIC_SIZER_GAP);
+       }
        view_options->Add (_left_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
        view_options->Add (_right_eye, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
-       view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
+       if (jump_to_selected) {
+               view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT, DCPOMATIC_SIZER_GAP);
+       }
        _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
 
        wxBoxSizer* h_sizer = new wxBoxSizer (wxHORIZONTAL);
@@ -122,9 +140,10 @@ FilmViewer::FilmViewer (wxWindow* p)
        _outline_content->Bind  (wxEVT_CHECKBOX,          boost::bind (&FilmViewer::refresh_panel,   this));
        _left_eye->Bind         (wxEVT_RADIOBUTTON,       boost::bind (&FilmViewer::refresh,         this));
        _right_eye->Bind        (wxEVT_RADIOBUTTON,       boost::bind (&FilmViewer::refresh,         this));
-       _slider->Bind           (wxEVT_SCROLL_THUMBTRACK, boost::bind (&FilmViewer::slider_moved,    this));
-       _slider->Bind           (wxEVT_SCROLL_PAGEUP,     boost::bind (&FilmViewer::slider_moved,    this));
-       _slider->Bind           (wxEVT_SCROLL_PAGEDOWN,   boost::bind (&FilmViewer::slider_moved,    this));
+       _slider->Bind           (wxEVT_SCROLL_THUMBTRACK, boost::bind (&FilmViewer::slider_moved,    this, false));
+       _slider->Bind           (wxEVT_SCROLL_PAGEUP,     boost::bind (&FilmViewer::slider_moved,    this, false));
+       _slider->Bind           (wxEVT_SCROLL_PAGEDOWN,   boost::bind (&FilmViewer::slider_moved,    this, false));
+       _slider->Bind           (wxEVT_SCROLL_CHANGED,    boost::bind (&FilmViewer::slider_moved,    this, true));
        _play_button->Bind      (wxEVT_TOGGLEBUTTON,      boost::bind (&FilmViewer::play_clicked,    this));
        _timer.Bind             (wxEVT_TIMER,             boost::bind (&FilmViewer::timer,           this));
        _back_button->Bind      (wxEVT_LEFT_DOWN,         boost::bind (&FilmViewer::back_clicked,    this, _1));
@@ -142,6 +161,14 @@ FilmViewer::FilmViewer (wxWindow* p)
                );
 
        setup_sensitivity ();
+
+       _config_changed_connection = Config::instance()->Changed.connect (bind (&FilmViewer::config_changed, this, _1));
+       config_changed (Config::PREVIEW_SOUND_OUTPUT);
+}
+
+FilmViewer::~FilmViewer ()
+{
+       stop ();
 }
 
 void
@@ -175,13 +202,15 @@ FilmViewer::set_film (shared_ptr<Film> film)
           in the preview.
        */
        _player->set_always_burn_subtitles (true);
-       _player->set_ignore_audio ();
        _player->set_play_referenced ();
 
        _film->Changed.connect (boost::bind (&FilmViewer::film_changed, this, _1));
-
        _player->Changed.connect (boost::bind (&FilmViewer::player_changed, this, _1));
-       _player->Video.connect (boost::bind (&FilmViewer::video, this, _1, _2));
+
+       /* Keep about 1 second's worth of history samples */
+       _latency_history_count = _film->audio_frame_rate() / _audio_block_size;
+
+       recreate_butler ();
 
        calculate_sizes ();
        refresh ();
@@ -189,6 +218,42 @@ FilmViewer::set_film (shared_ptr<Film> film)
        setup_sensitivity ();
 }
 
+void
+FilmViewer::recreate_butler ()
+{
+       bool const was_running = stop ();
+       _butler.reset ();
+
+       if (!_film) {
+               return;
+       }
+
+       AudioMapping map = AudioMapping (_film->audio_channels(), _audio_channels);
+
+       if (_audio_channels != 2 || _film->audio_channels() < 3) {
+               for (int i = 0; i < min (_film->audio_channels(), _audio_channels); ++i) {
+                       map.set (i, i, 1);
+               }
+       } else {
+               /* Special case: stereo output, at least 3 channel input, map L+R to L/R and
+                  C to both, all 3dB down.
+               */
+               map.set (0, 0, 1 / sqrt(2)); // L -> L
+               map.set (1, 1, 1 / sqrt(2)); // R -> R
+               map.set (2, 0, 1 / sqrt(2)); // C -> L
+               map.set (2, 1, 1 / sqrt(2)); // C -> R
+       }
+
+       _butler.reset (new Butler (_player, _film->log(), map, _audio_channels));
+       if (!Config::instance()->preview_sound()) {
+               _butler->disable_audio ();
+       }
+
+       if (was_running) {
+               start ();
+       }
+}
+
 void
 FilmViewer::refresh_panel ()
 {
@@ -197,16 +262,33 @@ FilmViewer::refresh_panel ()
 }
 
 void
-FilmViewer::video (shared_ptr<PlayerVideo> pv, DCPTime time)
+FilmViewer::get ()
 {
-       if (!_player) {
+       DCPOMATIC_ASSERT (_butler);
+
+       pair<shared_ptr<PlayerVideo>, DCPTime> video;
+       do {
+               video = _butler->get_video ();
+       } while (
+               _film->three_d() &&
+               ((_left_eye->GetValue() && video.first->eyes() == EYES_RIGHT) || (_right_eye->GetValue() && video.first->eyes() == EYES_LEFT))
+               );
+
+       _butler->rethrow ();
+
+       if (!video.first) {
+               _frame.reset ();
+               refresh_panel ();
                return;
        }
 
-       if (_film->three_d ()) {
-               if ((_left_eye->GetValue() && pv->eyes() == EYES_RIGHT) || (_right_eye->GetValue() && pv->eyes() == EYES_LEFT)) {
-                       return;
-               }
+       if ((time() - video.second) > one_video_frame()) {
+               /* Too late; just drop this frame before we try to get its image (which will be the time-consuming
+                  part if this frame is J2K).
+               */
+               _video_position = video.second;
+               ++_dropped;
+               return;
        }
 
        /* In an ideal world, what we would do here is:
@@ -227,42 +309,42 @@ FilmViewer::video (shared_ptr<PlayerVideo> pv, DCPTime time)
         * image and convert it (from whatever the user has said it is) to RGB.
         */
 
-       _frame = pv->image (
+       _frame = video.first->image (
                bind (&Log::dcp_log, _film->log().get(), _1, _2),
                bind (&PlayerVideo::always_rgb, _1),
                false, true
                );
 
-       ImageChanged (pv);
+       ImageChanged (video.first);
 
-       _position = time;
-       _inter_position = pv->inter_position ();
-       _inter_size = pv->inter_size ();
+       _video_position = video.second;
+       _inter_position = video.first->inter_position ();
+       _inter_size = video.first->inter_size ();
 
        refresh_panel ();
 }
 
-void
-FilmViewer::get ()
-{
-       Image const * current = _frame.get ();
-       while (!_player->pass() && _frame.get() == current) {}
-}
-
 void
 FilmViewer::timer ()
 {
-       DCPTime const frame = DCPTime::from_frames (1, _film->video_frame_rate ());
-
-       if ((_position + frame) >= _film->length ()) {
-               _play_button->SetValue (false);
-               check_play_state ();
-       } else {
-               get ();
+       if (!_film || !_playing) {
+               return;
        }
 
+       get ();
        update_position_label ();
        update_position_slider ();
+       DCPTime const next = _video_position + one_video_frame();
+
+       if (next >= _film->length()) {
+               stop ();
+       }
+
+       _timer.Start (max ((next.seconds() - time().seconds()) * 1000, 1.0), wxTIMER_ONE_SHOT);
+
+       if (_butler) {
+               _butler->rethrow ();
+       }
 }
 
 void
@@ -304,19 +386,23 @@ FilmViewer::paint_panel ()
 }
 
 void
-FilmViewer::slider_moved ()
+FilmViewer::slider_moved (bool update_slider)
 {
        if (!_film) {
                return;
        }
 
+
        DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
        /* Ensure that we hit the end of the film at the end of the slider */
        if (t >= _film->length ()) {
-               t = _film->length() - DCPTime::from_frames (1, _film->video_frame_rate ());
+               t = _film->length() - one_video_frame();
        }
        seek (t, false);
        update_position_label ();
+       if (update_slider) {
+               update_position_slider ();
+       }
 }
 
 void
@@ -334,7 +420,7 @@ FilmViewer::panel_sized (wxSizeEvent& ev)
 void
 FilmViewer::calculate_sizes ()
 {
-       if (!_film || !_player) {
+       if (!_film) {
                return;
        }
 
@@ -374,10 +460,40 @@ FilmViewer::check_play_state ()
        }
 
        if (_play_button->GetValue()) {
-               _timer.Start (1000 / _film->video_frame_rate());
+               start ();
        } else {
-               _timer.Stop ();
+               stop ();
+       }
+}
+
+void
+FilmViewer::start ()
+{
+       if (_audio.isStreamOpen()) {
+               _audio.setStreamTime (_video_position.seconds());
+               _audio.startStream ();
+       }
+
+       _playing = true;
+       _dropped = 0;
+       timer ();
+}
+
+bool
+FilmViewer::stop ()
+{
+       if (_audio.isStreamRunning()) {
+               /* stop stream and discard any remainig queued samples */
+               _audio.abortStream ();
        }
+
+       if (!_playing) {
+               return false;
+       }
+
+       _playing = false;
+       _play_button->SetValue (false);
+       return true;
 }
 
 void
@@ -391,7 +507,7 @@ FilmViewer::update_position_slider ()
        DCPTime const len = _film->length ();
 
        if (len.get ()) {
-               int const new_slider_position = 4096 * _position.get() / len.get();
+               int const new_slider_position = 4096 * _video_position.get() / len.get();
                if (new_slider_position != _slider->GetValue()) {
                        _slider->SetValue (new_slider_position);
                }
@@ -409,8 +525,8 @@ FilmViewer::update_position_label ()
 
        double const fps = _film->video_frame_rate ();
        /* Count frame number from 1 ... not sure if this is the best idea */
-       _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_position.seconds() * fps) + 1));
-       _timecode->SetLabel (time_to_timecode (_position, fps));
+       _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_video_position.seconds() * fps) + 1));
+       _timecode->SetLabel (time_to_timecode (_video_position, fps));
 }
 
 void
@@ -425,7 +541,7 @@ FilmViewer::active_jobs_changed (optional<string> j)
 DCPTime
 FilmViewer::nudge_amount (wxMouseEvent& ev)
 {
-       DCPTime amount = DCPTime::from_frames (1, _film->video_frame_rate ());
+       DCPTime amount = one_video_frame ();
 
        if (ev.ShiftDown() && !ev.ControlDown()) {
                amount = DCPTime::from_seconds (1);
@@ -457,14 +573,14 @@ FilmViewer::go_to (DCPTime t)
 void
 FilmViewer::back_clicked (wxMouseEvent& ev)
 {
-       go_to (_position - nudge_amount (ev));
+       go_to (_video_position - nudge_amount (ev));
        ev.Skip ();
 }
 
 void
 FilmViewer::forward_clicked (wxMouseEvent& ev)
 {
-       go_to (_position + nudge_amount (ev));
+       go_to (_video_position + nudge_amount (ev));
        ev.Skip ();
 }
 
@@ -498,6 +614,7 @@ FilmViewer::setup_sensitivity ()
        _outline_content->Enable (c);
        _frame_number->Enable (c);
        _timecode->Enable (c);
+       _jump_to_selected->Enable (c);
 
        _left_eye->Enable (c && _film->three_d ());
        _right_eye->Enable (c && _film->three_d ());
@@ -515,13 +632,13 @@ FilmViewer::film_changed (Film::Property p)
 void
 FilmViewer::refresh ()
 {
-       seek (_position, _last_seek_accurate);
+       seek (_video_position, _last_seek_accurate);
 }
 
 void
 FilmViewer::set_position (DCPTime p)
 {
-       _position = p;
+       _video_position = p;
        seek (p, true);
        update_position_label ();
        update_position_slider ();
@@ -570,11 +687,126 @@ FilmViewer::jump_to_selected_clicked ()
 void
 FilmViewer::seek (DCPTime t, bool accurate)
 {
-       if (!_player) {
+       if (!_butler) {
                return;
        }
 
-       _player->seek (t, accurate);
+       bool const was_running = stop ();
+
+       _butler->seek (t, accurate);
        _last_seek_accurate = accurate;
        get ();
+
+       if (was_running) {
+               start ();
+       }
+}
+
+void
+FilmViewer::config_changed (Config::Property p)
+{
+       if (p != Config::PREVIEW_SOUND && p != Config::PREVIEW_SOUND_OUTPUT) {
+               return;
+       }
+
+       if (_audio.isStreamOpen ()) {
+               _audio.closeStream ();
+       }
+
+       if (Config::instance()->preview_sound()) {
+               unsigned int st = 0;
+               if (Config::instance()->preview_sound_output()) {
+                       while (st < _audio.getDeviceCount()) {
+                               if (_audio.getDeviceInfo(st).name == Config::instance()->preview_sound_output().get()) {
+                                       break;
+                               }
+                               ++st;
+                       }
+                       if (st == _audio.getDeviceCount()) {
+                               st = _audio.getDefaultOutputDevice();
+                       }
+               } else {
+                       st = _audio.getDefaultOutputDevice();
+               }
+
+               _audio_channels = _audio.getDeviceInfo(st).outputChannels;
+
+               recreate_butler ();
+
+               RtAudio::StreamParameters sp;
+               sp.deviceId = st;
+               sp.nChannels = _audio_channels;
+               sp.firstChannel = 0;
+               try {
+                       _audio.openStream (&sp, 0, RTAUDIO_FLOAT32, 48000, &_audio_block_size, &rtaudio_callback, this);
+#ifdef DCPOMATIC_USE_RTERROR
+               } catch (RtError& e) {
+#else
+               } catch (RtAudioError& e) {
+#endif
+                       error_dialog (
+                               this,
+                               wxString::Format (_("Could not set up audio output (%s).  There will be no audio during the preview."), e.what())
+                               );
+               }
+
+       } else {
+               _audio_channels = 0;
+               recreate_butler ();
+       }
+}
+
+DCPTime
+FilmViewer::time () const
+{
+       if (_audio.isStreamRunning ()) {
+               return DCPTime::from_seconds (const_cast<RtAudio*>(&_audio)->getStreamTime ()) -
+                       DCPTime::from_frames (average_latency(), _film->audio_frame_rate());
+       }
+
+       return _video_position;
+}
+
+int
+FilmViewer::audio_callback (void* out_p, unsigned int frames)
+{
+       _butler->get_audio (reinterpret_cast<float*> (out_p), frames);
+
+        boost::mutex::scoped_lock lm (_latency_history_mutex, boost::try_to_lock);
+        if (lm) {
+                _latency_history.push_back (_audio.getStreamLatency ());
+                if (_latency_history.size() > static_cast<size_t> (_latency_history_count)) {
+                        _latency_history.pop_front ();
+                }
+        }
+
+       return 0;
+}
+
+Frame
+FilmViewer::average_latency () const
+{
+        boost::mutex::scoped_lock lm (_latency_history_mutex);
+        if (_latency_history.empty()) {
+                return 0;
+        }
+
+        Frame total = 0;
+        BOOST_FOREACH (Frame i, _latency_history) {
+                total += i;
+        }
+
+        return total / _latency_history.size();
+}
+
+void
+FilmViewer::set_dcp_decode_reduction (optional<int> reduction)
+{
+       _player->set_dcp_decode_reduction (reduction);
+}
+
+DCPTime
+FilmViewer::one_video_frame () const
+{
+       return DCPTime::from_frames (1, _film->video_frame_rate());
 }