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 void
  67 Butler::thread ()
  68 try
  69 {
  70         while (true) {
  71                 boost::mutex::scoped_lock lm (_mutex);
  72
  73                 /* Wait until we have something to do */
  74                 while ((_video.size() >= VIDEO_READAHEAD && _audio.size() >= AUDIO_READAHEAD && !_pending_seek_position) || _stop_thread) {
  75                         _summon.wait (lm);
  76                 }
  77
  78                 /* Do any seek that has been requested */
  79                 if (_pending_seek_position) {
  80                         _player->seek (*_pending_seek_position, _pending_seek_accurate);
  81                         _pending_seek_position = optional<DCPTime> ();
  82                 }
  83
  84                 /* Fill _video and _audio.  Don't try to carry on if a pending seek appears
  85                    while lm is unlocked, as in that state nothing will be added to
  86                    _video/_audio.
  87                 */
  88                 while ((_video.size() < VIDEO_READAHEAD || _audio.size() < AUDIO_READAHEAD) && !_pending_seek_position && !_stop_thread) {
  89                         lm.unlock ();
  90                         if (_player->pass ()) {
  91                                 _finished = true;
  92                                 _arrived.notify_all ();
  93                                 break;
  94                         }
  95                         lm.lock ();
  96                         _arrived.notify_all ();
  97                 }
  98         }
  99 } catch (boost::thread_interrupted) {
 100         /* The butler thread is being terminated */
 101 } catch (...) {
 102         store_current ();
 103 }
 104
 105 pair<shared_ptr<PlayerVideo>, DCPTime>
 106 Butler::get_video ()
 107 {
 108         boost::mutex::scoped_lock lm (_mutex);
 109
 110         /* Wait for data if we have none */
 111         while (_video.empty() && !_finished) {
 112                 _arrived.wait (lm);
 113         }
 114
 115         if (_video.empty() && _finished) {
 116                 return make_pair (shared_ptr<PlayerVideo>(), DCPTime());
 117         }
 118
 119         pair<shared_ptr<PlayerVideo>, DCPTime> const r = _video.get ();
 120         _summon.notify_all ();
 121         return r;
 122 }
 123
 124 void
 125 Butler::seek (DCPTime position, bool accurate)
 126 {
 127         boost::mutex::scoped_lock lm (_mutex);
 128         _video.clear ();
 129         _finished = false;
 130         _pending_seek_position = position;
 131         _pending_seek_accurate = accurate;
 132         _summon.notify_all ();
 133 }
 134
 135 void
 136 Butler::video (shared_ptr<PlayerVideo> video, DCPTime time)
 137 {
 138         {
 139                 boost::mutex::scoped_lock lm (_mutex);
 140                 if (_pending_seek_position) {
 141                         /* Don't store any video while a seek is pending */
 142                         return;
 143                 }
 144         }
 145
 146         _video.put (video, time);
 147 }
 148
 149 void
 150 Butler::audio (shared_ptr<AudioBuffers> audio, DCPTime time)
 151 {
 152         {
 153                 boost::mutex::scoped_lock lm (_mutex);
 154                 if (_pending_seek_position) {
 155                         /* Don't store any audio while a seek is pending */
 156                         return;
 157                 }
 158         }
 159
 160         _audio.put (audio, time);
 161 }
 162
 163 void
 164 Butler::player_changed ()
 165 {
 166         optional<DCPTime> t;
 167
 168         {
 169                 boost::mutex::scoped_lock lm (_mutex);
 170                 t = _video.earliest ();
 171         }
 172
 173         if (t) {
 174                 seek (*t, true);
 175         } else {
 176                 _video.clear ();
 177                 _audio.clear ();
 178         }
 179 }
 180
 181 void
 182 Butler::get_audio (float* out, Frame frames)
 183 {
 184         _audio.get (out, _audio_channels, frames);
 185         _summon.notify_all ();
 186 }