Merge master.
[dcpomatic.git] / src / lib / film.h
index f5f9444092d2b634d892af93e452a15d46d21c73..071f474aca6f645a097dee2360e88e0a05cc6141 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 "dci_metadata.h"
+#include "types.h"
+#include "ffmpeg_content.h"
+#include "audio_mapping.h"
 
+class DCPContentType;
 class Format;
 class Job;
 class Filter;
@@ -47,32 +47,32 @@ class ExamineContentJob;
 class AnalyseAudioJob;
 class ExternalAudioStream;
 class Content;
+class Player;
 class Playlist;
 
 /** @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 (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 video_mxf_dir () const;
-       std::string video_mxf_filename () const;
+       std::string internal_video_mxf_dir () const;
+       std::string internal_video_mxf_filename () const;
        std::string audio_analysis_path () 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 ();
 
        /** @return Logger.
@@ -90,7 +90,6 @@ public:
        int target_audio_sample_rate () const;
        
        void write_metadata () const;
-       void read_metadata ();
 
        libdcp::Size cropped_size (libdcp::Size) const;
        std::string dci_name (bool if_created_now) const;
@@ -101,11 +100,33 @@ public:
                return _dirty;
        }
 
-       void set_dci_date_today ();
-
        bool have_dcp () const;
 
-       boost::shared_ptr<Playlist> playlist () const;
+       boost::shared_ptr<Player> player () const;
+
+       /* Proxies for some Playlist methods */
+
+       ContentAudioFrame audio_length () const;
+       int audio_channels () const;
+       int audio_frame_rate () const;
+       bool has_audio () const;
+       
+       float video_frame_rate () const;
+       libdcp::Size video_size () const;
+       ContentVideoFrame video_length () const;        
+
+       std::vector<FFmpegSubtitleStream> ffmpeg_subtitle_streams () const;
+       boost::optional<FFmpegSubtitleStream> ffmpeg_subtitle_stream () const;
+       std::vector<FFmpegAudioStream> ffmpeg_audio_streams () const;
+       boost::optional<FFmpegAudioStream> ffmpeg_audio_stream () const;
+
+       void set_ffmpeg_subtitle_stream (FFmpegSubtitleStream);
+       void set_ffmpeg_audio_stream (FFmpegAudioStream);
+
+       enum TrimType {
+               CPL,
+               ENCODE
+       };
 
        /** Identifiers for the parts of our state;
            used for signalling changes.
@@ -115,6 +136,7 @@ public:
                NAME,
                USE_DCI_NAME,
                TRUST_CONTENT_HEADERS,
+               /** The content list has changed (i.e. content has been added, moved around or removed) */
                CONTENT,
                DCP_CONTENT_TYPE,
                FORMAT,
@@ -124,17 +146,17 @@ public:
                TRIM_START,
                TRIM_END,
                AB,
+               TRIM_TYPE,
                AUDIO_GAIN,
                AUDIO_DELAY,
-               STILL_DURATION,
-               SUBTITLE_STREAM,
                WITH_SUBTITLES,
                SUBTITLE_OFFSET,
                SUBTITLE_SCALE,
                COLOUR_LUT,
                J2K_BANDWIDTH,
                DCI_METADATA,
-               DCP_FRAME_RATE
+               DCP_FRAME_RATE,
+               AUDIO_MAPPING
        };
 
 
@@ -160,7 +182,7 @@ public:
                return _trust_content_headers;
        }
 
-       std::list<boost::shared_ptr<Content> > content () const {
+       ContentList content () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _content;
        }
@@ -200,6 +222,11 @@ public:
                return _trim_end;
        }
 
+       TrimType trim_type () const {
+               boost::mutex::scoped_lock lm (_state_mutex);
+               return _trim_type;
+       }
+
        bool ab () const {
                boost::mutex::scoped_lock lm (_state_mutex);
                return _ab;
@@ -250,6 +277,11 @@ public:
                return _dcp_frame_rate;
        }
 
+       AudioMapping audio_mapping () const {
+               boost::mutex::scoped_lock lm (_state_mutex);
+               return _audio_mapping;
+       }
+
        /* SET */
 
        void set_directory (std::string);
@@ -257,6 +289,9 @@ public:
        void set_use_dci_name (bool);
        void set_trust_content_headers (bool);
        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);
@@ -269,9 +304,9 @@ public:
        void set_trim_start (int);
        void set_trim_end (int);
        void set_ab (bool);
+       void set_trim_type (TrimType);
        void set_audio_gain (float);
        void set_audio_delay (int);
-       void set_still_duration (int);
        void set_with_subtitles (bool);
        void set_subtitle_offset (int);
        void set_subtitle_scale (float);
@@ -279,10 +314,15 @@ public:
        void set_j2k_bandwidth (int);
        void set_dci_metadata (DCIMetadata);
        void set_dcp_frame_rate (int);
+       void set_dci_date_today ();
+       void set_audio_mapping (AudioMapping);
 
-       /** Emitted when some property has changed */
+       /** Emitted when some property has of the Film has changed */
        mutable boost::signals2::signal<void (Property)> Changed;
 
+       /** 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 */
@@ -290,16 +330,20 @@ public:
 
 private:
        
+       void signal_changed (Property);
+       void analyse_audio_finished ();
+       std::string video_state_identifier () const;
+       void read_metadata ();
+       void content_changed (boost::weak_ptr<Content>, int);
+       boost::shared_ptr<FFmpegContent> ffmpeg () const;
+       void setup_default_audio_mapping ();
+       std::string filename_safe_name () const;
+
        /** Log to write to */
        boost::shared_ptr<Log> _log;
-
        /** 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;
+       boost::shared_ptr<Playlist> _playlist;
 
        /** Complete path to directory containing the film metadata;
         *  must not be relative.
@@ -308,13 +352,12 @@ 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;
-       typedef std::list<boost::shared_ptr<Content> > ContentList;
-       ContentList _content;
        bool _trust_content_headers;
+       ContentList _content;
        /** 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.) */
@@ -329,6 +372,7 @@ private:
        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.
@@ -353,13 +397,13 @@ private:
        int _colour_lut;
        /** bandwidth for J2K files in bits per second */
        int _j2k_bandwidth;
-
        /** 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;
+       /** The date that we should use in a DCI name */
+       boost::gregorian::date _dci_date;
+       AudioMapping _audio_mapping;
 
        /** true if our state has changed since we last saved it */
        mutable bool _dirty;