src/lib/player.h

   1 /*
   2     Copyright (C) 2013-2015 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 "player_subtitles.h"
  24 #include "film.h"
  25 #include "content.h"
  26 #include "position_image.h"
  27 #include "piece.h"
  28 #include <boost/shared_ptr.hpp>
  29 #include <boost/enable_shared_from_this.hpp>
  30 #include <list>
  31
  32 class PlayerVideo;
  33 class Playlist;
  34 class Font;
  35 class AudioBuffers;
  36
  37 /** @class Player
  38  *  @brief A class which can `play' a Playlist.
  39  */
  40 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
  41 {
  42 public:
  43         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
  44
  45         std::list<boost::shared_ptr<PlayerVideo> > get_video (DCPTime time, bool accurate);
  46         boost::shared_ptr<AudioBuffers> get_audio (DCPTime time, DCPTime length, bool accurate);
  47         PlayerSubtitles get_subtitles (DCPTime time, DCPTime length, bool starting, bool burnt);
  48         std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
  49
  50         void set_video_container_size (dcp::Size);
  51         void set_ignore_video ();
  52         void set_ignore_audio ();
  53         void set_enable_subtitles (bool enable);
  54         void set_always_burn_subtitles (bool burn);
  55
  56         /** Emitted when something has changed such that if we went back and emitted
  57          *  the last frame again it would look different.  This is not emitted after
  58          *  a seek.
  59          *
  60          *  The parameter is true if these signals are currently likely to be frequent.
  61          */
  62         boost::signals2::signal<void (bool)> Changed;
  63
  64 private:
  65         friend class PlayerWrapper;
  66         friend class Piece;
  67         friend struct player_overlaps_test;
  68         friend struct player_time_calculation_test1;
  69         friend struct player_time_calculation_test2;
  70         friend struct player_time_calculation_test3;
  71
  72         void setup_pieces ();
  73         void flush ();
  74         void film_changed (Film::Property);
  75         void playlist_changed ();
  76         void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
  77         std::list<PositionImage> transform_image_subtitles (std::list<ImageSubtitle>) const;
  78         void update_subtitle_from_text ();
  79         Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
  80         DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
  81         Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
  82         ContentTime dcp_to_content_subtitle (boost::shared_ptr<const Piece> piece, DCPTime t) const;
  83         boost::shared_ptr<PlayerVideo> black_player_video_frame (DCPTime) const;
  84
  85         /** @return Pieces of content type C that overlap a specified time range in the DCP */
  86         template<class C>
  87         std::list<boost::shared_ptr<Piece> >
  88         overlaps (DCPTime from, DCPTime to)
  89         {
  90                 if (!_have_valid_pieces) {
  91                         setup_pieces ();
  92                 }
  93
  94                 std::list<boost::shared_ptr<Piece> > overlaps;
  95                 for (typename std::list<boost::shared_ptr<Piece> >::const_iterator i = _pieces.begin(); i != _pieces.end(); ++i) {
  96                         if (!boost::dynamic_pointer_cast<C> ((*i)->content)) {
  97                                 continue;
  98                         }
  99
 100                         if ((*i)->content->position() <= to && (*i)->content->end() >= from) {
 101                                 overlaps.push_back (*i);
 102                         }
 103                 }
 104
 105                 return overlaps;
 106         }
 107
 108         boost::shared_ptr<const Film> _film;
 109         boost::shared_ptr<const Playlist> _playlist;
 110
 111         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 112         bool _have_valid_pieces;
 113         std::list<boost::shared_ptr<Piece> > _pieces;
 114
 115         /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
 116         dcp::Size _video_container_size;
 117         boost::shared_ptr<Image> _black_image;
 118
 119         /** true if the player should ignore all video; i.e. never produce any */
 120         bool _ignore_video;
 121         /** true if the player should ignore all audio; i.e. never produce any */
 122         bool _ignore_audio;
 123         /** true if the player should always burn subtitles into the video regardless
 124             of content settings
 125         */
 126         bool _always_burn_subtitles;
 127
 128         boost::shared_ptr<AudioProcessor> _audio_processor;
 129
 130         boost::signals2::scoped_connection _film_changed_connection;
 131         boost::signals2::scoped_connection _playlist_changed_connection;
 132         boost::signals2::scoped_connection _playlist_content_changed_connection;
 133 };
 134
 135 #endif