home *** CD-ROM | disk | FTP | other *** search
/ Audio 4.94 - Over 11,000 Files / audio-11000.iso / amiga / utils / atools / audiotol.c < prev    next >
C/C++ Source or Header  |  1988-03-23  |  36KB  |  1,085 lines
  1. /* audiotools2.c  */
  2.  
  3. /* audiotools.h built in here so that audiotools is a package deal */ 
  4.  
  5. #define StartChannel(c) ControlChannel(c, CMD_START) 
  6. #define StopChannel(c)  ControlChannel(c, CMD_STOP) 
  7. #define ResetChannel(c) ControlChannel(c, CMD_RESET) 
  8. #define FlushChannel(c) ControlChannel(c, CMD_FLUSH) 
  9.  
  10. #define  BIG_WAVE          256L   /* size of biggest waveform */ 
  11. #define  NBR_WAVES         7L     /* number of waves per instrument */ 
  12. #define  WAVES_TOTAL       1024L  /* alloc size for instrument's waves */ 
  13.  
  14. #define  DEFAULT_DURATION  500L   /* 500/1000ths of a second default */ 
  15. #define  AUDBUFFERS        20L    /* iob msg packets before need to allot */ 
  16. #define  YES               1L 
  17. #define  NO                0L 
  18.  
  19. #define  BAD_CHANNEL_SELECTED -1L /* channel # out of range */ 
  20. #define  NOT_YOUR_CHANNEL     -2L /* not owned by your task */ 
  21. #define  OUT_OF_RANGE_FREQ    -3L /* frequency that we cannot play */ 
  22. #define  OUT_OF_RANGE_PRI     -4L /* priority value wont fit in 1 byte */ 
  23.  
  24. /* REDEFINITION from article - now contains one new field at the bottom 
  25.  * of the data structure. 
  26.  */ 
  27. struct ExtIOB { 
  28.     struct      IORequest ioa_Request; 
  29.     WORD        ioa_AllocKey; 
  30.     UBYTE       *ioa_Data; 
  31.     ULONG       ioa_Length; 
  32.     UWORD       ioa_Period; 
  33.     UWORD       ioa_Volume; 
  34.     UWORD       ioa_Cycles; 
  35.     struct      Message ioa_WriteMsg;   /* up to here, same as IOAudio */ 
  36.     LONG        iob_Identifier;         /* This field is added */ 
  37. }; 
  38.  
  39. /* a few forward declarations */ 
  40.  
  41. extern struct ExtIOB    *GetIOB(); 
  42. extern int              FreeIOB(); 
  43. extern int              GetChannel(); 
  44. extern int              GetStereoPair(); 
  45. extern int              InitBlock(); 
  46. extern struct MsgPort   *CreatePort(); 
  47.  
  48. extern APTR             AllocMem(); 
  49. extern struct Message   *GetMsg(); 
  50. extern struct Task      *FindTask(); 
  51.  
  52. struct auMsg { 
  53.    struct Message au_Message; 
  54.    LONG aum_Identifier;   /* matches the bottom of ExtIOB */ 
  55. }; 
  56.  
  57. /* Note that the definition of ExtIOB has now been changed (added to) */ 
  58.  
  59. /* forward declaration */ 
  60. extern struct MsgPort *InitAudio(); 
  61.  
  62. /* these are used to keep track of allocated channels */ 
  63.  
  64. struct Unit     *unit[4];       /* global pointers to Units        */ 
  65. WORD            key[4];         /* global value for alloc keys     */ 
  66. struct Task     *usertask[4];   /* in preparation for making this 
  67.                                  * a shared library of routines 
  68.                                  * (loadable from disk), keep track 
  69.                                  * of which user actually owns a 
  70.                                  * channel currently. 
  71.                                  */ 
  72.  
  73. struct  IOAudio         openIOB;      /* IOB to open and close the device */ 
  74. struct  MsgPort         *auReplyPort; /* temporary pointer */ 
  75. struct  MsgPort         *controlPort; /* Port for ControlChannel functions */ 
  76.  
  77. char    *globalname     = "global";     /* the name for global IOB's  */ 
  78. char    *dynamicname    = "dynamic";    /* the name for dynamic IOB's */ 
  79.  
  80. UBYTE stereostuff[4]    = { 3, 5, 10, 12 };     /* channel masks for stereo */ 
  81. UBYTE anychan[4]        = { 1, 2, 4, 8 };       /* channel masks for mono */ 
  82.  
  83. /* Resolve most all externals */ 
  84.  
  85. struct ExtIOB           audbuffer[AUDBUFFERS];  /* globals to build-in       */ 
  86. UBYTE                   *chipaudio[4];  /* pointers to waveforms in CHIP RAM */ 
  87. struct Device           *device;        /* global pointer to audio device  */ 
  88. LONG                    datalength[4];  /* length of the data for a wave   */ 
  89. struct MsgPort          *replyPort[4];  /* one ReplyPort per channel       */ 
  90. BYTE                    inuse[AUDBUFFERS]; /* keep track of globals in-use */ 
  91. LONG                    dynamix[4];     /* counters for how many 
  92.                                          * dynamically allocated audio 
  93.                                          * message I/O blocks  
  94.                                          */ 
  95.  
  96.  
  97. /* Each waveform buffer contains 8 octaves of the wave.   
  98.  * The offset values specify where in the buffer the 
  99.  * proper waveform table for that octave begins. 
  100.  */ 
  101. int woffsets[]  = { 0, 256, 384, 448, 480, 496, 504, 508, 510 }; 
  102.  
  103. /* Length of each waveform within a buffer */ 
  104. int wlen[]      = { 256, 128, 64, 32, 16, 8, 4, 2, 1 }; 
  105.  
  106. /* Period value to go with particular notes within an octave. */ 
  107. int perval[]    = { 428, 404, 381, 360, 339, 320,  
  108.                     302, 285, 269, 254, 240, 226, 214 }; 
  109.  
  110. UBYTE *w1, *w2, *w3; 
  111. BYTE *owptr[4]  = { NULL, NULL, NULL, NULL }; 
  112.  
  113. /* InitAudio is different from that published in the article - 
  114.   
  115. InitAudio now returns a value, an address of a message port at which 
  116. your task receives a message when a particular note BEGINS to play. 
  117. You must save this value somewhere, and use it to call MayGetNote 
  118. or FinishAudio.  MayGetNote is the name of the routine that you call 
  119. to check if a note has begun to play. 
  120.  
  121. InitAudio also has been modified to return to its caller when there 
  122. are problems, rather than calling finishup routines itself.  This is better 
  123. programming practice. 
  124.  
  125. */ 
  126.  
  127. struct MsgPort *     
  128. InitAudio() 
  129. { 
  130.       LONG error,i; 
  131.       struct MsgPort *userport; /* NEW item */ 
  132.  
  133.       LONG firstuser;   /* THIS WILL GET MOVED when shared library is made */ 
  134.       firstuser = TRUE; 
  135.  
  136.       /* Declare all message blocks available */ 
  137.       for(i=0; i<AUDBUFFERS; i++)  {   inuse[i] = NO;   } 
  138.  
  139.       /* Open device but don't allocate channels     */ 
  140.       openIOB.ioa_Length = 0;   /* (no allocation table) */ 
  141.  
  142.       error = OpenDevice("audio.device",0,&openIOB,0); 
  143.       if(error) return((struct MsgPort *)0); 
  144.  
  145.       /* Get the device address for later use */ 
  146.       device = openIOB.ioa_Request.io_Device; 
  147.     
  148.    /* Create ports for replies from each channel as well as 
  149.     * one port to be used for the control and synchonous functions */ 
  150.  
  151.    for(i=0; i<4; i++)  
  152.    {    
  153.       auReplyPort = CreatePort(0,0); 
  154.       replyPort[i] = auReplyPort; 
  155.       if(auReplyPort == 0) return((struct MsgPort *)0); 
  156.       chipaudio[i] = 0;  /* have not yet created the waves */ 
  157.  
  158.       datalength[i] = 1; /* might use for custom sound samples  */ 
  159.  
  160.       /* Also, zero out key values for each channel, as well as 
  161.        * unit value and usertask value (no channel owned by any task) 
  162.        */ 
  163.  
  164.         /* When implemented as a shared library, "firstuser" will only  
  165.          * be true when the library is first opened. 
  166.          */ 
  167.       if(firstuser)      
  168.       { 
  169.         key[i]  = 0; 
  170.         unit[i] = 0; 
  171.         usertask[i] = 0; 
  172.       } 
  173.    } 
  174.    controlPort = CreatePort(0,0); 
  175.    if(controlPort == 0) return((struct MsgPort *)0); 
  176.  
  177.    error = MakeWaves(); 
  178.    if(error == -1) return((struct MsgPort *)0); 
  179.  
  180.    for(i=0; i<4; i++) 
  181.    { dynamix[i] = 0; }   /* no dynamic I/O blocks allocated  
  182.                           * for any channel thus far */ 
  183.  
  184.    userport = CreatePort(0,0); 
  185.  
  186. return(userport); 
  187. } 
  188.  
  189. int  
  190. CheckIOBDone() 
  191. { 
  192.    LONG i, status; 
  193.  
  194.    status = 0;   /* means there are still some iob's in play */ 
  195.          /* when status = 5, then everything is free */ 
  196.  
  197.    for(i=0; i<AUDBUFFERS; i++) 
  198.    {   if(inuse[i] == YES) 
  199.        {    
  200.          /* Sooner or later, this will catch both 
  201.           * the statics and dynamics.  Note that 
  202.           * this will only work if NO (REPEAT: NO) 
  203.           * iob's sent off with a duration value 
  204.           * of "0", because zero means "forever" 
  205.           */ 
  206.          ReEmployIOB(); 
  207.       } 
  208.    } 
  209.    /* Note to implementors... maintaining inuse[i] now seems 
  210.     * like a lousy idea, unless it is accompanied by a variable 
  211.     * statics_inplay that decrements to zero when all statics 
  212.     * are done.  That makes it much easier to check than going 
  213.     * through all of the inuse[]'s. 
  214.     */ 
  215.  
  216.    for(i=0; i<4; i++) 
  217.    {    
  218.       if(dynamix[i] > 0)   
  219.             /* If this channel still playing a   */ 
  220.                  /* dynamically allocated block, wait */ 
  221.                  /* for all messages to return before */ 
  222.                  /* the program exits.                */ 
  223.       { 
  224.                 ReEmployIOB();  /* take another shot at freeing it all */   
  225.       } 
  226.    } 
  227.    for(i=0; i<4; i++)   /* Check again as we nearly exit */ 
  228.    { 
  229.       if(dynamix[i] == 0) status++; 
  230.    } 
  231.    if(status == 4)      /* All dynamics are free, now check 
  232.              * the statics.  Any not free force 
  233.              * an early return. */ 
  234.    { 
  235. #ifdef DEBUG 
  236.       printf("ch0,1,2,3 have %ld,%ld,%ld,%ld dyn.blocks playing\n", 
  237.          dynamix[0], dynamix[1], dynamix[2], dynamix[3]); 
  238. #endif DEBUG 
  239.       for(i=0; i<AUDBUFFERS; i++) 
  240.       { 
  241.          if(inuse[i] == YES) 
  242.          { 
  243. #ifdef DEBUG 
  244.          printf("iob still in use is: %ld\n",i); 
  245. #endif DEBUG 
  246.          return(0); 
  247.          } 
  248.       } 
  249.       printf("All global I/O blocks are done\n"); 
  250.  
  251.       return(1);   /* DONE! */ 
  252.    } 
  253.    else 
  254.    { 
  255.       return(0);   /* still some out there! */ 
  256.    } 
  257. } 
  258.  
  259.  
  260. FinishAudio(uport) 
  261. struct MsgPort *uport; 
  262. { 
  263.    LONG i; 
  264.    struct auMsg *aum;       /* A little bigger than a standard 
  265.                              * message, but this routine will 
  266.                              * not really know (or care) about 
  267.                              * the difference. 
  268.                              */ 
  269.    if(uport == 0) 
  270.    { 
  271.         goto no_init;       /* InitAudio didn't work, bypass 
  272.                              * the usual port emptying and so on. 
  273.                              */ 
  274.    } 
  275.    /* If the user says FinishAudio, IT MEANS FINISH AUDIO. 
  276.     * Flush anything that is still in play, NOW.  You can 
  277.     * use "CheckIOBDone()" to see if everything is finished 
  278.     * BEFORE you call FinishAudio.  If CheckIOBDone() is 
  279.     * equal to zero (FALSE), it means that something is still 
  280.     * playing. 
  281.     */ 
  282.    for(i=0; i<4; i++)   FlushChannel(i); 
  283.  
  284.    while(CheckIOBDone() == 0) 
  285.    { 
  286.       Delay(12);   /* Be a good multitasking neighbor; 
  287.                     * sleep a little before trying again */ 
  288.    } 
  289.    /* Empty the port if the user has not yet done so */ 
  290.    while((aum = (struct auMsg *)GetMsg(uport)) != NULL) 
  291.    { 
  292.       aum->au_Message.mn_ReplyPort = 0;   /* let system deallocate it */ 
  293.    } 
  294.    ReEmployIOB();   /* free all static and dynamic messages */ 
  295.  
  296.    for(i=0; i<4; i++)   FreeChannel(i); 
  297.  
  298. no_init: 
  299.    if(device) CloseDevice(&openIOB); 
  300.    printf("closed the device\n"); 
  301.  
  302.    for(i=0; i<4; i++) 
  303.    { 
  304.         if(chipaudio[i]) FreeMem(chipaudio[i],WAVES_TOTAL); 
  305.         if(replyPort[i])  
  306.         DeletePort(replyPort[i]); 
  307.    } 
  308.    if(controlPort) DeletePort(controlPort); 
  309.  
  310.    return(0);      /* no errors */ 
  311. } 
  312.   
  313.   
  314. int 
  315. ControlChannel(channel, command) 
  316.    WORD channel; 
  317.    WORD command; 
  318. { 
  319.    LONG rtn; 
  320.    struct ExtIOB *iob, controlIOB; 
  321.  
  322.    if(channel < 0 || channel > 3)       return(BAD_CHANNEL_SELECTED); 
  323.    if(usertask[channel] != FindTask(0)) return(NOT_YOUR_CHANNEL); 
  324.  
  325.    iob = &controlIOB; 
  326.    iob->ioa_Request.io_Device    = device; 
  327.    iob->ioa_Request.io_Message.mn_ReplyPort = controlPort; 
  328.  
  329.    InitBlock(iob,channel);   /* init it for CMD_WRITE, then change */ 
  330.  
  331.    iob->ioa_Request.io_Command = command; 
  332.    iob->ioa_Request.io_Flags   = IOF_QUICK; 
  333.  
  334.    BeginIO(iob); 
  335.    WaitIO(iob); 
  336.    rtn = ((LONG)(iob->ioa_Request.io_Error)); 
  337.    return(rtn); 
  338. } 
  339.   
  340. struct ExtIOB * 
  341. GetIOB(ch) 
  342.    LONG ch; 
  343. { 
  344.    WORD i,use_reply; 
  345.    struct ExtIOB *iob;  /* in case we need to allocate one */ 
  346.    ReEmployIOB();    /* find already used ones and free them */ 
  347.               /* so that when we do a get... */ 
  348.    if(ch == -1)  use_reply = 0;  /* which reply port to use */ 
  349.    else          use_reply = ch; 
  350.  
  351.    for(i=0; i<AUDBUFFERS; i++) 
  352.    {    
  353.         if(inuse[i] == NO) 
  354.         {    
  355.                 inuse[i] = YES; 
  356.  
  357.                 audbuffer[i].ioa_Request.io_Device    = device; 
  358.                 audbuffer[i].ioa_Request.io_Message.mn_ReplyPort =  
  359.                                                 replyPort[use_reply]; 
  360.                 audbuffer[i].ioa_Request.io_Message.mn_Length = i; 
  361.                 audbuffer[i].ioa_Request.io_Message.mn_Node.ln_Name =  
  362.                                                 globalname; 
  363. #ifdef DEBUG 
  364.       printf("Using global iob\n"); 
  365. #endif DEBUG 
  366.       return(&audbuffer[i]); 
  367.        } 
  368.    } 
  369.    /* if all globals are in use, have to allocate one */ 
  370.    iob = (struct ExtIOB *)AllocMem(sizeof(struct ExtIOB), 
  371.                      MEMF_CLEAR | MEMF_FAST ); 
  372.    if(iob == 0) return(0);   /* out of memory */ 
  373.    else 
  374.    {    
  375.         iob->ioa_Request.io_Device = device; 
  376.         iob->ioa_Request.io_Message.mn_ReplyPort =  
  377.                replyPort[use_reply]; 
  378.         iob->ioa_Request.io_Message.mn_Node.ln_Name =  
  379.                dynamicname; 
  380.         iob->ioa_Request.io_Message.mn_Length = dynamix[use_reply]; 
  381.         dynamix[use_reply] += 1; /* add one to number allocated 
  382.                                   * for a specific channel */ 
  383. #ifdef DEBUG 
  384.         printf("Using dynamic iob\n"); 
  385. #endif DEBUG 
  386.         return(iob); 
  387.         } 
  388. return(0); 
  389. } 
  390.   
  391.   
  392. /* Free a global or an allocated IOB */ 
  393. int 
  394. FreeIOB(iob, ch) 
  395.    struct ExtIOB *iob; 
  396.    LONG ch;   /* which channel was it attached to? */ 
  397. { 
  398.    WORD i; 
  399.  
  400.    if(iob->ioa_Request.io_Message.mn_Node.ln_Name == dynamicname) 
  401.    {    
  402.         FreeMem(iob, sizeof(struct ExtIOB)); 
  403.         if(dynamix[ch]) dynamix[ch] -= 1; /* subtract one if nonzero */ 
  404.         return(0L); 
  405.    } 
  406.    else if(iob->ioa_Request.io_Message.mn_Node.ln_Name == globalname) 
  407.    {     
  408.         i = iob->ioa_Request.io_Message.mn_Length; 
  409.  
  410.         if(i < AUDBUFFERS) 
  411.         {    
  412.                 inuse[i] = NO;   /* frees this one for reuse */ 
  413.         } 
  414.         return(0L); 
  415.    } 
  416.    /* if get here, the names don't match... something is wrong.*/ 
  417.    else  
  418.    {    
  419.                 printf("FreeIOB: names don't match...unknown error\n"); 
  420.                 return(-1);   /* unknown source of IOB fed to routine. */ 
  421.    } 
  422. return(0); 
  423. } 
  424.   
  425. /* Initialize an audio I/O block for default CMD_WRITE operation. */ 
  426. int 
  427. InitBlock(iob, channel) 
  428.      struct ExtIOB *iob; 
  429.    WORD channel; 
  430. { 
  431.    /* Device and ReplyPort fields have been initialized by GetIOB */ 
  432.    iob->ioa_Request.io_Unit = unit[channel]; 
  433.  
  434.    /* Allocation key */ 
  435.    iob->ioa_AllocKey = key[channel]; 
  436.  
  437.    /* Where is the waveform?  Just be sure is in MEMF_CHIP!!! */ 
  438.  
  439.    /* USER initializes datalength[ch] before calling this;    */ 
  440.    /* for sampled sound command write operation.              */ 
  441.    iob->ioa_Data    = chipaudio[channel]; 
  442.    iob->ioa_Length = datalength[channel]; 
  443.  
  444.    /* Another routine, must initialize: 
  445.  
  446.       period      ioa_Period 
  447.       volume      ioa_Volume 
  448.       cycles      ioa_Cycles 
  449.       message      ioa_WriteMsg 
  450.    */ 
  451.    /* Default command type is CMD_WRITE */ 
  452.    iob->ioa_Request.io_Command = CMD_WRITE; 
  453.  
  454.    /* If IOF_QUICK is zeroed, this would affect the 
  455.     * period and volume.  If a CMD_WRITE, it queues if 
  456.     * another note is already playing.  We queue CMD_WRITES. 
  457.     */ 
  458.    iob->ioa_Request.io_Flags = ADIOF_PERVOL; 
  459.    return(0); 
  460. } 
  461.   
  462.   
  463. /* To request "any" channel, use ch = -1; 
  464.  * To request a specific channel, use ch = {0, 1, 2 or 3}; 
  465.  * Again NOTE, this returns two globals as well as the channel number! 
  466.  */ 
  467.  
  468. int 
  469. GetChannel(ch) 
  470.    LONG ch; 
  471. { 
  472.    int error, value; 
  473.    struct ExtIOB *iob, controlIOB; 
  474.  
  475.    iob = &controlIOB; 
  476.    iob->ioa_Request.io_Device    = device; 
  477.    iob->ioa_Request.io_Message.mn_ReplyPort = controlPort; 
  478.  
  479.    InitBlock(iob,0);   /* init it for CMD_WRITE, then change */ 
  480.  
  481.    iob->ioa_Request.io_Message.mn_Node.ln_Pri = 20; 
  482.    iob->ioa_Request.io_Command = ADCMD_ALLOCATE; 
  483.  
  484.    if(ch == -1) 
  485.    {    
  486.         iob->ioa_Data = (UBYTE *)anychan; 
  487.         iob->ioa_Length = 4; 
  488.    } 
  489.    else if(ch >=0 && ch <= 3) 
  490.    {     
  491.         /* Test to be sure that this channel is now free.  If 
  492.          * usertask[i] is not zero, either the current task  
  493.          * has already allocated this channel, or a different 
  494.          * task is now using it.  
  495.          */ 
  496.  
  497.         /* NOTE ***** ENHANCEMENT COMING HERE ***** */ 
  498.  
  499.         if(usertask[ch] != 0) return(-1); 
  500.  
  501.         /* Enhancement might be: look at the running priority 
  502.          * of the current task as compared to the running priority 
  503.          * of the task in usertask[i].  If not same task and if 
  504.          * the current task has a higher priority, STEAL the channel! 
  505.          * Alternative (seems better) is to have a global variable 
  506.          * called audPriority to be set by a new function SetAudPriority 
  507.          * (for a given task only), and that global priority value 
  508.          * would be used for GetChannel and LockChannel requests. 
  509.          */ 
  510.         iob->ioa_Data = (UBYTE *)(&anychan[ch]); 
  511.         iob->ioa_Length = 1; 
  512.    } 
  513.    else   /* chose a bad channel number; cannot allocate it */ 
  514.    {    
  515.         return(-1); 
  516.    } 
  517.    iob->ioa_Request.io_Flags = ADIOF_NOWAIT | IOF_QUICK; 
  518.    BeginIO(iob);  
  519.    error = WaitIO(iob);  /* returns nonzero if error */ 
  520.    if(!(iob->ioa_Request.io_Flags & IOF_QUICK)) 
  521.    {    
  522.         GetMsg(iob->ioa_Request.io_Message.mn_ReplyPort); 
  523.    } 
  524.    if(error) 
  525.    {    
  526.         return(-1); 
  527.    } 
  528.    switch((LONG)(iob->ioa_Request.io_Unit)) 
  529.    {    
  530.         case  1:   value = 0;   break; 
  531.         case  2:   value = 1;   break; 
  532.         case  4:   value = 2;   break; 
  533.         case  8:   value = 3;   break; 
  534.         default:   value = -1;  break; 
  535.    } 
  536.    if(value == -1) return(-1L); 
  537.  
  538.    unit[value]     = (iob->ioa_Request.io_Unit); 
  539.    key[value]      = (iob->ioa_AllocKey); 
  540.    usertask[value] = FindTask(0);       /* THIS user task owns it now */ 
  541.  
  542.    return(value); 
  543. } 
  544.  
  545. int 
  546. FreeChannel(channel) 
  547.    LONG channel; 
  548. { 
  549.    int error; 
  550.    struct ExtIOB *iob, controlIOB; 
  551.  
  552.    if(channel < 0 || channel > 3)       return(BAD_CHANNEL_SELECTED); 
  553.    if(usertask[channel] != FindTask(0)) return(NOT_YOUR_CHANNEL); 
  554.  
  555.    iob = &controlIOB; 
  556.    iob->ioa_Request.io_Device    = device; 
  557.    iob->ioa_Request.io_Message.mn_ReplyPort = controlPort; 
  558.  
  559.    InitBlock(iob,channel);      /* init it for CMD_WRITE, then change it */ 
  560.                                 /* (pick up unit, key value for channel) */ 
  561.    iob->ioa_Request.io_Command = ADCMD_FREE; 
  562.    iob->ioa_Request.io_Flags = ADIOF_NOWAIT | IOF_QUICK; 
  563.    BeginIO(iob);  
  564.    error = WaitIO(iob);  /* returns nonzero if error */ 
  565.  
  566.    /* Educational note - the docs indicate that audio, even though  
  567.     * told to do an io item as "quickio", can, if it chooses, not do 
  568.     * it quick.  In that case, the reply is queued to the 
  569.     * reply port and it has to be removed.  That is why 
  570.     * the following status check has been installed here. 
  571.     * (Actually this check probably can be removed because 
  572.     * WaitIO, just above, removes the message from the port 
  573.     * if it does arrive there after all.) 
  574.     */ 
  575.    if(!(iob->ioa_Request.io_Flags & IOF_QUICK)) 
  576.    {     
  577.         GetMsg(iob->ioa_Request.io_Message.mn_ReplyPort); 
  578.    } 
  579.    usertask[channel] = 0;       /* free again... */ 
  580.    if(error) 
  581.    {    
  582.         return(error); 
  583.    } 
  584.    return(0); 
  585. } 
  586.   
  587. /* SOME OF THE FOLLOWING ROUTINES ARE PARAPHRASED FROM A USENET and BIX 
  588.  * POSTING MADE IN 1985 BY STEVEN A. BENNETT.   
  589.  */ 
  590. /* I have modified his routines to queue the audio commands in  
  591.  * place of starting forever-duration and canceling each note. 
  592.  * Many of his original comments have been incorporated into 
  593.  * the article.  
  594.  */ 
  595.  
  596. /* PlayNote(...) */ 
  597.  
  598. /* ******************************************************************* */ 
  599. /* NOTE: There are some differences in PlayNote as compared to the article. 
  600.  * See the audiotools.DOC for details. 
  601.  */ 
  602. /* ******************************************************************* */ 
  603.  
  604. /* Starts a sound on the channel with specified period and volume. */ 
  605. /* This nice little routine takes a note and plays it on the given 
  606.  * voice.  The note is basically an integer from 
  607.  * 0 to 11 (c to b) plus 12 per octave above the first and lowest.  
  608.  * 
  609.  * The waveform to use is determined by adding an index (woffsets[])  
  610.  * dependant on the octave. 
  611.  * 
  612.  * The length of the waveform (in wlen[]) is likewise dependant on 
  613.  * the octave.  Note that octaves start with zero, not one. 
  614.  */ 
  615. int  
  616. PlayNote(channel, note, wf, vol, duration, priority, messageport, id) 
  617.    char *wf;   /* waveform to use */ 
  618.    LONG vol, channel, duration, note;   /* specific note number */ 
  619.    LONG priority; 
  620.    struct MsgPort *messageport; 
  621.    LONG id; 
  622. { 
  623.    LONG per, len, oct;   /* period, length of waveform, which octave */ 
  624.    char *wavepointer;   /* where to find start of waveform */ 
  625.    struct ExtIOB *iob; 
  626.    int frequency; 
  627.  
  628.    if(channel < 0 || channel > 3)       return(BAD_CHANNEL_SELECTED); 
  629.    if(usertask[channel] != FindTask(0)) return(NOT_YOUR_CHANNEL); 
  630.    if(note < 0 || note > 95)            return(OUT_OF_RANGE_FREQ); 
  631.    if(priority < -128 || priority > 127)return(OUT_OF_RANGE_PRI); 
  632.  
  633.    iob = GetIOB(channel); 
  634.   
  635.    if(iob != 0) 
  636.    { 
  637.         InitBlock(iob, channel);   /* set up for CMD_WRITE */ 
  638.     
  639.         oct = note / 12; 
  640.         wavepointer = wf + woffsets[oct]; 
  641.         len = wlen[oct]; 
  642.         per = perval[note % 12]; 
  643.  
  644.         /* Set the parameters */ 
  645.         iob->ioa_Data = (UBYTE *)wavepointer; 
  646.         iob->ioa_Length = len; 
  647.         iob->ioa_Period = per; 
  648.         iob->ioa_Volume = vol; 
  649.  
  650.         iob->ioa_Request.io_Message.mn_Node.ln_Pri = priority; 
  651.  
  652.         /* additions for support of tell-me-when-note-starts */ 
  653.  
  654.         iob->iob_Identifier = id; 
  655.  
  656.         /* Initialize message port.  If 0, then no pushing back 
  657.          * of a message.  If nonzero, message gets recirculated 
  658.          * by ReEmployIOB until the user finally acknowledges it 
  659.          * by using MayGetNote. 
  660.          */ 
  661.         iob->ioa_WriteMsg.mn_ReplyPort = messageport; 
  662.  
  663.         if(messageport != 0) 
  664.         { 
  665.                 /* If 0, no sending message when note plays; 
  666.                  * if nonzero, user gets a message that can 
  667.                  * be read by MayGetNote.  uport, received from  
  668.                  * InitAudio, is where the message goes */ 
  669.  
  670.             /* Tell the audio device to "reply" to this message */ 
  671.             iob->ioa_Request.io_Flags |= ADIOF_WRITEMESSAGE; 
  672.         } 
  673.   
  674.    /* Look at the frequency that it is to play by backwards calc. */ 
  675.    frequency = 3579545 / (len * per); 
  676.  
  677.    /* Calculate cycles from duration in 1000ths of a second */ 
  678.    /* Multiply all-in-one to maintain max precision possible */ 
  679.    /* (all integer arithmetic.) */ 
  680.  
  681.    iob->ioa_Cycles = ((LONG)(frequency * duration)/1000); 
  682.    BeginIO(iob); 
  683.    return(0);      /* all went ok */ 
  684.    } 
  685. return(-1);     /* (else-part) iob was zero, couldn't do the above. */ 
  686. } 
  687.  
  688.    
  689. /* SetPV(channel, per, vol) 
  690.  *   int channel, per, vol; 
  691.  */ 
  692. int  
  693. SetPV(channel, per, vol) 
  694.    int channel, per, vol; 
  695.    { 
  696.    int error; 
  697.    struct ExtIOB *iob, controlIOB; 
  698.  
  699.    if(channel < 0 || channel > 3)       return(BAD_CHANNEL_SELECTED); 
  700.    if(usertask[channel] != FindTask(0)) return(NOT_YOUR_CHANNEL); 
  701.  
  702.    iob = &controlIOB; 
  703.    iob->ioa_Request.io_Device    = device; 
  704.    iob->ioa_Request.io_Message.mn_ReplyPort = controlPort; 
  705.  
  706.    InitBlock(iob, channel);   /* set up for CMD_WRITE */ 
  707.     
  708.    iob->ioa_Period = per; 
  709.    iob->ioa_Volume = vol; 
  710.    iob->ioa_Request.io_Command = ADCMD_PERVOL; 
  711.    iob->ioa_Request.io_Flags   = IOF_QUICK | ADIOF_PERVOL; 
  712.    BeginIO(iob);   /* This one will be synchronous; affects whatever 
  713.           * is playing on this channel at this time. 
  714.           */ 
  715.    error = WaitIO(iob);   /* OK to wait, since it will return */ 
  716.    return(error);      /* copy of io_Error field; should be 0 */ 
  717. } 
  718.   
  719. /* SetWaves(w1, w2, w3): create first sawtooth, triangle and square wave */ 
  720.  
  721. SetWaves(w1, w2, w3) 
  722.    UBYTE *w1, *w2, *w3; 
  723. { 
  724.    int i, increment, value, sqvalue; 
  725.    value = 0; increment = 2; 
  726.    sqvalue = 127; 
  727.  
  728.    for (i = 0; i < BIG_WAVE; ++i) 
  729.    { 
  730.    w1[i] = i;   /* do the sawtooth */ 
  731.  
  732.    if(i > 62 && i < 180) increment = -2; 
  733.    else 
  734.    if(i >= 180) increment = 2; 
  735.  
  736.    w2[i] = value;  value += increment;  /* triangle wave */ 
  737.  
  738.    if(i > 126) sqvalue = -127; 
  739.  
  740.    w3[i] = sqvalue; 
  741.    } 
  742. return(0); 
  743. } 
  744.    
  745. /* ExpandWave(wfp) - replicate waves in decreasing sample sizes 
  746.  *   BYTE *wfp; 
  747.  */ 
  748.   
  749. ExpandWave(wfp) 
  750.    BYTE *wfp; 
  751.    { 
  752.    int i, j, rate; 
  753.    BYTE *tptr; 
  754.   
  755.    rate = 1; 
  756.    tptr = wfp + BIG_WAVE; 
  757.    for (i = 0; i < NBR_WAVES - 1; ++i) 
  758.       { 
  759.       rate *= 2; 
  760.       for (j = 0; j < BIG_WAVE; j += rate) 
  761.          *tptr++ = wfp[j]; 
  762.       } 
  763.    return(0); 
  764.    } 
  765.    
  766. /* MakeWaves() 
  767.  * 
  768.  *   Just makes a sawtooth, triangle and square wave in chip mem  
  769.  * and expands them. 
  770.  */ 
  771. int  
  772. MakeWaves() 
  773. { 
  774.    /* allocate the memory for the waveforms. 
  775.     */ 
  776.    w1 = (UBYTE *)AllocMem(WAVES_TOTAL, MEMF_CHIP); 
  777.    w2 = (UBYTE *)AllocMem(WAVES_TOTAL, MEMF_CHIP); 
  778.    w3 = (UBYTE *)AllocMem(WAVES_TOTAL, MEMF_CHIP); 
  779.  
  780.    if (w1 == NULL || w2 == NULL || w3 == NULL) 
  781.    return(-1);   /* ran out of memory! */ 
  782.   
  783.    /* get and expand the waveforms    */ 
  784.  
  785.    SetWaves(w1, w2, w3); 
  786.    ExpandWave(w1);   chipaudio[0]=w1; 
  787.    ExpandWave(w2);   chipaudio[1]=w2; 
  788.    ExpandWave(w3);   chipaudio[2]=w3; 
  789.    return(0); 
  790. } 
  791.  
  792. /* =================================================================== */ 
  793. /* Here are NEW routines that did not appear in the AmigaWorld article. 
  794.  * These are in addition to the changes noted above for InitAudio and 
  795.  * FinishAudio, and changes in main() to accommodate them. 
  796.  */ 
  797.  
  798. /* PlayFreq in this version is for INTEGER values of frequency only. 
  799.  * 
  800.  * To be more precise, you'll have to convert the integer calculations 
  801.  * to floating point.   Almost identical to PlayNote, however, had to 
  802.  * add some error checking to the parameters AHEAD OF GetIOB because 
  803.  * if the frequency is out of range of what we have in our wave tables 
  804.  * currently, we have to reject the command.  If it got rejected 
  805.  * after Getting an IOB, then we'd have to free it. 
  806.  */ 
  807. int  
  808. PlayFreq(channel, freq, wf, vol, duration, priority, messageport, id) 
  809.    char *wf;   /* waveform to use */ 
  810.    LONG vol, channel, duration, freq;   /* specific integer frequency */ 
  811.    LONG priority; 
  812.    struct MsgPort *messageport; 
  813.    LONG id; 
  814. { 
  815.    LONG per, len, oct;   /* period, length of waveform, which octave */ 
  816.    char *wavepointer;   /* where to find start of waveform */ 
  817.    struct ExtIOB *iob; 
  818.    LONG i, isave, accept; 
  819.  
  820.    if(channel < 0 || channel > 3)       return(BAD_CHANNEL_SELECTED); 
  821.    if(usertask[channel] != FindTask(0)) return(NOT_YOUR_CHANNEL); 
  822.    if(priority < -128 || priority > 127)return(OUT_OF_RANGE_PRI); 
  823.  
  824.    /* see if we CAN represent this frequency, if not, reject it */ 
  825.  
  826.    for(i=0; i<9; i++) 
  827.    { 
  828.            /* Now figure out which waveform to use... 
  829.             * start with the first wlen value because 
  830.             * we want to use the longest waveform we can. 
  831.             */ 
  832.         isave = i;    
  833.  
  834.         accept = FALSE; 
  835.  
  836.         per = 3579545 / (freq * wlen[i]); 
  837.  
  838.         if(per > 127 && per < 500) 
  839.         { 
  840.                 accept = TRUE; 
  841.                 break; 
  842.         } 
  843.    } 
  844.    if(accept != TRUE)                   return(OUT_OF_RANGE_FREQ); 
  845.  
  846.    iob = GetIOB(channel); 
  847.  
  848.    if(iob != 0) 
  849.    { 
  850.         InitBlock(iob, channel);   /* set up for CMD_WRITE */ 
  851.  
  852.         oct = isave;         /* show the octave we are in */ 
  853.         wavepointer = wf + woffsets[oct];   /* point to longest wave */ 
  854.         len = wlen[oct];      /* show its length */ 
  855.  
  856.         /* Set the parameters */ 
  857.         iob->ioa_Data = (UBYTE *)wavepointer; 
  858.         iob->ioa_Length = len; 
  859.         iob->ioa_Period = per; 
  860.         iob->ioa_Volume = vol; 
  861.  
  862.         iob->ioa_Request.io_Message.mn_Node.ln_Pri = priority; 
  863.  
  864.         /* additions for support of tell-me-when-note-starts */ 
  865.         iob->iob_Identifier = id; 
  866.  
  867.         /* see note on same line for PlayNote above */ 
  868.         iob->ioa_WriteMsg.mn_ReplyPort = messageport; 
  869.  
  870.         if(messageport != 0) 
  871.         { 
  872.                 /* If 0, no sending message when note plays; 
  873.                  * if nonzero, user gets a message that can 
  874.                  * be read by MayGetNote.  uport, received from  
  875.                  * InitAudio, is what should be the value of 
  876.                  * messageport.  
  877.                  */  
  878.  
  879.             /* Tell the audio device to "reply" to this message */ 
  880.             iob->ioa_Request.io_Flags |= ADIOF_WRITEMESSAGE; 
  881.         } 
  882.  
  883.    /* Calculate cycles from duration in 1000ths of a second */ 
  884.    /* Multiply all-in-one to maintain max precision possible */ 
  885.    /* (all integer arithmetic.) */ 
  886.  
  887.    iob->ioa_Cycles = ((LONG)(freq * duration)/1000); 
  888.    BeginIO(iob); 
  889.    return(0);      /* all went ok */ 
  890.    } 
  891. return(-1L);    /* (else-part) iob value was zero, out of memory probably */ 
  892. } 
  893.  
  894.  
  895. /* Another new routine called MayGetNote.  Its syntax is: 
  896.  * 
  897.  *      note = MayGetNote(uport, flag) 
  898.  * 
  899.  * where uport is the address of the port you received from InitAudio. 
  900.  * 
  901.  *       flag  is a value of 0 or 1. 
  902.  * 
  903.  *          when flag = 0, the routine returns immediately, with 
  904.  *               a note value of 0 (no note available), or 
  905.  *               the value of the first note notification  
  906.  *               to arrive at the port. 
  907.  * 
  908.  *          when flag = nonzero, the routine will wait if (and only if) 
  909.  *               there is no note to be had.  In other words, 
  910.  *               you can cause your task to go to sleep until 
  911.  *               the next note begins to play.  You decide 
  912.  *               what to do for a specific note value. 
  913.  * 
  914.  *     note  is the value you placed into the PlayNote or PlayFreq 
  915.  *               identifier field.  A report of this type 
  916.  *               is ONLY generated when "messageport" is nonzero.  
  917.  *    
  918.  *   CAUTION - if there are no more notes with messageport nonzero in 
  919.  *         the queue and you specify TRUE for the flag, you can cause your 
  920.  *         task to sleep forever!! 
  921.  */ 
  922.  
  923. LONG 
  924. MayGetNote(uport, flag) 
  925.    struct MsgPort *uport; 
  926.    LONG flag; 
  927. { 
  928.    struct auMsg *aum; 
  929.    LONG wakemask; 
  930.    struct Message *writemsg; 
  931.    
  932. grabmessage: 
  933.    aum = (struct auMsg *)GetMsg(uport);   /* is a message there? */ 
  934.  
  935.    if(aum)   /* There was a message! */  
  936.    { 
  937.       /* The user has seen this msg, so the system can deallocate 
  938.        * the iob in which it occurs anytime in the future. 
  939.        * Now that we have received the message at our own reply 
  940.        * port, it belongs to us and we can do whatever we want 
  941.        * to it.  Set the reply port value to zero now, as a signal 
  942.        * to FreeIOB that it can really do that!  
  943.        */ 
  944.       aum->au_Message.mn_ReplyPort = 0; 
  945.  
  946.       return(aum->aum_Identifier);  /* return the value */ 
  947.    } 
  948.    if(flag) /* If nonzero, we cause caller to sleep while 
  949.              * waiting for any identified iob to appear. 
  950.              */ 
  951.    { 
  952.       wakemask = WaitPort(uport);  /* not using wakemask */ 
  953.       flag = 0; 
  954.       goto grabmessage;   /* a goto!  aaarrrggghhh! */ 
  955.    } 
  956. return(0L);    
  957. } 
  958.  
  959. /* ReEmployIOB is not new (as compared to article) but it 
  960.  * has changed a lot since the article was written. 
  961.  */ 
  962.  
  963. /* ReEmployIOB - look at ALL of the reply ports and if any IOBs 
  964.  *        hanging around with nothing to do, free them. 
  965.  * 
  966.  *       In the article, this routine removed iob's from the 
  967.  *       reply ports via the usual GetMsg function.  This 
  968.  *       was not practical in this case when adding the support 
  969.  *       for audio messages from the device.   
  970.  * 
  971.  *  Problem was this: 
  972.  *       Audio may still be playing the waveform as we get a 
  973.  *       message through MayGetNote.  MayGetNote marks the 
  974.  *       iob message block as free-able, (when it finds that 
  975.  *       the identifier field is set to zero) but we have to have a 
  976.  *       way of recirculating in this list of messages. 
  977.  * 
  978.  *       In other words, if something is free-able, free it, 
  979.  *       otherwise leave it on the list.  So rather than 
  980.  *       removing things from the front of the list, lets just 
  981.  *       walk through the message list, Remove (dequeue) what is  
  982.  *       freeable and leave the rest there to look at the next time. 
  983.  */ 
  984.  
  985. ReEmployIOB() 
  986. { 
  987.    LONG i; 
  988.    struct MsgPort *mp; 
  989.    struct ExtIOB *iob; 
  990.  
  991.    /* now declare a pointer to "the first iob pushed back onto the port" */ 
  992.  
  993.    struct ExtIOB *pushback;      
  994.  
  995.    /* What happens here is that iob's are removed from the message port 
  996.     * when they come back from the audio device.   If YOU have set the 
  997.     * messageport nonzero, it means that you wanted to know when 
  998.     * this note began to play.  The WriteMsg part of the iob is then 
  999.     * linked, as a message, onto your user port.  So this routine here 
  1000.     * cannot free the iob until it is certain that YOU have finished 
  1001.     * using it.  The iob_Priority field is READ here.  If it still 
  1002.     * nonzero, the iob is pushed back onto the message port (on the 
  1003.     * end of the message queue) to be read again.  We hold a pointer 
  1004.     * named pushback that lets us keep track of when we see that 
  1005.     * again.  If we see it twice, it means we have completed a full 
  1006.     * circle through the queue of messages and have freed everything 
  1007.     * that we can this time.  Therefore, we examine it and either 
  1008.     * free it or push it back again, then exit. 
  1009.     */ 
  1010.  
  1011.    /* Tiny drawback to the pushback that we do is that there can 
  1012.     * be more than one dynamic IOB with the same identifier value. 
  1013.     * The id value is not used anywhere, execept for the debug 
  1014.     * reporting, so it is not critical.  Note that this is not 
  1015.     * a problem with a pushback of a static iob because the inuse[] 
  1016.     * array is being maintained for the statics. 
  1017.     */ 
  1018.    for(i=0; i<4; i++)   /* remove all iob's from ALL ports */ 
  1019.                         /* (that is, unless we have to push one back) */ 
  1020.    {    
  1021.       mp = replyPort[i]; 
  1022.  
  1023.       pushback = (struct ExtIOB *)0;    /* nothing pushed back so far */ 
  1024.  
  1025.       while((iob = (struct ExtIOB *)GetMsg(mp)) != 0) 
  1026.       {  
  1027.             /* Here is what triggers the Identifier message for MayGetNote */ 
  1028.  
  1029.             /* First see if messageport in WriteMsg is greater than zero; 
  1030.              * if so, audio device is done, but user hasnt acknowledged 
  1031.              * this message yet (by using MayGetNote). 
  1032.              */ 
  1033.             if(iob->ioa_WriteMsg.mn_ReplyPort != 0) 
  1034.             { 
  1035.                 /* If we get here, we already know we will push it back */ 
  1036.                 /* because User has not yet freed it (using MayGetNote) */ 
  1037.  
  1038.                 PutMsg(mp, iob); 
  1039.  
  1040.                 if(iob == pushback) /* If so, we saw it already */ 
  1041.                 { 
  1042.                         break;     /* Go out to empty next port */ 
  1043.                 } 
  1044.                 if(pushback == 0) 
  1045.                 { 
  1046.                         pushback = iob; /* Remember FIRST one pushed back */ 
  1047.                 } 
  1048.             } 
  1049.             else        /* messageport value is zero, can free the iob */ 
  1050.             { 
  1051. #ifdef DEBUG 
  1052.                 printf("freeing %ls iob; ID=%ld\n", 
  1053.                       iob->ioa_Request.io_Message.mn_Node.ln_Name, 
  1054.                       iob->ioa_Request.io_Message.mn_Length); 
  1055. #endif DEBUG 
  1056.                 FreeIOB(iob,i); 
  1057.             } 
  1058.       } 
  1059.  
  1060.    } 
  1061.    return(0); 
  1062. } 
  1063.  
  1064. /* Use this next function to determine if you (still) own a particular channel. 
  1065.  * The audio device has an arrangement by which a higher priority request 
  1066.  * for a channel than the one that already owns it can be made.  The higher 
  1067.  * priority request can actually cause a channel to be stolen from a user. 
  1068.  * This feature may be implemented in a future version of audiotools, 
  1069.  * (shared library version), in which, depending on the task's running 
  1070.  * priority itself, a higher priority task could succeed at GetChannel 
  1071.  * for a channel that is already owned by another task. 
  1072.  */ 
  1073.  
  1074. int 
  1075. IsThatMyChan(channel)   /* returns nonzero if YOU still own the channel */ 
  1076.         LONG channel; 
  1077. { 
  1078.         if(channel < 0 || channel > 3)          return(0); 
  1079.         if(usertask[channel] == FindTask(0))    return(TRUE); 
  1080.         return(0); 
  1081. } 
  1082.  
  1083.  
  1084. /*  end of file */
  1085.