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