Developer Documentation

These pages contain documentation for people wanting to use the EAR python APIs to work with ADM data.

The EAR was primarily developed as a stand-alone application for rendering ADM files to loudspeaker signals, to support the standardisation of renderers. As such, the internal APIs are not necessarily as tidy and stable as they could be, as they were not the focus during development. You have been warned!

That being said, they represent one of the more complete packages for working with ADM data (along with libbw64 and libadm), so we welcome changes that improve the experience of using them.

Contents:

• File IO
  • BW64 I/O
    • Chunk Classes
  • ADM Data
    • Top-level Elements
    • Common Sub-Elements
    • Common Types
    • audioBlockFormat types
  • ADM XML Handling
    • XML Parsing
    • XML Generation
  • ADM Utilities
    • ADM Builder
    • ID Generation
    • CHNA Utilities
    • Common Definitions
  • ADM Exceptions
  • Timing Fixes
• Core
  • Metadata Input
    • Overall Structure
    • Track Specs
    • Objects
    • Direct Speakers
    • HOA
    • Shared Data
  • Rendering Item Selection
  • Track Processor
  • Loudspeaker Layout
    • BS.2051 Layouts
    • Real-world Layouts
  • Conversion
    • audioBlockFormat Conversion Functions
    • Low-Level Conversion Functions
  • Geometry Utilities
    • Coordinate Conversion
    • Angle Utilities
• Common Structures
  • Position Classes
    • Position Mixins
  • Screen Classes