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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
{ $Header: /MidiComp/CIRCBUF.PAS 2 10/06/97 7:33 Davec $ }
{ Written by David Churcher <dchurcher@cix.compulink.co.uk>,
released to the public domain. }
{ A First-In First-Out circular buffer.
Port of circbuf.c from Microsoft's Windows MIDI monitor example.
I did do a version of this as an object (see Rev 1.1) but it was getting too
complicated and I couldn't see any real benefits to it so I dumped it
for an ordinary memory buffer with pointers.
This unit is a bit C-like, everything is done with pointers and extensive
use is made of the undocumented feature of the Inc() function that
increments pointers by the size of the object pointed to.
All of this could probably be done using Pascal array notation with
range-checking turned off, but I'm not sure it's worth it.
}
Unit Circbuf;
interface
Uses Wintypes, WinProcs, MMSystem;
type
{$IFNDEF WIN32}
{ API types not defined in Delphi 1 }
DWORD = Longint;
HGLOBAL = THandle;
UINT = Word;
TFNTimeCallBack = procedure(uTimerID, uMessage: UINT; dwUser, dw1, dw2: DWORD);
{$ENDIF}
{ MIDI input event }
TMidiBufferItem = record
timestamp: DWORD; { Timestamp in milliseconds after midiInStart }
data: DWORD; { MIDI message received }
sysex: PMidiHdr; { Pointer to sysex MIDIHDR, nil if not sysex }
end;
PMidiBufferItem = ^TMidiBufferItem;
{ MIDI input buffer }
TCircularBuffer = record
RecordHandle: HGLOBAL; { Windows memory handle for this record }
BufferHandle: HGLOBAL; { Windows memory handle for the buffer }
pStart: PMidiBufferItem; { ptr to start of buffer }
pEnd: PMidiBufferItem; { ptr to end of buffer }
pNextPut: PMidiBufferItem; { next location to fill }
pNextGet: PMidiBufferItem; { next location to empty }
Error: Word; { error code from MMSYSTEM functions }
Capacity: Word; { buffer size (in TMidiBufferItems) }
EventCount: Word; { Number of events in buffer }
end;
PCircularBuffer = ^TCircularBuffer;
function GlobalSharedLockedAlloc( Capacity: Word; var hMem: HGLOBAL ): Pointer;
procedure GlobalSharedLockedFree( hMem: HGLOBAL; ptr: Pointer );
function CircbufAlloc( Capacity: Word ): PCircularBuffer;
procedure CircbufFree( PBuffer: PCircularBuffer );
function CircbufRemoveEvent( PBuffer: PCircularBuffer ): Boolean;
function CircbufReadEvent( PBuffer: PCircularBuffer; PEvent: PMidiBufferItem ): Boolean;
{ Note: The PutEvent function is in the DLL }
implementation
{ Allocates in global shared memory, returns pointer and handle }
function GlobalSharedLockedAlloc( Capacity: Word; var hMem: HGLOBAL ): Pointer;
var
ptr: Pointer;
begin
{ Allocate the buffer memory }
hMem := GlobalAlloc(GMEM_SHARE Or GMEM_MOVEABLE Or GMEM_ZEROINIT, Capacity );
if (hMem = 0) then
ptr := Nil
else
begin
ptr := GlobalLock(hMem);
if (ptr = Nil) then
GlobalFree(hMem);
end;
{$IFNDEF WIN32}
if (ptr <> Nil) then
GlobalPageLock(HIWORD(DWORD(ptr)));
{$ENDIF}
GlobalSharedLockedAlloc := Ptr;
end;
procedure GlobalSharedLockedFree( hMem: HGLOBAL; ptr: Pointer );
begin
{$IFNDEF WIN32}
if (ptr <> Nil) then
GlobalPageUnlock(HIWORD(DWORD(ptr)));
{$ENDIF}
if (hMem <> 0) then
begin
GlobalUnlock(hMem);
GlobalFree(hMem);
end;
end;
function CircbufAlloc( Capacity: Word ): PCircularBuffer;
var
NewCircularBuffer: PCircularBuffer;
NewMIDIBuffer: PMidiBufferItem;
hMem: HGLOBAL;
begin
{ TODO: Validate circbuf size, <64K }
NewCircularBuffer :=
GlobalSharedLockedAlloc( Sizeof(TCircularBuffer), hMem );
if (NewCircularBuffer <> Nil) then
begin
NewCircularBuffer^.RecordHandle := hMem;
NewMIDIBuffer :=
GlobalSharedLockedAlloc( Capacity * Sizeof(TMidiBufferItem), hMem );
if (NewMIDIBuffer = Nil) then
begin
{ TODO: Exception here? }
GlobalSharedLockedFree( NewCircularBuffer^.RecordHandle,
NewCircularBuffer );
NewCircularBuffer := Nil;
end
else
begin
NewCircularBuffer^.pStart := NewMidiBuffer;
{ Point to item at end of buffer }
NewCircularBuffer^.pEnd := NewMidiBuffer;
Inc(NewCircularBuffer^.pEnd, Capacity);
{ Start off the get and put pointers in the same position. These
will get out of sync as the interrupts start rolling in }
NewCircularBuffer^.pNextPut := NewMidiBuffer;
NewCircularBuffer^.pNextGet := NewMidiBuffer;
NewCircularBuffer^.Error := 0;
NewCircularBuffer^.Capacity := Capacity;
NewCircularBuffer^.EventCount := 0;
end;
end;
CircbufAlloc := NewCircularBuffer;
end;
procedure CircbufFree( pBuffer: PCircularBuffer );
begin
if (pBuffer <> Nil) then
begin
GlobalSharedLockedFree(pBuffer^.BufferHandle, pBuffer^.pStart);
GlobalSharedLockedFree(pBuffer^.RecordHandle, pBuffer);
end;
end;
{ Reads first event in queue without removing it.
Returns true if successful, False if no events in queue }
function CircbufReadEvent( PBuffer: PCircularBuffer; PEvent: PMidiBufferItem ): Boolean;
var
PCurrentEvent: PMidiBufferItem;
begin
if (PBuffer^.EventCount <= 0) then
CircbufReadEvent := False
else
begin
PCurrentEvent := PBuffer^.PNextget;
{ Copy the object from the "tail" of the buffer to the caller's object }
PEvent^.Timestamp := PCurrentEvent^.Timestamp;
PEvent^.Data := PCurrentEvent^.Data;
PEvent^.Sysex := PCurrentEvent^.Sysex;
CircbufReadEvent := True;
end;
end;
{ Remove current event from the queue }
function CircbufRemoveEvent(PBuffer: PCircularBuffer): Boolean;
begin
if (PBuffer^.EventCount > 0) then
begin
Dec( Pbuffer^.EventCount);
{ Advance the buffer pointer, with wrap }
Inc( Pbuffer^.PNextGet );
If (PBuffer^.PNextGet = PBuffer^.PEnd) then
PBuffer^.PNextGet := PBuffer^.PStart;
CircbufRemoveEvent := True;
end
else
CircbufRemoveEvent := False;
end;
end.
|
