home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional Developers Kit 1992 November / Disc01 / Disc01.mdf / mmpm2tk / mmpmtlk2 / inc / evcb.inc < prev    next >
Encoding:
Text File  |  1992-05-06  |  12.0 KB  |  196 lines
  1. ;***************************************************************************  
  2. ;                                                                             
  3. ;  Module Name: EVCB.H                                                        
  4. ;                                                                             
  5. ;  OS/2 2.0 Multimedia Extensions Sync/Stream Manager Event Control           
  6. ;  Block defintitions.                                                        
  7. ;                                                                             
  8. ;  Copyright (c) International Business Machines Corporation 1991, 1992       
  9. ;                         All Rights Reserved                                 
  10. ;                                                                             
  11. ;***************************************************************************  
  12. ;**********************************************
  13. ;* List of Implicit events:
  14. ;*    EVENT_EOS                 - Use IMPL_EVCB
  15. ;*    EVENT_ERROR               - Use IMPL_EVCB
  16. ;*    EVENT_STREAM_STOPPED      - Use IMPL_EVCB
  17. ;*    EVENT_SYNC_PREROLLED      - Use IMPL_EVCB
  18. ;*    EVENT_PLAYLISTMESSAGE     - Use PLAYL_EVCB
  19. ;*    EVENT_PLAYLISTCUEPOINT    - Use PLAYL_EVCB
  20. ;*    EVENT_QUEUE_OVERFLOW      - Use IMPL_EVCB
  21. ;*********************************************  
  22. ;**********************************************
  23. ;* List of Explicit events:
  24. ;*    EVENT_SYNCOVERRUN         - Use OVRU_EVCB
  25. ;*    EVENT_CUE_TIME            - Use TIME_EVCB
  26. ;*    EVENT_CUE_DATA            - Use DATA_EVCB
  27. ;*    EVENT_DATAUNDERRUN        - Use EVCB
  28. ;*    EVENT_DATAOVERRUN         - Use EVCB
  29. ;*    EVENT_CUE_TIME_PAUSE      - Use TIME_EVCB
  30. ;*********************************************  
  31. EVENT_SYNCOVERRUN    EQU    4 
  32. EVENT_CUE_TIME    EQU    5        ;  Cue point in terms of stream time  
  33. EVENT_CUE_DATA    EQU    6        ;  Cue point in terms of data items   
  34. EVENT_DATAUNDERRUN    EQU    7        ;  data underrun event from SH      
  35. EVENT_DATAOVERRUN    EQU    8        ;  data underrun event from SH      
  36. EVENT_CUE_TIME_PAUSE    EQU    9        ;  Pause when cue-point reached.    
  37. ;**********************************************
  38. ;* SYNC_EVCB - Sync Pulse Event Control Block
  39. ;*             (This event is only seen by
  40. ;*              stream handlers)
  41. ;*********************************************  
  42. EVENT_SYNC    EQU    1      ;  Synchronization point in stream    
  43.  
  44. sync_evcb    STRUC
  45. syevcb_ulType    DD    ?                     ;  EVENT_SYNC                         
  46. syevcb_ulSubType    DD    ?                  ;  Not used                           
  47. syevcb_ulSyncFlags    DD    ?                ;  0 (input),status (output)          
  48. syevcb_hstream    DD    ?                    ;  handle to stream for this event    
  49. syevcb_hid    DD    ?                        ;  Handler id                         
  50. syevcb_ulStatus    DD    ?                   ;  Event status (output)              
  51. syevcb_mmtimeStart    DD    ?                ;  Filled in by Sync/Stream manager   
  52.                                        ;   at SpiEnableSync time. (input)    
  53. syevcb_mmtimeMaster    DD    ?               ;  Filled in by Master SH (input)     
  54. syevcb_mmtimeSlave    DD    ?                ;  Filled in by slave SH. (output)    
  55. sync_evcb    ENDS
  56. ;  ulSyncFlags:                                                              
  57. SYNCOVERRUN    EQU    0001H     ;  Set by SSM if sync pulse comes in before      
  58.                                        ;   a has processed the current sync pulse.      
  59. SYNCPOLLING    EQU    0002H     ;  SSM set this after filling the handler EVCB.  
  60.                                        ;   Handler resets it after it processes the     
  61.                                        ;   contents of EVCB. The SSM must check this    
  62.                                        ;   bit before modifying EVCB. If bit already    
  63.                                        ;   set, set the SYNC overrun bit.               
  64. EVENT_RESERVED    EQU    2      ;  RESERVED                           
  65. ;**********************************************
  66. ;* IMPL_EVCB - Implicit Event Control Block
  67. ;*             (This is a parameter on the
  68. ;*              SpiCreatStrem API)
  69. ;*********************************************  
  70. EVENT_IMPLICIT_TYPE    EQU    3      ;  These events are always supported  
  71.  
  72. impl_evcb    STRUC
  73. imevcb_ulType    DD    ?                     ;  EVENT_IMPLICIT_TYPE                
  74. imevcb_ulSubType    DD    ?                  ;  One of the implicit events (input)   
  75. imevcb_ulFlags    DD    ?                    ;  0 (Input), status (Output)           
  76. imevcb_hstream    DD    ?                    ;  handle to stream for this event (input/output)   
  77. imevcb_hid    DD    ?                        ;  0 (input), handler Id (output)       
  78. imevcb_ulStatus    DD    ?                   ;  Event status/error return code (output)   
  79. imevcb_unused1    DD    ?                    ;  0 (input)                          
  80. imevcb_unused2    DD    ?                    ;  0 (input)                          
  81. imevcb_unused3    DD    ?                    ;  0 (input)                          
  82. impl_evcb    ENDS
  83. ;  ulSubtype:                                                                
  84. EVENT_EOS    EQU    1      ;  End of Stream                      
  85. EVENT_ERROR    EQU    2      ;  Error in Stream handler or device driver          
  86. EVENT_STREAM_STOPPED    EQU    3      ;  Stream is in a stopped state (Discard or Flush)   
  87. EVENT_SYNC_PREROLLED    EQU    4      ;  All streams are prerolled (buffers     
  88.                                        ;   have been filled by the Source SH's.  
  89. EVENT_PLAYLISTMESSAGE    EQU    5      ;  Memory SH playlist message event       
  90. EVENT_PLAYLISTCUEPOINT    EQU    6      ;  Memory SH playlist cue point           
  91. EVENT_QUEUE_OVERFLOW    EQU    7      ;  Event Queue overflow. Indicates lost   
  92.                                        ;   events. Application must use this     
  93.                                        ;   to clear any waiting conditions.      
  94. ;**********************************************
  95. ;* PLAYL_EVCB - Playlist Message Event Control Block
  96. ;*********************************************  
  97. ;  (IMPLICIT EVENT)                                                          
  98.  
  99. playl_evcb    STRUC
  100. plevcb_ulType    DD    ?                     ;  EVENT_IMPLICIT_TYPE                
  101. plevcb_ulSubType    DD    ?                  ;  EVENT_PLAYLISTMESSAGE or EVENT_PLAYLISTCUEPOINT   
  102. plevcb_ulFlags    DD    ?                    ;  0 (input), status (output)                        
  103. plevcb_hstream    DD    ?                    ;  handle to stream for this event (input/output)    
  104. plevcb_hid    DD    ?                        ;  0 (input), handler Id (output)                    
  105. plevcb_ulStatus    DD    ?                   ;  Playlist Instruction number (output)              
  106. plevcb_ulMessageParm    DD    ?              ;  0 (input), Message from playlist (output)         
  107. plevcb_unused1    DD    ?                    ;  0 (input)                          
  108. plevcb_unused2    DD    ?                    ;  0 (input)                          
  109. playl_evcb    ENDS
  110. ;**********************************************
  111. ;* OVRU_EVCB - Sync Overrun Event Control Block
  112. ;*             (Applications can request to be
  113. ;*              notified whenever a Sync overrun
  114. ;*              occurs.
  115. ;*********************************************  
  116.  
  117. ovru_evcb    STRUC
  118. ovevcb_ulType    DD    ?                     ;  EVENT_SYNCOVERRUN                  
  119. ovevcb_ulSubType    DD    ?                  ;  Not used                           
  120. ovevcb_ulFlags    DD    ?                    ;  0 (input), status (output)         
  121. ovevcb_hstream    DD    ?                    ;  handle to stream for this event (input/output)   
  122. ovevcb_hid    DD    ?                        ;  handler Id (input/output)          
  123. ovevcb_ulStatus    DD    ?                   ;  Event status/error return code (output)   
  124. ovevcb_mmtimeSlave    DD    ?                ;  0 (input), Slave stream time (output)     
  125. ovevcb_mmtimeStart    DD    ?                ;  0 (input), Slave start offset (offset)    
  126. ovevcb_mmtimeMaster    DD    ?               ;  0 (input), Master stream time (output)    
  127. ovru_evcb    ENDS
  128. ;**********************************************
  129. ;* TIME_EVCB - Cue Time Event Control Block
  130. ;*             (Applications can request to be
  131. ;*              notified for a time cue point)
  132. ;*********************************************  
  133.  
  134. time_evcb    STRUC
  135. tievcb_ulType    DD    ?                     ;  EVENT_CUE_TIME                     
  136. tievcb_ulSubType    DD    ?                  ;  Not used                           
  137. tievcb_ulFlags    DD    ?                    ;  Single/Recurring(input/output)     
  138. tievcb_hstream    DD    ?                    ;  handle to stream for this event (input/output)  
  139. tievcb_hid    DD    ?                        ;  handler Id (input/output)                       
  140. tievcb_ulStatus    DD    ?                   ;  Event status/error return code (output)         
  141. tievcb_mmtimeStream    DD    ?               ;  Stream time (input/output)         
  142. tievcb_unused1    DD    ?                    ;  0 (input)                          
  143. tievcb_unused2    DD    ?                    ;  0 (input)                          
  144. time_evcb    ENDS
  145. ;                                                                            
  146. ;  ulFlags:                                                                  
  147. EVENT_SINGLE    EQU    0      ;  This is single one time event      
  148. EVENT_RECURRING    EQU    1      ;  This is recurring event            
  149. ;**********************************************
  150. ;* DATA_EVCB - Cue Data Event Control Block
  151. ;*             (Applications can request to be
  152. ;*              notified for a data cue point)
  153. ;*********************************************  
  154.  
  155. data_evcb    STRUC
  156. daevcb_ulType    DD    ?                     ;  EVENT_CUE_DATA                     
  157. daevcb_ulSubType    DD    ?                  ;  Event SubType                      
  158. daevcb_ulFlags    DD    ?                    ;  Single/Recurring(input/output)     
  159. daevcb_hstream    DD    ?                    ;  handle to stream for this event (input/output)   
  160. daevcb_hid    DD    ?                        ;  handler Id (input/output)                        
  161. daevcb_ulStatus    DD    ?                   ;  Event status/error return code (output)          
  162. daevcb_mmtimeStream    DD    ?               ;  Stream time (input/output)                       
  163. daevcb_ulEventParm1    DD    ?               ;  Data to Cue on (input/output)                    
  164.                                        ;   This is interpreted by the stream handler       
  165. daevcb_ulEventParm2    DD    ?               ;  Length of data cue buffer (input/output)         
  166. data_evcb    ENDS
  167. ;  ulFlags:                                                                  
  168. ; #define EVENT_SINGLE          0L        This is single one time event      
  169. ; #define EVENT_RECURRING       1L        This is recurring event            
  170. EVENT_DATAPTR    EQU    2      ;  ulEventParm1 if ptr to buffer and  
  171.                                        ;   ulEventParm2 is a length of buffer,   
  172.                                        ;   else ulEventParm1 is data.            
  173. ;******************
  174. ;* EVCB_ulType:  (Stream Handler defined types)
  175. ;*****************  
  176. SH_TYPE    EQU    80000000H   ;  Stream Handler defined types must   
  177.                                        ;  have the high order bit set in the  
  178.                                        ;  ulType field.                       
  179.                                        ;  events: 0H - 7FFFFFFFH are reserved!  
  180. ;**********************************************
  181. ;* EVCB - Generic Event Control Block (Use the
  182. ;*        specific one in the SSM.H if possible)
  183. ;*********************************************  
  184.  
  185. evcb    STRUC
  186. evcb_ulType    DD    ?                     ;  Event type (input)                 
  187. evcb_ulSubType    DD    ?                  ;  Event SubType (input)              
  188. evcb_ulFlags    DD    ?                    ;  0 (Input), status (Output)         
  189. evcb_hstream    DD    ?                    ;  handle to stream for this event    
  190. evcb_hid    DD    ?                        ;  handler Id (input/output)          
  191. evcb_ulStatus    DD    ?                   ;  Event status (output)              
  192. evcb_ulEventParm1    DD    ?               ;  Event parameters (input), HID if implicit event   
  193. evcb_ulEventParm2    DD    ?               ;  Event parameters (input)           
  194. evcb_ulEventParm3    DD    ?               ;  Event parameters (input)           
  195. evcb    ENDS
  196.