/*
- Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
This file is part of libdcp.
files in the program, then also delete it here.
*/
-#include "sound_asset_writer.h"
-#include "sound_asset.h"
-#include "exceptions.h"
-#include "dcp_assert.h"
+
+/** @file src/sound_asset_writer.cc
+ * @brief SoundAssetWriter class
+ */
+
+
+#include "bitstream.h"
#include "compose.hpp"
-#include "encryption_context.h"
+#include "crypto_context.h"
+#include "dcp_assert.h"
+#include "exceptions.h"
+#include "filesystem.h"
+#include "sound_asset.h"
+#include "sound_asset_writer.h"
+#include "warnings.h"
+LIBDCP_DISABLE_WARNINGS
#include <asdcp/AS_DCP.h>
+#include <asdcp/Metadata.h>
+LIBDCP_ENABLE_WARNINGS
+#include <iostream>
+
using std::min;
using std::max;
+using std::cout;
+using std::string;
+using std::vector;
using namespace dcp;
+
struct SoundAssetWriter::ASDCPState
{
ASDCP::PCM::MXFWriter mxf_writer;
ASDCP::PCM::FrameBuffer frame_buffer;
ASDCP::WriterInfo writer_info;
- ASDCP::PCM::AudioDescriptor audio_desc;
+ ASDCP::PCM::AudioDescriptor desc;
};
-SoundAssetWriter::SoundAssetWriter (SoundAsset* asset, boost::filesystem::path file, Standard standard, ChannelAssignment assign)
- : AssetWriter (asset, file, standard)
+
+SoundAssetWriter::SoundAssetWriter(SoundAsset* asset, boost::filesystem::path file, vector<dcp::Channel> extra_active_channels, bool sync, bool include_mca_subdescriptors)
+ : AssetWriter (asset, file)
, _state (new SoundAssetWriter::ASDCPState)
- , _sound_asset (asset)
- , _frame_buffer_offset (0)
+ , _asset (asset)
+ , _extra_active_channels(extra_active_channels)
+ , _sync (sync)
+ , _include_mca_subdescriptors(include_mca_subdescriptors)
{
+ DCP_ASSERT (!_sync || _asset->channels() >= 14);
+ DCP_ASSERT (!_sync || _asset->standard() == Standard::SMPTE);
+
+ /* None of these are allowed in extra_active_channels; some are implicit, and (it seems) should never have a descriptor
+ * written for them.
+ */
+ vector<Channel> disallowed_extra = {
+ Channel::LEFT,
+ Channel::RIGHT,
+ Channel::CENTRE,
+ Channel::LFE,
+ Channel::LS,
+ Channel::RS,
+ Channel::MOTION_DATA,
+ Channel::SYNC_SIGNAL,
+ Channel::SIGN_LANGUAGE,
+ Channel::CHANNEL_COUNT
+ };
+ for (auto disallowed: disallowed_extra) {
+ DCP_ASSERT(std::find(extra_active_channels.begin(), extra_active_channels.end(), disallowed) == extra_active_channels.end());
+ }
+
/* Derived from ASDCP::Wav::SimpleWaveHeader::FillADesc */
- _state->audio_desc.EditRate = ASDCP::Rational (_sound_asset->edit_rate().numerator, _sound_asset->edit_rate().denominator);
- _state->audio_desc.AudioSamplingRate = ASDCP::Rational (_sound_asset->sampling_rate(), 1);
- _state->audio_desc.Locked = 0;
- _state->audio_desc.ChannelCount = _sound_asset->channels ();
- _state->audio_desc.QuantizationBits = 24;
- _state->audio_desc.BlockAlign = 3 * _sound_asset->channels();
- _state->audio_desc.AvgBps = _sound_asset->sampling_rate() * _state->audio_desc.BlockAlign;
- _state->audio_desc.LinkedTrackID = 0;
- if (standard == INTEROP) {
- _state->audio_desc.ChannelFormat = ASDCP::PCM::CF_NONE;
+ _state->desc.EditRate = ASDCP::Rational (_asset->edit_rate().numerator, _asset->edit_rate().denominator);
+ _state->desc.AudioSamplingRate = ASDCP::Rational (_asset->sampling_rate(), 1);
+ _state->desc.Locked = 0;
+ _state->desc.ChannelCount = _asset->channels();
+ _state->desc.QuantizationBits = 24;
+ _state->desc.BlockAlign = 3 * _asset->channels();
+ _state->desc.AvgBps = _asset->sampling_rate() * _state->desc.BlockAlign;
+ _state->desc.LinkedTrackID = 0;
+ if (asset->standard() == Standard::INTEROP) {
+ _state->desc.ChannelFormat = ASDCP::PCM::CF_NONE;
} else {
- switch (assign) {
- case CHANNEL_ASSIGNMENT_51:
- _state->audio_desc.ChannelFormat = ASDCP::PCM::CF_CFG_1;
- break;
- case CHANNEL_ASSIGNMENT_61:
- _state->audio_desc.ChannelFormat = ASDCP::PCM::CF_CFG_2;
- break;
- case CHANNEL_ASSIGNMENT_71:
- _state->audio_desc.ChannelFormat = ASDCP::PCM::CF_CFG_3;
- break;
- case CHANNEL_ASSIGNMENT_WTF:
- _state->audio_desc.ChannelFormat = ASDCP::PCM::CF_CFG_4;
- break;
- case CHANNEL_ASSIGNMENT_71_DS:
- _state->audio_desc.ChannelFormat = ASDCP::PCM::CF_CFG_5;
- break;
- }
+ /* As required by Bv2.1 */
+ _state->desc.ChannelFormat = ASDCP::PCM::CF_CFG_4;
}
- _state->frame_buffer.Capacity (ASDCP::PCM::CalcFrameBufferSize (_state->audio_desc));
- _state->frame_buffer.Size (ASDCP::PCM::CalcFrameBufferSize (_state->audio_desc));
+ /* I'm fairly sure this is not necessary, as ContainerDuration is written
+ in ASDCP's WriteMXFFooter, but it stops a valgrind warning.
+ */
+ _state->desc.ContainerDuration = 0;
+
+ _state->frame_buffer.Capacity (ASDCP::PCM::CalcFrameBufferSize (_state->desc));
+ _state->frame_buffer.Size (ASDCP::PCM::CalcFrameBufferSize (_state->desc));
memset (_state->frame_buffer.Data(), 0, _state->frame_buffer.Capacity());
- _sound_asset->fill_writer_info (&_state->writer_info, _sound_asset->id(), standard);
+ _asset->fill_writer_info (&_state->writer_info, _asset->id());
+
+ if (_sync) {
+ _fsk.set_data (create_sync_packets());
+ }
}
+
+SoundAssetWriter::~SoundAssetWriter()
+{
+ try {
+ /* Last-resort finalization to close the file, at least */
+ if (!_finalized) {
+ _state->mxf_writer.Finalize();
+ }
+ } catch (...) {}
+}
+
+
void
-SoundAssetWriter::write (float const * const * data, int frames)
+SoundAssetWriter::start ()
{
- DCP_ASSERT (!_finalized);
+ auto r = _state->mxf_writer.OpenWrite(dcp::filesystem::fix_long_path(_file).string().c_str(), _state->writer_info, _state->desc);
+ if (ASDCP_FAILURE(r)) {
+ boost::throw_exception (FileError("could not open audio MXF for writing", _file.string(), r));
+ }
+
+ if (_asset->standard() == Standard::SMPTE && _include_mca_subdescriptors) {
- static float const clip = 1.0f - (1.0f / pow (2, 23));
+ ASDCP::MXF::WaveAudioDescriptor* essence_descriptor = nullptr;
+ _state->mxf_writer.OP1aHeader().GetMDObjectByType(
+ asdcp_smpte_dict->ul(ASDCP::MDD_WaveAudioDescriptor), reinterpret_cast<ASDCP::MXF::InterchangeObject**>(&essence_descriptor)
+ );
+ DCP_ASSERT (essence_descriptor);
+ essence_descriptor->ChannelAssignment = asdcp_smpte_dict->ul(ASDCP::MDD_DCAudioChannelCfg_4_WTF);
- if (!_started) {
- Kumu::Result_t r = _state->mxf_writer.OpenWrite (_file.string().c_str(), _state->writer_info, _state->audio_desc);
- if (ASDCP_FAILURE (r)) {
- boost::throw_exception (FileError ("could not open audio MXF for writing", _file.string(), r));
+ auto soundfield = new ASDCP::MXF::SoundfieldGroupLabelSubDescriptor(asdcp_smpte_dict);
+ GenRandomValue (soundfield->MCALinkID);
+ if (auto lang = _asset->language()) {
+ soundfield->RFC5646SpokenLanguage = *lang;
}
- _sound_asset->set_file (_file);
- _started = true;
- }
+ MCASoundField const field =
+ (
+ find(_extra_active_channels.begin(), _extra_active_channels.end(), dcp::Channel::BSL) != _extra_active_channels.end() ||
+ find(_extra_active_channels.begin(), _extra_active_channels.end(), dcp::Channel::BSR) != _extra_active_channels.end()
+ ) ? MCASoundField::SEVEN_POINT_ONE : MCASoundField::FIVE_POINT_ONE;
- int const ch = _sound_asset->channels ();
+ if (field == MCASoundField::SEVEN_POINT_ONE) {
+ soundfield->MCATagSymbol = "sg71";
+ soundfield->MCATagName = "7.1DS";
+LIBDCP_DISABLE_WARNINGS
+ soundfield->MCALabelDictionaryID = asdcp_smpte_dict->ul(ASDCP::MDD_DCAudioSoundfield_71);
+LIBDCP_ENABLE_WARNINGS
+ } else {
+ soundfield->MCATagSymbol = "sg51";
+ soundfield->MCATagName = "5.1";
+LIBDCP_DISABLE_WARNINGS
+ soundfield->MCALabelDictionaryID = asdcp_smpte_dict->ul(ASDCP::MDD_DCAudioSoundfield_51);
+LIBDCP_ENABLE_WARNINGS
+ }
- for (int i = 0; i < frames; ++i) {
+ _state->mxf_writer.OP1aHeader().AddChildObject(soundfield);
+ essence_descriptor->SubDescriptors.push_back(soundfield->InstanceUID);
- byte_t* out = _state->frame_buffer.Data() + _frame_buffer_offset;
+ /* We always make a descriptor for these channels if they are present in the asset;
+ * there's no way for the caller to tell us whether they are active or not.
+ */
+ std::vector<dcp::Channel> dcp_channels = {
+ Channel::LEFT,
+ Channel::RIGHT,
+ Channel::CENTRE,
+ Channel::LFE,
+ Channel::LS,
+ Channel::RS
+ };
- /* Write one sample per channel */
- for (int j = 0; j < ch; ++j) {
- /* Convert sample to 24-bit int, clipping if necessary. */
- float x = data[j][i];
- if (x > clip) {
- x = clip;
- } else if (x < -clip) {
- x = -clip;
- }
- int32_t const s = x * (1 << 23);
- *out++ = (s & 0xff);
- *out++ = (s & 0xff00) >> 8;
- *out++ = (s & 0xff0000) >> 16;
- }
- _frame_buffer_offset += 3 * ch;
+ /* We add descriptors for some extra channels that the caller gave us (we made sure earlier
+ * that nothing "bad" is in this list).
+ */
+ std::copy(_extra_active_channels.begin(), _extra_active_channels.end(), back_inserter(dcp_channels));
+
+ /* Remove duplicates */
+ std::sort(dcp_channels.begin(), dcp_channels.end());
+ dcp_channels.erase(std::unique(dcp_channels.begin(), dcp_channels.end()), dcp_channels.end());
- DCP_ASSERT (_frame_buffer_offset <= int (_state->frame_buffer.Capacity()));
+ /* Remove channels that aren't actually in this MXF at all */
+ dcp_channels.erase(
+ std::remove_if(dcp_channels.begin(), dcp_channels.end(), [this](dcp::Channel channel) {
+ return static_cast<int>(channel) >= _asset->channels();
+ }),
+ dcp_channels.end()
+ );
- /* 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());
+ for (auto dcp_channel: dcp_channels) {
+ auto channel = new ASDCP::MXF::AudioChannelLabelSubDescriptor(asdcp_smpte_dict);
+ GenRandomValue (channel->MCALinkID);
+ channel->SoundfieldGroupLinkID = soundfield->MCALinkID;
+ channel->MCAChannelID = static_cast<int>(dcp_channel) + 1;
+ channel->MCATagSymbol = "ch" + channel_to_mca_id(dcp_channel, field);
+ channel->MCATagName = channel_to_mca_name(dcp_channel, field);
+ if (auto lang = _asset->language()) {
+ channel->RFC5646SpokenLanguage = *lang;
+ }
+LIBDCP_DISABLE_WARNINGS
+ channel->MCALabelDictionaryID = channel_to_mca_universal_label(dcp_channel, field, asdcp_smpte_dict);
+LIBDCP_ENABLE_WARNINGS
+ _state->mxf_writer.OP1aHeader().AddChildObject(channel);
+ essence_descriptor->SubDescriptors.push_back(channel->InstanceUID);
}
}
+
+ _asset->set_file (_file);
+ _started = true;
}
+
+void
+SoundAssetWriter::write(float const * const * data, int data_channels, int frames)
+{
+ do_write(data, data_channels, frames);
+}
+
+
+void
+SoundAssetWriter::write(int32_t const * const * data, int data_channels, int frames)
+{
+ do_write(data, data_channels, frames);
+}
+
+
void
SoundAssetWriter::write_current_frame ()
{
- ASDCP::Result_t const r = _state->mxf_writer.WriteFrame (_state->frame_buffer, _encryption_context->encryption(), _encryption_context->hmac());
- if (ASDCP_FAILURE (r)) {
- boost::throw_exception (MiscError (String::compose ("could not write audio MXF frame (%1)", int (r))));
+ auto const r = _state->mxf_writer.WriteFrame (_state->frame_buffer, _crypto_context->context(), _crypto_context->hmac());
+ if (ASDCP_FAILURE(r)) {
+ boost::throw_exception (MiscError(String::compose("could not write audio MXF frame (%1)", static_cast<int>(r))));
}
++_frames_written;
+
+ if (_sync) {
+ /* We need a new set of sync packets for this frame */
+ _fsk.set_data (create_sync_packets());
+ }
}
bool
write_current_frame ();
}
- if (_started && ASDCP_FAILURE (_state->mxf_writer.Finalize())) {
- boost::throw_exception (MiscError ("could not finalise audio MXF"));
+ if (_started) {
+ auto const r = _state->mxf_writer.Finalize();
+ if (ASDCP_FAILURE(r)) {
+ boost::throw_exception (MiscError(String::compose ("could not finalise audio MXF (%1)", static_cast<int>(r))));
+ }
}
- _sound_asset->_intrinsic_duration = _frames_written;
+ _asset->_intrinsic_duration = _frames_written;
return AssetWriter::finalize ();
}
+
+
+/** Calculate and return the sync packets required for this edit unit (aka "frame") */
+vector<bool>
+SoundAssetWriter::create_sync_packets ()
+{
+ /* Parts of this code assumes 48kHz */
+ DCP_ASSERT (_asset->sampling_rate() == 48000);
+
+ /* Encoding of edit rate */
+ int edit_rate_code = 0;
+ /* How many 0 bits are used to pad the end of the packet */
+ int remaining_bits = 0;
+ /* How many packets in this edit unit (i.e. "frame") */
+ int packets = 0;
+ auto const edit_rate = _asset->edit_rate ();
+ if (edit_rate == Fraction(24, 1)) {
+ edit_rate_code = 0;
+ remaining_bits = 25;
+ packets = 4;
+ } else if (edit_rate == Fraction(25, 1)) {
+ edit_rate_code = 1;
+ remaining_bits = 20;
+ packets = 4;
+ } else if (edit_rate == Fraction(30, 1)) {
+ edit_rate_code = 2;
+ remaining_bits = 0;
+ packets = 4;
+ } else if (edit_rate == Fraction(48, 1)) {
+ edit_rate_code = 3;
+ remaining_bits = 25;
+ packets = 2;
+ } else if (edit_rate == Fraction(50, 1)) {
+ edit_rate_code = 4;
+ remaining_bits = 20;
+ packets = 2;
+ } else if (edit_rate == Fraction(60, 1)) {
+ edit_rate_code = 5;
+ remaining_bits = 0;
+ packets = 2;
+ } else if (edit_rate == Fraction(96, 1)) {
+ edit_rate_code = 6;
+ remaining_bits = 25;
+ packets = 1;
+ } else if (edit_rate == Fraction(100, 1)) {
+ edit_rate_code = 7;
+ remaining_bits = 20;
+ packets = 1;
+ } else if (edit_rate == Fraction(120, 1)) {
+ edit_rate_code = 8;
+ remaining_bits = 0;
+ packets = 1;
+ }
+
+ Bitstream bs;
+
+ Kumu::UUID id;
+ DCP_ASSERT (id.DecodeHex(_asset->id().c_str()));
+
+ for (int i = 0; i < packets; ++i) {
+ bs.write_from_byte (0x4d);
+ bs.write_from_byte (0x56);
+ bs.start_crc (0x1021);
+ bs.write_from_byte (edit_rate_code, 4);
+ bs.write_from_byte (0, 2);
+ bs.write_from_byte (_sync_packet, 2);
+ bs.write_from_byte (id.Value()[i * 4 + 0]);
+ bs.write_from_byte (id.Value()[i * 4 + 1]);
+ bs.write_from_byte (id.Value()[i * 4 + 2]);
+ bs.write_from_byte (id.Value()[i * 4 + 3]);
+ bs.write_from_word (_frames_written, 24);
+ bs.write_crc ();
+ bs.write_from_byte (0, 4);
+ bs.write_from_word (0, remaining_bits);
+
+ ++_sync_packet;
+ if (_sync_packet == 4) {
+ _sync_packet = 0;
+ }
+ }
+
+ return bs.get();
+}
+
+
+byte_t*
+SoundAssetWriter::frame_buffer_data() const
+{
+ return _state->frame_buffer.Data();
+}
+
+
+int
+SoundAssetWriter::frame_buffer_capacity() const
+{
+ return _state->frame_buffer.Capacity();
+}
+
projects / libdcp.git / blobdiff