libcm is a C development framework with an emphasis on audio signal processing applications.
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

cmMsgProtocol.h 5.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. #ifndef cmMsgProtocol_h
  2. #define cmMsgProtocol_h
  3. #include "cmAudioSysMsg.h"
  4. #ifdef __cplusplus
  5. extern "C" {
  6. #endif
  7. //( { file_desc:"Global constants and data structures for transmiting messages between threads and network nodes.", kw:[real_time]}
  8. #define cmAudDspSys_FILENAME "aud_dsp.js"
  9. // UI seletor id's used in the cmDspUiHdr_t selId field
  10. enum
  11. {
  12. kPrintDuiId, // ui<--eng print the value to the console
  13. kSliderDuiId, // ui<--eng create a slider control
  14. kButtonDuiId, // ui<--eng create button control
  15. kCheckDuiId, // ui<--eng create a check box control
  16. kLabelDuiId, // ui<--eng create a label control
  17. kTimeLineDuiId, // ui<--eng create a time-line control
  18. kScoreDuiId, // ui<--eng create a score control
  19. kTakeSeqBldrDuiId, // ui<--eng create a take sequence builder
  20. kTakeSeqRendDuiId, // ui<--eng create a take sequence renderer
  21. kTwodDuiId, // ui<--eng create a 2d control
  22. kNumberDuiId, // ui<--eng create a number box
  23. kTextDuiId, // ui<--eng create a text entry control
  24. kFnameDuiId, // ui<--eng create a file/directory picker control
  25. kMsgListDuiId, // ui<--eng create a msg list control
  26. kMeterDuiId, // ui<--eng create a meter display
  27. kValueDuiId, // ui<->eng a control changed values
  28. kColumnDuiId, // ui<--eng start a new column
  29. kHBorderDuiId, // ui<--eng insert a vertical border
  30. kPageDuiId, // ui<--eng insert a new control page
  31. kAudioSysCfgDuiId, // ui<--audio system cfg label
  32. kSubSysCntDuiId, // ui<--eng audio sub-system count
  33. kDeviceDuiId, // ui<--eng device label
  34. kProgramDuiId, // ui<--eng program label
  35. // The following selId's are used by cmAudDsp to indicate various commands.
  36. kSetAudioCfgDuiId, // 1) select an audio system setup
  37. kSetAudioDevDuiId, // 2) (optional) set an audio device on an audio sub-system
  38. kSetSampleRateDuiId, // 3) (optional) set the sample rate of an audio sub-system
  39. kSetPgmDuiId, // 4) select a program
  40. kEnableDuiId, // 5) enable/disable the audio system (also resets the DSP system)
  41. kSyncDuiId, // 6) sent by cmAudDsp to client to indicate sync success or failure.
  42. kSetNotifyEnableDuiId, // enable/disable periodic status notification from the audio system.
  43. kClientMsgPollDuiId, // Periodic check for and deliver messages waiting in the audio system for delivery to the client.
  44. kSendMsgDuiId, // forward msg to the audio system
  45. kDevReportDuiId, // print a device report
  46. kPrintPgmDuiId, // write the currently loaded pgm as a JSON file
  47. kRightAlignDuiId = 0, // label alignment id used by kLabelDuiId
  48. kLeftAlignDuiId,
  49. kCenterAlignDuiId
  50. };
  51. enum
  52. {
  53. kDuplexDuiFl = 0x01
  54. };
  55. // Header record for all messages between the host and the DSP controllers.
  56. typedef struct
  57. {
  58. unsigned asSubIdx; // the audio sub-system this UI belongs to
  59. unsigned uiId; // msg type kXXXAsId
  60. unsigned selId; // action to perform see above
  61. unsigned flags; //
  62. unsigned instId; // DSP instance id
  63. unsigned instVarId; // DSP instance var id
  64. // The cmDspValue_t field must come last in the structure in
  65. // order for the cmDsvSerialize() to work in cmDspUI.c:_cmDspUiMsg().
  66. cmDspValue_t value; // Data value associated with this msg.
  67. } cmDspUiHdr_t;
  68. // cmDspNetMsg_t sub-selector id's
  69. enum {
  70. kNetHelloSelAsId, // node->node awake msg
  71. kNetDstIdReqSelAsId, // src->dst request a dst id
  72. kNetDstIdReqDoneAsId, // src->dst all requests have been sent
  73. kNetDstIdSelAsId, // dst->src provide dst id
  74. kNetDoneSelAsId, // node->node sync done
  75. kNetErrSelAsId, // node->node sync error
  76. kNetEvtSelAsId // src->dst send cmDspEvnt_t
  77. };
  78. // Message Layout [ cmDspNetMsg_t dstInstLabel[] dstVarLabel[] ]
  79. typedef struct
  80. {
  81. unsigned asSubIdx;
  82. unsigned selId; // kNetSyncSelAsId
  83. unsigned subSelId; // see above kNetXXXSelAsId
  84. unsigned srcId;
  85. unsigned dstId;
  86. cmDspValue_t value;
  87. // char dstInstLabel[] - with kNetSyncSelAsId only
  88. // char dstVarLabel[] - with kNetSyncSelAsId only
  89. } cmDspNetMsg_t;
  90. enum
  91. {
  92. kOkMsgRC = cmOkRC,
  93. kSerializeFailMsgRC,
  94. kSendFailMsgRC,
  95. kDecodeFailMsgRC
  96. };
  97. typedef cmRC_t cmMsgRC_t;
  98. typedef cmMsgRC_t (*cmMsgSendFuncPtr_t)(void* cbDataPtr, unsigned msgByteCnt, const void* msg );
  99. cmMsgRC_t cmMsgSend(
  100. cmErr_t* err,
  101. unsigned asSubIdx,
  102. unsigned msgTypeId,
  103. unsigned selId,
  104. unsigned flags,
  105. unsigned instId,
  106. unsigned instVarId,
  107. const cmDspValue_t* valPtr,
  108. cmMsgSendFuncPtr_t sendFunc,
  109. void* cbDataPtr );
  110. cmMsgRC_t cmMsgPeekAsSubIndex( const void* msgArray[], unsigned msgByteCntArray[], unsigned segCnt, unsigned* retValPtr );
  111. cmMsgRC_t cmMsgPeekMsgTypeId( const void* msgArray[], unsigned msgByteCntArray[], unsigned segCnt, unsigned* retValPtr );
  112. cmMsgRC_t cmMsgPeekSelId( const void* msgArray[], unsigned msgByteCntArray[], unsigned segCnt, unsigned* retValPtr );
  113. cmMsgRC_t cmMsgPeekFlags( const void* msgArray[], unsigned msgByteCntArray[], unsigned segCnt, unsigned* retValPtr );
  114. cmMsgRC_t cmMsgPeekInstId( const void* msgArray[], unsigned msgByteCntArray[], unsigned segCnt, unsigned* retValPtr );
  115. cmMsgRC_t cmMsgPeekInstVarId( const void* msgArray[], unsigned msgByteCntArray[], unsigned segCnt, unsigned* retValPtr );
  116. //)
  117. #ifdef __cplusplus
  118. }
  119. #endif
  120. #endif