More string -> boost::filesystem::path.
[dcpomatic.git] / src / lib / film.h
index 6dd2b446dc499be4898538d7d4bf25697e00866d..8cfc490886629ea99c3cc5e0cddd07b7932ceb7a 100644 (file)
 #include <string>
 #include <vector>
 #include <inttypes.h>
-#include <boost/thread/mutex.hpp>
-#include <boost/thread.hpp>
 #include <boost/signals2.hpp>
 #include <boost/enable_shared_from_this.hpp>
+#include <boost/filesystem.hpp>
+#include <libdcp/key.h>
+#include <libdcp/kdm.h>
 #include "util.h"
-#include "dci_metadata.h"
 #include "types.h"
-#include "ffmpeg_content.h"
-#include "playlist.h"
+#include "dci_metadata.h"
 
 class DCPContentType;
-class Format;
-class Job;
-class Filter;
 class Log;
-class ExamineContentJob;
-class AnalyseAudioJob;
-class ExternalAudioStream;
 class Content;
 class Player;
+class Playlist;
+class AudioContent;
+class Scaler;
+class Screen;
 
 /** @class Film
+ *
  *  @brief A representation of some audio and video content, and details of
  *  how they should be presented in a DCP.
+ *
+ *  The content of a Film is held in a Playlist (created and managed by the Film).
  */
-class Film : public boost::enable_shared_from_this<Film>
+class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
 {
 public:
-       Film (std::string d, bool must_exist = true);
-       Film (Film const &);
+       Film (boost::filesystem::path);
 
-       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;
+       boost::filesystem::path info_dir () const;
+       boost::filesystem::path j2c_path (int, Eyes, bool) const;
+       boost::filesystem::path info_path (int, Eyes) const;
+       boost::filesystem::path internal_video_mxf_dir () const;
+       boost::filesystem::path internal_video_mxf_filename () const;
+       boost::filesystem::path audio_analysis_path (boost::shared_ptr<const AudioContent>) const;
 
-       void examine_content (boost::shared_ptr<Content>);
-       std::string dcp_video_mxf_filename () const;
-       std::string dcp_audio_mxf_filename () const;
+       boost::filesystem::path video_mxf_filename () const;
+       boost::filesystem::path audio_mxf_filename () const;
 
-       void analyse_audio ();
        void send_dcp_to_tms ();
        void make_dcp ();
 
@@ -83,12 +80,12 @@ public:
 
        int encoded_frames () const;
        
-       std::string file (std::string f) const;
-       std::string dir (std::string d) const;
+       boost::filesystem::path file (boost::filesystem::path f) const;
+       boost::filesystem::path dir (boost::filesystem::path d) const;
 
+       void read_metadata ();
        void write_metadata () 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;
 
@@ -97,12 +94,14 @@ public:
                return _dirty;
        }
 
-       bool have_dcp () const;
+       libdcp::Size full_frame () const;
 
-       boost::shared_ptr<Player> player () const;
+       std::list<boost::filesystem::path> dcps () const;
+
+       boost::shared_ptr<Player> make_player () const;
        boost::shared_ptr<Playlist> playlist () const;
 
-       OutputAudioFrame dcp_audio_frame_rate () const;
+       OutputAudioFrame audio_frame_rate () const;
 
        OutputAudioFrame time_to_audio_frames (Time) const;
        OutputVideoFrame time_to_video_frames (Time) const;
@@ -111,14 +110,30 @@ public:
 
        /* Proxies for some Playlist methods */
 
-       Playlist::ContentList content () const;
+       ContentList content () const;
 
        Time length () const;
        bool has_subtitles () const;
-       OutputVideoFrame best_dcp_video_frame_rate () const;
-
-       void set_loop (int);
-       int loop () const;
+       OutputVideoFrame best_video_frame_rate () const;
+
+       libdcp::KDM
+       make_kdm (
+               boost::shared_ptr<libdcp::Certificate> target,
+               boost::filesystem::path dcp,
+               boost::posix_time::ptime from,
+               boost::posix_time::ptime until
+               ) const;
+       
+       std::list<libdcp::KDM> make_kdms (
+               std::list<boost::shared_ptr<Screen> >,
+               boost::filesystem::path dcp,
+               boost::posix_time::ptime from,
+               boost::posix_time::ptime until
+               ) const;
+
+       libdcp::Key key () const {
+               return _key;
+       }
 
        /** Identifiers for the parts of our state;
            used for signalling changes.
@@ -129,145 +144,115 @@ public:
                USE_DCI_NAME,
                /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
                CONTENT,
-               LOOP,
                DCP_CONTENT_TYPE,
-               FORMAT,
-               CROP,
-               FILTERS,
+               CONTAINER,
+               RESOLUTION,
                SCALER,
-               AB,
-               AUDIO_GAIN,
-               AUDIO_DELAY,
                WITH_SUBTITLES,
-               SUBTITLE_OFFSET,
-               SUBTITLE_SCALE,
-               COLOUR_LUT,
+               ENCRYPTED,
                J2K_BANDWIDTH,
                DCI_METADATA,
-               DCP_VIDEO_FRAME_RATE,
+               VIDEO_FRAME_RATE,
+               AUDIO_CHANNELS,
+               /** The setting of _three_d has been changed */
+               THREE_D,
+               SEQUENCE_VIDEO,
+               INTEROP,
        };
 
 
        /* GET */
 
-       std::string directory () const {
-               boost::mutex::scoped_lock lm (_directory_mutex);
+       boost::filesystem::path directory () const {
                return _directory;
        }
 
        std::string name () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
                return _name;
        }
 
        bool use_dci_name () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
                return _use_dci_name;
        }
 
        DCPContentType const * dcp_content_type () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
                return _dcp_content_type;
        }
 
-       Format const * format () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _format;
-       }
-
-       Crop crop () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _crop;
+       Ratio const * container () const {
+               return _container;
        }
 
-       std::vector<Filter const *> filters () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _filters;
+       Resolution resolution () const {
+               return _resolution;
        }
 
        Scaler const * scaler () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
                return _scaler;
        }
 
-       bool ab () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _ab;
-       }
-
-       float audio_gain () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _audio_gain;
+       bool with_subtitles () const {
+               return _with_subtitles;
        }
 
-       int audio_delay () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _audio_delay;
+       bool encrypted () const {
+               return _encrypted;
        }
 
-       bool with_subtitles () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _with_subtitles;
+       int j2k_bandwidth () const {
+               return _j2k_bandwidth;
        }
 
-       int subtitle_offset () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _subtitle_offset;
+       DCIMetadata dci_metadata () const {
+               return _dci_metadata;
        }
 
-       float subtitle_scale () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _subtitle_scale;
+       /** @return The frame rate of the DCP */
+       int video_frame_rate () const {
+               return _video_frame_rate;
        }
 
-       int colour_lut () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _colour_lut;
+       int audio_channels () const {
+               return _audio_channels;
        }
 
-       int j2k_bandwidth () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _j2k_bandwidth;
+       bool three_d () const {
+               return _three_d;
        }
 
-       DCIMetadata dci_metadata () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _dci_metadata;
+       bool sequence_video () const {
+               return _sequence_video;
        }
 
-       /* XXX: -> "video_frame_rate" */
-       int dcp_video_frame_rate () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _dcp_video_frame_rate;
+       bool interop () const {
+               return _interop;
        }
+       
 
        /* SET */
 
-       void set_directory (std::string);
+       void set_directory (boost::filesystem::path);
        void set_name (std::string);
        void set_use_dci_name (bool);
+       void examine_and_add_content (boost::shared_ptr<Content>);
        void add_content (boost::shared_ptr<Content>);
        void remove_content (boost::shared_ptr<Content>);
+       void move_content_earlier (boost::shared_ptr<Content>);
+       void move_content_later (boost::shared_ptr<Content>);
        void set_dcp_content_type (DCPContentType const *);
-       void set_format (Format const *);
-       void set_crop (Crop);
-       void set_left_crop (int);
-       void set_right_crop (int);
-       void set_top_crop (int);
-       void set_bottom_crop (int);
-       void set_filters (std::vector<Filter const *>);
+       void set_container (Ratio const *);
+       void set_resolution (Resolution);
        void set_scaler (Scaler const *);
-       void set_ab (bool);
-       void set_audio_gain (float);
-       void set_audio_delay (int);
        void set_with_subtitles (bool);
-       void set_subtitle_offset (int);
-       void set_subtitle_scale (float);
-       void set_colour_lut (int);
+       void set_encrypted (bool);
        void set_j2k_bandwidth (int);
        void set_dci_metadata (DCIMetadata);
-       void set_dcp_video_frame_rate (int);
+       void set_video_frame_rate (int);
+       void set_audio_channels (int);
+       void set_three_d (bool);
        void set_dci_date_today ();
+       void set_sequence_video (bool);
+       void set_interop (bool);
 
        /** Emitted when some property has of the Film has changed */
        mutable boost::signals2::signal<void (Property)> Changed;
@@ -275,33 +260,26 @@ public:
        /** Emitted when some property of our content has changed */
        mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
 
-       boost::signals2::signal<void ()> AudioAnalysisSucceeded;
-
        /** Current version number of the state file */
        static int const state_version;
 
 private:
-       
+
        void signal_changed (Property);
-       void analyse_audio_finished ();
-       std::string video_state_identifier () const;
-       void read_metadata ();
+       std::string video_identifier () const;
        void playlist_changed ();
        void playlist_content_changed (boost::weak_ptr<Content>, int);
        std::string filename_safe_name () const;
+       void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
 
        /** Log to write to */
        boost::shared_ptr<Log> _log;
-       /** Any running AnalyseAudioJob, or 0 */
-       boost::shared_ptr<AnalyseAudioJob> _analyse_audio_job;
        boost::shared_ptr<Playlist> _playlist;
 
        /** Complete path to directory containing the film metadata;
         *  must not be relative.
         */
-       std::string _directory;
-       /** Mutex for _directory */
-       mutable boost::mutex _directory_mutex;
+       boost::filesystem::path _directory;
        
        /** Name for DCP-o-matic */
        std::string _name;
@@ -309,51 +287,36 @@ private:
        bool _use_dci_name;
        /** 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.) */
-       Format const * _format;
-       /** The crop to apply to the source */
-       Crop _crop;
-       /** Video filters that should be used when generating DCPs */
-       std::vector<Filter const *> _filters;
+       /** The container to put this Film in (flat, scope, etc.) */
+       Ratio const * _container;
+       /** DCP resolution (2K or 4K) */
+       Resolution _resolution;
        /** Scaler algorithm to use */
        Scaler const * _scaler;
-       /** 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 _ab;
-       /** Gain to apply to audio in dB */
-       float _audio_gain;
-       /** Delay to apply to audio (positive moves audio later) in milliseconds */
-       int _audio_delay;
        /** True if subtitles should be shown for this film */
        bool _with_subtitles;
-       /** y offset for placing subtitles, in source pixels; +ve is further down
-           the frame, -ve is further up.
-       */
-       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;
+       bool _encrypted;
        /** bandwidth for J2K files in bits per second */
        int _j2k_bandwidth;
        /** DCI naming stuff */
        DCIMetadata _dci_metadata;
        /** Frames per second to run our DCP at */
-       int _dcp_video_frame_rate;
+       int _video_frame_rate;
        /** The date that we should use in a DCI name */
        boost::gregorian::date _dci_date;
+       /** Number of audio channels to put in the DCP */
+       int _audio_channels;
+       /** If true, the DCP will be written in 3D mode; otherwise in 2D.
+           This will be regardless of what content is on the playlist.
+       */
+       bool _three_d;
+       bool _sequence_video;
+       bool _interop;
+       libdcp::Key _key;
 
        /** true if our state has changed since we last saved it */
        mutable bool _dirty;
 
-       /** Mutex for all state except _directory */
-       mutable boost::mutex _state_mutex;
-
        friend class paths_test;
        friend class film_metadata_test;
 };