# ka9q/libfec architecture

> Architecture diagram of the GitHub repository ka9q/libfec, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ka9q/libfec
- Repository: https://github.com/ka9q/libfec

## Overview

libfec is a C library providing forward-error-correction codecs and DSP primitives. Its user-facing workflow is to supply encoded-channel symbols to a decoder and receive corrected data; encoding is the corresponding transmit-side operation. The major branches are convolutional-code decoding, general and CCSDS Reed–Solomon coding, and signal-processing helpers. Portable C and architecture-specific SIMD implementations provide alternate execution paths, with runtime selection documented by the README. The README establishes those capabilities and selection behavior; source excerpts confirm selected codec implementations, but not all dispatch wiring.

Main entry points: [`fec.h`](https://github.com/ka9q/libfec/blob/main/fec.h) (Viterbi API), [`encode_rs_ccsds.c`](https://github.com/ka9q/libfec/blob/main/encode_rs_ccsds.c) (CCSDS encoder), [`decode_rs_ccsds.c`](https://github.com/ka9q/libfec/blob/main/decode_rs_ccsds.c) (CCSDS decoder), [`code.h`](https://github.com/ka9q/libfec/blob/main/code.h) (Code definitions)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_conv["Convolutional Decoding"]
  node_conv_api["Viterbi API<br/>[fec.h]"]
  node_conv27["K=7 decoder<br/>[viterbi27.c]"]
  node_conv29["K=9 decoder<br/>[viterbi29.c]"]
  node_conv615["K=15 decoder<br/>[viterbi615.c]"]
  node_conv224["K=24 decoder<br/>[viterbi224_port.c]"]
  node_conv_config["Code definitions<br/>[code.h]"]
end

subgraph group_reed["Reed-Solomon Coding"]
  node_rs_api["RS API<br/>[fec.h]"]
  node_rs_core["RS core<br/>[rs.c]"]
  node_rs_encode["RS encoders<br/>[encode_rs_8.c]"]
  node_rs_decode["RS decoders<br/>[decode_rs.c]"]
  node_rs_headers["RS definitions<br/>[rs.h]"]
  node_ccsds_encode["CCSDS encoder<br/>[encode_rs_ccsds.c]"]
  node_ccsds_decode["CCSDS decoder<br/>[decode_rs_ccsds.c]"]
  node_ccsds_defs["CCSDS definitions<br/>[ccsds.h]"]
end

subgraph group_dsp["DSP Primitives"]
  node_dotprod["Dot product<br/>[dotprod.c]"]
  node_sumsq["Sum of squares<br/>[sumsq_port.c]"]
  node_peak["Peak value<br/>[peakval_port.c]"]
end

subgraph group_simd["SIMD Implementations"]
  node_simd_select["Runtime selection<br/>[fec.c]"]
  node_simd_viterbi["SIMD Viterbi variants<br/>[viterbi615_av.c]"]
  node_simd_dsp["SIMD DSP variants<br/>[dotprod_av.c]"]
end

subgraph group_fano["Fano Decoding"]
  node_fano_decoder["Fano decoder<br/>[fano.c]"]
  node_fano_defs["Fano definitions<br/>[fano.h]"]
end

node_user(("Library caller"))

node_user -->|"uses"| node_conv_api
node_user -->|"uses"| node_rs_api
node_user -->|"encodes CCSDS"| node_ccsds_encode
node_user -->|"decodes CCSDS"| node_ccsds_decode
node_user -->|"computes product"| node_dotprod
node_user -->|"computes energy"| node_sumsq
node_user -->|"finds peak"| node_peak
node_user -->|"uses"| node_fano_decoder
node_conv_api -->|"exposes"| node_conv27
node_conv_api -->|"exposes"| node_conv29
node_conv_api -->|"exposes"| node_conv615
node_conv_api -->|"exposes"| node_conv224
node_conv27 -->|"uses polynomials"| node_conv_config
node_conv29 -.->|"uses polynomials"| node_conv_config
node_conv615 -->|"uses polynomials"| node_conv_config
node_conv_api -.->|"selects implementation"| node_simd_select
node_rs_api -->|"exposes"| node_rs_encode
node_rs_api -->|"exposes"| node_rs_decode
node_rs_core -->|"implements definitions"| node_rs_headers
node_rs_api -->|"exposes"| node_ccsds_encode
node_rs_api -->|"exposes"| node_ccsds_decode
node_ccsds_encode -->|"uses format"| node_ccsds_defs
node_ccsds_decode -.->|"uses format"| node_ccsds_defs
node_fano_decoder -->|"implements API"| node_fano_defs
node_conv_api -.->|"may select"| node_simd_viterbi
node_dotprod -.->|"may select"| node_simd_dsp
node_sumsq -.->|"may select"| node_simd_dsp
node_peak -.->|"may select"| node_simd_dsp

click node_conv_api "https://github.com/ka9q/libfec/blob/main/fec.h"
click node_conv27 "https://github.com/ka9q/libfec/blob/main/viterbi27.c"
click node_conv29 "https://github.com/ka9q/libfec/blob/main/viterbi29.c"
click node_conv615 "https://github.com/ka9q/libfec/blob/main/viterbi615.c"
click node_conv224 "https://github.com/ka9q/libfec/blob/main/viterbi224_port.c"
click node_conv_config "https://github.com/ka9q/libfec/blob/main/code.h"
click node_rs_api "https://github.com/ka9q/libfec/blob/main/fec.h"
click node_rs_core "https://github.com/ka9q/libfec/blob/main/rs.c"
click node_rs_encode "https://github.com/ka9q/libfec/blob/main/encode_rs_8.c"
click node_rs_decode "https://github.com/ka9q/libfec/blob/main/decode_rs.c"
click node_rs_headers "https://github.com/ka9q/libfec/blob/main/rs.h"
click node_ccsds_encode "https://github.com/ka9q/libfec/blob/main/encode_rs_ccsds.c"
click node_ccsds_decode "https://github.com/ka9q/libfec/blob/main/decode_rs_ccsds.c"
click node_ccsds_defs "https://github.com/ka9q/libfec/blob/main/ccsds.h"
click node_dotprod "https://github.com/ka9q/libfec/blob/main/dotprod.c"
click node_sumsq "https://github.com/ka9q/libfec/blob/main/sumsq_port.c"
click node_peak "https://github.com/ka9q/libfec/blob/main/peakval_port.c"
click node_fano_decoder "https://github.com/ka9q/libfec/blob/main/fano.c"
click node_fano_defs "https://github.com/ka9q/libfec/blob/main/fano.h"
click node_simd_select "https://github.com/ka9q/libfec/blob/main/fec.c"
click node_simd_viterbi "https://github.com/ka9q/libfec/blob/main/viterbi615_av.c"
click node_simd_dsp "https://github.com/ka9q/libfec/blob/main/dotprod_av.c"

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_conv_api,node_conv27,node_conv29,node_conv615,node_conv224,node_conv_config toneBlue
class node_rs_api,node_rs_core,node_rs_encode,node_rs_decode,node_rs_headers,node_ccsds_encode,node_ccsds_decode,node_ccsds_defs toneAmber
class node_dotprod,node_sumsq,node_peak toneMint
class node_simd_select,node_simd_viterbi,node_simd_dsp toneRose
class node_fano_decoder,node_fano_defs,node_user toneIndigo
```

## Components

### Convolutional Decoding

- [Viterbi API](https://github.com/ka9q/libfec/blob/main/fec.h): `fec.h`
- [K=7 decoder](https://github.com/ka9q/libfec/blob/main/viterbi27.c): `viterbi27.c`
- [K=9 decoder](https://github.com/ka9q/libfec/blob/main/viterbi29.c): `viterbi29.c`
- [K=15 decoder](https://github.com/ka9q/libfec/blob/main/viterbi615.c): `viterbi615.c`
- [K=24 decoder](https://github.com/ka9q/libfec/blob/main/viterbi224_port.c): `viterbi224_port.c`
- [Code definitions](https://github.com/ka9q/libfec/blob/main/code.h): `code.h`

### Reed-Solomon Coding

- [RS API](https://github.com/ka9q/libfec/blob/main/fec.h): `fec.h`
- [RS core](https://github.com/ka9q/libfec/blob/main/rs.c): `rs.c`
- [RS encoders](https://github.com/ka9q/libfec/blob/main/encode_rs_8.c): `encode_rs_8.c`
- [RS decoders](https://github.com/ka9q/libfec/blob/main/decode_rs.c): `decode_rs.c`
- [RS definitions](https://github.com/ka9q/libfec/blob/main/rs.h): `rs.h`
- [CCSDS encoder](https://github.com/ka9q/libfec/blob/main/encode_rs_ccsds.c): `encode_rs_ccsds.c`
- [CCSDS decoder](https://github.com/ka9q/libfec/blob/main/decode_rs_ccsds.c): `decode_rs_ccsds.c`
- [CCSDS definitions](https://github.com/ka9q/libfec/blob/main/ccsds.h): `ccsds.h`

### DSP Primitives

- [Dot product](https://github.com/ka9q/libfec/blob/main/dotprod.c): `dotprod.c`
- [Sum of squares](https://github.com/ka9q/libfec/blob/main/sumsq_port.c): `sumsq_port.c`
- [Peak value](https://github.com/ka9q/libfec/blob/main/peakval_port.c): `peakval_port.c`

### SIMD Implementations

- [Runtime selection](https://github.com/ka9q/libfec/blob/main/fec.c): `fec.c`
- [SIMD Viterbi variants](https://github.com/ka9q/libfec/blob/main/viterbi615_av.c): `viterbi615_av.c`
- [SIMD DSP variants](https://github.com/ka9q/libfec/blob/main/dotprod_av.c): `dotprod_av.c`

### Fano Decoding

- [Fano decoder](https://github.com/ka9q/libfec/blob/main/fano.c): `fano.c`
- [Fano definitions](https://github.com/ka9q/libfec/blob/main/fano.h): `fano.h`

### Other components

- **Library caller**

## Connections

- Library caller → Viterbi API: uses (evidence: `README`)
- Library caller → RS API: uses (evidence: `README`)
- Library caller → CCSDS encoder: encodes CCSDS (evidence: `README`)
- Library caller → CCSDS decoder: decodes CCSDS (evidence: `README`)
- Library caller → Dot product: computes product (evidence: `README`)
- Library caller → Sum of squares: computes energy (evidence: `README`)
- Library caller → Peak value: finds peak (evidence: `README`)
- Library caller → Fano decoder: uses
- Viterbi API → K=7 decoder: exposes (evidence: `fec.h`)
- Viterbi API → K=9 decoder: exposes (evidence: `fec.h`)
- Viterbi API → K=15 decoder: exposes (evidence: `fec.h`)
- Viterbi API → K=24 decoder: exposes (evidence: `viterbi224_port.c`)
- K=7 decoder → Code definitions: uses polynomials
- K=9 decoder → Code definitions: uses polynomials
- K=15 decoder → Code definitions: uses polynomials
- Viterbi API → Runtime selection: selects implementation (evidence: `README`)
- RS API → RS encoders: exposes (evidence: `fec.h`)
- RS API → RS decoders: exposes (evidence: `fec.h`)
- RS core → RS definitions: implements definitions (evidence: `rs.c`)
- RS API → CCSDS encoder: exposes (evidence: `fec.h`)
- RS API → CCSDS decoder: exposes (evidence: `fec.h`)
- CCSDS encoder → CCSDS definitions: uses format
- CCSDS decoder → CCSDS definitions: uses format
- Fano decoder → Fano definitions: implements API (evidence: `fano.c`)
- Viterbi API → SIMD Viterbi variants: may select (evidence: `README`)
- Dot product → SIMD DSP variants: may select (evidence: `README`)
- Sum of squares → SIMD DSP variants: may select (evidence: `README`)
- Peak value → SIMD DSP variants: may select (evidence: `README`)
