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>Syntax</H2>
16<dl><dd><pre class="construction">
17#include &lt;revolution.h&gt;
18#include &lt;revolution/axfx.h&gt;
19
20/*----------------------------------------------*
21    For mono, stereo, surround
22 *----------------------------------------------*/
23
24typedef struct AXFX_BUS
25{
26    s32       *left;
27    s32       *right;
28    s32       *surround;
29
30} AXFX_BUS;
31
32typedef struct AXFX_CHORUS_EXP
33{
34    // don't touch these
35    AXFX_CHORUS_EXP_DELAY  delay;
36
37       (omitted)
38
39    u32        active;
40
41    // user parameters
42    f32        delayTime;   // 0.1 - 50.f (msec)
43    f32        depth;       // 0.f - 1.f
44    f32        rate;        // 0.1 - 2.f (Hz)
45    f32        feedback;    // 0.f - &lt; 1.f
46
47    AXFX_BUS  *busIn;
48    AXFX_BUS  *busOut;
49    f32        outGain;
50    f32        sendGain;
51
52} AXFX_CHORUS_EXP;
53
54/*----------------------------------------------*
55    For Dolby Pro Logic II
56 *----------------------------------------------*/
57
58typedef struct AXFX_BUS_DPL2
59{
60    s32       *L;
61    s32       *R;
62    s32       *Ls;
63    s32       *Rs;
64
65} AXFX_BUS_DPL2;
66
67typedef struct AXFX_CHORUS_EXP_DPL2
68{
69    // don't touch these
70    AXFX_CHORUS_EXP_DELAY_DPL2  delay;
71
72       (omitted)
73
74    u32        active;
75
76    // user parameters
77    f32        delayTime;   // 0.1 - 50.f (msec)
78    f32        depth;       // 0.f - 1.f
79    f32        rate;        // 0.1f - 2.f (Hz)
80    f32        feedback;    // 0.f - &lt; 1.f
81
82    AXFX_BUS_DPL2 *busIn;
83    AXFX_BUS_DPL2 *busOut;
84    f32        outGain;
85    f32        sendGain;
86
87} AXFX_CHORUS_EXP_DPL2;
88</pre></dd></dl>
89
90<h2>Elements</h2>
91<TABLE class="arguments" border="1" >
92  <tr>
93<TH><STRONG><CODE><EM>delayTime</EM></CODE></STRONG></TH>
94<TD>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>
95  </tr>
96  <tr>
97<TH><CODE><STRONG><EM>depth</EM></STRONG></CODE></TH>
98<TD>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>
99  </tr>
100  <tr>
101<TH><CODE><STRONG><EM>rate</EM></STRONG></CODE></TH>
102<TD>Frequency of LFO. Specify a value as 0.1 &lt;= <EM>value</EM> &lt;= 2.0 (in Hertz).</TD>
103  </tr>
104  <tr>
105<TH><CODE><STRONG><EM>feedback</EM></STRONG></CODE></TH>
106<TD>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>
107  </tr>
108  <tr>
109<TH><STRONG><CODE><EM>busIn</EM></CODE></STRONG></TH>
110<TD>Specifies the input buffer for effect bus sends.</TD>
111  </tr>
112  <tr>
113<TH><STRONG><CODE><EM>busOut</EM></CODE></STRONG></TH>
114<TD>Specifies the output buffer for effect bus sends.</TD>
115  </tr>
116  <tr>
117<TH><CODE><STRONG><EM>outGain</EM></STRONG></CODE></TH>
118<TD>Output gain. Specify a value as 0.0 &lt;= <EM>value</EM> &lt;= 1.0.</TD>
119  </tr>
120  <tr>
121<TH><STRONG><CODE><EM>sendGain</EM></CODE></STRONG></TH>
122<TD>Send gain to the next-level effect bus. Specify a value as 0.0 &lt;= <EM>value</EM> &lt;= 1.0.</TD>
123  </tr>
124</table>
125
126<H2>Description</H2>
127<P>When using Chorus Expansion, you must assign appropriate values to the various 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>
128
129<H2>See Also</H2>
130<P class="reference">
131</P>
132
133<H2>Revision History</H2>
134<P>
1352007/08/07 Initial version.<br>
136</P>
137
138<hr><p>CONFIDENTIAL</p></body>
139</HTML>
140