src/lib/player.h

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