src/sound_asset_writer.cc

   1 /*
   2     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34 #include "sound_asset_writer.h"
  35 #include "sound_asset.h"
  36 #include "exceptions.h"
  37 #include "dcp_assert.h"
  38 #include "compose.hpp"
  39 #include "encryption_context.h"
  40 #include <asdcp/AS_DCP.h>
  41
  42 using std::min;
  43 using std::max;
  44 using namespace dcp;
  45
  46 struct SoundAssetWriter::ASDCPState
  47 {
  48         ASDCP::PCM::MXFWriter mxf_writer;
  49         ASDCP::PCM::FrameBuffer frame_buffer;
  50         ASDCP::WriterInfo writer_info;
  51         ASDCP::PCM::AudioDescriptor desc;
  52 };
  53
  54 SoundAssetWriter::SoundAssetWriter (SoundAsset* asset, boost::filesystem::path file, Standard standard)
  55         : AssetWriter (asset, file, standard)
  56         , _state (new SoundAssetWriter::ASDCPState)
  57         , _asset (asset)
  58         , _frame_buffer_offset (0)
  59 {
  60         /* Derived from ASDCP::Wav::SimpleWaveHeader::FillADesc */
  61         _state->desc.EditRate = ASDCP::Rational (_asset->edit_rate().numerator, _asset->edit_rate().denominator);
  62         _state->desc.AudioSamplingRate = ASDCP::Rational (_asset->sampling_rate(), 1);
  63         _state->desc.Locked = 0;
  64         _state->desc.ChannelCount = _asset->channels ();
  65         _state->desc.QuantizationBits = 24;
  66         _state->desc.BlockAlign = 3 * _asset->channels();
  67         _state->desc.AvgBps = _asset->sampling_rate() * _state->desc.BlockAlign;
  68         _state->desc.LinkedTrackID = 0;
  69         if (standard == INTEROP) {
  70                 _state->desc.ChannelFormat = ASDCP::PCM::CF_NONE;
  71         } else {
  72                 /* Just use WTF ("wild track format") for SMPTE for now; searches suggest that this
  73                    uses the same assignment as Interop.
  74                 */
  75                 _state->desc.ChannelFormat = ASDCP::PCM::CF_CFG_4;
  76         }
  77
  78         /* I'm fairly sure this is not necessary, as ContainerDuration is written
  79            in ASDCP's WriteMXFFooter, but it stops a valgrind warning.
  80         */
  81         _state->desc.ContainerDuration = 0;
  82
  83         _state->frame_buffer.Capacity (ASDCP::PCM::CalcFrameBufferSize (_state->desc));
  84         _state->frame_buffer.Size (ASDCP::PCM::CalcFrameBufferSize (_state->desc));
  85         memset (_state->frame_buffer.Data(), 0, _state->frame_buffer.Capacity());
  86
  87         _asset->fill_writer_info (&_state->writer_info, _asset->id(), standard);
  88 }
  89
  90 void
  91 SoundAssetWriter::write (float const * const * data, int frames)
  92 {
  93         DCP_ASSERT (!_finalized);
  94
  95         static float const clip = 1.0f - (1.0f / pow (2, 23));
  96
  97         if (!_started) {
  98                 Kumu::Result_t r = _state->mxf_writer.OpenWrite (_file.string().c_str(), _state->writer_info, _state->desc);
  99                 if (ASDCP_FAILURE (r)) {
 100                         boost::throw_exception (FileError ("could not open audio MXF for writing", _file.string(), r));
 101                 }
 102
 103                 _asset->set_file (_file);
 104                 _started = true;
 105         }
 106
 107         int const ch = _asset->channels ();
 108
 109         for (int i = 0; i < frames; ++i) {
 110
 111                 byte_t* out = _state->frame_buffer.Data() + _frame_buffer_offset;
 112
 113                 /* Write one sample per channel */
 114                 for (int j = 0; j < ch; ++j) {
 115                         /* Convert sample to 24-bit int, clipping if necessary. */
 116                         float x = data[j][i];
 117                         if (x > clip) {
 118                                 x = clip;
 119                         } else if (x < -clip) {
 120                                 x = -clip;
 121                         }
 122                         int32_t const s = x * (1 << 23);
 123                         *out++ = (s & 0xff);
 124                         *out++ = (s & 0xff00) >> 8;
 125                         *out++ = (s & 0xff0000) >> 16;
 126                 }
 127                 _frame_buffer_offset += 3 * ch;
 128
 129                 DCP_ASSERT (_frame_buffer_offset <= int (_state->frame_buffer.Capacity()));
 130
 131                 /* Finish the MXF frame if required */
 132                 if (_frame_buffer_offset == int (_state->frame_buffer.Capacity())) {
 133                         write_current_frame ();
 134                         _frame_buffer_offset = 0;
 135                         memset (_state->frame_buffer.Data(), 0, _state->frame_buffer.Capacity());
 136                 }
 137         }
 138 }
 139
 140 void
 141 SoundAssetWriter::write_current_frame ()
 142 {
 143         ASDCP::Result_t const r = _state->mxf_writer.WriteFrame (_state->frame_buffer, _encryption_context->encryption(), _encryption_context->hmac());
 144         if (ASDCP_FAILURE (r)) {
 145                 boost::throw_exception (MiscError (String::compose ("could not write audio MXF frame (%1)", int (r))));
 146         }
 147
 148         ++_frames_written;
 149 }
 150
 151 bool
 152 SoundAssetWriter::finalize ()
 153 {
 154         if (_frame_buffer_offset > 0) {
 155                 write_current_frame ();
 156         }
 157
 158         if (_started && ASDCP_FAILURE (_state->mxf_writer.Finalize())) {
 159                 boost::throw_exception (MiscError ("could not finalise audio MXF"));
 160         }
 161
 162         _asset->_intrinsic_duration = _frames_written;
 163         return AssetWriter::finalize ();
 164 }