Merge master.
[dcpomatic.git] / src / lib / film.h
index ca9bd57f43a0fbd4439d5db12247b3b2e194ea3f..f5a7c1246c38c2f133f8d82044be6531b26662f8 100644 (file)
 */
 
 /** @file  src/film.h
- *  @brief A representation of a piece of video (with sound), including naming,
- *  the source content file, and how it should be presented in a DCP.
+ *  @brief A representation of some audio and video content, and details of
+ *  how they should be presented in a DCP.
  */
 
-#ifndef DVDOMATIC_FILM_H
-#define DVDOMATIC_FILM_H
+#ifndef DCPOMATIC_FILM_H
+#define DCPOMATIC_FILM_H
 
 #include <string>
 #include <vector>
 #include <boost/thread.hpp>
 #include <boost/signals2.hpp>
 #include <boost/enable_shared_from_this.hpp>
-extern "C" {
-#include <libavcodec/avcodec.h>
-}
-#include "dcp_content_type.h"
 #include "util.h"
-#include "stream.h"
 #include "dci_metadata.h"
+#include "types.h"
+#include "ffmpeg_content.h"
+#include "playlist.h"
 
-class Format;
+class DCPContentType;
 class Job;
 class Filter;
 class Log;
 class ExamineContentJob;
 class AnalyseAudioJob;
 class ExternalAudioStream;
+class Content;
+class Player;
 
 /** @class Film
- *  @brief A representation of a video, maybe with sound.
- *
- *  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.
+ *  @brief A representation of some audio and video content, and details of
+ *  how they should be presented in a DCP.
  */
 class Film : public boost::enable_shared_from_this<Film>
 {
 public:
-       Film (std::string d, bool must_exist = true);
+       Film (std::string d);
        Film (Film const &);
-       ~Film ();
 
        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;
 
        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 ();
 
        /** @return Logger.
@@ -89,15 +83,9 @@ public:
        std::string file (std::string f) const;
        std::string dir (std::string d) const;
 
-       std::string content_path () const;
-       ContentType content_type () const;
-       
-       int target_audio_sample_rate () const;
-       
-       void write_metadata () 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;
 
@@ -106,16 +94,32 @@ public:
                return _dirty;
        }
 
-       int audio_channels () const;
-
-       void set_dci_date_today ();
+       libdcp::Size full_frame () const;
 
        bool have_dcp () const;
 
-       enum TrimType {
-               CPL,
-               ENCODE
-       };
+       boost::shared_ptr<Player> player () const;
+       boost::shared_ptr<Playlist> playlist () const;
+
+       OutputAudioFrame dcp_audio_frame_rate () const;
+
+       OutputAudioFrame time_to_audio_frames (Time) const;
+       OutputVideoFrame time_to_video_frames (Time) const;
+       Time video_frames_to_time (OutputVideoFrame) const;
+       Time audio_frames_to_time (OutputAudioFrame) const;
+
+       /* Proxies for some Playlist methods */
+
+       Playlist::ContentList content () const;
+
+       Time length () const;
+       bool has_subtitles () const;
+       OutputVideoFrame best_dcp_video_frame_rate () const;
+
+       void set_loop (int);
+       int loop () const;
+
+       void set_sequence_video (bool);
 
        /** Identifiers for the parts of our state;
            used for signalling changes.
@@ -124,36 +128,19 @@ public:
                NONE,
                NAME,
                USE_DCI_NAME,
+               /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
                CONTENT,
-               TRUST_CONTENT_HEADER,
+               LOOP,
                DCP_CONTENT_TYPE,
-               FORMAT,
-               CROP,
-               FILTERS,
+               CONTAINER,
                SCALER,
-               TRIM_START,
-               TRIM_END,
-               TRIM_TYPE,
-               DCP_AB,
-               CONTENT_AUDIO_STREAM,
-               EXTERNAL_AUDIO,
-               USE_CONTENT_AUDIO,
-               AUDIO_GAIN,
-               AUDIO_DELAY,
-               STILL_DURATION,
-               SUBTITLE_STREAM,
                WITH_SUBTITLES,
                SUBTITLE_OFFSET,
                SUBTITLE_SCALE,
                COLOUR_LUT,
                J2K_BANDWIDTH,
                DCI_METADATA,
-               SIZE,
-               LENGTH,
-               CONTENT_AUDIO_STREAMS,
-               SUBTITLE_STREAMS,
-               SOURCE_FRAME_RATE,
-               DCP_FRAME_RATE,
+               DCP_VIDEO_FRAME_RATE,
                MINIMUM_AUDIO_CHANNELS
        };
 
@@ -175,34 +162,14 @@ public:
                return _use_dci_name;
        }
 
-       std::string content () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               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;
        }
 
-       Format const * format () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _format;
-       }
-
-       Crop crop () const {
+       Ratio const * container () const {
                boost::mutex::scoped_lock lm (_state_mutex);
-               return _crop;
-       }
-
-       std::vector<Filter const *> filters () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _filters;
+               return _container;
        }
 
        Scaler const * scaler () const {
@@ -210,63 +177,6 @@ public:
                return _scaler;
        }
 
-       int trim_start () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _trim_start;
-       }
-
-       int trim_end () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               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;
-       }
-
-       boost::shared_ptr<AudioStream> content_audio_stream () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _content_audio_stream;
-       }
-
-       std::vector<std::string> external_audio () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _external_audio;
-       }
-
-       bool use_content_audio () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _use_content_audio;
-       }
-       
-       float audio_gain () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _audio_gain;
-       }
-
-       int audio_delay () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _audio_delay;
-       }
-
-       int still_duration () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               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;
-       }
-
        bool with_subtitles () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _with_subtitles;
@@ -297,43 +207,15 @@ public:
                return _dci_metadata;
        }
 
-       int dcp_frame_rate () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _dcp_frame_rate;
-       }
-       
-       libdcp::Size size () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _size;
-       }
-
-       boost::optional<SourceFrame> length () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _length;
-       }
-       
-       std::string content_digest () const {
+       /* XXX: -> "video_frame_rate" */
+       int dcp_video_frame_rate () const {
                boost::mutex::scoped_lock lm (_state_mutex);
-               return _content_digest;
-       }
-       
-       std::vector<boost::shared_ptr<AudioStream> > content_audio_streams () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _content_audio_streams;
+               return _dcp_video_frame_rate;
        }
 
-       std::vector<boost::shared_ptr<SubtitleStream> > subtitle_streams () const {
-               boost::mutex::scoped_lock lm (_state_mutex);
-               return _subtitle_streams;
-       }
-       
-       float source_frame_rate () const {
+       int dcp_audio_channels () const {
                boost::mutex::scoped_lock lm (_state_mutex);
-               if (content_type() == STILL) {
-                       return 24;
-               }
-               
-               return _source_frame_rate;
+               return _dcp_audio_channels;
        }
 
        int minimum_audio_channels () const {
@@ -341,75 +223,48 @@ public:
                return _minimum_audio_channels;
        }
 
-       boost::shared_ptr<AudioStream> audio_stream () const;
-       bool has_audio () const;
-       
        /* SET */
 
        void set_directory (std::string);
        void set_name (std::string);
        void set_use_dci_name (bool);
-       void set_content (std::string);
-       void set_trust_content_header (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_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_scaler (Scaler const *);
-       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>);
-       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::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_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_source_frame_rate (float);
+       void set_dcp_video_frame_rate (int);
+       void set_dci_date_today ();
        void set_minimum_audio_channels (int);
 
-       /** Emitted when some property has changed */
+       /** Emitted when some property has of the Film has changed */
        mutable boost::signals2::signal<void (Property)> Changed;
 
-       boost::signals2::signal<void ()> AudioAnalysisSucceeded;
+       /** Emitted when some property of our content has changed */
+       mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
 
        /** Current version number of the state file */
        static int const state_version;
 
 private:
        
-       /** Log to write to */
-       boost::shared_ptr<Log> _log;
-
-       /** Any running ExamineContentJob, or 0 */
-       boost::shared_ptr<ExamineContentJob> _examine_content_job;
-       /** 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;
+       void playlist_changed ();
+       void playlist_content_changed (boost::weak_ptr<Content>, int);
        std::string filename_safe_name () const;
+       void add_content_weak (boost::weak_ptr<Content>);
+
+       /** Log to write to */
+       boost::shared_ptr<Log> _log;
+       boost::shared_ptr<Playlist> _playlist;
 
        /** Complete path to directory containing the film metadata;
         *  must not be relative.
@@ -418,54 +273,16 @@ private:
        /** Mutex for _directory */
        mutable boost::mutex _directory_mutex;
        
-       /** Name for DVD-o-matic */
+       /** Name for DCP-o-matic */
        std::string _name;
        /** True if a auto-generated DCI-compliant name should be used for our DCP */
        bool _use_dci_name;
-       /** File or directory containing content; may be relative to our directory
-        *  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.) */
-       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;
        /** Scaler algorithm to use */
        Scaler const * _scaler;
-       /** 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.
-       */
-       bool _dcp_ab;
-       /** 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::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
@@ -481,32 +298,15 @@ private:
        int _colour_lut;
        /** 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;
        /** 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;
+       int _dcp_audio_channels;
        int _minimum_audio_channels;
 
-       /* Data which are cached to speed things up */
-
-       /** Size, in pixels, of the source (ignoring cropping) */
-       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> _sndfile_stream;
-       /** the subtitle streams that we can use */
-       std::vector<boost::shared_ptr<SubtitleStream> > _subtitle_streams;
-       /** Frames per second of the source */
-       float _source_frame_rate;
-
        /** true if our state has changed since we last saved it */
        mutable bool _dirty;