src/wx/film_viewer.h

   1 /*
   2     Copyright (C) 2012-2019 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 /** @file  src/film_viewer.h
  22  *  @brief FilmViewer class.
  23  */
  24
  25 #include "video_view.h"
  26 #include "lib/film.h"
  27 #include "lib/config.h"
  28 #include "lib/player_text.h"
  29 #include "lib/timer.h"
  30 #include "lib/signaller.h"
  31 #include <RtAudio.h>
  32 #include <wx/wx.h>
  33
  34 class wxToggleButton;
  35 class FFmpegPlayer;
  36 class Image;
  37 class RGBPlusAlphaImage;
  38 class PlayerVideo;
  39 class Player;
  40 class Butler;
  41 class ClosedCaptionsDialog;
  42
  43 /** @class FilmViewer
  44  *  @brief A wx widget to view a Film.
  45  */
  46 class FilmViewer : public Signaller
  47 {
  48 public:
  49         FilmViewer (wxWindow *);
  50         ~FilmViewer ();
  51
  52         /** @return the window showing the film's video */
  53         wxWindow* panel () const {
  54                 return _video_view->get();
  55         }
  56
  57         VideoView const * video_view () const {
  58                 return _video_view;
  59         }
  60
  61         void show_closed_captions ();
  62
  63         void set_film (boost::shared_ptr<Film>);
  64         boost::shared_ptr<Film> film () const {
  65                 return _film;
  66         }
  67
  68         void seek (dcpomatic::DCPTime t, bool accurate);
  69         void seek (boost::shared_ptr<Content> content, dcpomatic::ContentTime p, bool accurate);
  70         void seek_by (dcpomatic::DCPTime by, bool accurate);
  71         /** @return our `playhead' position; this may not lie exactly on a frame boundary */
  72         dcpomatic::DCPTime position () const {
  73                 return _video_view->position();
  74         }
  75         dcpomatic::DCPTime one_video_frame () const;
  76
  77         void start ();
  78         bool stop ();
  79         void suspend ();
  80         void resume ();
  81
  82         bool playing () const {
  83                 return _playing;
  84         }
  85
  86         void set_coalesce_player_changes (bool c);
  87         void set_dcp_decode_reduction (boost::optional<int> reduction);
  88         boost::optional<int> dcp_decode_reduction () const;
  89         void set_outline_content (bool o);
  90         void set_eyes (Eyes e);
  91         void set_pad_black (bool p);
  92
  93         void slow_refresh ();
  94
  95         dcpomatic::DCPTime time () const;
  96         boost::optional<dcpomatic::DCPTime> audio_time () const;
  97
  98         int dropped () const;
  99         int gets () const;
 100
 101         int audio_callback (void* out, unsigned int frames);
 102
 103 #ifdef DCPOMATIC_VARIANT_SWAROOP
 104         void set_background_image (bool b) {
 105                 _background_image = b;
 106                 _video_view->update ();
 107         }
 108
 109         bool background_image () const {
 110                 return _background_image;
 111         }
 112 #endif
 113
 114         StateTimer const & state_timer () const {
 115                 return _video_view->state_timer ();
 116         }
 117
 118         /* Some accessors and utility methods that VideoView classes need */
 119         dcp::Size out_size () const {
 120                 return _out_size;
 121         }
 122         bool outline_content () const {
 123                 return _outline_content;
 124         }
 125         bool pad_black () const {
 126                 return _pad_black;
 127         }
 128         boost::shared_ptr<Butler> butler () const {
 129                 return _butler;
 130         }
 131         ClosedCaptionsDialog* closed_captions_dialog () const {
 132                 return _closed_captions_dialog;
 133         }
 134
 135         boost::signals2::signal<void (boost::weak_ptr<PlayerVideo>)> ImageChanged;
 136         boost::signals2::signal<void (dcpomatic::DCPTime)> Started;
 137         boost::signals2::signal<void (dcpomatic::DCPTime)> Stopped;
 138         /** While playing back we reached the end of the film (emitted from GUI thread) */
 139         boost::signals2::signal<void ()> Finished;
 140         void emit_finished ();
 141
 142         boost::signals2::signal<bool ()> PlaybackPermitted;
 143
 144 private:
 145
 146         void video_view_sized ();
 147         void calculate_sizes ();
 148         void player_change (ChangeType type, int, bool);
 149         void idle_handler ();
 150         void request_idle_display_next_frame ();
 151         void film_change (ChangeType, Film::Property);
 152         void recreate_butler ();
 153         void config_changed (Config::Property);
 154         void film_length_change ();
 155
 156         dcpomatic::DCPTime uncorrected_time () const;
 157         Frame average_latency () const;
 158
 159         bool quick_refresh ();
 160
 161         boost::shared_ptr<Film> _film;
 162         boost::shared_ptr<Player> _player;
 163
 164         VideoView* _video_view;
 165         bool _coalesce_player_changes;
 166         std::list<int> _pending_player_changes;
 167
 168         /** Size of our output (including padding if we have any) */
 169         dcp::Size _out_size;
 170
 171         RtAudio _audio;
 172         int _audio_channels;
 173         unsigned int _audio_block_size;
 174         bool _playing;
 175         int _suspended;
 176         boost::shared_ptr<Butler> _butler;
 177
 178         std::list<Frame> _latency_history;
 179         /** Mutex to protect _latency_history */
 180         mutable boost::mutex _latency_history_mutex;
 181         int _latency_history_count;
 182
 183         boost::optional<int> _dcp_decode_reduction;
 184
 185         ClosedCaptionsDialog* _closed_captions_dialog;
 186
 187         bool _outline_content;
 188         /** true to pad the viewer panel with black, false to use
 189             the normal window background colour.
 190         */
 191         bool _pad_black;
 192
 193 #ifdef DCPOMATIC_VARIANT_SWAROOP
 194         bool _background_image;
 195 #endif
 196
 197         /** true if an get() is required next time we are idle */
 198         bool _idle_get;
 199
 200         boost::signals2::scoped_connection _config_changed_connection;
 201 };