Tweak comment.

[libdcp.git] / src / sound_asset.h

diff --git a/src/sound_asset.h b/src/sound_asset.h
index 8c63b530d4e8a4c48ffb2df7cb58c08a1f6c6dea..e9faeb8bb6d26c68f4fdcda46f2d6662a3f0c2ae 100644 (file)
--- a/src/sound_asset.h
+++ b/src/sound_asset.h
@@ -17,17 +17,83 @@
 
 */
 
+#ifndef LIBDCP_SOUND_ASSET_H
+#define LIBDCP_SOUND_ASSET_H
+
+/** @file  src/sound_asset.h
+ *  @brief An asset made up of WAV files
+ */
+
 #include "asset.h"
+#include "types.h"
 
 namespace libdcp
 {
 
+/** @brief An asset made up of WAV files */
 class SoundAsset : public Asset
 {
 public:
-       SoundAsset (std::list<std::string> const &, std::string, int, int);
+       /** 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 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 length Length in frames.
+        */
+       SoundAsset (
+               std::vector<std::string> const & files,
+               std::string directory,
+               std::string mxf_name,
+               sigc::signal1<void, float>* progress,
+               int fps,
+               int length
+               );
+
+       /** 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 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 length Length in frames.
+        *  @param channels Number of audio channels.
+        */
+       SoundAsset (
+               sigc::slot<std::string, Channel> get_path,
+               std::string directory,
+               std::string mxf_name,
+               sigc::signal1<void, float>* progress,
+               int fps,
+               int length,
+               int channels
+               );
 
-       void write_to_cpl (std::ostream &) const;
+       SoundAsset (
+               std::string directory,
+               std::string mxf_name,
+               int fps,
+               int length
+               );
+       
+       /** Write details of this asset to a CPL stream.
+        *  @param s Stream.
+        */
+       void write_to_cpl (std::ostream& s) const;
+
+       std::list<std::string> equals (boost::shared_ptr<const Asset> other, EqualityOptions opt) const;
+       
+private:
+       void construct (sigc::slot<std::string, Channel> get_path);
+       std::string path_from_channel (Channel channel, std::vector<std::string> const & files);
+
+       /** Number of channels in the asset */
+       int _channels;
 };
 
 }
+
+#endif