src/lib/player.h

   1 /*
   2     Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_PLAYER_H
  22 #define DCPOMATIC_PLAYER_H
  23
  24 #include "player_subtitles.h"
  25 #include "film.h"
  26 #include "content.h"
  27 #include "position_image.h"
  28 #include "piece.h"
  29 #include "content_video.h"
  30 #include "content_audio.h"
  31 #include "content_subtitle.h"
  32 #include "audio_stream.h"
  33 #include "audio_merger.h"
  34 #include <boost/shared_ptr.hpp>
  35 #include <boost/enable_shared_from_this.hpp>
  36 #include <list>
  37
  38 namespace dcp {
  39         class ReelAsset;
  40 }
  41
  42 class PlayerVideo;
  43 class Playlist;
  44 class Font;
  45 class AudioBuffers;
  46 class ReferencedReelAsset;
  47
  48 /** @class Player
  49  *  @brief A class which can `play' a Playlist.
  50  */
  51 class Player : public boost::enable_shared_from_this<Player>, public boost::noncopyable
  52 {
  53 public:
  54         Player (boost::shared_ptr<const Film>, boost::shared_ptr<const Playlist> playlist);
  55
  56         bool pass ();
  57         void seek (DCPTime time, bool accurate);
  58
  59         std::list<boost::shared_ptr<Font> > get_subtitle_fonts ();
  60         std::list<ReferencedReelAsset> get_reel_assets ();
  61
  62         void set_video_container_size (dcp::Size);
  63         void set_ignore_video ();
  64         void set_ignore_audio ();
  65         void set_enable_subtitles (bool enable);
  66         void set_always_burn_subtitles (bool burn);
  67         void set_fast ();
  68         void set_play_referenced ();
  69
  70         /** Emitted when something has changed such that if we went back and emitted
  71          *  the last frame again it would look different.  This is not emitted after
  72          *  a seek.
  73          *
  74          *  The parameter is true if these signals are currently likely to be frequent.
  75          */
  76         boost::signals2::signal<void (bool)> Changed;
  77
  78         boost::signals2::signal<void (boost::shared_ptr<PlayerVideo>, DCPTime)> Video;
  79         boost::signals2::signal<void (boost::shared_ptr<AudioBuffers>, DCPTime)> Audio;
  80         boost::signals2::signal<void (PlayerSubtitles, DCPTimePeriod)> Subtitle;
  81
  82 private:
  83         friend class PlayerWrapper;
  84         friend class Piece;
  85         friend struct player_overlaps_test;
  86         friend struct player_time_calculation_test1;
  87         friend struct player_time_calculation_test2;
  88         friend struct player_time_calculation_test3;
  89
  90         void setup_pieces ();
  91         void flush ();
  92         void film_changed (Film::Property);
  93         void playlist_changed ();
  94         void playlist_content_changed (boost::weak_ptr<Content>, int, bool);
  95         std::list<PositionImage> transform_image_subtitles (std::list<ImageSubtitle>) const;
  96         Frame dcp_to_content_video (boost::shared_ptr<const Piece> piece, DCPTime t) const;
  97         DCPTime content_video_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
  98         Frame dcp_to_resampled_audio (boost::shared_ptr<const Piece> piece, DCPTime t) const;
  99         DCPTime resampled_audio_to_dcp (boost::shared_ptr<const Piece> piece, Frame f) const;
 100         ContentTime dcp_to_content_time (boost::shared_ptr<const Piece> piece, DCPTime t) const;
 101         DCPTime content_time_to_dcp (boost::shared_ptr<const Piece> piece, ContentTime t) const;
 102         boost::shared_ptr<PlayerVideo> black_player_video_frame () const;
 103         std::list<boost::shared_ptr<Piece> > overlaps (DCPTime from, DCPTime to, boost::function<bool (Content *)> valid);
 104         void video (boost::weak_ptr<Piece>, ContentVideo);
 105         void audio (boost::weak_ptr<Piece>, AudioStreamPtr, ContentAudio);
 106         void image_subtitle (boost::weak_ptr<Piece>, ContentImageSubtitle);
 107         void text_subtitle (boost::weak_ptr<Piece>, ContentTextSubtitle);
 108
 109         boost::shared_ptr<const Film> _film;
 110         boost::shared_ptr<const Playlist> _playlist;
 111
 112         /** Our pieces are ready to go; if this is false the pieces must be (re-)created before they are used */
 113         bool _have_valid_pieces;
 114         std::list<boost::shared_ptr<Piece> > _pieces;
 115
 116         /** Size of the image in the DCP (e.g. 1990x1080 for flat) */
 117         dcp::Size _video_container_size;
 118         boost::shared_ptr<Image> _black_image;
 119
 120         /** true if the player should ignore all video; i.e. never produce any */
 121         bool _ignore_video;
 122         /** true if the player should ignore all audio; i.e. never produce any */
 123         bool _ignore_audio;
 124         /** true if the player should always burn subtitles into the video regardless
 125             of content settings
 126         */
 127         bool _always_burn_subtitles;
 128         /** true if we should try to be fast rather than high quality */
 129         bool _fast;
 130         /** true if we should `play' (i.e output) referenced DCP data (e.g. for preview) */
 131         bool _play_referenced;
 132
 133         boost::shared_ptr<PlayerVideo> _last_video;
 134         boost::optional<DCPTime> _last_video_time;
 135
 136         AudioMerger _audio_merger;
 137         DCPTime _last_audio_time;
 138
 139         std::list<std::pair<PlayerSubtitles, DCPTimePeriod> > _subtitles;
 140
 141         boost::shared_ptr<AudioProcessor> _audio_processor;
 142
 143         boost::signals2::scoped_connection _film_changed_connection;
 144         boost::signals2::scoped_connection _playlist_changed_connection;
 145         boost::signals2::scoped_connection _playlist_content_changed_connection;
 146 };
 147
 148 #endif