src/lib/butler.cc

   1 /*
   2     Copyright (C) 2016-2017 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 #include "butler.h"
  22 #include "player.h"
  23 #include <boost/weak_ptr.hpp>
  24 #include <boost/shared_ptr.hpp>
  25
  26 using std::cout;
  27 using std::pair;
  28 using std::make_pair;
  29 using boost::weak_ptr;
  30 using boost::shared_ptr;
  31 using boost::bind;
  32 using boost::optional;
  33
  34 /** Video readahead in frames */
  35 #define VIDEO_READAHEAD 10
  36 /** Audio readahead in frames */
  37 #define AUDIO_READAHEAD (48000*5)
  38
  39 Butler::Butler (weak_ptr<const Film> film, shared_ptr<Player> player, AudioMapping audio_mapping, int audio_channels)
  40         : _film (film)
  41         , _player (player)
  42         , _pending_seek_accurate (false)
  43         , _finished (false)
  44         , _audio_mapping (audio_mapping)
  45         , _audio_channels (audio_channels)
  46         , _stop_thread (false)
  47 {
  48         _player_video_connection = _player->Video.connect (bind (&Butler::video, this, _1, _2));
  49         _player_audio_connection = _player->Audio.connect (bind (&Butler::audio, this, _1, _2));
  50         _player_changed_connection = _player->Changed.connect (bind (&Butler::player_changed, this));
  51         _thread = new boost::thread (bind (&Butler::thread, this));
  52 }
  53
  54 Butler::~Butler ()
  55 {
  56         _stop_thread = true;
  57         _thread->interrupt ();
  58         try {
  59                 _thread->join ();
  60         } catch (boost::thread_interrupted& e) {
  61                 /* No problem */
  62         }
  63         delete _thread;
  64 }
  65
  66 bool
  67 Butler::should_run () const
  68 {
  69         return (_video.size() < VIDEO_READAHEAD || _audio.size() < AUDIO_READAHEAD) && !_stop_thread && !_finished;
  70 }
  71
  72
  73 void
  74 Butler::thread ()
  75 try
  76 {
  77         while (true) {
  78                 boost::mutex::scoped_lock lm (_mutex);
  79
  80                 /* Wait until we have something to do */
  81                 while (!should_run() && !_pending_seek_position) {
  82                         _summon.wait (lm);
  83                 }
  84
  85                 /* Do any seek that has been requested */
  86                 if (_pending_seek_position) {
  87                         _player->seek (*_pending_seek_position, _pending_seek_accurate);
  88                         _pending_seek_position = optional<DCPTime> ();
  89                 }
  90
  91                 /* Fill _video and _audio.  Don't try to carry on if a pending seek appears
  92                    while lm is unlocked, as in that state nothing will be added to
  93                    _video/_audio.
  94                 */
  95                 while (should_run() && !_pending_seek_position) {
  96                         lm.unlock ();
  97                         if (_player->pass ()) {
  98                                 _finished = true;
  99                                 _arrived.notify_all ();
 100                                 break;
 101                         }
 102                         lm.lock ();
 103                         _arrived.notify_all ();
 104                 }
 105         }
 106 } catch (boost::thread_interrupted) {
 107         /* The butler thread is being terminated */
 108 } catch (...) {
 109         store_current ();
 110 }
 111
 112 pair<shared_ptr<PlayerVideo>, DCPTime>
 113 Butler::get_video ()
 114 {
 115         boost::mutex::scoped_lock lm (_mutex);
 116
 117         /* Wait for data if we have none */
 118         while (_video.empty() && !_finished) {
 119                 _arrived.wait (lm);
 120         }
 121
 122         if (_video.empty() && _finished) {
 123                 return make_pair (shared_ptr<PlayerVideo>(), DCPTime());
 124         }
 125
 126         pair<shared_ptr<PlayerVideo>, DCPTime> const r = _video.get ();
 127         _summon.notify_all ();
 128         return r;
 129 }
 130
 131 void
 132 Butler::seek (DCPTime position, bool accurate)
 133 {
 134         boost::mutex::scoped_lock lm (_mutex);
 135         _video.clear ();
 136         _audio.clear ();
 137         _finished = false;
 138         _pending_seek_position = position;
 139         _pending_seek_accurate = accurate;
 140         _summon.notify_all ();
 141 }
 142
 143 void
 144 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
 145 {
 146         {
 147                 boost::mutex::scoped_lock lm (_mutex);
 148                 if (_pending_seek_position) {
 149                         /* Don't store any video while a seek is pending */
 150                         return;
 151                 }
 152         }
 153
 154         _video.put (video, time);
 155 }
 156
 157 void
 158 Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time)
 159 {
 160         {
 161                 boost::mutex::scoped_lock lm (_mutex);
 162                 if (_pending_seek_position) {
 163                         /* Don't store any audio while a seek is pending */
 164                         return;
 165                 }
 166         }
 167
 168         _audio.put (audio, time);
 169 }
 170
 171 void
 172 Butler::player_changed ()
 173 {
 174         optional<DCPTime> t;
 175
 176         {
 177                 boost::mutex::scoped_lock lm (_mutex);
 178                 t = _video.earliest ();
 179         }
 180
 181         if (t) {
 182                 seek (*t, true);
 183         } else {
 184                 _video.clear ();
 185                 _audio.clear ();
 186         }
 187 }
 188
 189 void
 190 Butler::get_audio (float* out, Frame frames)
 191 {
 192         _audio.get (out, _audio_channels, frames);
 193         _summon.notify_all ();
 194 }