Add docs for OpenAL Soft and standard decoder presets

5 files changed, 220 insertions, 0 deletions

diff --git a/presets/3D7.1.ambdec b/presets/3D7.1.ambdec
new file mode 100644
index 00000000..42b6a0bb
--- /dev/null
+++ b/presets/3D7.1.ambdec
@@ -0,0 +1,43 @@
+# AmbDec configuration
+# Written by Ambisonic Decoder Toolbox, version 8.0
+
+/description     3D7_2h1v_allrad_5200_rE_max_1_band
+
+/version         	3
+
+/dec/chan_mask   	1bf
+/dec/freq_bands  	1
+/dec/speakers    	7
+/dec/coeff_scale 	fuma
+
+/opt/input_scale  	fuma
+/opt/nfeff_comp   	output
+/opt/delay_comp   	on
+/opt/level_comp   	on
+/opt/xover_freq   	400.000000
+/opt/xover_ratio  	0.000000
+
+/speakers/{
+#           id     dist          azim       elev     conn
+#-----------------------------------------------------------------------
+add_spkr 	LF	 1.500000	  51.000000	 24.000000
+add_spkr 	RF	 1.500000	 -51.000000	 24.000000
+add_spkr 	CE	 1.500000	   0.000000	  0.000000
+add_spkr 	LB	 1.500000	 180.000000	 55.000000
+add_spkr 	RB	 1.500000	   0.000000	-55.000000
+add_spkr 	LS	 1.500000	 129.000000	-24.000000
+add_spkr 	RS	 1.500000	-129.000000	-24.000000
+/}
+
+/matrix/{
+order_gain	1.000000	0.774597	0.400000	0.000000
+add_row 	 0.325031	 0.357638	 0.206500	 0.234037	 0.202440	 0.135692	 0.116927	-0.098768
+add_row 	 0.325036	-0.357619	 0.206537	 0.234033	-0.202427	-0.135680	 0.116934	-0.098768
+add_row 	 0.080073	-0.000010	-0.000296	 0.155843	-0.000016	-0.000011	-0.000623	 0.163306
+add_row 	 0.353556	 0.000002	 0.408453	-0.288377	-0.000004	-0.000003	-0.221039	 0.077297
+add_row 	 0.325297	 0.000008	-0.414018	 0.232789	 0.000004	 0.000003	-0.232940	 0.018311
+add_row 	 0.353558	 0.352704	-0.203542	-0.290124	-0.191868	-0.134582	 0.110616	-0.038294
+add_row 	 0.353556	-0.352691	-0.203576	-0.290115	 0.191871	 0.134585	 0.110612	-0.038293
+/}
+
+/end
diff --git a/presets/hexagon.ambdec b/presets/hexagon.ambdec
new file mode 100644
index 00000000..d45f2732
--- /dev/null
+++ b/presets/hexagon.ambdec
@@ -0,0 +1,51 @@
+# AmbDec configuration
+# Written by Ambisonic Decoder Toolbox, version 8.0
+
+/description     Hexagon_2h0p_pinv_match_rV_max_rE_2_band
+
+/version         	3
+
+/dec/chan_mask   	11b
+/dec/freq_bands  	2
+/dec/speakers    	6
+/dec/coeff_scale 	fuma
+
+/opt/input_scale  	fuma
+/opt/nfeff_comp   	input
+/opt/delay_comp   	on
+/opt/level_comp   	on
+/opt/xover_freq   	400.000000
+/opt/xover_ratio  	0.000000
+
+/speakers/{
+#            id      dist     azim     elev     conn
+#-----------------------------------------------------------------------
+add_spkr 	LF	 1.000000	 30.000000	 0.000000
+add_spkr 	RF	 1.000000	-30.000000	 0.000000
+add_spkr 	RS	 1.000000	-90.000000	 0.000000
+add_spkr 	RB	 1.000000	-150.000000	 0.000000
+add_spkr 	LB	 1.000000	 150.000000	 0.000000
+add_spkr 	LS	 1.000000	 90.000000	 0.000000
+/}
+
+/lfmatrix/{
+order_gain	1.000000	1.000000	1.000000	0.000000
+add_row 	 0.235702	 0.166667	 0.288675	 0.288675	 0.166667
+add_row 	 0.235702	-0.166667	 0.288675	-0.288675	 0.166667
+add_row 	 0.235702	-0.333333	 0.000000	-0.000000	-0.333333
+add_row 	 0.235702	-0.166667	-0.288675	 0.288675	 0.166667
+add_row 	 0.235702	 0.166667	-0.288675	-0.288675	 0.166667
+add_row 	 0.235702	 0.333333	 0.000000	-0.000000	-0.333333
+/}
+
+/hfmatrix/{
+order_gain	1.414214	1.224745	0.707107	0.000000
+add_row 	 0.235702	 0.166667	 0.288675	 0.288675	 0.166667
+add_row 	 0.235702	-0.166667	 0.288675	-0.288675	 0.166667
+add_row 	 0.235702	-0.333333	 0.000000	-0.000000	-0.333333
+add_row 	 0.235702	-0.166667	-0.288675	 0.288675	 0.166667
+add_row 	 0.235702	 0.166667	-0.288675	-0.288675	 0.166667
+add_row 	 0.235702	 0.333333	 0.000000	-0.000000	-0.333333
+/}
+
+/end
diff --git a/presets/presets.txt b/presets/presets.txt
new file mode 100644
index 00000000..fcc8128f
--- /dev/null
+++ b/presets/presets.txt
@@ -0,0 +1,36 @@
+Ambisonic decoder configuration presets are provided here for common surround
+sound speaker layouts. The presets are prepared to work with OpenAL Soft's high
+quality decoder. By default all of the speaker distances within a preset are
+set to the same value, which results in no effect from distance compensation.
+If this doesn't match your physical speaker setup, it may be worth copying the
+preset and modifying the distance values to match (note that modifying the
+azimuth and elevation values in the presets will not have any effect; the
+specified angles do not change the decoder behavior).
+
+Details of the individual presets are as follows.
+
+square.ambdec
+Specifies a basic square speaker setup for Quadrophonic output, with identical
+width and depth. Front speakers are placed at +45 and -45 degrees, and back
+speakers are placed at +135 and -135 degrees.
+
+rectangle.ambdec
+Specifies a narrower speaker setup for Quadrophonic output, with a little less
+width but a little more depth over a basic square setup. Front speakers are
+placed at +30 and -30 degrees, providing a bit more compatibility for existing
+stereo content, with back speakers at +150 and -150 degrees.
+
+hexagon.ambdec
+Specifies a flat-front hexagonal speaker setup for 7.1 Surround output. The
+front left and right speakers are placed at +30 and -30 degrees, the side
+speakers are placed at +90 and -90 degrees, and the back speakers are placed at
++150 and -150 degrees. Although this is for 7.1 output, no front-center speaker
+is defined for the decoder, meaning that speaker will be silent for 3D sound
+(however it may still be used with AL_SOFT_direct_channels or ALC_EXT_DEDICATED
+output). A "proper" 7.1 decoder may be provided in the future, but due to the
+nature of the speaker configuration will have trade-offs.
+
+3D7.1.ambdec
+Specifies a 3D7.1 speaker setup for 7.1 Surround output. Although it's for 7.1
+output, the speakers for such a configuration need to be placed in different
+positions for proper results. Please see docs/3D7.1.txt for more information.
diff --git a/presets/rectangle.ambdec b/presets/rectangle.ambdec
new file mode 100644
index 00000000..caf72318
--- /dev/null
+++ b/presets/rectangle.ambdec
@@ -0,0 +1,45 @@
+# AmbDec configuration
+# Written by Ambisonic Decoder Toolbox, version 8.0
+
+/description     Rectangle_1h0p_pinv_match_rV_max_rE_2_band
+
+/version         	3
+
+/dec/chan_mask   	b
+/dec/freq_bands  	2
+/dec/speakers    	4
+/dec/coeff_scale 	fuma
+
+/opt/input_scale  	fuma
+/opt/nfeff_comp   	input
+/opt/delay_comp   	on
+/opt/level_comp   	on
+/opt/xover_freq   	400.000000
+/opt/xover_ratio  	0.000000
+
+/speakers/{
+#            id      dist     azim     elev     conn
+#-----------------------------------------------------------------------
+add_spkr 	LF	 1.000000	 30.000000	 0.000000
+add_spkr 	RF	 1.000000	-30.000000	 0.000000
+add_spkr 	RB	 1.000000	-150.000000	 0.000000
+add_spkr 	LB	 1.000000	 150.000000	 0.000000
+/}
+
+/lfmatrix/{
+order_gain	1.000000	1.000000	0.000000	0.000000
+add_row 	 0.353553	 0.500000	 0.288675
+add_row 	 0.353553	-0.500000	 0.288675
+add_row 	 0.353553	-0.500000	-0.288675
+add_row 	 0.353553	 0.500000	-0.288675
+/}
+
+/hfmatrix/{
+order_gain	1.414214	1.000000	0.000000	0.000000
+add_row 	 0.353553	 0.500000	 0.288675
+add_row 	 0.353553	-0.500000	 0.288675
+add_row 	 0.353553	-0.500000	-0.288675
+add_row 	 0.353553	 0.500000	-0.288675
+/}
+
+/end
diff --git a/presets/square.ambdec b/presets/square.ambdec
new file mode 100644
index 00000000..547ed367
--- /dev/null
+++ b/presets/square.ambdec
@@ -0,0 +1,45 @@
+# AmbDec configuration
+# Written by Ambisonic Decoder Toolbox, version 8.0
+
+/description     Square_1h0p_pinv_match_rV_max_rE_2_band
+
+/version         	3
+
+/dec/chan_mask   	b
+/dec/freq_bands  	2
+/dec/speakers    	4
+/dec/coeff_scale 	fuma
+
+/opt/input_scale  	fuma
+/opt/nfeff_comp   	input
+/opt/delay_comp   	on
+/opt/level_comp   	on
+/opt/xover_freq   	400.000000
+/opt/xover_ratio  	0.000000
+
+/speakers/{
+#            id      dist     azim     elev     conn
+#-----------------------------------------------------------------------
+add_spkr 	LF	 1.000000	 45.000000	 0.000000
+add_spkr 	RF	 1.000000	-45.000000	 0.000000
+add_spkr 	RB	 1.000000	-135.000000	 0.000000
+add_spkr 	LB	 1.000000	 135.000000	 0.000000
+/}
+
+/lfmatrix/{
+order_gain	1.000000	1.000000	0.000000	0.000000
+add_row 	 0.353553	 0.353553	 0.353553
+add_row 	 0.353553	-0.353553	 0.353553
+add_row 	 0.353553	-0.353553	-0.353553
+add_row 	 0.353553	 0.353553	-0.353553
+/}
+
+/hfmatrix/{
+order_gain	1.414214	1.000000	0.000000	0.000000
+add_row 	 0.353553	 0.353553	 0.353553
+add_row 	 0.353553	-0.353553	 0.353553
+add_row 	 0.353553	-0.353553	-0.353553
+add_row 	 0.353553	 0.353553	-0.353553
+/}
+
+/end