2 Copyright (c) 2004-2012, John Hurst
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
8 1. Redistributions of source code must retain the above copyright
9 notice, this list of conditions and the following disclaimer.
10 2. Redistributions in binary form must reproduce the above copyright
11 notice, this list of conditions and the following disclaimer in the
12 documentation and/or other materials provided with the distribution.
13 3. The name of the author may not be used to endorse or promote products
14 derived from this software without specific prior written permission.
16 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 /*! \file AS_DCP_PCM.cpp
28 \version $Id: AS_DCP_PCM.cpp,v 1.36 2012/02/07 18:54:25 jhurst Exp $
29 \brief AS-DCP library, PCM essence reader and writer implementation
32 #include "AS_DCP_internal.h"
37 //------------------------------------------------------------------------------------------
39 static std::string PCM_PACKAGE_LABEL = "File Package: SMPTE 382M frame wrapping of wave audio";
40 static std::string SOUND_DEF_LABEL = "Sound Track";
44 PCM_ADesc_to_MD(PCM::AudioDescriptor& ADesc, MXF::WaveAudioDescriptor* ADescObj)
46 ASDCP_TEST_NULL(ADescObj);
47 ADescObj->SampleRate = ADesc.EditRate;
48 ADescObj->AudioSamplingRate = ADesc.AudioSamplingRate;
49 ADescObj->Locked = ADesc.Locked;
50 ADescObj->ChannelCount = ADesc.ChannelCount;
51 ADescObj->QuantizationBits = ADesc.QuantizationBits;
52 ADescObj->BlockAlign = ADesc.BlockAlign;
53 ADescObj->AvgBps = ADesc.AvgBps;
54 ADescObj->LinkedTrackID = ADesc.LinkedTrackID;
55 ADescObj->ContainerDuration = ADesc.ContainerDuration;
57 ADescObj->ChannelAssignment.Reset();
59 switch ( ADesc.ChannelFormat )
62 ADescObj->ChannelAssignment = DefaultSMPTEDict().Type(MDD_DCAudioChannelCfg_1_5p1).ul;
66 ADescObj->ChannelAssignment = DefaultSMPTEDict().Type(MDD_DCAudioChannelCfg_2_6p1).ul;
70 ADescObj->ChannelAssignment = DefaultSMPTEDict().Type(MDD_DCAudioChannelCfg_3_7p1).ul;
74 ADescObj->ChannelAssignment = DefaultSMPTEDict().Type(MDD_DCAudioChannelCfg_4_WTF).ul;
78 ADescObj->ChannelAssignment = DefaultSMPTEDict().Type(MDD_DCAudioChannelCfg_5_7p1_DS).ul;
91 MD_to_PCM_ADesc(MXF::WaveAudioDescriptor* ADescObj, PCM::AudioDescriptor& ADesc)
93 ASDCP_TEST_NULL(ADescObj);
94 ADesc.EditRate = ADescObj->SampleRate;
95 ADesc.AudioSamplingRate = ADescObj->AudioSamplingRate;
96 ADesc.Locked = ADescObj->Locked;
97 ADesc.ChannelCount = ADescObj->ChannelCount;
98 ADesc.QuantizationBits = ADescObj->QuantizationBits;
99 ADesc.BlockAlign = ADescObj->BlockAlign;
100 ADesc.AvgBps = ADescObj->AvgBps;
101 ADesc.LinkedTrackID = ADescObj->LinkedTrackID;
102 assert(ADescObj->ContainerDuration <= 0xFFFFFFFFL);
103 ADesc.ContainerDuration = (ui32_t) ADescObj->ContainerDuration;
105 ADesc.ChannelFormat = PCM::CF_NONE;
107 if ( ADescObj->ChannelAssignment.HasValue() )
109 if ( ADescObj->ChannelAssignment == DefaultSMPTEDict().Type(MDD_DCAudioChannelCfg_1_5p1).ul )
110 ADesc.ChannelFormat = PCM::CF_CFG_1;
112 else if ( ADescObj->ChannelAssignment == DefaultSMPTEDict().Type(MDD_DCAudioChannelCfg_2_6p1).ul )
113 ADesc.ChannelFormat = PCM::CF_CFG_2;
115 else if ( ADescObj->ChannelAssignment == DefaultSMPTEDict().Type(MDD_DCAudioChannelCfg_3_7p1).ul )
116 ADesc.ChannelFormat = PCM::CF_CFG_3;
118 else if ( ADescObj->ChannelAssignment == DefaultSMPTEDict().Type(MDD_DCAudioChannelCfg_4_WTF).ul )
119 ADesc.ChannelFormat = PCM::CF_CFG_4;
121 else if ( ADescObj->ChannelAssignment == DefaultSMPTEDict().Type(MDD_DCAudioChannelCfg_5_7p1_DS).ul )
122 ADesc.ChannelFormat = PCM::CF_CFG_5;
130 ASDCP::PCM::operator << (std::ostream& strm, const AudioDescriptor& ADesc)
132 strm << " SampleRate: " << ADesc.EditRate.Numerator << "/" << ADesc.EditRate.Denominator << std::endl;
133 strm << " AudioSamplingRate: " << ADesc.AudioSamplingRate.Numerator << "/" << ADesc.AudioSamplingRate.Denominator << std::endl;
134 strm << " Locked: " << (unsigned) ADesc.Locked << std::endl;
135 strm << " ChannelCount: " << (unsigned) ADesc.ChannelCount << std::endl;
136 strm << " QuantizationBits: " << (unsigned) ADesc.QuantizationBits << std::endl;
137 strm << " BlockAlign: " << (unsigned) ADesc.BlockAlign << std::endl;
138 strm << " AvgBps: " << (unsigned) ADesc.AvgBps << std::endl;
139 strm << " LinkedTrackID: " << (unsigned) ADesc.LinkedTrackID << std::endl;
140 strm << " ContainerDuration: " << (unsigned) ADesc.ContainerDuration << std::endl;
147 ASDCP::PCM::AudioDescriptorDump(const AudioDescriptor& ADesc, FILE* stream)
154 AudioSamplingRate: %d/%d\n\
157 QuantizationBits: %u\n\
161 ContainerDuration: %u\n",
162 ADesc.EditRate.Numerator, ADesc.EditRate.Denominator,
163 ADesc.AudioSamplingRate.Numerator, ADesc.AudioSamplingRate.Denominator,
166 ADesc.QuantizationBits,
170 ADesc.ContainerDuration
178 calc_CBR_frame_size(ASDCP::WriterInfo& Info, const ASDCP::PCM::AudioDescriptor& ADesc)
180 ui32_t CBR_frame_size = 0;
182 if ( Info.EncryptedEssence )
188 + calc_esv_length(ASDCP::PCM::CalcFrameBufferSize(ADesc), 0)
189 + ( Info.UsesHMAC ? klv_intpack_size : (MXF_BER_LENGTH * 3) );
193 CBR_frame_size = ASDCP::PCM::CalcFrameBufferSize(ADesc) + SMPTE_UL_LENGTH + MXF_BER_LENGTH;
196 return CBR_frame_size;
200 //------------------------------------------------------------------------------------------
203 class ASDCP::PCM::MXFReader::h__Reader : public ASDCP::h__Reader
205 ASDCP_NO_COPY_CONSTRUCT(h__Reader);
209 AudioDescriptor m_ADesc;
211 h__Reader(const Dictionary& d) : ASDCP::h__Reader(d) {}
213 Result_t OpenRead(const char*);
214 Result_t ReadFrame(ui32_t, FrameBuffer&, AESDecContext*, HMACContext*);
221 ASDCP::PCM::MXFReader::h__Reader::OpenRead(const char* filename)
223 Result_t result = OpenMXFRead(filename);
225 if( ASDCP_SUCCESS(result) )
227 InterchangeObject* Object;
228 if ( ASDCP_SUCCESS(m_HeaderPart.GetMDObjectByType(OBJ_TYPE_ARGS(WaveAudioDescriptor), &Object)) )
231 result = MD_to_PCM_ADesc((MXF::WaveAudioDescriptor*)Object, m_ADesc);
235 // check for sample/frame rate sanity
236 if ( ASDCP_SUCCESS(result)
237 && m_ADesc.EditRate != EditRate_24
238 && m_ADesc.EditRate != EditRate_25
239 && m_ADesc.EditRate != EditRate_30
240 && m_ADesc.EditRate != EditRate_48
241 && m_ADesc.EditRate != EditRate_50
242 && m_ADesc.EditRate != EditRate_60
243 && m_ADesc.EditRate != EditRate_96
244 && m_ADesc.EditRate != EditRate_100
245 && m_ADesc.EditRate != EditRate_120
246 && m_ADesc.EditRate != EditRate_23_98 )
248 DefaultLogSink().Error("PCM file EditRate is not a supported value: %d/%d\n", // lu
249 m_ADesc.EditRate.Numerator, m_ADesc.EditRate.Denominator);
251 // oh, they gave us the audio sampling rate instead, assume 24/1
252 if ( m_ADesc.EditRate == SampleRate_48k )
254 DefaultLogSink().Warn("adjusting EditRate to 24/1\n");
255 m_ADesc.EditRate = EditRate_24;
259 // or we just drop the hammer
260 return RESULT_FORMAT;
264 if( ASDCP_SUCCESS(result) )
265 result = InitMXFIndex();
267 if( ASDCP_SUCCESS(result) )
270 // TODO: test file for sane CBR index BytesPerEditUnit
279 ASDCP::PCM::MXFReader::h__Reader::ReadFrame(ui32_t FrameNum, FrameBuffer& FrameBuf,
280 AESDecContext* Ctx, HMACContext* HMAC)
282 if ( ! m_File.IsOpen() )
286 return ReadEKLVFrame(FrameNum, FrameBuf, m_Dict->ul(MDD_WAVEssence), Ctx, HMAC);
289 //------------------------------------------------------------------------------------------
294 ASDCP::PCM::FrameBuffer::Dump(FILE* stream, ui32_t dump_len) const
299 fprintf(stream, "Frame: %06u, %7u bytes\n",
300 m_FrameNumber, m_Size);
303 Kumu::hexdump(m_Data, dump_len, stream);
306 //------------------------------------------------------------------------------------------
308 ASDCP::PCM::MXFReader::MXFReader()
310 m_Reader = new h__Reader(DefaultCompositeDict());
314 ASDCP::PCM::MXFReader::~MXFReader()
316 if ( m_Reader && m_Reader->m_File.IsOpen() )
320 // Warning: direct manipulation of MXF structures can interfere
321 // with the normal operation of the wrapper. Caveat emptor!
323 ASDCP::MXF::OPAtomHeader&
324 ASDCP::PCM::MXFReader::OPAtomHeader()
326 if ( m_Reader.empty() )
328 assert(g_OPAtomHeader);
329 return *g_OPAtomHeader;
332 return m_Reader->m_HeaderPart;
335 // Warning: direct manipulation of MXF structures can interfere
336 // with the normal operation of the wrapper. Caveat emptor!
338 ASDCP::MXF::OPAtomIndexFooter&
339 ASDCP::PCM::MXFReader::OPAtomIndexFooter()
341 if ( m_Reader.empty() )
343 assert(g_OPAtomIndexFooter);
344 return *g_OPAtomIndexFooter;
347 return m_Reader->m_FooterPart;
350 // Open the file for reading. The file must exist. Returns error if the
351 // operation cannot be completed.
353 ASDCP::PCM::MXFReader::OpenRead(const char* filename) const
355 return m_Reader->OpenRead(filename);
358 // Reads a frame of essence from the MXF file. If the optional AESEncContext
359 // argument is present, the essence is decrypted after reading. If the MXF
360 // file is encrypted and the AESDecContext argument is NULL, the frame buffer
361 // will contain the ciphertext frame data.
363 ASDCP::PCM::MXFReader::ReadFrame(ui32_t FrameNum, FrameBuffer& FrameBuf,
364 AESDecContext* Ctx, HMACContext* HMAC) const
366 if ( m_Reader && m_Reader->m_File.IsOpen() )
367 return m_Reader->ReadFrame(FrameNum, FrameBuf, Ctx, HMAC);
373 // Fill the struct with the values from the file's header.
374 // Returns RESULT_INIT if the file is not open.
376 ASDCP::PCM::MXFReader::FillAudioDescriptor(AudioDescriptor& ADesc) const
378 if ( m_Reader && m_Reader->m_File.IsOpen() )
380 ADesc = m_Reader->m_ADesc;
387 // Fill the struct with the values from the file's header.
388 // Returns RESULT_INIT if the file is not open.
390 ASDCP::PCM::MXFReader::FillWriterInfo(WriterInfo& Info) const
392 if ( m_Reader && m_Reader->m_File.IsOpen() )
394 Info = m_Reader->m_Info;
403 ASDCP::PCM::MXFReader::DumpHeaderMetadata(FILE* stream) const
405 if ( m_Reader && m_Reader->m_File.IsOpen() )
406 m_Reader->m_HeaderPart.Dump(stream);
412 ASDCP::PCM::MXFReader::DumpIndex(FILE* stream) const
414 if ( m_Reader->m_File.IsOpen() )
415 m_Reader->m_FooterPart.Dump(stream);
420 ASDCP::PCM::MXFReader::Close() const
422 if ( m_Reader && m_Reader->m_File.IsOpen() )
432 //------------------------------------------------------------------------------------------
435 class ASDCP::PCM::MXFWriter::h__Writer : public ASDCP::h__Writer
437 ASDCP_NO_COPY_CONSTRUCT(h__Writer);
441 AudioDescriptor m_ADesc;
442 byte_t m_EssenceUL[SMPTE_UL_LENGTH];
444 h__Writer(const Dictionary& d) : ASDCP::h__Writer(d) {
445 memset(m_EssenceUL, 0, SMPTE_UL_LENGTH);
450 Result_t OpenWrite(const char*, ui32_t HeaderSize);
451 Result_t SetSourceStream(const AudioDescriptor&);
452 Result_t WriteFrame(const FrameBuffer&, AESEncContext* = 0, HMACContext* = 0);
458 // Open the file for writing. The file must not exist. Returns error if
459 // the operation cannot be completed.
461 ASDCP::PCM::MXFWriter::h__Writer::OpenWrite(const char* filename, ui32_t HeaderSize)
463 if ( ! m_State.Test_BEGIN() )
466 Result_t result = m_File.OpenWrite(filename);
468 if ( ASDCP_SUCCESS(result) )
470 m_HeaderSize = HeaderSize;
471 m_EssenceDescriptor = new WaveAudioDescriptor(m_Dict);
472 result = m_State.Goto_INIT();
479 // Automatically sets the MXF file's metadata from the WAV parser info.
481 ASDCP::PCM::MXFWriter::h__Writer::SetSourceStream(const AudioDescriptor& ADesc)
483 if ( ! m_State.Test_INIT() )
486 if ( ADesc.EditRate != EditRate_24
487 && ADesc.EditRate != EditRate_25
488 && ADesc.EditRate != EditRate_30
489 && ADesc.EditRate != EditRate_48
490 && ADesc.EditRate != EditRate_50
491 && ADesc.EditRate != EditRate_60
492 && ADesc.EditRate != EditRate_96
493 && ADesc.EditRate != EditRate_100
494 && ADesc.EditRate != EditRate_120
495 && ADesc.EditRate != EditRate_23_98 )
497 DefaultLogSink().Error("AudioDescriptor.EditRate is not a supported value: %d/%d\n",
498 ADesc.EditRate.Numerator, ADesc.EditRate.Denominator);
499 return RESULT_RAW_FORMAT;
502 if ( ADesc.AudioSamplingRate != SampleRate_48k && ADesc.AudioSamplingRate != SampleRate_96k )
504 DefaultLogSink().Error("AudioDescriptor.AudioSamplingRate is not 48000/1 or 96000/1: %d/%d\n",
505 ADesc.AudioSamplingRate.Numerator, ADesc.AudioSamplingRate.Denominator);
506 return RESULT_RAW_FORMAT;
512 Result_t result = PCM_ADesc_to_MD(m_ADesc, (WaveAudioDescriptor*)m_EssenceDescriptor);
514 if ( ASDCP_SUCCESS(result) )
516 memcpy(m_EssenceUL, m_Dict->ul(MDD_WAVEssence), SMPTE_UL_LENGTH);
517 m_EssenceUL[SMPTE_UL_LENGTH-1] = 1; // first (and only) essence container
518 result = m_State.Goto_READY();
521 if ( ASDCP_SUCCESS(result) )
523 ui32_t TCFrameRate = ( m_ADesc.EditRate == EditRate_23_98 ) ? 24 : m_ADesc.EditRate.Numerator;
525 result = WriteMXFHeader(PCM_PACKAGE_LABEL, UL(m_Dict->ul(MDD_WAVWrapping)),
526 SOUND_DEF_LABEL, UL(m_EssenceUL), UL(m_Dict->ul(MDD_SoundDataDef)),
527 m_ADesc.EditRate, TCFrameRate, calc_CBR_frame_size(m_Info, m_ADesc));
537 ASDCP::PCM::MXFWriter::h__Writer::WriteFrame(const FrameBuffer& FrameBuf, AESEncContext* Ctx,
540 Result_t result = RESULT_OK;
542 if ( m_State.Test_READY() )
543 result = m_State.Goto_RUNNING(); // first time through
545 if ( ASDCP_SUCCESS(result) )
546 result = WriteEKLVPacket(FrameBuf, m_EssenceUL, Ctx, HMAC);
548 if ( ASDCP_SUCCESS(result) )
554 // Closes the MXF file, writing the index and other closing information.
557 ASDCP::PCM::MXFWriter::h__Writer::Finalize()
559 if ( ! m_State.Test_RUNNING() )
562 m_State.Goto_FINAL();
564 return WriteMXFFooter();
568 //------------------------------------------------------------------------------------------
573 ASDCP::PCM::MXFWriter::MXFWriter()
577 ASDCP::PCM::MXFWriter::~MXFWriter()
581 // Warning: direct manipulation of MXF structures can interfere
582 // with the normal operation of the wrapper. Caveat emptor!
584 ASDCP::MXF::OPAtomHeader&
585 ASDCP::PCM::MXFWriter::OPAtomHeader()
587 if ( m_Writer.empty() )
589 assert(g_OPAtomHeader);
590 return *g_OPAtomHeader;
593 return m_Writer->m_HeaderPart;
596 // Warning: direct manipulation of MXF structures can interfere
597 // with the normal operation of the wrapper. Caveat emptor!
599 ASDCP::MXF::OPAtomIndexFooter&
600 ASDCP::PCM::MXFWriter::OPAtomIndexFooter()
602 if ( m_Writer.empty() )
604 assert(g_OPAtomIndexFooter);
605 return *g_OPAtomIndexFooter;
608 return m_Writer->m_FooterPart;
611 // Open the file for writing. The file must not exist. Returns error if
612 // the operation cannot be completed.
614 ASDCP::PCM::MXFWriter::OpenWrite(const char* filename, const WriterInfo& Info,
615 const AudioDescriptor& ADesc, ui32_t HeaderSize)
617 if ( Info.LabelSetType == LS_MXF_SMPTE )
618 m_Writer = new h__Writer(DefaultSMPTEDict());
620 m_Writer = new h__Writer(DefaultInteropDict());
622 m_Writer->m_Info = Info;
624 Result_t result = m_Writer->OpenWrite(filename, HeaderSize);
626 if ( ASDCP_SUCCESS(result) )
627 result = m_Writer->SetSourceStream(ADesc);
629 if ( ASDCP_FAILURE(result) )
635 // Writes a frame of essence to the MXF file. If the optional AESEncContext
636 // argument is present, the essence is encrypted prior to writing.
637 // Fails if the file is not open, is finalized, or an operating system
640 ASDCP::PCM::MXFWriter::WriteFrame(const FrameBuffer& FrameBuf, AESEncContext* Ctx, HMACContext* HMAC)
642 if ( m_Writer.empty() )
645 return m_Writer->WriteFrame(FrameBuf, Ctx, HMAC);
648 // Closes the MXF file, writing the index and other closing information.
650 ASDCP::PCM::MXFWriter::Finalize()
652 if ( m_Writer.empty() )
655 return m_Writer->Finalize();
659 // end AS_DCP_PCM.cpp