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