# dolbylaboratories/dolby-encoding-engine architecture

> Architecture diagram of the GitHub repository dolbylaboratories/dolby-encoding-engine, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dolbylaboratories/dolby-encoding-engine
- Repository: https://github.com/dolbylaboratories/dolby-encoding-engine

## Overview

This repository provides Dolby Encoding Engine integration plugins: HEVC encoders, image transformation, and JPEG 2000, TIFF, PCM watermarking, and ProRes decoder/plugin APIs. The user-facing workflow is DEE invoking a plugin through its C API to configure it, process frames, and retrieve outputs or status. Sampled implementation details chiefly cover Beamr/x265 encoding and Kakadu/libtiff decoding; other capabilities are retained from the tree and APIs, with uncertain internal wiring omitted.

Main entry points: [`plugins/code/common/Common/plugins_common.h`](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/common/Common/plugins_common.h) (Common types), [`plugins/code/hevc_enc/beamr/src/hevc_enc_beamr_impl.cpp`](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/hevc_enc/beamr/src/hevc_enc_beamr_impl.cpp) (Beamr encoder), [`plugins/code/api/hevc_enc/hevc_enc_api.h`](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/api/hevc_enc/hevc_enc_api.h) (HEVC API), [`plugins/code/hevc_enc/beamr/src/hevc_enc_beamr.cpp`](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/hevc_enc/beamr/src/hevc_enc_beamr.cpp) (Beamr adapter)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_contracts["Plugin contracts"]
  node_common_api["Common types<br/>[plugins_common.h]"]
  node_hevc_api["HEVC API<br/>[hevc_enc_api.h]"]
  node_image_api["Transformer API"]
  node_j2k_api["JPEG 2000 API<br/>[j2k_dec_api.h]"]
  node_tiff_api["TIFF API<br/>[tiff_dec_api.h]"]
  node_pcm_api["PCM watermark API"]
  node_prores_api["ProRes API<br/>[prores_dec_api.h]"]
end

subgraph group_encoding["HEVC encoding"]
  node_beamr_plugin["Beamr adapter<br/>[hevc_enc_beamr.cpp]"]
  node_beamr_engine["Beamr encoder"]
  node_beamr_utils["Beamr utilities"]
  node_x265_plugin["x265 adapter<br/>[hevc_enc_x265.cpp]"]
  node_x265_utils["x265 utilities"]
end

subgraph group_media["Image and decoding"]
  node_image_dummy["Dummy transformer"]
  node_kakadu_plugin["Kakadu decoder<br/>[j2k_dec_kakadu.cpp]"]
  node_kakadu_entry["Kakadu exports"]
  node_libtiff_plugin["libtiff decoder"]
end

subgraph group_shared["Shared support"]
  node_debugger["Call debugger<br/>[plugins_debugger.h]"]
end

node_dee(("DEE host"))

node_dee -.->|"invokes plugin"| node_beamr_plugin
node_dee -.->|"invokes plugin"| node_x265_plugin
node_dee -.->|"invokes plugin"| node_image_dummy
node_dee -.->|"loads export"| node_kakadu_entry
node_dee -.->|"invokes plugin"| node_libtiff_plugin
node_common_api -->|"defines shared types"| node_hevc_api
node_common_api -->|"defines shared types"| node_image_api
node_common_api -->|"defines shared types"| node_j2k_api
node_common_api -->|"defines shared types"| node_tiff_api
node_common_api -->|"defines shared types"| node_pcm_api
node_common_api -->|"defines shared types"| node_prores_api
node_beamr_plugin -->|"implements contract"| node_hevc_api
node_beamr_plugin -->|"delegates encoding"| node_beamr_engine
node_beamr_engine -->|"uses parsing helpers"| node_beamr_utils
node_beamr_engine -->|"uses call macros"| node_debugger
node_beamr_engine -->|"uses encoder types"| node_hevc_api
node_x265_plugin -->|"implements contract"| node_hevc_api
node_x265_plugin -->|"uses helpers"| node_x265_utils
node_image_dummy -->|"implements contract"| node_image_api
node_kakadu_entry -->|"exports decoder"| node_kakadu_plugin
node_kakadu_plugin -->|"uses decoder contract"| node_j2k_api
node_libtiff_plugin -->|"implements contract"| node_tiff_api

click node_common_api "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/common/Common/plugins_common.h"
click node_hevc_api "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/api/hevc_enc/hevc_enc_api.h"
click node_image_api "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/api/image_transformer/image_transformer_api.h"
click node_j2k_api "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/api/j2k_dec/j2k_dec_api.h"
click node_tiff_api "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/api/tiff_dec/tiff_dec_api.h"
click node_pcm_api "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/api/pcm_watermarker/pcm_watermarker_api.h"
click node_prores_api "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/api/prores_dec/prores_dec_api.h"
click node_beamr_plugin "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/hevc_enc/beamr/src/hevc_enc_beamr.cpp"
click node_beamr_engine "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/hevc_enc/beamr/src/hevc_enc_beamr_impl.cpp"
click node_beamr_utils "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/hevc_enc/beamr/src/hevc_enc_beamr_utils.cpp"
click node_x265_plugin "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/hevc_enc/x265/src/hevc_enc_x265.cpp"
click node_x265_utils "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/hevc_enc/x265/src/hevc_enc_x265_utils.cpp"
click node_image_dummy "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/image_transformer/dummy/src/image_transformer_dummy.cpp"
click node_kakadu_plugin "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/j2k_dec/kakadu/src/j2k_dec_kakadu.cpp"
click node_kakadu_entry "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/j2k_dec/kakadu/src/j2k_dec_kakadu_plugin.cpp"
click node_libtiff_plugin "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/tiff_dec/libtiff/src/tiff_dec_libtiff.cpp"
click node_debugger "https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/common/Debugger/plugins_debugger.h"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_common_api,node_hevc_api,node_image_api,node_j2k_api,node_tiff_api,node_pcm_api,node_prores_api toneBlue
class node_beamr_plugin,node_beamr_engine,node_beamr_utils,node_x265_plugin,node_x265_utils toneAmber
class node_image_dummy,node_kakadu_plugin,node_kakadu_entry,node_libtiff_plugin toneMint
class node_debugger toneRose
class node_dee toneIndigo
```

## Components

### Plugin contracts

- [Common types](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/common/Common/plugins_common.h): `plugins/code/common/Common/plugins_common.h`
- [HEVC API](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/api/hevc_enc/hevc_enc_api.h): `plugins/code/api/hevc_enc/hevc_enc_api.h`
- [Transformer API](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/api/image_transformer/image_transformer_api.h): `plugins/code/api/image_transformer/image_transformer_api.h`
- [JPEG 2000 API](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/api/j2k_dec/j2k_dec_api.h): `plugins/code/api/j2k_dec/j2k_dec_api.h`
- [TIFF API](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/api/tiff_dec/tiff_dec_api.h): `plugins/code/api/tiff_dec/tiff_dec_api.h`
- [PCM watermark API](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/api/pcm_watermarker/pcm_watermarker_api.h): `plugins/code/api/pcm_watermarker/pcm_watermarker_api.h`
- [ProRes API](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/api/prores_dec/prores_dec_api.h): `plugins/code/api/prores_dec/prores_dec_api.h`

### HEVC encoding

- [Beamr adapter](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/hevc_enc/beamr/src/hevc_enc_beamr.cpp): `plugins/code/hevc_enc/beamr/src/hevc_enc_beamr.cpp`
- [Beamr encoder](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/hevc_enc/beamr/src/hevc_enc_beamr_impl.cpp): `plugins/code/hevc_enc/beamr/src/hevc_enc_beamr_impl.cpp`
- [Beamr utilities](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/hevc_enc/beamr/src/hevc_enc_beamr_utils.cpp): `plugins/code/hevc_enc/beamr/src/hevc_enc_beamr_utils.cpp`
- [x265 adapter](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/hevc_enc/x265/src/hevc_enc_x265.cpp): `plugins/code/hevc_enc/x265/src/hevc_enc_x265.cpp`
- [x265 utilities](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/hevc_enc/x265/src/hevc_enc_x265_utils.cpp): `plugins/code/hevc_enc/x265/src/hevc_enc_x265_utils.cpp`

### Image and decoding

- [Dummy transformer](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/image_transformer/dummy/src/image_transformer_dummy.cpp): `plugins/code/image_transformer/dummy/src/image_transformer_dummy.cpp`
- [Kakadu decoder](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/j2k_dec/kakadu/src/j2k_dec_kakadu.cpp): `plugins/code/j2k_dec/kakadu/src/j2k_dec_kakadu.cpp`
- [Kakadu exports](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/j2k_dec/kakadu/src/j2k_dec_kakadu_plugin.cpp): `plugins/code/j2k_dec/kakadu/src/j2k_dec_kakadu_plugin.cpp`
- [libtiff decoder](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/tiff_dec/libtiff/src/tiff_dec_libtiff.cpp): `plugins/code/tiff_dec/libtiff/src/tiff_dec_libtiff.cpp`

### Shared support

- [Call debugger](https://github.com/dolbylaboratories/dolby-encoding-engine/blob/master/plugins/code/common/Debugger/plugins_debugger.h): `plugins/code/common/Debugger/plugins_debugger.h`

### Other components

- **DEE host**

## Connections

- DEE host → Beamr adapter: invokes plugin
- DEE host → x265 adapter: invokes plugin
- DEE host → Dummy transformer: invokes plugin
- DEE host → Kakadu exports: loads export
- DEE host → libtiff decoder: invokes plugin
- Common types → HEVC API: defines shared types (evidence: `plugins/code/api/hevc_enc/hevc_enc_api.h`)
- Common types → Transformer API: defines shared types (evidence: `plugins/code/api/image_transformer/image_transformer_api.h`)
- Common types → JPEG 2000 API: defines shared types (evidence: `plugins/code/api/j2k_dec/j2k_dec_api.h`)
- Common types → TIFF API: defines shared types (evidence: `plugins/code/api/tiff_dec/tiff_dec_api.h`)
- Common types → PCM watermark API: defines shared types (evidence: `plugins/code/api/pcm_watermarker/pcm_watermarker_api.h`)
- Common types → ProRes API: defines shared types (evidence: `plugins/code/api/prores_dec/prores_dec_api.h`)
- Beamr adapter → HEVC API: implements contract (evidence: `plugins/code/hevc_enc/beamr/src/hevc_enc_beamr.cpp`)
- Beamr adapter → Beamr encoder: delegates encoding (evidence: `plugins/code/hevc_enc/beamr/src/hevc_enc_beamr.cpp`)
- Beamr encoder → Beamr utilities: uses parsing helpers (evidence: `plugins/code/hevc_enc/beamr/src/hevc_enc_beamr_impl.cpp`)
- Beamr encoder → Call debugger: uses call macros (evidence: `plugins/code/hevc_enc/beamr/src/hevc_enc_beamr_impl.cpp`)
- Beamr encoder → HEVC API: uses encoder types
- x265 adapter → HEVC API: implements contract (evidence: `plugins/code/hevc_enc/x265/src/hevc_enc_x265.cpp`)
- x265 adapter → x265 utilities: uses helpers (evidence: `plugins/code/hevc_enc/x265/src/hevc_enc_x265.cpp`)
- Dummy transformer → Transformer API: implements contract (evidence: `plugins/code/image_transformer/dummy/src/image_transformer_dummy.cpp`)
- Kakadu exports → Kakadu decoder: exports decoder (evidence: `plugins/code/j2k_dec/kakadu/src/j2k_dec_kakadu_plugin.cpp`)
- Kakadu decoder → JPEG 2000 API: uses decoder contract
- libtiff decoder → TIFF API: implements contract (evidence: `plugins/code/tiff_dec/libtiff/src/tiff_dec_libtiff.cpp`)
