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