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