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