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