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         static int const IGNORE_VIDEO;
  67         static int const IGNORE_AUDIO;
  68         static int const IGNORE_TEXT;
  69         static int const ALWAYS_BURN_OPEN_SUBTITLES;
  70         static int const PLAY_REFERENCED;
  71 };
  72
  73
  74 /** @class Player
  75  *  @brief A class which can play a Playlist.
  76  */
  77 class Player
  78 {
  79 public:
  80         Player (std::shared_ptr<const Film>, Image::Alignment subtitle_alignment);
  81         Player (std::shared_ptr<const Film>, std::shared_ptr<const Playlist> playlist);
  82
  83         Player (Player const&) = delete;
  84         Player& operator= (Player const&) = delete;
  85
  86         Player(Player&& other);
  87         Player& operator=(Player&& other);
  88
  89         bool pass ();
  90         void seek (dcpomatic::DCPTime time, bool accurate);
  91
  92         std::vector<std::shared_ptr<dcpomatic::Font>> get_subtitle_fonts ();
  93
  94         dcp::Size video_container_size () const {
  95                 return _video_container_size;
  96         }
  97
  98         void set_video_container_size (dcp::Size);
  99         void set_ignore_video ();
 100         void set_ignore_audio ();
 101         void set_ignore_text ();
 102         void set_always_burn_open_subtitles ();
 103         void set_fast ();
 104         void set_play_referenced ();
 105         void set_dcp_decode_reduction (boost::optional<int> reduction);
 106
 107         boost::optional<dcpomatic::DCPTime> content_time_to_dcp (std::shared_ptr<const Content> content, dcpomatic::ContentTime t) const;
 108         boost::optional<dcpomatic::ContentTime> dcp_to_content_time (std::shared_ptr<const Content> content, dcpomatic::DCPTime t) const;
 109
 110         void signal_change(ChangeType type, int property);
 111
 112         /** First parameter is PENDING, DONE or CANCELLED.
 113          *  Second parameter is the property.
 114          *  Third parameter is true if these signals are currently likely to be frequent.
 115          */
 116         boost::signals2::signal<void (ChangeType, int, bool)> Change;
 117
 118         /** Emitted when a video frame is ready.  These emissions happen in the correct order. */
 119         boost::signals2::signal<void (std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime)> Video;
 120         /** Emitted when audio data is ready.  First parameter is the audio data, second its time,
 121          *  third the frame rate.
 122          */
 123         boost::signals2::signal<void (std::shared_ptr<AudioBuffers>, dcpomatic::DCPTime, int)> Audio;
 124         /** Emitted when a text is ready.  This signal may be emitted considerably
 125          *  after the corresponding Video.
 126          */
 127         boost::signals2::signal<void (PlayerText, TextType, boost::optional<DCPTextTrack>, dcpomatic::DCPTimePeriod)> Text;
 128         boost::signals2::signal<void (std::shared_ptr<const dcp::AtmosFrame>, dcpomatic::DCPTime, AtmosMetadata)> Atmos;
 129
 130 private:
 131         friend class PlayerWrapper;
 132         friend class Piece;
 133         friend struct player_time_calculation_test1;
 134         friend struct player_time_calculation_test2;
 135         friend struct player_time_calculation_test3;
 136         friend struct player_subframe_test;
 137         friend struct empty_test1;
 138         friend struct empty_test2;
 139         friend struct check_reuse_old_data_test;
 140         friend struct overlap_video_test1;
 141
 142         void construct ();
 143         void connect();
 144         void setup_pieces ();
 145         void film_change (ChangeType, Film::Property);
 146         void playlist_change (ChangeType);
 147         void playlist_content_change (ChangeType, int, bool);
 148         Frame dcp_to_content_video (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
 149         dcpomatic::DCPTime content_video_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
 150         Frame dcp_to_resampled_audio (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
 151         dcpomatic::DCPTime resampled_audio_to_dcp (std::shared_ptr<const Piece> piece, Frame f) const;
 152         dcpomatic::ContentTime dcp_to_content_time (std::shared_ptr<const Piece> piece, dcpomatic::DCPTime t) const;
 153         dcpomatic::DCPTime content_time_to_dcp (std::shared_ptr<const Piece> piece, dcpomatic::ContentTime t) const;
 154         std::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
 155         void emit_video_until(dcpomatic::DCPTime time);
 156         void insert_video(std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time, dcpomatic::DCPTime end);
 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 use_video(std::shared_ptr<PlayerVideo> pv, dcpomatic::DCPTime time, dcpomatic::DCPTime end);
 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         /** Time of the next audio that we will emit, or the time of the last accurate seek */
 214         boost::optional<dcpomatic::DCPTime> _next_audio_time;
 215
 216         boost::atomic<boost::optional<int>> _dcp_decode_reduction;
 217
 218         EnumIndexedVector<std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime>, Eyes> _last_video;
 219
 220         AudioMerger _audio_merger;
 221         std::unique_ptr<Shuffler> _shuffler;
 222         std::list<std::pair<std::shared_ptr<PlayerVideo>, dcpomatic::DCPTime>> _delay;
 223
 224         class StreamState
 225         {
 226         public:
 227                 StreamState () {}
 228
 229                 explicit StreamState(std::shared_ptr<Piece> p)
 230                         : piece(p)
 231                 {}
 232
 233                 std::shared_ptr<Piece> piece;
 234                 boost::optional<dcpomatic::DCPTime> last_push_end;
 235         };
 236         std::map<AudioStreamPtr, StreamState> _stream_states;
 237
 238         Empty _black;
 239         Empty _silent;
 240
 241         EnumIndexedVector<ActiveText, TextType> _active_texts;
 242         std::shared_ptr<AudioProcessor> _audio_processor;
 243
 244         boost::atomic<dcpomatic::DCPTime> _playback_length;
 245
 246         /** Alignment for subtitle images that we create */
 247         Image::Alignment _subtitle_alignment = Image::Alignment::PADDED;
 248
 249         boost::signals2::scoped_connection _film_changed_connection;
 250         boost::signals2::scoped_connection _playlist_change_connection;
 251         boost::signals2::scoped_connection _playlist_content_change_connection;
 252 };
 253
 254
 255 #endif