DOCSEARCHbyAlgolia
Submit Docs

gin

repository·master·Indexed 18 days ago

https://github.com/figbug/gin

A collection of C++ modules extending the JUCE framework for audio plugin and application development. It includes professional-grade utilities for DSP components, GUI elements, graphics processing, and networking. Key components include the AudioFilter library for State Variable Filter (SVF) implementations and the AVIR image resizing library featuring SIMD-optimized processing and Lanczos filtering.

Tokens
9.8K
Snippets
21
Records
44
Agent score
64%

What's inside gin

  1. Overview of Gin modules

    master

    Gin is organized into specialized modules. You can include only the ones required for your project to keep your binary lean.

    ModuleDescription
    ginCore utilities, file system watching, download manager, math utilities
    gin_3dBasic wireframe 3D rendering engine
    gin_controllersCross-platform game controller support (XInput / GameController / joydev)
    gin_dspAudio DSP components: oscillators, filters, effects, modulation
    gin_graphicsImage processing, effects, metadata, BMP format support
    gin_guiUI components, property editors, layout system, OpenStreetMap integration
    gin_locationGPS location services (macOS CoreLocation)
    gin_metadataImage metadata reading from JPEG, GIF, and PNG files
    gin_networkWebSocket, secure sockets
    gin_pluginAudio plugin utilities and common functionality
    gin_simdSIMD-optimized operations
    gin_standalonepluginStandalone audio plugin application wrapper
    gin_svgSVG parsing and rendering using NanoSVG
    gin_webpWebP image format support

  2. Overview of gin_plugin

    master
    The gin_plugin module provides shared generic tools, utilities, and UI classes specifically designed for use within plugins for the Gin framework. It is intended as a base library for plugin developers to maintain consistency and reuse common functionality.

  4. AVIR Library Compatibility and Implementation Notes

    master

    AVIR is a header-only (fully "inline") C++ library, meaning there are no source files to compile separately.

    Compatibility:

    • Compilers: Tested with GNU C++, Microsoft Visual C++, LLVM, and Intel C++.
    • Platforms: 32-bit and 64-bit Windows, macOS, and CentOS Linux.
    • Memory: The library has a modest memory footprint, but temporary image buffers scale proportionally with the input and output image sizes.

    Algorithm Behavior:

    • Identity Resizing (k=1): When no resizing is applied, the output is a very close copy of the source, but not an exact bit-for-bit match. This is because the image is low-pass filtered to reduce aliasing and then corrected by a final filter to maintain stable quality across all resizing factors.

  5. Understand Mbed TLS branch maintenance and versioning

    master

    Mbed TLS follows Semantic Versioning to manage releases and compatibility. Users should choose a branch based on their need for the latest features versus long-term stability:

    • main branch: Contains the latest releases and all current security fixes. Recommended for most users.
    • development branch: Used for preparing the next major version (e.g., version 4.0). This branch contains API changes that are incompatible with previous major versions (e.g., 3.x).
    • LTS (Long-Time Support) branches: These receive only bug fixes and security updates. They aim to maintain both API and ABI compatibility.
      • mbedtls-3.6: Supported until March 2027.
      • mbedtls-4.1: Supported until March 2029.
    • archive/ branches: Historical branches that do not receive updates.

    Recommendation: Always use the latest version of a maintained branch.

  6. Use the PSA Cryptography API in Mbed TLS

    master

    The PSA (Platform Security Architecture) Cryptography API provides a generic interface to cryptographic primitives. Mbed TLS includes an implementation of this API.

    Enabling PSA Support: To allow X.509 and TLS code to use PSA cryptography (instead of the built-in software implementation), you must activate the following compilation option in mbedtls_config.h:

    • MBEDTLS_USE_PSA_CRYPTO

    Note: TLS 1.3 uses PSA cryptography for most operations regardless of this option.

    PSA Drivers: Mbed TLS supports drivers for hardware accelerators, secure elements, and random generators. To use these, you typically need:

    1. MBEDTLS_USE_PSA_CRYPTO: To route X.509/TLS calls through PSA.
    2. MBEDTLS_PSA_CRYPTO_CONFIG: To enable PSA mechanisms without including the software implementation code (where supported).

  7. How AudioFilter works: Parameters vs. State

    master

    AudioFilter follows a design pattern that separates filter parameters from the processing state:

    1. Parameters: A set of values (frequency, gain, Q, etc.) defining the filter's characteristics. This is useful for stereo processing where both channels share the same parameter set.
    2. Processing Instance (State): Holds the current state of the filter (e.g., delay lines/memory) required to process audio samples.

    Processing is implemented using a State Variable Filter (SVF), which allows for lower parameter quantization and enables tuning filter parameters without causing audio glitches.

  8. Maintain API compatibility when upgrading Mbed TLS

    master

    Mbed TLS maintains API compatibility within the same major version. If your code is working with version x.y.z and does not rely on undocumented features, it should re-compile without modification for any later release x.y'.z' within the same major version.

    Important Constraints

    • Configuration: This guarantee only applies if you use the default compile-time configuration (mbedtls/mbedtls_config.h) or the exact same modified configuration. Changing configuration options can result in incompatible APIs or ABIs.
    • Security Exceptions: In rare cases where security conflicts with backwards compatibility (e.g., a cryptographic algorithm is found to be weak), security takes precedence, though a compatibility option may be provided.

    Common Non-Breaking Changes

    The following are considered minor updates and not API breaks:

    • Adding or reordering fields in a structure or union.
    • Removing a field from a structure (unless documented as public).
    • Adding items to an enum.
    • Returning new or changed error codes for specific conditions.
    • Changing a function's behavior from failing to succeeding as a feature extension.

  9. Security limitations of X.509 data processing

    master

    Mbed TLS does not strictly validate that X.509 objects (certificates, CSRs, and CRLs) are compliant with relevant standards. It assumes the signing party has performed this validation.

    Critical Warning: Mbed TLS is unsuitable for use in a Certificate Authority (CA) on its own. Do not use Mbed TLS to sign untrusted CSRs or CRLs unless you perform separate, explicit validation to ensure they are standards-compliant.

    Note that Mbed TLS does aim to protect against memory corruption and undefined behavior during the parsing of these objects; any undefined behavior triggered by parsing a CSR or certificate is considered a security vulnerability.

  10. Implement affine and non-linear transformations with AVIR

    master

    AVIR does not provide affine or non-linear transformations directly. However, because upscaling is fast, you can implement these transformations using a multi-step approach:

    1. Upsize the image (e.g., 4x to 8x) using AVIR.
    2. Apply the transformation via bilinear interpolation on the high-resolution buffer.
    3. Downsize the result back to the target size using AVIR.

    Note: For transformations that change proportions, apply the proportion change during the initial upsize step. This approach is memory-intensive but time-efficient and maintains high quality.

  11. Mitigate block cipher timing attacks in Mbed TLS

    master

    The pure software implementations of AES, CAMELLIA, ARIA, and DES in Mbed TLS use lookup tables that are vulnerable to timing attacks (physical, local, or remote), which can lead to key recovery.

    To mitigate these risks, use one of the following workarounds:

    1. Enable Hardware Acceleration: For AES, enable hardware acceleration if supported by your architecture. Use the following configuration options:
      • MBEDTLS_AESCE_C
      • MBEDTLS_AESNI_C
      • MBEDTLS_PADLOCK_C
    2. Use Alternative Implementations: Provide a secure alternative implementation (typically hardware acceleration) for the vulnerable cipher.
    3. Use Non-Block Cipher Mechanisms:
      • For authenticated encryption, use ChaCha20/Poly1305 instead of block cipher modes.
      • For random generation, use HMAC_DRBG instead of CTR_DRBG.

  12. Understand PSA Crypto key store backward compatibility

    master

    Mbed TLS maintains backward compatibility for PSA Crypto persistent storage (since version 2.25.0), provided the storage backend (PSA ITS implementation) is configured compatibly.

    • Within a major version: All Mbed TLS 3.y versions can read keys written by any Mbed TLS 3.x (where x <= y).
    • Cross-major version: Mbed TLS 3.x can read keys written by Mbed TLS 2.25.0 through 2.28.x LTS. However, upgrading from 2.x/3.x to 4.y may require an upgrade tool.
    • Drivers: Compatibility for the basic use of drivers is intended from Mbed TLS 2.28.0 onwards, but experimental parts of the driver interface (like driver state) do not currently guarantee backward compatibility.