src/wx/film_viewer.h

   1 /*
   2     Copyright (C) 2012-2017 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 A wx widget to view `thumbnails' of a Film.
  23  */
  24
  25 #include "lib/film.h"
  26 #include "lib/config.h"
  27 #include <RtAudio.h>
  28 #include <wx/wx.h>
  29
  30 class wxToggleButton;
  31 class FFmpegPlayer;
  32 class Image;
  33 class RGBPlusAlphaImage;
  34 class PlayerVideo;
  35 class Player;
  36 class Butler;
  37
  38 /** @class FilmViewer
  39  *  @brief A wx widget to view a preview of a Film.
  40  */
  41 class FilmViewer : public wxPanel
  42 {
  43 public:
  44         FilmViewer (wxWindow *, bool outline_content = true, bool jump_to_selected = true);
  45         ~FilmViewer ();
  46
  47         void set_film (boost::shared_ptr<Film>);
  48         boost::shared_ptr<Film> film () const {
  49                 return _film;
  50         }
  51
  52         /** @return our `playhead' position; this may not lie exactly on a frame boundary */
  53         DCPTime position () const {
  54                 return _video_position;
  55         }
  56
  57         void set_position (DCPTime p);
  58         void set_coalesce_player_changes (bool c);
  59         void set_dcp_decode_reduction (boost::optional<int> reduction);
  60         boost::optional<int> dcp_decode_reduction () const;
  61
  62         void slow_refresh ();
  63         bool quick_refresh ();
  64
  65         int dropped () const {
  66                 return _dropped;
  67         }
  68
  69         void start ();
  70         bool stop ();
  71         bool playing () const {
  72                 return _playing;
  73         }
  74
  75         void back_frame ();
  76         void forward_frame ();
  77
  78         int audio_callback (void* out, unsigned int frames);
  79
  80         boost::signals2::signal<void (boost::weak_ptr<PlayerVideo>)> ImageChanged;
  81
  82 private:
  83         void paint_panel ();
  84         void panel_sized (wxSizeEvent &);
  85         void slider_moved (bool page);
  86         void slider_released ();
  87         void play_clicked ();
  88         void timer ();
  89         void calculate_sizes ();
  90         void check_play_state ();
  91         void active_jobs_changed (boost::optional<std::string>);
  92         void rewind_clicked (wxMouseEvent &);
  93         void back_clicked (wxKeyboardState& s);
  94         void forward_clicked (wxKeyboardState &);
  95         void player_changed (int, bool);
  96         void update_position_label ();
  97         void update_position_slider ();
  98         void get ();
  99         void display_player_video ();
 100         void seek (DCPTime t, bool accurate);
 101         void refresh_panel ();
 102         void setup_sensitivity ();
 103         void film_changed (Film::Property);
 104         DCPTime nudge_amount (wxKeyboardState &);
 105         void timecode_clicked ();
 106         void frame_number_clicked ();
 107         void go_to (DCPTime t);
 108         void jump_to_selected_clicked ();
 109         void recreate_butler ();
 110         void config_changed (Config::Property);
 111         DCPTime time () const;
 112         Frame average_latency () const;
 113         DCPTime one_video_frame () const;
 114
 115         boost::shared_ptr<Film> _film;
 116         boost::shared_ptr<Player> _player;
 117
 118         wxSizer* _v_sizer;
 119         /** The area that we put our image in */
 120         wxPanel* _panel;
 121         wxCheckBox* _outline_content;
 122         wxRadioButton* _left_eye;
 123         wxRadioButton* _right_eye;
 124         wxCheckBox* _jump_to_selected;
 125         wxSlider* _slider;
 126         wxButton* _rewind_button;
 127         wxButton* _back_button;
 128         wxButton* _forward_button;
 129         wxStaticText* _frame_number;
 130         wxStaticText* _timecode;
 131         wxToggleButton* _play_button;
 132         wxTimer _timer;
 133         bool _coalesce_player_changes;
 134         std::list<int> _pending_player_changes;
 135         bool _slider_being_moved;
 136         bool _was_running_before_slider;
 137
 138         std::pair<boost::shared_ptr<PlayerVideo>, DCPTime> _player_video;
 139         boost::shared_ptr<const Image> _frame;
 140         DCPTime _video_position;
 141         Position<int> _inter_position;
 142         dcp::Size _inter_size;
 143
 144         /** Size of our output (including padding if we have any) */
 145         dcp::Size _out_size;
 146         /** Size of the panel that we have available */
 147         dcp::Size _panel_size;
 148
 149         RtAudio _audio;
 150         int _audio_channels;
 151         unsigned int _audio_block_size;
 152         bool _playing;
 153         boost::shared_ptr<Butler> _butler;
 154
 155         std::list<Frame> _latency_history;
 156         /** Mutex to protect _latency_history */
 157         mutable boost::mutex _latency_history_mutex;
 158         int _latency_history_count;
 159
 160         int _dropped;
 161         boost::optional<int> _dcp_decode_reduction;
 162
 163         boost::signals2::scoped_connection _config_changed_connection;
 164 };