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