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_content.h"
  31 #include "dcpomatic_time.h"
  32 #include "content_subtitle.h"
  33 #include "position_image.h"
  34
  35 class Job;
  36 class Film;
  37 class Playlist;
  38 class AudioContent;
  39 class Piece;
  40 class Image;
  41 class DCPVideo;
  42 class Decoder;
  43
  44 class PlayerStatistics
  45 {
  46 public:
  47         struct Video {
  48                 Video ()
  49                         : black (0)
  50                         , repeat (0)
  51                         , good (0)
  52                         , skip (0)
  53                 {}
  54
  55                 int black;
  56                 int repeat;
  57                 int good;
  58                 int skip;
  59         } video;
  60
  61         struct Audio {
  62                 Audio ()
  63                         : silence (0)
  64                         , good (0)
  65                         , skip (0)
  66                 {}
  67
  68                 DCPTime silence;
  69                 int64_t good;
  70                 int64_t skip;
  71         } audio;
  72
  73         void dump (boost::shared_ptr<Log>) const;
  74 };
  75
  76 class Piece
  77 {
  78 public:
  79         Piece (boost::shared_ptr<Content> c, boost::shared_ptr<Decoder> d, FrameRateChange f)
  80                 : content (c)
  81                 , decoder (d)
  82                 , frc (f)
  83         {}
  84
  85         boost::shared_ptr<Content> content;
  86         boost::shared_ptr<Decoder> decoder;
  87         FrameRateChange frc;
  88 };
  89
  90 /** @class Player
  91  *  @brief A class which can `play' a Playlist.
  92  */
  93 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
  94 {
  95 public:
  96         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist>);
  97
  98         boost::shared_ptr<DCPVideo> get_video (DCPTime time, bool accurate);
  99         boost::shared_ptr<AudioBuffers> get_audio (DCPTime time, DCPTime length, bool accurate);
 100
 101         void set_video_container_size (dcp::Size);
 102         void set_approximate_size ();
 103         void set_burn_subtitles (bool burn) {
 104                 _burn_subtitles = burn;
 105         }
 106
 107         PlayerStatistics const & statistics () const;
 108
 109         /** Emitted when something has changed such that if we went back and emitted
 110          *  the last frame again it would look different.  This is not emitted after
 111          *  a seek.
 112          *
 113          *  The parameter is true if these signals are currently likely to be frequent.
 114          */
 115         boost::signals2::signal<void (bool)> Changed;
 116
 117 private:
 118         friend class PlayerWrapper;
 119         friend class Piece;
 120
 121         void setup_pieces ();
 122         void playlist_changed ();
 123         void content_changed (boost::weak_ptr<Content>, int, bool);
 124         void flush ();
 125         void film_changed (Film::Property);
 126         std::list<PositionImage> process_content_image_subtitles (
 127                 boost::shared_ptr<SubtitleContent>, std::list<boost::shared_ptr<ContentImageSubtitle> >
 128                 );
 129         std::list<PositionImage> process_content_text_subtitles (std::list<boost::shared_ptr<ContentTextSubtitle> >);
 130         void update_subtitle_from_text ();
 131         VideoFrame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 132         AudioFrame dcp_to_content_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 133         ContentTime dcp_to_content_subtitle (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 134
 135         template<class C>
 136         std::list<boost::shared_ptr<Piece> >
 137         overlaps (DCPTime t)
 138         {
 139                 std::list<boost::shared_ptr<Piece> > overlaps;
 140                 for (typename std::list<boost::shared_ptr<Piece> >::const_iterator i = _pieces.begin(); i != _pieces.end(); ++i) {
 141                         if (boost::dynamic_pointer_cast<C> ((*i)->content) && (*i)->content->position() <= t && t < (*i)->content->end()) {
 142                                 overlaps.push_back (*i);
 143                         }
 144                 }
 145
 146                 return overlaps;
 147         }
 148
 149         boost::shared_ptr<const Film> _film;
 150         boost::shared_ptr<const Playlist> _playlist;
 151
 152         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 153         bool _have_valid_pieces;
 154         std::list<boost::shared_ptr<Piece> > _pieces;
 155
 156         dcp::Size _video_container_size;
 157         boost::shared_ptr<Image> _black_image;
 158
 159         bool _approximate_size;
 160         bool _burn_subtitles;
 161
 162         PlayerStatistics _statistics;
 163
 164         boost::signals2::scoped_connection _playlist_changed_connection;
 165         boost::signals2::scoped_connection _playlist_content_changed_connection;
 166         boost::signals2::scoped_connection _film_changed_connection;
 167 };
 168
 169 #endif