Improved comments.

[libdcp.git] / src / sound_asset_writer.h

diff --git a/src/sound_asset_writer.h b/src/sound_asset_writer.h
index 8c54b618e8e93279f487cf6a220f70aa146ce1b2..d2eba02474cc77ecf3887641fe8284fbd0a8f6d0 100644 (file)
--- a/src/sound_asset_writer.h
+++ b/src/sound_asset_writer.h
@@ -1,36 +1,60 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of libdcp.
+
+    libdcp is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    libdcp is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
+    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
+
 /** @file  src/sound_asset_writer.h
- *  @brief SoundAssetWriter class.
+ *  @brief SoundAssetWriter class
  */
 
+
 #include "asset_writer.h"
+#include "fsk.h"
 #include "types.h"
-#include <boost/shared_ptr.hpp>
+#include "sound_frame.h"
+#include <memory>
 #include <boost/filesystem.hpp>
+#include <boost/shared_array.hpp>
+
+
+struct sync_test1;
+
 
 namespace dcp {
 
-class SoundFrame;
+
 class SoundAsset;
 
+
 /** @class SoundAssetWriter
  *  @brief A helper class for writing to SoundAssets.
  *
@@ -43,26 +67,40 @@ class SoundAsset;
 class SoundAssetWriter : public AssetWriter
 {
 public:
+       /** @param data Pointer an array of float pointers, one for each channel.
+        *  @param frames Number of frames i.e. number of floats that are given for each channel.
+        */
        void write (float const * const *, int);
-       void finalize ();
+
+       bool finalize ();
 
 private:
        friend class SoundAsset;
+       friend struct ::sync_test1;
 
-       SoundAssetWriter (SoundAsset *, boost::filesystem::path, Standard standard);
+       SoundAssetWriter (SoundAsset *, boost::filesystem::path, std::vector<Channel> active_channels, bool sync);
 
+       void start ();
        void write_current_frame ();
+       std::vector<bool> create_sync_packets ();
 
        /* do this with an opaque pointer so we don't have to include
           ASDCP headers
        */
-          
+
        struct ASDCPState;
-       boost::shared_ptr<ASDCPState> _state;
+       std::shared_ptr<ASDCPState> _state;
 
-       SoundAsset* _sound_asset;
-       int _frame_buffer_offset;
+       SoundAsset* _asset = nullptr;
+       int _frame_buffer_offset = 0;
+
+       /** true to ignore any signal passed to write() on channel 14 and instead write a sync track */
+       bool _sync = false;
+       /** index of the sync packet (0-3) which starts the next edit unit */
+       int _sync_packet = 0;
+       FSK _fsk;
+
+       std::vector<Channel> _active_channels;
 };
 
 }
-