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 "audio_buffers.h"
  28 #include "content.h"
  29 #include "film.h"
  30
  31 class Job;
  32 class Film;
  33 class Playlist;
  34 class AudioContent;
  35 class Piece;
  36 class Image;
  37 class Resampler;
  38 class TimedSubtitle;
  39
  40 /** @class Player
  41  *  @brief A class which can `play' a Playlist; emitting its audio and video.
  42  */
  43
  44 class Player : public boost::enable_shared_from_this<Player>
  45 {
  46 public:
  47         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist>);
  48
  49         void disable_video ();
  50         void disable_audio ();
  51
  52         bool pass ();
  53         void seek (Time, bool);
  54
  55         Time video_position () const {
  56                 return _video_position;
  57         }
  58
  59         void set_video_container_size (libdcp::Size);
  60
  61         /** Emitted when a video frame is ready.
  62          *  First parameter is the video image.
  63          *  Second parameter is true if the image is the same as the last one that was emitted.
  64          *  Third parameter is the time.
  65          */
  66         boost::signals2::signal<void (boost::shared_ptr<const Image>, bool, Time)> Video;
  67
  68         /** Emitted when some audio data is ready */
  69         boost::signals2::signal<void (boost::shared_ptr<const AudioBuffers>, Time)> Audio;
  70
  71         /** Emitted when something has changed such that if we went back and emitted
  72          *  the last frame again it would look different.  This is not emitted after
  73          *  a seek.
  74          */
  75         boost::signals2::signal<void ()> Changed;
  76
  77 private:
  78
  79         void process_video (boost::weak_ptr<Piece>, boost::shared_ptr<const Image>, bool, VideoContent::Frame);
  80         void process_audio (boost::weak_ptr<Piece>, boost::shared_ptr<const AudioBuffers>, AudioContent::Frame);
  81         void process_subtitle (boost::weak_ptr<Piece>, boost::shared_ptr<TimedSubtitle>);
  82         void setup_pieces ();
  83         void playlist_changed ();
  84         void content_changed (boost::weak_ptr<Content>, int);
  85         void do_seek (Time, bool);
  86         void flush ();
  87         void emit_black ();
  88         void emit_silence (OutputAudioFrame);
  89         boost::shared_ptr<Resampler> resampler (boost::shared_ptr<AudioContent>);
  90         void film_changed (Film::Property);
  91
  92         boost::shared_ptr<const Film> _film;
  93         boost::shared_ptr<const Playlist> _playlist;
  94
  95         bool _video;
  96         bool _audio;
  97
  98         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
  99         bool _have_valid_pieces;
 100         std::list<boost::shared_ptr<Piece> > _pieces;
 101
 102         /** The time after the last video that we emitted */
 103         Time _video_position;
 104         /** The time after the last audio that we emitted */
 105         Time _audio_position;
 106
 107         AudioBuffers _audio_buffers;
 108
 109         libdcp::Size _video_container_size;
 110         boost::shared_ptr<Image> _black_frame;
 111         std::map<boost::shared_ptr<AudioContent>, boost::shared_ptr<Resampler> > _resamplers;
 112
 113         boost::shared_ptr<TimedSubtitle> _subtitle;
 114         Time _subtitle_offset;
 115 };
 116
 117 #endif