src/lib/butler.h

   1 /*
   2     Copyright (C) 2016-2021 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
  22 #include "audio_mapping.h"
  23 #include "audio_ring_buffers.h"
  24 #include "change_signaller.h"
  25 #include "exception_store.h"
  26 #include "text_ring_buffers.h"
  27 #include "video_ring_buffers.h"
  28 #include <boost/asio.hpp>
  29 #include <boost/signals2.hpp>
  30 #include <boost/thread.hpp>
  31 #include <boost/thread/condition.hpp>
  32
  33
  34 class Player;
  35 class PlayerVideo;
  36
  37
  38 class Butler : public ExceptionStore
  39 {
  40 public:
  41         enum class Audio
  42         {
  43                 ENABLED,
  44                 DISABLED
  45         };
  46
  47         Butler (
  48                 std::weak_ptr<const Film> film,
  49                 std::shared_ptr<Player> player,
  50                 AudioMapping map,
  51                 int audio_channels,
  52                 std::function<AVPixelFormat (AVPixelFormat)> pixel_format,
  53                 dcp::Size display_container,
  54                 dcp::Size film_container,
  55                 VideoRange video_range,
  56                 Image::Alignment alignment,
  57                 bool fast,
  58                 bool prepare_only_proxy,
  59                 Audio audio
  60                 );
  61
  62         ~Butler ();
  63
  64         Butler (Butler const&) = delete;
  65         Butler& operator= (Butler const&) = delete;
  66
  67         void seek (dcpomatic::DCPTime position, bool accurate);
  68
  69         class Error {
  70         public:
  71                 enum class Code {
  72                         NONE,
  73                         AGAIN,
  74                         DIED,
  75                         FINISHED
  76                 };
  77
  78                 Code code = Code::NONE;
  79                 std::string message;
  80
  81                 std::string summary () const;
  82         };
  83
  84         enum class Behaviour {
  85                 BLOCKING,
  86                 NON_BLOCKING
  87         };
  88
  89         std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime> get_video (Behaviour behaviour, Error* e = nullptr);
  90         boost::optional<dcpomatic::DCPTime> get_audio (Behaviour behaviour, float* out, Frame frames);
  91         boost::optional<TextRingBuffers::Data> get_closed_caption ();
  92
  93         std::pair<size_t, std::string> memory_used () const;
  94
  95 private:
  96         void thread ();
  97         void video (std::shared_ptr<PlayerVideo> video, dcpomatic::DCPTime time);
  98         void audio (std::shared_ptr<AudioBuffers> audio, dcpomatic::DCPTime time, int frame_rate);
  99         void text (PlayerText pt, TextType type, boost::optional<DCPTextTrack> track, dcpomatic::DCPTimePeriod period);
 100         bool should_run () const;
 101         void prepare (std::weak_ptr<PlayerVideo> video);
 102         void player_change (ChangeType type, int property);
 103         void seek_unlocked (dcpomatic::DCPTime position, bool accurate);
 104
 105         std::weak_ptr<const Film> _film;
 106         std::shared_ptr<Player> _player;
 107         boost::thread _thread;
 108
 109         VideoRingBuffers _video;
 110         AudioRingBuffers _audio;
 111         TextRingBuffers _closed_caption;
 112
 113         boost::thread_group _prepare_pool;
 114         boost::asio::io_service _prepare_service;
 115         std::shared_ptr<boost::asio::io_service::work> _prepare_work;
 116
 117         /** mutex to protect _pending_seek_position, _pending_seek_accurate, _finished, _died, _stop_thread */
 118         boost::mutex _mutex;
 119         boost::condition _summon;
 120         boost::condition _arrived;
 121         boost::optional<dcpomatic::DCPTime> _pending_seek_position;
 122         bool _pending_seek_accurate;
 123         int _suspended;
 124         bool _finished;
 125         bool _died;
 126         std::string _died_message;
 127         bool _stop_thread;
 128
 129         AudioMapping _audio_mapping;
 130         int _audio_channels;
 131
 132         bool _disable_audio;
 133
 134         std::function<AVPixelFormat (AVPixelFormat)> _pixel_format;
 135         dcp::Size _display_container;
 136         dcp::Size _film_container;
 137         VideoRange _video_range;
 138         Image::Alignment _alignment;
 139         bool _fast;
 140
 141         /** true to ask PlayerVideo::prepare to only prepare the ImageProxy and not also
 142          *  the final image.  We want to do this when the viewer is intending to call
 143          *  PlayerVideo::raw_image() and do the things in PlayerVideo::make_image() itself:
 144          *  this is the case for the GLVideoView which can do scale, pixfmt conversion etc.
 145          *  in the shader.
 146          */
 147         bool _prepare_only_proxy = false;
 148
 149         /** If we are waiting to be refilled following a seek, this is the time we were
 150             seeking to.
 151         */
 152         boost::optional<dcpomatic::DCPTime> _awaiting;
 153
 154         boost::signals2::scoped_connection _player_video_connection;
 155         boost::signals2::scoped_connection _player_audio_connection;
 156         boost::signals2::scoped_connection _player_text_connection;
 157         boost::signals2::scoped_connection _player_change_connection;
 158 };