0d0e1cd4e7408c0ebe09af61dee2aeb262edbe72
[libdcp.git] / src / sound_asset.cc
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 /** @file  src/sound_asset.cc
21  *  @brief An asset made up of WAV files
22  */
23
24 #include <iostream>
25 #include <stdexcept>
26 #include <boost/filesystem.hpp>
27 #include <boost/lexical_cast.hpp>
28 #include "KM_fileio.h"
29 #include "AS_DCP.h"
30 #include "sound_asset.h"
31 #include "util.h"
32 #include "exceptions.h"
33 #include "sound_frame.h"
34
35 using std::string;
36 using std::stringstream;
37 using std::ostream;
38 using std::vector;
39 using std::list;
40 using boost::shared_ptr;
41 using boost::lexical_cast;
42 using namespace libdcp;
43
44 SoundAsset::SoundAsset (
45         vector<string> const & files, string directory, string mxf_name, boost::signals2::signal<void (float)>* progress, int fps, int length
46         )
47         : MXFAsset (directory, mxf_name, progress, fps, 0, length)
48         , _channels (files.size ())
49         , _sampling_rate (0)
50 {
51         construct (boost::bind (&SoundAsset::path_from_channel, this, _1, files));
52 }
53
54 SoundAsset::SoundAsset (
55         boost::function<string (Channel)> get_path,
56         string directory,
57         string mxf_name,
58         boost::signals2::signal<void (float)>* progress,
59         int fps, int length, int channels
60         )
61         : MXFAsset (directory, mxf_name, progress, fps, 0, length)
62         , _channels (channels)
63         , _sampling_rate (0)
64 {
65         construct (get_path);
66 }
67
68 SoundAsset::SoundAsset (string directory, string mxf_name, int fps, int entry_point, int length)
69         : MXFAsset (directory, mxf_name, 0, fps, entry_point, length)
70         , _channels (0)
71 {
72         ASDCP::PCM::MXFReader reader;
73         if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
74                 throw MXFFileError ("could not open MXF file for reading", path().string());
75         }
76
77         
78         ASDCP::PCM::AudioDescriptor desc;
79         if (ASDCP_FAILURE (reader.FillAudioDescriptor (desc))) {
80                 throw DCPReadError ("could not read audio MXF information");
81         }
82
83         _sampling_rate = desc.AudioSamplingRate.Numerator / desc.AudioSamplingRate.Denominator;
84         _channels = desc.ChannelCount;
85 }
86
87 string
88 SoundAsset::path_from_channel (Channel channel, vector<string> const & files)
89 {
90         unsigned int const c = int (channel);
91         assert (c < files.size ());
92         return files[c];
93 }
94
95 void
96 SoundAsset::construct (boost::function<string (Channel)> get_path)
97 {
98         ASDCP::Rational asdcp_fps (_fps, 1);
99         
100         ASDCP::PCM::WAVParser pcm_parser_channel[_channels];
101         if (pcm_parser_channel[0].OpenRead (get_path(LEFT).c_str(), asdcp_fps)) {
102                 throw FileError ("could not open WAV file for reading", get_path(LEFT));
103         }
104         
105         ASDCP::PCM::AudioDescriptor audio_desc;
106         pcm_parser_channel[0].FillAudioDescriptor (audio_desc);
107         audio_desc.ChannelCount = 0;
108         audio_desc.BlockAlign = 0;
109         audio_desc.EditRate = asdcp_fps;
110         audio_desc.AvgBps = audio_desc.AvgBps * _channels;
111
112         Channel channels[] = {
113                 LEFT,
114                 RIGHT,
115                 CENTRE,
116                 LFE,
117                 LS,
118                 RS
119         };
120
121         ASDCP::PCM::FrameBuffer frame_buffer_channel[_channels];
122         ASDCP::PCM::AudioDescriptor audio_desc_channel[_channels];
123
124         for (int i = 0; i < _channels; ++i) {
125
126                 string const path = get_path (channels[i]);
127                 
128                 if (ASDCP_FAILURE (pcm_parser_channel[i].OpenRead (path.c_str(), asdcp_fps))) {
129                         throw FileError ("could not open WAV file for reading", path);
130                 }
131
132                 pcm_parser_channel[i].FillAudioDescriptor (audio_desc_channel[i]);
133                 frame_buffer_channel[i].Capacity (ASDCP::PCM::CalcFrameBufferSize (audio_desc_channel[i]));
134
135                 audio_desc.ChannelCount += audio_desc_channel[i].ChannelCount;
136                 audio_desc.BlockAlign += audio_desc_channel[i].BlockAlign;
137         }
138
139         ASDCP::PCM::FrameBuffer frame_buffer;
140         frame_buffer.Capacity (ASDCP::PCM::CalcFrameBufferSize (audio_desc));
141         frame_buffer.Size (ASDCP::PCM::CalcFrameBufferSize (audio_desc));
142
143         ASDCP::WriterInfo writer_info;
144         fill_writer_info (&writer_info);
145
146         ASDCP::PCM::MXFWriter mxf_writer;
147         if (ASDCP_FAILURE (mxf_writer.OpenWrite (path().string().c_str(), writer_info, audio_desc))) {
148                 throw FileError ("could not open audio MXF for writing", path().string());
149         }
150
151         for (int i = 0; i < _length; ++i) {
152
153                 byte_t *data_s = frame_buffer.Data();
154                 byte_t *data_e = data_s + frame_buffer.Capacity();
155                 byte_t sample_size = ASDCP::PCM::CalcSampleSize (audio_desc_channel[0]);
156                 int offset = 0;
157
158                 for (int j = 0; j < _channels; ++j) {
159                         memset (frame_buffer_channel[j].Data(), 0, frame_buffer_channel[j].Capacity());
160                         if (ASDCP_FAILURE (pcm_parser_channel[j].ReadFrame (frame_buffer_channel[j]))) {
161                                 throw MiscError ("could not read audio frame");
162                         }
163                         
164                         if (frame_buffer_channel[j].Size() != frame_buffer_channel[j].Capacity()) {
165                                 stringstream s;
166                                 s << "short audio frame; " << _channels << " channels, "
167                                   << frame_buffer_channel[j].Size() << " vs " << frame_buffer_channel[j].Capacity();
168                                 throw MiscError (s.str ());
169                         }
170                 }
171
172                 while (data_s < data_e) {
173                         for (int j = 0; j < _channels; ++j) {
174                                 byte_t* frame = frame_buffer_channel[j].Data() + offset;
175                                 memcpy (data_s, frame, sample_size);
176                                 data_s += sample_size;
177                         }
178                         offset += sample_size;
179                 }
180
181                 if (ASDCP_FAILURE (mxf_writer.WriteFrame (frame_buffer, 0, 0))) {
182                         throw MiscError ("could not write audio MXF frame");
183                 }
184
185                 if (_progress) {
186                         (*_progress) (0.5 * float (i) / _length);
187                 }
188         }
189
190         if (ASDCP_FAILURE (mxf_writer.Finalize())) {
191                 throw MiscError ("could not finalise audio MXF");
192         }
193 }
194
195 void
196 SoundAsset::write_to_cpl (ostream& s) const
197 {
198         s << "        <MainSound>\n"
199           << "          <Id>urn:uuid:" << _uuid << "</Id>\n"
200           << "          <AnnotationText>" << _file_name << "</AnnotationText>\n"
201           << "          <EditRate>" << _fps << " 1</EditRate>\n"
202           << "          <IntrinsicDuration>" << _length << "</IntrinsicDuration>\n"
203           << "          <EntryPoint>0</EntryPoint>\n"
204           << "          <Duration>" << _length << "</Duration>\n"
205           << "        </MainSound>\n";
206 }
207
208 bool
209 SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
210 {
211         if (!MXFAsset::equals (other, opt, notes)) {
212                 return false;
213         }
214                      
215         ASDCP::PCM::MXFReader reader_A;
216         if (ASDCP_FAILURE (reader_A.OpenRead (path().string().c_str()))) {
217                 throw MXFFileError ("could not open MXF file for reading", path().string());
218         }
219
220         ASDCP::PCM::MXFReader reader_B;
221         if (ASDCP_FAILURE (reader_B.OpenRead (other->path().string().c_str()))) {
222                 throw MXFFileError ("could not open MXF file for reading", path().string());
223         }
224
225         ASDCP::PCM::AudioDescriptor desc_A;
226         if (ASDCP_FAILURE (reader_A.FillAudioDescriptor (desc_A))) {
227                 throw DCPReadError ("could not read audio MXF information");
228         }
229         ASDCP::PCM::AudioDescriptor desc_B;
230         if (ASDCP_FAILURE (reader_B.FillAudioDescriptor (desc_B))) {
231                 throw DCPReadError ("could not read audio MXF information");
232         }
233         
234         if (
235                 desc_A.EditRate != desc_B.EditRate ||
236                 desc_A.AudioSamplingRate != desc_B.AudioSamplingRate ||
237                 desc_A.Locked != desc_B.Locked ||
238                 desc_A.ChannelCount != desc_B.ChannelCount ||
239                 desc_A.QuantizationBits != desc_B.QuantizationBits ||
240                 desc_A.BlockAlign != desc_B.BlockAlign ||
241                 desc_A.AvgBps != desc_B.AvgBps ||
242                 desc_A.LinkedTrackID != desc_B.LinkedTrackID ||
243                 desc_A.ContainerDuration != desc_B.ContainerDuration
244 //              desc_A.ChannelFormat != desc_B.ChannelFormat ||
245                 ) {
246                 
247                 notes.push_back ("audio MXF picture descriptors differ");
248                 return false;
249         }
250         
251         ASDCP::PCM::FrameBuffer buffer_A (1 * Kumu::Megabyte);
252         ASDCP::PCM::FrameBuffer buffer_B (1 * Kumu::Megabyte);
253         
254         for (int i = 0; i < _length; ++i) {
255                 if (ASDCP_FAILURE (reader_A.ReadFrame (i, buffer_A))) {
256                         throw DCPReadError ("could not read audio frame");
257                 }
258                 
259                 if (ASDCP_FAILURE (reader_B.ReadFrame (i, buffer_B))) {
260                         throw DCPReadError ("could not read audio frame");
261                 }
262                 
263                 if (buffer_A.Size() != buffer_B.Size()) {
264                         notes.push_back ("sizes of audio data for frame " + lexical_cast<string>(i) + " differ");
265                         return false;
266                 }
267                 
268                 if (memcmp (buffer_A.RoData(), buffer_B.RoData(), buffer_A.Size()) != 0) {
269                         for (uint32_t i = 0; i < buffer_A.Size(); ++i) {
270                                 int const d = abs (buffer_A.RoData()[i] - buffer_B.RoData()[i]);
271                                 if (d > opt.max_audio_sample_error) {
272                                         notes.push_back ("PCM data difference of " + lexical_cast<string> (d));
273                                         return false;
274                                 }
275                         }
276                 }
277         }
278
279         return true;
280 }
281
282 shared_ptr<const SoundFrame>
283 SoundAsset::get_frame (int n) const
284 {
285         return shared_ptr<const SoundFrame> (new SoundFrame (path().string(), n + _entry_point));
286 }