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