Merge master.
[dcpomatic.git] / src / lib / format.h
index 6172dc57d43b3b67881856a14d7d908c29b24b62..7958ca5341604e199a181b2295e0708b3614d542 100644 (file)
@@ -31,27 +31,31 @@ class Film;
 class Format
 {
 public:
-       Format (Size dcp, std::string id, std::string n)
+       Format (libdcp::Size dcp, std::string id, std::string n, std::string d)
                : _dcp_size (dcp)
                , _id (id)
                , _nickname (n)
+               , _dci_name (d)
        {}
 
        /** @return the aspect ratio multiplied by 100
         *  (e.g. 239 for Cinemascope 2.39:1)
         */
-       virtual int ratio_as_integer (Film const * f) const = 0;
+       virtual int ratio_as_integer (boost::shared_ptr<const Film> f) const = 0;
 
        /** @return the ratio as a floating point number */
-       virtual float ratio_as_float (Film const * f) const = 0;
+       virtual float ratio_as_float (boost::shared_ptr<const Film> f) const = 0;
 
-       int dcp_padding (Film const * f) const;
+       /** @return the ratio of the container (including any padding) as a floating point number */
+       float container_ratio_as_float () const;
+
+       int dcp_padding (boost::shared_ptr<const Film>) const;
 
        /** @return 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.
         */
-       Size dcp_size () const {
+       libdcp::Size dcp_size () const {
                return _dcp_size;
        }
 
@@ -67,26 +71,29 @@ public:
                return _nickname;
        }
 
+       std::string dci_name () const {
+               return _dci_name;
+       }
+
        std::string as_metadata () const;
 
        static Format const * from_nickname (std::string n);
        static Format const * from_metadata (std::string m);
-       static Format const * from_index (int i);
        static Format const * from_id (std::string i);
-       static int as_index (Format const * f);
        static std::vector<Format const *> all ();
        static void setup_formats ();
 
 protected:     
-       /** Size in pixels of the images that we should
+       /** libdcp::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.
         */
-       Size _dcp_size;
+       libdcp::Size _dcp_size;
        /** id for use in metadata */
        std::string _id;
        /** nickname (e.g. Flat, Scope) */
        std::string _nickname;
+       std::string _dci_name;
 
 private:       
        /** all available formats */
@@ -100,13 +107,13 @@ private:
 class FixedFormat : public Format
 {
 public:
-       FixedFormat (int, Size, std::string, std::string);
+       FixedFormat (int, libdcp::Size, std::string, std::string, std::string);
 
-       int ratio_as_integer (Film const *) const {
+       int ratio_as_integer (boost::shared_ptr<const Film>) const {
                return _ratio;
        }
 
-       float ratio_as_float (Film const *) const {
+       float ratio_as_float (boost::shared_ptr<const Film>) const {
                return _ratio / 100.0;
        }
 
@@ -121,10 +128,10 @@ private:
 class VariableFormat : public Format
 {
 public:
-       VariableFormat (Size, std::string, std::string);
+       VariableFormat (libdcp::Size, std::string, std::string, std::string);
 
-       int ratio_as_integer (Film const * f) const;
-       float ratio_as_float (Film const * f) const;
+       int ratio_as_integer (boost::shared_ptr<const Film> f) const;
+       float ratio_as_float (boost::shared_ptr<const Film> f) const;
 
        std::string name () const;
 };