How tjoppen/mxflib works
Project type and purpose
• MXFlib is an open-source C++ library implementing support for the Material Exchange Format (MXF).
• It also packages a set of simple command-line utilities (mxfdump, mxfwrap, mxfsplit, mxfcrypt, dictconvert, simplewrap) to demonstrate and exercise the library API.
• Platform-abstraction is factored into libprocesswrap and utility modules; documentation is generated by Doxygen; a test suite validates functionality.
File structure
• Top-level modules:
• mxflib/ ← core MXF parsing, metadata, essence, indexing, KLV, partitions, XML, crypto interfaces
• libprocesswrap/ ← cross-platform process and charset wrappers
• utility/ ← simple UTF-8 helpers
• mxfwrap/, mxfdump/, mxfsplit/, mxfcrypt/, dictconvert/, simplewrap/ ← sample CLI applications linking against mxflib & libprocesswrap
• docs/ ← Doxygen configuration and documentation source
• tests/ ← automated tests (.at scripts, sample MXF, WAV files)
• build/ ← MSVC project files for VS8/VS9
• autotools files (configure.ac, Makefile.am, bootstrap.sh) for Unix builds
• Notice the modular separation: core library, platform/foundation layer, example front-ends, build system, docs, and tests.
README highlights
• Describes how to build on Windows (MSVC) and Unix (./configure && make), how to run make check (test suite).
• Mentions external dependencies: Doxygen (docs), e2fsprogs’ uuid_generate on Linux, native CoCreateGuid on Windows, fallback random UUID generator.
• Demonstrates example workflows: dumping an MXF, wrapping MPEG-2 into MXF.
a. Main components
• Core MXFlib Library (mxflib/)
• Platform Abstraction Layer (libprocesswrap/ + utility/)
• CLI Tools (mxfwrap, mxfdump, mxfsplit, mxfcrypt, dictconvert, simplewrap)
• Build & Configuration (autotools, VS projects)
• Documentation Generator (Doxygen)
• Test Harness (tests/)
• External Dependencies (OS uuid APIs, e2fsprogs, Doxygen)
b. Relationships and interactions
• Each CLI tool → links against Core MXFlib + Platform layer → operates on input files → emits MXF or textual output
• Core MXFlib → invokes UUID APIs (OS or fallback)
• Build system → invokes compiler/linker to produce library and tools, runs Doxygen for docs, runs tests via “make check”
• Test harness → drives each CLI tool and core library functions on sample files
c. Architectural patterns
• Modular, layered design: separation of concerns between core protocol handling (MXF), platform abstractions, and user-facing tools
• Plugins/extensions style: each utility is a thin wrapper around core APIs
• Cross-platform build abstraction via autotools and VS project files
d. Key technologies
• C++11/98 (codebase)
• Autotools (configure.ac, Makefile.am)
• MSVC++ project files (build/vs8, build/vs9)
• Doxygen (docs/)
• e2fsprogs uuid library or Windows CoCreateGuid