/[svn]/liblscp/trunk/src/common.h
ViewVC logotype

Annotation of /liblscp/trunk/src/common.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 975 - (hide annotations) (download) (as text)
Sun Dec 17 00:59:40 2006 UTC (17 years, 3 months ago) by capela
File MIME type: text/x-c++hdr
File size: 8607 byte(s)
* MIDI instrument mapping, second round, according to
  LSCP 1.2 draft document as of December 15, 2006.

* New client interface functions:
     lscp_set_channel_midi_map();
     lscp_add_midi_instrument_map();
     lscp_remove_midi_instrument_map();
     lscp_get_midi_instrument_maps();
     lscp_list_midi_instrument_maps();
     lscp_get_midi_instrument_map_name();
     lscp_set_midi_instrument_map_name();

1 capela 103 // common.h
2     //
3     /****************************************************************************
4     liblscp - LinuxSampler Control Protocol API
5 capela 869 Copyright (C) 2004-2006, rncbc aka Rui Nuno Capela. All rights reserved.
6 capela 103
7     This library is free software; you can redistribute it and/or
8     modify it under the terms of the GNU Lesser General Public
9     License as published by the Free Software Foundation; either
10     version 2.1 of the License, or (at your option) any later version.
11    
12     This library is distributed in the hope that it will be useful,
13     but WITHOUT ANY WARRANTY; without even the implied warranty of
14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15     Lesser General Public License for more details.
16    
17 capela 921 You should have received a copy of the GNU General Public License along
18     with this program; if not, write to the Free Software Foundation, Inc.,
19     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 capela 103
21     *****************************************************************************/
22    
23     #ifndef __LSCP_COMMON_H
24     #define __LSCP_COMMON_H
25    
26     #include "lscp/client.h"
27     #include "lscp/device.h"
28    
29    
30     // Case unsensitive comparison substitutes.
31     #if defined(WIN32)
32     #define strcasecmp stricmp
33     #define strncasecmp strnicmp
34     #endif
35    
36     //-------------------------------------------------------------------------
37     // Client opaque descriptor struct.
38    
39     struct _lscp_client_t
40     {
41 capela 952 // Client socket stuff.
42     lscp_client_proc_t pfnCallback;
43     void * pvData;
44     lscp_socket_agent_t cmd;
45     lscp_socket_agent_t evt;
46     // Subscribed events.
47     lscp_event_t events;
48     // Client struct persistent caches.
49     char ** audio_drivers;
50     char ** midi_drivers;
51     int * audio_devices;
52     int * midi_devices;
53     char ** engines;
54     int * channels;
55     lscp_midi_instrument_t *midi_instruments;
56 capela 975 int * midi_maps;
57     char * midi_map_name;
58 capela 952 // Client struct volatile caches.
59     lscp_driver_info_t audio_driver_info;
60     lscp_driver_info_t midi_driver_info;
61     lscp_device_info_t audio_device_info;
62     lscp_device_info_t midi_device_info;
63     lscp_param_info_t audio_param_info;
64     lscp_param_info_t midi_param_info;
65     lscp_device_port_info_t audio_channel_info;
66     lscp_device_port_info_t midi_port_info;
67     lscp_param_info_t audio_channel_param_info;
68     lscp_param_info_t midi_port_param_info;
69     lscp_server_info_t server_info;
70     lscp_engine_info_t engine_info;
71     lscp_channel_info_t channel_info;
72     lscp_midi_instrument_info_t midi_instrument_info;
73     // Result and error status.
74     char * pszResult;
75     int iErrno;
76     // Stream buffers status.
77     lscp_buffer_fill_t *buffer_fill;
78     int iStreamCount;
79     // Transaction call timeout (msecs).
80     int iTimeout;
81     lscp_mutex_t mutex;
82     lscp_cond_t cond;
83     // Flag last transaction timedout.
84     int iTimeoutCount;
85 capela 103 };
86    
87    
88     //-------------------------------------------------------------------------
89 capela 132 // Local client request executive.
90    
91 capela 253 lscp_status_t lscp_client_recv (lscp_client_t *pClient, char *pchBuffer, int *pcchBuffer, int iTimeout);
92 capela 948 lscp_status_t lscp_client_call (lscp_client_t *pClient, const char *pszQuery, int iResult);
93 capela 132 void lscp_client_set_result (lscp_client_t *pClient, char *pszResult, int iErrno);
94    
95     //-------------------------------------------------------------------------
96 capela 103 // General utility function prototypes.
97    
98 capela 948 char * lscp_strtok (char *pchBuffer, const char *pszSeps, char **ppch);
99     char * lscp_ltrim (char *psz);
100     char * lscp_unquote (char **ppsz, int dup);
101     void lscp_unquote_dup (char **ppszDst, char **ppszSrc);
102 capela 103
103 capela 948 char ** lscp_szsplit_create (const char *pszCsv, const char *pszSeps);
104     void lscp_szsplit_destroy (char **ppszSplit);
105 capela 103 #ifdef LSCP_SZSPLIT_COUNT
106 capela 948 int lscp_szsplit_count (char **ppszSplit);
107     int lscp_szsplit_size (char **ppszSplit);
108 capela 103 #endif
109    
110 capela 948 int * lscp_isplit_create (const char *pszCsv, const char *pszSeps);
111     void lscp_isplit_destroy (int *piSplit);
112 capela 125 #ifdef LSCP_ISPLIT_COUNT
113 capela 948 int lscp_isplit_count (int *piSplit);
114     int lscp_isplit_size (int *piSplit);
115 capela 125 #endif
116 capela 103
117 capela 948 lscp_param_t * lscp_psplit_create (const char *pszCsv, const char *pszSep1, const char *pszSep2);
118     void lscp_psplit_destroy (lscp_param_t *ppSplit);
119 capela 158 #ifdef LSCP_PSPLIT_COUNT
120 capela 948 int lscp_psplit_count (lscp_param_t *ppSplit);
121     int lscp_psplit_size (lscp_param_t *ppSplit);
122 capela 158 #endif
123    
124 capela 171 void lscp_plist_alloc (lscp_param_t **ppList);
125     void lscp_plist_free (lscp_param_t **ppList);
126     void lscp_plist_append (lscp_param_t **ppList, const char *pszKey, const char *pszValue);
127     #ifdef LSCP_PLIST_COUNT
128     int lscp_plist_count (lscp_param_t **ppList);
129     int lscp_plist_size (lscp_param_t **ppList);
130     #endif
131    
132 capela 948 lscp_midi_instrument_t *lscp_midi_instruments_create (const char *pszCsv);
133     void lscp_midi_instruments_destroy (lscp_midi_instrument_t *pInstrs);
134     #ifdef LSCP_MIDI_INSTRUMENTS_COUNT
135     int lscp_midi_instruments_count (lscp_midi_instrument_t *pInstrs);
136     int lscp_midi_instruments_size (lscp_midi_instrument_t *pInstrs);
137     #endif
138    
139    
140 capela 103 //-------------------------------------------------------------------------
141 capela 564 // Server struct helper functions.
142    
143     void lscp_server_info_init (lscp_server_info_t *pServerInfo);
144     void lscp_server_info_free (lscp_server_info_t *pServerInfo);
145     void lscp_server_info_reset (lscp_server_info_t *pServerInfo);
146    
147     //-------------------------------------------------------------------------
148 capela 103 // Engine struct helper functions.
149    
150 capela 132 void lscp_engine_info_init (lscp_engine_info_t *pEngineInfo);
151 capela 179 void lscp_engine_info_free (lscp_engine_info_t *pEngineInfo);
152 capela 132 void lscp_engine_info_reset (lscp_engine_info_t *pEngineInfo);
153 capela 103
154     //-------------------------------------------------------------------------
155     // Channel struct helper functions.
156    
157 capela 132 void lscp_channel_info_init (lscp_channel_info_t *pChannelInfo);
158 capela 179 void lscp_channel_info_free (lscp_channel_info_t *pChannelInfo);
159 capela 132 void lscp_channel_info_reset (lscp_channel_info_t *pChannelInfo);
160 capela 103
161     //-------------------------------------------------------------------------
162     // Driver struct helper functions.
163    
164 capela 132 void lscp_driver_info_init (lscp_driver_info_t *pDriverInfo);
165 capela 179 void lscp_driver_info_free (lscp_driver_info_t *pDriverInfo);
166 capela 132 void lscp_driver_info_reset (lscp_driver_info_t *pDriverInfo);
167 capela 103
168 capela 163 //-------------------------------------------------------------------------
169 capela 171 // Device struct helper functions.
170    
171     void lscp_device_info_init (lscp_device_info_t *pDeviceInfo);
172 capela 179 void lscp_device_info_free (lscp_device_info_t *pDeviceInfo);
173 capela 171 void lscp_device_info_reset (lscp_device_info_t *pDeviceInfo);
174    
175     //-------------------------------------------------------------------------
176     // Device channel/port struct helper functions.
177    
178     void lscp_device_port_info_init (lscp_device_port_info_t *pDevicePortInfo);
179 capela 179 void lscp_device_port_info_free (lscp_device_port_info_t *pDevicePortInfo);
180 capela 171 void lscp_device_port_info_reset (lscp_device_port_info_t *pDevicePortInfo);
181    
182     //-------------------------------------------------------------------------
183 capela 163 // Parameter struct helper functions.
184 capela 103
185 capela 163 void lscp_param_info_init (lscp_param_info_t *pParamInfo);
186 capela 179 void lscp_param_info_free (lscp_param_info_t *pParamInfo);
187 capela 163 void lscp_param_info_reset (lscp_param_info_t *pParamInfo);
188    
189     //-------------------------------------------------------------------------
190     // Concatenate a parameter list (key='value'...) into a string.
191    
192     int lscp_param_concat (char *pszBuffer, int cchMaxBuffer, lscp_param_t *pParams);
193    
194 capela 946 //-------------------------------------------------------------------------
195     // MIDI instrument info struct helper functions.
196 capela 163
197 capela 948 void lscp_midi_instrument_info_init (lscp_midi_instrument_info_t *pInstrInfo);
198     void lscp_midi_instrument_info_free (lscp_midi_instrument_info_t *pInstrInfo);
199     void lscp_midi_instrument_info_reset (lscp_midi_instrument_info_t *pInstrInfo);
200 capela 946
201    
202 capela 103 #endif // __LSCP_COMMON_H
203    
204     // end of common.h

  ViewVC Help
Powered by ViewVC