home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional Developers Kit 1992 November / Disc01 / Disc01.mdf / runnable / mmos2 / mmtoolkt / h / mcidrv.h < prev    next >
Encoding:
C/C++ Source or Header  |  1992-05-06  |  9.7 KB  |  179 lines
  1. /****************************************************************************/
  2. /*                                                                          */
  3. /* Module Name: MCIDRV.H                                                    */
  4. /*                                                                          */
  5. /* This is the multimedia include file that has the typedefs, defines and   */
  6. /* function prototyes for MCI drivers.                                      */
  7. /*                                                                          */
  8. /* Copyright (c) International Business Machines Corporation 1991, 1992     */
  9. /*                        All Rights Reserved                               */
  10. /*                                                                          */
  11. /****************************************************************************/
  12.  
  13. typedef    USHORT   GID;
  14.  
  15. /****************************************************************************/
  16. /*             MCI Driver  message identifiers                              */
  17. /****************************************************************************/
  18. #define MCIDRV_SAVE                 900
  19. #define MCIDRV_RESTORE              901
  20. #define MCIDRV_SYNC                 902
  21. #define MCIDRV_CHANGERESOURCE       903
  22.  
  23. /*********************************************************************/
  24. /* The following range of message ID's are reserved for internal use */
  25. /*  by MCI drivers                                                   */
  26. /*********************************************************************/
  27. #define MCI_INTERNAL_MESSAGES_START    1000
  28. #define MCI_INTERNAL_MESSAGES_END      1999
  29.  
  30. /*********************************************************************/
  31. /* Flags used by the string parser for command tables                */
  32. /* NOTE: All flags must have an "L" suffix in order to be parsed as  */
  33. /* DWORDs by the resource compiler                                   */
  34. /*********************************************************************/
  35. #define MCI_COMMAND_HEAD                 0x00000001L
  36. #define MCI_END_COMMAND                  0x00000002L
  37. #define MCI_END_COMMAND_LIST             0x00000003L
  38. #define MCI_RETURN                       0x00000004L
  39. #define MCI_STRING                       0x00000005L
  40. #define MCI_FLAG                         0x00000006L
  41. #define MCI_INTEGER                      0x00000007L
  42. #define MCI_CONSTANT                     0x00000008L
  43. #define MCI_CONSTANT_INTEGER             0x00000009L
  44. #define MCI_CONSTANT_STRING              0x0000000AL
  45. #define MCI_END_CONSTANT                 0x0000000BL
  46. #define MCI_DEFAULT_STRING               0x0000000CL
  47. #define MCI_DEFAULT_INTEGER              0x0000000DL
  48. #define MCI_RETURN_TYPE                  0x0000000EL
  49. #define MCI_RETURN_TYPE_STRING           0x0000000FL
  50. #define MCI_END_RETURN_TYPE              0x00000010L
  51. #define MCI_CONSTANT_2                   0x00000011L
  52. #define MCI_END_CONSTANT_2               0x00000012L
  53. #define MCI_CONSTANT_PAIR                0x00000013L
  54. #define MCI_END_CONSTANT_PAIR            0x00000014L
  55. #define MCI_CONSTANT_INTEGER_PAIR        0x00000015L
  56. #define MCI_CONSTANT_STRING_PAIR         0x00000016L
  57.  
  58. /*********************************************************************/
  59. /* Return types supported by mciSendString                           */
  60. /*********************************************************************/
  61. #define MCI_INTEGER_RETURNED                     0x1000
  62. #define MCI_COLONIZED2_RETURN                    0x2000
  63. #define MCI_COLONIZED3_RETURN                    0x3000
  64. #define MCI_COLONIZED4_RETURN                    0x4000
  65. #define MCI_TRUE_FALSE_RETURN                    0x5000
  66. #define MCI_ON_OFF_RETURN                        0x6000
  67. #define MCI_DEVICENAME_RETURN                    0x7000
  68. #define MCI_TIME_FORMAT_RETURN                   0x8000
  69. #define MCI_SPEED_FORMAT_RETURN                  0x9000
  70. #define MCI_MODE_RETURN                          0xA000
  71. #define MCI_MEDIA_TYPE_RETURN                    0xB000
  72. #define MCI_TRACK_TYPE_RETURN                    0xC000
  73. #define MCI_CONNECTOR_TYPE_RETURN                0xD000
  74. #define MCI_CDXA_CHANNEL_DESTINATION_RETURN      0xE000
  75. #define MCI_PREROLL_TYPE_RETURN                  0xF000
  76. #define MCI_FORMAT_TAG_RETURN                    0xF100
  77. #define MCI_SEQ_SYNCHRONIZATION_RETURN           0xF200
  78.  
  79. /*********************************************************************/
  80. /* End of msg text used by mciGetErrorString                         */
  81. /*********************************************************************/
  82. #define MCIERR_MSG_TABLE_END    MCIERR_BASE + 7000
  83.  
  84. /*********************************************************************/
  85. /*                                                                   */
  86. /*  MCI DEVICE shareability categories                               */
  87. /*                                                                   */
  88. /*********************************************************************/
  89. #define FIXEDSINGLECONTEXT            0x0001
  90. #define DYNAMICSINGLECONTEXT          0x0002
  91. #define LIMITEDMULTIPLECONTEXT        0x0003
  92. #define UNLIMITEDMULTIPLECONTEXT      0x0004
  93.  
  94. /*********************************************************************/
  95. /* MCI driver flag for close during exit list processing             */
  96. /*********************************************************************/
  97. #define MCI_CLOSE_EXIT                 0x10000000L
  98.  
  99. /*********************************************************************/
  100. /* MCI driver specific error table resource number base              */
  101. /*********************************************************************/
  102. #define MMERROR_TABLE_BASE      500
  103.  
  104. /*********************************************************************/
  105. /*                                                                   */
  106. /*  MCIDRV_CHANGERESOURCE  message flags                             */
  107. /*                                                                   */
  108. /*********************************************************************/
  109. #pragma pack(1)
  110.  
  111. typedef struct {
  112.    PVOID      pInstance;             /* pointer to device instance   */
  113.    USHORT     usResourceUnits;       /* required resource units      */
  114.    USHORT     usResourceClass;       /* resource class               */
  115.    USHORT     usResourcePriority;    /* resource priority            */
  116. } MCIDRV_CHANGERESOURCE_PARMS;
  117. typedef MCIDRV_CHANGERESOURCE_PARMS  *PMCIDRV_CHANGERESOURCE_PARMS;
  118.  
  119. /*********************************************************************/
  120. /*                                                                   */
  121. /*  MCIDRV_SYNC  message flags                                       */
  122. /*                                                                   */
  123. /*********************************************************************/
  124. #define MCIDRV_SYNC_ENABLE           0x00000100L
  125. #define MCIDRV_SYNC_DISABLE          0x00000200L
  126. #define MCIDRV_SYNC_REC_PULSE        0x00000400L
  127. #define MCIDRV_SYNC_MASTER           0x00000800L
  128.  
  129. typedef struct {
  130.     PVOID   pInstance;       /* pointer to the instance structure    */
  131.     GID     GroupID;         /* pointer to the instance structure    */
  132.     MMTIME  mmTime;          /* Synch pulse time                     */
  133.     HSTREAM hStream;         /* Stream handle                        */
  134. } MCIDRV_SYNC_PARMS;
  135. typedef MCIDRV_SYNC_PARMS *PMCIDRV_SYNC_PARMS;
  136.  
  137.  
  138. /*********************************************************************/
  139. /* contains information for open message for MCI drivers             */
  140. /*********************************************************************/
  141. typedef struct {
  142.     DWORD   dwCallback;    /* call back handle                       */
  143.     WORD    wDeviceID;     /* The device ID assigned to this instance*/
  144.     USHORT  usDeviceType;  /* The device type number                 */
  145.     USHORT  usDeviceOrd;   /* The device ordinal number              */
  146.     PVOID   pInstance;     /* pointer to the instance structure allocated */
  147.                            /* initialized by the driver. The MCI driver   */
  148.                            /* will fill in this parameter.                */
  149.     CHAR    szDevDLLName[260]; /* Character string containing the device  */
  150.                                /* specific DLL name to call for the open. */
  151.                                /* (ie. ACPA.DLL)                          */
  152.     LPSTR   lpstrElementName;/* typically a file name or NULL             */
  153.     USHORT  usDevParmLen;  /* Device parameters data block length.        */
  154.     PVOID   pDevParm;      /* Device parameters data block. This data     */
  155.                            /* block is unique to each type of device.     */
  156.                            /* (ie. LVD "COM1 9600 N 7 1").                */
  157.     PVOID   Reserved0;
  158.     USHORT  usResourceUnitsRequired;  /* number of resource units this instance */
  159.                                       /* requires.                              */
  160.     USHORT  usResourceClass;          /* resource class this instance belongs to*/
  161.     USHORT  usResourcePriority;       /* resource priority for this instance    */
  162.     DWORD   dwParam2;                 /* Pointer to MCI_OPEN structure          */
  163. } MMDRV_OPEN_PARMS;
  164. typedef MMDRV_OPEN_PARMS  *PMMDRV_OPEN_PARMS;
  165.  
  166.  
  167. #pragma pack()
  168. DWORD APIENTRY mdmDriverNotify (WORD    wDeviceID,
  169.                                 HWND    hwnd,
  170.                                 WORD    wMsgType,
  171.                                 WORD    wUserParm,
  172.                                 DWORD   dwMsgParm);
  173.  
  174. DWORD APIENTRY mdmSyncNotify   (PVOID  pInstance,
  175.                                 GID    GroupID,
  176.                                 ULONG  ulSyncTime,
  177.                                 DWORD  dwSyncFlags);
  178.  
  179.