src/sound_asset.cc

   1 /*
   2     Copyright (C) 2012-2016 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/KM_fileio.h>
  47 #include <asdcp/AS_DCP.h>
  48 #include <libxml++/nodes/element.h>
  49 #include <boost/filesystem.hpp>
  50 #include <stdexcept>
  51
  52 using std::string;
  53 using std::vector;
  54 using std::list;
  55 using boost::shared_ptr;
  56 using boost::dynamic_pointer_cast;
  57 using namespace dcp;
  58
  59 SoundAsset::SoundAsset (boost::filesystem::path file)
  60         : Asset (file)
  61 {
  62         ASDCP::PCM::MXFReader reader;
  63         Kumu::Result_t r = reader.OpenRead (file.string().c_str());
  64         if (ASDCP_FAILURE (r)) {
  65                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", file.string(), r));
  66         }
  67
  68         ASDCP::PCM::AudioDescriptor desc;
  69         if (ASDCP_FAILURE (reader.FillAudioDescriptor (desc))) {
  70                 boost::throw_exception (DCPReadError ("could not read audio MXF information"));
  71         }
  72
  73         _sampling_rate = desc.AudioSamplingRate.Numerator / desc.AudioSamplingRate.Denominator;
  74         _channels = desc.ChannelCount;
  75         _edit_rate = Fraction (desc.EditRate.Numerator, desc.EditRate.Denominator);
  76
  77         _intrinsic_duration = desc.ContainerDuration;
  78
  79         ASDCP::WriterInfo info;
  80         if (ASDCP_FAILURE (reader.FillWriterInfo (info))) {
  81                 boost::throw_exception (DCPReadError ("could not read audio MXF information"));
  82         }
  83
  84         _id = read_writer_info (info);
  85 }
  86
  87 SoundAsset::SoundAsset (Fraction edit_rate, int sampling_rate, int channels)
  88         : _edit_rate (edit_rate)
  89         , _intrinsic_duration (0)
  90         , _channels (channels)
  91         , _sampling_rate (sampling_rate)
  92 {
  93
  94 }
  95
  96 bool
  97 SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, NoteHandler note) const
  98 {
  99         ASDCP::PCM::MXFReader reader_A;
 100         Kumu::Result_t r = reader_A.OpenRead (file().string().c_str());
 101         if (ASDCP_FAILURE (r)) {
 102                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", file().string(), r));
 103         }
 104
 105         ASDCP::PCM::MXFReader reader_B;
 106         r = reader_B.OpenRead (other->file().string().c_str());
 107         if (ASDCP_FAILURE (r)) {
 108                 boost::throw_exception (MXFFileError ("could not open MXF file for reading", file().string(), r));
 109         }
 110
 111         ASDCP::PCM::AudioDescriptor desc_A;
 112         if (ASDCP_FAILURE (reader_A.FillAudioDescriptor (desc_A))) {
 113                 boost::throw_exception (DCPReadError ("could not read audio MXF information"));
 114         }
 115         ASDCP::PCM::AudioDescriptor desc_B;
 116         if (ASDCP_FAILURE (reader_B.FillAudioDescriptor (desc_B))) {
 117                 boost::throw_exception (DCPReadError ("could not read audio MXF information"));
 118         }
 119
 120         if (desc_A.EditRate != desc_B.EditRate) {
 121                 note (
 122                         DCP_ERROR,
 123                         String::compose (
 124                                 "audio edit rates differ: %1/%2 cf %3/%4",
 125                                 desc_A.EditRate.Numerator, desc_A.EditRate.Denominator, desc_B.EditRate.Numerator, desc_B.EditRate.Denominator
 126                                 )
 127                         );
 128                 return false;
 129         } else if (desc_A.AudioSamplingRate != desc_B.AudioSamplingRate) {
 130                 note (
 131                         DCP_ERROR,
 132                         String::compose (
 133                                 "audio sampling rates differ: %1 cf %2",
 134                                 desc_A.AudioSamplingRate.Numerator, desc_A.AudioSamplingRate.Denominator,
 135                                 desc_B.AudioSamplingRate.Numerator, desc_B.AudioSamplingRate.Numerator
 136                                 )
 137                         );
 138                 return false;
 139         } else if (desc_A.Locked != desc_B.Locked) {
 140                 note (DCP_ERROR, String::compose ("audio locked flags differ: %1 cf %2", desc_A.Locked, desc_B.Locked));
 141                 return false;
 142         } else if (desc_A.ChannelCount != desc_B.ChannelCount) {
 143                 note (DCP_ERROR, String::compose ("audio channel counts differ: %1 cf %2", desc_A.ChannelCount, desc_B.ChannelCount));
 144                 return false;
 145         } else if (desc_A.QuantizationBits != desc_B.QuantizationBits) {
 146                 note (DCP_ERROR, String::compose ("audio bits per sample differ: %1 cf %2", desc_A.QuantizationBits, desc_B.QuantizationBits));
 147                 return false;
 148         } else if (desc_A.BlockAlign != desc_B.BlockAlign) {
 149                 note (DCP_ERROR, String::compose ("audio bytes per sample differ: %1 cf %2", desc_A.BlockAlign, desc_B.BlockAlign));
 150                 return false;
 151         } else if (desc_A.AvgBps != desc_B.AvgBps) {
 152                 note (DCP_ERROR, String::compose ("audio average bps differ: %1 cf %2", desc_A.AvgBps, desc_B.AvgBps));
 153                 return false;
 154         } else if (desc_A.LinkedTrackID != desc_B.LinkedTrackID) {
 155                 note (DCP_ERROR, String::compose ("audio linked track IDs differ: %1 cf %2", desc_A.LinkedTrackID, desc_B.LinkedTrackID));
 156                 return false;
 157         } else if (desc_A.ContainerDuration != desc_B.ContainerDuration) {
 158                 note (DCP_ERROR, String::compose ("audio container durations differ: %1 cf %2", desc_A.ContainerDuration, desc_B.ContainerDuration));
 159                 return false;
 160         } else if (desc_A.ChannelFormat != desc_B.ChannelFormat) {
 161                 /* XXX */
 162         }
 163
 164         shared_ptr<const SoundAsset> other_sound = dynamic_pointer_cast<const SoundAsset> (other);
 165
 166         shared_ptr<const SoundAssetReader> reader = start_read ();
 167         shared_ptr<const SoundAssetReader> other_reader = other_sound->start_read ();
 168
 169         for (int i = 0; i < _intrinsic_duration; ++i) {
 170
 171                 shared_ptr<const SoundFrame> frame_A = reader->get_frame (i);
 172                 shared_ptr<const SoundFrame> frame_B = other_reader->get_frame (i);
 173
 174                 if (frame_A->size() != frame_B->size()) {
 175                         note (DCP_ERROR, String::compose ("sizes of audio data for frame %1 differ", i));
 176                         return false;
 177                 }
 178
 179                 if (memcmp (frame_A->data(), frame_B->data(), frame_A->size()) != 0) {
 180                         for (int i = 0; i < frame_A->size(); ++i) {
 181                                 int const d = abs (frame_A->data()[i] - frame_B->data()[i]);
 182                                 if (d > opt.max_audio_sample_error) {
 183                                         note (DCP_ERROR, String::compose ("PCM data difference of %1", d));
 184                                         return false;
 185                                 }
 186                         }
 187                 }
 188         }
 189
 190         return true;
 191 }
 192
 193 shared_ptr<SoundAssetWriter>
 194 SoundAsset::start_write (boost::filesystem::path file, Standard standard)
 195 {
 196         /* XXX: can't we use a shared_ptr here? */
 197         return shared_ptr<SoundAssetWriter> (new SoundAssetWriter (this, file, standard));
 198 }
 199
 200 shared_ptr<SoundAssetReader>
 201 SoundAsset::start_read () const
 202 {
 203         return shared_ptr<SoundAssetReader> (new SoundAssetReader (this));
 204 }
 205
 206 string
 207 SoundAsset::pkl_type (Standard standard) const
 208 {
 209         switch (standard) {
 210         case INTEROP:
 211                 return "application/x-smpte-mxf;asdcpKind=Sound";
 212         case SMPTE:
 213                 return "application/mxf";
 214         default:
 215                 DCP_ASSERT (false);
 216         }
 217 }
 218
 219 bool
 220 SoundAsset::valid_mxf (boost::filesystem::path file)
 221 {
 222         ASDCP::PCM::MXFReader reader;
 223         Kumu::Result_t r = reader.OpenRead (file.string().c_str ());
 224         return !ASDCP_FAILURE (r);
 225 }