$Id: README,v 1.116 2018/09/14 07:33:17 jhurst Exp $
The asdcplib library is a set of objects that offer simplified access to files conforming to the sound and picture track file formats developed by the SMPTE Working Group DC28.20 (now TC 21DC).
Recently, support has also been added for SMPTE draft ST 2067-5 "IMF Essence Component", AKA "AS-02". This code was donated by Fraunhofer IIS. It carries additional copyright information which should be listed whenever you link the AS-02 elements of the library. Please look at the top of the AS-02 files to see this copyright information.
AS-02 support is carried in separate object modules, so unless you #include <AS_02.h> and link libas-02.so you are still using plain old asdcp.
This work was originally funded by Digital Cinema Initiatives, LLC (DCI). Subsequent efforts have been funded by Deluxe Laboratories, Doremi Labs, CineCert LLC, Avica Technology and others.
**The asdcplib project was originally housed on SourceForge. The project has moved to http://www.cinecert.com/asdcplib/
The project formerly depended upon the mxflib project. Because of its focus on covering the whole of the MXF specifications, mxflib is considerably larger and more complex that what I require for this application. For this reason I have created a dedicated MXF implementation that is now part of this library. Special thanks to Matt Beard and Oliver Morgan for their great work and support.
Thanks also to the members of the SMPTE DC28.20 packaging ad-hoc group and the members of the MXF Interop Initiative for their encouragement and support. Special thanks to Jim Whittlesey and Howard Lukk at DCI for proposing and supporting this project.
Design Notes
This library is intended (but of course not limited) for use by developers of commercial D-Cinema products (and now IMF!). It is designed to be easily integrated into a wide variety of development environments. Commercial users are strongly urged to use static linking (at least where you use this library) to prevent malicious in-field replacement of critical system modules. This recommendation should be considered wherever Open Source or Free software is being used in conjunction with critical security parameters, such as cryptographic keys.
The author strives mightily to provide an API that is completely independent of operating system and other library dependencies, and which allows selective replacement of some modules for local needs. Specifically, the essence parsers and OpenSSL crypto functions can be replaced by linking to alternative implementations of the ASDCP:: objects which provide those services.
AS_DCP.h contains the entire AS-DCP API. You do not need to read any of the other files, except maybe asdcp-test.cpp which contains detailed usage examples of each of the API's services. The KM_* files may be of interest for general development support, but may be ignored if all you want is simple AS-DCP support.
Likewise, draft 2067-5 "IMF Essence Component" (AS-02) support is entirely contained in AS-02.h
Build Instructions
On more-or-less POSIX systems (OS X, Linux, and BSD), GNU make and autotools are required to build asdcplib. The same configure script will also build this package on Windows machines with Cygwin and MinGW installed. For those Windows users who would prefer to build this natively, an "nmake" build file and instructions can be found in the win32 subdirectory.
OpenSSL is also required, any recent version should be fine. See http://www.openssl.org/ for more information and download instructions.
Optional support for writing Timed Text Track Files is supported by either Xerces-C or Expat. See http://xerces.apache.org/xerces-c/ or http://expat.sourceforge.net/ for source and build instructions.
To configure and build, type './configure' followed by 'make'. There are several test targets on the POSIX side, but you need to assemble a set of test files to use them. AS-02 support can be enabled with --enable-as-02.
I have tested this build on win32, Linux, OpenBSD, and Darwin platforms. Others may work as well.
Utilities
asdcp-test - Writes, reads and verifies AS-DCP (MXF) track files.
asdcp-wrap - Writes AS-DCP (MXF) track files.
asdcp-unwrap - Extracts essence from AS-DCP (MXF) track files.
asdcp-info - Displays information about AS-DCP (MXF) track files.
asdcp-util - Calculates digests and generates random numbers and UUIDs.
as-02-wrap - Writes AS-02 Essence Component files.
as-02-unwrap - Extracts essence from AS-02 Essence Component files.
kmfilegen - Writes and verifies large files using a platform- independent format. Use it to test issues related to large files.
kmuuidgen, kmrandgen - generate UUID values and random numbers.
wavesplit - Splits a WAVE file into two or more output files. Used to untangle incorrectly-paired DCDM sound files.
blackwave - Write a WAVE file of zeros.
pinkwave - Write a WAVE file of SMPTE ST 2095 pink noise.
j2c-test - Displays information about JP2K codestreams.
Experimental feature: Prototype for High Dynamic Range is a wrapper for the IMF application that allows JPEG-2000 codestreams to be paired with opaque blobs of metadata. AS-02 support must be enabled to build this feature, so --enable-as-02 must be enabled if --enable-phdr is to be used. The following executable programs will be built:
phdr-wrap - Writes AS-02 PHDR Essence Component files.
phdr-unwrap - Extracts essence from AS-02 PHDR Essence Component files.
Documentation
The API documentation is mostly in AS_DCP.h. and AS_02.h Read those files for a detailed description of the library's capabilities. Read asdcp-.cpp and as-02-.cpp files for library usage examples. The command-line utilities all respond to -h.
Change History
2018-09-14 - 2.9.30 o Fixes wrong MajorVersion in Preface o Adds VideoLineMap also to RGBA essence descriptor o Adds VideoLineMap to RGBA and CDCI descriptor only when option -l is present (disputable - but distinguished value {0, 0} is not allowed in closed and complete partitions) o Fixes issue with IndexRate not set in AS-02 J2K files o Additional fixes to minor version number in AS-02 partition packs o CMake brought up to date o Fixed erroneous WAV RF64 header interpretation o ACES AS-02 ST 2065-5 wrapper o ACES AS-02 ST 2065-5 unwrapper o ST 2067-50 Subdescriptors support o ST 2067-50 Target Frame wrapping support o ST 2067-50 Target Frame unwrapping support o Command line tools as-02-wrap, as-02-unwrap and as-02-info extended to support ACES, App#5 subdescriptors and Target Frames o Beta support for ST2065-5 AS_02 ACES wrapping and unwrapping including ST 2067-50 Subdescriptors and Target Frame support o Please report ACES-related issues to [email protected]
2018-08-08 - 2.8.29 o Modified AS_02::ST2052_TextParser::OpenRead signature o Fixed partition version error in AS-02 interior body partitions o Changed StartTimecode to 0 (zero) in the Source Package o Remove use of BN_init in OpenSSL API o XML parser now works correctly with Xerces-c 3.x o Improved MCA sound field expression parser o Added support for IMF Numbered Source Channel labels in MCA o Added CLI switches for MCAAudioContentKind and MCAAudioElementKind o Re-assigned asdcp-wrap option '-g' to '-x', added new option '-g' o Added TLM marker check to j2c-test o Added to kmrandgen options '-C', '-w', '-W' o Added support for SMPTE RDD 47 "ISXD Track File" o Added generic support for SMPTE RP 2057 "Text-Based Metadata Carriage in MXF" o Re-factored AS-02 frame-wrap index write to use a common implementation o Re-factored support for SMPTE ST 410 to use a common implementation (affects AS-DCP and AS-02 timed-text MXF (SMPTE 429-5) o Patched several ambiguous integer casts. o Added new essence type identifiers ESS_AS02_ISXD and ESS_AS02_ACES o Fixed a bug wherein the Generic Container data track clip was instead being written as a DM track o Fixed UL values DCDataDescriptor and ContainerConstraintSubDescriptor to have a byte 6 value of 0x53 (Tag Set) instead of 0x07 (coding sentinel) o Added UL values 468 - 511 to the dictionary (including added ACES UL values) o Added ApplicationSchemes and ConformsToSpecifications to the Preface set o Added default initializer to MXF::LineMapPair o Added sets DescriptiveFramework, DescriptiveObject, TextBasedDMFramework, TextBasedObject, GenericStreamTextBasedSet and ISXDDataEssenceDescriptor, ACESPictureSubDescriptor, TargetFrameSubDescriptor o Added ISXD support, options '-c', '-g', '-G', '-v', '-q', '-u' to as-02-wrap o Added ISXD support and option '-g' to as-02-unwrap o Cleaned up definition of UL WaveAudioDescriptor_PeakEnvelopeData (currently unused) o Moved ReferenceAudioAlignmentLevel from WaveAudioDescriptor to GenericSoundEssenceDescriptor
2016-12-10 - MDD bug fix 2.7.19 o The previous version (2.7.18) contained incorrect MDD.cpp and MDD.h files which affect the PIMF and JP2KEssenceCompression labels.
2016-12-10 - bug fixes 2.7.18 o Fixed all Partiton version numbers in AS-02 files (the previous attempt only affected the header partition) o Improved IMSC-1 profile detection. May not yet be perfect, experimentation encouraged! o Added IMF App2e UL values and new MXF data types ColorPrimary and ThreeColorPrimaries (contributed by Schleich) o Added picture descriptor elements MasteringDisplayPrimaries, MasteringDisplayWhitePointChromaticity, MasteringDisplayMaximumLuminance, and MasteringDisplayMinimumLuminance o Added -o and -O options to as-02-wrap o Fixed as-02-wrap option -p when making 4:4:4 files o Simplified as-02-wrap syntax description
2016-12-01 - bug fixes 2.6.17 o Fixed Partiton and Preface version numbers in AS-02 files o Replaced WIN32 directory scanner with dirent_win.h o The NamespaceURI property of AS-02 timed text files has been exposed in the API and via as-02-wrap -P. This behavior replaces previous bad behavior, but puts responsibility for selecting the correct value on the operator. o Exposed CreatePNGNameId and CreateFontNameId subroutines in AS_02::TimedText o Adjusted UUID generation based on PNG and font names to exclude paths by inserting a call to PathBasename at each Id generation site o Fixed AS-02 timed text index partition o Fixed contents of generic partiton EssenceContainers property in AS-DCP timed text files o Added PixelLayout to RGBAEssenceDescriptor (contributed by Schleich) o Cleared up MXFGCP1FrameWrappedPictureElement / MXFGCP1FrameWrappedPictureElement ambiguity. PHDR continues to use MXFGCP1FrameWrappedPictureElement. MXFGCI1FrameWrappedPictureElement is supported for interlace. o Added support for 192, 200 and 240 fps images, includes 96, 100 and 120 fpe stereo o Added missing MCA properties to MCALabelSubDescriptor (contributed by Ruppel) o New MXF data type: LineMapPair o Added default 0,0 VideoLineMap value when wrapping CDCI with as-02-wrap o Added VideoLineMap property to GenericPictureEssenceDescriptor o Added timed text unwrap support to as-02-unwrap (contributed by Ruppel) o Added prototype PIDM dynamic metadata wrapping, config with --enable-phdr (Not for production use, caveat emptor, not the droids, etc.)
2016-08-11 - bug fixes, 2.5.15
o Modified as-02-wrap to pass WhiteRefLev, BlackRefLev and ColorRange (contributed by Elmer Musser / Rod Bogart) o Fixed a bug in the index reader that allowed an out-of-bounds vector index to be used. o Modified the IndexEntry parser to ignore additional bytes belonging to slice values.
2016-05-06 - bug fixes, 2.5.14
o Release 2.5.12 caused two problems with Atoms and DTS-X wrapping that are addressed by this release. The UL values that were changed to correct the DCData (ST 429-14) implementation had two unintended side-effects: 1. v2.5.12 cannot read old DCData (and thus DTS-X) track files 2. v2.5.12 creates broken Atmos track files (incorrect ULs) The fix for this involved the following changes: 1. ASDCP::DCData::(MXFReader|MXFWriter) are no longer base classes of ASDCP::ATMOS::(MXFReader|MXFWriter). 2. New UL values have been added to carry the original Atoms UL values: a. DolbyAtmosDCDataWrappingFrame b. DolbyAtmosDCDataEssence c. DolbyAtmosDCDataDescriptor 3. ASDCP::ATMOS::(MXFReader|MXFWriter) have been modified to use the DolbyAtmosDCData* UL values. 4. ASDCP::DCData::MXFReader will parse files having either DCData* or DolbyAtmosDCData* UL values. 5. ASDCP::DCData:: MXFWriter continues to use DCData* UL values from ST 429-14 o Some optional parameters of the MXF metadata packs were being erroneously initialized with a value of zero (0), such as GenericPictureEssenceDescriptor ::SignalStandard, GenericPictureEssenceDescriptor::SampledXOffset(0), etc. o Added higher edit rates (96, 100, 120) to the cinema TimedText_Parser
o Defined bool ASDCP::UL::operator<(const UL& rhs) const, which is needed to carry out the version-insensitive lookup policy when searching for ULs in a std::map<> of UL entries. o New files: src/info.in src/CMakeLists.txt o Removed filess: AS_DCP_DCData_internal.h
2016-03-17 - bug fixes, 2.5.12 o Changed default UNIX file permissions to "666" o Changed default UNIX file permissions to "777" o Added missing initializer for caltime::offset o Fixed UL values for Aux Data files (per ST 429-14) o Added support for default TTML fonts (ST2052_TextParser) o Added Solaris patch to KM_fileio (Thanks Mikey!) o Fixed the version byte in UL DataEssenceCoding o Fixed duplicate linkage error for symbol MIME2str o Big patch from Wolfgang Ruppel: o Corrected erroneous fixed-tag values in ActiveHeight, ActiveWidth, ActiveXOffset, ActiveYOffset UL definitions. o Provided a stub implementation for Kumu::DirScannerEx (A real implementation will follow soon.) o Added as-02-info program o Added Seek() method to PCM parsers o Added CMakeLists.txt
2015-11-10 - bug fixes, IMF text, pink noise, 2.5.11 o I moved personal dev environment from older gcc to newer clang. Many small changes were made to satisfy the new compiler:
2015-02-23 - bug fixes, 2.4.10 o Fixed a new bug introduced by the fix to large numbers of subtitle ancillary resources. o Added support for generic Aux Data (ST 429-14) to asdcp-wrap.
2015-02-19 - PHDR feature, bug fixes, 2.4.9 o Modified PCMParser and PCMParserList to return partial frame buffers at the end of a WAV input file. This was needed to allow wrapping all samples into an AS-02 audio file (which is clip-wrapped) in the case where the input file has an odd number of samples with respect to the frame buffer size being used. If there is more than one input file the length of the last buffer will be determined by PCMParserList to be the shortest of the input files. Prior to this change, partial samples in an input WAV file have been abandoned (i.e., not written out to the MXF file). As a result, AS-DCP applications will have to decide whether to abandon the partial last frame (usually detected by testing frame_buffer.Size() != frame_buffer.Capacity()) or write it to the MXF file. Programs written to the old API will write the partial frame (i.e., new behavior.) This should not be harmful since the remainder of the buffer is zeroed and the output file will contain one additional edit unit compared to the previous version. o asdcp-wrap has been modified to test for the partial buffer and by default will complain and abandon the buffer (i.e., same behavior but with a warning message.) A new command line switch (-g) alters this behavior and writes the buffer to the MXF file (it still warns the user that this condition is present.) o as-02-wrap now wraps all samples from the input file to the MXF file. There is no padding, the clip is exactly the set of samples from the input. o as-02 unwrap is temporarily restricted to creating wav files that are aligned with the frame buffer size. This means that the output file will be longer than the original WAV input in the case where the input file has an odd number of samples with respect to the frame buffer size being used. The pad samples are zero (silence). o Modified CalcFramesFromDurationInSamples() to increment the count by one for the case where the input file has an odd number of samples with respect to the frame buffer size being used (previously it truncated the odd samples.) o Fixed ST 429-5 / ST 2067-5 wrapping to increase header space when ancillary resources are present (fixes a bug that cause the header to overflow the allotted space when large numbers of PNG files were present.) o Refactored GetXMLDocType() to use the XML parser. o Added ParseFirstFromString() method to Kumu::XMLElement o Removed Kumu::StringIsXML from the API. o Added ASDCP::MXF::RGBALayout type o Added J2CLayout property to JPEG2000PictureSubDescriptor o Changed km_token_split() to retain empty elements in the output list o Added PHDR wrapping for AS-02. o Added J2CLayout property to the JPEG2000PictureSubDescriptor. This support is preliminary: the Raw data type is being used instead of RGBALayout type, which will be in the next release.
2014-10-2 - Bug fixes and enhancements, 2.2.6 o Fixed erroneous 377-4 MCA identifier in AS_DCP_PCM dump routine o Fixed erroneous byte 13 in WaveAudioDescriptor_ReferenceAudioAlignmentLevel label o Added missing implementation of -W option to as-02.unwrap o Fixed erroneous use of d-cinema ChannelAssignment label in as-02-wrap
2014-10-01 - Bug fixes and enhancements, 2.2.5 o Finished AS-02 text wrap/unwrap o Fixed fractional seconds parsing for Timestamp objects o Updated KLVPacket to use 64-bit length; allows huge packets in AS-02 PCM files o cleaned up use of atoi() in the library
2014-07-09 - Additional IMF/AS-02 support, bug fixes and enhancements, 2.1.4
o Added IMF App 2 edit rates in AS_02 namespace: EditRate_29_97,
EditRate_59_94.
o Revised AEC CBC context objects to copy the key rather than
keep the reference passed in to it.
o Addressed a bug that would allow unimpeded iteration of component
values in a JP2K::PictureDescriptor object.
o Addressed a bug that was incorrectly recording the sequence Duration
in MXF Track objects.
o Added ASDCP::AtmosSyncChannelMixer::AppendSilenceChannels()
o Added a QCD decoder to the j2c parser.
o Altered ASDCP::KLVPacket::HasUL() to use version-blind matching.
o Fixed an uninitialized variable in MemIOReader::ReadString() that
caused unbounded reads.
o Fixed broken ByteString::ArchiveLength() method
o Fixed broken version numbers on SoundfieldGroupLinkID and
GroupOfSoundfieldGroupsLinkID UL values.
o Added DBOXMotionCodePrimaryStream and DBOXMotionCodeSecondaryStream UL
values to the internal dictionary.
o Added optional prefix handling to MCA label generator.
o Re-factored MCA label generator to include additional
metadata (Thanks to Mike Radford).
o Added new options to as-02-wrap.
2014-01-06 – Additional IMF/AS-02 support, bug fixes 2.1.1 o Fixed missing-index-partion bugs for AS-02 files. o Moved LocalFilenameResolver into the AS_DCP public API so that it can be used by other modules including AS-02. o Did further refactoring of AS-02 Writer classes to separate CBR and VBR indexing implementations. o Fixed wave wrapping UL in clip-wrapped AS-02 files. Renamed some UL constants to reflect "clip" or "frame" wrapping. o Re-factored JP2K_PDesc_to_MD() and MD_to_JP2K_PDesc() to work with GenericPictureEssenceDescriptor objects. o Fixed a bug that was suppressing PictureComponentSizing, CodingStyleDefault and QuantizationDefault when writing the essence descriptor in a JP2K file (AS-DCP and AS-02). o Fixed the version byte on the following UL values: StereoscopicPictureSubDescriptor GenericPictureEssenceDescriptor_ColorPrimaries GenericPictureEssenceDescriptor_ActiveHeight GenericPictureEssenceDescriptor_ActiveWidth GenericPictureEssenceDescriptor_ActiveXOffset GenericPictureEssenceDescriptor_ActiveYOffset o Added some essence descriptor options to as-02-wrap. o Changed bit rate display in asdcp-info from mebi-bits/s to mega-bits/s. o Added "SMPTE" / "Interop" format type display to asdcp-info. o Improved integration of ST 377-4 MCA concepts with ST 429-2 static labels. o Modified asdcp-wrap to assume -L when wrapping timed-text (since there is no MXF text wrapping for Interop.) o Added new EssenceType_t values for IMF/AS-02 track files. o Added detection for AS-02 track files to ASDCP::EssenceType() o Changed lots of "const char*" to "const std::string&" in the APIs defined by KM_fileio.h and AS_DCP.h. o Fixed VBR Delta Segment entries to correctly flag progressive material. o Fixed PCM unwrapping bugs in as-02-unwrap. o Fixed missing return statement in ArchivableString::ArchiveLength (thanks to both Kristof Provost and Franck Chopin) o Fixed broken sample alignment in RF64Writer (thanks to Wolfgang Woehl and Dolby) o Fixed win32 build (thanks to Dolby) o fixed a bug that caused blackwave to only produce 96kHz WAV files. (thanks to Stephane W)
2013-07-02 – IMF/AS-02 support, bug fixes 2.0.0 o Massive refactoring of internals to allow easier implementation of AS-02. Some API changes were made as well (note that OPAtomHeader is now OP1aHeader and RIP is no longer part of the OP1aHeader.) If you are using this project as a library (and especially if you are keeping patches against it) PLEASE TAKE TIME TO EVALUATE THIS RELEASE THOUROUGHLY BEFORE ADDING IT TO YOUR RELEASE PATH. o Final integration of Fraunhoffer IIS code contribution. AS-02 files are now fully supported with some TODOs and two major exceptions: LEAD indexes are not supported by the MXF writers and interlace images are not yet supported. o Added support for MCA labels (ST 428-12) to asdcp-wrap. Note that this project is still in the early stages of interop testing so errors are likely present and don't expect any server to make use of this feature.
2013-07-01 - Bug fixes, enhancements 1.12.50 o Fixed missing return statement in ArchivableString::ArchiveLength (thanks to both Kristof Provost and Franck Chopin) o Fixed broken sample alignment in RF64Writer (thanks to Dolby) o Fixed win32 build (thanks to Dolby)
2013-04-12 - Dolby Atmos support and more audio labels 1.11.49 o Significant code contribution from Dolby Laboratories to add support for generic data track files as proposed in ST 21DC and also Dolby Atmos track file support as a specialization. o Added Dolby-contributed code to support generating the external sync signal for d-cinema as proposed in ST 21DC. o Added Dolby-contributed code to support RF64 WAVE files. o Fixed UL error in ST 429-5 DM encoding (contributed by Dolby). o Added ULs for ST 428-12 and Amd. 429-2 2013. Please check!
2013-02-20 - bug fixes, enhancements 1.10.48 o Refactored internals of the AS-DCP file readers. While no changes in behavior are intende
Content type
Image
Digest
Size
73.8 MB
Last updated
almost 8 years ago
docker pull arnaudmarcantoine/asdcplib