/*
- Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
- This program is free software; you can redistribute it and/or modify
+ This file is part of libdcp.
+
+ libdcp is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
- This program is distributed in the hope that it will be useful,
+ libdcp is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
+ along with libdcp. If not, see <http://www.gnu.org/licenses/>.
+
+ In addition, as a special exception, the copyright holders give
+ permission to link the code of portions of this program with the
+ OpenSSL library under certain conditions as described in each
+ individual source file, and distribute linked combinations
+ including the two.
+
+ You must obey the GNU General Public License in all respects
+ for all of the code used other than OpenSSL. If you modify
+ file(s) with this exception, you may extend this exception to your
+ version of the file(s), but you are not obligated to do so. If you
+ do not wish to do so, delete this exception statement from your
+ version. If you delete this exception statement from all source
+ files in the program, then also delete it here.
*/
+
/** @file src/sound_asset.cc
- * @brief An asset made up of WAV files
+ * @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 "sound_asset_reader.h"
+#include "compose.hpp"
+#include "dcp_assert.h"
+#include <asdcp/AS_DCP.h>
+#include <asdcp/KM_fileio.h>
+#include <asdcp/Metadata.h>
+#include <libxml++/nodes/element.h>
+#include <boost/filesystem.hpp>
+#include <stdexcept>
+
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 directory, string mxf_name, boost::signals2::signal<void (float)>* progress, int fps, int length
- )
- : MXFAsset (directory, mxf_name, progress, fps, 0, length)
- , _channels (files.size ())
- , _sampling_rate (0)
-{
- 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 length, int channels
- )
- : MXFAsset (directory, mxf_name, progress, fps, 0, length)
- , _channels (channels)
- , _sampling_rate (0)
-{
- construct (get_path);
-}
-
-SoundAsset::SoundAsset (string directory, string mxf_name, int fps, int entry_point, int length)
- : MXFAsset (directory, mxf_name, 0, fps, entry_point, length)
- , _channels (0)
+using std::shared_ptr;
+using std::dynamic_pointer_cast;
+using namespace dcp;
+
+
+SoundAsset::SoundAsset (boost::filesystem::path file)
+ : Asset (file)
+ /* XXX: this is a fallback language, which will be used if we can't find the RFC5646SpokenLanguage
+ * in the MXF header. Perhaps RFC5646SpokenLanguage is optional and we should just not write it
+ * if we don't know it.
+ */
+ , _language ("en-US")
{
ASDCP::PCM::MXFReader reader;
- if (ASDCP_FAILURE (reader.OpenRead (path().string().c_str()))) {
- throw MXFFileError ("could not open MXF file for reading", path().string());
+ auto 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));
}
-
ASDCP::PCM::AudioDescriptor desc;
- if (ASDCP_FAILURE (reader.FillAudioDescriptor (desc))) {
- throw DCPReadError ("could not read audio MXF information");
+ if (ASDCP_FAILURE (reader.FillAudioDescriptor(desc))) {
+ boost::throw_exception (ReadError("could not read audio MXF information"));
}
_sampling_rate = desc.AudioSamplingRate.Numerator / desc.AudioSamplingRate.Denominator;
_channels = desc.ChannelCount;
-}
-
-string
-SoundAsset::path_from_channel (Channel channel, vector<string> const & files)
-{
- unsigned int const c = int (channel);
- assert (c < files.size ());
- return files[c];
-}
+ _edit_rate = Fraction (desc.EditRate.Numerator, desc.EditRate.Denominator);
-void
-SoundAsset::construct (boost::function<string (Channel)> get_path)
-{
- 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::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,
- /* 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]);
-
- if (ASDCP_FAILURE (pcm_parser_channel[i].OpenRead (path.c_str(), asdcp_fps))) {
- throw FileError ("could not open WAV file for reading", path);
- }
+ _intrinsic_duration = desc.ContainerDuration;
- 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::WriterInfo info;
+ if (ASDCP_FAILURE (reader.FillWriterInfo(info))) {
+ boost::throw_exception (ReadError("could not read audio MXF information"));
}
- 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 (path().string().c_str(), writer_info, audio_desc))) {
- throw 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 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()) {
- stringstream s;
- s << "short audio frame; " << _channels << " channels, "
- << frame_buffer_channel[j].Size() << " vs " << frame_buffer_channel[j].Capacity();
- throw MiscError (s.str ());
- }
- }
-
- 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 (mxf_writer.WriteFrame (frame_buffer, 0, 0))) {
- throw MiscError ("could not write audio MXF frame");
- }
-
- if (_progress) {
- (*_progress) (0.5 * float (i) / _length);
+ ASDCP::MXF::SoundfieldGroupLabelSubDescriptor* soundfield;
+ auto rr = reader.OP1aHeader().GetMDObjectByType(
+ asdcp_smpte_dict->ul(ASDCP::MDD_SoundfieldGroupLabelSubDescriptor),
+ reinterpret_cast<ASDCP::MXF::InterchangeObject**>(&soundfield)
+ );
+
+ if (KM_SUCCESS(rr)) {
+ if (!soundfield->RFC5646SpokenLanguage.empty()) {
+ char buffer[64];
+ soundfield->RFC5646SpokenLanguage.get().EncodeString(buffer, sizeof(buffer));
+ _language = buffer;
}
}
- if (ASDCP_FAILURE (mxf_writer.Finalize())) {
- throw MiscError ("could not finalise audio MXF");
- }
+ _id = read_writer_info (info);
}
-void
-SoundAsset::write_to_cpl (ostream& s) const
+
+SoundAsset::SoundAsset (Fraction edit_rate, int sampling_rate, int channels, LanguageTag language, Standard standard)
+ : MXF (standard)
+ , _edit_rate (edit_rate)
+ , _channels (channels)
+ , _sampling_rate (sampling_rate)
+ , _language (language.to_string())
{
- s << " <MainSound>\n"
- << " <Id>urn:uuid:" << _uuid << "</Id>\n"
- << " <AnnotationText>" << _file_name << "</AnnotationText>\n"
- << " <EditRate>" << _fps << " 1</EditRate>\n"
- << " <IntrinsicDuration>" << _length << "</IntrinsicDuration>\n"
- << " <EntryPoint>0</EntryPoint>\n"
- << " <Duration>" << _length << "</Duration>\n"
- << " </MainSound>\n";
+
}
+
bool
-SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, list<string>& notes) const
+SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, NoteHandler note) const
{
- if (!MXFAsset::equals (other, opt, notes)) {
- 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());
+ DCP_ASSERT (file());
+ auto 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::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());
+ r = reader_B.OpenRead (other->file()->string().c_str());
+ if (ASDCP_FAILURE (r)) {
+ boost::throw_exception (MXFFileError("could not open MXF file for reading", other->file()->string(), r));
}
ASDCP::PCM::AudioDescriptor desc_A;
- if (ASDCP_FAILURE (reader_A.FillAudioDescriptor (desc_A))) {
- throw DCPReadError ("could not read audio MXF information");
+ if (ASDCP_FAILURE (reader_A.FillAudioDescriptor(desc_A))) {
+ boost::throw_exception (ReadError ("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 (ASDCP_FAILURE (reader_B.FillAudioDescriptor(desc_B))) {
+ boost::throw_exception (ReadError ("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");
+
+ if (desc_A.EditRate != desc_B.EditRate) {
+ note (
+ NoteType::ERROR,
+ String::compose (
+ "audio edit rates differ: %1/%2 cf %3/%4",
+ desc_A.EditRate.Numerator, desc_A.EditRate.Denominator, desc_B.EditRate.Numerator, desc_B.EditRate.Denominator
+ )
+ );
+ return false;
+ } else if (desc_A.AudioSamplingRate != desc_B.AudioSamplingRate) {
+ note (
+ NoteType::ERROR,
+ String::compose (
+ "audio sampling rates differ: %1 cf %2",
+ desc_A.AudioSamplingRate.Numerator, desc_A.AudioSamplingRate.Denominator,
+ desc_B.AudioSamplingRate.Numerator, desc_B.AudioSamplingRate.Numerator
+ )
+ );
+ return false;
+ } else if (desc_A.Locked != desc_B.Locked) {
+ note (NoteType::ERROR, String::compose ("audio locked flags differ: %1 cf %2", desc_A.Locked, desc_B.Locked));
+ return false;
+ } else if (desc_A.ChannelCount != desc_B.ChannelCount) {
+ note (NoteType::ERROR, String::compose ("audio channel counts differ: %1 cf %2", desc_A.ChannelCount, desc_B.ChannelCount));
+ return false;
+ } else if (desc_A.QuantizationBits != desc_B.QuantizationBits) {
+ note (NoteType::ERROR, String::compose ("audio bits per sample differ: %1 cf %2", desc_A.QuantizationBits, desc_B.QuantizationBits));
+ return false;
+ } else if (desc_A.BlockAlign != desc_B.BlockAlign) {
+ note (NoteType::ERROR, String::compose ("audio bytes per sample differ: %1 cf %2", desc_A.BlockAlign, desc_B.BlockAlign));
return false;
+ } else if (desc_A.AvgBps != desc_B.AvgBps) {
+ note (NoteType::ERROR, String::compose ("audio average bps differ: %1 cf %2", desc_A.AvgBps, desc_B.AvgBps));
+ return false;
+ } else if (desc_A.LinkedTrackID != desc_B.LinkedTrackID) {
+ note (NoteType::ERROR, String::compose ("audio linked track IDs differ: %1 cf %2", desc_A.LinkedTrackID, desc_B.LinkedTrackID));
+ return false;
+ } else if (desc_A.ContainerDuration != desc_B.ContainerDuration) {
+ note (NoteType::ERROR, String::compose ("audio container durations differ: %1 cf %2", desc_A.ContainerDuration, desc_B.ContainerDuration));
+ return false;
+ } else if (desc_A.ChannelFormat != desc_B.ChannelFormat) {
+ /* XXX */
}
-
- 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 (i, buffer_A))) {
- throw DCPReadError ("could not read audio frame");
- }
-
- if (ASDCP_FAILURE (reader_B.ReadFrame (i, buffer_B))) {
- throw 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");
+
+ auto other_sound = dynamic_pointer_cast<const SoundAsset> (other);
+
+ auto reader = start_read ();
+ auto other_reader = other_sound->start_read ();
+
+ for (int i = 0; i < _intrinsic_duration; ++i) {
+
+ auto frame_A = reader->get_frame (i);
+ auto frame_B = other_reader->get_frame (i);
+
+ if (frame_A->size() != frame_B->size()) {
+ note (NoteType::ERROR, String::compose ("sizes of audio data for frame %1 differ", i));
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) {
- notes.push_back ("PCM data difference of " + lexical_cast<string> (d));
- return false;
+
+ if (memcmp (frame_A->data(), frame_B->data(), frame_A->size()) != 0) {
+ for (int sample = 0; sample < frame_A->samples(); ++sample) {
+ for (int channel = 0; channel < frame_A->channels(); ++channel) {
+ int32_t const d = abs(frame_A->get(channel, sample) - frame_B->get(channel, sample));
+ if (d > opt.max_audio_sample_error) {
+ note (NoteType::ERROR, String::compose ("PCM data difference of %1", d));
+ return false;
+ }
}
}
}
return true;
}
-shared_ptr<const SoundFrame>
-SoundAsset::get_frame (int n) const
+
+shared_ptr<SoundAssetWriter>
+SoundAsset::start_write (boost::filesystem::path file, vector<Channel> active_channels, bool atmos_sync)
+{
+ if (atmos_sync && _channels < 14) {
+ throw MiscError ("Insufficient channels to write ATMOS sync (there must be at least 14)");
+ }
+
+ return shared_ptr<SoundAssetWriter> (new SoundAssetWriter(this, file, active_channels, atmos_sync));
+}
+
+
+shared_ptr<SoundAssetReader>
+SoundAsset::start_read () const
+{
+ return shared_ptr<SoundAssetReader> (new SoundAssetReader(this, key(), standard()));
+}
+
+
+string
+SoundAsset::static_pkl_type (Standard standard)
+{
+ switch (standard) {
+ case Standard::INTEROP:
+ return "application/x-smpte-mxf;asdcpKind=Sound";
+ case Standard::SMPTE:
+ return "application/mxf";
+ default:
+ DCP_ASSERT (false);
+ }
+}
+
+
+bool
+SoundAsset::valid_mxf (boost::filesystem::path file)
{
- return shared_ptr<const SoundFrame> (new SoundFrame (path().string(), n + _entry_point));
+ ASDCP::PCM::MXFReader reader;
+ Kumu::Result_t r = reader.OpenRead (file.string().c_str());
+ return !ASDCP_FAILURE (r);
}
projects / libdcp.git / blobdiff