Tidying.
[libdcp.git] / src / sound_asset.cc
index 590472a5ebea2a8d4c66123ebfd7f24a275cfde4..1c0a181f81255c72dea107d73b6100c556123e78 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
     You should have received a copy of the GNU General Public License
     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_mxf.cc
- *  @brief SoundAsset class.
+
+/** @file  src/sound_asset.cc
+ *  @brief SoundAsset class
  */
 
+
 #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 "KM_fileio.h"
-#include "AS_DCP.h"
 #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 <iostream>
 #include <stdexcept>
 
+
 using std::string;
-using std::stringstream;
-using std::ostream;
 using std::vector;
 using std::list;
-using boost::shared_ptr;
-using boost::dynamic_pointer_cast;
+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;
-       Kumu::Result_t 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));
+       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))) {
-               boost::throw_exception (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;
@@ -66,81 +87,131 @@ SoundAsset::SoundAsset (boost::filesystem::path file)
        _intrinsic_duration = desc.ContainerDuration;
 
        ASDCP::WriterInfo info;
-       if (ASDCP_FAILURE (reader.FillWriterInfo (info))) {
-               boost::throw_exception (DCPReadError ("could not read audio MXF information"));
+       if (ASDCP_FAILURE (reader.FillWriterInfo(info))) {
+               boost::throw_exception (ReadError("could not read audio MXF information"));
+       }
+
+       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;
+               }
        }
 
        _id = read_writer_info (info);
 }
 
-SoundAsset::SoundAsset (Fraction edit_rate, int sampling_rate, int channels)
-       : _edit_rate (edit_rate)
-       , _intrinsic_duration (0)
+
+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())
 {
 
 }
 
+
 bool
 SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, NoteHandler note) const
 {
        ASDCP::PCM::MXFReader reader_A;
-       Kumu::Result_t 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));
+       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;
-       r = reader_B.OpenRead (other->file().string().c_str());
+       r = reader_B.OpenRead (other->file()->string().c_str());
        if (ASDCP_FAILURE (r)) {
-               boost::throw_exception (MXFFileError ("could not open MXF file for reading", file().string(), 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))) {
-               boost::throw_exception (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))) {
-               boost::throw_exception (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 ||
-               ) {
-
-               note (DCP_ERROR, "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 */
        }
 
-       shared_ptr<const SoundAsset> other_sound = dynamic_pointer_cast<const SoundAsset> (other);
+       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) {
 
-               shared_ptr<const SoundFrame> frame_A = get_frame (i);
-               shared_ptr<const SoundFrame> frame_B = other_sound->get_frame (i);
+               auto frame_A = reader->get_frame (i);
+               auto frame_B = other_reader->get_frame (i);
 
                if (frame_A->size() != frame_B->size()) {
-                       note (DCP_ERROR, String::compose ("sizes of audio data for frame %1 differ", i));
+                       note (NoteType::ERROR, String::compose ("sizes of audio data for frame %1 differ", i));
                        return false;
                }
 
                if (memcmp (frame_A->data(), frame_B->data(), frame_A->size()) != 0) {
-                       for (int i = 0; i < frame_A->size(); ++i) {
-                               int const d = abs (frame_A->data()[i] - frame_B->data()[i]);
-                               if (d > opt.max_audio_sample_error) {
-                                       note (DCP_ERROR, String::compose ("PCM data difference of %1", d));
-                                       return false;
+                       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;
+                                       }
                                }
                        }
                }
@@ -149,37 +220,43 @@ SoundAsset::equals (shared_ptr<const Asset> other, EqualityOptions opt, NoteHand
        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)
 {
-       /* XXX: should add on entry point here? */
-       return shared_ptr<const SoundFrame> (new SoundFrame (file(), n, _decryption_context));
+       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<SoundAssetWriter>
-SoundAsset::start_write (boost::filesystem::path file, Standard standard)
+
+shared_ptr<SoundAssetReader>
+SoundAsset::start_read () const
 {
-       /* XXX: can't we use a shared_ptr here? */
-       return shared_ptr<SoundAssetWriter> (new SoundAssetWriter (this, file, standard));
+       return shared_ptr<SoundAssetReader> (new SoundAssetReader(this, key(), standard()));
 }
 
+
 string
-SoundAsset::pkl_type (Standard standard) const
+SoundAsset::static_pkl_type (Standard standard)
 {
        switch (standard) {
-       case INTEROP:
+       case Standard::INTEROP:
                return "application/x-smpte-mxf;asdcpKind=Sound";
-       case SMPTE:
+       case Standard::SMPTE:
                return "application/mxf";
        default:
                DCP_ASSERT (false);
        }
 }
 
+
 bool
 SoundAsset::valid_mxf (boost::filesystem::path file)
 {
        ASDCP::PCM::MXFReader reader;
-       Kumu::Result_t r = reader.OpenRead (file.string().c_str ());
+       Kumu::Result_t r = reader.OpenRead (file.string().c_str());
        return !ASDCP_FAILURE (r);
 }