Merge master.
[dcpomatic.git] / src / lib / format.cc
index d99ed926a2ac42df20ed7216c716bb9a91256ddd..5eda9eb889ef1896b9a86613259b12424a58c49f 100644 (file)
 #include <iomanip>
 #include <iostream>
 #include "format.h"
+#include "film.h"
+#include "playlist.h"
 
-using namespace std;
+#include "i18n.h"
 
-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)
-{
+using std::string;
+using std::setprecision;
+using std::stringstream;
+using std::vector;
+using boost::shared_ptr;
+using libdcp::Size;
 
-}
+vector<Format const *> Format::_formats;
 
 /** @return A name to be presented to the user */
 string
-Format::name () const
+FixedFormat::name () const
 {
        stringstream s;
        if (!_nickname.empty ()) {
-               s << _nickname << " (";
+               s << _nickname << N_(" (");
        }
 
-       s << setprecision(3) << (_ratio / 100.0) << ":1";
+       s << setprecision(3) << (_ratio / 100.0) << N_(":1");
 
        if (!_nickname.empty ()) {
-               s << ")";
+               s << N_(")");
        }
 
        return s.str ();
@@ -76,29 +71,62 @@ Format::as_metadata () const
 void
 Format::setup_formats ()
 {
-       _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 (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;
+       /// TRANSLATORS: these are film picture aspect ratios; "Academy" means 1.37, "Flat" 1.85 and "Scope" 2.39.
+       _formats.push_back (
+               new FixedFormat (119, libdcp::Size (1285, 1080), N_("119"), _("1.19"), N_("F")
+                       ));
+       
+       _formats.push_back (
+               new FixedFormat (133, libdcp::Size (1436, 1080), N_("133"), _("1.33"), N_("F")
+                       ));
+       
+       _formats.push_back (
+               new FixedFormat (138, libdcp::Size (1485, 1080), N_("138"), _("1.375"), N_("F")
+                       ));
+       
+       _formats.push_back (
+               new FixedFormat (133, libdcp::Size (1998, 1080), N_("133-in-flat"), _("4:3 within Flat"), N_("F")
+                       ));
+       
+       _formats.push_back (
+               new FixedFormat (137, libdcp::Size (1480, 1080), N_("137"), _("Academy"), N_("F")
+                       ));
+       
+       _formats.push_back (
+               new FixedFormat (166, libdcp::Size (1793, 1080), N_("166"), _("1.66"), N_("F")
+                       ));
+       
+       _formats.push_back (
+               new FixedFormat (166, libdcp::Size (1998, 1080), N_("166-in-flat"), _("1.66 within Flat"), N_("F")
+                       ));
+       
+       _formats.push_back (
+               new FixedFormat (178, libdcp::Size (1998, 1080), N_("178-in-flat"), _("16:9 within Flat"), N_("F")
+                       ));
+       
+       _formats.push_back (
+               new FixedFormat (178, libdcp::Size (1920, 1080), N_("178"), _("16:9"), N_("F")
+                       ));
+       
+       _formats.push_back (
+               new FixedFormat (185, libdcp::Size (1998, 1080), N_("185"), _("Flat"), N_("F")
+                       ));
+       
+       _formats.push_back (
+               new FixedFormat (178, libdcp::Size (2048, 858), N_("178-in-scope"), _("16:9 within Scope"), N_("S")
+                       ));
+       
+       _formats.push_back (
+               new FixedFormat (239, libdcp::Size (2048, 858), N_("239"), _("Scope"), N_("S")
+                       ));
+               
+       _formats.push_back (
+               new VariableFormat (libdcp::Size (1998, 1080), N_("var-185"), _("Flat without stretch"), N_("F")
+                       ));
+       
+       _formats.push_back (
+               new VariableFormat (libdcp::Size (2048, 858), N_("var-239"), _("Scope without stretch"), N_("S")
+                       ));
 }
 
 /** @param n Nickname.
@@ -147,50 +175,68 @@ Format::from_metadata (string m)
        return from_id (m);
 }
 
-/** @param f A Format.
- *  @return Index of f within our static list, or -1.
+/** @return All available formats */
+vector<Format const *>
+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, libdcp::Size dcp, string id, string n, string d)
+       : Format (dcp, id, n, d)
+       , _ratio (r)
+{
+
+}
+
+/** @return Number of pixels (int the DCP image) to pad either side of the film
+ *  (so there are dcp_padding() pixels on the left and dcp_padding() on the right)
  */
 int
-Format::as_index (Format const * f)
+Format::dcp_padding (shared_ptr<const Film> f) const
 {
-       vector<Format*>::size_type i = 0;
-       while (i < _formats.size() && _formats[i] != f) {
-               ++i;
-       }
+       int pad = rint ((_dcp_size.width - (_dcp_size.height * ratio_as_integer(f) / 100.0)) / 2.0);
 
-       if (i == _formats.size ()) {
-               return -1;
+       /* This comes out -ve for Scope; bodge it */
+       if (pad < 0) {
+               pad = 0;
        }
-
-       return i;
+       
+       return pad;
 }
 
-/** @param i An index returned from as_index().
- *  @return Corresponding Format.
- */
-Format const *
-Format::from_index (int i)
+float
+Format::container_ratio_as_float () const
 {
-       assert (i >= 0 && i < int(_formats.size ()));
-       return _formats[i];
+       return static_cast<float> (_dcp_size.width) / _dcp_size.height;
 }
 
-/** @return All available formats */
-vector<Format const *>
-Format::all ()
+VariableFormat::VariableFormat (libdcp::Size dcp, string id, string n, string d)
+       : Format (dcp, id, n, d)
 {
-       return _formats;
+
 }
 
 int
-Format::dcp_padding () const
+VariableFormat::ratio_as_integer (shared_ptr<const Film> f) const
+{
+       return rint (ratio_as_float (f) * 100);
+}
+
+float
+VariableFormat::ratio_as_float (shared_ptr<const Film> f) const
 {
-       int p = rint ((_dcp_size.width - (_dcp_size.height * _ratio / 100.0)) / 2.0);
+       return float (f->video_size().width) / f->video_size().height;
+}
 
-       /* This comes out -ve for Scope; bodge it */
-       if (p < 0) {
-               p = 0;
-       }
-       
-       return p;
+/** @return A name to be presented to the user */
+string
+VariableFormat::name () const
+{
+       return _nickname;
 }