summaryrefslogtreecommitdiff
path: root/src/wx/film_viewer.h
blob: 68d51bfbded2accec2137ad088f2d173267f59e1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/*
    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 wxToggleButton;
class FFmpegPlayer;
class Image;
class RGBPlusAlphaImage;
class Subtitle;

/** @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 (boost::shared_ptr<Film>, wxWindow *);

	void set_film (boost::shared_ptr<Film>);

private:
	void film_changed (Film::Property);
	void film_content_changed (boost::weak_ptr<Content>, int);
	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<const Image>, bool, boost::shared_ptr<Subtitle>, Time);
	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);
	void back_clicked (wxCommandEvent &);
	void forward_clicked (wxCommandEvent &);

	boost::shared_ptr<Film> _film;
	boost::shared_ptr<Player> _player;

	wxSizer* _v_sizer;
	wxPanel* _panel;
	wxSlider* _slider;
	wxButton* _back_button;
	wxButton* _forward_button;
	wxStaticText* _frame;
	wxStaticText* _timecode;
	wxToggleButton* _play_button;
	wxTimer _timer;

	boost::shared_ptr<const Image> _raw_frame;
	boost::shared_ptr<Subtitle> _raw_sub;
	boost::shared_ptr<const Image> _display_frame;
	/* The x offset at which we display the actual film content; this corresponds
	   to the film's padding converted to our coordinates.
	*/
	int _display_frame_x;
	boost::shared_ptr<RGBPlusAlphaImage> _display_sub;
	Position _display_sub_position;
	bool _got_frame;

	/** 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;
};