Skip to content

OpenAudio/ddex-proto

BranchesTags

Repository files navigation

DDEX Proto

Go Reference Go Report Card License: MIT CI

A comprehensive implementation of DDEX (Digital Data Exchange) standards with native XML support and Protocol Buffer/JSON serialization using Go.

What is DDEX?

DDEX is a consortium of leading media companies, music licensing organizations, digital service providers and technical intermediaries that develop and promote the adoption of global standards for the exchange of information and rights data along the digital supply chain.

Features

This library provides Go structs with Protocol Buffer, JSON, and XML serialization support for:

  • ERN v4.3.2 (Electronic Release Notification) - For communicating music release information
  • ERN v4.3 (Electronic Release Notification) - For communicating music release information
  • ERN v4.2 (Electronic Release Notification) - For communicating music release information
  • ERN v3.8.3 (Electronic Release Notification) - For communicating music release information
  • ERN v3.8.1 (Electronic Release Notification) - For communicating music release information
  • MEAD v1.1 (Media Enrichment and Description) - For enriching media metadata
  • PIE v1.0 (Party Identification and Enrichment) - For party/artist information and awards

Key Capabilities

  • Native XML support: Full XML marshal/unmarshal with complete DDEX XSD compliance
  • Protocol Buffer serialization: Efficient binary format for high-performance applications
  • JSON serialization: Standard Go JSON support for REST APIs and web services
  • gRPC/ConnectRPC ready: Protocol Buffer definitions work seamlessly with RPC frameworks
  • Bidirectional conversion: Convert between XML, JSON, and protobuf without data loss
  • Type safety: Strong typing with comprehensive test coverage and validation

Installation

go get github.com/OpenAudio/ddex-proto@latest

Buf Schema Registry

The Protocol Buffer schemas for this project are available on the Buf Schema Registry:

buf.build/openaudio/ddex

Using Buf Schemas

To use these schemas in your own project with Buf:

# buf.yaml
version: v2
deps:
  - buf.build/openaudio/ddex
breaking:
  use:
    - FILE
lint:
  use:
    - DEFAULT

Then in your .proto files:

syntax = "proto3";

package myservice;

import "ddex/ern/v432/new_release_message.proto";
import "ddex/avs/avs.proto";

message MyReleaseWrapper {
  ddex.ern.v432.NewReleaseMessage release = 1;
  ddex.avs.TerritoryCode territory = 2;
}

Important Notes on Generation

  • Custom XML Tags: The Go structures in this library include custom XML tags that are essential for proper DDEX XML serialization. These tags are injected during the generation process using protoc-go-inject-tag.
  • Generation Binaries: The generation binaries and toolchain required to reproduce the full XML tag injection process are not yet available through the Buf remote registry. To regenerate the code with XML tags, you'll need to clone the repository and use the local Makefile commands.
  • Buf Generated Code: Code generated directly from the Buf registry will have Protocol Buffer support but will lack the XML struct tags needed for DDEX XML compliance. For full XML support, use the pre-generated code from this repository or use the Go module directly.

Quick Start

Basic XML Parsing

package main

import (
    "encoding/xml"
    "fmt"
    "os"

    "github.com/OpenAudio/ddex-proto"
    ernv432 "github.com/OpenAudio/ddex-proto/gen/ddex/ern/v432"
)

func main() {
    // Read DDEX XML file
    xmlData, err := os.ReadFile("release.xml")
    if err != nil {
        panic(err)
    }

    // Unmarshal into typed struct
    var release ernv432.NewReleaseMessage
    err = xml.Unmarshal(xmlData, &release)
    if err != nil {
        panic(err)
    }

    // Access structured data
    fmt.Printf("Message ID: %s\n", release.MessageHeader.MessageId)

    // Convert back to XML with proper header
    regeneratedXML, err := xml.MarshalIndent(&release, "", "  ")
    if err != nil {
        panic(err)
    }

    // Add XML declaration for complete DDEX document
    fullXML := xml.Header + string(regeneratedXML)
    fmt.Println(fullXML)

    // Use type aliases for convenience
    var typedRelease ddex.NewReleaseMessageV432 = release
    fmt.Printf("Release Count: %d\n", len(typedRelease.ReleaseList.TrackRelease))
}

Protocol Buffer and JSON Serialization

package main

import (
    "encoding/json"
    "encoding/xml"
    "fmt"
    ernv432 "github.com/OpenAudio/ddex-proto/gen/ddex/ern/v432"
    "google.golang.org/protobuf/proto"
)

func main() {
    // Create a new release message
    release := &ernv432.NewReleaseMessage{
        MessageHeader: &ernv432.MessageHeader{
            MessageId: "MSG-12345",
        },
    }

    // Serialize to Protocol Buffer binary format
    protoData, err := proto.Marshal(release)
    if err != nil {
        panic(err)
    }

    // Serialize to JSON
    jsonData, err := json.Marshal(release)
    if err != nil {
        panic(err)
    }

    // Serialize to XML with proper DDEX formatting
    xmlData, err := xml.MarshalIndent(release, "", "  ")
    if err != nil {
        panic(err)
    }

    fmt.Printf("Proto size: %d bytes\n", len(protoData))
    fmt.Printf("JSON: %s\n", string(jsonData))
    fmt.Printf("XML:\n%s%s\n", xml.Header, string(xmlData))

    // Deserialize from binary format
    var decoded ernv432.NewReleaseMessage
    err = proto.Unmarshal(protoData, &decoded)
    if err != nil {
        panic(err)
    }

    fmt.Printf("Message ID: %s\n", decoded.MessageHeader.MessageId)
}

Supported Message Types

ERN (Electronic Release Notification) v4.3.2

  • NewReleaseMessage - New music releases
  • PurgeReleaseMessage - Release removal notifications

ERN (Electronic Release Notification) v4.3

  • NewReleaseMessage - New music releases
  • PurgeReleaseMessage - Release removal notifications

ERN (Electronic Release Notification) v4.2

  • NewReleaseMessage - New music releases
  • PurgeReleaseMessage - Release removal notifications

ERN (Electronic Release Notification) v3.8.3

  • NewReleaseMessage - New music releases
  • PurgeReleaseMessage - Release removal notifications
  • CatalogListMessage - Catalog list messages

ERN (Electronic Release Notification) v3.8.1

  • NewReleaseMessage - New music releases
  • PurgeReleaseMessage - Release removal notifications
  • CatalogListMessage - Catalog list messages

MEAD (Media Enrichment and Description) v1.1

  • MeadMessage - Media metadata enrichment

PIE (Party Identification and Enrichment) v1.0

  • PieMessage - Party/artist information
  • PieRequestMessage - Party information requests

Type Aliases

For convenience, the main package exports versioned type aliases:

// ERN v4.3.2 - Main message types
type NewReleaseMessageV432   = ernv432.NewReleaseMessage
type PurgeReleaseMessageV432 = ernv432.PurgeReleaseMessage

// ERN v4.3 - Main message types
type NewReleaseMessageV43   = ernv43.NewReleaseMessage
type PurgeReleaseMessageV43 = ernv43.PurgeReleaseMessage

// ERN v4.2 - Main message types
type NewReleaseMessageV42   = ernv42.NewReleaseMessage
type PurgeReleaseMessageV42 = ernv42.PurgeReleaseMessage

// ERN v3.8.3 - Main message types (including CatalogListMessage)
type NewReleaseMessageV383   = ernv383.NewReleaseMessage
type PurgeReleaseMessageV383 = ernv383.PurgeReleaseMessage
type CatalogListMessageV383  = ernv383.CatalogListMessage

// ERN v3.8.1 - Main message types (including CatalogListMessage)
type NewReleaseMessageV381   = ernv381.NewReleaseMessage
type PurgeReleaseMessageV381 = ernv381.PurgeReleaseMessage
type CatalogListMessageV381  = ernv381.CatalogListMessage

// MEAD v1.1 types
type MeadMessageV11 = meadv11.MeadMessage

// PIE v1.0 types
type PieMessageV10        = piev10.PieMessage
type PieRequestMessageV10 = piev10.PieRequestMessage

Examples

Testing with Real DDEX Files

The examples/proto/ directory contains a comprehensive tool for parsing and validating DDEX files:

# Parse any DDEX file - automatically detects message type and version
go run examples/proto/main.go -file path/to/your/ddex-file.xml

# Examples with different message types
# ERN v4.3 examples
go run examples/proto/main.go -file testdata/ddex/ern/v43/1\ Audio.xml
go run examples/proto/main.go -file testdata/ddex/ern/v42/2\ Video.xml
# MEAD and PIE examples
go run examples/proto/main.go -file testdata/ddex/mead/v11/award.xml
go run examples/proto/main.go -file testdata/ddex/pie/v10/reward.xml

Note: The repository now includes comprehensive test data for all supported ERN versions (v3.8.1, v3.8.3, v4.2, v4.3, v4.3.2), MEAD v1.1, and PIE v1.0. All test files are automatically discovered and validated.

For safely storing real DDEX files for testing, create a test-files/ or ddex-samples/ directory (gitignored):

mkdir test-files
# Copy your DDEX files here
go run examples/proto/main.go -file test-files/sample.xml

The example automatically detects the message type (ERN, MEAD, or PIE) and provides detailed output using spew.Dump() for easy inspection.

Development

Running Tests

# Run all tests including comprehensive validation
make test

# Run specific test suites
make test-comprehensive  # Conformance, roundtrip, and completeness tests
make test-roundtrip     # XML bidirectional conversion tests
make benchmark          # Performance benchmarks

Test Coverage:

  • Conformance tests: Validate against official DDEX sample files
  • Roundtrip tests: Ensure XML ↔ protobuf conversion without data loss
  • Field completeness: Verify all XSD fields are properly mapped
  • Performance benchmarks: Memory and speed optimization validation

Test Data:

  • ERN test files: Official DDEX consortium sample files for all supported versions (complete accuracy)
  • MEAD/PIE test files: Comprehensive examples covering core functionality
  • Automatic discovery: Test framework automatically discovers all message types and versions

Code Generation

Regenerating from Buf Registry

To regenerate the same Go code with full XML support from the Buf Schema Registry:

# Install the post-processor
go install github.com/OpenAudio/ddex-proto/cmd/protoc-gen-ddex@latest

# In your buf.gen.yaml, set the go_package_prefix for ddex module:
# managed:
#   enabled: true
#   override:
#     - file_option: go_package_prefix
#       module: buf.build/openaudio/ddex
#       value: github.com/OpenAudio/ddex-proto/gen

# Generate .pb.go files from buf.build/openaudio/ddex
buf generate

# Post-process to add XML support
protoc-gen-ddex

# Optional: Generate registry.go with custom import path
protoc-gen-ddex --go-package-prefix github.com/your-org/your-repo/gen

The protoc-gen-ddex tool performs these operations:

  1. Injects XML struct tags for DDEX XML compatibility
  2. Generates enum string conversion methods (enum_strings.go)
  3. Generates XML marshaling methods with namespace handling (*.xml.go)
  4. Optionally generates message type registry (registry.go) when --go-package-prefix is provided

Options:

  • --dir <path>: Target directory containing .pb.go files (default: ./gen)
  • --go-package-prefix <prefix>: Go package prefix for import paths (generates registry.go)
  • --verbose: Enable verbose logging

Note: The proto files use relative go_package paths (e.g., ddex/ern/v432;ernv432). Set the go_package_prefix override in your buf.gen.yaml to specify your full import path.

Full Generation Pipeline (For Maintainers)

The library uses a sophisticated generation pipeline:

# Complete generation workflow from XSD schemas
make generate           # XSD → proto → Go with XML tags

# Individual steps
make generate-proto     # XSD schemas → Protocol Buffer definitions
make generate-proto-go  # Proto files → Go structs with XML tags
make buf-generate      # Alternative: use buf for Go generation
make buf-lint          # Lint protobuf files

# See all available commands
make help

Pipeline Details:

  1. XSD → Proto: cmd/xsd2proto converts DDEX XSD schemas to protobuf with XML annotations
  2. Proto → Go: buf generate creates Go structs with protobuf support
  3. XML Tag Injection: cmd/protoc-go-inject-tag adds XML struct tags for DDEX compatibility
  4. Go Extensions: cmd/ddex-gen generates enum strings and XML methods

Manual Commands

# Run tests without generation
go test -v ./...

# Clean generated files and test data
make clean

# Force refresh of test data
make testdata-refresh

Repository Structure

ddex-go/
├── proto/                   # Protocol Buffer definitions with XML tags
│   └── ddex/               # Namespace-aware proto organization
│       ├── avs/            # Allowed Value Sets (enums shared across specs)
│       ├── ern/            # ERN versions: v381, v383, v42, v43, v432
│       ├── mead/v11/       # MEAD v1.1 .proto files
│       └── pie/v10/        # PIE v1.0 .proto files
│
├── gen/                     # Generated Go code from proto files
│   └── ddex/               # Mirrors proto structure
│       ├── avs/            # Shared enum types with proper XML tags
│       ├── ern/            # ERN Go code for all supported versions
│       ├── mead/v11/       # MEAD Go code with protobuf + XML support
│       └── pie/v10/        # PIE Go code with protobuf + XML support
│
├── tools/                   # Generation and conversion tools
│   ├── xsd2proto/          # XSD to Proto converter with namespace-aware imports
│   └── generate-enum-strings/ # Enum string method generator
│
├── examples/                # Usage examples and documentation
│   └── proto/              # Comprehensive parsing example (supports all message types)
│
├── testdata/                # Test files for validation
│   └── ddex/               # Organized by message type and version
│       ├── ern/            # ERN test data (v381, v383, v42, v43, v432)
│       ├── mead/v11/       # MEAD v1.1 test examples
│       └── pie/v10/        # PIE v1.0 test examples
│
├── xsd/                     # Original DDEX XSD schema files
│   ├── avs20200518.xsd     # AVS v2020.05.18
│   ├── avs_20161006.xsd    # AVS v2016.10.06
│   ├── ernv381/           # ERN v3.8.1 XSD files
│   ├── ernv42/            # ERN v4.2 XSD files
│   └── ... (other ERN versions, MEAD, PIE)
│
├── buf.yaml                 # Protocol Buffer configuration
├── buf.gen.yaml            # Code generation configuration
├── Makefile                # Build automation
└── ddex.go                 # Main package with type aliases

Architecture and Serialization

This library implements native XML support with Protocol Buffer and JSON serialization:

Core Architecture

  • Native XML support: Direct XML marshal/unmarshal with full DDEX XSD compliance
  • Protocol Buffer definitions: High-performance binary serialization for microservices
  • JSON serialization: Standard Go JSON support for REST APIs and web services
  • Shared enum types in ddex/avs/ package used across all DDEX specifications
  • Namespace-aware imports ensure proper XSD compliance and proto organization

Benefits

  • DDEX Compliance: Native XML support ensures perfect DDEX standard compliance
  • Performance: Binary protobuf serialization for high-throughput applications
  • Interoperability: Native gRPC/ConnectRPC support for microservices
  • Type Safety: Strong typing with comprehensive validation and test coverage
  • Flexibility: Convert seamlessly between XML, JSON, and protobuf formats

Usage Patterns

  • Use XML for DDEX standard compliance and external integrations
  • Use JSON for REST APIs, web services, and JavaScript interoperability
  • Use Protocol Buffers for internal APIs, microservices, and performance-critical applications
  • Convert seamlessly between all three formats as needed

License

This library is for working with DDEX standards. DDEX specifications are developed by the DDEX consortium.

About

protobuf definitions of ddex schemas. used by the OpenAudio Protocol.

Resources

Readme

License

MIT license

Contributing

Contributing
Activity
Custom properties

Stars

2 stars

Watchers

0 watching

Forks

1 fork
Report repository

Releases 10

v0.10.0 Latest
Nov 13, 2025
+ 9 releases

Packages

No packages published

Languages