Try to fix up paths for video MXFs, hashes and temporarily-stored frames.
[dcpomatic.git] / src / lib / film.h
index 8cd55a227994dd011040d64f3df19cb3ffca0ea3..4d2819be30c9226bd67d0cbc8f44d1293a87b907 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>
@@ -59,9 +59,10 @@ public:
        Film (Film const &);
        ~Film ();
 
-       std::string j2k_dir () const;
-       std::vector<std::string> audio_files () const;
-       std::pair<Position, std::string> thumb_subtitle (int) const;
+       std::string hash_dir () const;
+       std::string j2c_path (int f, bool t) const;
+       std::string hash_path (int f) const;
+       std::string video_mxf_path () const;
 
        void examine_content ();
        void send_dcp_to_tms ();
@@ -83,20 +84,20 @@ public:
        std::string content_path () const;
        ContentType content_type () const;
        
-       std::string thumb_file (int) const;
-       std::string thumb_base (int) const;
-       SourceFrame thumb_frame (int) const;
-
        int target_audio_sample_rate () const;
        
        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;
        std::string dci_name () const;
        std::string dcp_name () const;
 
+       boost::optional<int> dcp_intrinsic_duration () const {
+               return _dcp_intrinsic_duration;
+       }
+
+       /** @return true if our state has changed since we last saved it */
        bool dirty () const {
                return _dirty;
        }
@@ -105,6 +106,9 @@ public:
 
        void set_dci_date_today ();
 
+       /** Identifiers for the parts of our state;
+           used for signalling changes.
+       */
        enum Property {
                NONE,
                NAME,
@@ -116,8 +120,8 @@ public:
                CROP,
                FILTERS,
                SCALER,
-               DCP_TRIM_START,
-               DCP_TRIM_END,
+               TRIM_START,
+               TRIM_END,
                DCP_AB,
                CONTENT_AUDIO_STREAM,
                EXTERNAL_AUDIO,
@@ -129,10 +133,12 @@ public:
                WITH_SUBTITLES,
                SUBTITLE_OFFSET,
                SUBTITLE_SCALE,
+               COLOUR_LUT,
+               J2K_BANDWIDTH,
                DCI_METADATA,
-               THUMBS,
                SIZE,
                LENGTH,
+               DCP_INTRINSIC_DURATION,
                CONTENT_AUDIO_STREAMS,
                SUBTITLE_STREAMS,
                FRAMES_PER_SECOND,
@@ -191,16 +197,16 @@ public:
                return _scaler;
        }
 
-       SourceFrame dcp_trim_start () const {
+       int trim_start () const {
                boost::mutex::scoped_lock lm (_state_mutex);
-               return _dcp_trim_start;
+               return _trim_start;
        }
 
-       SourceFrame dcp_trim_end () const {
+       int trim_end () const {
                boost::mutex::scoped_lock lm (_state_mutex);
-               return _dcp_trim_end;
+               return _trim_end;
        }
-       
+
        bool dcp_ab () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _dcp_ab;
@@ -236,6 +242,8 @@ public:
                return _still_duration;
        }
 
+       int still_duration_in_frames () const;
+
        boost::shared_ptr<SubtitleStream> subtitle_stream () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _subtitle_stream;
@@ -256,6 +264,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;
@@ -291,12 +309,7 @@ public:
                return _package_type;
        }
 
-       std::vector<SourceFrame> thumbs () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _thumbs;
-       }
-       
-       Size size () const {
+       libdcp::Size size () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _size;
        }
@@ -323,6 +336,10 @@ public:
        
        float frames_per_second () const {
                boost::mutex::scoped_lock lm (_state_mutex);
+               if (content_type() == STILL) {
+                       return 24;
+               }
+               
                return _frames_per_second;
        }
 
@@ -345,8 +362,8 @@ public:
        void set_bottom_crop (int);
        void set_filters (std::vector<Filter const *>);
        void set_scaler (Scaler const *);
-       void set_dcp_trim_start (int);
-       void set_dcp_trim_end (int);
+       void set_trim_start (int);
+       void set_trim_end (int);
        void set_dcp_ab (bool);
        void set_content_audio_stream (boost::shared_ptr<AudioStream>);
        void set_external_audio (std::vector<std::string>);
@@ -358,6 +375,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);
@@ -365,10 +384,10 @@ public:
        void set_studio (std::string);
        void set_facility (std::string);
        void set_package_type (std::string);
-       void set_thumbs (std::vector<SourceFrame>);
-       void set_size (Size);
+       void set_size (libdcp::Size);
        void set_length (SourceFrame);
        void unset_length ();
+       void set_dcp_intrinsic_duration (int);
        void set_content_digest (std::string);
        void set_content_audio_streams (std::vector<boost::shared_ptr<AudioStream> >);
        void set_subtitle_streams (std::vector<boost::shared_ptr<SubtitleStream> >);
@@ -391,10 +410,9 @@ private:
        /** The date that we should use in a DCI name */
        boost::gregorian::date _dci_date;
 
-       std::string thumb_file_for_frame (SourceFrame) const;
-       std::string thumb_base_for_frame (SourceFrame) const;
        void signal_changed (Property);
        void examine_content_finished ();
+       std::string video_state_identifier () const;
 
        /** Complete path to directory containing the film metadata;
         *  must not be relative.
@@ -411,6 +429,10 @@ 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;
@@ -422,10 +444,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 _trim_start;
+       /** Frames to trim off the end of the DCP */
+       int _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.
@@ -454,7 +476,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;
@@ -466,12 +495,11 @@ private:
 
        /* Data which are cached to speed things up */
 
-       /** Vector of frame indices for each of our `thumbnails' */
-       std::vector<SourceFrame> _thumbs;
        /** Size, in pixels, of the source (ignoring cropping) */
-       Size _size;
-       /** Actual length of the source (in video frames) from examining it */
+       libdcp::Size _size;
+       /** The length of the source, in video frames (as far as we know) */
        boost::optional<SourceFrame> _length;
+       boost::optional<int> _dcp_intrinsic_duration;
        /** MD5 digest of our content file */
        std::string _content_digest;
        /** The audio streams in our content */