src/sound_asset.cc

   1 /*
   2     Copyright (C) 2012-2020 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 /** @file  src/sound_mxf.cc
  35  *  @brief SoundAsset class.
  36  */
  37
  38 #include "sound_asset.h"
  39 #include "util.h"
  40 #include "exceptions.h"
  41 #include "sound_frame.h"
  42 #include "sound_asset_writer.h"
  43 #include "sound_asset_reader.h"
  44 #include "compose.hpp"
  45 #include "dcp_assert.h"
  46 #include <asdcp/AS_DCP.h>
  47 #include <asdcp/KM_fileio.h>
  48 #include <asdcp/Metadata.h>
  49 #include <libxml++/nodes/element.h>
  50 #include <boost/filesystem.hpp>
  51 #include <stdexcept>
  52
  53 using std::string;
  54 using std::vector;
  55 using std::list;
  56 using boost::shared_ptr;
  57 using boost::dynamic_pointer_cast;
  58 using namespace dcp;
  59
  60 SoundAsset::SoundAsset (boost::filesystem::path file)
  61         : Asset (file)
  62         /* XXX: this is a fallback language, which will be used if we can't find the RFC5646SpokenLanguage
  63          * in the MXF header.  Perhaps RFC5646SpokenLanguage is optional and we should just not write it
  64          * if we don't know it.
  65          */
  66         , _language ("en-US")
  67 {
  68         ASDCP::PCM::MXFReader reader;
  69         Kumu::Result_t r = reader.OpenRead (file.string().c_str());
  70         if (ASDCP_FAILURE (r)) {
  71                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", file.string(), r));
  72         }
  73
  74         ASDCP::PCM::AudioDescriptor desc;
  75         if (ASDCP_FAILURE (reader.FillAudioDescriptor (desc))) {
  76                 boost::throw_exception (ReadError ("could not read audio MXF information"));
  77         }
  78
  79         _sampling_rate = desc.AudioSamplingRate.Numerator / desc.AudioSamplingRate.Denominator;
  80         _channels = desc.ChannelCount;
  81         _edit_rate = Fraction (desc.EditRate.Numerator, desc.EditRate.Denominator);
  82
  83         _intrinsic_duration = desc.ContainerDuration;
  84
  85         ASDCP::WriterInfo info;
  86         if (ASDCP_FAILURE (reader.FillWriterInfo (info))) {
  87                 boost::throw_exception (ReadError ("could not read audio MXF information"));
  88         }
  89
  90         ASDCP::MXF::SoundfieldGroupLabelSubDescriptor* soundfield;
  91         ASDCP::Result_t rr = reader.OP1aHeader().GetMDObjectByType(
  92                 ASDCP::DefaultSMPTEDict().ul(ASDCP::MDD_SoundfieldGroupLabelSubDescriptor),
  93                 reinterpret_cast<ASDCP::MXF::InterchangeObject**>(&soundfield)
  94                 );
  95
  96         if (KM_SUCCESS(rr)) {
  97                 if (!soundfield->RFC5646SpokenLanguage.empty()) {
  98                         char buffer[64];
  99                         soundfield->RFC5646SpokenLanguage.get().EncodeString(buffer, sizeof(buffer));
 100                         _language = dcp::LanguageTag (buffer);
 101                 }
 102         }
 103
 104         _id = read_writer_info (info);
 105 }
 106
 107 SoundAsset::SoundAsset (Fraction edit_rate, int sampling_rate, int channels, LanguageTag language, Standard standard)
 108         : MXF (standard)
 109         , _edit_rate (edit_rate)
 110         , _intrinsic_duration (0)
 111         , _channels (channels)
 112         , _sampling_rate (sampling_rate)
 113         , _language (language)
 114 {
 115
 116 }
 117
 118 bool
 119 SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, NoteHandler note) const
 120 {
 121         ASDCP::PCM::MXFReader reader_A;
 122         DCP_ASSERT (file ());
 123         Kumu::Result_t r = reader_A.OpenRead (file()->string().c_str());
 124         if (ASDCP_FAILURE (r)) {
 125                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", file()->string(), r));
 126         }
 127
 128         ASDCP::PCM::MXFReader reader_B;
 129         r = reader_B.OpenRead (other->file()->string().c_str());
 130         if (ASDCP_FAILURE (r)) {
 131                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", other->file()->string(), r));
 132         }
 133
 134         ASDCP::PCM::AudioDescriptor desc_A;
 135         if (ASDCP_FAILURE (reader_A.FillAudioDescriptor (desc_A))) {
 136                 boost::throw_exception (ReadError ("could not read audio MXF information"));
 137         }
 138         ASDCP::PCM::AudioDescriptor desc_B;
 139         if (ASDCP_FAILURE (reader_B.FillAudioDescriptor (desc_B))) {
 140                 boost::throw_exception (ReadError ("could not read audio MXF information"));
 141         }
 142
 143         if (desc_A.EditRate != desc_B.EditRate) {
 144                 note (
 145                         DCP_ERROR,
 146                         String::compose (
 147                                 "audio edit rates differ: %1/%2 cf %3/%4",
 148                                 desc_A.EditRate.Numerator, desc_A.EditRate.Denominator, desc_B.EditRate.Numerator, desc_B.EditRate.Denominator
 149                                 )
 150                         );
 151                 return false;
 152         } else if (desc_A.AudioSamplingRate != desc_B.AudioSamplingRate) {
 153                 note (
 154                         DCP_ERROR,
 155                         String::compose (
 156                                 "audio sampling rates differ: %1 cf %2",
 157                                 desc_A.AudioSamplingRate.Numerator, desc_A.AudioSamplingRate.Denominator,
 158                                 desc_B.AudioSamplingRate.Numerator, desc_B.AudioSamplingRate.Numerator
 159                                 )
 160                         );
 161                 return false;
 162         } else if (desc_A.Locked != desc_B.Locked) {
 163                 note (DCP_ERROR, String::compose ("audio locked flags differ: %1 cf %2", desc_A.Locked, desc_B.Locked));
 164                 return false;
 165         } else if (desc_A.ChannelCount != desc_B.ChannelCount) {
 166                 note (DCP_ERROR, String::compose ("audio channel counts differ: %1 cf %2", desc_A.ChannelCount, desc_B.ChannelCount));
 167                 return false;
 168         } else if (desc_A.QuantizationBits != desc_B.QuantizationBits) {
 169                 note (DCP_ERROR, String::compose ("audio bits per sample differ: %1 cf %2", desc_A.QuantizationBits, desc_B.QuantizationBits));
 170                 return false;
 171         } else if (desc_A.BlockAlign != desc_B.BlockAlign) {
 172                 note (DCP_ERROR, String::compose ("audio bytes per sample differ: %1 cf %2", desc_A.BlockAlign, desc_B.BlockAlign));
 173                 return false;
 174         } else if (desc_A.AvgBps != desc_B.AvgBps) {
 175                 note (DCP_ERROR, String::compose ("audio average bps differ: %1 cf %2", desc_A.AvgBps, desc_B.AvgBps));
 176                 return false;
 177         } else if (desc_A.LinkedTrackID != desc_B.LinkedTrackID) {
 178                 note (DCP_ERROR, String::compose ("audio linked track IDs differ: %1 cf %2", desc_A.LinkedTrackID, desc_B.LinkedTrackID));
 179                 return false;
 180         } else if (desc_A.ContainerDuration != desc_B.ContainerDuration) {
 181                 note (DCP_ERROR, String::compose ("audio container durations differ: %1 cf %2", desc_A.ContainerDuration, desc_B.ContainerDuration));
 182                 return false;
 183         } else if (desc_A.ChannelFormat != desc_B.ChannelFormat) {
 184                 /* XXX */
 185         }
 186
 187         shared_ptr<const SoundAsset> other_sound = dynamic_pointer_cast<const SoundAsset> (other);
 188
 189         shared_ptr<const SoundAssetReader> reader = start_read ();
 190         shared_ptr<const SoundAssetReader> other_reader = other_sound->start_read ();
 191
 192         for (int i = 0; i < _intrinsic_duration; ++i) {
 193
 194                 shared_ptr<const SoundFrame> frame_A = reader->get_frame (i);
 195                 shared_ptr<const SoundFrame> frame_B = other_reader->get_frame (i);
 196
 197                 if (frame_A->size() != frame_B->size()) {
 198                         note (DCP_ERROR, String::compose ("sizes of audio data for frame %1 differ", i));
 199                         return false;
 200                 }
 201
 202                 if (memcmp (frame_A->data(), frame_B->data(), frame_A->size()) != 0) {
 203                         for (int i = 0; i < frame_A->size(); ++i) {
 204                                 int const d = abs (frame_A->data()[i] - frame_B->data()[i]);
 205                                 if (d > opt.max_audio_sample_error) {
 206                                         note (DCP_ERROR, String::compose ("PCM data difference of %1", d));
 207                                         return false;
 208                                 }
 209                         }
 210                 }
 211         }
 212
 213         return true;
 214 }
 215
 216 shared_ptr<SoundAssetWriter>
 217 SoundAsset::start_write (boost::filesystem::path file, vector<Channel> active_channels, bool atmos_sync)
 218 {
 219         if (atmos_sync && _channels < 14) {
 220                 throw MiscError ("Insufficient channels to write ATMOS sync (there must be at least 14)");
 221         }
 222
 223         return shared_ptr<SoundAssetWriter> (new SoundAssetWriter(this, file, active_channels, atmos_sync));
 224 }
 225
 226 shared_ptr<SoundAssetReader>
 227 SoundAsset::start_read () const
 228 {
 229         return shared_ptr<SoundAssetReader> (new SoundAssetReader (this, key(), standard()));
 230 }
 231
 232 string
 233 SoundAsset::static_pkl_type (Standard standard)
 234 {
 235         switch (standard) {
 236         case INTEROP:
 237                 return "application/x-smpte-mxf;asdcpKind=Sound";
 238         case SMPTE:
 239                 return "application/mxf";
 240         default:
 241                 DCP_ASSERT (false);
 242         }
 243 }
 244
 245 bool
 246 SoundAsset::valid_mxf (boost::filesystem::path file)
 247 {
 248         ASDCP::PCM::MXFReader reader;
 249         Kumu::Result_t r = reader.OpenRead (file.string().c_str ());
 250         return !ASDCP_FAILURE (r);
 251 }