Basic implementation of extra subtitle-scan job to run when the

subtitle appearance dialogue is opened.  Fixes #1393.

5 files changed, 218 insertions, 30 deletions

diff --git a/src/lib/examine_ffmpeg_subtitles_job.cc b/src/lib/examine_ffmpeg_subtitles_job.cc
new file mode 100644
index 000000000..9197bdcbd
--- /dev/null
+++ b/src/lib/examine_ffmpeg_subtitles_job.cc
@@ -0,0 +1,106 @@
+/*
+    Copyright (C) 2019 Carl Hetherington <cth@carlh.net>
+
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic 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.
+
+    DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+#include "examine_ffmpeg_subtitles_job.h"
+#include "ffmpeg_content.h"
+#include "ffmpeg_subtitle_stream.h"
+#include "text_content.h"
+#include "cross.h"
+extern "C" {
+#include <libavcodec/avcodec.h>
+#include <libavformat/avformat.h>
+}
+#include <iostream>
+
+#include "i18n.h"
+
+using std::string;
+using std::cout;
+using boost::shared_ptr;
+
+ExamineFFmpegSubtitlesJob::ExamineFFmpegSubtitlesJob (shared_ptr<const Film> film, shared_ptr<FFmpegContent> c)
+	: Job (film)
+	, FFmpeg (c)
+	, _content (c)
+{
+
+}
+
+string
+ExamineFFmpegSubtitlesJob::name () const
+{
+	return _("Examining subtitles");
+}
+
+string
+ExamineFFmpegSubtitlesJob::json_name () const
+{
+	return N_("examine_subtitles");
+}
+
+void
+ExamineFFmpegSubtitlesJob::run ()
+{
+	dcpomatic_sleep (15);
+
+	int64_t const len = _file_group.length ();
+	while (true) {
+		int r = av_read_frame (_format_context, &_packet);
+		if (r < 0) {
+			break;
+		}
+
+		if (len > 0) {
+			set_progress (float(_format_context->pb->pos) / len);
+		} else {
+			set_progress_unknown ();
+		}
+
+		if (_content->subtitle_stream() && _content->subtitle_stream()->uses_index(_format_context, _packet.stream_index) && _content->only_text()->use()) {
+			int got_subtitle;
+			AVSubtitle sub;
+			if (avcodec_decode_subtitle2(subtitle_codec_context(), &sub, &got_subtitle, &_packet) >= 0 && got_subtitle) {
+				for (unsigned int i = 0; i < sub.num_rects; ++i) {
+					AVSubtitleRect const * rect = sub.rects[i];
+					if (rect->type == SUBTITLE_BITMAP) {
+#ifdef DCPOMATIC_HAVE_AVSUBTITLERECT_PICT
+						/* sub_p looks up into a BGRA palette which is here
+						   (i.e. first byte B, second G, third R, fourth A)
+						*/
+						uint32_t const * palette = (uint32_t *) rect->pict.data[1];
+#else
+						/* sub_p looks up into a BGRA palette which is here
+						   (i.e. first byte B, second G, third R, fourth A)
+						*/
+						uint32_t const * palette = (uint32_t *) rect->data[1];
+#endif
+						RGBA c ((palette[i] & 0xff0000) >> 16, (palette[i] & 0xff00) >> 8, palette[i] & 0xff, (palette[i] & 0xff000000) >> 24);
+						_content->subtitle_stream()->set_colour (c, c);
+					}
+				}
+			}
+		}
+
+		av_packet_unref (&_packet);
+	}
+
+	set_progress (1);
+	set_state (FINISHED_OK);
+}
diff --git a/src/lib/examine_ffmpeg_subtitles_job.h b/src/lib/examine_ffmpeg_subtitles_job.h
new file mode 100644
index 000000000..5960a9cc3
--- /dev/null
+++ b/src/lib/examine_ffmpeg_subtitles_job.h
@@ -0,0 +1,38 @@
+/*
+    Copyright (C) 2019 Carl Hetherington <cth@carlh.net>
+
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic 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.
+
+    DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+#include "job.h"
+#include "ffmpeg.h"
+#include <boost/shared_ptr.hpp>
+
+class FFmpegContent;
+
+class ExamineFFmpegSubtitlesJob : public Job, public FFmpeg
+{
+public:
+	ExamineFFmpegSubtitlesJob (boost::shared_ptr<const Film>, boost::shared_ptr<FFmpegContent>);
+
+	std::string name () const;
+	std::string json_name () const;
+	void run ();
+
+private:
+	boost::shared_ptr<FFmpegContent> _content;
+};
diff --git a/src/lib/wscript b/src/lib/wscript
index 9e20131a8..9bd07c67d 100644
--- a/src/lib/wscript
+++ b/src/lib/wscript
@@ -85,6 +85,7 @@ sources = """
           environment_info.cc
           event_history.cc
           examine_content_job.cc
+          examine_ffmpeg_subtitles_job.cc
           exceptions.cc
           file_group.cc
           file_log.cc
diff --git a/src/wx/subtitle_appearance_dialog.cc b/src/wx/subtitle_appearance_dialog.cc
index 69a7d743d..339388be6 100644
--- a/src/wx/subtitle_appearance_dialog.cc
+++ b/src/wx/subtitle_appearance_dialog.cc
@@ -27,12 +27,15 @@
 #include "lib/text_content.h"
 #include "lib/ffmpeg_subtitle_stream.h"
 #include "lib/ffmpeg_content.h"
+#include "lib/examine_ffmpeg_subtitles_job.h"
+#include "lib/job_manager.h"
 #include <wx/wx.h>
 #include <wx/clrpicker.h>
 #include <wx/spinctrl.h>
 #include <wx/gbsizer.h>
 
 using std::map;
+using std::string;
 using boost::shared_ptr;
 using boost::bind;
 using boost::dynamic_pointer_cast;
@@ -45,20 +48,26 @@ int const SubtitleAppearanceDialog::SHADOW = 2;
 SubtitleAppearanceDialog::SubtitleAppearanceDialog (wxWindow* parent, shared_ptr<const Film> film, shared_ptr<Content> content, shared_ptr<TextContent> caption)
 	: wxDialog (parent, wxID_ANY, _("Caption appearance"))
 	, _film (film)
+	, _finding (0)
 	, _content (content)
 	, _caption (caption)
 {
 	shared_ptr<FFmpegContent> ff = dynamic_pointer_cast<FFmpegContent> (content);
 	if (ff) {
 		_stream = ff->subtitle_stream ();
+		/* XXX: assuming that all FFmpeg streams have bitmap subs */
+		if (_stream->colours().empty()) {
+			_job_manager_connection = JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&SubtitleAppearanceDialog::active_jobs_changed, this, _1));
+			JobManager::instance()->add(shared_ptr<Job>(new ExamineFFmpegSubtitlesJob(film, ff)));
+		}
 	}
 
-	wxSizer* overall_sizer = new wxBoxSizer (wxVERTICAL);
-	SetSizer (overall_sizer);
+	_overall_sizer = new wxBoxSizer (wxVERTICAL);
+	SetSizer (_overall_sizer);
 
 	_table = new wxGridBagSizer (DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
 
-	overall_sizer->Add (_table, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
+	_overall_sizer->Add (_table, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
 
 	int r = 0;
 
@@ -83,48 +92,46 @@ SubtitleAppearanceDialog::SubtitleAppearanceDialog (wxWindow* parent, shared_ptr
 	_force_fade_out = set_to (_fade_out = new Timecode<ContentTime> (this), r);
 
 	if (_stream) {
-		wxScrolled<wxPanel>* colours_panel = new wxScrolled<wxPanel> (this);
-		colours_panel->EnableScrolling (false, true);
-		colours_panel->ShowScrollbars (wxSHOW_SB_NEVER, wxSHOW_SB_ALWAYS);
-		colours_panel->SetScrollRate (0, 16);
-
-		wxFlexGridSizer* table = new wxFlexGridSizer (2, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
-		table->AddGrowableCol (1, 1);
+		_colours_panel = new wxScrolled<wxPanel> (this);
+		_colours_panel->EnableScrolling (false, true);
+		_colours_panel->ShowScrollbars (wxSHOW_SB_NEVER, wxSHOW_SB_ALWAYS);
+		_colours_panel->SetScrollRate (0, 16);
 
-		map<RGBA, RGBA> colours = _stream->colours ();
+		_colour_table = new wxFlexGridSizer (2, DCPOMATIC_SIZER_X_GAP, DCPOMATIC_SIZER_Y_GAP);
+		_colour_table->AddGrowableCol (1, 1);
 
-		wxStaticText* t = new StaticText (colours_panel, "");
+		wxStaticText* t = new StaticText (_colours_panel, "");
 		t->SetLabelMarkup (_("<b>Original colour</b>"));
-		table->Add (t, 1, wxEXPAND);
-		t = new StaticText (colours_panel, "", wxDefaultPosition, wxDefaultSize, wxALIGN_CENTRE_HORIZONTAL);
+		_colour_table->Add (t, 1, wxEXPAND);
+		t = new StaticText (_colours_panel, "", wxDefaultPosition, wxDefaultSize, wxALIGN_CENTRE_HORIZONTAL);
 		t->SetLabelMarkup (_("<b>New colour</b>"));
-		table->Add (t, 1, wxALIGN_CENTER);
-
-		for (map<RGBA, RGBA>::const_iterator i = colours.begin(); i != colours.end(); ++i) {
-			wxPanel* from = new wxPanel (colours_panel, wxID_ANY);
-			from->SetBackgroundColour (wxColour (i->first.r, i->first.g, i->first.b, i->first.a));
-			table->Add (from, 1, wxEXPAND);
-			RGBAColourPicker* to = new RGBAColourPicker (colours_panel, i->second);
-			table->Add (to, 1, wxEXPAND);
-			_pickers[i->first] = to;
-		}
+		_colour_table->Add (t, 1, wxALIGN_CENTER);
 
-		colours_panel->SetSizer (table);
+		add_colours ();
 
-		overall_sizer->Add (colours_panel, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
+		_colours_panel->SetSizer (_colour_table);
+
+		/* XXX: still assuming that all FFmpeg streams have bitmap subs */
+		if (_stream->colours().empty()) {
+			_finding = new wxStaticText(this, wxID_ANY, _("Finding the colours in these subtitles..."));
+			_overall_sizer->Add (_finding, 0, wxALL, DCPOMATIC_DIALOG_BORDER);
+			_colours_panel->Show (false);
+		}
+
+		_overall_sizer->Add (_colours_panel, 1, wxEXPAND | wxALL, DCPOMATIC_DIALOG_BORDER);
 
 		wxButton* restore = new Button (this, _("Restore to original colours"));
 		restore->Bind (wxEVT_BUTTON, bind (&SubtitleAppearanceDialog::restore, this));
-		overall_sizer->Add (restore, 0, wxALL, DCPOMATIC_SIZER_X_GAP);
+		_overall_sizer->Add (restore, 0, wxALL, DCPOMATIC_SIZER_X_GAP);
 	}
 
 	wxSizer* buttons = CreateSeparatedButtonSizer (wxOK);
 	if (buttons) {
-		overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
+		_overall_sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
 	}
 
-	overall_sizer->Layout ();
-	overall_sizer->SetSizeHints (this);
+	_overall_sizer->Layout ();
+	_overall_sizer->SetSizeHints (this);
 
 	/* Keep these Appends() up to date with NONE/OUTLINE/SHADOW variables */
 	_effect->Append (_("None"));
@@ -295,3 +302,31 @@ SubtitleAppearanceDialog::setup_sensitivity ()
 		_outline_width->SetToolTip (_("Outline width cannot be set unless you are burning in captions"));
 	}
 }
+
+void
+SubtitleAppearanceDialog::active_jobs_changed (optional<string> last)
+{
+	if (last && *last == "examine_subtitles") {
+		_colours_panel->Show (true);
+		if (_finding) {
+			_finding->Show (false);
+		}
+		add_colours ();
+		_overall_sizer->Layout ();
+		_overall_sizer->SetSizeHints (this);
+	}
+}
+
+void
+SubtitleAppearanceDialog::add_colours ()
+{
+	map<RGBA, RGBA> colours = _stream->colours ();
+	for (map<RGBA, RGBA>::const_iterator i = colours.begin(); i != colours.end(); ++i) {
+		wxPanel* from = new wxPanel (_colours_panel, wxID_ANY);
+		from->SetBackgroundColour (wxColour (i->first.r, i->first.g, i->first.b, i->first.a));
+		_colour_table->Add (from, 1, wxEXPAND);
+		RGBAColourPicker* to = new RGBAColourPicker (_colours_panel, i->second);
+		_colour_table->Add (to, 1, wxEXPAND);
+		_pickers[i->first] = to;
+	}
+}
diff --git a/src/wx/subtitle_appearance_dialog.h b/src/wx/subtitle_appearance_dialog.h
index d02e283d9..ed0360e4c 100644
--- a/src/wx/subtitle_appearance_dialog.h
+++ b/src/wx/subtitle_appearance_dialog.h
@@ -46,6 +46,8 @@ private:
 	void restore ();
 	wxCheckBox* set_to (wxWindow* w, int& r);
 	void content_change (ChangeType type);
+	void active_jobs_changed (boost::optional<std::string> last);
+	void add_colours ();
 
 	boost::weak_ptr<const Film> _film;
 	wxCheckBox* _force_colour;
@@ -62,11 +64,17 @@ private:
 	wxGridBagSizer* _table;
 	std::map<RGBA, RGBAColourPicker*> _pickers;
 
+	wxBoxSizer* _overall_sizer;
+	wxScrolled<wxPanel>* _colours_panel;
+	wxStaticText* _finding;
+	wxFlexGridSizer* _colour_table;
+
 	boost::shared_ptr<Content> _content;
 	boost::shared_ptr<TextContent> _caption;
 	boost::shared_ptr<FFmpegSubtitleStream> _stream;
 
 	boost::signals2::scoped_connection _content_connection;
+	boost::signals2::scoped_connection _job_manager_connection;
 
 	static int const NONE;
 	static int const OUTLINE;