Giter VIP home page Giter VIP logo

qs's Introduction

QS

QS is a library for encoding and decoding audio in Quadraphonic Sound (Regular Matrix). The library is the core of QUARK, a DAW plugin for quadraphonic spatial audio production. QUARK is made possible by dublab and the National Endowment for the Arts.

Usage

While the project currently relies on JUCE structures, but we hope to make this usable outside of JUCE in the future. For now and simplicity, JUCE is the way.

As a CMake Package

Clone and install the CMake package:

$ git clone https://github.com/quarkquad/qs.git qs
$ cd qs
$ cmake -B build-install -DCMAKE_INSTALL_PREFIX="..."
$ cmake --build build-install --target install

Add the following to your CMakeLists.txt:

find_package(JUCE CONFIG REQUIRED)
find_package(QS CONFIG REQUIRED)

target_link_libraries(MyPlugin
    PRIVATE
    juce::juce_audio_utils
    juce::juce_dsp
    quark::qs
)

As a Project Subdirectory

Clone this repository as a subdirectory in your JUCE project:

$ git clone https://github.com/quarkquad/qs.git qs

Then add the following to your CMakeLists.txt:

add_subdirectory(JUCE)
add_subdirectory(qs)

target_link_libraries(MyTarget
    PRIVATE
    juce::juce_audio_utils
    juce::juce_dsp
    quark::qs
)

You can find a few JUCE plugin examples in the examples/ directory.

Encoding

QS provides a static encoder that encodes 4 input channels into 2 output channels. The channels layout is as follows:

┌────────────┬────────────┬────────────┬────────────┐
│ Front Left │Front Right │ Rear Left  │ Rear Right │
│     0      │     1      │     2      │     3      │
└─────┬──────┴─────┬──────┴─────┬──────┴─────┬──────┘
      │            │            │            │       
┌─────▼────────────▼────────────▼────────────▼──────┐
│                                                   │
│                   Encoder (4-2)                   │
│                                                   │
└──────────────────┬────────────┬───────────────────┘
                   │            │                    
             ┌─────▼──────┬─────▼──────┐             
             │ Total Left │Total Right │             
             │     0      │     1      │             
             └────────────┴────────────┘

Decoding

QS provides an active multiband decoder modeled after the Sansui Vario-Matrix decoding process and QSD-1 hardware decoder. The QSD-1 was a tri-band decoder that processed high, mid and low frequencies independently. While simplistic, the result is musical and convincing.

The channels layout is as follows:

             ┌────────────┬────────────┐             
             │ Total Left │Total Right │             
             │     0      │     1      │             
             └─────┬──────┴─────┬──────┘             
                   │            │                    
┌──────────────────▼────────────▼───────────────────┐
│                                                   │
│                   Decoder (2-4)                   │
│                                                   │
└──────┬───────────┬────────────┬────────────┬──────┘
       │           │            │            │       
┌──────▼─────┬─────▼──────┬─────▼──────┬─────▼──────┐
│ Front Left │Front Right │ Rear Left  │ Rear Right │
│     0      │     1      │     2      │     3      │
└────────────┴────────────┴────────────┴────────────┘

The frequency bands are produced by passing the input through a second-order Butterworth filter. Coefficients for the filters are provided at initialization time. Coefficients are quantized between sample rates so it's recommended to calculate coefficients for 48kHz.

The active control logic behavior can be tuned by adjusting envelope timings, comparision width and gain of each frequency band.

Generating Filter Coefficients

To calculate coefficients for the MultiBandDecoder you can use script/coefficients/generate utility. First construct a Python venv so you can install some dependencies.

$ python3 -m venv coeffs-venv 
$ coeffs-venv/bin/
$ source coeffs-venv/bin/activate
(coeffs-venv) $ pip3 install -r script/coefficients/requirements.txt

Now run the script to generate coefficients. It accepts a list of band-stops and produces coefficients each band.

(coeffs-venv) $ script/coefficients/generate --stops 1000
1000.0 [[0.003916126660547369, 0.007832253321094738, 0.003916126660547369, 1.0, -1.815341082704568, 0.8310055893467575]]
1000.0 [[0.9115866680128315, -1.823173336025663, 0.9115866680128315, 1.0, -1.815341082704568, 0.8310055893467575]]

We've calculated coefficients for a dual-band decoder with a cross-over point of 1kHz. The bands are a lowpass at 1kHz and a highpass at 1kHz.

Need more bands? Add more stops:

(coeffs-venv) $ script/coefficients/generate --stops 1000 4000
1000.0 [[0.003916126660547369, 0.007832253321094738, 0.003916126660547369, 1.0, -1.815341082704568, 0.8310055893467575]]
1000.0 4000.0 [[0.029954582208092474, 0.059909164416185004, 0.029954582208092526, 1.0, -1.4835932220566492, 0.6582736235325576], [1.0, -2.000000000000001, 1.0000000000000009, 1.0, -1.851415359120339, 0.8720718779575456]]
4000.0 [[0.6893061687675816, -1.378612337535163, 0.6893061687675816, 1.0, -1.2796324249978086, 0.477592250072517]]

Here we've calculated coefficients for a tri-band decoder with stops at 1kHz and 4kHz. The bands have the following shape: lowpass at 1kHz, bandpass between 1Hz and 4kHz, highpass at 4kHz.

The script/coefficients/generate accepts a --plot flag to visualize the filters.

Related Research

qs's People

Contributors

brettbuddin avatar

Stargazers

Ben Brown avatar Akhil Nistala avatar Matthew Heidemann avatar George avatar Pete Davids avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.