Remove multi-reel, for now, and sort out Size vs libdcp::Size.
[dcpomatic.git] / src / lib / film.h
index c7ebdef12d66d7bf3f199fd49e149efd969f7483..d3530b81772ac43f117d2d4f2734778c9d0d28c9 100644 (file)
@@ -47,9 +47,9 @@ class ExamineContentJob;
 class ExternalAudioStream;
 
 /** @class Film
- *  @brief A representation of a video with sound.
+ *  @brief A representation of a video, maybe with sound.
  *
- *  A representation of a piece of video (with sound), including naming,
+ *  A representation of a piece of video (maybe with sound), including naming,
  *  the source content file, and how it should be presented in a DCP.
  */
 class Film : public boost::enable_shared_from_this<Film>
@@ -60,7 +60,6 @@ public:
        ~Film ();
 
        std::string j2k_dir () const;
-       std::vector<std::string> audio_files () const;
 
        void examine_content ();
        void send_dcp_to_tms ();
@@ -87,11 +86,12 @@ public:
        void write_metadata () const;
        void read_metadata ();
 
-       Size cropped_size (Size) const;
-       boost::optional<SourceFrame> dcp_length () const;
+       libdcp::Size cropped_size (libdcp::Size) const;
+       boost::optional<int> dcp_length () const;
        std::string dci_name () const;
        std::string dcp_name () const;
 
+       /** @return true if our state has changed since we last saved it */
        bool dirty () const {
                return _dirty;
        }
@@ -100,11 +100,15 @@ public:
 
        void set_dci_date_today ();
 
+       /** Identifiers for the parts of our state;
+           used for signalling changes.
+       */
        enum Property {
                NONE,
                NAME,
                USE_DCI_NAME,
                CONTENT,
+               TRUST_CONTENT_HEADER,
                DCP_CONTENT_TYPE,
                FORMAT,
                CROP,
@@ -123,6 +127,8 @@ public:
                WITH_SUBTITLES,
                SUBTITLE_OFFSET,
                SUBTITLE_SCALE,
+               COLOUR_LUT,
+               J2K_BANDWIDTH,
                DCI_METADATA,
                SIZE,
                LENGTH,
@@ -154,6 +160,11 @@ public:
                return _content;
        }
 
+       bool trust_content_header () const {
+               boost::mutex::scoped_lock lm (_state_mutex);
+               return _trust_content_header;
+       }
+
        DCPContentType const * dcp_content_type () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _dcp_content_type;
@@ -188,7 +199,7 @@ public:
                boost::mutex::scoped_lock lm (_state_mutex);
                return _dcp_trim_end;
        }
-       
+
        bool dcp_ab () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _dcp_ab;
@@ -244,6 +255,16 @@ public:
                return _subtitle_scale;
        }
 
+       int colour_lut () const {
+               boost::mutex::scoped_lock lm (_state_mutex);
+               return _colour_lut;
+       }
+
+       int j2k_bandwidth () const {
+               boost::mutex::scoped_lock lm (_state_mutex);
+               return _j2k_bandwidth;
+       }
+
        std::string audio_language () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _audio_language;
@@ -279,7 +300,7 @@ public:
                return _package_type;
        }
 
-       Size size () const {
+       libdcp::Size size () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _size;
        }
@@ -306,6 +327,10 @@ public:
        
        float frames_per_second () const {
                boost::mutex::scoped_lock lm (_state_mutex);
+               if (content_type() == STILL) {
+                       return 24;
+               }
+               
                return _frames_per_second;
        }
 
@@ -318,6 +343,7 @@ public:
        void set_name (std::string);
        void set_use_dci_name (bool);
        void set_content (std::string);
+       void set_trust_content_header (bool);
        void set_dcp_content_type (DCPContentType const *);
        void set_format (Format const *);
        void set_crop (Crop);
@@ -340,6 +366,8 @@ public:
        void set_with_subtitles (bool);
        void set_subtitle_offset (int);
        void set_subtitle_scale (float);
+       void set_colour_lut (int);
+       void set_j2k_bandwidth (int);
        void set_audio_language (std::string);
        void set_subtitle_language (std::string);
        void set_territory (std::string);
@@ -347,7 +375,7 @@ public:
        void set_studio (std::string);
        void set_facility (std::string);
        void set_package_type (std::string);
-       void set_size (Size);
+       void set_size (libdcp::Size);
        void set_length (SourceFrame);
        void unset_length ();
        void set_content_digest (std::string);
@@ -390,6 +418,11 @@ private:
         *  or an absolute path.
         */
        std::string _content;
+       /** If this is true, we will believe the length specified by the content
+        *  file's header; if false, we will run through the whole content file
+        *  the first time we see it in order to obtain the length.
+        */
+       bool _trust_content_header;
        /** The type of content that this Film represents (feature, trailer etc.) */
        DCPContentType const * _dcp_content_type;
        /** The format to present this Film in (flat, scope, etc.) */
@@ -400,10 +433,10 @@ private:
        std::vector<Filter const *> _filters;
        /** Scaler algorithm to use */
        Scaler const * _scaler;
-       /** Frames to trim off the start of the source */
-       SourceFrame _dcp_trim_start;
-       /** Frames to trim off the end of the source */
-       SourceFrame _dcp_trim_end;
+       /** Frames to trim off the start of the DCP */
+       int _dcp_trim_start;
+       /** Frames to trim off the end of the DCP */
+       int _dcp_trim_end;
        /** true to create an A/B comparison DCP, where the left half of the image
            is the video without any filters or post-processing, and the right half
            has the specified filters and post-processing.
@@ -432,7 +465,14 @@ private:
        int _subtitle_offset;
        /** scale factor to apply to subtitles */
        float _subtitle_scale;
-
+       /** index of colour LUT to use when converting RGB to XYZ.
+        *  0: sRGB
+        *  1: Rec 709
+        */
+       int _colour_lut;
+       /** bandwidth for J2K files in bits per second */
+       int _j2k_bandwidth;
+       
        /* DCI naming stuff */
        std::string _audio_language;
        std::string _subtitle_language;
@@ -444,9 +484,9 @@ private:
 
        /* Data which are cached to speed things up */
 
-       /** Size, in pixels, of the source (ignoring cropping) */
-       Size _size;
-       /** Actual length of the source (in video frames) from examining it */
+       /** libdcp::Size, in pixels, of the source (ignoring cropping) */
+       libdcp::Size _size;
+       /** The length of the source, in video frames (as far as we know) */
        boost::optional<SourceFrame> _length;
        /** MD5 digest of our content file */
        std::string _content_digest;