Fix erroneous extra character.
[libdcp.git] / src / sound_asset.h
index c63bab90ccd391f49a7aeab8bb1d98c5176b0097..73734f9fa67ce5a0ac4209ce19a8836343d2c34a 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 */
 
 /** @file  src/sound_asset.h
- *  @brief An asset made up of WAV files
+ *  @brief SoundAsset class
  */
 
-#include "asset.h"
+#ifndef LIBDCP_SOUND_ASSET_H
+#define LIBDCP_SOUND_ASSET_H
 
-namespace libdcp
+#include "mxf.h"
+#include "types.h"
+#include "metadata.h"
+
+namespace dcp
 {
 
-/** @brief An asset made up of WAV files */
-class SoundAsset : public Asset
+class SoundFrame;
+class SoundAssetWriter;
+
+/** @class SoundAsset
+ *  @brief Representation of a sound asset
+ */
+class SoundAsset : public Asset, public MXF
 {
 public:
-       /** Construct a SoundAsset, generating the MXF from the 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 mxf_path Pathname of MXF file to create.
-        *  @param progress Signal to inform of progress.
-        *  @param fps Frames per second.
-        *  @param length Length in frames.
-        */
-       SoundAsset (std::list<std::string> const & files, std::string mxf_path, sigc::signal1<void, float>* progress, int fps, int length);
+       SoundAsset (boost::filesystem::path file);
+       SoundAsset (Fraction edit_rate, int sampling_rate, int channels);
+
+       boost::shared_ptr<SoundAssetWriter> start_write (boost::filesystem::path file, Standard standard);
+
+       bool equals (
+               boost::shared_ptr<const Asset> other,
+               EqualityOptions opt,
+               NoteHandler note
+               ) const;
+
+       boost::shared_ptr<const SoundFrame> get_frame (int n) const;
+
+       /** @return number of channels */
+       int channels () const {
+               return _channels;
+       }
 
-       /** Write details of this asset to a CPL stream.
-        *  @param s Stream.
+       /** @return sampling rate in Hz */
+       int sampling_rate () const {
+               return _sampling_rate;
+       }
+
+       Fraction edit_rate () const {
+               return _edit_rate;
+       }
+
+       int64_t intrinsic_duration () const {
+               return _intrinsic_duration;
+       }
+
+       static bool valid_mxf (boost::filesystem::path);
+
+private:
+       friend class SoundAssetWriter;
+
+       std::string pkl_type (Standard standard) const;
+
+       Fraction _edit_rate;
+       /** The total length of this content in video frames.  The amount of
+        *  content presented may be less than this.
         */
-       void write_to_cpl (std::ostream& s) const;
+       int64_t _intrinsic_duration;
+       int _channels;      ///< number of channels
+       int _sampling_rate; ///< sampling rate in Hz
 };
 
 }
+
+#endif