soloud-sys 1.1.1

Rust bindings for the soloud audio engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

/*
   YM-2149F emulator for Unreal Speccy project
   created under public domain license by SMT, jan.2006
*/


#ifndef _SNDCHIP_H_INCLUDED
#define _SNDCHIP_H_INCLUDED

#include "sndrender.h"

const unsigned SNDR_DEFAULT_AY_RATE = 1774400; // original ZX-Spectrum soundchip clock fq

struct AYOUT;

// output volumes (#0000-#FFFF) for given envelope state or R8-R10 value
// AY chip has only 16 different volume values, so v[0]=v[1], v[2]=v[3], ...
struct SNDCHIP_VOLTAB
{
   unsigned v[32];
};

// generator's channel panning, % (0-100)
struct SNDCHIP_PANTAB
{
   unsigned raw[6];
   // structured as 'struct { unsigned left, right; } chan[3]';
};


extern const char * const ay_chips[];

#ifdef __GNUC__
#pragma pack(push,1)
#else
#pragma pack(push)
#pragma pack(1) // envelope period (envT, R13-R14) has invalid word alignment
#endif
struct AYREGS
{
   unsigned short fA, fB, fC;
   unsigned char noise, mix;
   unsigned char vA, vB, vC;
   unsigned short envT;
   unsigned char env;
   unsigned char portA, portB;
};
#pragma pack(pop)

class SNDCHIP : public SNDRENDER
{

 public:

   enum CHIP_TYPE { CHIP_AY, CHIP_YM, CHIP_MAX };
   static const char *get_chipname(CHIP_TYPE i) { return ay_chips[i]; }

   void set_chip(CHIP_TYPE type) { chiptype = type; }
   void set_timings(unsigned system_clock_rate, unsigned chip_clock_rate, unsigned sample_rate);
   void set_volumes(unsigned global_vol, const SNDCHIP_VOLTAB *voltab, const SNDCHIP_PANTAB *stereo);
   void set_volume(unsigned global_vol);

   void reset(unsigned timestamp = 0); // call with default parameter, when context outside start_frame/end_frame block

   // 'render' is a function that converts array of register writes into PCM-buffer
   void render(AYOUT *src, unsigned srclen, unsigned clk_ticks);

   // set of functions that fills buffer in emulation progress
   void start_frame();
   void select(unsigned char nreg);
   void write(unsigned timestamp, unsigned char val);
   unsigned char read();
   void end_frame(unsigned clk_ticks);

   SNDCHIP(SNDBUFFER&);

   // for monitoring, chip can't report this values
   unsigned char get_activereg() { return activereg; }
   unsigned char get_r13_reloaded() { return r13_reloaded; }
   unsigned char get_reg(unsigned nreg) { return reg[nreg]; }
   unsigned get_env() { return env; }

 private:

   unsigned t, ta, tb, tc, tn, te, env, denv;
   unsigned bitA, bitB, bitC, bitN, ns;
   unsigned bit0, bit1, bit2, bit3, bit4, bit5;
   unsigned ea, eb, ec, va, vb, vc;
   unsigned fa, fb, fc, fn, fe;
   unsigned mult_const;

   unsigned char activereg, r13_reloaded;

   unsigned vols[6][32];
   CHIP_TYPE chiptype;

   union {
      unsigned char reg[16];
      struct AYREGS r;
   };

   unsigned chip_clock_rate, system_clock_rate;
   unsigned passed_chip_ticks, passed_clk_ticks;
   void flush(unsigned chiptick);
   void apply_regs(unsigned timestamp = 0);

   SNDCHIP_VOLTAB defvoltab;
   SNDCHIP_PANTAB defpantab;
};

struct AYOUT
{
   unsigned timestamp; // in system ticks
   unsigned char reg_num;
   unsigned char reg_value;
   unsigned char res1, res2; // padding
};

extern const SNDCHIP_VOLTAB SNDR_VOL_AY_S;
extern const SNDCHIP_VOLTAB SNDR_VOL_YM_S;
extern const SNDCHIP_PANTAB SNDR_PAN_MONO_S;
extern const SNDCHIP_PANTAB SNDR_PAN_ABC_S;
extern const SNDCHIP_PANTAB SNDR_PAN_ACB_S;
extern const SNDCHIP_PANTAB SNDR_PAN_BAC_S;
extern const SNDCHIP_PANTAB SNDR_PAN_BCA_S;
extern const SNDCHIP_PANTAB SNDR_PAN_CAB_S;
extern const SNDCHIP_PANTAB SNDR_PAN_CBA_S;

// used as parameters to SNDCHIP::set_volumes(),
// if application don't want to override defaults
const SNDCHIP_VOLTAB * const SNDR_VOL_AY = &SNDR_VOL_AY_S;
const SNDCHIP_VOLTAB * const SNDR_VOL_YM = &SNDR_VOL_YM_S;
const SNDCHIP_PANTAB * const SNDR_PAN_MONO = &SNDR_PAN_MONO_S;
const SNDCHIP_PANTAB * const SNDR_PAN_ABC = &SNDR_PAN_ABC_S;
const SNDCHIP_PANTAB * const SNDR_PAN_ACB = &SNDR_PAN_ACB_S;
const SNDCHIP_PANTAB * const SNDR_PAN_BAC = &SNDR_PAN_BAC_S;
const SNDCHIP_PANTAB * const SNDR_PAN_BCA = &SNDR_PAN_BCA_S;
const SNDCHIP_PANTAB * const SNDR_PAN_CAB = &SNDR_PAN_CAB_S;
const SNDCHIP_PANTAB * const SNDR_PAN_CBA = &SNDR_PAN_CBA_S;

#endif // _SNDCHIP_H_INCLUDED