02739194a858b799752f06dca40e36b8aade1bae
[xonotic/xonotic-data.pk3dir.git] / qcsrc / client / bgmscript.qc
1 #include "bgmscript.qh"
2
3 #include <common/util.qh>
4 #include <client/autocvars.qh>
5 #include <client/defs.qh>
6 #include <client/main.qh>
7
8 #define CONSTANT_SPEED_DECAY
9
10 float bgmscriptbuf;
11 float bgmscriptbufsize;
12 float bgmscriptbufloaded;
13
14 classfield(BGMScript) .float bgmscriptline;
15 classfield(BGMScript) .float bgmscriptline0;
16 classfield(BGMScript) .float bgmscriptvolume;
17 classfield(BGMScript) .float bgmscripttime;
18 classfield(BGMScript) .float bgmscriptstate;
19 classfield(BGMScript) .float bgmscriptstatetime;
20
21 float GetAttackDecaySustainAmplitude(float a, float d, float s, float t)
22 {
23         // phase:
24         //   attack: from 0 to 1, in time a for a full length
25         //   decay: from 1 to s, in time d
26         //   sustain: s
27
28         if(t < 0)
29                 return 0;
30
31         if(a)
32                 if(t <= a)
33                         return t / a;
34
35         if(d)
36                 if(t <= a + d)
37                         return ((t - a) / d) * (s - 1) + 1;
38
39         return s;
40 }
41
42 float GetReleaseAmplitude(float d, float s, float r, float t)
43 {
44         float decayval, releaseval;
45
46         if(!r)
47                 return 0;
48
49         if(t > r)
50                 return 0;
51
52         releaseval = s * (1 - t / r);
53
54         if(t < -d)
55                 return 1;
56
57         if(t < 0 && t >= -d)
58         {
59                 // pre-time decay
60                 // value is s at time  0
61                 //          1 at time -d
62                 decayval = ((t + d) / d) * (s - 1) + 1;
63                 return max(decayval, releaseval);
64         }
65
66         return releaseval;
67 }
68
69 float GetAttackTime(float a, float amp)
70 {
71         return amp * a;
72 }
73
74 float GetReleaseTime(float d, float s, float r, float amp)
75 {
76         float decaytime, releasetime;
77
78         if(!s)
79                 return 0;
80
81         // if amp > s, we may be in the attack or in the prolonged decay curve
82         releasetime = (1 - amp / s) * r;
83
84         if(amp > s)
85         {
86                 if(s == 1) // gracefully handle division by zero here
87                         return 0;
88
89                 // pre-time decay
90                 // value is s at time  0
91                 //          1 at time -d
92                 decaytime = (amp - 1) / (s - 1) * d - d;
93                 return max(decaytime, releasetime);
94         }
95
96         return releasetime;
97 }
98
99 void BGMScript_Init()
100 {
101         string s;
102         float fh;
103         bgmscriptbuf = bgmscriptbufsize = 0;
104         bgmscriptbufloaded = 1;
105         s = strcat("maps/", mi_shortname, ".bgs");
106         fh = fopen(s, FILE_READ);
107         if(fh < 0)
108                 return;
109         bgmscriptbuf = buf_create();
110         while((s = fgets(fh)))
111         {
112                 bufstr_set(bgmscriptbuf, bgmscriptbufsize, s);
113                 ++bgmscriptbufsize;
114         }
115         fclose(fh);
116 }
117
118 void BGMScript_InitEntity(entity e)
119 {
120         float l;
121         string m;
122         if(e.bgmscript != "")
123         {
124                 if(!bgmscriptbufloaded)
125                         BGMScript_Init();
126
127                 float i;
128
129                 m = strcat(e.bgmscript, " ");
130                 l = strlen(m);
131
132                 e.bgmscriptline0 = -1;
133                 for(i = 0; i < bgmscriptbufsize; ++i)
134                 {
135                         if(substring(bufstr_get(bgmscriptbuf, i), 0, l) == m)
136                                 break;
137                 }
138                 e.bgmscriptline = e.bgmscriptline0 = i;
139                 if(i >= bgmscriptbufsize)
140                 {
141                         LOG_INFOF("ERROR: bgmscript does not define %s", e.bgmscript);
142                         strfree(e.bgmscript);
143                 }
144         }
145 }
146
147 float GetCurrentAmplitude(entity e, float trel)
148 {
149         if(e.bgmscriptstate)
150                 return GetAttackDecaySustainAmplitude(e.bgmscriptattack, e.bgmscriptdecay, e.bgmscriptsustain, trel) * e.bgmscriptvolume;
151         else
152         {
153 #ifdef CONSTANT_SPEED_DECAY
154                 return GetReleaseAmplitude(e.bgmscriptdecay, e.bgmscriptsustain * e.bgmscriptvolume, e.bgmscriptrelease, trel);
155 #else
156                 return GetReleaseAmplitude(e.bgmscriptdecay, e.bgmscriptsustain, e.bgmscriptrelease, trel) * e.bgmscriptvolume;
157 #endif
158         }
159 }
160
161 float GetTimeForAmplitude(entity e, float amp)
162 {
163         if(e.bgmscriptstate)
164                 return GetAttackTime(e.bgmscriptattack, amp / e.bgmscriptvolume);
165         else
166         {
167 #ifdef CONSTANT_SPEED_DECAY
168                 return GetReleaseTime(e.bgmscriptdecay, e.bgmscriptsustain * e.bgmscriptvolume, e.bgmscriptrelease, amp);
169 #else
170                 return GetReleaseTime(e.bgmscriptdecay, e.bgmscriptsustain, e.bgmscriptrelease, amp / e.bgmscriptvolume);
171 #endif
172         }
173 }
174
175 float doBGMScript(entity e)
176 {
177         float amp, vel;
178
179         if(e.bgmscript == "")
180                 return 1;
181
182         if(autocvar_bgmvolume <= 0)
183                 return -1;
184
185         e.just_toggled = false;
186
187         if(bgmtime < 0)
188                 return -1;
189
190         if(bgmtime < e.bgmscripttime)
191         {
192                 amp = GetCurrentAmplitude(e, e.bgmscripttime - e.bgmscriptstatetime + drawframetime);
193
194                 e.bgmscriptline = e.bgmscriptline0;
195                 e.bgmscripttime = bgmtime;
196
197                 // treat this as a stop event for all notes, to prevent sticking keys
198                 e.bgmscriptstate = false;
199                 e.bgmscriptvolume = 1;
200                 e.bgmscriptstatetime = bgmtime - GetTimeForAmplitude(e, amp);
201         }
202
203         // find the CURRENT line
204         for (;;)
205         {
206                 tokenize_console(bufstr_get(bgmscriptbuf, e.bgmscriptline));
207                 if(stof(argv(1)) >= bgmtime || argv(0) != e.bgmscript)
208                 {
209                         e.bgmscripttime = bgmtime;
210                         return GetCurrentAmplitude(e, bgmtime - e.bgmscriptstatetime);
211                 }
212                 else if(bgmtime >= stof(argv(1)))
213                 {
214                         e.bgmscriptline += 1;
215                         e.bgmscripttime = stof(argv(1));
216
217                         amp = GetCurrentAmplitude(e, e.bgmscripttime - e.bgmscriptstatetime);
218
219                         // time code reached!
220                         vel = stof(argv(2));
221                         if(vel > 0)
222                         {
223                                 e.just_toggled = e.bgmscriptstate = true;
224                                 e.bgmscriptvolume = vel;
225                         }
226                         else
227                                 e.just_toggled = e.bgmscriptstate = false;
228
229                         e.bgmscriptstatetime = e.bgmscripttime - GetTimeForAmplitude(e, amp);
230                 }
231         }
232 }
233