Asset -> ContentAsset.
[libdcp.git] / src / sound_asset.h
1 /*
2     Copyright (C) 2012 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 #ifndef LIBDCP_SOUND_ASSET_H
21 #define LIBDCP_SOUND_ASSET_H
22
23 /** @file  src/sound_asset.h
24  *  @brief An asset made up of PCM audio data files
25  */
26
27 #include "mxf_asset.h"
28 #include "types.h"
29 #include "metadata.h"
30
31 namespace dcp
32 {
33
34 class SoundFrame;
35 class SoundAsset;
36
37 class SoundAssetWriter
38 {
39 public:
40         void write (float const * const *, int);
41         void finalize ();
42
43 private:
44         friend class SoundAsset;
45
46         SoundAssetWriter (SoundAsset *);
47
48         /* no copy construction */
49         SoundAssetWriter (SoundAssetWriter const &);
50         SoundAssetWriter& operator= (SoundAssetWriter const &);
51         
52         void write_current_frame ();
53
54         /* do this with an opaque pointer so we don't have to include
55            ASDCP headers
56         */
57            
58         struct ASDCPState;
59         boost::shared_ptr<ASDCPState> _state;
60
61         SoundAsset* _asset;
62         bool _finalized;
63         int _frames_written;
64         int _frame_buffer_offset;
65 };
66
67 /** @brief An asset made up of WAV files */
68 class SoundAsset : public MXFAsset
69 {
70 public:
71         SoundAsset (boost::filesystem::path directory, boost::filesystem::path mxf_name);
72
73         void read ();
74
75         /** The following parameters must be set up (if required) before calling this:
76          *      Interop mode (set_interop)
77          *      Edit rate    (set_edit_rate)
78          *      MXF Metadata (set_metadata)
79          *      Channels     (set_channels)
80          *      Intrinsic duration (set_intrinsic_duration)
81          */
82         void create (std::vector<boost::filesystem::path> const & files);
83
84         /** The following parameters must be set up (if required) before calling this:
85          *      Interop mode (set_interop)
86          *      Edit rate    (set_edit_rate)
87          *      MXF Metadata (set_metadata)
88          *      Channels     (set_channels)
89          *      Intrinsic duration (set_intrinsic_duration)
90          */
91         void create (boost::function<boost::filesystem::path (Channel)> get_path);
92
93         boost::shared_ptr<SoundAssetWriter> start_write ();
94         
95         bool equals (boost::shared_ptr<const ContentAsset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
96
97         boost::shared_ptr<const SoundFrame> get_frame (int n) const;
98
99         void set_channels (int c) {
100                 _channels = c;
101         }
102         
103         int channels () const {
104                 return _channels;
105         }
106
107         void set_sampling_rate (int s) {
108                 _sampling_rate = s;
109         }
110
111         int sampling_rate () const {
112                 return _sampling_rate;
113         }
114
115 private:
116         std::string key_type () const;
117         void construct (boost::function<boost::filesystem::path (Channel)> get_path);
118         boost::filesystem::path path_from_channel (Channel channel, std::vector<boost::filesystem::path> const & files);
119         std::string cpl_node_name () const;
120
121         /** Number of channels in the asset */
122         int _channels;
123         int _sampling_rate;
124 };
125
126 }
127
128 #endif