The asdcplib library is a set of objects that offer
simplified access to files conforming to the sound and
-picture track file formats proposed by the SMPTE working
-group DC-28.20.
+picture track file formats developed by the SMPTE Working
+Group DC28.20.
This work was originally funded by Digital Cinema
Initiatives, LLC (DCI). Subsequent efforts have been funded
-by Deluxe Laboratories, Doremi Labs, CineCert, LLC, Avica
+by Deluxe Laboratories, Doremi Labs, CineCert LLC, Avica
Technology and others.
-**The asdcplib project was housed on SourceForge. The project
-will be moving to a new home, to be announced here soon.
+**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,
library. Special thanks to Matt Beard and Oliver Morgan for
their great work and support.
-Thanks also to the members of the SMPTE DC-28.20 packaging
+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
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 for applications having non-trivial security
-requirements.
+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.
+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 API. You do not need to read
any of the other files, except maybe asdcp-test.cpp which
Build Instructions
-GNU make is required to build asdcplib. The makefile will
-work on win32 systems that have Cygwin. Other win32 gmake
+GNU make is required to build asdcplib. The makefile will work
+on win32 systems that have Cygwin and MSVC. Other win32 gmake
packages may or may not work depending upon the availability
of standard POSIX shell commands. You will need gcc to rebuild
the dep.make file.
-OpenSSL is also required. See http://www.openssl.org
+OpenSSL is also required. See http://www.openssl.org/
If you are building on win32 or a unix with no OpenSSL library
-support, you will have to also obtain and build OpenSSL (I'm
-using 0.9.7d on win32). Unpack it into the same parent directory
-as asdcplib/, and rename the directory as (or make a sym link
-named) 'openssl':
+support, you will have to also obtain and build OpenSSL. Unpack
+it into the same parent directory as asdcplib/, and rename (or make
+a symlink to) the directory as 'openssl':
myhost$ ls -l
total 1761
drwxr-xr-x 1 jhurst None 0 Feb 3 16:37 asdcplib
drwxr-xr-x 56 jhurst None 0 Feb 2 16:35 openssl
-I have tested this build on win32, Linux and Darwin platforms.
-Others may work as well.
+Expat is optionally required for writing Timed Text Track Files. See
+http://expat.sourceforge.net/
+
+To build, type 'make'. There are several test targets but you
+need to assemble a set of test files to use them.
+
+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-lf-test - Writes and verifies large files using a platform-
+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.
Documentation
-Currently, the documentation is mostly in AS_DCP.h. Read
-that file for a detailed description of the library's
-capabilities. Read asdcp-test.cpp for library usage
-examples. More detailed documentation will be written RSN.
+Currently, the API documentation is mostly in AS_DCP.h. Read
+that file for a detailed description of the library's capabilities.
+Read asdcp-test.cpp for library usage examples. The command-line
+utilities all respond to -h.
Change History
-2006.04.05 - Bug fixes and new stuff
+2007.12.13 - Bug fixes v.1.2.17
+ o Changed Result_t implementation to use int instead of long, which
+ was causing trouble on some 64 bit platforms.
+ o Fixed EKLV HMAC. NOTE: Breaks backward compatibility with older
+ Interop files. To validate these files, use asdcplib-1.1.14. This
+ should not cause too much trouble since files with broken and
+ non-broken HMAC have been in the wild for years without issue.
+ o Fixed HMAC sequence numbering in encrypted stereoscopic files.
+ o Finished stereoscopic test targets in the makefile.
+ o Fixed the win32 build, now expects VS2005 compiler by default,
+ use WITH_VC6=1 top get VC6 flags.
+ o Stereoscopic and Timed Text modes now have SMPTE UL values.
+ NOTE: SMPTE 429-5 and 429-10 are not yet published. It is possible
+ that these UL values may change before publication. Please use
+ caution when using these features for production work.
+ o Changed a bunch of symbol names in the 429-5 implementation to
+ better match the spec.
+ o Added -U option to asdcp-test to dump the UL library to stdout.
+ o Fixed erroneous placement of the PictureEssenceCoding UL in JP2K
+ files (Interop and SMPTE modes).
+
+
+2007.10.22 - Timed Text, Stereoscopic Picture and Bug fixes v.1.2.16
+ o Significant API changes have been made. Please read all entries
+ in this changelog to be sure you understand the changes. Also
+ note that some changes have been made to LS_MXF_SMPTE files that
+ are incompatible with earlier releases (e.g., EKLV HMAC). If
+ you are looking for a stable interop release, use v.1.1.14.
+ o Fixed RFC 2104 HMAC implementation for LS_MXF_SMPTE only. The
+ broken implementation has been maintained for Interop mode.
+ o Added support for draft SMPTE 429-5 Timed Text Track File. This
+ is still waiting for official SMPTE ULs, so do not use it for
+ shipping products. An XML parser is needed to create a Timed
+ Text Track File; Expat is now an optional part of the build.
+ Make with WITH_XML_PARSER=1 to link with Expat. If you do not
+ link with expat, you will get an error when using the TimedText::
+ DCSubtitleParser class. See also S429-5-cgi.cpp for an example
+ that shows how to serve plaintext MXF file elements directly via
+ HTTP.
+ o Added support for draft SMPTE 429-10 Stereoscopic Picture Track
+ File, including the JPEG Interop version. This is still waiting
+ for official SMPTE ULs, so do not use it with LS_MXF_SMPTE for
+ shipping products.
+ o Refactored the following files as a side-effect of the above
+ work: AS_DCP_JP2K.cpp AS_DCP_MPEG2.cpp AS_DCP_PCM.cpp
+ AS_DCP_MXF.cpp AS_DCP_internal.h MXF.[h|cpp] MXFTypes.[h|cpp]
+ Metadata.[h|cpp] h__Reader.cpp h__Writer.cpp klvwalk.cpp.
+ WARNING: While significant effort has been extended to make sure
+ that these changes do not affect existing stable file support,
+ users are cautioned to test this release thouroughly.
+ o Added a large set of filesystem path manglers to KM_fileio.h. See
+ path-test.cpp for example usage. The path manglers have not yet
+ been tested on win32 platforms (they are currently used only by
+ the Timed Text module.
+ o The PathIsFile(), PathIsDirectory() and FileSize() subroutines
+ have been modified to accept const std::string& instead of
+ const char*.
+ o Added namespace and parsing support (Expat) to Kumu::XMLElement
+ (currently used only for Timed Text support). Also added some
+ new accessors.
+ o Altered MXF::UTF16String to use mbtowc() and wctomb().
+
+
+2007.03.31 - Bug fixes v.1.1.14
+ o Fixed KeyFrameOffset value in MPEG wrapping to have negative
+ value. This is probably not yet complete for handling all
+ types of GOPs. Please send chunks of MPEG-2 VES that you
+ find which break this. Thanks to Doremi.
+ ** no other file format changes in this release **
+ o Fixed error in RIP interpretation when reading arbitrary (i.e.,
+ non-MXF) files.
+ o Fixed a memory leak in ASDCP::MXF::OPAtomHeader when used
+ in read mode. Thanks to Mahesh Bajaj for pointing out this
+ bug and the one above.
+ o Removed asserts from KM_fileio, replaced with RESULT_WRITEFAIL
+ return value statements.
+ o Added -s and -p to the makefile install target.
+ o Altered ByteString behavior to use target Length() in copy
+ operations (instead of Capacity()).
+ o Added new Set() method to ByteString.
+ o Fixed a bug in ByteString::Unarchive() that caused the operation
+ to fail when the buffer was smaller than the read (i.e., when
+ Capacity() was called).
+ o Added IdentifierList class to KM_util.h.
+ o Changed some Error() messages to Debug() in Wav.cpp
+ o Revived jp2k-test.cpp and asdcp-mem-test.cpp (they both had
+ stale #includes).
+
+
+2007.02.15 - Bug fixes v1.1.13
+ o Removed 'VDescObj->SampleRate.Numerator = VDesc.FrameRate;'
+ from MPEG2_VDesc_to_MD() in AS_DCP_MPEG2.cpp, was line 76.
+ o Added KM_TEST_NULL_STR_L() and KM_TEST_NULL_L() macros to
+ KM_log.h. These versions log the location of the null value.
+ Macros are now used in any module that includes KM_log.h.
+ o MPEG2 VES with run of zero values at the head is now OK.
+ o Increased VESHeaderBufSize to 16K.
+ o Added makefile support for local OpenSSL in ../openssl, if
+ present.
+ o The Kumu::PathIs*() functions now return false if a null or
+ empty string is given (used to be an assert).
+ o Cleaned up the install target in the makefile.
+ o Fixed SMPTE 429-6 HMAC -- FIPS 186-2 implementation was
+ laughably incorrect. Thanks to Doremi for pointing this out.
+ o Removed default parameter to HMACContext::InitKey().
+ o Cleaned up messages and CLI arg handling in asdcp-test.
+
+
+2006.11.19 - Mo better stuff v1.1.12
+ o Changed read-only Result_t accessor methods to const.
+ o Added Base64 (-B) option to kmrandgen.
+ o Removed 16-bit alignment restriction from kmrandgen.
+ o Improved WAV file extraction speed (Thanks to Jim Radford
+ for pointing this out).
+ o Added single-channel split for WAV extraction (asdcp-test -1).
+ o Fixed remainder bug in h__RNG::fill_rand().
+
+
+2006.11.03 - Bug fixes v1.1.11
+ o Increased index table entry list size to 5000.
+ o Added length checking to TLV writer (returns error if TLV
+ payload exceeds 64kB).
+ o Fixed partition header and RIP errors related to 2-partition
+ files (MXF Interop mode).
+ o Added -t option to asdcp-test (SHA-1 digest with Base64 output
+ on stdout).
+ o Fixed Sub Descriptor reference bug (Thanks to Denis Leconte
+ for dogged determination).
+ o Added directory-of-wav detection to RawEssenceType()
+ o Modified MXF::Partition::AddChildObject() to only generate
+ a UUID if the InstanceID is unset.
+ o Added ComponentMaxRef & ComponentMinRef to RGBAEssenceDescriptor.
+ More to follow.
+ o Added detection of 2K/4K jp2c, writing correct 4K metadata.
+
+
+2006.10.05 - Bug fixes v1.1.10
+ o Changed RM_RELEASE to RL_RELEASE in MXFTypes.h.
+ o Changed the MXF writer to use RL_RELEASE (was RL_DEVELOPMENT).
+ o Really fixed source reference chain.
+ o Updated JP2K file package label.
+ o Changed location of JPEG2000PictureSubDescriptor in the
+ header (was erroneously before Preface).
+ o Altered LS_MXF_INTEROP to produce 2-partition files.
+
+
+2006.09.25 - Bug fixes v1.1.9
+ o Fixed SourcePackageID value. All files will be 'original',
+ i.e. SourcePackageID will be all zeros. Let me know if you
+ want to set SourcePackageID.
+ o Fixed compiler warnings on some Linux platforms
+ o Fixed the build so that BUILD_DIR is no longer created
+ as a dependency.
+ o Added duration detection to the raw essence parsers. The
+ MPEG parser uses a nasty approximation so don't use it
+ without paying close attention to the result.
+ o Modified PCMParserList to make it more useful as a base
+ class.
+ o Fixed bugs and re-organized command-line help in asdcp-test
+ and klvwalk.
+ o Fixed two-partition file reads.
+ o Fixed Win32 PRNG initialization.
+ o Renamed asdcp-lf-test as kmfilegen.
+ o Added kmrandgen and kmuuidgen.
+ o Added string retrieval mechanism to Result_t.
+ o Refactored Kumu::Identifier and its sub-classes.
+ o Altered Kumu::PathIsFile to return true when the path
+ is a symbolic link (unix only).
+ o Altered Kumu::FileWriter::OpenWrite to use file creation
+ mode 0664 (was 0644) (unix only).
+ o Added Kumu::WriteStringIntoFile() subroutine.
+
+
+2006.04.05 - Bug fixes and new stuff v1.1.7
o Fixed a bug in the MPEG parser that caused it to fail when
handling start codes spanning buffer boundaries
o Added wavesplit and blackwave utility programs
const Kumu::Result_t RESULT_FORMAT (-101, "The file...");
The macros ASDCP_SUCCESS and ASDCP_FAILURE still work
- the same thanks to an operator overload for long. See
- KM_error.h for more information.
+ the same way thanks to an operator overload for type long.
+ See KM_error.h for more information.
+ The logging interface has been moved out of AS_DCP.h
and into KM_log.h
o Some of the command line utilities that were using headers
- other than AS_DCP.h have been changed to us the Kumu
+ other than AS_DCP.h have been changed to use the Kumu
equivalents. If you have code based on those utilities, you
will have to update by hand.
o Added new types to the EssenceType_t enum.
projects / asdcplib.git / blobdiff