[1/2] Documentation: add glossary page
diff mbox series

Message ID 20251219-glossary-page-v1-1-971ba0ab4b2f@schnwalter.eu
State New
Headers show
Series
  • Documentation: add glossary terms
Related show

Commit Message

Walter Werner Schneider Dec. 19, 2025, 7:06 p.m. UTC 
The page currently contains acronyms and abbreviations commonly used
troughout libcamera and related projects, but can be expanded to also
explain technical terms.

Signed-off-by: Walter Werner Schneider <contact@schnwalter.eu>
---
 Documentation/glossary.rst | 158 +++++++++++++++++++++++++++++++++++++++++++++
 Documentation/index.rst    |   1 +
 Documentation/meson.build  |   1 +
 3 files changed, 160 insertions(+)

Patch
diff mbox series 

diff --git a/Documentation/glossary.rst b/Documentation/glossary.rst
new file mode 100644
index 0000000000000000000000000000000000000000..d8679a1148d2b520c301891745e78f5033b1235d
--- /dev/null
+++ b/Documentation/glossary.rst
@@ -0,0 +1,158 @@ 
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
+Glossary
+========
+
+This document contains a glossary of technical terms, acronyms and
+abbreviations commonly used throughout the libcamera documentation and
+codebase.
+
+.. Please keep the glossary entries in alphabetical order.
+
+.. glossary::
+   :sorted:
+
+   3A
+      Refers to the :term:`AE`, :term:`AF` and :term:`AWB`.
+
+   AE
+      Auto Exposure
+
+   AEC
+      Auto Exposure Control
+
+   AEGC
+      Refers to :term:`AEC` and :term:`AGC`
+
+   AF
+      Auto Focus
+
+   AFC
+      Auto Focus Control
+
+   AGC
+      Auto Gain Control
+
+   ALSC
+      Auto Lens Shading Correction
+
+   AWB
+      Auto White Balance
+
+   BLC
+      Black Level Correction
+
+   BLS
+      Black Level Subtraction
+
+   CAC
+      Chromatic Aberration Correction
+
+   CC
+      Color Correction
+
+   CCI
+      Camera Control Interface
+
+   CCM
+      Color Correction Matrix
+
+   CCS
+      Camera Command Set
+
+   CDAF
+      Contrast Detection Auto Focus
+
+   CDN
+      Color Denoise
+
+   CIF
+      Camera Interface
+
+   CPROC
+      Color Processing
+
+   CSC
+      Color Space Conversion
+
+   CSI
+      Camera Serial Interface
+
+   CSI-2
+      Camera Serial Interface 2
+
+   DMA
+      Direct Memory Access
+
+   DPC
+      Defective Pixel Correction
+
+   DPCC
+      Defective Pixel Cluster Correction
+
+   DPF
+      Denoise Pre-Filter
+
+   FB
+      Frame Buffer
+
+   FourCC
+      Four Character Code, abstract identifier that uniquely defines
+      a :term:`FB` pixel format.
+
+   GEQ
+      Green Equalisation
+
+   GSL
+      Gamma Sensor Linearization
+
+   GOC
+      Gamma Out Curve
+
+   HAL
+      Hardware Abstraction Layer
+
+   HDR
+      High Dynamic Range
+
+   IPA
+      Image Processing Algorithm
+
+   IPC
+      Inter-process communication
+
+   IPU3
+      Intel 3rd generation Image Processing Unit
+
+   ISP
+      Image Signal Processor
+
+   NLL
+      Noise Level Lookup
+
+   LSC
+      Lens Shading Correction
+
+   PDAF
+      Phase Detection Auto Focus
+
+   SDN
+      Spatial Denoise
+
+   TDN
+      Temporal Denoise
+
+   UVC
+      USB Video Class
+
+   V4L2
+      Video for Linux 2
+
+   VIMC
+      Virtual Media Controller
+
+   WBG
+      White Balance Gain
+
+   WDR
+      Wide Dynamic Range
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 8109b4295c92d722a2a215b97fd50af2f9babb9c..2eb0b894f1139d43389b2b450be003b054f6e335 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -21,6 +21,7 @@ 
 
    Contribute <contributing>
    Getting Started <getting-started>
+   Glossary <glossary>
    Camera Sensor Model <camera-sensor-model>
    IPA Writer's guide <guides/ipa>
    libcamera Architecture <libcamera_architecture>
diff --git a/Documentation/meson.build b/Documentation/meson.build
index 51899c19c1667c8ac07c6e7776e1faaa14915e20..158825e398c48f41fbfebe4b4ac7afecb1a5b2a2 100644
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -161,6 +161,7 @@  if sphinx.found()
         'guides/ipa.rst',
         'guides/pipeline-handler.rst',
         'guides/tracing.rst',
+        'glossary.rst',
         'index.rst',
         'internal-api/index.rst',
         'introduction.rst',