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