2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
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.
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.
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.
20 #ifndef LIBDCP_SOUND_ASSET_H
21 #define LIBDCP_SOUND_ASSET_H
23 /** @file src/sound_asset.h
24 * @brief An asset made up of PCM audio data files
27 #include "mxf_asset.h"
37 class SoundAssetWriter
40 void write (float const * const *, int);
44 friend class SoundAsset;
46 SoundAssetWriter (SoundAsset *, MXFMetadata const &);
48 /* no copy construction */
49 SoundAssetWriter (SoundAssetWriter const &);
50 SoundAssetWriter& operator= (SoundAssetWriter const &);
52 void write_current_frame ();
54 /* do this with an opaque pointer so we don't have to include
59 boost::shared_ptr<ASDCPState> _state;
64 int _frame_buffer_offset;
65 MXFMetadata _metadata;
68 /** @brief An asset made up of WAV files */
69 class SoundAsset : public MXFAsset
72 /** Construct a SoundAsset, generating the MXF from some WAV files.
73 * This may take some time; progress is indicated by emission of the Progress signal.
74 * @param files Pathnames of sound files, in the order Left, Right, Centre, Lfe (sub), Left surround, Right surround.
75 * @param directory Directory in which to create MXF file.
76 * @param mxf_name Name of MXF file to create.
77 * @param progress Signal to inform of progress.
78 * @param fps Frames per second.
79 * @param intrinsic_duration Length of the whole asset in frames.
80 * Note that this is different to entry_point in that the asset will contain no data before start_frame.
83 std::vector<std::string> const & files,
84 std::string directory,
86 boost::signals2::signal<void (float)>* progress,
88 int intrinsic_duration,
89 MXFMetadata const & metadata = MXFMetadata ()
92 /** Construct a SoundAsset, generating the MXF from some WAV files.
93 * This may take some time; progress is indicated by emission of the Progress signal.
94 * @param get_path Functor which returns a WAV file path for a given channel.
95 * @param directory Directory in which to create MXF file.
96 * @param mxf_name Name of MXF file to create.
97 * @param progress Signal to inform of progress.
98 * @param fps Frames per second.
99 * @param intrinsic_duration Length of the whole asset in frames.
100 * @param channels Number of audio channels.
103 boost::function<std::string (Channel)> get_path,
104 std::string directory,
105 std::string mxf_name,
106 boost::signals2::signal<void (float)>* progress,
108 int intrinsic_duration,
110 MXFMetadata const & metadata = MXFMetadata ()
114 std::string directory,
119 std::string directory,
120 std::string mxf_name,
126 boost::shared_ptr<SoundAssetWriter> start_write (MXFMetadata const & metadata = MXFMetadata ());
128 /** Write details of this asset to a CPL XML node.
131 void write_to_cpl (xmlpp::Node* node) const;
133 bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
135 boost::shared_ptr<const SoundFrame> get_frame (int n) const;
137 int channels () const {
141 int sampling_rate () const {
142 return _sampling_rate;
146 void construct (boost::function<std::string (Channel)> get_path, MXFMetadata const &);
147 std::string path_from_channel (Channel channel, std::vector<std::string> const & files);
149 /** Number of channels in the asset */