+/*
+ Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
+/** @file src/film_viewer.h
+ * @brief A wx widget to view `thumbnails' of a Film.
+ */
+
#include <wx/wx.h>
+#include "lib/film.h"
-class Film;
-class ThumbPanel;
+class wxToggleButton;
+class FFmpegPlayer;
+class Image;
+class RGBPlusAlphaImage;
+class Subtitle;
-class FilmViewer
+/** @class FilmViewer
+ * @brief A wx widget to view a preview of a Film.
+ *
+ * The film takes the following path through the viewer:
+ *
+ * 1. get_frame() asks our _player to decode some data. If it does, process_video()
+ * will be called.
+ *
+ * 2. process_video() takes the image and subtitle from the decoder (_raw_frame and _raw_sub)
+ * and calls raw_to_display().
+ *
+ * 3. raw_to_display() copies _raw_frame to _display_frame, processing it and scaling it.
+ *
+ * 4. calling _panel->Refresh() and _panel->Update() results in paint_panel() being called;
+ * this creates frame_bitmap from _display_frame and blits it to the display. It also
+ * blits the subtitle, if required.
+ *
+ * update_from_decoder() asks the player to re-emit its current frame on the next pass(), and then
+ * starts from step #1.
+ *
+ * update_from_raw() starts at step #3, then calls _panel->Refresh and _panel->Update.
+ */
+class FilmViewer : public wxPanel
{
public:
- FilmViewer (Film *, wxFrame *);
+ FilmViewer (boost::shared_ptr<Film>, wxWindow *);
- void load_thumbnail (int);
- wxPanel* get_widget ();
+ void set_film (boost::shared_ptr<Film>);
private:
- Film* _film;
+ void film_changed (Film::Property);
+ void paint_panel (wxPaintEvent &);
+ void panel_sized (wxSizeEvent &);
+ void slider_moved (wxScrollEvent &);
+ void play_clicked (wxCommandEvent &);
+ void timer (wxTimerEvent &);
+ void process_video (boost::shared_ptr<Image>, bool, boost::shared_ptr<Subtitle>);
+ void calculate_sizes ();
+ void check_play_state ();
+ void update_from_raw ();
+ void update_from_decoder ();
+ void raw_to_display ();
+ void get_frame ();
+ void active_jobs_changed (bool);
+
+ boost::shared_ptr<Film> _film;
+ boost::shared_ptr<Player> _player;
+
+ wxSizer* _v_sizer;
+ wxPanel* _panel;
+ wxSlider* _slider;
+ wxToggleButton* _play_button;
+ wxTimer _timer;
+
+ boost::shared_ptr<Image> _raw_frame;
+ boost::shared_ptr<Subtitle> _raw_sub;
+ boost::shared_ptr<Image> _display_frame;
+ int _display_frame_x;
+ boost::shared_ptr<RGBPlusAlphaImage> _display_sub;
+ Position _display_sub_position;
+ bool _got_frame;
- wxImage* _image;
- wxImage* _scaled_image;
- wxBitmap* _bitmap;
- ThumbPanel* _thumb_panel;
+ /** Size of our output (including padding if we have any) */
+ libdcp::Size _out_size;
+ /** Size that we will make our film (equal to _out_size unless we have padding) */
+ libdcp::Size _film_size;
+ /** Size of the panel that we have available */
+ libdcp::Size _panel_size;
};