Switch away from the many-constructor-arguments approach to a hopefully simpler API.
[libdcp.git] / src / sound_asset.cc
index a0d17f29ebf6aabfc319bfd7879282c2b25c6c51..ec82752c290ea6f68efb912942f4d4e654169b94 100644 (file)
 #include <iostream>
 #include <stdexcept>
 #include <boost/filesystem.hpp>
+#include <boost/lexical_cast.hpp>
+#include <libxml++/nodes/element.h>
+#include "KM_fileio.h"
 #include "AS_DCP.h"
 #include "sound_asset.h"
 #include "util.h"
 #include "exceptions.h"
-
-using namespace std;
-using namespace boost;
+#include "sound_frame.h"
+
+using std::string;
+using std::stringstream;
+using std::ostream;
+using std::vector;
+using std::list;
+using boost::shared_ptr;
+using boost::lexical_cast;
 using namespace libdcp;
 
-SoundAsset::SoundAsset (
-       vector<string> const & files, string mxf_path, sigc::signal1<void, float>* progress, int fps, int length
-       )
-       : Asset (mxf_path, progress, fps, length)
-       , _channels (files.size ())
+SoundAsset::SoundAsset (boost::filesystem::path directory, string mxf_name)
+       : MXFAsset (directory, mxf_name)
+       , _channels (0)
+       , _sampling_rate (0)
 {
-       construct (sigc::bind (sigc::mem_fun (*this, &SoundAsset::path_from_channel), files));
+
 }
 
-SoundAsset::SoundAsset (
-       sigc::slot<string, Channel> get_path, string mxf_path, sigc::signal1<void, float>* progress, int fps, int length, int channels
-       )
-       : Asset (mxf_path, progress, fps, length)
-       , _channels (channels)
+void
+SoundAsset::create (vector<boost::filesystem::path> const & files)
 {
-       construct (get_path);
+       create (boost::bind (&SoundAsset::path_from_channel, this, _1, files));
 }
 
-SoundAsset::SoundAsset (string mxf_path, int fps, int length)
-       : Asset (mxf_path, 0, fps, length)
-       , _channels (0)
+void
+SoundAsset::read ()
 {
+       ASDCP::PCM::MXFReader reader;
+       if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
+               boost::throw_exception (MXFFileError ("could not open MXF file for reading", path().string()));
+       }
 
+       ASDCP::PCM::AudioDescriptor desc;
+       if (ASDCP_FAILURE (reader.FillAudioDescriptor (desc))) {
+               boost::throw_exception (DCPReadError ("could not read audio MXF information"));
+       }
+
+       _sampling_rate = desc.AudioSamplingRate.Numerator / desc.AudioSamplingRate.Denominator;
+       _channels = desc.ChannelCount;
+       _edit_rate = desc.EditRate.Numerator;
+       assert (desc.EditRate.Denominator == 1);
+       _intrinsic_duration = desc.ContainerDuration;
 }
 
-string
-SoundAsset::path_from_channel (Channel channel, vector<string> const & files)
+boost::filesystem::path
+SoundAsset::path_from_channel (Channel channel, vector<boost::filesystem::path> const & files)
 {
        unsigned int const c = int (channel);
        assert (c < files.size ());
@@ -67,20 +85,21 @@ SoundAsset::path_from_channel (Channel channel, vector<string> const & files)
 }
 
 void
-SoundAsset::construct (sigc::slot<string, Channel> get_path)
+SoundAsset::create (boost::function<boost::filesystem::path (Channel)> get_path)
 {
-       ASDCP::Rational asdcp_fps (_fps, 1);
-       
+       ASDCP::Rational asdcp_edit_rate (_edit_rate, 1);
+
+       assert (_channels > 0);
        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));
+       if (pcm_parser_channel[0].OpenRead (get_path(LEFT).c_str(), asdcp_edit_rate)) {
+               boost::throw_exception (FileError ("could not open WAV file for reading", get_path(LEFT)));
        }
        
        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.EditRate = asdcp_edit_rate;
        audio_desc.AvgBps = audio_desc.AvgBps * _channels;
 
        Channel channels[] = {
@@ -89,18 +108,23 @@ SoundAsset::construct (sigc::slot<string, Channel> get_path)
                CENTRE,
                LFE,
                LS,
-               RS
+               RS,
+               /* XXX: not quite sure what these should be yet */
+               CHANNEL_7,
+               CHANNEL_8
        };
 
+       assert (int(_channels) <= int(sizeof(channels) / sizeof(Channel)));
+
        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]);
+               boost::filesystem::path 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);
+               if (ASDCP_FAILURE (pcm_parser_channel[i].OpenRead (path.c_str(), asdcp_edit_rate))) {
+                       boost::throw_exception (FileError ("could not open WAV file for reading", path));
                }
 
                pcm_parser_channel[i].FillAudioDescriptor (audio_desc_channel[i]);
@@ -115,31 +139,27 @@ SoundAsset::construct (sigc::slot<string, Channel> get_path)
        frame_buffer.Size (ASDCP::PCM::CalcFrameBufferSize (audio_desc));
 
        ASDCP::WriterInfo writer_info;
-       fill_writer_info (&writer_info);
+       MXFAsset::fill_writer_info (&writer_info, _uuid, _interop, _metadata);
 
        ASDCP::PCM::MXFWriter mxf_writer;
-       if (ASDCP_FAILURE (mxf_writer.OpenWrite (_mxf_path.c_str(), writer_info, audio_desc))) {
-               throw FileError ("could not open audio MXF for writing", _mxf_path);
+       if (ASDCP_FAILURE (mxf_writer.OpenWrite (path().string().c_str(), writer_info, audio_desc))) {
+               boost::throw_exception (FileError ("could not open audio MXF for writing", path().string()));
        }
-
-       for (int i = 0; i < _length; ++i) {
-
-               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;
+       
+       for (int i = 0; i < _intrinsic_duration; ++i) {
 
                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");
+                               boost::throw_exception (MiscError ("could not read audio frame"));
                        }
                }
 
+               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;
+
                while (data_s < data_e) {
                        for (int j = 0; j < _channels; ++j) {
                                byte_t* frame = frame_buffer_channel[j].Data() + offset;
@@ -149,34 +169,209 @@ SoundAsset::construct (sigc::slot<string, Channel> get_path)
                        offset += sample_size;
                }
 
-               if (ASDCP_FAILURE (mxf_writer.WriteFrame (frame_buffer, 0, 0))) {
-                       throw MiscError ("could not write audio MXF frame");
+               if (ASDCP_FAILURE (mxf_writer.WriteFrame (frame_buffer, _encryption_context, 0))) {
+                       boost::throw_exception (MiscError ("could not write audio MXF frame"));
                }
 
-               (*_progress) (0.5 * float (i) / _length);
+               if (_progress) {
+                       (*_progress) (0.5 * float (i) / _intrinsic_duration);
+               }
        }
 
        if (ASDCP_FAILURE (mxf_writer.Finalize())) {
-               throw MiscError ("could not finalise audio MXF");
+               boost::throw_exception (MiscError ("could not finalise audio MXF"));
+       }
+}
+
+string
+SoundAsset::cpl_node_name () const
+{
+       return "MainSound";
+}
+
+bool
+SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
+{
+       if (!MXFAsset::equals (other, opt, note)) {
+               return false;
+       }
+                    
+       ASDCP::PCM::MXFReader reader_A;
+       if (ASDCP_FAILURE (reader_A.OpenRead (path().string().c_str()))) {
+               boost::throw_exception (MXFFileError ("could not open MXF file for reading", path().string()));
+       }
+
+       ASDCP::PCM::MXFReader reader_B;
+       if (ASDCP_FAILURE (reader_B.OpenRead (other->path().string().c_str()))) {
+               boost::throw_exception (MXFFileError ("could not open MXF file for reading", 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"));
+       }
+       
+       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 (ERROR, "audio MXF picture descriptors differ");
+               return false;
+       }
+       
+       ASDCP::PCM::FrameBuffer buffer_A (1 * Kumu::Megabyte);
+       ASDCP::PCM::FrameBuffer buffer_B (1 * Kumu::Megabyte);
+       
+       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"));
+               }
+               
+               if (ASDCP_FAILURE (reader_B.ReadFrame (i, buffer_B))) {
+                       boost::throw_exception (DCPReadError ("could not read audio frame"));
+               }
+               
+               if (buffer_A.Size() != buffer_B.Size()) {
+                       note (ERROR, "sizes of audio data for frame " + lexical_cast<string>(i) + " differ");
+                       return false;
+               }
+               
+               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 (ERROR, "PCM data difference of " + lexical_cast<string> (d));
+                                       return false;
+                               }
+                       }
+               }
        }
 
-       _digest = make_digest (_mxf_path, _progress);
+       return true;
+}
+
+shared_ptr<const SoundFrame>
+SoundAsset::get_frame (int n) const
+{
+       /* XXX: should add on entry point here? */
+       return shared_ptr<const SoundFrame> (new SoundFrame (path().string(), n, _decryption_context));
+}
+
+shared_ptr<SoundAssetWriter>
+SoundAsset::start_write ()
+{
+       /* XXX: can't we use a shared_ptr here? */
+       return shared_ptr<SoundAssetWriter> (new SoundAssetWriter (this));
+}
+
+struct SoundAssetWriter::ASDCPState
+{
+       ASDCP::PCM::MXFWriter mxf_writer;
+       ASDCP::PCM::FrameBuffer frame_buffer;
+       ASDCP::WriterInfo writer_info;
+       ASDCP::PCM::AudioDescriptor audio_desc;
+       ASDCP::AESEncContext* encryption_context;
+};
+
+SoundAssetWriter::SoundAssetWriter (SoundAsset* a)
+       : _state (new SoundAssetWriter::ASDCPState)
+       , _asset (a)
+       , _finalized (false)
+       , _frames_written (0)
+       , _frame_buffer_offset (0)
+{
+       _state->encryption_context = a->encryption_context ();
+       
+       /* Derived from ASDCP::Wav::SimpleWaveHeader::FillADesc */
+       _state->audio_desc.EditRate = ASDCP::Rational (_asset->edit_rate(), 1);
+       _state->audio_desc.AudioSamplingRate = ASDCP::Rational (_asset->sampling_rate(), 1);
+       _state->audio_desc.Locked = 0;
+       _state->audio_desc.ChannelCount = _asset->channels ();
+       _state->audio_desc.QuantizationBits = 24;
+       _state->audio_desc.BlockAlign = 3 * _asset->channels();
+       _state->audio_desc.AvgBps = _asset->sampling_rate() * _state->audio_desc.BlockAlign;
+       _state->audio_desc.LinkedTrackID = 0;
+       _state->audio_desc.ChannelFormat = ASDCP::PCM::CF_NONE;
+       
+       _state->frame_buffer.Capacity (ASDCP::PCM::CalcFrameBufferSize (_state->audio_desc));
+       _state->frame_buffer.Size (ASDCP::PCM::CalcFrameBufferSize (_state->audio_desc));
+       memset (_state->frame_buffer.Data(), 0, _state->frame_buffer.Capacity());
+       
+       _asset->fill_writer_info (&_state->writer_info, _asset->uuid (), _asset->interop(), _asset->metadata());
+       
+       if (ASDCP_FAILURE (_state->mxf_writer.OpenWrite (_asset->path().string().c_str(), _state->writer_info, _state->audio_desc))) {
+               boost::throw_exception (FileError ("could not open audio MXF for writing", _asset->path().string()));
+       }
 }
 
 void
-SoundAsset::write_to_cpl (ostream& s) const
+SoundAssetWriter::write (float const * const * data, int frames)
 {
-       s << "        <MainSound>\n"
-         << "          <Id>urn:uuid:" << _uuid << "</Id>\n"
-#if BOOST_FILESYSTEM_VERSION == 3              
-         << "          <AnnotationText>" << filesystem::path(_mxf_path).filename().string() << "</AnnotationText>\n"
-#else          
-         << "          <AnnotationText>" << filesystem::path(_mxf_path).filename() << "</AnnotationText>\n"
-#endif         
-         << "          <EditRate>" << _fps << " 1</EditRate>\n"
-         << "          <IntrinsicDuration>" << _length << "</IntrinsicDuration>\n"
-         << "          <EntryPoint>0</EntryPoint>\n"
-         << "          <Duration>" << _length << "</Duration>\n"
-         << "        </MainSound>\n";
+       for (int i = 0; i < frames; ++i) {
+
+               byte_t* out = _state->frame_buffer.Data() + _frame_buffer_offset;
+
+               /* Write one sample per channel */
+               for (int j = 0; j < _asset->channels(); ++j) {
+                       int32_t const s = data[j][i] * (1 << 23);
+                       *out++ = (s & 0xff);
+                       *out++ = (s & 0xff00) >> 8;
+                       *out++ = (s & 0xff0000) >> 16;
+               }
+               _frame_buffer_offset += 3 * _asset->channels();
+
+               assert (_frame_buffer_offset <= int (_state->frame_buffer.Capacity()));
+
+               /* Finish the MXF frame if required */
+               if (_frame_buffer_offset == int (_state->frame_buffer.Capacity())) {
+                       write_current_frame ();
+                       _frame_buffer_offset = 0;
+                       memset (_state->frame_buffer.Data(), 0, _state->frame_buffer.Capacity());
+               }
+       }
+}
+
+void
+SoundAssetWriter::write_current_frame ()
+{
+       if (ASDCP_FAILURE (_state->mxf_writer.WriteFrame (_state->frame_buffer, _state->encryption_context, 0))) {
+               boost::throw_exception (MiscError ("could not write audio MXF frame"));
+       }
+
+       ++_frames_written;
+}
+
+void
+SoundAssetWriter::finalize ()
+{
+       if (_frame_buffer_offset > 0) {
+               write_current_frame ();
+       }
+       
+       if (ASDCP_FAILURE (_state->mxf_writer.Finalize())) {
+               boost::throw_exception (MiscError ("could not finalise audio MXF"));
+       }
+
+       _finalized = true;
+       _asset->set_intrinsic_duration (_frames_written);
+       _asset->set_duration (_frames_written);
 }
 
+string
+SoundAsset::key_type () const
+{
+       return "MDAK";
+}