src/wx/film_viewer.h

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