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
  61         void refresh ();
  62
  63         int audio_callback (void* out, unsigned int frames);
  64
  65         boost::signals2::signal<void (boost::weak_ptr<PlayerVideo>)> ImageChanged;
  66
  67 private:
  68         void paint_panel ();
  69         void panel_sized (wxSizeEvent &);
  70         void slider_moved (bool update_slider);
  71         void play_clicked ();
  72         void timer ();
  73         void calculate_sizes ();
  74         void check_play_state ();
  75         void active_jobs_changed (boost::optional<std::string>);
  76         void back_clicked (wxMouseEvent &);
  77         void forward_clicked (wxMouseEvent &);
  78         void player_changed (bool);
  79         void update_position_label ();
  80         void update_position_slider ();
  81         void get ();
  82         void seek (DCPTime t, bool accurate);
  83         void refresh_panel ();
  84         void setup_sensitivity ();
  85         void film_changed (Film::Property);
  86         DCPTime nudge_amount (wxMouseEvent &);
  87         void timecode_clicked ();
  88         void frame_number_clicked ();
  89         void go_to (DCPTime t);
  90         void jump_to_selected_clicked ();
  91         void recreate_butler ();
  92         void config_changed (Config::Property);
  93         DCPTime time () const;
  94         void start ();
  95         bool stop ();
  96         Frame average_latency () const;
  97
  98         boost::shared_ptr<Film> _film;
  99         boost::shared_ptr<Player> _player;
 100
 101         wxSizer* _v_sizer;
 102         /** The area that we put our image in */
 103         wxPanel* _panel;
 104         wxCheckBox* _outline_content;
 105         wxRadioButton* _left_eye;
 106         wxRadioButton* _right_eye;
 107         wxCheckBox* _jump_to_selected;
 108         wxSlider* _slider;
 109         wxButton* _back_button;
 110         wxButton* _forward_button;
 111         wxStaticText* _frame_number;
 112         wxStaticText* _timecode;
 113         wxToggleButton* _play_button;
 114         wxTimer _timer;
 115         bool _coalesce_player_changes;
 116         bool _pending_player_change;
 117
 118         boost::shared_ptr<const Image> _frame;
 119         DCPTime _video_position;
 120         Position<int> _inter_position;
 121         dcp::Size _inter_size;
 122
 123         /** Size of our output (including padding if we have any) */
 124         dcp::Size _out_size;
 125         /** Size of the panel that we have available */
 126         dcp::Size _panel_size;
 127         /** true if the last call to Player::seek() was specified to be accurate;
 128          *  this is used so that when re-fetching the current frame we
 129          *  can get the same one that we got last time.
 130          */
 131         bool _last_seek_accurate;
 132
 133         RtAudio _audio;
 134         int _audio_channels;
 135         unsigned int _audio_block_size;
 136         bool _playing;
 137         boost::shared_ptr<Butler> _butler;
 138
 139         std::list<Frame> _latency_history;
 140         /** Mutex to protect _latency_history */
 141         mutable boost::mutex _latency_history_mutex;
 142         int _latency_history_count;
 143
 144         boost::signals2::scoped_connection _config_changed_connection;
 145 };