Try to fix the filter / AVFrame ownership.
[dcpomatic.git] / src / lib / film.h
index 536855b1f64a0abd4e80c6d7a0121b3fe787773e..dd0a83d94e473f5da6d5b9e98d1378e247c0c3eb 100644 (file)
@@ -38,18 +38,20 @@ extern "C" {
 #include "dcp_content_type.h"
 #include "util.h"
 #include "stream.h"
+#include "dci_metadata.h"
 
 class Format;
 class Job;
 class Filter;
 class Log;
 class ExamineContentJob;
+class AnalyseAudioJob;
 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,18 +61,26 @@ public:
        Film (Film const &);
        ~Film ();
 
-       std::string j2k_dir () const;
-       std::vector<std::string> audio_files () const;
+       std::string info_dir () const;
+       std::string j2c_path (int f, bool t) const;
+       std::string info_path (int f) const;
+       std::string internal_video_mxf_dir () const;
+       std::string internal_video_mxf_filename () const;
+       std::string audio_analysis_path () const;
+
+       std::string dcp_video_mxf_filename () const;
+       std::string dcp_audio_mxf_filename () const;
 
        void examine_content ();
+       void analyse_audio ();
        void send_dcp_to_tms ();
 
-       void make_dcp (bool);
+       void make_dcp ();
 
        /** @return Logger.
         *  It is safe to call this from any thread.
         */
-       Log* log () const {
+       boost::shared_ptr<Log> log () const {
                return _log;
        }
 
@@ -87,11 +97,11 @@ public:
        void write_metadata () const;
        void read_metadata ();
 
-       Size cropped_size (Size) const;
-       boost::optional<SourceFrame> dcp_length () const;
-       std::string dci_name () const;
-       std::string dcp_name () const;
+       libdcp::Size cropped_size (libdcp::Size) const;
+       std::string dci_name (bool if_created_now) const;
+       std::string dcp_name (bool if_created_now = false) const;
 
+       /** @return true if our state has changed since we last saved it */
        bool dirty () const {
                return _dirty;
        }
@@ -100,6 +110,16 @@ public:
 
        void set_dci_date_today ();
 
+       bool have_dcp () const;
+
+       enum TrimType {
+               CPL,
+               ENCODE
+       };
+
+       /** Identifiers for the parts of our state;
+           used for signalling changes.
+       */
        enum Property {
                NONE,
                NAME,
@@ -111,8 +131,9 @@ public:
                CROP,
                FILTERS,
                SCALER,
-               DCP_TRIM_START,
-               DCP_TRIM_END,
+               TRIM_START,
+               TRIM_END,
+               TRIM_TYPE,
                DCP_AB,
                CONTENT_AUDIO_STREAM,
                EXTERNAL_AUDIO,
@@ -124,12 +145,15 @@ public:
                WITH_SUBTITLES,
                SUBTITLE_OFFSET,
                SUBTITLE_SCALE,
+               COLOUR_LUT,
+               J2K_BANDWIDTH,
                DCI_METADATA,
                SIZE,
                LENGTH,
                CONTENT_AUDIO_STREAMS,
                SUBTITLE_STREAMS,
-               FRAMES_PER_SECOND,
+               SOURCE_FRAME_RATE,
+               DCP_FRAME_RATE
        };
 
 
@@ -185,16 +209,21 @@ 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;
        }
-       
+
+       TrimType trim_type () const {
+               boost::mutex::scoped_lock lm (_state_mutex);
+               return _trim_type;
+       }
+
        bool dcp_ab () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _dcp_ab;
@@ -230,6 +259,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;
@@ -250,42 +281,27 @@ public:
                return _subtitle_scale;
        }
 
-       std::string audio_language () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _audio_language;
-       }
-       
-       std::string subtitle_language () const {
+       int colour_lut () const {
                boost::mutex::scoped_lock lm (_state_mutex);
-               return _subtitle_language;
+               return _colour_lut;
        }
-       
-       std::string territory () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _territory;
-       }
-       
-       std::string rating () const {
+
+       int j2k_bandwidth () const {
                boost::mutex::scoped_lock lm (_state_mutex);
-               return _rating;
+               return _j2k_bandwidth;
        }
-       
-       std::string studio () const {
+
+       DCIMetadata dci_metadata () const {
                boost::mutex::scoped_lock lm (_state_mutex);
-               return _studio;
+               return _dci_metadata;
        }
-       
-       std::string facility () const {
+
+       int dcp_frame_rate () const {
                boost::mutex::scoped_lock lm (_state_mutex);
-               return _facility;
+               return _dcp_frame_rate;
        }
        
-       std::string package_type () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _package_type;
-       }
-
-       Size size () const {
+       libdcp::Size size () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _size;
        }
@@ -310,17 +326,17 @@ public:
                return _subtitle_streams;
        }
        
-       float frames_per_second () const {
+       float source_frame_rate () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                if (content_type() == STILL) {
                        return 24;
                }
                
-               return _frames_per_second;
+               return _source_frame_rate;
        }
 
        boost::shared_ptr<AudioStream> audio_stream () const;
-
+       bool has_audio () const;
        
        /* SET */
 
@@ -338,8 +354,9 @@ 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_trim_type (TrimType);
        void set_dcp_ab (bool);
        void set_content_audio_stream (boost::shared_ptr<AudioStream>);
        void set_external_audio (std::vector<std::string>);
@@ -351,40 +368,41 @@ public:
        void set_with_subtitles (bool);
        void set_subtitle_offset (int);
        void set_subtitle_scale (float);
-       void set_audio_language (std::string);
-       void set_subtitle_language (std::string);
-       void set_territory (std::string);
-       void set_rating (std::string);
-       void set_studio (std::string);
-       void set_facility (std::string);
-       void set_package_type (std::string);
-       void set_size (Size);
+       void set_colour_lut (int);
+       void set_j2k_bandwidth (int);
+       void set_dci_metadata (DCIMetadata);
+       void set_dcp_frame_rate (int);
+       void set_size (libdcp::Size);
        void set_length (SourceFrame);
        void unset_length ();
        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> >);
-       void set_frames_per_second (float);
+       void set_source_frame_rate (float);
 
        /** Emitted when some property has changed */
        mutable boost::signals2::signal<void (Property)> Changed;
 
+       boost::signals2::signal<void ()> AudioAnalysisSucceeded;
+
        /** Current version number of the state file */
        static int const state_version;
 
 private:
        
        /** Log to write to */
-       Log* _log;
+       boost::shared_ptr<Log> _log;
 
        /** Any running ExamineContentJob, or 0 */
        boost::shared_ptr<ExamineContentJob> _examine_content_job;
-
-       /** The date that we should use in a DCI name */
-       boost::gregorian::date _dci_date;
+       /** Any running AnalyseAudioJob, or 0 */
+       boost::shared_ptr<AnalyseAudioJob> _analyse_audio_job;
 
        void signal_changed (Property);
        void examine_content_finished ();
+       void analyse_audio_finished ();
+       std::string video_state_identifier () const;
+       std::string filename_safe_name () const;
 
        /** Complete path to directory containing the film metadata;
         *  must not be relative.
@@ -401,6 +419,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;
@@ -412,10 +434,11 @@ 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;
+       TrimType _trim_type;
        /** 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.
@@ -444,32 +467,37 @@ 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;
-       std::string _territory;
-       std::string _rating;
-       std::string _studio;
-       std::string _facility;
-       std::string _package_type;
+       /** DCI naming stuff */
+       DCIMetadata _dci_metadata;
+       /** The date that we should use in a DCI name */
+       boost::gregorian::date _dci_date;
+       /** Frames per second to run our DCP at */
+       int _dcp_frame_rate;
 
        /* 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 _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;
        /** 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;
+       boost::shared_ptr<AudioStream> _sndfile_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;
+       float _source_frame_rate;
 
        /** true if our state has changed since we last saved it */
        mutable bool _dirty;
@@ -478,6 +506,7 @@ private:
        mutable boost::mutex _state_mutex;
 
        friend class paths_test;
+       friend class film_metadata_test;
 };
 
 #endif