diff --git a/README.md b/README.md index 41742c1e..3de69438 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,10 @@ Cavern is a fully adaptive object-based audio engine and upmixer without limitat * Unity-like listener and source functionality * Ultra low latency, even the upconverter can work from as low as one sample per frame -## Helpful documents -* [Calibration process](./docs/Calibration%20process.md) for traditional or Cavern-only rooms -* [Cavern DCP channel order](./docs/Cavern%20DCP%20channel%20order.md) compared to DCP standards -* [Limitless Audio Format](./docs/Limitless%20Audio%20Format.md) for storing Cavern mixes in a CPU-effective spatial format -* [Virtualizer repository](https://github.com/VoidXH/HRTF) which contains the raw IR measurements and detailed information about their use +## User documentation +User documentation can be found at the [Cavern documentation webpage](http://cavern.sbence.hu/cavern/doc.php). +Please go to this page for basic setup, in-depth QuickEQ tutorials, and +command-line arguments. ## How to build ### Cavern @@ -31,6 +30,16 @@ the CavernUnity DLL project to UnityEngine and UnityEditor. Add these files from your own Unity installation as references. They are found in Editor\Data\Managed under Unity's installation folder. +### Cavernize Lite +This is a Code::Blocks project, set up for the MingW compiler. No additional +libraries were used, this is standard C++ code, so importing just the .cpp and +.h files into any IDE will work perfectly. + +## Development documents +* [Cavern DCP channel order](./docs/Cavern%20DCP%20channel%20order.md) compared to DCP standards +* [Limitless Audio Format](./docs/Limitless%20Audio%20Format.md) for storing Cavern mixes in a CPU-effective spatial format +* [Virtualizer repository](https://github.com/VoidXH/HRTF) which contains the raw IR measurements and detailed information about their use + ## Disclaimers ### Code Cavern is a performance software written in an environment that's not ready for diff --git a/docs/Calibration process.md b/docs/Calibration process.md deleted file mode 100644 index 65321f69..00000000 --- a/docs/Calibration process.md +++ /dev/null @@ -1,42 +0,0 @@ -# Cavern calibration process -Cavern's exact calibration process depends on the system it's used on. However, -using pink noise for frequency analysis is strongly discouraged, as the error -margin is too large. A full range frequency sweep for measurement, and a -linear-phase parametric EQ instead of a third-octave one should be used for -calibration. - -## Regular theatres and studios -These are the recommended settings for Cavern DCP creation and playback. The -center of the microphone placement should be at 2/3 of the room from the screen, -in the center. The correct microphone aligment is behind a seat, but at least -the size of the microphone higher than the top of the seat, facing upwards. The -room should be equalized to the X-curve (-3 dB/octave above 2 kHz), at the -following peak sound pressure levels. - -### Peak channel sound pressure levels (-20 dB FS) -In regular theatres, Cavern-ready systems, even with custom layouts, must match -the standard levels. - -| Channel | Level | -|-----------------------------------------------------|:-----------:| -| Screen channels (max. 45° from center on both axes) | 85 dB | -| Low frequency effect channels | 95 dB | -| All other channels | 82 dB | - -## Cavern theatres and studios -For Cavern-only content creation and playback, the channels can only be -calibrated with a linear-phase parametric EQ, based off a frequency sweep -reading with at least 7 microphones positioned around the reference listening -position, to a flat response with the error margin of 0.2 dB between 100 Hz and -16 kHz (25 to 120 Hz for LFE channels). The use of Cavern QuickEQ for -measurement and configuration file generation is hardly recommended. - -### Peak channel sound pressure levels (-20 dB FS) -For a Cavern theatre, each individual channel must be capable of outputting 105 -dB SPL at the center of calibration. The channel array peak is also the same, it -must be enforced in the content creation process by the authoring tools. - -| Channel | Level | -|-----------------------------------------------------|:-----------:| -| Full range channels | 85 dB | -| Low frequency effect channels | 95 dB | \ No newline at end of file