Bump version
[libdcp.git] / src / sound_asset.h
index d41b72d5f995adc3862529f97bfa735be606d743..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
 
 */
 
-#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
+ *  @brief SoundAsset class
  */
 
-#include "mxf_asset.h"
+#ifndef LIBDCP_SOUND_ASSET_H
+#define LIBDCP_SOUND_ASSET_H
+
+#include "mxf.h"
 #include "types.h"
 #include "metadata.h"
 
-namespace libdcp
+namespace dcp
 {
 
 class SoundFrame;
-class SoundAsset;
+class SoundAssetWriter;
 
-class SoundAssetWriter
-{
-public:
-       void write (float const * const *, int);
-       void finalize ();
-
-private:
-       friend class SoundAsset;
-
-       SoundAssetWriter (SoundAsset *);
-
-       /* 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;
-};
-
-/** @brief An asset made up of WAV files */
-class SoundAsset : public MXFAsset
+/** @class SoundAsset
+ *  @brief Representation of a sound asset
+ */
+class SoundAsset : public Asset, public MXF
 {
 public:
-       SoundAsset (boost::filesystem::path directory, std::string mxf_name);
+       SoundAsset (boost::filesystem::path file);
+       SoundAsset (Fraction edit_rate, int sampling_rate, int channels);
 
-       void read ();
-       void create (std::vector<boost::filesystem::path> const & files);
-       void create (boost::function<boost::filesystem::path (Channel)> get_path);
+       boost::shared_ptr<SoundAssetWriter> start_write (boost::filesystem::path file, Standard standard);
 
-       boost::shared_ptr<SoundAssetWriter> start_write ();
-       
-       bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
+       bool equals (
+               boost::shared_ptr<const Asset> other,
+               EqualityOptions opt,
+               NoteHandler note
+               ) const;
 
        boost::shared_ptr<const SoundFrame> get_frame (int n) const;
 
-       void set_channels (int c) {
-               _channels = c;
-       }
-       
+       /** @return number of channels */
        int channels () const {
                return _channels;
        }
 
+       /** @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:
-       std::string key_type () const;
-       void construct (boost::function<boost::filesystem::path (Channel)> get_path);
-       boost::filesystem::path path_from_channel (Channel channel, std::vector<boost::filesystem::path> const & files);
-       std::string cpl_node_name () const;
-
-       /** Number of channels in the asset */
-       int _channels;
-       int _sampling_rate;
+       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.
+        */
+       int64_t _intrinsic_duration;
+       int _channels;      ///< number of channels
+       int _sampling_rate; ///< sampling rate in Hz
 };
 
 }