Read LayoutRes headers and support editing them

Initial support for LayoutRes. Allow editing the values in the
properties and respect them in the visual tools. However, resolution
resampling and the resolution mismatch dialogs still need to be
adjusted.

Author: arch1t3cht

src/ass_file.cpp

@@ -21,7 +21,10 @@
 #include "ass_info.h"
 #include "ass_style.h"
 #include "ass_style_storage.h"
+#include "async_video_provider.h"
 #include "options.h"
+#include "project.h"
+#include "include/aegisub/context.h"
 
 #include <algorithm>
 #include <boost/algorithm/string/case_conv.hpp>
@@ -152,6 +155,23 @@ void AssFile::GetResolution(int &sw, int &sh) const {
 		sh = sw == 1280 ? 1024 : sw * 3 / 4;
 }
 
+void AssFile::GetLayoutResolution(int &lw, int &lh) const {
+	lw = GetScriptInfoAsInt("LayoutResX");
+	lh = GetScriptInfoAsInt("LayoutResY");
+}
+
+void AssFile::GetEffectiveLayoutResolution(agi::Context *c, int &lw, int &lh) const {
+	GetLayoutResolution(lw, lh);
+	if (lw == 0 || lh == 0) {
+		if (c->project->VideoProvider()) {
+			lw = c->project->VideoProvider()->GetWidth();
+			lh = c->project->VideoProvider()->GetHeight();
+		} else {
+			GetResolution(lw, lh);
+		}
+	}
+}
+
 std::vector<std::string> AssFile::GetStyles() const {
 	std::vector<std::string> styles;
 	for (auto& style : Styles)

src/ass_file.h

@@ -44,6 +44,7 @@ class AssDialogue;
 class AssInfo;
 class AssStyle;
 class wxString;
+namespace agi { struct Context; }
 
 template<typename T>
 using EntryList = typename boost::intrusive::make_list<T, boost::intrusive::constant_time_size<false>, boost::intrusive::base_hook<AssEntryListHook>>::type;
@@ -127,6 +128,14 @@ class AssFile {
 	/// @param[out] w Width
 	/// @param[in] h Height
 	void GetResolution(int &w,int &h) const;
+	/// @brief Get the specified layout resolution, if present, or 0 if it is not present
+	/// @param[out] w Width
+	/// @param[in] h Height
+	void GetLayoutResolution(int &w,int &h) const;
+	/// @brief Get the effective layout resolution (i.e. falling back to the video resolution, if present)
+	/// @param[out] w Width
+	/// @param[in] h Height
+	void GetEffectiveLayoutResolution(agi::Context *c, int &w,int &h) const;
 	/// Get the value in a [Script Info] key as int, or 0 if it is not present
 	int GetScriptInfoAsInt(std::string_view key) const;
 	/// Get the value in a [Script Info] key as string.

src/dialog_properties.cpp

@@ -36,6 +36,7 @@
 #include "project.h"
 #include "resolution_resampler.h"
 #include "validators.h"
+#include "video_controller.h"
 
 #include <boost/algorithm/string/predicate.hpp>
 #include <vector>
@@ -59,13 +60,17 @@ class DialogProperties {
 	wxComboBox *WrapStyle;   ///< Wrapping style for long lines
 	wxTextCtrl *ResX;        ///< Script x resolution
 	wxTextCtrl *ResY;        ///< Script y resolution
+	wxTextCtrl *LayoutResX;  ///< Layout x resolution
+	wxTextCtrl *LayoutResY;  ///< Layout y resolution
 	wxCheckBox *ScaleBorder; ///< If script resolution != video resolution how should borders be handled
 	wxComboBox *YCbCrMatrix;
 
 	/// OK button handler
 	void OnOK(wxCommandEvent &event);
 	/// Set script resolution to video resolution button
 	void OnSetFromVideo(wxCommandEvent &event);
+	/// Set layout resolution to video resolution button
+	void OnSetLayoutResFromVideo(wxCommandEvent &event);
 	/// Set a script info field
 	/// @param key Name of field
 	/// @param value New value
@@ -119,18 +124,36 @@ DialogProperties::DialogProperties(agi::Context *c)
 	ResX = new wxTextCtrl(&d,-1,"",wxDefaultPosition,wxDefaultSize,0,IntValidator(c->ass->GetScriptInfoAsInt("PlayResX")));
 	ResY = new wxTextCtrl(&d,-1,"",wxDefaultPosition,wxDefaultSize,0,IntValidator(c->ass->GetScriptInfoAsInt("PlayResY")));
 
+	LayoutResX = new wxTextCtrl(&d,-1,"",wxDefaultPosition,wxDefaultSize,0,IntValidator(c->ass->GetScriptInfoAsInt("LayoutResX")));
+	LayoutResY = new wxTextCtrl(&d,-1,"",wxDefaultPosition,wxDefaultSize,0,IntValidator(c->ass->GetScriptInfoAsInt("LayoutResY")));
+
 	wxButton *FromVideo = new wxButton(&d,-1,_("From &video"));
 	if (!c->project->VideoProvider())
 		FromVideo->Enable(false);
 	else
 		FromVideo->Bind(wxEVT_BUTTON, &DialogProperties::OnSetFromVideo, this);
 
-	auto res_sizer = new wxBoxSizer(wxHORIZONTAL);
-	res_sizer->Add(ResX, 1, wxRIGHT | wxALIGN_CENTER_VERTICAL, 5);
-	res_sizer->Add(new wxStaticText(&d, -1, _(L"\u00D7")), 0, wxALIGN_CENTER | wxRIGHT, 5); // U+00D7 multiplication sign
-	res_sizer->Add(ResY, 1, wxRIGHT | wxALIGN_CENTER_VERTICAL, 5);
+	auto res_sizer = new wxFlexGridSizer(5, 5, 5);
+	res_sizer->AddGrowableCol(1, 1);
+	res_sizer->AddGrowableCol(3, 1);
+	res_sizer->Add(new wxStaticText(&d, -1, _("Script: ")), wxSizerFlags().Center().Left());
+	res_sizer->Add(ResX, 1, wxRIGHT | wxALIGN_CENTER_VERTICAL | wxEXPAND, 2);
+	res_sizer->Add(new wxStaticText(&d, -1, _(L"\u00D7")), 0, wxALIGN_CENTER | wxRIGHT, 2); // U+00D7 multiplication sign
+	res_sizer->Add(ResY, 1, wxRIGHT | wxALIGN_CENTER_VERTICAL | wxEXPAND, 2);
 	res_sizer->Add(FromVideo, 1, 0, 0);
 
+	wxButton *LayoutResFromVideo = new wxButton(&d,-1,_("From video"));
+	if (!c->project->VideoProvider())
+		LayoutResFromVideo->Enable(false);
+	else
+		LayoutResFromVideo->Bind(wxEVT_BUTTON, &DialogProperties::OnSetLayoutResFromVideo, this);
+
+	res_sizer->Add(new wxStaticText(&d, -1, _("Layout: ")), wxSizerFlags().Center().Left());
+	res_sizer->Add(LayoutResX, 1, wxRIGHT | wxALIGN_CENTER_VERTICAL | wxEXPAND, 2);
+	res_sizer->Add(new wxStaticText(&d, -1, _(L"\u00D7")), 0, wxALIGN_CENTER | wxRIGHT, 2); // U+00D7 multiplication sign
+	res_sizer->Add(LayoutResY, 1, wxRIGHT | wxALIGN_CENTER_VERTICAL | wxEXPAND, 2);
+	res_sizer->Add(LayoutResFromVideo, 1, 0, 0);
+
 	YCbCrMatrix = new wxComboBox(&d, -1, to_wx(c->ass->GetScriptInfo("YCbCr Matrix")),
 		 wxDefaultPosition, wxDefaultSize, to_wx(MatrixNames()), wxCB_READONLY);
 
@@ -189,6 +212,8 @@ void DialogProperties::OnOK(wxCommandEvent &) {
 
 	count += SetInfoIfDifferent("PlayResX", from_wx(ResX->GetValue()));
 	count += SetInfoIfDifferent("PlayResY", from_wx(ResY->GetValue()));
+	count += SetInfoIfDifferent("LayoutResX", from_wx(LayoutResX->GetValue()));
+	count += SetInfoIfDifferent("LayoutResY", from_wx(LayoutResY->GetValue()));
 	count += SetInfoIfDifferent("WrapStyle", std::to_string(WrapStyle->GetSelection()));
 	count += SetInfoIfDifferent("ScaledBorderAndShadow", ScaleBorder->GetValue() ? "yes" : "no");
 	count += SetInfoIfDifferent("YCbCr Matrix", from_wx(YCbCrMatrix->GetValue()));
@@ -206,9 +231,28 @@ int DialogProperties::SetInfoIfDifferent(std::string_view key, std::string_view
 	return 0;
 }
 
+std::pair<int, int> GetVideoDisplayResolution(agi::Context *c) {
+	double dar = c->videoController->GetAspectRatioValue();
+	int width = c->project->VideoProvider()->GetWidth();
+	int height = c->project->VideoProvider()->GetHeight();
+	double sar = double(width) / double(height);
+
+	return std::make_pair(
+		width * std::max(1., dar / sar),
+		height * std::max(1., sar / dar)
+	);
+}
+
 void DialogProperties::OnSetFromVideo(wxCommandEvent &) {
-	ResX->SetValue(std::to_wstring(c->project->VideoProvider()->GetWidth()));
-	ResY->SetValue(std::to_wstring(c->project->VideoProvider()->GetHeight()));
+	auto [width, height] = GetVideoDisplayResolution(c);
+	ResX->SetValue(std::to_wstring(width));
+	ResY->SetValue(std::to_wstring(height));
+}
+
+void DialogProperties::OnSetLayoutResFromVideo(wxCommandEvent &) {
+	auto [width, height] = GetVideoDisplayResolution(c);
+	LayoutResX->SetValue(std::to_wstring(width));
+	LayoutResY->SetValue(std::to_wstring(height));
 }
 }
 

src/gl_wrap.cpp

@@ -401,11 +401,11 @@ void OpenGLWrapper::SetScale(Vector2D scale) {
 	glScalef(scale.X() / 100.f, scale.Y() / 100.f, 1.f);
 }
 
-void OpenGLWrapper::SetRotation(float x, float y, float z) {
+void OpenGLWrapper::SetRotation(float x, float y, float z, float zScale) {
 	PrepareTransform();
 	float matrix[16] = { 2500, 0, 0, 0, 0, 2500, 0, 0, 0, 0, 1, 1, 0, 0, 2500, 2500 };
 	glMultMatrixf(matrix);
-	glScalef(1.f, 1.f, 8.f);
+	glScalef(1.f, 1.f, 8.f / zScale);
 	glRotatef(y, 0.f, -1.f, 0.f);
 	glRotatef(x, -1.f, 0.f, 0.f);
 	glRotatef(z, 0.f, 0.f, -1.f);

src/gl_wrap.h

@@ -48,7 +48,7 @@ class OpenGLWrapper {
 
 	void SetScale(Vector2D scale);
 	void SetOrigin(Vector2D origin);
-	void SetRotation(float x, float y, float z);
+	void SetRotation(float x, float y, float z, float zScale = 1);
 	void SetShear(float x, float y);
 	void ResetTransform();
 

src/visual_tool.cpp

@@ -55,23 +55,27 @@ VisualToolBase::VisualToolBase(VideoDisplay *parent, agi::Context *context)
 , shaded_area_alpha_opt(OPT_GET("Colour/Visual Tools/Shaded Area Alpha"))
 , file_changed_connection(c->ass->AddCommitListener(&VisualToolBase::OnCommit, this))
 {
-	int script_w, script_h;
-	c->ass->GetResolution(script_w, script_h);
-	script_res = Vector2D(script_w, script_h);
+	SetResolutions();
 	active_line = GetActiveDialogueLine();
 	connections.push_back(c->selectionController->AddActiveLineListener(&VisualToolBase::OnActiveLineChanged, this));
 	connections.push_back(c->videoController->AddSeekListener(&VisualToolBase::OnSeek, this));
 	parent->Bind(wxEVT_MOUSE_CAPTURE_LOST, &VisualToolBase::OnMouseCaptureLost, this);
 }
 
+void VisualToolBase::SetResolutions() {
+	int script_w, script_h, layout_w, layout_h;
+	c->ass->GetResolution(script_w, script_h);
+	c->ass->GetEffectiveLayoutResolution(c, layout_w, layout_h);
+	script_res = Vector2D(script_w, script_h);
+	layout_res = Vector2D(layout_w, layout_h);
+}
+
 void VisualToolBase::OnCommit(int type) {
 	holding = false;
 	dragging = false;
 
 	if (type == AssFile::COMMIT_NEW || type & AssFile::COMMIT_SCRIPTINFO) {
-		int script_w, script_h;
-		c->ass->GetResolution(script_w, script_h);
-		script_res = Vector2D(script_w, script_h);
+		SetResolutions();
 		OnCoordinateSystemsChanged();
 	}
 

src/visual_tool.h

@@ -43,6 +43,7 @@ namespace agi {
 /// functionality as possible is implemented here to avoid having four copies
 /// of each method for no good reason (and four times as many error messages)
 class VisualToolBase {
+	void SetResolutions();
 	void OnCommit(int type);
 	void OnSeek(int new_frame);
 
@@ -98,6 +99,7 @@ class VisualToolBase {
 	Vector2D mouse_pos; ///< Last seen mouse position
 	Vector2D drag_start; ///< Mouse position at the beginning of the last drag
 	Vector2D script_res; ///< Script resolution
+	Vector2D layout_res; ///< Layout resolution
 	Vector2D canvas_size; ///< The size of the display area
 	Vector2D video_pos; ///< Top-left corner of the video in the display area
 	Vector2D video_size; ///< Size of the video on screen. Not necessarily equal to the video resolution

src/visual_tool_rotatexy.cpp

@@ -50,7 +50,7 @@ void VisualToolRotateXY::Draw() {
 	// Transform grid
 	gl.SetOrigin(org->pos);
 	gl.SetScale(100 * video_size / script_res);
-	gl.SetRotation(angle_x, angle_y, angle_z);
+	gl.SetRotation(angle_x, angle_y, angle_z, script_res.Y() / layout_res.Y());
 	gl.SetScale(fsc);
 	gl.SetShear(fax, fay);