Skip to content

Commit ba974c8

Browse files
author
Jonas Rinke
committed
Fixed typos
1 parent 8c58027 commit ba974c8

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Emulator for the expansion sound of the Konami VRC7.
66

77
VRC7-Sound is an open-source emulator for the Konami VRC7's expansion sound, featured in the Famicom game *Lagrange Point*.
88
The VRC7 enables FM-style music through the use of a modified Yamaha YM2413 (OPLL) architecture, which is itself based on the
9-
YM3812, a chip prominently used in the AdLib and Sound Blaster soundcards. The emulator attempts to accurately recreate this sound
10-
by relying mostly on information gathered from the VRC7's die shot.
9+
YM3812, a chip prominently used in the AdLib and Sound Blaster soundcards. The emulator attempts to recreate this sound as accurately
10+
as possible by relying mostly on information gathered from the VRC7's die shot.
1111

1212
## Usage
1313

VRC7-sound/vrc7_sound.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ enum env_stages {
127127
ENV_DAMPING //trigger off
128128
};
129129

130+
//Lookup tables
130131
static uint32_t logsin[LOGSIN_TABLE_LEN];
131132

132133
static uint16_t fast_exp[FAST_EXP_TABLE_LEN];
@@ -163,7 +164,6 @@ static void make_tables(void) {
163164
}
164165

165166
static inline uint32_t phase_to_logsin(uint32_t phase) {
166-
//phase ^= 1; //TODO check?
167167
if (BIT_TEST(phase, 8))
168168
phase = ~phase;
169169
return logsin[phase & 0xff];
@@ -340,7 +340,7 @@ static void update_envelope(struct vrc7_sound *vrc7_s, uint32_t ch,uint32_t type
340340
if (rate_high == 15 || rate_high == 14 && env_table)
341341
env_inc |= inc1;
342342

343-
//Update the envelope value in a weird way
343+
//Update envelope value
344344
uint32_t env_value = (slot->env_value + env_inc) & 0x7f;
345345

346346
//Update envelope stage

VRC7-sound/vrc7_sound.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ VRC7SOUND_API void vrc7_set_clock_rate(struct vrc7_sound *vrc7_s, double clock_r
211211

212212
/*
213213
Sets the sample rate of the vrc7_sound object. This function only has an effect if you are using vrc7_fetch_sample. This is not to be
214-
confused with the sample rate of the signal member of the vrc7_sound object which is set by vrc7_set_clock_rate.
214+
confused with the sample rate of the signal variable of the vrc7_sound object which is set by vrc7_set_clock_rate.
215215
*/
216216
VRC7SOUND_API void vrc7_set_sample_rate(struct vrc7_sound *vrc7_s, double sample_rate);
217217

@@ -222,12 +222,12 @@ VRC7SOUND_API void vrc7_set_patch_set(struct vrc7_sound *vrc7_s, int patch_set);
222222

223223
/*
224224
Updates the vrc7. This function has to be called at 1/72th of the clock rate set by vrc7_set_clock_rate. After calling this function,
225-
the signal member of the vrc7_object will contain new data. If you are using vrc7_fetch_sample, you do not need to call this function.
225+
the signal variable of the vrc7_sound object will contain new data. If you are using vrc7_fetch_sample, you should not call this function.
226226
*/
227227
VRC7SOUND_API void vrc7_tick(struct vrc7_sound *vrc7_s);
228228

229229
/*
230-
Fetches a single sample and updates the vrc7. This function internally calls vrc7_tick, so you should not call it manually when using
230+
Fetches a single sample and updates the vrc7_sound object. This function internally calls vrc7_tick, so you should not call it manually when using
231231
vrc7_fetch_sample. This function has to be called at the sample rate set by vrc7_set_sample_rate.
232232
*/
233233
VRC7SOUND_API void vrc7_fetch_sample(struct vrc7_sound *vrc7_s, int16_t *sample);
@@ -270,12 +270,12 @@ VRC7SOUND_API void vrc7_get_default_patch(int set, uint32_t index, struct vrc7_p
270270
*/
271271

272272
/*
273-
Filter function that leaves the raw output from the vrc7 in the signal member. In other words, this function does nothing.
273+
Filter function that leaves the raw output from the vrc7 in the signal variable. In other words, this function does nothing.
274274
*/
275275
VRC7SOUND_API void vrc7_filter_raw(struct vrc7_sound *vrc7_s);
276276

277277
/*
278-
Filter function converts the pulse output of the vrc7 into a more usable signal, but does not apply any filters to it.
278+
Filter function that converts the pulse output of the vrc7 into a more usable signal, but does not apply any filters to it.
279279
The output signal is filled with the sum of each of the channels outputs.
280280
*/
281281
VRC7SOUND_API void vrc7_filter_no_filter(struct vrc7_sound *vrc7_s);

0 commit comments

Comments
 (0)