1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
6<TITLE>AXFX_CHORUS_EXP/AXFX_CHORUS_EXP_DPL2</TITLE>
7<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
8<META http-equiv="Content-Style-Type" content="text/css">
9</head>
10
11<BODY>
12
13<H1 align="left">AXFX_CHORUS_EXP/AXFX_CHORUS_EXP_DPL2</H1>
14
15<H2>C Specification</H2>
16<BLOCKQUOTE>
17<PRE><CODE>
18#include &lt;revolution.h&gt;
19#include &lt;revolution/axfx.h&gt;
20
21/*----------------------------------------------*
22  For mono, stereo, surround
23 *----------------------------------------------*/
24
25typedef struct AXFX_BUS
26{
27    s32       *left;
28    s32       *right;
29    s32       *surround;
30
31} AXFX_BUS;
32
33typedef struct AXFX_CHORUS_EXP
34{
35    // do not touch these
36    AXFX_CHORUS_EXP_DELAY  delay;
37
38        (omitted)
39
40    u32        active;
41
42    // user parameters
43    f32        delayTime;   // 0.1 - 50.f (msec)
44    f32        depth;       // 0.f - 1.f
45    f32        rate;        // 0.1 - 2.f (Hz)
46    f32        feedback;    // 0.f - &lt; 1.f
47
48    AXFX_BUS  *busIn;
49    AXFX_BUS  *busOut;
50    f32        outGain;
51    f32        sendGain;
52
53} AXFX_CHORUS_EXP;
54
55/*----------------------------------------------*
56  For Dolby Pro Logic II
57 *----------------------------------------------*/
58
59typedef struct AXFX_BUS_DPL2
60{
61    s32       *L;
62    s32       *R;
63    s32       *Ls;
64    s32       *Rs;
65
66} AXFX_BUS_DPL2;
67
68typedef struct AXFX_CHORUS_EXP_DPL2
69{
70    // do not touch these
71    AXFX_CHORUS_EXP_DELAY_DPL2  delay;
72
73        (omitted)
74
75    u32        active;
76
77    // user parameters
78    f32        delayTime;   // 0.1 - 50.f (msec)
79    f32        depth;       // 0.f - 1.f
80    f32        rate;        // 0.1f - 2.f (Hz)
81    f32        feedback;    // 0.f - &lt; 1.f
82
83    AXFX_BUS_DPL2 *busIn;
84    AXFX_BUS_DPL2 *busOut;
85    f32        outGain;
86    f32        sendGain;
87
88} AXFX_CHORUS_EXP_DPL2;
89</CODE></PRE>
90</BLOCKQUOTE>
91
92<H2>Description</H2>
93<P>When using chorus expansion, you must assign appropriate values to the following parameters of the <code>AXFX_CHORUS_EXP</CODE> or <CODE>AXFX_CHORUS_EXP_DPL2</code> structure. Normally, the <code>AXFX_CHORUS_EXP</code> structure is used; the <code>AXFX_CHORUS_EXP_DPL2</code> structure is used with Dolby Pro Logic II.</P>
94
95<table border="1" >
96  <tbody>
97	<tr>
98	  <td width="120" align="center" bgcolor="#ffffe8"><STRONG><CODE><EM>delayTime</EM></CODE></STRONG></td>
99<td width="480">Length of the delay line (=standard delay time of input audio). Specify a value as 0.1 &lt;= <EM>value</EM> &lt;= 50.0 (in msec).</td>
100	</tr>
101	<tr>
102	  <td width="120" align="center" bgcolor="#ffffe8"><CODE><STRONG><EM>depth</EM></STRONG></CODE></td>
103<td width="480">Range over which the output position from the delay line (=delay time) is varied in time by the LFO. Specified as a proportion of <STRONG><CODE><EM>delayTime</EM></CODE></STRONG>; the value is in the range of 0.0 &lt;= <EM>value</EM> &lt;= 1.0.</td>
104	</tr>
105	<tr>
106	  <td width="120" align="center" bgcolor="#ffffe8"><CODE><STRONG><EM>rate</EM></STRONG></CODE></td>
107<td width="480">Frequency of LFO. Specify a value as 0.1 &lt;= <EM>value</EM> &lt;= 2.0 (in Hertz).</td>
108	</tr>
109	<tr>
110	  <td width="120" align="center" bgcolor="#ffffe8"><CODE><STRONG><EM>feedback</EM></STRONG></CODE></td>
111<td width="480">Feedback gain. Specify a value as 0.0 &lt;= <EM>value</EM> &lt; 1.0. This is mainly used to heighten the flanging effect when chorus is used as a flanger. (It produces the powerful swell of sound called &quot;jet plane&quot; sound.) It is also possible to use this as a characteristic delay effect by setting a somewhat longer delay time.</td>
112	</tr>
113	<tr>
114	  <td width="120" align="center" bgcolor="#ffffe8"><STRONG><CODE><EM>busIn</EM></CODE></STRONG></td>
115<td width="480">Specifies the input buffer for effect bus sends.</td>
116	</tr>
117	<tr>
118	  <td width="120" align="center" bgcolor="#ffffe8"><STRONG><CODE><EM>busOut</EM></CODE></STRONG></td>
119<td width="480">Specifies the output buffer for effect bus sends.</td>
120	</tr>
121	<tr>
122	  <td width="120" align="center" bgcolor="#ffffe8"><CODE><STRONG><EM>outGain</EM></STRONG></CODE></td>
123<td width="480">Output gain. Specify a value as 0.0 &lt;= <EM>value</EM> &lt;= 1.0.</td>
124	</tr>
125	<tr>
126	  <td width="120" align="center" bgcolor="#ffffe8"><STRONG><CODE><EM>sendGain</EM></CODE></STRONG></td>
127<td width="480">Send gain to the next-level effect bus. Specify a value as 0.0 &lt;= <EM>value</EM> &lt;= 1.0.</td>
128	</tr>
129  </tbody>
130</table>
131
132<H2>Revision History</H2>
133<P>
1342007/08/07 Initial version.<br>
135</P>
136
137<hr><p>CONFIDENTIAL</p></body>
138</HTML>
139