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         int dropped () const;
  96
  97         int audio_callback (void* out, unsigned int frames);
  98
  99 #ifdef DCPOMATIC_VARIANT_SWAROOP
 100         void set_background_image (bool b) {
 101                 _background_image = b;
 102                 refresh_view ();
 103         }
 104
 105         bool background_image () const {
 106                 return _background_image;
 107         }
 108 #endif
 109
 110         StateTimer const & state_timer () const {
 111                 return _state_timer;
 112         }
 113
 114         StateTimer& state_timer () {
 115                 return _state_timer;
 116         }
 117
 118         int gets () const {
 119                 return _gets;
 120         }
 121
 122         /* Some accessors and utility methods that VideoView classes need */
 123         dcp::Size out_size () const {
 124                 return _out_size;
 125         }
 126         dcp::Size inter_size () const {
 127                 return _inter_size;
 128         }
 129         bool outline_content () const {
 130                 return _outline_content;
 131         }
 132         bool pad_black () const {
 133                 return _pad_black;
 134         }
 135         boost::shared_ptr<Butler> butler () const {
 136                 return _butler;
 137         }
 138
 139         boost::signals2::signal<void (boost::weak_ptr<PlayerVideo>)> ImageChanged;
 140         boost::signals2::signal<void (dcpomatic::DCPTime)> Started;
 141         boost::signals2::signal<void (dcpomatic::DCPTime)> Stopped;
 142         /** While playing back we reached the end of the film (emitted from GUI thread) */
 143         boost::signals2::signal<void ()> Finished;
 144         void emit_finished ();
 145
 146         boost::signals2::signal<bool ()> PlaybackPermitted;
 147
 148 private:
 149
 150         /* XXX_b: to remove */
 151         friend class SimpleVideoView;
 152         friend class GLVideoView;
 153         friend class VideoView;
 154
 155         void video_view_sized ();
 156         void calculate_sizes ();
 157         void player_change (ChangeType type, int, bool);
 158         void idle_handler ();
 159         void request_idle_display_next_frame ();
 160         void film_change (ChangeType, Film::Property);
 161         void recreate_butler ();
 162         void config_changed (Config::Property);
 163         void film_length_change ();
 164
 165         dcpomatic::DCPTime time () const;
 166         boost::optional<dcpomatic::DCPTime> audio_time () const;
 167         dcpomatic::DCPTime uncorrected_time () const;
 168         Frame average_latency () const;
 169
 170         void refresh_view ();
 171         bool quick_refresh ();
 172
 173         boost::shared_ptr<Film> _film;
 174         boost::shared_ptr<Player> _player;
 175
 176         VideoView* _video_view;
 177         bool _coalesce_player_changes;
 178         std::list<int> _pending_player_changes;
 179
 180         dcp::Size _inter_size;
 181
 182         /** Size of our output (including padding if we have any) */
 183         dcp::Size _out_size;
 184
 185         RtAudio _audio;
 186         int _audio_channels;
 187         unsigned int _audio_block_size;
 188         bool _playing;
 189         int _suspended;
 190         boost::shared_ptr<Butler> _butler;
 191
 192         std::list<Frame> _latency_history;
 193         /** Mutex to protect _latency_history */
 194         mutable boost::mutex _latency_history_mutex;
 195         int _latency_history_count;
 196
 197         boost::optional<int> _dcp_decode_reduction;
 198
 199         ClosedCaptionsDialog* _closed_captions_dialog;
 200
 201         bool _outline_content;
 202         Eyes _eyes;
 203         /** true to pad the viewer panel with black, false to use
 204             the normal window background colour.
 205         */
 206         bool _pad_black;
 207
 208 #ifdef DCPOMATIC_VARIANT_SWAROOP
 209         bool _background_image;
 210 #endif
 211
 212         StateTimer _state_timer;
 213         int _gets;
 214
 215         /** true if an get() is required next time we are idle */
 216         bool _idle_get;
 217
 218         boost::signals2::scoped_connection _config_changed_connection;
 219 };