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 <libxml++/nodes/element.h>
  29 #include "KM_fileio.h"
  30 #include "AS_DCP.h"
  31 #include "sound_asset.h"
  32 #include "util.h"
  33 #include "exceptions.h"
  34 #include "sound_frame.h"
  35
  36 using std::string;
  37 using std::stringstream;
  38 using std::ostream;
  39 using std::vector;
  40 using std::list;
  41 using boost::shared_ptr;
  42 using boost::lexical_cast;
  43 using namespace libdcp;
  44
  45 SoundAsset::SoundAsset (
  46         vector<boost::filesystem::path> const & files,
  47         boost::filesystem::path directory,
  48         string mxf_name,
  49         boost::signals2::signal<void (float)>* progress,
  50         int fps,
  51         int intrinsic_duration,
  52         bool interop,
  53         MXFMetadata const & metadata
  54         )
  55         : MXFAsset (directory, mxf_name, progress, fps, intrinsic_duration)
  56         , _channels (files.size ())
  57         , _sampling_rate (0)
  58 {
  59         assert (_channels);
  60
  61         construct (boost::bind (&SoundAsset::path_from_channel, this, _1, files), interop, metadata);
  62 }
  63
  64 SoundAsset::SoundAsset (
  65         boost::function<boost::filesystem::path (Channel)> get_path,
  66         boost::filesystem::path directory,
  67         string mxf_name,
  68         boost::signals2::signal<void (float)>* progress,
  69         int fps,
  70         int intrinsic_duration,
  71         int channels,
  72         bool interop,
  73         MXFMetadata const & metadata
  74         )
  75         : MXFAsset (directory, mxf_name, progress, fps, intrinsic_duration)
  76         , _channels (channels)
  77         , _sampling_rate (0)
  78 {
  79         assert (_channels);
  80
  81         construct (get_path, interop, metadata);
  82 }
  83
  84 SoundAsset::SoundAsset (boost::filesystem::path directory, string mxf_name)
  85         : MXFAsset (directory, mxf_name)
  86         , _channels (0)
  87 {
  88         ASDCP::PCM::MXFReader reader;
  89         if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
  90                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", path().string()));
  91         }
  92
  93         ASDCP::PCM::AudioDescriptor desc;
  94         if (ASDCP_FAILURE (reader.FillAudioDescriptor (desc))) {
  95                 boost::throw_exception (DCPReadError ("could not read audio MXF information"));
  96         }
  97
  98         _sampling_rate = desc.AudioSamplingRate.Numerator / desc.AudioSamplingRate.Denominator;
  99         _channels = desc.ChannelCount;
 100         _edit_rate = desc.EditRate.Numerator;
 101         assert (desc.EditRate.Denominator == 1);
 102         _intrinsic_duration = desc.ContainerDuration;
 103 }
 104
 105 SoundAsset::SoundAsset (boost::filesystem::path directory, string mxf_name, int fps, int channels, int sampling_rate)
 106         : MXFAsset (directory, mxf_name, 0, fps, 0)
 107         , _channels (channels)
 108         , _sampling_rate (sampling_rate)
 109 {
 110
 111 }
 112
 113 boost::filesystem::path
 114 SoundAsset::path_from_channel (Channel channel, vector<boost::filesystem::path> const & files)
 115 {
 116         unsigned int const c = int (channel);
 117         assert (c < files.size ());
 118         return files[c];
 119 }
 120
 121 void
 122 SoundAsset::construct (boost::function<boost::filesystem::path (Channel)> get_path, bool interop, MXFMetadata const & metadata)
 123 {
 124         ASDCP::Rational asdcp_edit_rate (_edit_rate, 1);
 125
 126         ASDCP::PCM::WAVParser pcm_parser_channel[_channels];
 127         if (pcm_parser_channel[0].OpenRead (get_path(LEFT).c_str(), asdcp_edit_rate)) {
 128                 boost::throw_exception (FileError ("could not open WAV file for reading", get_path(LEFT)));
 129         }
 130
 131         ASDCP::PCM::AudioDescriptor audio_desc;
 132         pcm_parser_channel[0].FillAudioDescriptor (audio_desc);
 133         audio_desc.ChannelCount = 0;
 134         audio_desc.BlockAlign = 0;
 135         audio_desc.EditRate = asdcp_edit_rate;
 136         audio_desc.AvgBps = audio_desc.AvgBps * _channels;
 137
 138         Channel channels[] = {
 139                 LEFT,
 140                 RIGHT,
 141                 CENTRE,
 142                 LFE,
 143                 LS,
 144                 RS,
 145                 /* XXX: not quite sure what these should be yet */
 146                 CHANNEL_7,
 147                 CHANNEL_8
 148         };
 149
 150         assert (int(_channels) <= int(sizeof(channels) / sizeof(Channel)));
 151
 152         ASDCP::PCM::FrameBuffer frame_buffer_channel[_channels];
 153         ASDCP::PCM::AudioDescriptor audio_desc_channel[_channels];
 154
 155         for (int i = 0; i < _channels; ++i) {
 156
 157                 boost::filesystem::path const path = get_path (channels[i]);
 158
 159                 if (ASDCP_FAILURE (pcm_parser_channel[i].OpenRead (path.c_str(), asdcp_edit_rate))) {
 160                         boost::throw_exception (FileError ("could not open WAV file for reading", path));
 161                 }
 162
 163                 pcm_parser_channel[i].FillAudioDescriptor (audio_desc_channel[i]);
 164                 frame_buffer_channel[i].Capacity (ASDCP::PCM::CalcFrameBufferSize (audio_desc_channel[i]));
 165
 166                 audio_desc.ChannelCount += audio_desc_channel[i].ChannelCount;
 167                 audio_desc.BlockAlign += audio_desc_channel[i].BlockAlign;
 168         }
 169
 170         ASDCP::PCM::FrameBuffer frame_buffer;
 171         frame_buffer.Capacity (ASDCP::PCM::CalcFrameBufferSize (audio_desc));
 172         frame_buffer.Size (ASDCP::PCM::CalcFrameBufferSize (audio_desc));
 173
 174         ASDCP::WriterInfo writer_info;
 175         MXFAsset::fill_writer_info (&writer_info, _uuid, interop, metadata);
 176
 177         ASDCP::PCM::MXFWriter mxf_writer;
 178         if (ASDCP_FAILURE (mxf_writer.OpenWrite (path().string().c_str(), writer_info, audio_desc))) {
 179                 boost::throw_exception (FileError ("could not open audio MXF for writing", path().string()));
 180         }
 181
 182         for (int i = 0; i < _intrinsic_duration; ++i) {
 183
 184                 for (int j = 0; j < _channels; ++j) {
 185                         memset (frame_buffer_channel[j].Data(), 0, frame_buffer_channel[j].Capacity());
 186                         if (ASDCP_FAILURE (pcm_parser_channel[j].ReadFrame (frame_buffer_channel[j]))) {
 187                                 boost::throw_exception (MiscError ("could not read audio frame"));
 188                         }
 189                 }
 190
 191                 byte_t *data_s = frame_buffer.Data();
 192                 byte_t *data_e = data_s + frame_buffer.Capacity();
 193                 byte_t sample_size = ASDCP::PCM::CalcSampleSize (audio_desc_channel[0]);
 194                 int offset = 0;
 195
 196                 while (data_s < data_e) {
 197                         for (int j = 0; j < _channels; ++j) {
 198                                 byte_t* frame = frame_buffer_channel[j].Data() + offset;
 199                                 memcpy (data_s, frame, sample_size);
 200                                 data_s += sample_size;
 201                         }
 202                         offset += sample_size;
 203                 }
 204
 205                 if (ASDCP_FAILURE (mxf_writer.WriteFrame (frame_buffer, _encryption_context, 0))) {
 206                         boost::throw_exception (MiscError ("could not write audio MXF frame"));
 207                 }
 208
 209                 if (_progress) {
 210                         (*_progress) (0.5 * float (i) / _intrinsic_duration);
 211                 }
 212         }
 213
 214         if (ASDCP_FAILURE (mxf_writer.Finalize())) {
 215                 boost::throw_exception (MiscError ("could not finalise audio MXF"));
 216         }
 217 }
 218
 219 string
 220 SoundAsset::cpl_node_name () const
 221 {
 222         return "MainSound";
 223 }
 224
 225 bool
 226 SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
 227 {
 228         if (!MXFAsset::equals (other, opt, note)) {
 229                 return false;
 230         }
 231
 232         ASDCP::PCM::MXFReader reader_A;
 233         if (ASDCP_FAILURE (reader_A.OpenRead (path().string().c_str()))) {
 234                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", path().string()));
 235         }
 236
 237         ASDCP::PCM::MXFReader reader_B;
 238         if (ASDCP_FAILURE (reader_B.OpenRead (other->path().string().c_str()))) {
 239                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", path().string()));
 240         }
 241
 242         ASDCP::PCM::AudioDescriptor desc_A;
 243         if (ASDCP_FAILURE (reader_A.FillAudioDescriptor (desc_A))) {
 244                 boost::throw_exception (DCPReadError ("could not read audio MXF information"));
 245         }
 246         ASDCP::PCM::AudioDescriptor desc_B;
 247         if (ASDCP_FAILURE (reader_B.FillAudioDescriptor (desc_B))) {
 248                 boost::throw_exception (DCPReadError ("could not read audio MXF information"));
 249         }
 250
 251         if (
 252                 desc_A.EditRate != desc_B.EditRate ||
 253                 desc_A.AudioSamplingRate != desc_B.AudioSamplingRate ||
 254                 desc_A.Locked != desc_B.Locked ||
 255                 desc_A.ChannelCount != desc_B.ChannelCount ||
 256                 desc_A.QuantizationBits != desc_B.QuantizationBits ||
 257                 desc_A.BlockAlign != desc_B.BlockAlign ||
 258                 desc_A.AvgBps != desc_B.AvgBps ||
 259                 desc_A.LinkedTrackID != desc_B.LinkedTrackID ||
 260                 desc_A.ContainerDuration != desc_B.ContainerDuration
 261 //              desc_A.ChannelFormat != desc_B.ChannelFormat ||
 262                 ) {
 263
 264                 note (ERROR, "audio MXF picture descriptors differ");
 265                 return false;
 266         }
 267
 268         ASDCP::PCM::FrameBuffer buffer_A (1 * Kumu::Megabyte);
 269         ASDCP::PCM::FrameBuffer buffer_B (1 * Kumu::Megabyte);
 270
 271         for (int i = 0; i < _intrinsic_duration; ++i) {
 272                 if (ASDCP_FAILURE (reader_A.ReadFrame (i, buffer_A))) {
 273                         boost::throw_exception (DCPReadError ("could not read audio frame"));
 274                 }
 275
 276                 if (ASDCP_FAILURE (reader_B.ReadFrame (i, buffer_B))) {
 277                         boost::throw_exception (DCPReadError ("could not read audio frame"));
 278                 }
 279
 280                 if (buffer_A.Size() != buffer_B.Size()) {
 281                         note (ERROR, "sizes of audio data for frame " + lexical_cast<string>(i) + " differ");
 282                         return false;
 283                 }
 284
 285                 if (memcmp (buffer_A.RoData(), buffer_B.RoData(), buffer_A.Size()) != 0) {
 286                         for (uint32_t i = 0; i < buffer_A.Size(); ++i) {
 287                                 int const d = abs (buffer_A.RoData()[i] - buffer_B.RoData()[i]);
 288                                 if (d > opt.max_audio_sample_error) {
 289                                         note (ERROR, "PCM data difference of " + lexical_cast<string> (d));
 290                                         return false;
 291                                 }
 292                         }
 293                 }
 294         }
 295
 296         return true;
 297 }
 298
 299 shared_ptr<const SoundFrame>
 300 SoundAsset::get_frame (int n) const
 301 {
 302         /* XXX: should add on entry point here? */
 303         return shared_ptr<const SoundFrame> (new SoundFrame (path().string(), n, _decryption_context));
 304 }
 305
 306 shared_ptr<SoundAssetWriter>
 307 SoundAsset::start_write (bool interop, MXFMetadata const & metadata)
 308 {
 309         /* XXX: can't we use a shared_ptr here? */
 310         return shared_ptr<SoundAssetWriter> (new SoundAssetWriter (this, interop, metadata));
 311 }
 312
 313 struct SoundAssetWriter::ASDCPState
 314 {
 315         ASDCP::PCM::MXFWriter mxf_writer;
 316         ASDCP::PCM::FrameBuffer frame_buffer;
 317         ASDCP::WriterInfo writer_info;
 318         ASDCP::PCM::AudioDescriptor audio_desc;
 319         ASDCP::AESEncContext* encryption_context;
 320 };
 321
 322 SoundAssetWriter::SoundAssetWriter (SoundAsset* a, bool interop, MXFMetadata const & m)
 323         : _state (new SoundAssetWriter::ASDCPState)
 324         , _asset (a)
 325         , _finalized (false)
 326         , _frames_written (0)
 327         , _frame_buffer_offset (0)
 328         , _metadata (m)
 329 {
 330         _state->encryption_context = a->encryption_context ();
 331
 332         /* Derived from ASDCP::Wav::SimpleWaveHeader::FillADesc */
 333         _state->audio_desc.EditRate = ASDCP::Rational (_asset->edit_rate(), 1);
 334         _state->audio_desc.AudioSamplingRate = ASDCP::Rational (_asset->sampling_rate(), 1);
 335         _state->audio_desc.Locked = 0;
 336         _state->audio_desc.ChannelCount = _asset->channels ();
 337         _state->audio_desc.QuantizationBits = 24;
 338         _state->audio_desc.BlockAlign = 3 * _asset->channels();
 339         _state->audio_desc.AvgBps = _asset->sampling_rate() * _state->audio_desc.BlockAlign;
 340         _state->audio_desc.LinkedTrackID = 0;
 341         _state->audio_desc.ChannelFormat = ASDCP::PCM::CF_NONE;
 342
 343         _state->frame_buffer.Capacity (ASDCP::PCM::CalcFrameBufferSize (_state->audio_desc));
 344         _state->frame_buffer.Size (ASDCP::PCM::CalcFrameBufferSize (_state->audio_desc));
 345         memset (_state->frame_buffer.Data(), 0, _state->frame_buffer.Capacity());
 346
 347         _asset->fill_writer_info (&_state->writer_info, _asset->uuid (), interop, _metadata);
 348
 349         if (ASDCP_FAILURE (_state->mxf_writer.OpenWrite (_asset->path().string().c_str(), _state->writer_info, _state->audio_desc))) {
 350                 boost::throw_exception (FileError ("could not open audio MXF for writing", _asset->path().string()));
 351         }
 352 }
 353
 354 void
 355 SoundAssetWriter::write (float const * const * data, int frames)
 356 {
 357         for (int i = 0; i < frames; ++i) {
 358
 359                 byte_t* out = _state->frame_buffer.Data() + _frame_buffer_offset;
 360
 361                 /* Write one sample per channel */
 362                 for (int j = 0; j < _asset->channels(); ++j) {
 363                         int32_t const s = data[j][i] * (1 << 23);
 364                         *out++ = (s & 0xff);
 365                         *out++ = (s & 0xff00) >> 8;
 366                         *out++ = (s & 0xff0000) >> 16;
 367                 }
 368                 _frame_buffer_offset += 3 * _asset->channels();
 369
 370                 assert (_frame_buffer_offset <= int (_state->frame_buffer.Capacity()));
 371
 372                 /* Finish the MXF frame if required */
 373                 if (_frame_buffer_offset == int (_state->frame_buffer.Capacity())) {
 374                         write_current_frame ();
 375                         _frame_buffer_offset = 0;
 376                         memset (_state->frame_buffer.Data(), 0, _state->frame_buffer.Capacity());
 377                 }
 378         }
 379 }
 380
 381 void
 382 SoundAssetWriter::write_current_frame ()
 383 {
 384         if (ASDCP_FAILURE (_state->mxf_writer.WriteFrame (_state->frame_buffer, _state->encryption_context, 0))) {
 385                 boost::throw_exception (MiscError ("could not write audio MXF frame"));
 386         }
 387
 388         ++_frames_written;
 389 }
 390
 391 void
 392 SoundAssetWriter::finalize ()
 393 {
 394         if (_frame_buffer_offset > 0) {
 395                 write_current_frame ();
 396         }
 397
 398         if (ASDCP_FAILURE (_state->mxf_writer.Finalize())) {
 399                 boost::throw_exception (MiscError ("could not finalise audio MXF"));
 400         }
 401
 402         _finalized = true;
 403         _asset->set_intrinsic_duration (_frames_written);
 404         _asset->set_duration (_frames_written);
 405 }
 406
 407 string
 408 SoundAsset::key_type () const
 409 {
 410         return "MDAK";
 411 }