Merge master.
[libdcp.git] / src / sound_asset.h
index 8c63b530d4e8a4c48ffb2df7cb58c08a1f6c6dea..1e3553a0f48338af33fcf1fd08bbdf0a79c63f91 100644 (file)
 
 */
 
-#include "asset.h"
+#ifndef LIBDCP_SOUND_ASSET_H
+#define LIBDCP_SOUND_ASSET_H
+
+/** @file  src/sound_asset.h
+ *  @brief An asset made up of PCM audio data files
+ */
+
+#include "mxf_asset.h"
+#include "types.h"
+#include "metadata.h"
 
 namespace libdcp
 {
 
-class SoundAsset : public Asset
+class SoundFrame;
+class SoundAsset;
+
+class SoundAssetWriter
+{
+public:
+       ~SoundAssetWriter ();
+
+       void write (float const * const *, int);
+       void finalize ();
+
+private:
+       friend class SoundAsset;
+
+       SoundAssetWriter (SoundAsset *, MXFMetadata const &);
+
+       /* no copy construction */
+       SoundAssetWriter (SoundAssetWriter const &);
+       SoundAssetWriter& operator= (SoundAssetWriter const &);
+       
+       void write_current_frame ();
+
+       /* do this with an opaque pointer so we don't have to include
+          ASDCP headers
+       */
+          
+       struct ASDCPState;
+       boost::shared_ptr<ASDCPState> _state;
+
+       SoundAsset* _asset;
+       bool _finalized;
+       int _frames_written;
+       int _frame_buffer_offset;
+       MXFMetadata _metadata;
+};
+
+/** @brief An asset made up of WAV files */
+class SoundAsset : public MXFAsset
 {
 public:
-       SoundAsset (std::list<std::string> const &, std::string, int, int);
+       /** Construct a SoundAsset, generating the MXF from some WAV files.
+        *  This may take some time; progress is indicated by emission of the Progress signal.
+        *  @param files Pathnames of sound files, in the order Left, Right, Centre, Lfe (sub), Left surround, Right surround.
+        *  @param directory Directory in which to create MXF file.
+        *  @param mxf_name Name of MXF file to create.
+        *  @param progress Signal to inform of progress.
+        *  @param fps Frames per second.
+        *  @param intrinsic_duration Length of the whole asset in frames.
+        *  Note that this is different to entry_point in that the asset will contain no data before start_frame.
+        */
+       SoundAsset (
+               std::vector<std::string> const & files,
+               std::string directory,
+               std::string mxf_name,
+               boost::signals2::signal<void (float)>* progress,
+               int fps,
+               int intrinsic_duration,
+               MXFMetadata const & metadata = MXFMetadata ()
+               );
+
+       /** Construct a SoundAsset, generating the MXF from some WAV files.
+        *  This may take some time; progress is indicated by emission of the Progress signal.
+        *  @param get_path Functor which returns a WAV file path for a given channel.
+        *  @param directory Directory in which to create MXF file.
+        *  @param mxf_name Name of MXF file to create.
+        *  @param progress Signal to inform of progress.
+        *  @param fps Frames per second.
+        *  @param intrinsic_duration Length of the whole asset in frames.
+        *  @param channels Number of audio channels.
+        */
+       SoundAsset (
+               boost::function<std::string (Channel)> get_path,
+               std::string directory,
+               std::string mxf_name,
+               boost::signals2::signal<void (float)>* progress,
+               int fps,
+               int intrinsic_duration,
+               int channels,
+               MXFMetadata const & metadata = MXFMetadata ()
+               );
+
+       SoundAsset (
+               std::string directory,
+               std::string mxf_name
+               );
+
+       SoundAsset (
+               std::string directory,
+               std::string mxf_name,
+               int fps,
+               int channels,
+               int sampling_rate
+               );
+
+       boost::shared_ptr<SoundAssetWriter> start_write (MXFMetadata const & metadata = MXFMetadata ());
+       
+       /** Write details of this asset to a CPL XML node.
+        *  @param node Node.
+        */
+       void write_to_cpl (xmlpp::Node* node) const;
 
-       void write_to_cpl (std::ostream &) const;
+       bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
+
+       boost::shared_ptr<const SoundFrame> get_frame (int n) const;
+       
+       int channels () const {
+               return _channels;
+       }
+
+       int sampling_rate () const {
+               return _sampling_rate;
+       }
+
+private:
+       void construct (boost::function<std::string (Channel)> get_path, MXFMetadata const &);
+       std::string path_from_channel (Channel channel, std::vector<std::string> const & files);
+
+       /** Number of channels in the asset */
+       int _channels;
+       int _sampling_rate;
 };
 
 }
+
+#endif