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