-
Notifications
You must be signed in to change notification settings - Fork 8
/
soundfile.c
1275 lines (1152 loc) · 36.3 KB
/
soundfile.c
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* $Id: soundfile.c,v 1.45 1994/11/16 23:00:27 phil Exp $ */
/***************************************************************
**
** Play Sound File from Disk.
** By: Phil Burk
**
** Copyright (c) 1992, 3DO Company.
** This program is proprietary and confidential.
**
***************************************************************/
/*
** 921116 PLB Modified for explicit mixer connect.
** 921118 PLB Added ChangeDirectory("/remote") for filesystem.
** 921202 PLB Converted to LoadInstrument and GrabKnob.
** 921203 PLB Use AUDIODATADIR instead of /remote.
** 930501 PLB Convert to use linked attachments.
** 930505 PLB Wait on SignalMask to avoid double hits.
** 930524 PLB Added CreateSoundFilePLayer
** 930614 PLB Read integral number of blocks at end.
** 930721 PLB Changed MEMTYPE_DMA to MEMTYPE_AUDIO
** 930730 PLB Added ioi_Flags2 = 0
** 930809 PLB Added SFP_NO_DIRECTOUT
** 931110 PLB Protect against writing past end of buffer if DataOffset is Past BufferEnd
** 931110 PLB Prevent hang at end by only unlinking last buffer.
** 931110 PLB In LoadSoundFile(), rewind after loading instruments so that
** drive head is left in soundfile track.
** 931111 PLB Clear signals before and after run.
** 931213 PLB Converted to use new SoundSpooler, not released until 3/94.
** 940224 PLB Use Async IO
** 940415 PLB UnloadSoundFile was unloading sfp->sfp_Spooler->sspl_SamplerIns
** which had already been cleared. Thus the instrument was never
** getting unloaded. New bug arrived with new spooler.
** 940415 PLB Removed dead static code, LoopSoundFile().
** 940421 PLB Do not play buffers past end of short files.
** Reset Spooler in RewindSoundFile() to handle looping and reduce
** hiccup in Start/Stop.
** Return SignalsNeeded from StartSoundFile() to reduce loop errors.
** 940516 PLB Fixed minor warnings.
** 940727 WJB Added autodocs.
** 941013 WJB Now reads block size from file system.
** 941114 PLB Change directout.dsp priority from 0 to 100 for capture_audio.c.
** 941116 PLB Delete IOReq before file device to prevent WARNING
*/
#include "types.h"
#include "debug.h"
#include "nodes.h"
#include "kernelnodes.h"
#include "list.h"
#include "folio.h"
#include "io.h"
#include "task.h"
#include "kernel.h"
#include "mem.h"
#include "semaphore.h"
#include "stdarg.h"
#include "strings.h"
#include "operror.h"
#include "stdio.h"
/* Include this when using the Audio Folio */
#include "audio.h"
#include "music.h"
#include "music_internal.h" /* package id */
DEFINE_MUSICLIB_PACKAGE_ID(soundfile)
#define PRT(x) { printf x; }
#define ERR(x) PRT(x)
#define DBUG(x) /* PRT(x) */
#define DBUGCLK(x) /* PRT(x) */
#define DEBUG_LoadSoundFile 0 /* prints out info during LoadSoundFile() (941013) */
/* Macro to simplify error checking. */
#define CHECKRESULT(val,name) \
if (val < 0) \
{ \
Result = val; \
ERR(("Failure in %s: $%x\n", name, val)); \
PrintfSysErr(Result); \
goto error; \
}
#define FINISHIO \
if(sfp->sfp_PrivateFlags & SFP_PRIV_IO_PENDING) /* 940224 */ \
{ \
DBUG(("WaitIO\n")); \
WaitIO( sfp->sfp_IOReqItem ); \
sfp->sfp_PrivateFlags &= ~SFP_PRIV_IO_PENDING; \
}
#define SNDF_IF_ASYNC (TRUE)
/* Debug info must be written to arrays cuz printing would mess up timing. */
/* #define DEBUG */
#ifdef DEBUG
#define MAXDATA 1000
static int32 logCurAddrA[MAXDATA];
static int32 logCurAddrB[MAXDATA];
static int32 logSignal[MAXDATA];
static int32 logCurSignal[MAXDATA];
static int32 logBufIndex[MAXDATA];
static int32 logCursor[MAXDATA];
static int32 logNumRead[MAXDATA];
static int32 logUnlink[MAXDATA];
static int32 dbgindx;
#define LOGDATA(val,arr) { if (dbgindx < MAXDATA ) { arr[dbgindx]=val; } }
#endif
/* -------------------- Local functions */
static int32 GetFileBlockSize (Item fileioreq);
/* -------------------- Code */
/**************************************************************************/
/**
||| AUTODOC PUBLIC mpg/musiclib/soundfileplayer/createsoundfileplayer
||| CreateSoundFilePlayer - Creates a SoundFilePlayer data structure to play
||| sound files.
|||
||| Synopsis
|||
||| SoundFilePlayer *CreateSoundFilePlayer( int32 NumBuffers,
||| int32 BufSize, void *Buffers[] )
|||
||| Description
|||
||| This procedure creates a SoundFilePlayer data structure and initializes
||| it. A SoundFilePlayer can be used to play several sound files, one at a
||| time. The Buffers argument is a pointer to an array of pointers to
||| preallocated audio data buffers, all the same size. If Buffers is NULL,
||| then this procedure allocates the memory for you. The memory for this
||| must be of type MEMTYPE_AUDIO.
|||
||| Arguments
|||
||| NumBuffers A value indicating the number of audio data
||| buffers.
|||
||| BufSize A value indicating the size of the audio
||| data buffers.
|||
||| Buffers A pointer to an array of pointers to
||| preallocated audio data buffers.
|||
||| Return Value
|||
||| This procedure returns a pointer to the SoundFilePlayer data structure if
||| all went well or a NULL if an error occurs.
|||
||| Implementation
|||
||| Library call implemented in music.lib V20.
|||
||| Caveats
|||
||| Buffer size must be a multiple of the file's block size (see LoadSoundFile() for complete reason).
|||
||| Associated Files
|||
||| soundfile.h, music.lib
|||
||| See Also
|||
||| OpenSoundFile(), CloseSoundFile(), DeleteSoundFile(), LoadSoundFile(),
||| ReadSoundFile(), RewindSoundFile(), ServiceSoundFile(), StartSoundFile(),
||| StopSoundFile(), UnloadSoundFile()
|||
**/
SoundFilePlayer *CreateSoundFilePlayer ( int32 NumBuffers, int32 BufSize, void *Buffers[] )
{
SoundFilePlayer *sfp;
SoundSpooler *sspl;
void *MemAddr;
int32 i;
PULL_MUSICLIB_PACKAGE_ID(soundfile);
if (NumBuffers < 2)
{
ERR(("CreateSoundFilePlayer: too few buffers requested, %d < 2\n", NumBuffers));
return NULL;
}
if (NumBuffers > MAX_SOUNDFILE_BUFS)
{
ERR(("CreateSoundFilePlayer: too many buffers requested, %d > %d\n",
NumBuffers, MAX_SOUNDFILE_BUFS));
return NULL;
}
sfp = (SoundFilePlayer *) zalloc(sizeof(SoundFilePlayer));
if (sfp == NULL) return NULL;
/* Create SoundSpooler data structure. */
sspl = ssplCreateSoundSpooler( NumBuffers, 0 );
if( sspl == NULL )
{
ERR(("CreateSoundFilePlayer: could not create spooler.\n"));
goto error;
}
sfp->sfp_Spooler = sspl;
sfp->sfp_BufSize = BufSize;
sfp->sfp_NumBuffers = NumBuffers;
/* Assign memory to buffers. */
/* Create desired buffers for spooler. */
for (i=0; i<NumBuffers; i++)
{
if (Buffers)
{
MemAddr = Buffers[i];
}
else
{
MemAddr = EZMemAlloc( BufSize, MEMTYPE_AUDIO );
if (MemAddr == NULL)
{
ERR(("CreateSoundFilePlayer: Buffer allocation failed!\n"));
goto error;
}
}
sfp->sfp_BufferAddrs[i] = (char *) MemAddr;
}
if (Buffers == NULL) sfp->sfp_PrivateFlags |= SFP_PRIV_OWN_BUFFERS;
error:
return sfp;
}
/**************************************************************************/
/**
||| AUTODOC PUBLIC mpg/musiclib/soundfileplayer/deletesoundfileplayer
||| DeleteSoundFilePlayer - Deletes a SoundFilePlayer data structure.
|||
||| Synopsis
|||
||| int32 DeleteSoundFilePlayer( SoundFilePlayer *sfp )
|||
||| Description
|||
||| This procedure deletes a SoundFilePlayer data structure and cleans up
||| after CreateSoundFilePlayer(). If the memory for the SoundFilePlayer was
||| allocated by CreateSoundFilePlayer(), then the memory is returned to the
||| system. If you allocated your own buffers, DeleteSoundFilePlayer()
||| won't free the buffers; you must do it yourself.
|||
||| Arguments
|||
||| sfp A pointer to the SoundFilePlayer.
|||
||| Return Value
|||
||| This procedure returns 0 if successful or an error code (a negative value)
||| if an error occurs.
|||
||| Implementation
|||
||| Library call implemented in music.lib V20.
|||
||| Associated Files
|||
||| soundfile.h, music.lib
|||
||| See Also
|||
||| OpenSoundFile(), CloseSoundFile(), LoadSoundFile(), ReadSoundFile(),
||| RewindSoundFile(), ServiceSoundFile(), StartSoundFile(), StopSoundFile(),
||| UnloadSoundFile(), CreateSoundFilePlayer()
|||
**/
int32 DeleteSoundFilePlayer ( SoundFilePlayer *sfp )
{
int32 i, Result = 0;
if (sfp)
{
for (i=0; i<sfp->sfp_NumBuffers; i++)
{
if (sfp->sfp_PrivateFlags & SFP_PRIV_OWN_BUFFERS)
{
EZMemFree(sfp->sfp_BufferAddrs[i]);
}
}
ssplDeleteSoundSpooler( sfp->sfp_Spooler );
free (sfp);
}
return Result;
}
/**************************************************************************
** Load beginning of a soundfile into the player.
**************************************************************************/
/**
||| AUTODOC PUBLIC mpg/musiclib/soundfileplayer/loadsoundfile
||| LoadSoundFile - Preloads the first part of a sound file.
|||
||| Synopsis
|||
||| Err LoadSoundFile( SoundFilePlayer *sfp, char *FileName )
|||
||| Description
|||
||| This procedure preloads the first part of a sound file to be played. The
||| file should be an AIFF file. The appropriate DSP instrument to play this
||| sound file is loaded for you at the same time.
|||
||| Arguments
|||
||| sfp A pointer to the SoundFilePlayer.
|||
||| FileName A pointer to the sound file.
|||
||| Return Value
|||
||| This procedure returns 0 if successful or an error code (a negative value)
||| if an error occurs.
|||
||| Implementation
|||
||| Library call implemented in music.lib V20.
|||
||| Caveats
|||
||| Prior to V24 this function failed to check the file's block size. It always
||| assumed that it was 2048 bytes. As of V24 it does check. However, there has
||| always been an implicit requirement that buffer size be a multiple of block
||| size. Not having buffers be a multiple of block size could
||| result in memory overruns. The sound file player now checks buffer size against block size and returns
||| an error if the buffer size is not a multiple of block size.
|||
||| This means that an app using 10K buffers will work fine on a 2K block file and
||| will simply fail on a 4K block file system. To prevent this choose a buffer size
||| that is a multiple of all of the block sizes that your application is expected to support.
|||
||| If this restriction is too severe, use the advanced sound player instead.
|||
||| Associated Files
|||
||| soundfile.h, music.lib
|||
||| See Also
|||
||| OpenSoundFile(), CloseSoundFile(), DeleteSoundFile(), ReadSoundFile(),
||| RewindSoundFile(), ServiceSoundFile(), StartSoundFile(), StopSoundFile(),
||| UnloadSoundFile(), CreateSoundFilePlayer()
|||
**/
int32 LoadSoundFile ( SoundFilePlayer *sfp, char *FileName )
{
int32 Result;
Item OpenFileItem, ioReqItem;
char *InstrumentName;
int32 Channels;
int32 DataOffset;
int32 DataSize;
TagArg Tags[4];
Item TempSample;
#ifdef DEBUG
int32 i;
/* Clear debug arrays. */
for (i=0; i<MAXDATA; i++)
{
logCurAddrA[i] = 0;
logCurAddrB[i] = 0;
logSignal[i] = 0;
logCurSignal[i] = 0;
logBufIndex[i] = 0;
logCursor[i] = 0;
logNumRead[i] = 0;
}
dbgindx = 0;
#endif
/* Scan sample buffer to get sample info */
TempSample = ScanSample(FileName, 0 ); /* from command line? */
CHECKRESULT(TempSample,"ScanSample");
/* Get information from sample. */
Tags[0].ta_Tag = AF_TAG_CHANNELS;
Tags[1].ta_Tag = AF_TAG_DATA_OFFSET;
Tags[2].ta_Tag = AF_TAG_DATA_SIZE;
Tags[3].ta_Tag = TAG_END;
Result = GetAudioItemInfo( TempSample, Tags );
if( Result < 0) return Result;
Channels = (int32) Tags[0].ta_Arg;
DataOffset = (uint32) Tags[1].ta_Arg;
DataSize = (int32) Tags[2].ta_Arg;
sfp->sfp_NumToRead = DataSize + DataOffset;
sfp->sfp_BuffersToPlay = (sfp->sfp_NumToRead + sfp->sfp_BufSize -1 )/ sfp->sfp_BufSize;
sfp->sfp_DataOffset = DataOffset;
DBUG(("sfp->sfp_BuffersToPlay = %d\n", sfp->sfp_BuffersToPlay));
/* Now reopen file as a block oriented sound file. */
OpenFileItem = OpenDiskFile(FileName);
if (OpenFileItem < 0)
{
Result = OpenFileItem;
goto error;
}
sfp->sfp_FileItem = OpenFileItem;
/* Create an IO Request for reading file. */
Tags[0].ta_Tag = CREATEIOREQ_TAG_DEVICE;
Tags[0].ta_Arg = (void *) OpenFileItem;
Tags[1].ta_Tag = TAG_END;
ioReqItem = CreateItem(MKNODEID(KERNELNODE,IOREQNODE), Tags);
if (ioReqItem < 0)
{
Result = ioReqItem;
goto error;
}
sfp->sfp_IOReqItem = ioReqItem;
/* Get the file's block size (941013) */
{
int32 tresult;
if ( (tresult = GetFileBlockSize (sfp->sfp_IOReqItem)) < 0 ) {
Result = tresult;
goto error;
}
sfp->sfp_BlockSize = (uint32)tresult;
#if DEBUG_LoadSoundFile
PRT (("soundfile: Block size: %lu bytes.\n", sfp->sfp_BlockSize));
#endif
}
/* Make sure buffer size is a multiple of block size */
if (sfp->sfp_BufSize % sfp->sfp_BlockSize) {
ERR (("soundfile: buffer size (%lu) not a multiple of file's block size (%lu)\n", sfp->sfp_BufSize, sfp->sfp_BlockSize));
Result = ML_ERR_BUFFER_TOO_SMALL;
goto error;
}
/* Load an instrument if the user has not supplied one. */
if((sfp->sfp_Flags & SFP_NO_SAMPLER) == 0)
{
InstrumentName = SelectSamplePlayer( TempSample , FALSE );
if (InstrumentName == NULL)
{
ERR(("No instrument to play that sample.\n"));
Result = ML_ERR_UNSUPPORTED_SAMPLE;
goto error; /* %Q cleanup */
}
else
{
#if DEBUG_LoadSoundFile
PRT(("soundfile: Use '%s' instrument.\n", InstrumentName));
#endif
}
sfp->sfp_SamplerIns = LoadInstrument( InstrumentName, 0, 100 );
CHECKRESULT(sfp->sfp_SamplerIns,"LoadInstrument");
}
/* Attach buffers to sampler. */
if( sfp->sfp_SamplerIns )
{
Result = ssplAttachInstrument( sfp->sfp_Spooler, sfp->sfp_SamplerIns );
CHECKRESULT(Result,"ssplAttachInstrument");
}
if((sfp->sfp_Flags & SFP_NO_DIRECTOUT) == 0)
{
sfp->sfp_OutputIns = LoadInstrument("directout.dsp", 0, 100); /* 941114 */
DBUG(("Open: OutputIns = 0x%x\n", sfp->sfp_OutputIns));
CHECKRESULT(sfp->sfp_OutputIns,"LoadInstrument");
if (Channels == 1)
{
/* Connect Sampler to Direct Out */
Result = ConnectInstruments (sfp->sfp_SamplerIns, "Output", sfp->sfp_OutputIns, "InputLeft");
CHECKRESULT(Result,"ConnectInstruments");
Result = ConnectInstruments (sfp->sfp_SamplerIns, "Output", sfp->sfp_OutputIns, "InputRight");
CHECKRESULT(Result,"ConnectInstruments");
}
else if (Channels == 2)
{
/* Connect Sampler to Direct Out */
Result = ConnectInstruments (sfp->sfp_SamplerIns, "LeftOutput", sfp->sfp_OutputIns, "InputLeft");
CHECKRESULT(Result,"ConnectInstruments");
Result = ConnectInstruments (sfp->sfp_SamplerIns, "RightOutput", sfp->sfp_OutputIns, "InputRight");
CHECKRESULT(Result,"ConnectInstruments");
}
}
UnloadSample( TempSample );
/* Rewind after loading instruments so that drive head is left in soundfile track. 931110 */
Result = RewindSoundFile(sfp);
CHECKRESULT(Result,"RewindSoundFile");
return Result;
#ifdef DEBUG
dbgindx = 0;
#endif
error:
return Result;
}
/*****************************************************************/
static int32 ReadSoundFileAddr( SoundFilePlayer *sfp, int32 Cursor, uint8 *Address, int32 IfAsync)
{
/* Read sound file data into buffer. */
int32 LeftToRead, NumToRead, NumToClear = 0, Result = 0;
int32 err, i;
IOInfo theInfo;
uint8 *bp;
DBUG(("ReadSoundFileAddr( 0x%x, 0x%lx, 0x%lx )\n", sfp, Cursor, Address));
LeftToRead = sfp->sfp_NumToRead - Cursor;
if (LeftToRead <= 0)
{
ERR(("ReadSoundFile nothing left to read.\n"));
return ML_ERR_END_OF_FILE;
}
if (sfp->sfp_IOReqItem > 0)
{
/* @@@ NumToRead is set in both cases assuming that the buffer size is a multiple of block size */
if (LeftToRead < sfp->sfp_BufSize)
{
/* Adjust NumToRead to get an integral number of BLOCKs 930614 */
/* NumToRead = (LeftToRead + (BLOCKSIZE-1)) & (~(BLOCKSIZE-1)); 941013: replaced w/ block size from file */
NumToRead = (LeftToRead + (sfp->sfp_BlockSize-1)) / sfp->sfp_BlockSize * sfp->sfp_BlockSize;
DBUG(("NumToRead = 0x%x, LeftToRead = 0x%x\n", NumToRead, LeftToRead));
NumToClear = sfp->sfp_BufSize - LeftToRead;
}
else
{
NumToRead = sfp->sfp_BufSize;
NumToClear = 0;
}
theInfo.ioi_Command = CMD_READ;
theInfo.ioi_Flags = 0;
#ifndef dragon2
theInfo.ioi_Flags2 = 0;
#endif
theInfo.ioi_Unit = 0;
theInfo.ioi_Offset = (int32) (Cursor / sfp->sfp_BlockSize); /* 941013: replaced w/ block size from file */
theInfo.ioi_Send.iob_Buffer = NULL;
theInfo.ioi_Send.iob_Len = 0;
theInfo.ioi_Recv.iob_Buffer = Address;
theInfo.ioi_Recv.iob_Len = NumToRead;
#ifdef DEBUG
LOGDATA(NumToRead,logNumRead);
#endif
/* Wait for old IO to complete. 940224 */
DBUG(("ReadSoundFileAS: IfAsync = %d\n", IfAsync));
FINISHIO;
if( IfAsync )
{
DBUG(("ReadSoundFileAS: SendIO\n"));
err = SendIO(sfp->sfp_IOReqItem , &theInfo);
if( err >= 0) sfp->sfp_PrivateFlags |= SFP_PRIV_IO_PENDING;
}
else
{
err = DoIO(sfp->sfp_IOReqItem , &theInfo);
}
if (err < 0)
{
ERR(("ReadSoundFIle: DoIO error = 0x%x\n", err));
Result = err;
}
/* Clear any data left at end. */
if (NumToClear)
{
/* 940224 Must finish IO because it is rounded up to a block and has crud at end. */
FINISHIO;
bp = Address + LeftToRead;
for (i=0; i<NumToClear; i++) *bp++ = 0;
DBUG(("Clearing %d bytes in buf 0x%x\n", NumToClear, Address ));
}
}
else
{
Result = ML_ERR_NOT_OPEN;
}
return Result;
}
/**
||| AUTODOC PUBLIC mpg/musiclib/soundfileplayer/readsoundfile
||| ReadSoundFile - Reads a sound file.
|||
||| !!! hide this function?
|||
||| Synopsis
|||
||| int32 ReadSoundFile( SoundFilePlayer *sfp, int32 Cursor,
||| int32 BufIndex )
|||
||| Description
|||
||| This procedure is used internally to read part of the sound file into a
||| buffer.
|||
||| Arguments
|||
||| sfp A pointer to the SoundFilePlayer.
|||
||| Cursor A value indicating where in the sound file
||| the procedure is reading from.
|||
||| BufIndex A value indicating which of the audio data
||| buffers the procedure is reading from.
|||
||| Return Value
|||
||| This procedure returns 0 if successful or an error code (a negative value)
||| if an error occurs.
|||
||| Implementation
|||
||| Library call implemented in music.lib V20.
|||
||| Associated Files
|||
||| soundfile.h, music.lib
|||
||| See Also
|||
||| ServiceSoundFile()
|||
**/
int32 ReadSoundFile( SoundFilePlayer *sfp, int32 Cursor, int32 BufIndex)
{
DBUG(("ReadSoundFile( ...,..., %d )\n", BufIndex ));
return ReadSoundFileAddr( sfp, Cursor, sfp->sfp_BufferAddrs[BufIndex], SNDF_IF_ASYNC );
}
/**************************************************************************/
/**
||| AUTODOC PUBLIC mpg/musiclib/soundfileplayer/opensoundfile
||| OpenSoundFile - Creates a SoundFilePlayer data structure and loads a sound
||| file.
|||
||| Synopsis
|||
||| SoundFilePlayer *OpenSoundFile( char *FileName,
||| int32 NumBuffers, int32 BufSize )
|||
||| Description
|||
||| This is a convenience procedure that creates a SoundFilePlayer data
||| structure and loads the sound file. It calls CreateSoundFilePlayer() and
||| LoadSoundFile() for you.
|||
||| Arguments
|||
||| FileName A pointer to the name of the sound file.
|||
||| NumBuffers A value indicating the number of audio data
||| buffers in the SoundFilePlayer.
|||
||| BufSize A value indicating the size of the audio
||| data buffers.
|||
||| Return Value
|||
||| This procedure returns a pointer to the SoundFilePlayer data structure if
||| successful or NULL if an error occurs.
|||
||| Implementation
|||
||| Convenience call implemented in music.lib V20.
|||
||| Caveats
|||
||| Buffer size must be a multiple of the file's block size (see LoadSoundFile() for complete reason).
|||
||| Associated Files
|||
||| soundfile.h, music.lib
|||
||| See Also
|||
||| CloseSoundFile(), DeleteSoundFile(), LoadSoundFile(), ReadSoundFile(),
||| RewindSoundFile(), ServiceSoundFile(), StartSoundFile(), StopSoundFile(),
||| UnloadSoundFile(), CreateSoundFilePlayer()
|||
**/
SoundFilePlayer *OpenSoundFile (char *FileName, int32 NumBuffers, int32 BufSize )
{
SoundFilePlayer *sfp;
int32 Result;
sfp = CreateSoundFilePlayer ( NumBuffers, BufSize, NULL );
if (sfp)
{
Result = LoadSoundFile( sfp, FileName );
if (Result < 0) return NULL;
}
return sfp;
}
/***************************************************************************
** Loop back to beginning of file.
** Preload buffers so that spooler is ready to start immediately.
***************************************************************************/
/**
||| AUTODOC PUBLIC mpg/musiclib/soundfileplayer/rewindsoundfile
||| RewindSoundFile - Rewinds a sound file player.
|||
||| Synopsis
|||
||| int32 RewindSoundFile( SoundFilePlayer *sfp )
|||
||| Description
|||
||| This procedure rewinds a SoundFilePlayer data structure so that sound file
||| playback will start from the beginning when the sound file is activated
||| with StartSoundFile().
|||
||| Arguments
|||
||| sfp A pointer to the SoundFilePlayer data
||| structure.
|||
||| Return Value
|||
||| This procedure returns 0 if successful or an error code (a negative value)
||| if an error occurs.
|||
||| Implementation
|||
||| Library call implemented in music.lib V20.
|||
||| Associated Files
|||
||| soundfile.h, music.lib
|||
||| See Also
|||
||| OpenSoundFile(), CloseSoundFile(), DeleteSoundFile(), LoadSoundFile(),
||| ReadSoundFile(), ServiceSoundFile(), StartSoundFile(), StopSoundFile(),
||| UnloadSoundFile(), CreateSoundFilePlayer()
|||
**/
int32 RewindSoundFile ( SoundFilePlayer *sfp)
{
int32 Result, i;
char *bp;
int32 LastPos;
SoundSpooler *sspl;
SoundBufferNode *sbn;
sfp->sfp_Cursor = 0;
sfp->sfp_LastPos = 0;
sfp->sfp_BufIndex = 0;
sfp->sfp_BuffersPlayed = 0;
sspl = sfp->sfp_Spooler;
/* 940419 Reset spooler so that buffers are free. */
Result = ssplAbort( sspl, NULL );
if (Result < 0) return Result;
/* Preload the initial buffers. */
for (i=0; i<sfp->sfp_NumBuffers; i++)
{
if (sfp->sfp_Cursor < sfp->sfp_NumToRead)
{
Result = ReadSoundFile( sfp, sfp->sfp_Cursor, sfp->sfp_BufIndex);
if (Result < 0) return Result;
sfp->sfp_Cursor += sfp->sfp_BufSize;
sfp->sfp_BufIndex += 1;
/* Send buffers during Rewind so that Start/Stop works Properly. */
if( (sbn = ssplRequestBuffer( sspl )) != NULL)
{
/* Set address and length of buffer. */
Result = ssplSetBufferAddressLength( sspl, sbn,
sfp->sfp_BufferAddrs[i], sfp->sfp_BufSize );
if( Result < 0 ) return Result;
/* Send that buffer off to be played eventually. */
Result = ssplSendBuffer( sspl, sbn );
if( Result < 0 ) return Result;
}
else
{
ERR(("RewindSoundFile: Could not send all buffers!\n"));
}
}
else
{
break;
}
}
sfp->sfp_BufIndex = 0;
/* Zero out part of file that contains header info which should be small. */
bp = sfp->sfp_BufferAddrs[0];
/* 931110 Protect against writing past end of buffer if DataOffset is past BufferEnd */
LastPos = (sfp->sfp_DataOffset < sfp->sfp_BufSize) ?
sfp->sfp_DataOffset : sfp->sfp_BufSize ;
for (i=0; i<LastPos; i++)
{
*bp++ = 0;
}
return 0;
}
/***************************************************************************
** Start playback. Returns initial SignalsNeeded if successful. 940421
***************************************************************************/
/**
||| AUTODOC PUBLIC mpg/musiclib/soundfileplayer/startsoundfile
||| StartSoundFile - Begins playing a sound file.
|||
||| Synopsis
|||
||| int32 StartSoundFile( SoundFilePlayer *sfp, int32
||| Amplitude )
|||
||| Description
|||
||| This procedure begins playing a sound file.
|||
||| Arguments
|||
||| sfp A pointer to the SoundFilePlayer data
||| structure controlling playback.
|||
||| Amplitude A value indicating the amplitude at which to
||| play the sound file; the value is from 0 to
||| $7FFF.
|||
||| Return Value
|||
||| This procedure returns 0 if successful or an error code (a negative value)
||| if an error occurs.
|||
||| Implementation
|||
||| Library call implemented in music.lib V20.
|||
||| Associated Files
|||
||| soundfile.h, music.lib
|||
||| See Also
|||
||| OpenSoundFile(), CloseSoundFile(), DeleteSoundFile(), LoadSoundFile(),
||| ReadSoundFile(), RewindSoundFile(), ServiceSoundFile(), StopSoundFile(),
||| UnloadSoundFile(), CreateSoundFilePlayer()
|||
**/
int32 StartSoundFile ( SoundFilePlayer *sfp , int32 Amplitude)
{
int32 Result;
/* DirectOut must be started */
if(sfp->sfp_OutputIns)
{
Result = StartInstrument( sfp->sfp_OutputIns, NULL );
if( Result < 0 ) return Result;
}
Result = ssplStartSpooler( sfp->sfp_Spooler, Amplitude );
if( Result < 0 ) return Result;
return (sfp->sfp_Spooler->sspl_SignalMask);
}
/**************************************************************************
** ServiceSoundFile - read a buffer of sound if the DMA is ready.
** Returns the number of bytes left to be heard.
**************************************************************************/
/**
||| AUTODOC PUBLIC mpg/musiclib/soundfileplayer/servicesoundfile
||| ServiceSoundFile - Spools a sound file from disk to a sound buffer.
|||
||| Synopsis
|||
||| int32 ServiceSoundFile( SoundFilePlayer *sfp, int32
||| SignalIn, int32 *SignalNeeded )
|||
||| Description
|||
||| This procedure is called repeatedly to spool the sound file from disk to a
||| sound buffer played by StartSoundFile() and controlled by the specified
||| SoundFilePlayer data structure. It returns, in the SignalNeeded mask, the
||| signal for the next sound buffer to finish playing. The task should use
||| that signal in WaitSignal() to enter wait state where it can wait for the
||| buffer to finish playing. When it exits wait state, it passes the signal
||| mask returned to ServiceSoundFile() as the next buffer to write to.
|||
||| Arguments
|||
||| sfp A pointer to the SoundFilePlayer data
||| structure.
|||
||| SignalIn A signal mask containing bits set
||| corresponding to the cue bits of sound
||| buffers to be filled.
|||
||| SignalNeeded A pointer to a signal mask where the
||| procedure writes the cue bit of the sound
||| buffers for which the task should wait.
|||
||| Return Value
|||
||| This procedure returns 0 if successful or an error code (a negative value)
||| if an error occurs.
|||
||| Implementation
|||
||| Library call implemented in music.lib V20.
|||
||| Associated Files
|||
||| soundfile.h, music.lib
|||
||| See Also
|||
||| OpenSoundFile(), CloseSoundFile(), DeleteSoundFile(), LoadSoundFile(),
||| ReadSoundFile(), RewindSoundFile(), StartSoundFile(), StopSoundFile(),
||| UnloadSoundFile(), CreateSoundFilePlayer()
|||
**/
int32 ServiceSoundFile ( SoundFilePlayer *sfp, int32 SignalIn, int32 *SignalNeeded)
{
int32 Result = 0;
SoundSpooler *sspl;
SoundBufferNode *sbn;
int32 NumBuffers;
DBUG(("ServiceSoundFile: Played = %d, BI=%d\n", sfp->sfp_BuffersPlayed, sfp->sfp_BufIndex));
sspl = sfp->sfp_Spooler;
if ( SignalIn )
{
/* Tell sound spooler that some buffers have completed. */
NumBuffers = ssplProcessSignals( sspl, SignalIn, NULL );
CHECKRESULT(NumBuffers,"ssplProcessSignals");
sfp->sfp_BuffersPlayed += NumBuffers;
#ifdef DEBUG
{
char *CurAddr;
CurAddr = DSPWhereDMA(0);
LOGDATA((int32)CurAddr,logCurAddrA);
LOGDATA(sfp->sfp_Cursor,logCursor);
LOGDATA(SignalIn,logSignal);
LOGDATA(GetCurrentSignals(),logCurSignal);
LOGDATA(sfp->sfp_BufIndex,logBufIndex);
LOGDATA(-1,logUnlink);
}
#endif
/* If there is anything left to read, go get it. */
do
{
sbn = NULL;
if (sfp->sfp_Cursor < sfp->sfp_NumToRead)
{
/* Fill up the buffers */
if( (sbn = ssplRequestBuffer( sspl )) != NULL)
{
DBUG(("ServiceSoundFile: sbn=0x%08x, Addr = 0x%08x\n", sbn, sbn->sbn_Address ));
Result = ReadSoundFileAddr( sfp, sfp->sfp_Cursor, sbn->sbn_Address, SNDF_IF_ASYNC);
if (Result < 0) return Result;