src/lib/butler.h

   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 "video_ring_buffers.h"
  22 #include "audio_ring_buffers.h"
  23 #include "text_ring_buffers.h"
  24 #include "audio_mapping.h"
  25 #include "exception_store.h"
  26 #include <boost/shared_ptr.hpp>
  27 #include <boost/weak_ptr.hpp>
  28 #include <boost/thread.hpp>
  29 #include <boost/thread/condition.hpp>
  30 #include <boost/signals2.hpp>
  31 #include <boost/asio.hpp>
  32
  33 class Player;
  34 class PlayerVideo;
  35
  36 class Butler : public ExceptionStore, public boost::noncopyable
  37 {
  38 public:
  39         Butler (
  40                 boost::shared_ptr<Player> player,
  41                 AudioMapping map,
  42                 int audio_channels,
  43                 boost::function<AVPixelFormat (AVPixelFormat)> pixel_format,
  44                 bool aligned,
  45                 bool fast
  46                 );
  47
  48         ~Butler ();
  49
  50         void seek (DCPTime position, bool accurate);
  51
  52         class Error {
  53         public:
  54                 enum Code {
  55                         NONE,
  56                         AGAIN,
  57                         DIED
  58                 };
  59
  60                 Error ()
  61                         : code(NONE)
  62                 {}
  63
  64                 Code code;
  65                 std::string message;
  66
  67                 std::string summary () const;
  68         };
  69
  70         std::pair<boost::shared_ptr<PlayerVideo>, DCPTime> get_video (Error* e = 0);
  71         boost::optional<DCPTime> get_audio (float* out, Frame frames);
  72         boost::optional<TextRingBuffers::Data> get_closed_caption ();
  73
  74         void disable_audio ();
  75
  76         std::pair<size_t, std::string> memory_used () const;
  77
  78 private:
  79         void thread ();
  80         void video (boost::shared_ptr<PlayerVideo> video, DCPTime time);
  81         void audio (boost::shared_ptr<AudioBuffers> audio, DCPTime time, int frame_rate);
  82         void text (PlayerText pt, TextType type, boost::optional<DCPTextTrack> track, DCPTimePeriod period);
  83         bool should_run () const;
  84         void prepare (boost::weak_ptr<PlayerVideo> video);
  85         void player_change (ChangeType type, bool frequent);
  86         void seek_unlocked (DCPTime position, bool accurate);
  87
  88         boost::shared_ptr<Player> _player;
  89         boost::thread* _thread;
  90
  91         /** mutex to protect _video, _audio and _closed_caption for when we are clearing them and they all need to be
  92             cleared together without any data being inserted in the interim;
  93             XXX: is this necessary now that all butler output data is timestamped? Perhaps the locked clear-out
  94             is only required if we guarantee that get_video() and get_audio() calls are in sync.
  95         */
  96         boost::mutex _buffers_mutex;
  97         VideoRingBuffers _video;
  98         AudioRingBuffers _audio;
  99         TextRingBuffers _closed_caption;
 100
 101         boost::thread_group _prepare_pool;
 102         boost::asio::io_service _prepare_service;
 103         boost::shared_ptr<boost::asio::io_service::work> _prepare_work;
 104
 105         /** mutex to protect _pending_seek_position, _pending_seek_acurate, _finished, _died, _stop_thread */
 106         boost::mutex _mutex;
 107         boost::condition _summon;
 108         boost::condition _arrived;
 109         boost::optional<DCPTime> _pending_seek_position;
 110         bool _pending_seek_accurate;
 111         int _suspended;
 112         bool _finished;
 113         bool _died;
 114         std::string _died_message;
 115         bool _stop_thread;
 116
 117         AudioMapping _audio_mapping;
 118         int _audio_channels;
 119
 120         bool _disable_audio;
 121
 122         boost::function<AVPixelFormat (AVPixelFormat)> _pixel_format;
 123         bool _aligned;
 124         bool _fast;
 125
 126         /** If we are waiting to be refilled following a seek, this is the time we were
 127             seeking to.
 128         */
 129         boost::optional<DCPTime> _awaiting;
 130
 131         boost::signals2::scoped_connection _player_video_connection;
 132         boost::signals2::scoped_connection _player_audio_connection;
 133         boost::signals2::scoped_connection _player_text_connection;
 134         boost::signals2::scoped_connection _player_change_connection;
 135 };