No-op: whitespace.
[libdcp.git] / src / sound_asset_writer.h
1 /*
2     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 /** @file  src/sound_asset_writer.h
21  *  @brief SoundAssetWriter class.
22  */
23
24 #include "asset_writer.h"
25 #include "types.h"
26 #include <boost/shared_ptr.hpp>
27 #include <boost/filesystem.hpp>
28
29 namespace dcp {
30
31 class SoundFrame;
32 class SoundAsset;
33
34 /** @class SoundAssetWriter
35  *  @brief A helper class for writing to SoundAssets.
36  *
37  *  Objects of this class can only be created with SoundAsset::start_write().
38  *
39  *  Sound samples can be written to the SoundAsset by calling write() with
40  *  a buffer of float values.  finalize() must be called after the last samples
41  *  have been written.
42  */
43 class SoundAssetWriter : public AssetWriter
44 {
45 public:
46         void write (float const * const *, int);
47         void finalize ();
48
49 private:
50         friend class SoundAsset;
51
52         SoundAssetWriter (SoundAsset *, boost::filesystem::path, Standard standard);
53
54         void write_current_frame ();
55
56         /* do this with an opaque pointer so we don't have to include
57            ASDCP headers
58         */
59
60         struct ASDCPState;
61         boost::shared_ptr<ASDCPState> _state;
62
63         SoundAsset* _sound_asset;
64         int _frame_buffer_offset;
65 };
66
67 }
68