Consider assets outside the DCP as referenced assets (i.e.
[libdcp.git] / src / sound_asset.cc
index 2d8349579ccdacc171fab4cf176a5d79d5326832..f95b860f7da2bd0efaab38e72ca1a06a7be9cee5 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
-/** @file  src/sound_asset.cc
- *  @brief An asset made up of WAV files
+/** @file  src/sound_mxf.cc
+ *  @brief SoundAsset class.
  */
 
-#include <iostream>
-#include <stdexcept>
-#include <boost/filesystem.hpp>
-#include <boost/lexical_cast.hpp>
-#include "KM_fileio.h"
-#include "AS_DCP.h"
 #include "sound_asset.h"
 #include "util.h"
 #include "exceptions.h"
+#include "sound_frame.h"
+#include "sound_asset_writer.h"
+#include "compose.hpp"
+#include "KM_fileio.h"
+#include "AS_DCP.h"
+#include "dcp_assert.h"
+#include <libxml++/nodes/element.h>
+#include <boost/filesystem.hpp>
+#include <iostream>
+#include <stdexcept>
 
-using namespace std;
-using namespace boost;
-using namespace libdcp;
+using std::string;
+using std::stringstream;
+using std::ostream;
+using std::vector;
+using std::list;
+using boost::shared_ptr;
+using namespace dcp;
 
-SoundAsset::SoundAsset (
-       vector<string> const & files, string directory, string mxf_name, sigc::signal1<void, float>* progress, int fps, int length
-       )
-       : Asset (directory, mxf_name, progress, fps, length)
-       , _channels (files.size ())
+SoundAsset::SoundAsset (boost::filesystem::path file)
+       : Asset (file)
 {
-       construct (sigc::bind (sigc::mem_fun (*this, &SoundAsset::path_from_channel), files));
-}
+       ASDCP::PCM::MXFReader reader;
+       Kumu::Result_t r = reader.OpenRead (file.string().c_str());
+       if (ASDCP_FAILURE (r)) {
+               boost::throw_exception (MXFFileError ("could not open MXF file for reading", file.string(), r));
+       }
 
-SoundAsset::SoundAsset (
-       sigc::slot<string, Channel> get_path, string directory, string mxf_name, sigc::signal1<void, float>* progress, int fps, int length, int channels
-       )
-       : Asset (directory, mxf_name, progress, fps, length)
-       , _channels (channels)
-{
-       construct (get_path);
-}
+       ASDCP::PCM::AudioDescriptor desc;
+       if (ASDCP_FAILURE (reader.FillAudioDescriptor (desc))) {
+               boost::throw_exception (DCPReadError ("could not read audio MXF information"));
+       }
 
-SoundAsset::SoundAsset (string directory, string mxf_name, int fps, int length)
-       : Asset (directory, mxf_name, 0, fps, length)
-       , _channels (0)
-{
+       _sampling_rate = desc.AudioSamplingRate.Numerator / desc.AudioSamplingRate.Denominator;
+       _channels = desc.ChannelCount;
+       _edit_rate = Fraction (desc.EditRate.Numerator, desc.EditRate.Denominator);
+
+       _intrinsic_duration = desc.ContainerDuration;
 
+       ASDCP::WriterInfo info;
+       if (ASDCP_FAILURE (reader.FillWriterInfo (info))) {
+               boost::throw_exception (DCPReadError ("could not read audio MXF information"));
+       }
+
+       _id = read_writer_info (info);
 }
 
-string
-SoundAsset::path_from_channel (Channel channel, vector<string> const & files)
+SoundAsset::SoundAsset (Fraction edit_rate, int sampling_rate, int channels)
+       : _edit_rate (edit_rate)
+       , _intrinsic_duration (0)
+       , _channels (channels)
+       , _sampling_rate (sampling_rate)
 {
-       unsigned int const c = int (channel);
-       assert (c < files.size ());
-       return files[c];
+
 }
 
-void
-SoundAsset::construct (sigc::slot<string, Channel> get_path)
+bool
+SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, NoteHandler note) const
 {
-       ASDCP::Rational asdcp_fps (_fps, 1);
-       
-       ASDCP::PCM::WAVParser pcm_parser_channel[_channels];
-       if (pcm_parser_channel[0].OpenRead (get_path(LEFT).c_str(), asdcp_fps)) {
-               throw FileError ("could not open WAV file for reading", get_path(LEFT));
+       ASDCP::PCM::MXFReader reader_A;
+       Kumu::Result_t r = reader_A.OpenRead (file().string().c_str());
+       if (ASDCP_FAILURE (r)) {
+               boost::throw_exception (MXFFileError ("could not open MXF file for reading", file().string(), r));
        }
-       
-       ASDCP::PCM::AudioDescriptor audio_desc;
-       pcm_parser_channel[0].FillAudioDescriptor (audio_desc);
-       audio_desc.ChannelCount = 0;
-       audio_desc.BlockAlign = 0;
-       audio_desc.EditRate = asdcp_fps;
-       audio_desc.AvgBps = audio_desc.AvgBps * _channels;
-
-       Channel channels[] = {
-               LEFT,
-               RIGHT,
-               CENTRE,
-               LFE,
-               LS,
-               RS
-       };
-
-       ASDCP::PCM::FrameBuffer frame_buffer_channel[_channels];
-       ASDCP::PCM::AudioDescriptor audio_desc_channel[_channels];
-
-       for (int i = 0; i < _channels; ++i) {
-
-               string const path = get_path (channels[i]);
-               
-               if (ASDCP_FAILURE (pcm_parser_channel[i].OpenRead (path.c_str(), asdcp_fps))) {
-                       throw FileError ("could not open WAV file for reading", path);
-               }
-
-               pcm_parser_channel[i].FillAudioDescriptor (audio_desc_channel[i]);
-               frame_buffer_channel[i].Capacity (ASDCP::PCM::CalcFrameBufferSize (audio_desc_channel[i]));
 
-               audio_desc.ChannelCount += audio_desc_channel[i].ChannelCount;
-               audio_desc.BlockAlign += audio_desc_channel[i].BlockAlign;
+       ASDCP::PCM::MXFReader reader_B;
+       r = reader_B.OpenRead (other->file().string().c_str());
+       if (ASDCP_FAILURE (r)) {
+               boost::throw_exception (MXFFileError ("could not open MXF file for reading", file().string(), r));
        }
 
-       ASDCP::PCM::FrameBuffer frame_buffer;
-       frame_buffer.Capacity (ASDCP::PCM::CalcFrameBufferSize (audio_desc));
-       frame_buffer.Size (ASDCP::PCM::CalcFrameBufferSize (audio_desc));
-
-       ASDCP::WriterInfo writer_info;
-       fill_writer_info (&writer_info);
-
-       ASDCP::PCM::MXFWriter mxf_writer;
-       if (ASDCP_FAILURE (mxf_writer.OpenWrite (mxf_path().string().c_str(), writer_info, audio_desc))) {
-               throw FileError ("could not open audio MXF for writing", mxf_path().string());
+       ASDCP::PCM::AudioDescriptor desc_A;
+       if (ASDCP_FAILURE (reader_A.FillAudioDescriptor (desc_A))) {
+               boost::throw_exception (DCPReadError ("could not read audio MXF information"));
+       }
+       ASDCP::PCM::AudioDescriptor desc_B;
+       if (ASDCP_FAILURE (reader_B.FillAudioDescriptor (desc_B))) {
+               boost::throw_exception (DCPReadError ("could not read audio MXF information"));
        }
 
-       for (int i = 0; i < _length; ++i) {
+       if (
+               desc_A.EditRate != desc_B.EditRate ||
+               desc_A.AudioSamplingRate != desc_B.AudioSamplingRate ||
+               desc_A.Locked != desc_B.Locked ||
+               desc_A.ChannelCount != desc_B.ChannelCount ||
+               desc_A.QuantizationBits != desc_B.QuantizationBits ||
+               desc_A.BlockAlign != desc_B.BlockAlign ||
+               desc_A.AvgBps != desc_B.AvgBps ||
+               desc_A.LinkedTrackID != desc_B.LinkedTrackID ||
+               desc_A.ContainerDuration != desc_B.ContainerDuration
+//             desc_A.ChannelFormat != desc_B.ChannelFormat ||
+               ) {
+
+               note (DCP_ERROR, "audio MXF picture descriptors differ");
+               return false;
+       }
 
-               byte_t *data_s = frame_buffer.Data();
-               byte_t *data_e = data_s + frame_buffer.Capacity();
-               byte_t sample_size = ASDCP::PCM::CalcSampleSize (audio_desc_channel[0]);
-               int offset = 0;
+       ASDCP::PCM::FrameBuffer buffer_A (1 * Kumu::Megabyte);
+       ASDCP::PCM::FrameBuffer buffer_B (1 * Kumu::Megabyte);
 
-               for (int j = 0; j < _channels; ++j) {
-                       memset (frame_buffer_channel[j].Data(), 0, frame_buffer_channel[j].Capacity());
-                       if (ASDCP_FAILURE (pcm_parser_channel[j].ReadFrame (frame_buffer_channel[j]))) {
-                               throw MiscError ("could not read audio frame");
-                       }
-                       
-                       if (frame_buffer_channel[j].Size() != frame_buffer_channel[j].Capacity()) {
-                               throw MiscError ("short audio frame");
-                       }
+       for (int i = 0; i < _intrinsic_duration; ++i) {
+               if (ASDCP_FAILURE (reader_A.ReadFrame (i, buffer_A))) {
+                       boost::throw_exception (DCPReadError ("could not read audio frame"));
                }
 
-               while (data_s < data_e) {
-                       for (int j = 0; j < _channels; ++j) {
-                               byte_t* frame = frame_buffer_channel[j].Data() + offset;
-                               memcpy (data_s, frame, sample_size);
-                               data_s += sample_size;
-                       }
-                       offset += sample_size;
+               if (ASDCP_FAILURE (reader_B.ReadFrame (i, buffer_B))) {
+                       boost::throw_exception (DCPReadError ("could not read audio frame"));
                }
 
-               if (ASDCP_FAILURE (mxf_writer.WriteFrame (frame_buffer, 0, 0))) {
-                       throw MiscError ("could not write audio MXF frame");
+               if (buffer_A.Size() != buffer_B.Size()) {
+                       note (DCP_ERROR, String::compose ("sizes of audio data for frame %1 differ", i));
+                       return false;
                }
 
-               (*_progress) (0.5 * float (i) / _length);
+               if (memcmp (buffer_A.RoData(), buffer_B.RoData(), buffer_A.Size()) != 0) {
+                       for (uint32_t i = 0; i < buffer_A.Size(); ++i) {
+                               int const d = abs (buffer_A.RoData()[i] - buffer_B.RoData()[i]);
+                               if (d > opt.max_audio_sample_error) {
+                                       note (DCP_ERROR, String::compose ("PCM data difference of %1", d));
+                                       return false;
+                               }
+                       }
+               }
        }
 
-       if (ASDCP_FAILURE (mxf_writer.Finalize())) {
-               throw MiscError ("could not finalise audio MXF");
-       }
+       return true;
 }
 
-void
-SoundAsset::write_to_cpl (ostream& s) const
+shared_ptr<const SoundFrame>
+SoundAsset::get_frame (int n) const
 {
-       s << "        <MainSound>\n"
-         << "          <Id>urn:uuid:" << _uuid << "</Id>\n"
-         << "          <AnnotationText>" << _mxf_name << "</AnnotationText>\n"
-         << "          <EditRate>" << _fps << " 1</EditRate>\n"
-         << "          <IntrinsicDuration>" << _length << "</IntrinsicDuration>\n"
-         << "          <EntryPoint>0</EntryPoint>\n"
-         << "          <Duration>" << _length << "</Duration>\n"
-         << "        </MainSound>\n";
+       /* XXX: should add on entry point here? */
+       return shared_ptr<const SoundFrame> (new SoundFrame (file(), n, _decryption_context));
 }
 
-list<string>
-SoundAsset::equals (shared_ptr<const Asset> other, EqualityFlags flags, double max_mean, double max_std_dev) const
+shared_ptr<SoundAssetWriter>
+SoundAsset::start_write (boost::filesystem::path file, Standard standard)
 {
-       list<string> notes = Asset::equals (other, flags, max_mean, max_std_dev);
-                    
-       if (flags & MXF_INSPECT) {
-               ASDCP::PCM::MXFReader reader_A;
-               if (ASDCP_FAILURE (reader_A.OpenRead (mxf_path().string().c_str()))) {
-                       cout << "failed " << mxf_path() << "\n";
-                       throw FileError ("could not open MXF file for reading", mxf_path().string());
-               }
-
-               ASDCP::PCM::MXFReader reader_B;
-               if (ASDCP_FAILURE (reader_B.OpenRead (other->mxf_path().string().c_str()))) {
-                       cout << "failed " << other->mxf_path() << "\n";
-                       throw FileError ("could not open MXF file for reading", mxf_path().string());
-               }
-
-               ASDCP::PCM::AudioDescriptor desc_A;
-               if (ASDCP_FAILURE (reader_A.FillAudioDescriptor (desc_A))) {
-                       throw DCPReadError ("could not read audio MXF information");
-               }
-               ASDCP::PCM::AudioDescriptor desc_B;
-               if (ASDCP_FAILURE (reader_B.FillAudioDescriptor (desc_B))) {
-                       throw DCPReadError ("could not read audio MXF information");
-               }
-
-               if (
-                       desc_A.EditRate != desc_B.EditRate ||
-                       desc_A.AudioSamplingRate != desc_B.AudioSamplingRate ||
-                       desc_A.Locked != desc_B.Locked ||
-                       desc_A.ChannelCount != desc_B.ChannelCount ||
-                       desc_A.QuantizationBits != desc_B.QuantizationBits ||
-                       desc_A.BlockAlign != desc_B.BlockAlign ||
-                       desc_A.AvgBps != desc_B.AvgBps ||
-                       desc_A.LinkedTrackID != desc_B.LinkedTrackID ||
-                       desc_A.ContainerDuration != desc_B.ContainerDuration
-//                     desc_A.ChannelFormat != desc_B.ChannelFormat ||
-                       ) {
-               
-                       notes.push_back ("audio MXF picture descriptors differ");
-               }
-
-               ASDCP::PCM::FrameBuffer buffer_A (1 * Kumu::Megabyte);
-               ASDCP::PCM::FrameBuffer buffer_B (1 * Kumu::Megabyte);
-
-               for (int i = 0; i < _length; ++i) {
-                       if (ASDCP_FAILURE (reader_A.ReadFrame (0, buffer_A))) {
-                               throw DCPReadError ("could not read audio frame");
-                       }
-
-                       if (ASDCP_FAILURE (reader_B.ReadFrame (0, buffer_B))) {
-                               throw DCPReadError ("could not read audio frame");
-                       }
-
-                       if (buffer_A.Size() != buffer_B.Size()) {
-                               notes.push_back ("sizes of video data for frame " + lexical_cast<string>(i) + " differ");
-                               continue;
-                       }
+       /* XXX: can't we use a shared_ptr here? */
+       return shared_ptr<SoundAssetWriter> (new SoundAssetWriter (this, file, standard));
+}
 
-                       if (memcmp (buffer_A.RoData(), buffer_B.RoData(), buffer_A.Size()) != 0) {
-                               notes.push_back ("PCM data for frame " + lexical_cast<string>(i) + " differ");
-                               continue;
-                       }
-               }
+string
+SoundAsset::pkl_type (Standard standard) const
+{
+       switch (standard) {
+       case INTEROP:
+               return "application/x-smpte-mxf;asdcpKind=Sound";
+       case SMPTE:
+               return "application/mxf";
+       default:
+               DCP_ASSERT (false);
        }
-
-       return notes;
 }