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 #include "subtitle.h"
  34
  35 class Job;
  36 class Film;
  37 class Playlist;
  38 class AudioContent;
  39 class Piece;
  40 class Image;
  41 class Resampler;
  42 class PlayerVideoFrame;
  43
  44 /** @class Player
  45  *  @brief A class which can `play' a Playlist; emitting its audio and video.
  46  */
  47 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
  48 {
  49 public:
  50         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist>);
  51
  52         void disable_video ();
  53         void disable_audio ();
  54
  55         bool pass ();
  56         void seek (Time, bool);
  57
  58         Time video_position () const {
  59                 return _video_position;
  60         }
  61
  62         void set_video_container_size (libdcp::Size);
  63
  64         bool repeat_last_video ();
  65
  66         /** Emitted when a video frame is ready.
  67          *  First parameter is the video image.
  68          *  Second parameter is true if the frame is the same as the last one that was emitted.
  69          *  Third parameter is the time.
  70          */
  71         boost::signals2::signal<void (boost::shared_ptr<PlayerVideoFrame>, bool, Time)> Video;
  72
  73         /** Emitted when some audio data is ready */
  74         boost::signals2::signal<void (boost::shared_ptr<const AudioBuffers>, Time)> Audio;
  75
  76         /** Emitted when something has changed such that if we went back and emitted
  77          *  the last frame again it would look different.  This is not emitted after
  78          *  a seek.
  79          *
  80          *  The parameter is true if these signals are currently likely to be frequent.
  81          */
  82         boost::signals2::signal<void (bool)> Changed;
  83
  84 private:
  85         friend class PlayerWrapper;
  86         friend class Piece;
  87
  88         void process_video (boost::weak_ptr<Piece>, boost::shared_ptr<const Image>, Eyes, bool, VideoContent::Frame, Time);
  89         void process_audio (boost::weak_ptr<Piece>, boost::shared_ptr<const AudioBuffers>, AudioContent::Frame);
  90         void process_subtitle (boost::weak_ptr<Piece>, boost::shared_ptr<Image>, dcpomatic::Rect<double>, Time, Time);
  91         void setup_pieces ();
  92         void playlist_changed ();
  93         void content_changed (boost::weak_ptr<Content>, int, bool);
  94         void do_seek (Time, bool);
  95         void flush ();
  96         void emit_black ();
  97         void emit_silence (OutputAudioFrame);
  98         boost::shared_ptr<Resampler> resampler (boost::shared_ptr<AudioContent>, bool);
  99         void film_changed (Film::Property);
 100         void update_subtitle ();
 101
 102         boost::shared_ptr<const Film> _film;
 103         boost::shared_ptr<const Playlist> _playlist;
 104
 105         bool _video;
 106         bool _audio;
 107
 108         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 109         bool _have_valid_pieces;
 110         std::list<boost::shared_ptr<Piece> > _pieces;
 111
 112         /** The time after the last video that we emitted */
 113         Time _video_position;
 114         /** The time after the last audio that we emitted */
 115         Time _audio_position;
 116
 117         AudioMerger<Time, AudioContent::Frame> _audio_merger;
 118
 119         libdcp::Size _video_container_size;
 120         boost::shared_ptr<PlayerVideoFrame> _black_frame;
 121         std::map<boost::shared_ptr<AudioContent>, boost::shared_ptr<Resampler> > _resamplers;
 122
 123         std::list<Subtitle> _subtitles;
 124
 125 #ifdef DCPOMATIC_DEBUG
 126         boost::shared_ptr<Content> _last_video;
 127 #endif
 128
 129         bool _last_emit_was_black;
 130
 131         IncomingVideo _last_incoming_video;
 132
 133         boost::signals2::scoped_connection _playlist_changed_connection;
 134         boost::signals2::scoped_connection _playlist_content_changed_connection;
 135         boost::signals2::scoped_connection _film_changed_connection;
 136 };
 137
 138 #endif