src/lib/player.h

   1 /*
   2     Copyright (C) 2013 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 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
  57 {
  58 public:
  59         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist>);
  60
  61         void disable_video ();
  62         void disable_audio ();
  63
  64         bool pass ();
  65         void seek (Time, bool);
  66
  67         Time video_position () const {
  68                 return _video_position;
  69         }
  70
  71         void set_video_container_size (libdcp::Size);
  72
  73         bool repeat_last_video ();
  74
  75         /** Emitted when a video frame is ready.
  76          *  First parameter is the video image.
  77          *  Second parameter is the eye(s) that should see this image.
  78          *  Third parameter is the colour conversion that should be used for this image.
  79          *  Fourth parameter is true if the image is the same as the last one that was emitted.
  80          *  Fifth parameter is the time.
  81          */
  82         boost::signals2::signal<void (boost::shared_ptr<const Image>, Eyes, ColourConversion, bool, Time)> Video;
  83
  84         /** Emitted when some audio data is ready */
  85         boost::signals2::signal<void (boost::shared_ptr<const AudioBuffers>, Time)> Audio;
  86
  87         /** Emitted when something has changed such that if we went back and emitted
  88          *  the last frame again it would look different.  This is not emitted after
  89          *  a seek.
  90          *
  91          *  The parameter is true if these signals are currently likely to be frequent.
  92          */
  93         boost::signals2::signal<void (bool)> Changed;
  94
  95 private:
  96         friend class PlayerWrapper;
  97         friend class Piece;
  98
  99         void process_video (boost::weak_ptr<Piece>, boost::shared_ptr<const Image>, Eyes, bool, VideoContent::Frame, Time);
 100         void process_audio (boost::weak_ptr<Piece>, boost::shared_ptr<const AudioBuffers>, AudioContent::Frame);
 101         void process_subtitle (boost::weak_ptr<Piece>, boost::shared_ptr<Image>, dcpomatic::Rect<double>, Time, Time);
 102         void setup_pieces ();
 103         void playlist_changed ();
 104         void content_changed (boost::weak_ptr<Content>, int, bool);
 105         void do_seek (Time, bool);
 106         void flush ();
 107         void emit_black ();
 108         void emit_silence (OutputAudioFrame);
 109         boost::shared_ptr<Resampler> resampler (boost::shared_ptr<AudioContent>, bool);
 110         void film_changed (Film::Property);
 111         void update_subtitle ();
 112
 113         boost::shared_ptr<const Film> _film;
 114         boost::shared_ptr<const Playlist> _playlist;
 115
 116         bool _video;
 117         bool _audio;
 118
 119         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 120         bool _have_valid_pieces;
 121         std::list<boost::shared_ptr<Piece> > _pieces;
 122
 123         /** The time after the last video that we emitted */
 124         Time _video_position;
 125         /** The time after the last audio that we emitted */
 126         Time _audio_position;
 127
 128         AudioMerger<Time, AudioContent::Frame> _audio_merger;
 129
 130         libdcp::Size _video_container_size;
 131         boost::shared_ptr<Image> _black_frame;
 132         std::map<boost::shared_ptr<AudioContent>, boost::shared_ptr<Resampler> > _resamplers;
 133
 134         struct {
 135                 boost::weak_ptr<Piece> piece;
 136                 boost::shared_ptr<Image> image;
 137                 dcpomatic::Rect<double> rect;
 138                 Time from;
 139                 Time to;
 140         } _in_subtitle;
 141
 142         struct {
 143                 boost::shared_ptr<Image> image;
 144                 Position<int> position;
 145                 Time from;
 146                 Time to;
 147         } _out_subtitle;
 148
 149 #ifdef DCPOMATIC_DEBUG
 150         boost::shared_ptr<Content> _last_video;
 151 #endif
 152
 153         bool _last_emit_was_black;
 154
 155         IncomingVideo _last_incoming_video;
 156
 157         boost::signals2::scoped_connection _playlist_changed_connection;
 158         boost::signals2::scoped_connection _playlist_content_changed_connection;
 159         boost::signals2::scoped_connection _film_changed_connection;
 160 };
 161
 162 #endif