src/lib/player.h

   1 /*
   2     Copyright (C) 2013-2020 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 #ifndef DCPOMATIC_PLAYER_H
  23 #define DCPOMATIC_PLAYER_H
  24
  25
  26 #include "active_text.h"
  27 #include "atmos_metadata.h"
  28 #include "audio_merger.h"
  29 #include "audio_stream.h"
  30 #include "content_atmos.h"
  31 #include "content_audio.h"
  32 #include "content_text.h"
  33 #include "content_video.h"
  34 #include "empty.h"
  35 #include "film.h"
  36 #include "image.h"
  37 #include "player_text.h"
  38 #include "position_image.h"
  39 #include "shuffler.h"
  40 #include <boost/atomic.hpp>
  41 #include <list>
  42
  43
  44 namespace dcp {
  45         class ReelAsset;
  46 }
  47
  48 namespace dcpomatic {
  49         class FontData;
  50 }
  51
  52 class AtmosContent;
  53 class AudioBuffers;
  54 class Content;
  55 class PlayerVideo;
  56 class Playlist;
  57 class ReferencedReelAsset;
  58
  59
  60 class PlayerProperty
  61 {
  62 public:
  63         static int const VIDEO_CONTAINER_SIZE;
  64         static int const PLAYLIST;
  65         static int const FILM_CONTAINER;
  66         static int const FILM_VIDEO_FRAME_RATE;
  67         static int const DCP_DECODE_REDUCTION;
  68         static int const PLAYBACK_LENGTH;
  69 };
  70
  71
  72 /** @class Player
  73  *  @brief A class which can play a Playlist.
  74  */
  75 class Player : public std::enable_shared_from_this<Player>
  76 {
  77 public:
  78         Player (std::shared_ptr<const Film>, Image::Alignment subtitle_alignment);
  79         Player (std::shared_ptr<const Film>, std::shared_ptr<const Playlist> playlist);
  80
  81         Player (Player const& Player) = delete;
  82         Player& operator= (Player const& Player) = delete;
  83
  84         bool pass ();
  85         void seek (dcpomatic::DCPTime time, bool accurate);
  86
  87         std::vector<dcpomatic::FontData> get_subtitle_fonts ();
  88         std::list<ReferencedReelAsset> get_reel_assets ();
  89         dcp::Size video_container_size () const {
  90                 boost::mutex::scoped_lock lm (_mutex);
  91                 return _video_container_size;
  92         }
  93
  94         void set_video_container_size (dcp::Size);
  95         void set_ignore_video ();
  96         void set_ignore_audio ();
  97         void set_ignore_text ();
  98         void set_always_burn_open_subtitles ();
  99         void set_fast ();
 100         void set_play_referenced ();
 101         void set_dcp_decode_reduction (boost::optional<int> reduction);
 102
 103         boost::optional<dcpomatic::DCPTime> content_time_to_dcp (std::shared_ptr<const Content> content, dcpomatic::ContentTime t);
 104         boost::optional<dcpomatic::ContentTime> dcp_to_content_time (std::shared_ptr<const Content> content, dcpomatic::DCPTime t);
 105
 106         boost::signals2::signal<void (ChangeType, int, bool)> Change;
 107
 108         /** Emitted when a video frame is ready.  These emissions happen in the correct order. */
 109         boost::signals2::signal<void (std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime)> Video;
 110         /** Emitted when audio data is ready.  First parameter is the audio data, second its time,
 111          *  third the frame rate.
 112          */
 113         boost::signals2::signal<void (std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime, int)> Audio;
 114         /** Emitted when a text is ready.  This signal may be emitted considerably
 115          *  after the corresponding Video.
 116          */
 117         boost::signals2::signal<void (PlayerText, TextType, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod)> Text;
 118         boost::signals2::signal<void (std::shared_ptr<const dcp::AtmosFrame>, dcpomatic::DCPTime, AtmosMetadata)> Atmos;
 119
 120 private:
 121         friend class PlayerWrapper;
 122         friend class Piece;
 123         friend struct player_time_calculation_test1;
 124         friend struct player_time_calculation_test2;
 125         friend struct player_time_calculation_test3;
 126         friend struct player_subframe_test;
 127         friend struct empty_test1;
 128         friend struct empty_test2;
 129         friend struct check_reuse_old_data_test;
 130         friend struct overlap_video_test1;
 131
 132         void construct ();
 133         void setup_pieces ();
 134         void setup_pieces_unlocked ();
 135         void film_change (ChangeType, Film::Property);
 136         void playlist_change (ChangeType);
 137         void playlist_content_change (ChangeType, int, bool);
 138         Frame dcp_to_content_video (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
 139         dcpomatic::DCPTime content_video_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
 140         Frame dcp_to_resampled_audio (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
 141         dcpomatic::DCPTime resampled_audio_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
 142         dcpomatic::ContentTime dcp_to_content_time (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
 143         dcpomatic::DCPTime content_time_to_dcp (std::shared_ptr<const Piece> piece, dcpomatic::ContentTime t) const;
 144         std::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
 145
 146         void video (std::weak_ptr<Piece>, ContentVideo);
 147         void audio (std::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
 148         void bitmap_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentBitmapText);
 149         void plain_text_start (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, ContentStringText);
 150         void subtitle_stop (std::weak_ptr<Piece>, std::weak_ptr<const TextContent>, dcpomatic::ContentTime);
 151         void atmos (std::weak_ptr<Piece>, ContentAtmos);
 152
 153         dcpomatic::DCPTime one_video_frame () const;
 154         void fill_audio (dcpomatic::DCPTimePeriod period);
 155         std::pair<std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime> discard_audio (
 156                 std::shared_ptr<const AudioBuffers> audio, dcpomatic::DCPTime time, dcpomatic::DCPTime discard_to
 157                 ) const;
 158         boost::optional<PositionImage> open_subtitles_for_frame (dcpomatic::DCPTime time) const;
 159         void emit_video (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
 160         void do_emit_video (std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time);
 161         void emit_audio (std::shared_ptr<AudioBuffers> data, dcpomatic::DCPTime time);
 162         std::shared_ptr<const Playlist> playlist () const;
 163
 164         /** Mutex to protect the whole Player state.  When it's used for the preview we have
 165             seek() and pass() called from the Butler thread and lots of other stuff called
 166             from the GUI thread.
 167         */
 168         mutable boost::mutex _mutex;
 169
 170         std::shared_ptr<const Film> _film;
 171         /** Playlist, or 0 if we are using the one from the _film */
 172         std::shared_ptr<const Playlist> _playlist;
 173
 174         /** > 0 if we are suspended (i.e. pass() and seek() do nothing) */
 175         boost::atomic<int> _suspended;
 176         std::list<std::shared_ptr<Piece>> _pieces;
 177
 178         /** Size of the image we are rendering to; this may be the DCP frame size, or
 179          *  the size of preview in a window.
 180          */
 181         dcp::Size _video_container_size;
 182         std::shared_ptr<Image> _black_image;
 183
 184         /** true if the player should ignore all video; i.e. never produce any */
 185         bool _ignore_video = false;
 186         bool _ignore_audio = false;
 187         /** true if the player should ignore all text; i.e. never produce any */
 188         bool _ignore_text = false;
 189         bool _always_burn_open_subtitles = false;
 190         /** true if we should try to be fast rather than high quality */
 191         bool _fast = false;
 192         /** true if we should keep going in the face of `survivable' errors */
 193         bool _tolerant = false;
 194         /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
 195         bool _play_referenced = false;
 196
 197         /** Time of the next video that we will emit, or the time of the last accurate seek */
 198         boost::optional<dcpomatic::DCPTime> _next_video_time;
 199         /** Eyes of the next video that we will emit */
 200         boost::optional<Eyes> _next_video_eyes;
 201         /** Time of the next audio that we will emit, or the time of the last accurate seek */
 202         boost::optional<dcpomatic::DCPTime> _next_audio_time;
 203
 204         boost::optional<int> _dcp_decode_reduction;
 205
 206         typedef std::map<std::weak_ptr<Piece>, std::shared_ptr<PlayerVideo>, std::owner_less<std::weak_ptr<Piece>>> LastVideoMap;
 207         LastVideoMap _last_video;
 208
 209         AudioMerger _audio_merger;
 210         std::unique_ptr<Shuffler> _shuffler;
 211         std::list<std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime>> _delay;
 212
 213         class StreamState
 214         {
 215         public:
 216                 StreamState () {}
 217
 218                 StreamState (std::shared_ptr<Piece> p, dcpomatic::DCPTime l)
 219                         : piece(p)
 220                         , last_push_end(l)
 221                 {}
 222
 223                 std::shared_ptr<Piece> piece;
 224                 dcpomatic::DCPTime last_push_end;
 225         };
 226         std::map<AudioStreamPtr, StreamState> _stream_states;
 227
 228         Empty _black;
 229         Empty _silent;
 230
 231         ActiveText _active_texts[static_cast<int>(TextType::COUNT)];
 232         std::shared_ptr<AudioProcessor> _audio_processor;
 233
 234         dcpomatic::DCPTime _playback_length;
 235
 236         /** Alignment for subtitle images that we create */
 237         Image::Alignment _subtitle_alignment = Image::Alignment::PADDED;
 238
 239         boost::signals2::scoped_connection _film_changed_connection;
 240         boost::signals2::scoped_connection _playlist_change_connection;
 241         boost::signals2::scoped_connection _playlist_content_change_connection;
 242 };
 243
 244
 245 #endif