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
  33 class Job;
  34 class Film;
  35 class Playlist;
  36 class AudioContent;
  37 class Piece;
  38 class Image;
  39 class Resampler;
  40
  41 /** @class Player
  42  *  @brief A class which can `play' a Playlist; emitting its audio and video.
  43  */
  44
  45 struct IncomingVideo
  46 {
  47 public:
  48         boost::weak_ptr<Piece> weak_piece;
  49         boost::shared_ptr<const Image> image;
  50         Eyes eyes;
  51         bool same;
  52         VideoContent::Frame frame;
  53         Time extra;
  54 };
  55
  56 /** A wrapper for an Image which contains some pending operations; these may
  57  *  not be necessary if the receiver of the PlayerImage throws it away.
  58  */
  59 class PlayerImage
  60 {
  61 public:
  62         PlayerImage (boost::shared_ptr<const Image>, Crop, libdcp::Size, libdcp::Size, Scaler const *);
  63
  64         void set_subtitle (boost::shared_ptr<const Image>, Position<int>);
  65
  66         boost::shared_ptr<Image> image ();
  67
  68 private:
  69         boost::shared_ptr<const Image> _in;
  70         Crop _crop;
  71         libdcp::Size _inter_size;
  72         libdcp::Size _out_size;
  73         Scaler const * _scaler;
  74         boost::shared_ptr<const Image> _subtitle_image;
  75         Position<int> _subtitle_position;
  76 };
  77
  78 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
  79 {
  80 public:
  81         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist>);
  82
  83         void disable_video ();
  84         void disable_audio ();
  85
  86         bool pass ();
  87         void seek (Time, bool);
  88
  89         Time video_position () const {
  90                 return _video_position;
  91         }
  92
  93         void set_video_container_size (libdcp::Size);
  94
  95         bool repeat_last_video ();
  96
  97         /** Emitted when a video frame is ready.
  98          *  First parameter is the video image.
  99          *  Second parameter is the eye(s) that should see this image.
 100          *  Third parameter is the colour conversion that should be used for this image.
 101          *  Fourth parameter is true if the image is the same as the last one that was emitted.
 102          *  Fifth parameter is the time.
 103          */
 104         boost::signals2::signal<void (boost::shared_ptr<PlayerImage>, Eyes, ColourConversion, bool, Time)> Video;
 105
 106         /** Emitted when some audio data is ready */
 107         boost::signals2::signal<void (boost::shared_ptr<const AudioBuffers>, Time)> Audio;
 108
 109         /** Emitted when something has changed such that if we went back and emitted
 110          *  the last frame again it would look different.  This is not emitted after
 111          *  a seek.
 112          *
 113          *  The parameter is true if these signals are currently likely to be frequent.
 114          */
 115         boost::signals2::signal<void (bool)> Changed;
 116
 117 private:
 118         friend class PlayerWrapper;
 119         friend class Piece;
 120
 121         void process_video (boost::weak_ptr<Piece>, boost::shared_ptr<const Image>, Eyes, bool, VideoContent::Frame, Time);
 122         void process_audio (boost::weak_ptr<Piece>, boost::shared_ptr<const AudioBuffers>, AudioContent::Frame);
 123         void process_subtitle (boost::weak_ptr<Piece>, boost::shared_ptr<Image>, dcpomatic::Rect<double>, Time, Time);
 124         void setup_pieces ();
 125         void playlist_changed ();
 126         void content_changed (boost::weak_ptr<Content>, int, bool);
 127         void do_seek (Time, bool);
 128         void flush ();
 129         void emit_black ();
 130         void emit_silence (OutputAudioFrame);
 131         boost::shared_ptr<Resampler> resampler (boost::shared_ptr<AudioContent>, bool);
 132         void film_changed (Film::Property);
 133         void update_subtitle ();
 134
 135         boost::shared_ptr<const Film> _film;
 136         boost::shared_ptr<const Playlist> _playlist;
 137
 138         bool _video;
 139         bool _audio;
 140
 141         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 142         bool _have_valid_pieces;
 143         std::list<boost::shared_ptr<Piece> > _pieces;
 144
 145         /** The time after the last video that we emitted */
 146         Time _video_position;
 147         /** The time after the last audio that we emitted */
 148         Time _audio_position;
 149
 150         AudioMerger<Time, AudioContent::Frame> _audio_merger;
 151
 152         libdcp::Size _video_container_size;
 153         boost::shared_ptr<PlayerImage> _black_frame;
 154         std::map<boost::shared_ptr<AudioContent>, boost::shared_ptr<Resampler> > _resamplers;
 155
 156         struct {
 157                 boost::weak_ptr<Piece> piece;
 158                 boost::shared_ptr<Image> image;
 159                 dcpomatic::Rect<double> rect;
 160                 Time from;
 161                 Time to;
 162         } _in_subtitle;
 163
 164         struct {
 165                 boost::shared_ptr<Image> image;
 166                 Position<int> position;
 167                 Time from;
 168                 Time to;
 169         } _out_subtitle;
 170
 171 #ifdef DCPOMATIC_DEBUG
 172         boost::shared_ptr<Content> _last_video;
 173 #endif
 174
 175         bool _last_emit_was_black;
 176
 177         IncomingVideo _last_incoming_video;
 178
 179         boost::signals2::scoped_connection _playlist_changed_connection;
 180         boost::signals2::scoped_connection _playlist_content_changed_connection;
 181         boost::signals2::scoped_connection _film_changed_connection;
 182 };
 183
 184 #endif