Merge master branch.
[dcpomatic.git] / src / lib / film.h
index af1f49e2ef56534dc847123f7183ea3eb1694e3a..60646b0c8d78adc52f6fa8da0740d704926ac1c9 100644 (file)
@@ -44,11 +44,12 @@ class Job;
 class Filter;
 class Log;
 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,12 +60,9 @@ public:
        ~Film ();
 
        std::string j2k_dir () const;
-       std::vector<std::string> audio_files () const;
-       std::pair<Position, std::string> thumb_subtitle (int) const;
 
        void examine_content ();
        void send_dcp_to_tms ();
-       void copy_from_dvd ();
 
        void make_dcp (bool);
 
@@ -80,25 +78,27 @@ public:
        std::string file (std::string f) const;
        std::string dir (std::string d) const;
 
+       std::string frame_out_path (int f, bool t) const;
+       std::string hash_out_path (int f, bool t) const;
+       std::string multichannel_audio_out_path (int c, bool t) const;
+       
        std::string content_path () const;
        ContentType content_type () const;
        
-       bool content_is_dvd () 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;
        }
@@ -107,22 +107,26 @@ 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,
                FILTERS,
                SCALER,
-               DCP_TRIM_START,
-               DCP_TRIM_END,
+               TRIM_START,
+               TRIM_END,
                DCP_AB,
-               USE_SOURCE_AUDIO,
-               AUDIO_STREAM,
+               CONTENT_AUDIO_STREAM,
                EXTERNAL_AUDIO,
+               USE_CONTENT_AUDIO,
                AUDIO_GAIN,
                AUDIO_DELAY,
                STILL_DURATION,
@@ -130,11 +134,13 @@ public:
                WITH_SUBTITLES,
                SUBTITLE_OFFSET,
                SUBTITLE_SCALE,
+               COLOUR_LUT,
+               J2K_BANDWIDTH,
                DCI_METADATA,
-               THUMBS,
                SIZE,
                LENGTH,
-               AUDIO_STREAMS,
+               DCP_INTRINSIC_DURATION,
+               CONTENT_AUDIO_STREAMS,
                SUBTITLE_STREAMS,
                FRAMES_PER_SECOND,
        };
@@ -162,6 +168,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;
@@ -187,34 +198,34 @@ 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;
        }
 
-       bool use_source_audio () const {
+       boost::shared_ptr<AudioStream> content_audio_stream () const {
                boost::mutex::scoped_lock lm (_state_mutex);
-               return _use_source_audio;
+               return _content_audio_stream;
        }
 
-       boost::optional<AudioStream> audio_stream () const {
+       std::vector<std::string> external_audio () const {
                boost::mutex::scoped_lock lm (_state_mutex);
-               return _audio_stream;
+               return _external_audio;
        }
 
-       std::vector<std::string> external_audio () const {
+       bool use_content_audio () const {
                boost::mutex::scoped_lock lm (_state_mutex);
-               return _external_audio;
+               return _use_content_audio;
        }
        
        float audio_gain () const {
@@ -232,7 +243,9 @@ public:
                return _still_duration;
        }
 
-       boost::optional<SubtitleStream> subtitle_stream () const {
+       int still_duration_in_frames () const;
+
+       boost::shared_ptr<SubtitleStream> subtitle_stream () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _subtitle_stream;
        }
@@ -252,6 +265,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;
@@ -287,12 +310,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;
        }
@@ -307,28 +325,35 @@ public:
                return _content_digest;
        }
        
-       std::vector<AudioStream> audio_streams () const {
+       std::vector<boost::shared_ptr<AudioStream> > content_audio_streams () const {
                boost::mutex::scoped_lock lm (_state_mutex);
-               return _audio_streams;
+               return _content_audio_streams;
        }
 
-       std::vector<SubtitleStream> subtitle_streams () const {
+       std::vector<boost::shared_ptr<SubtitleStream> > subtitle_streams () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _subtitle_streams;
        }
        
        float frames_per_second () const {
                boost::mutex::scoped_lock lm (_state_mutex);
+               if (content_type() == STILL) {
+                       return 24;
+               }
+               
                return _frames_per_second;
        }
 
+       boost::shared_ptr<AudioStream> audio_stream () const;
 
+       
        /* SET */
 
        void set_directory (std::string);
        void set_name (std::string);
        void set_use_dci_name (bool);
-       virtual void set_content (std::string);
+       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);
@@ -338,19 +363,21 @@ 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_use_source_audio (bool);
-       void set_audio_stream (boost::optional<AudioStream>);
+       void set_content_audio_stream (boost::shared_ptr<AudioStream>);
        void set_external_audio (std::vector<std::string>);
+       void set_use_content_audio (bool);
        void set_audio_gain (float);
        void set_audio_delay (int);
        void set_still_duration (int);
-       void set_subtitle_stream (boost::optional<SubtitleStream>);
+       void set_subtitle_stream (boost::shared_ptr<SubtitleStream>);
        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);
@@ -358,18 +385,21 @@ 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_audio_streams (std::vector<AudioStream>);
-       void set_subtitle_streams (std::vector<SubtitleStream>);
+       void set_content_audio_streams (std::vector<boost::shared_ptr<AudioStream> >);
+       void set_subtitle_streams (std::vector<boost::shared_ptr<SubtitleStream> >);
        void set_frames_per_second (float);
 
        /** Emitted when some property has changed */
        mutable boost::signals2::signal<void (Property)> Changed;
-       
+
+       /** Current version number of the state file */
+       static int const state_version;
+
 private:
        
        /** Log to write to */
@@ -381,8 +411,6 @@ 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 ();
 
@@ -401,6 +429,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.) */
@@ -411,25 +444,30 @@ 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.
        */
        bool _dcp_ab;
-       bool _use_source_audio;
-       boost::optional<AudioStream> _audio_stream;
+       /** The audio stream to use from our content */
+       boost::shared_ptr<AudioStream> _content_audio_stream;
+       /** List of filenames of external audio files, in channel order
+           (L, R, C, Lfe, Ls, Rs)
+       */
        std::vector<std::string> _external_audio;
+       /** true to use audio from our content file; false to use external audio */
+       bool _use_content_audio;
        /** Gain to apply to audio in dB */
        float _audio_gain;
        /** Delay to apply to audio (positive moves audio later) in milliseconds */
        int _audio_delay;
        /** Duration to make still-sourced films (in seconds) */
        int _still_duration;
-       boost::optional<SubtitleStream> _subtitle_stream;
+       boost::shared_ptr<SubtitleStream> _subtitle_stream;
        /** True if subtitles should be shown for this film */
        bool _with_subtitles;
        /** y offset for placing subtitles, in source pixels; +ve is further down
@@ -438,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;
@@ -450,21 +495,23 @@ 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 that the source has */
-       std::vector<AudioStream> _audio_streams;
-       /** the subtitle streams that the source has */
-       std::vector<SubtitleStream> _subtitle_streams;
+       /** The audio streams in our content */
+       std::vector<boost::shared_ptr<AudioStream> > _content_audio_streams;
+       /** A stream to represent possible external audio (will always exist) */
+       boost::shared_ptr<AudioStream> _external_audio_stream;
+       /** the subtitle streams that we can use */
+       std::vector<boost::shared_ptr<SubtitleStream> > _subtitle_streams;
        /** Frames per second of the source */
        float _frames_per_second;
 
+       /** true if our state has changed since we last saved it */
        mutable bool _dirty;
 
        /** Mutex for all state except _directory */