src/lib/player.h

   1 /*
   2     Copyright (C) 2013-2018 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 "player_text.h"
  25 #include "active_text.h"
  26 #include "content_text.h"
  27 #include "film.h"
  28 #include "content.h"
  29 #include "position_image.h"
  30 #include "piece.h"
  31 #include "content_video.h"
  32 #include "content_audio.h"
  33 #include "audio_stream.h"
  34 #include "audio_merger.h"
  35 #include "empty.h"
  36 #include <boost/shared_ptr.hpp>
  37 #include <boost/enable_shared_from_this.hpp>
  38 #include <list>
  39
  40 namespace dcp {
  41         class ReelAsset;
  42 }
  43
  44 class PlayerVideo;
  45 class Playlist;
  46 class Font;
  47 class AudioBuffers;
  48 class ReferencedReelAsset;
  49 class Shuffler;
  50
  51 class PlayerProperty
  52 {
  53 public:
  54         static int const VIDEO_CONTAINER_SIZE;
  55         static int const PLAYLIST;
  56         static int const FILM_CONTAINER;
  57         static int const FILM_VIDEO_FRAME_RATE;
  58         static int const DCP_DECODE_REDUCTION;
  59         static int const IGNORE;
  60         static int const FAST;
  61         static int const PLAY_REFERENCED;
  62 };
  63
  64 /** @class Player
  65  *  @brief A class which can play a Playlist.
  66  */
  67 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
  68 {
  69 public:
  70         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
  71         ~Player ();
  72
  73         bool pass ();
  74         void seek (DCPTime time, bool accurate);
  75
  76         std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
  77         std::list<ReferencedReelAsset> get_reel_assets ();
  78         dcp::Size video_container_size () const {
  79                 boost::mutex::scoped_lock lm (_mutex);
  80                 return _video_container_size;
  81         }
  82
  83         void set_video_container_size (dcp::Size);
  84         void set_ignore_video ();
  85         void set_ignore_audio ();
  86         void set_ignore_text ();
  87         void set_always_burn_open_subtitles ();
  88         void set_fast ();
  89         void set_play_referenced ();
  90         void set_dcp_decode_reduction (boost::optional<int> reduction);
  91
  92         DCPTime content_time_to_dcp (boost::shared_ptr<Content> content, ContentTime t);
  93
  94         /** Emitted when something has changed such that if we went back and emitted
  95          *  the last frame again it would look different.  This is not emitted after
  96          *  a seek.
  97          *
  98          *  The first parameter is what changed.
  99          *  The second parameter is true if these signals are currently likely to be frequent.
 100          */
 101         boost::signals2::signal<void (int, bool)> Changed;
 102
 103         /** Emitted when a video frame is ready.  These emissions happen in the correct order. */
 104         boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>, DCPTime)> Video;
 105         boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, DCPTime)> Audio;
 106         /** Emitted when a text is ready.  This signal may be emitted considerably
 107          *  after the corresponding Video.
 108          */
 109         boost::signals2::signal<void (PlayerText, TextType, DCPTimePeriod)> Text;
 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
 119         void setup_pieces ();
 120         void flush ();
 121         void film_changed (Film::Property);
 122         void playlist_changed ();
 123         void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
 124         std::list<PositionImage> transform_bitmap_texts (std::list<BitmapText>) const;
 125         Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 126         DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
 127         Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 128         DCPTime resampled_audio_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
 129         ContentTime dcp_to_content_time (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 130         DCPTime content_time_to_dcp (boost::shared_ptr<const Piece> piece, ContentTime t) const;
 131         boost::shared_ptr<PlayerVideo> black_player_video_frame (Eyes eyes) const;
 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 subtitle_stop (boost::weak_ptr<Piece>, boost::weak_ptr<const TextContent>, ContentTime, TextType);
 137         DCPTime one_video_frame () const;
 138         void fill_audio (DCPTimePeriod period);
 139         std::pair<boost::shared_ptr<AudioBuffers>, DCPTime> discard_audio (
 140                 boost::shared_ptr<const AudioBuffers> audio, DCPTime time, DCPTime discard_to
 141                 ) const;
 142         boost::optional<PositionImage> open_subtitles_for_frame (DCPTime time) const;
 143         void emit_video (boost::shared_ptr<PlayerVideo> pv, DCPTime time);
 144         void do_emit_video (boost::shared_ptr<PlayerVideo> pv, DCPTime time);
 145         void emit_audio (boost::shared_ptr<AudioBuffers> data, DCPTime time);
 146
 147         /** Mutex to protect the whole Player state.  When it's used for the preview we have
 148             seek() and pass() called from the Butler thread and lots of other stuff called
 149             from the GUI thread.
 150         */
 151         mutable boost::mutex _mutex;
 152
 153         boost::shared_ptr<const Film> _film;
 154         boost::shared_ptr<const Playlist> _playlist;
 155
 156         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 157         bool _have_valid_pieces;
 158         std::list<boost::shared_ptr<Piece> > _pieces;
 159
 160         /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
 161         dcp::Size _video_container_size;
 162         boost::shared_ptr<Image> _black_image;
 163
 164         /** true if the player should ignore all video; i.e. never produce any */
 165         bool _ignore_video;
 166         bool _ignore_audio;
 167         /** true if the player should ignore all text; i.e. never produce any */
 168         bool _ignore_text;
 169         bool _always_burn_open_subtitles;
 170         /** true if we should try to be fast rather than high quality */
 171         bool _fast;
 172         /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
 173         bool _play_referenced;
 174
 175         /** Time just after the last video frame we emitted, or the time of the last accurate seek */
 176         boost::optional<DCPTime> _last_video_time;
 177         boost::optional<Eyes> _last_video_eyes;
 178         /** Time just after the last audio frame we emitted, or the time of the last accurate seek */
 179         boost::optional<DCPTime> _last_audio_time;
 180
 181         boost::optional<int> _dcp_decode_reduction;
 182
 183         typedef std::map<boost::weak_ptr<Piece>, boost::shared_ptr<PlayerVideo> > LastVideoMap;
 184         LastVideoMap _last_video;
 185
 186         AudioMerger _audio_merger;
 187         Shuffler* _shuffler;
 188         std::list<std::pair<boost::shared_ptr<PlayerVideo>, DCPTime> > _delay;
 189
 190         class StreamState
 191         {
 192         public:
 193                 StreamState () {}
 194
 195                 StreamState (boost::shared_ptr<Piece> p, DCPTime l)
 196                         : piece(p)
 197                         , last_push_end(l)
 198                 {}
 199
 200                 boost::shared_ptr<Piece> piece;
 201                 DCPTime last_push_end;
 202         };
 203         std::map<AudioStreamPtr, StreamState> _stream_states;
 204
 205         Empty _black;
 206         Empty _silent;
 207
 208         ActiveText _active_texts[TEXT_COUNT];
 209         boost::shared_ptr<AudioProcessor> _audio_processor;
 210
 211         boost::signals2::scoped_connection _film_changed_connection;
 212         boost::signals2::scoped_connection _playlist_changed_connection;
 213         boost::signals2::scoped_connection _playlist_content_changed_connection;
 214 };
 215
 216 #endif