Split Format into Fixed and Variable so that sources can be unstretched.

5 files changed, 117 insertions, 69 deletions

diff --git a/src/lib/film.cc b/src/lib/film.cc
index 20edacf59..330ae9e5d 100644
--- a/src/lib/film.cc
+++ b/src/lib/film.cc
@@ -534,8 +534,8 @@ Film::make_dcp (bool transcode, int freq)
 	}
 	
 	o->decode_video_frequency = freq;
-	o->padding = format()->dcp_padding ();
-	o->ratio = format()->ratio_as_float ();
+	o->padding = format()->dcp_padding (this);
+	o->ratio = format()->ratio_as_float (this);
 
 	if (transcode) {
 		if (_state.dcp_ab) {
diff --git a/src/lib/format.cc b/src/lib/format.cc
index e689aa05d..115e03691 100644
--- a/src/lib/format.cc
+++ b/src/lib/format.cc
@@ -28,28 +28,15 @@
 #include <iomanip>
 #include <iostream>
 #include "format.h"
+#include "film.h"
 
 using namespace std;
 
 vector<Format const *> Format::_formats;
 
-/** @param r Ratio multiplied by 100 (e.g. 185)
- *  @param dcp Size (in pixels) of the images that we should put in a DCP.
- *  @param id ID (e.g. 185)
- *  @param n Nick name (e.g. Flat)
- */
-Format::Format (int r, Size dcp, string id, string n)
-	: _ratio (r)
-	, _dcp_size (dcp)
-	, _id (id)
-	, _nickname (n)
-{
-
-}
-
 /** @return A name to be presented to the user */
 string
-Format::name () const
+FixedFormat::name () const
 {
 	stringstream s;
 	if (!_nickname.empty ()) {
@@ -76,34 +63,18 @@ Format::as_metadata () const
 void
 Format::setup_formats ()
 {
-	_formats.push_back (new Format (119, Size (1285, 1080), "119", "1.19"));
-	_formats.push_back (new Format (133, Size (1436, 1080), "133", "1.33"));
-	_formats.push_back (new Format (138, Size (1485, 1080), "138", "1.375"));
-	_formats.push_back (new Format (133, Size (1998, 1080), "133-in-flat", "4:3 within Flat"));
-	_formats.push_back (new Format (137, Size (1480, 1080), "137", "Academy"));
-	_formats.push_back (new Format (166, Size (1793, 1080), "166", "1.66"));
-	_formats.push_back (new Format (166, Size (1998, 1080), "166-in-flat", "1.66 within Flat"));
-	_formats.push_back (new Format (178, Size (1998, 1080), "178-in-flat", "16:9 within Flat"));
-	_formats.push_back (new Format (185, Size (1998, 1080), "185", "Flat"));
-	_formats.push_back (new Format (239, Size (2048, 858), "239", "Scope"));
-}
-
-/** @param r Ratio multiplied by 100.
- *  @return Matching Format, or 0.
- */
-Format const *
-Format::from_ratio (int r)
-{
-	vector<Format const *>::iterator i = _formats.begin ();
-	while (i != _formats.end() && (*i)->ratio_as_integer() != r) {
-		++i;
-	}
-
-	if (i == _formats.end ()) {
-		return 0;
-	}
-
-	return *i;
+	_formats.push_back (new FixedFormat (119, Size (1285, 1080), "119", "1.19"));
+	_formats.push_back (new FixedFormat (133, Size (1436, 1080), "133", "1.33"));
+	_formats.push_back (new FixedFormat (138, Size (1485, 1080), "138", "1.375"));
+	_formats.push_back (new FixedFormat (133, Size (1998, 1080), "133-in-flat", "4:3 within Flat"));
+	_formats.push_back (new FixedFormat (137, Size (1480, 1080), "137", "Academy"));
+	_formats.push_back (new FixedFormat (166, Size (1793, 1080), "166", "1.66"));
+	_formats.push_back (new FixedFormat (166, Size (1998, 1080), "166-in-flat", "1.66 within Flat"));
+	_formats.push_back (new FixedFormat (178, Size (1998, 1080), "178-in-flat", "16:9 within Flat"));
+	_formats.push_back (new FixedFormat (185, Size (1998, 1080), "185", "Flat"));
+	_formats.push_back (new FixedFormat (239, Size (2048, 858), "239", "Scope"));
+	_formats.push_back (new VariableFormat (Size (1998, 1080), "var-185", "Flat"));
+	_formats.push_back (new VariableFormat (Size (2048, 858), "var-239", "Scope"));
 }
 
 /** @param n Nickname.
@@ -187,10 +158,22 @@ Format::all ()
 	return _formats;
 }
 
+/** @param r Ratio multiplied by 100 (e.g. 185)
+ *  @param dcp Size (in pixels) of the images that we should put in a DCP.
+ *  @param id ID (e.g. 185)
+ *  @param n Nick name (e.g. Flat)
+ */
+FixedFormat::FixedFormat (int r, Size dcp, string id, string n)
+	: Format (dcp, id, n)
+	, _ratio (r)
+{
+
+}
+
 int
-Format::dcp_padding () const
+Format::dcp_padding (Film const * f) const
 {
-	int p = rint ((_dcp_size.width - (_dcp_size.height * _ratio / 100.0)) / 2.0);
+	int p = rint ((_dcp_size.width - (_dcp_size.height * ratio_as_integer(f) / 100.0)) / 2.0);
 
 	/* This comes out -ve for Scope; bodge it */
 	if (p < 0) {
@@ -199,3 +182,39 @@ Format::dcp_padding () const
 	
 	return p;
 }
+
+VariableFormat::VariableFormat (Size dcp, string id, string n)
+	: Format (dcp, id, n)
+{
+
+}
+
+int
+VariableFormat::ratio_as_integer (Film const * f) const
+{
+	return rint (ratio_as_float (f) * 100);
+}
+
+float
+VariableFormat::ratio_as_float (Film const * f) const
+{
+	return float (f->size().width) / f->size().height;
+}
+
+/** @return A name to be presented to the user */
+string
+VariableFormat::name () const
+{
+	stringstream s;
+	if (!_nickname.empty ()) {
+		s << _nickname << " (";
+	}
+
+	s << "without stretching";
+
+	if (!_nickname.empty ()) {
+		s << ")";
+	}
+
+	return s.str ();
+}
diff --git a/src/lib/format.h b/src/lib/format.h
index 4b727b2e3..6172dc57d 100644
--- a/src/lib/format.h
+++ b/src/lib/format.h
@@ -18,7 +18,7 @@
 */
 
 /** @file src/format.h
- *  @brief Class to describe a format (aspect ratio) that a Film should
+ *  @brief Classes to describe a format (aspect ratio) that a Film should
  *  be shown in.
  */
 
@@ -26,26 +26,26 @@
 #include <vector>
 #include "util.h"
 
-/** @class Format
- *  @brief Class to describe a format (aspect ratio) that a Film should
- *  be shown in.
- */
+class Film;
+
 class Format
 {
 public:
-	Format (int, Size, std::string, std::string);
+	Format (Size dcp, std::string id, std::string n)
+		: _dcp_size (dcp)
+		, _id (id)
+		, _nickname (n)
+	{}
 
 	/** @return the aspect ratio multiplied by 100
 	 *  (e.g. 239 for Cinemascope 2.39:1)
 	 */
-	int ratio_as_integer () const {
-		return _ratio;
-	}
+	virtual int ratio_as_integer (Film const * f) const = 0;
 
 	/** @return the ratio as a floating point number */
-	float ratio_as_float () const {
-		return _ratio / 100.0;
-	}
+	virtual float ratio_as_float (Film const * f) const = 0;
+
+	int dcp_padding (Film const * f) const;
 
 	/** @return size in pixels of the images that we should
 	 *  put in a DCP for this ratio.  This size will not correspond
@@ -60,7 +60,7 @@ public:
 	}
 
 	/** @return Full name to present to the user */
-	std::string name () const;
+	virtual std::string name () const = 0;
 
 	/** @return Nickname (e.g. Flat, Scope) */
 	std::string nickname () const {
@@ -69,9 +69,6 @@ public:
 
 	std::string as_metadata () const;
 
-	int dcp_padding () const;
-
-	static Format const * from_ratio (int);
 	static Format const * from_nickname (std::string n);
 	static Format const * from_metadata (std::string m);
 	static Format const * from_index (int i);
@@ -79,11 +76,8 @@ public:
 	static int as_index (Format const * f);
 	static std::vector<Format const *> all ();
 	static void setup_formats ();
-	
-private:
 
-	/** Ratio expressed as the actual ratio multiplied by 100 */
-	int _ratio;
+protected:	
 	/** Size in pixels of the images that we should
 	 *  put in a DCP for this ratio.  This size will not correspond
 	 *  to the ratio when we are doing things like 16:9 in a Flat frame.
@@ -94,8 +88,43 @@ private:
 	/** nickname (e.g. Flat, Scope) */
 	std::string _nickname;
 
+private:	
 	/** all available formats */
 	static std::vector<Format const *> _formats;
 };
 
+/** @class FixedFormat
+ *  @brief Class to describe a format whose ratio is fixed regardless
+ *  of source size.
+ */
+class FixedFormat : public Format
+{
+public:
+	FixedFormat (int, Size, std::string, std::string);
+
+	int ratio_as_integer (Film const *) const {
+		return _ratio;
+	}
+
+	float ratio_as_float (Film const *) const {
+		return _ratio / 100.0;
+	}
+
+	std::string name () const;
 	
+private:
+
+	/** Ratio expressed as the actual ratio multiplied by 100 */
+	int _ratio;
+};
+
+class VariableFormat : public Format
+{
+public:
+	VariableFormat (Size, std::string, std::string);
+
+	int ratio_as_integer (Film const * f) const;
+	float ratio_as_float (Film const * f) const;
+
+	std::string name () const;
+};
diff --git a/src/lib/image.cc b/src/lib/image.cc
index 620e71aa7..2df7636af 100644
--- a/src/lib/image.cc
+++ b/src/lib/image.cc
@@ -94,7 +94,7 @@ Image::scale_and_convert_to_rgb (Size out_size, int padding, Scaler const * scal
 	content_size.width -= (padding * 2);
 
 	shared_ptr<RGBFrameImage> rgb (new RGBFrameImage (content_size));
-	
+
 	struct SwsContext* scale_context = sws_getContext (
 		size().width, size().height, pixel_format(),
 		content_size.width, content_size.height, PIX_FMT_RGB24,
diff --git a/src/wx/film_viewer.cc b/src/wx/film_viewer.cc
index e647a5886..3c7d76bce 100644
--- a/src/wx/film_viewer.cc
+++ b/src/wx/film_viewer.cc
@@ -131,7 +131,7 @@ private:
 		int vw, vh;
 		GetSize (&vw, &vh);
 
-		float const target = _film->format() ? _film->format()->ratio_as_float () : 1.78;
+		float const target = _film->format() ? _film->format()->ratio_as_float (_film) : 1.78;
 
 		_cropped_image = _image->GetSubImage (
 			wxRect (