Switch away from the many-constructor-arguments approach to a hopefully simpler API.
[libdcp.git] / src / sound_asset.cc
index 499f41122209219ff0dc54b58b1564baee9b2e85..ec82752c290ea6f68efb912942f4d4e654169b94 100644 (file)
@@ -25,6 +25,7 @@
 #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"
@@ -41,53 +42,31 @@ using boost::shared_ptr;
 using boost::lexical_cast;
 using namespace libdcp;
 
-SoundAsset::SoundAsset (
-       vector<string> const & files,
-       string directory,
-       string mxf_name,
-       boost::signals2::signal<void (float)>* progress,
-       int fps, int intrinsic_duration, int start_frame
-       )
-       : MXFAsset (directory, mxf_name, progress, fps, intrinsic_duration)
-       , _channels (files.size ())
+SoundAsset::SoundAsset (boost::filesystem::path directory, string mxf_name)
+       : MXFAsset (directory, mxf_name)
+       , _channels (0)
        , _sampling_rate (0)
-       , _start_frame (start_frame)
 {
-       assert (_channels);
-       
-       construct (boost::bind (&SoundAsset::path_from_channel, this, _1, files));
+
 }
 
-SoundAsset::SoundAsset (
-       boost::function<string (Channel)> get_path,
-       string directory,
-       string mxf_name,
-       boost::signals2::signal<void (float)>* progress,
-       int fps, int intrinsic_duration, int start_frame, int channels
-       )
-       : MXFAsset (directory, mxf_name, progress, fps, intrinsic_duration)
-       , _channels (channels)
-       , _sampling_rate (0)
-       , _start_frame (start_frame)
+void
+SoundAsset::create (vector<boost::filesystem::path> const & files)
 {
-       assert (_channels);
-       
-       construct (get_path);
+       create (boost::bind (&SoundAsset::path_from_channel, this, _1, files));
 }
 
-SoundAsset::SoundAsset (string directory, string mxf_name)
-       : MXFAsset (directory, mxf_name)
-       , _channels (0)
-       , _start_frame (0)
+void
+SoundAsset::read ()
 {
        ASDCP::PCM::MXFReader reader;
        if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
-               throw MXFFileError ("could not open MXF file for reading", path().string());
+               boost::throw_exception (MXFFileError ("could not open MXF file for reading", path().string()));
        }
 
        ASDCP::PCM::AudioDescriptor desc;
        if (ASDCP_FAILURE (reader.FillAudioDescriptor (desc))) {
-               throw DCPReadError ("could not read audio MXF information");
+               boost::throw_exception (DCPReadError ("could not read audio MXF information"));
        }
 
        _sampling_rate = desc.AudioSamplingRate.Numerator / desc.AudioSamplingRate.Denominator;
@@ -97,17 +76,8 @@ SoundAsset::SoundAsset (string directory, string mxf_name)
        _intrinsic_duration = desc.ContainerDuration;
 }
 
-SoundAsset::SoundAsset (string directory, string mxf_name, int fps, int channels, int sampling_rate)
-       : MXFAsset (directory, mxf_name, 0, fps, 0)
-       , _channels (channels)
-       , _sampling_rate (sampling_rate)
-       , _start_frame (0)
-{
-
-}
-
-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 ());
@@ -115,13 +85,14 @@ SoundAsset::path_from_channel (Channel channel, vector<string> const & files)
 }
 
 void
-SoundAsset::construct (boost::function<string (Channel)> get_path)
+SoundAsset::create (boost::function<boost::filesystem::path (Channel)> get_path)
 {
        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_edit_rate)) {
-               throw FileError ("could not open WAV file for reading", get_path(LEFT));
+               boost::throw_exception (FileError ("could not open WAV file for reading", get_path(LEFT)));
        }
        
        ASDCP::PCM::AudioDescriptor audio_desc;
@@ -150,10 +121,10 @@ SoundAsset::construct (boost::function<string (Channel)> get_path)
 
        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_edit_rate))) {
-                       throw FileError ("could not open WAV file for reading", path);
+                       boost::throw_exception (FileError ("could not open WAV file for reading", path));
                }
 
                pcm_parser_channel[i].FillAudioDescriptor (audio_desc_channel[i]);
@@ -168,20 +139,11 @@ SoundAsset::construct (boost::function<string (Channel)> get_path)
        frame_buffer.Size (ASDCP::PCM::CalcFrameBufferSize (audio_desc));
 
        ASDCP::WriterInfo writer_info;
-       MXFAsset::fill_writer_info (&writer_info, _uuid);
+       MXFAsset::fill_writer_info (&writer_info, _uuid, _interop, _metadata);
 
        ASDCP::PCM::MXFWriter mxf_writer;
        if (ASDCP_FAILURE (mxf_writer.OpenWrite (path().string().c_str(), writer_info, audio_desc))) {
-               throw FileError ("could not open audio MXF for writing", path().string());
-       }
-
-       /* Skip through up to our _start_frame; this is pretty inefficient... */
-       for (int i = 0; i < _start_frame; ++i) {
-               for (int j = 0; j < _channels; ++j) {
-                       if (ASDCP_FAILURE (pcm_parser_channel[j].ReadFrame (frame_buffer_channel[j]))) {
-                               throw MiscError ("could not read audio frame");
-                       }
-               }
+               boost::throw_exception (FileError ("could not open audio MXF for writing", path().string()));
        }
        
        for (int i = 0; i < _intrinsic_duration; ++i) {
@@ -189,7 +151,7 @@ SoundAsset::construct (boost::function<string (Channel)> get_path)
                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");
+                               boost::throw_exception (MiscError ("could not read audio frame"));
                        }
                }
 
@@ -207,8 +169,8 @@ SoundAsset::construct (boost::function<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"));
                }
 
                if (_progress) {
@@ -217,47 +179,40 @@ SoundAsset::construct (boost::function<string (Channel)> get_path)
        }
 
        if (ASDCP_FAILURE (mxf_writer.Finalize())) {
-               throw MiscError ("could not finalise audio MXF");
+               boost::throw_exception (MiscError ("could not finalise audio MXF"));
        }
 }
 
-void
-SoundAsset::write_to_cpl (ostream& s) const
+string
+SoundAsset::cpl_node_name () const
 {
-       s << "        <MainSound>\n"
-         << "          <Id>urn:uuid:" << _uuid << "</Id>\n"
-         << "          <AnnotationText>" << _file_name << "</AnnotationText>\n"
-         << "          <EditRate>" << _edit_rate << " 1</EditRate>\n"
-         << "          <IntrinsicDuration>" << _intrinsic_duration << "</IntrinsicDuration>\n"
-         << "          <EntryPoint>" << _entry_point << "</EntryPoint>\n"
-         << "          <Duration>" << _duration << "</Duration>\n"
-         << "        </MainSound>\n";
+       return "MainSound";
 }
 
 bool
-SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
+SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
 {
-       if (!MXFAsset::equals (other, opt, notes)) {
+       if (!MXFAsset::equals (other, opt, note)) {
                return false;
        }
                     
        ASDCP::PCM::MXFReader reader_A;
        if (ASDCP_FAILURE (reader_A.OpenRead (path().string().c_str()))) {
-               throw MXFFileError ("could not open MXF file for reading", path().string());
+               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()))) {
-               throw MXFFileError ("could not open MXF file for reading", path().string());
+               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))) {
-               throw DCPReadError ("could not read audio MXF information");
+               boost::throw_exception (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");
+               boost::throw_exception (DCPReadError ("could not read audio MXF information"));
        }
        
        if (
@@ -273,7 +228,7 @@ SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<str
 //             desc_A.ChannelFormat != desc_B.ChannelFormat ||
                ) {
                
-               notes.push_back ("audio MXF picture descriptors differ");
+               note (ERROR, "audio MXF picture descriptors differ");
                return false;
        }
        
@@ -282,15 +237,15 @@ SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<str
        
        for (int i = 0; i < _intrinsic_duration; ++i) {
                if (ASDCP_FAILURE (reader_A.ReadFrame (i, buffer_A))) {
-                       throw DCPReadError ("could not read audio frame");
+                       boost::throw_exception (DCPReadError ("could not read audio frame"));
                }
                
                if (ASDCP_FAILURE (reader_B.ReadFrame (i, buffer_B))) {
-                       throw DCPReadError ("could not read audio frame");
+                       boost::throw_exception (DCPReadError ("could not read audio frame"));
                }
                
                if (buffer_A.Size() != buffer_B.Size()) {
-                       notes.push_back ("sizes of audio data for frame " + lexical_cast<string>(i) + " differ");
+                       note (ERROR, "sizes of audio data for frame " + lexical_cast<string>(i) + " differ");
                        return false;
                }
                
@@ -298,7 +253,7 @@ SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<str
                        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) {
-                                       notes.push_back ("PCM data difference of " + lexical_cast<string> (d));
+                                       note (ERROR, "PCM data difference of " + lexical_cast<string> (d));
                                        return false;
                                }
                        }
@@ -311,7 +266,8 @@ SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<str
 shared_ptr<const SoundFrame>
 SoundAsset::get_frame (int n) const
 {
-       return shared_ptr<const SoundFrame> (new SoundFrame (path().string(), n + _entry_point));
+       /* XXX: should add on entry point here? */
+       return shared_ptr<const SoundFrame> (new SoundFrame (path().string(), n, _decryption_context));
 }
 
 shared_ptr<SoundAssetWriter>
@@ -321,31 +277,43 @@ SoundAsset::start_write ()
        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)
-       : _asset (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 */
-       _audio_desc.EditRate = ASDCP::Rational (_asset->edit_rate(), 1);
-       _audio_desc.AudioSamplingRate = ASDCP::Rational (_asset->sampling_rate(), 0);
-       _audio_desc.Locked = 0;
-       _audio_desc.ChannelCount = _asset->channels ();
-       _audio_desc.QuantizationBits = 24;
-       _audio_desc.BlockAlign = 3 * _asset->channels();
-       _audio_desc.AvgBps = _asset->sampling_rate() * _audio_desc.BlockAlign;
-       _audio_desc.LinkedTrackID = 0;
-       _audio_desc.ChannelFormat = ASDCP::PCM::CF_NONE;
+       _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;
        
-       _frame_buffer.Capacity (ASDCP::PCM::CalcFrameBufferSize (_audio_desc));
-       _frame_buffer.Size (ASDCP::PCM::CalcFrameBufferSize (_audio_desc));
-       memset (_frame_buffer.Data(), 0, _frame_buffer.Capacity());
+       _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());
        
-       MXFAsset::fill_writer_info (&_writer_info, _asset->uuid ());
+       _asset->fill_writer_info (&_state->writer_info, _asset->uuid (), _asset->interop(), _asset->metadata());
        
-       if (ASDCP_FAILURE (_mxf_writer.OpenWrite (_asset->path().c_str(), _writer_info, _audio_desc))) {
-               throw FileError ("could not open audio MXF for writing", _asset->path().string());
+       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()));
        }
 }
 
@@ -354,7 +322,7 @@ SoundAssetWriter::write (float const * const * data, int frames)
 {
        for (int i = 0; i < frames; ++i) {
 
-               byte_t* out = _frame_buffer.Data() + _frame_buffer_offset;
+               byte_t* out = _state->frame_buffer.Data() + _frame_buffer_offset;
 
                /* Write one sample per channel */
                for (int j = 0; j < _asset->channels(); ++j) {
@@ -365,13 +333,13 @@ SoundAssetWriter::write (float const * const * data, int frames)
                }
                _frame_buffer_offset += 3 * _asset->channels();
 
-               assert (_frame_buffer_offset <= int (_frame_buffer.Capacity()));
+               assert (_frame_buffer_offset <= int (_state->frame_buffer.Capacity()));
 
                /* Finish the MXF frame if required */
-               if (_frame_buffer_offset == int (_frame_buffer.Capacity())) {
+               if (_frame_buffer_offset == int (_state->frame_buffer.Capacity())) {
                        write_current_frame ();
                        _frame_buffer_offset = 0;
-                       memset (_frame_buffer.Data(), 0, _frame_buffer.Capacity());
+                       memset (_state->frame_buffer.Data(), 0, _state->frame_buffer.Capacity());
                }
        }
 }
@@ -379,8 +347,8 @@ SoundAssetWriter::write (float const * const * data, int frames)
 void
 SoundAssetWriter::write_current_frame ()
 {
-       if (ASDCP_FAILURE (_mxf_writer.WriteFrame (_frame_buffer, 0, 0))) {
-               throw MiscError ("could not write audio MXF 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;
@@ -393,8 +361,8 @@ SoundAssetWriter::finalize ()
                write_current_frame ();
        }
        
-       if (ASDCP_FAILURE (_mxf_writer.Finalize())) {
-               throw MiscError ("could not finalise audio MXF");
+       if (ASDCP_FAILURE (_state->mxf_writer.Finalize())) {
+               boost::throw_exception (MiscError ("could not finalise audio MXF"));
        }
 
        _finalized = true;
@@ -402,7 +370,8 @@ SoundAssetWriter::finalize ()
        _asset->set_duration (_frames_written);
 }
 
-SoundAssetWriter::~SoundAssetWriter ()
+string
+SoundAsset::key_type () const
 {
-       assert (_finalized);
+       return "MDAK";
 }