Don't crash with bad content (#135).
[dcpomatic.git] / src / lib / film.h
index f0ccd99e77b33139b95ad23bc6d5678e18c4da9a..99c214ab7bd18776fe74aa54073975151bc3a801 100644 (file)
 #include <boost/signals2.hpp>
 #include <boost/enable_shared_from_this.hpp>
 #include "util.h"
-#include "dci_metadata.h"
 #include "types.h"
-#include "ffmpeg_content.h"
 #include "playlist.h"
+#include "dci_metadata.h"
 
 class DCPContentType;
-class Container;
-class Job;
-class Filter;
 class Log;
-class ExamineContentJob;
-class AnalyseAudioJob;
-class ExternalAudioStream;
 class Content;
 class Player;
 
 /** @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);
-       Film (Film 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;
+       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;
 
-       void analyse_audio ();
        void send_dcp_to_tms ();
        void make_dcp ();
 
@@ -97,13 +90,14 @@ public:
                return _dirty;
        }
 
+       libdcp::Size full_frame () const;
+
        bool have_dcp () const;
 
-       boost::shared_ptr<Player> player () const;
+       boost::shared_ptr<Player> make_player () const;
        boost::shared_ptr<Playlist> playlist () const;
 
        OutputAudioFrame dcp_audio_frame_rate () const;
-       int dcp_audio_channels () const;
 
        OutputAudioFrame time_to_audio_frames (Time) const;
        OutputVideoFrame time_to_video_frames (Time) const;
@@ -112,15 +106,12 @@ 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;
-
        /** Identifiers for the parts of our state;
            used for signalling changes.
        */
@@ -130,19 +121,16 @@ 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,
                CONTAINER,
-               FILTERS,
+               RESOLUTION,
                SCALER,
-               AB,
                WITH_SUBTITLES,
-               SUBTITLE_OFFSET,
-               SUBTITLE_SCALE,
-               COLOUR_LUT,
                J2K_BANDWIDTH,
                DCI_METADATA,
                DCP_VIDEO_FRAME_RATE,
+               DCP_AUDIO_CHANNELS,
+               SEQUENCE_VIDEO
        };
 
 
@@ -168,14 +156,14 @@ public:
                return _dcp_content_type;
        }
 
-       Container const * container () const {
+       Ratio const * container () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _container;
        }
 
-       std::vector<Filter const *> filters () const {
+       Resolution resolution () const {
                boost::mutex::scoped_lock lm (_state_mutex);
-               return _filters;
+               return _resolution;
        }
 
        Scaler const * scaler () const {
@@ -183,31 +171,11 @@ public:
                return _scaler;
        }
 
-       bool ab () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _ab;
-       }
-
        bool with_subtitles () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _with_subtitles;
        }
 
-       int subtitle_offset () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _subtitle_offset;
-       }
-
-       float subtitle_scale () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               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;
@@ -229,26 +197,31 @@ public:
                return _dcp_audio_channels;
        }
 
+       bool sequence_video () const {
+               boost::mutex::scoped_lock lm (_state_mutex);
+               return _sequence_video;
+       }
+       
+
        /* SET */
 
        void set_directory (std::string);
        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 set_dcp_content_type (DCPContentType const *);
-       void set_container (Container const *);
-       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_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_dci_metadata (DCIMetadata);
        void set_dcp_video_frame_rate (int);
+       void set_dcp_audio_channels (int);
        void set_dci_date_today ();
+       void set_sequence_video (bool);
 
        /** Emitted when some property has of the Film has changed */
        mutable boost::signals2::signal<void (Property)> Changed;
@@ -256,24 +229,20 @@ 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;
+       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;
@@ -290,29 +259,13 @@ private:
        /** The type of content that this Film represents (feature, trailer etc.) */
        DCPContentType const * _dcp_content_type;
        /** The container to put this Film in (flat, scope, etc.) */
-       Container const * _container;
-       /** Video filters that should be used when generating DCPs */
-       std::vector<Filter const *> _filters;
+       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;
        /** 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;
        /** bandwidth for J2K files in bits per second */
        int _j2k_bandwidth;
        /** DCI naming stuff */
@@ -322,6 +275,7 @@ private:
        /** The date that we should use in a DCI name */
        boost::gregorian::date _dci_date;
        int _dcp_audio_channels;
+       bool _sequence_video;
 
        /** true if our state has changed since we last saved it */
        mutable bool _dirty;