src/lib/player.h

   1 /*
   2     Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef DCPOMATIC_PLAYER_H
  21 #define DCPOMATIC_PLAYER_H
  22
  23 #include <list>
  24 #include <boost/shared_ptr.hpp>
  25 #include <boost/enable_shared_from_this.hpp>
  26 #include "playlist.h"
  27 #include "content.h"
  28 #include "film.h"
  29 #include "rect.h"
  30 #include "audio_merger.h"
  31 #include "audio_content.h"
  32 #include "piece.h"
  33
  34 class Job;
  35 class Film;
  36 class Playlist;
  37 class AudioContent;
  38 class Piece;
  39 class Image;
  40 class Resampler;
  41
  42 /** A wrapper for an Image which contains some pending operations; these may
  43  *  not be necessary if the receiver of the PlayerImage throws it away.
  44  */
  45 class PlayerImage
  46 {
  47 public:
  48         PlayerImage (boost::shared_ptr<const Image>, Crop, libdcp::Size, libdcp::Size, Scaler const *);
  49
  50         void set_subtitle (boost::shared_ptr<const Image>, Position<int>);
  51
  52         boost::shared_ptr<Image> image ();
  53
  54 private:
  55         boost::shared_ptr<const Image> _in;
  56         Crop _crop;
  57         libdcp::Size _inter_size;
  58         libdcp::Size _out_size;
  59         Scaler const * _scaler;
  60         boost::shared_ptr<const Image> _subtitle_image;
  61         Position<int> _subtitle_position;
  62 };
  63
  64 /** @class Player
  65  *  @brief A class which can `play' a Playlist; emitting its audio and video.
  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>);
  71
  72         void disable_video ();
  73         void disable_audio ();
  74
  75         bool pass ();
  76         void seek (Time, bool);
  77
  78         Time video_position () const {
  79                 return _video_position;
  80         }
  81
  82         void set_video_container_size (libdcp::Size);
  83
  84         bool repeat_last_video ();
  85
  86         /** Emitted when a video frame is ready.
  87          *  First parameter is the video image.
  88          *  Second parameter is the eye(s) that should see this image.
  89          *  Third parameter is the colour conversion that should be used for this image.
  90          *  Fourth parameter is true if the image is the same as the last one that was emitted.
  91          *  Fifth parameter is the time.
  92          */
  93         boost::signals2::signal<void (boost::shared_ptr<PlayerImage>, Eyes, ColourConversion, bool, Time)> Video;
  94
  95         /** Emitted when some audio data is ready */
  96         boost::signals2::signal<void (boost::shared_ptr<const AudioBuffers>, Time)> Audio;
  97
  98         /** Emitted when something has changed such that if we went back and emitted
  99          *  the last frame again it would look different.  This is not emitted after
 100          *  a seek.
 101          *
 102          *  The parameter is true if these signals are currently likely to be frequent.
 103          */
 104         boost::signals2::signal<void (bool)> Changed;
 105
 106 private:
 107         friend class PlayerWrapper;
 108         friend class Piece;
 109
 110         void process_video (boost::weak_ptr<Piece>, boost::shared_ptr<const Image>, Eyes, bool, VideoContent::Frame, Time);
 111         void process_audio (boost::weak_ptr<Piece>, boost::shared_ptr<const AudioBuffers>, AudioContent::Frame);
 112         void process_subtitle (boost::weak_ptr<Piece>, boost::shared_ptr<Image>, dcpomatic::Rect<double>, Time, Time);
 113         void setup_pieces ();
 114         void playlist_changed ();
 115         void content_changed (boost::weak_ptr<Content>, int, bool);
 116         void do_seek (Time, bool);
 117         void flush ();
 118         void emit_black ();
 119         void emit_silence (OutputAudioFrame);
 120         boost::shared_ptr<Resampler> resampler (boost::shared_ptr<AudioContent>, bool);
 121         void film_changed (Film::Property);
 122         void update_subtitle ();
 123
 124         boost::shared_ptr<const Film> _film;
 125         boost::shared_ptr<const Playlist> _playlist;
 126
 127         bool _video;
 128         bool _audio;
 129
 130         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 131         bool _have_valid_pieces;
 132         std::list<boost::shared_ptr<Piece> > _pieces;
 133
 134         /** The time after the last video that we emitted */
 135         Time _video_position;
 136         /** The time after the last audio that we emitted */
 137         Time _audio_position;
 138
 139         AudioMerger<Time, AudioContent::Frame> _audio_merger;
 140
 141         libdcp::Size _video_container_size;
 142         boost::shared_ptr<PlayerImage> _black_frame;
 143         std::map<boost::shared_ptr<AudioContent>, boost::shared_ptr<Resampler> > _resamplers;
 144
 145         struct {
 146                 boost::weak_ptr<Piece> piece;
 147                 boost::shared_ptr<Image> image;
 148                 dcpomatic::Rect<double> rect;
 149                 Time from;
 150                 Time to;
 151         } _in_subtitle;
 152
 153         struct {
 154                 boost::shared_ptr<Image> image;
 155                 Position<int> position;
 156                 Time from;
 157                 Time to;
 158         } _out_subtitle;
 159
 160 #ifdef DCPOMATIC_DEBUG
 161         boost::shared_ptr<Content> _last_video;
 162 #endif
 163
 164         bool _last_emit_was_black;
 165
 166         IncomingVideo _last_incoming_video;
 167
 168         boost::signals2::scoped_connection _playlist_changed_connection;
 169         boost::signals2::scoped_connection _playlist_content_changed_connection;
 170         boost::signals2::scoped_connection _film_changed_connection;
 171 };
 172
 173 #endif