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 /** @file src/sound_asset.cc
21 * @brief An asset made up of WAV files
26 #include <boost/filesystem.hpp>
27 #include <boost/lexical_cast.hpp>
28 #include "KM_fileio.h"
30 #include "sound_asset.h"
32 #include "exceptions.h"
33 #include "sound_frame.h"
36 using std::stringstream;
40 using boost::shared_ptr;
41 using boost::lexical_cast;
42 using namespace libdcp;
44 SoundAsset::SoundAsset (
45 vector<string> const & files,
48 boost::signals2::signal<void (float)>* progress,
49 int fps, int intrinsic_duration
51 : MXFAsset (directory, mxf_name, progress, fps, intrinsic_duration)
52 , _channels (files.size ())
57 construct (boost::bind (&SoundAsset::path_from_channel, this, _1, files));
60 SoundAsset::SoundAsset (
61 boost::function<string (Channel)> get_path,
64 boost::signals2::signal<void (float)>* progress,
65 int fps, int intrinsic_duration, int channels
67 : MXFAsset (directory, mxf_name, progress, fps, intrinsic_duration)
68 , _channels (channels)
76 SoundAsset::SoundAsset (string directory, string mxf_name)
77 : MXFAsset (directory, mxf_name)
80 ASDCP::PCM::MXFReader reader;
81 if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
82 throw MXFFileError ("could not open MXF file for reading", path().string());
85 ASDCP::PCM::AudioDescriptor desc;
86 if (ASDCP_FAILURE (reader.FillAudioDescriptor (desc))) {
87 throw DCPReadError ("could not read audio MXF information");
90 _sampling_rate = desc.AudioSamplingRate.Numerator / desc.AudioSamplingRate.Denominator;
91 _channels = desc.ChannelCount;
92 _edit_rate = desc.EditRate.Numerator;
93 assert (desc.EditRate.Denominator == 1);
94 _intrinsic_duration = desc.ContainerDuration;
97 SoundAsset::SoundAsset (string directory, string mxf_name, int fps, int channels, int sampling_rate)
98 : MXFAsset (directory, mxf_name, 0, fps, 0)
99 , _channels (channels)
100 , _sampling_rate (sampling_rate)
106 SoundAsset::path_from_channel (Channel channel, vector<string> const & files)
108 unsigned int const c = int (channel);
109 assert (c < files.size ());
114 SoundAsset::construct (boost::function<string (Channel)> get_path)
116 ASDCP::Rational asdcp_edit_rate (_edit_rate, 1);
118 ASDCP::PCM::WAVParser pcm_parser_channel[_channels];
119 if (pcm_parser_channel[0].OpenRead (get_path(LEFT).c_str(), asdcp_edit_rate)) {
120 throw FileError ("could not open WAV file for reading", get_path(LEFT));
123 ASDCP::PCM::AudioDescriptor audio_desc;
124 pcm_parser_channel[0].FillAudioDescriptor (audio_desc);
125 audio_desc.ChannelCount = 0;
126 audio_desc.BlockAlign = 0;
127 audio_desc.EditRate = asdcp_edit_rate;
128 audio_desc.AvgBps = audio_desc.AvgBps * _channels;
130 Channel channels[] = {
137 /* XXX: not quite sure what these should be yet */
142 assert (int(_channels) <= int(sizeof(channels) / sizeof(Channel)));
144 ASDCP::PCM::FrameBuffer frame_buffer_channel[_channels];
145 ASDCP::PCM::AudioDescriptor audio_desc_channel[_channels];
147 for (int i = 0; i < _channels; ++i) {
149 string const path = get_path (channels[i]);
151 if (ASDCP_FAILURE (pcm_parser_channel[i].OpenRead (path.c_str(), asdcp_edit_rate))) {
152 throw FileError ("could not open WAV file for reading", path);
155 pcm_parser_channel[i].FillAudioDescriptor (audio_desc_channel[i]);
156 frame_buffer_channel[i].Capacity (ASDCP::PCM::CalcFrameBufferSize (audio_desc_channel[i]));
158 audio_desc.ChannelCount += audio_desc_channel[i].ChannelCount;
159 audio_desc.BlockAlign += audio_desc_channel[i].BlockAlign;
162 ASDCP::PCM::FrameBuffer frame_buffer;
163 frame_buffer.Capacity (ASDCP::PCM::CalcFrameBufferSize (audio_desc));
164 frame_buffer.Size (ASDCP::PCM::CalcFrameBufferSize (audio_desc));
166 ASDCP::WriterInfo writer_info;
167 MXFAsset::fill_writer_info (&writer_info, _uuid);
169 ASDCP::PCM::MXFWriter mxf_writer;
170 if (ASDCP_FAILURE (mxf_writer.OpenWrite (path().string().c_str(), writer_info, audio_desc))) {
171 throw FileError ("could not open audio MXF for writing", path().string());
174 for (int i = 0; i < _intrinsic_duration; ++i) {
176 for (int j = 0; j < _channels; ++j) {
177 memset (frame_buffer_channel[j].Data(), 0, frame_buffer_channel[j].Capacity());
178 if (ASDCP_FAILURE (pcm_parser_channel[j].ReadFrame (frame_buffer_channel[j]))) {
179 throw MiscError ("could not read audio frame");
183 byte_t *data_s = frame_buffer.Data();
184 byte_t *data_e = data_s + frame_buffer.Capacity();
185 byte_t sample_size = ASDCP::PCM::CalcSampleSize (audio_desc_channel[0]);
188 while (data_s < data_e) {
189 for (int j = 0; j < _channels; ++j) {
190 byte_t* frame = frame_buffer_channel[j].Data() + offset;
191 memcpy (data_s, frame, sample_size);
192 data_s += sample_size;
194 offset += sample_size;
197 if (ASDCP_FAILURE (mxf_writer.WriteFrame (frame_buffer, 0, 0))) {
198 throw MiscError ("could not write audio MXF frame");
202 (*_progress) (0.5 * float (i) / _intrinsic_duration);
206 if (ASDCP_FAILURE (mxf_writer.Finalize())) {
207 throw MiscError ("could not finalise audio MXF");
212 SoundAsset::write_to_cpl (ostream& s) const
214 s << " <MainSound>\n"
215 << " <Id>urn:uuid:" << _uuid << "</Id>\n"
216 << " <AnnotationText>" << _file_name << "</AnnotationText>\n"
217 << " <EditRate>" << _edit_rate << " 1</EditRate>\n"
218 << " <IntrinsicDuration>" << _intrinsic_duration << "</IntrinsicDuration>\n"
219 << " <EntryPoint>" << _entry_point << "</EntryPoint>\n"
220 << " <Duration>" << _duration << "</Duration>\n"
221 << " </MainSound>\n";
225 SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
227 if (!MXFAsset::equals (other, opt, notes)) {
231 ASDCP::PCM::MXFReader reader_A;
232 if (ASDCP_FAILURE (reader_A.OpenRead (path().string().c_str()))) {
233 throw MXFFileError ("could not open MXF file for reading", path().string());
236 ASDCP::PCM::MXFReader reader_B;
237 if (ASDCP_FAILURE (reader_B.OpenRead (other->path().string().c_str()))) {
238 throw MXFFileError ("could not open MXF file for reading", path().string());
241 ASDCP::PCM::AudioDescriptor desc_A;
242 if (ASDCP_FAILURE (reader_A.FillAudioDescriptor (desc_A))) {
243 throw DCPReadError ("could not read audio MXF information");
245 ASDCP::PCM::AudioDescriptor desc_B;
246 if (ASDCP_FAILURE (reader_B.FillAudioDescriptor (desc_B))) {
247 throw DCPReadError ("could not read audio MXF information");
251 desc_A.EditRate != desc_B.EditRate ||
252 desc_A.AudioSamplingRate != desc_B.AudioSamplingRate ||
253 desc_A.Locked != desc_B.Locked ||
254 desc_A.ChannelCount != desc_B.ChannelCount ||
255 desc_A.QuantizationBits != desc_B.QuantizationBits ||
256 desc_A.BlockAlign != desc_B.BlockAlign ||
257 desc_A.AvgBps != desc_B.AvgBps ||
258 desc_A.LinkedTrackID != desc_B.LinkedTrackID ||
259 desc_A.ContainerDuration != desc_B.ContainerDuration
260 // desc_A.ChannelFormat != desc_B.ChannelFormat ||
263 notes.push_back ("audio MXF picture descriptors differ");
267 ASDCP::PCM::FrameBuffer buffer_A (1 * Kumu::Megabyte);
268 ASDCP::PCM::FrameBuffer buffer_B (1 * Kumu::Megabyte);
270 for (int i = 0; i < _intrinsic_duration; ++i) {
271 if (ASDCP_FAILURE (reader_A.ReadFrame (i, buffer_A))) {
272 throw DCPReadError ("could not read audio frame");
275 if (ASDCP_FAILURE (reader_B.ReadFrame (i, buffer_B))) {
276 throw DCPReadError ("could not read audio frame");
279 if (buffer_A.Size() != buffer_B.Size()) {
280 notes.push_back ("sizes of audio data for frame " + lexical_cast<string>(i) + " differ");
284 if (memcmp (buffer_A.RoData(), buffer_B.RoData(), buffer_A.Size()) != 0) {
285 for (uint32_t i = 0; i < buffer_A.Size(); ++i) {
286 int const d = abs (buffer_A.RoData()[i] - buffer_B.RoData()[i]);
287 if (d > opt.max_audio_sample_error) {
288 notes.push_back ("PCM data difference of " + lexical_cast<string> (d));
298 shared_ptr<const SoundFrame>
299 SoundAsset::get_frame (int n) const
301 return shared_ptr<const SoundFrame> (new SoundFrame (path().string(), n + _entry_point));
304 shared_ptr<SoundAssetWriter>
305 SoundAsset::start_write ()
307 /* XXX: can't we use a shared_ptr here? */
308 return shared_ptr<SoundAssetWriter> (new SoundAssetWriter (this));
311 struct SoundAssetWriter::ASDCPState
313 ASDCP::PCM::MXFWriter mxf_writer;
314 ASDCP::PCM::FrameBuffer frame_buffer;
315 ASDCP::WriterInfo writer_info;
316 ASDCP::PCM::AudioDescriptor audio_desc;
319 SoundAssetWriter::SoundAssetWriter (SoundAsset* a)
320 : _state (new SoundAssetWriter::ASDCPState)
323 , _frames_written (0)
324 , _frame_buffer_offset (0)
326 /* Derived from ASDCP::Wav::SimpleWaveHeader::FillADesc */
327 _state->audio_desc.EditRate = ASDCP::Rational (_asset->edit_rate(), 1);
328 _state->audio_desc.AudioSamplingRate = ASDCP::Rational (_asset->sampling_rate(), 1);
329 _state->audio_desc.Locked = 0;
330 _state->audio_desc.ChannelCount = _asset->channels ();
331 _state->audio_desc.QuantizationBits = 24;
332 _state->audio_desc.BlockAlign = 3 * _asset->channels();
333 _state->audio_desc.AvgBps = _asset->sampling_rate() * _state->audio_desc.BlockAlign;
334 _state->audio_desc.LinkedTrackID = 0;
335 _state->audio_desc.ChannelFormat = ASDCP::PCM::CF_NONE;
337 _state->frame_buffer.Capacity (ASDCP::PCM::CalcFrameBufferSize (_state->audio_desc));
338 _state->frame_buffer.Size (ASDCP::PCM::CalcFrameBufferSize (_state->audio_desc));
339 memset (_state->frame_buffer.Data(), 0, _state->frame_buffer.Capacity());
341 MXFAsset::fill_writer_info (&_state->writer_info, _asset->uuid ());
343 if (ASDCP_FAILURE (_state->mxf_writer.OpenWrite (_asset->path().string().c_str(), _state->writer_info, _state->audio_desc))) {
344 throw FileError ("could not open audio MXF for writing", _asset->path().string());
349 SoundAssetWriter::write (float const * const * data, int frames)
351 for (int i = 0; i < frames; ++i) {
353 byte_t* out = _state->frame_buffer.Data() + _frame_buffer_offset;
355 /* Write one sample per channel */
356 for (int j = 0; j < _asset->channels(); ++j) {
357 int32_t const s = data[j][i] * (1 << 23);
359 *out++ = (s & 0xff00) >> 8;
360 *out++ = (s & 0xff0000) >> 16;
362 _frame_buffer_offset += 3 * _asset->channels();
364 assert (_frame_buffer_offset <= int (_state->frame_buffer.Capacity()));
366 /* Finish the MXF frame if required */
367 if (_frame_buffer_offset == int (_state->frame_buffer.Capacity())) {
368 write_current_frame ();
369 _frame_buffer_offset = 0;
370 memset (_state->frame_buffer.Data(), 0, _state->frame_buffer.Capacity());
376 SoundAssetWriter::write_current_frame ()
378 if (ASDCP_FAILURE (_state->mxf_writer.WriteFrame (_state->frame_buffer, 0, 0))) {
379 throw MiscError ("could not write audio MXF frame");
386 SoundAssetWriter::finalize ()
388 if (_frame_buffer_offset > 0) {
389 write_current_frame ();
392 if (ASDCP_FAILURE (_state->mxf_writer.Finalize())) {
393 throw MiscError ("could not finalise audio MXF");
397 _asset->set_intrinsic_duration (_frames_written);
398 _asset->set_duration (_frames_written);
401 SoundAssetWriter::~SoundAssetWriter ()