Unholy melange of stuff; setup a standard test config; send / receive subs to / from...
[dcpomatic.git] / src / wx / film_viewer.cc
1 /*
2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 /** @file  src/film_viewer.cc
21  *  @brief A wx widget to view `thumbnails' of a Film.
22  */
23
24 #include <iostream>
25 #include <iomanip>
26 #include "lib/film.h"
27 #include "lib/format.h"
28 #include "lib/util.h"
29 #include "lib/thumbs_job.h"
30 #include "lib/job_manager.h"
31 #include "lib/film_state.h"
32 #include "lib/options.h"
33 #include "lib/subtitle.h"
34 #include "film_viewer.h"
35 #include "wx_util.h"
36
37 using namespace std;
38 using namespace boost;
39
40 class ThumbPanel : public wxPanel
41 {
42 public:
43         ThumbPanel (wxPanel* parent, Film* film)
44                 : wxPanel (parent)
45                 , _film (film)
46                 , _frame_rebuild_needed (false)
47                 , _composition_needed (false)
48         {}
49
50         /** Handle a paint event */
51         void paint_event (wxPaintEvent& ev)
52         {
53                 if (!_film || _film->num_thumbs() == 0) {
54                         wxPaintDC dc (this);
55                         return;
56                 }
57
58                 if (_frame_rebuild_needed) {
59                         _image.reset (new wxImage (std_to_wx (_film->thumb_file (_index))));
60
61                         _subtitle.reset ();
62                         pair<Position, string> s = _film->thumb_subtitle (_index);
63                         if (!s.second.empty ()) {
64                                 _subtitle.reset (new SubtitleView (s.first, std_to_wx (s.second)));
65                         }
66
67                         _frame_rebuild_needed = false;
68                         compose ();
69                 }
70
71                 if (_composition_needed) {
72                         compose ();
73                 }
74
75                 wxPaintDC dc (this);
76                 if (_bitmap) {
77                         dc.DrawBitmap (*_bitmap, 0, 0, false);
78                 }
79
80                 if (_film->with_subtitles() && _subtitle) {
81                         dc.DrawBitmap (*_subtitle->bitmap, _subtitle->transformed_area.x, _subtitle->transformed_area.y, true);
82                 }
83         }
84
85         /** Handle a size event */
86         void size_event (wxSizeEvent &)
87         {
88                 if (!_image) {
89                         return;
90                 }
91
92                 recompose ();
93         }
94
95         /** @param n Thumbnail index */
96         void set (int n)
97         {
98                 _index = n;
99                 _frame_rebuild_needed = true;
100                 Refresh ();
101         }
102
103         void set_film (Film* f)
104         {
105                 _film = f;
106                 if (!_film) {
107                         clear ();
108                         _frame_rebuild_needed = true;
109                         Refresh ();
110                 } else {
111                         _frame_rebuild_needed = true;
112                         Refresh ();
113                 }
114         }
115
116         /** Clear our thumbnail image */
117         void clear ()
118         {
119                 _bitmap.reset ();
120                 _image.reset ();
121                 _subtitle.reset ();
122         }
123
124         void recompose ()
125         {
126                 _composition_needed = true;
127                 Refresh ();
128         }
129
130         DECLARE_EVENT_TABLE ();
131
132 private:
133
134         void compose ()
135         {
136                 _composition_needed = false;
137                 
138                 if (!_film || !_image) {
139                         return;
140                 }
141
142                 /* Size of the view */
143                 int vw, vh;
144                 GetSize (&vw, &vh);
145
146                 /* Cropped rectangle */
147                 Rectangle cropped_area (
148                         _film->crop().left,
149                         _film->crop().top,
150                         _image->GetWidth() - (_film->crop().left + _film->crop().right),
151                         _image->GetHeight() - (_film->crop().top + _film->crop().bottom)
152                         );
153
154                 /* Target ratio */
155                 float const target = _film->format() ? _film->format()->ratio_as_float (_film) : 1.78;
156
157                 _transformed_image = _image->GetSubImage (wxRect (cropped_area.x, cropped_area.y, cropped_area.w, cropped_area.h));
158
159                 float x_scale = 1;
160                 float y_scale = 1;
161
162                 if ((float (vw) / vh) > target) {
163                         /* view is longer (horizontally) than the ratio; fit height */
164                         _transformed_image.Rescale (vh * target, vh, wxIMAGE_QUALITY_HIGH);
165                         x_scale = vh * target / cropped_area.w;
166                         y_scale = float (vh) / cropped_area.h;
167                 } else {
168                         /* view is shorter (horizontally) than the ratio; fit width */
169                         _transformed_image.Rescale (vw, vw / target, wxIMAGE_QUALITY_HIGH);
170                         x_scale = float (vw) / cropped_area.w;
171                         y_scale = (vw / target) / cropped_area.h;
172                 }
173
174                 _bitmap.reset (new wxBitmap (_transformed_image));
175
176                 if (_subtitle) {
177
178                         _subtitle->transformed_area = subtitle_transformed_area (
179                                 x_scale, y_scale, _subtitle->base_area, _film->subtitle_offset(), _film->subtitle_scale()
180                                 );
181
182                         _subtitle->transformed_image = _subtitle->base_image;
183                         _subtitle->transformed_image.Rescale (_subtitle->transformed_area.w, _subtitle->transformed_area.h, wxIMAGE_QUALITY_HIGH);
184                         _subtitle->transformed_area.x -= _film->crop().left;
185                         _subtitle->transformed_area.y -= _film->crop().top;
186                         _subtitle->bitmap.reset (new wxBitmap (_subtitle->transformed_image));
187                 }
188         }
189
190         Film* _film;
191         shared_ptr<wxImage> _image;
192         wxImage _transformed_image;
193         /** currently-displayed thumbnail index */
194         int _index;
195         shared_ptr<wxBitmap> _bitmap;
196         bool _frame_rebuild_needed;
197         bool _composition_needed;
198
199         struct SubtitleView
200         {
201                 SubtitleView (Position p, wxString const & i)
202                         : base_image (i)
203                 {
204                         base_area.x = p.x;
205                         base_area.y = p.y;
206                         base_area.w = base_image.GetWidth ();
207                         base_area.h = base_image.GetHeight ();
208                 }
209
210                 Rectangle base_area;
211                 Rectangle transformed_area;
212                 wxImage base_image;
213                 wxImage transformed_image;
214                 shared_ptr<wxBitmap> bitmap;
215         };
216
217         shared_ptr<SubtitleView> _subtitle;
218 };
219
220 BEGIN_EVENT_TABLE (ThumbPanel, wxPanel)
221 EVT_PAINT (ThumbPanel::paint_event)
222 EVT_SIZE (ThumbPanel::size_event)
223 END_EVENT_TABLE ()
224
225 FilmViewer::FilmViewer (Film* f, wxWindow* p)
226         : wxPanel (p)
227         , _film (0)
228 {
229         _sizer = new wxBoxSizer (wxVERTICAL);
230         SetSizer (_sizer);
231         
232         _thumb_panel = new ThumbPanel (this, f);
233         _sizer->Add (_thumb_panel, 1, wxEXPAND);
234
235         int const max = f ? f->num_thumbs() - 1 : 0;
236         _slider = new wxSlider (this, wxID_ANY, 0, 0, max);
237         _sizer->Add (_slider, 0, wxEXPAND | wxLEFT | wxRIGHT);
238         set_thumbnail (0);
239
240         _slider->Connect (wxID_ANY, wxEVT_COMMAND_SLIDER_UPDATED, wxCommandEventHandler (FilmViewer::slider_changed), 0, this);
241
242         set_film (_film);
243 }
244
245 void
246 FilmViewer::set_thumbnail (int n)
247 {
248         if (_film == 0 || _film->num_thumbs() <= n) {
249                 return;
250         }
251
252         _thumb_panel->set (n);
253 }
254
255 void
256 FilmViewer::slider_changed (wxCommandEvent &)
257 {
258         set_thumbnail (_slider->GetValue ());
259 }
260
261 void
262 FilmViewer::film_changed (Film::Property p)
263 {
264         switch (p) {
265         case Film::THUMBS:
266                 if (_film && _film->num_thumbs() > 1) {
267                         _slider->SetRange (0, _film->num_thumbs () - 1);
268                 } else {
269                         _thumb_panel->clear ();
270                         _slider->SetRange (0, 1);
271                 }
272                 
273                 _slider->SetValue (0);
274                 set_thumbnail (0);
275                 break;
276         case Film::CONTENT:
277                 setup_visibility ();
278                 _film->examine_content ();
279                 update_thumbs ();
280                 break;
281         case Film::CROP:
282         case Film::FORMAT:
283         case Film::WITH_SUBTITLES:
284         case Film::SUBTITLE_OFFSET:
285         case Film::SUBTITLE_SCALE:
286                 _thumb_panel->recompose ();
287                 break;
288         default:
289                 break;
290         }
291 }
292
293 void
294 FilmViewer::set_film (Film* f)
295 {
296         if (_film == f) {
297                 return;
298         }
299         
300         _film = f;
301         _thumb_panel->set_film (_film);
302
303         if (!_film) {
304                 return;
305         }
306
307         _film->Changed.connect (sigc::mem_fun (*this, &FilmViewer::film_changed));
308         film_changed (Film::CROP);
309         film_changed (Film::THUMBS);
310         setup_visibility ();
311 }
312
313 void
314 FilmViewer::update_thumbs ()
315 {
316         if (!_film) {
317                 return;
318         }
319
320         _film->update_thumbs_pre_gui ();
321
322         shared_ptr<const FilmState> s = _film->state_copy ();
323         shared_ptr<Options> o (new Options (s->dir ("thumbs"), ".png", ""));
324         o->out_size = _film->size ();
325         o->apply_crop = false;
326         o->decode_audio = false;
327         o->decode_video_frequency = 128;
328         o->decode_subtitles = true;
329         
330         shared_ptr<Job> j (new ThumbsJob (s, o, _film->log(), shared_ptr<Job> ()));
331         j->Finished.connect (sigc::mem_fun (_film, &Film::update_thumbs_post_gui));
332         JobManager::instance()->add (j);
333 }
334
335 void
336 FilmViewer::setup_visibility ()
337 {
338         if (!_film) {
339                 return;
340         }
341
342         ContentType const c = _film->content_type ();
343         _slider->Show (c == VIDEO);
344 }