trunk/src/common.h

// common.h
//
/****************************************************************************
   liblscp - LinuxSampler Control Protocol API
   Copyright (C) 2004-2006, rncbc aka Rui Nuno Capela. All rights reserved.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU General Public License along
   with this program; if not, write to the Free Software Foundation, Inc.,
   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

*****************************************************************************/

#ifndef __LSCP_COMMON_H
#define __LSCP_COMMON_H

#include "lscp/client.h"
#include "lscp/device.h"


// Case unsensitive comparison substitutes.
#if defined(WIN32)
#define strcasecmp      stricmp
#define strncasecmp     strnicmp
#endif

//-------------------------------------------------------------------------
// Client opaque descriptor struct.

struct _lscp_client_t
{
    // Client socket stuff.
    lscp_client_proc_t  pfnCallback;
    void *              pvData;
    lscp_socket_agent_t cmd;
    lscp_socket_agent_t evt;
    // Subscribed events.
    lscp_event_t        events;
    // Client struct persistent caches.
    char **             audio_drivers;
    char **             midi_drivers;
    int  *              audio_devices;
    int  *              midi_devices;
    char **             engines;
    int  *              channels;
    // Client struct volatile caches.
    lscp_driver_info_t  audio_driver_info;
    lscp_driver_info_t  midi_driver_info;
    lscp_device_info_t  audio_device_info;
    lscp_device_info_t  midi_device_info;
    lscp_param_info_t   audio_param_info;
    lscp_param_info_t   midi_param_info;
    lscp_device_port_info_t audio_channel_info;
    lscp_device_port_info_t midi_port_info;
    lscp_param_info_t   audio_channel_param_info;
    lscp_param_info_t   midi_port_param_info;
    lscp_server_info_t  server_info;
    lscp_engine_info_t  engine_info;
    lscp_channel_info_t channel_info;
    lscp_midi_instrument_info_t midi_instrument_info;
    // Result and error status.
    char *              pszResult;
    int                 iErrno;
    // Stream buffers status.
    lscp_buffer_fill_t *buffer_fill;
    int                 iStreamCount;
    // Transaction call timeout (msecs).
    int                 iTimeout;
    lscp_mutex_t        mutex;
    lscp_cond_t         cond;
    // Flag last transaction timedout.
        int                 iTimeoutCount;
};


//-------------------------------------------------------------------------
// Local client request executive.

lscp_status_t   lscp_client_recv            (lscp_client_t *pClient, char *pchBuffer, int *pcchBuffer, int iTimeout);
lscp_status_t   lscp_client_call            (lscp_client_t *pClient, const char *pszQuery);
void            lscp_client_set_result      (lscp_client_t *pClient, char *pszResult, int iErrno);

//-------------------------------------------------------------------------
// General utility function prototypes.

char *          lscp_strtok                 (char *pchBuffer, const char *pszSeps, char **ppch);
char *          lscp_ltrim                  (char *psz);
char *          lscp_unquote                (char **ppsz, int dup);
void            lscp_unquote_dup            (char **ppszDst, char **ppszSrc);

char **         lscp_szsplit_create         (const char *pszCsv, const char *pszSeps);
void            lscp_szsplit_destroy        (char **ppszSplit);
#ifdef LSCP_SZSPLIT_COUNT
int             lscp_szsplit_count          (char **ppszSplit);
int             lscp_szsplit_size           (char **ppszSplit);
#endif

int *           lscp_isplit_create          (const char *pszCsv, const char *pszSeps);
void            lscp_isplit_destroy         (int *piSplit);
#ifdef LSCP_ISPLIT_COUNT
int             lscp_isplit_count           (int *piSplit);
int             lscp_isplit_size            (int *piSplit);
#endif

lscp_param_t *  lscp_psplit_create          (const char *pszCsv, const char *pszSep1, const char *pszSep2);
void            lscp_psplit_destroy         (lscp_param_t *ppSplit);
#ifdef LSCP_PSPLIT_COUNT
int             lscp_psplit_count           (lscp_param_t *ppSplit);
int             lscp_psplit_size            (lscp_param_t *ppSplit);
#endif

void            lscp_plist_alloc       (lscp_param_t **ppList);
void            lscp_plist_free        (lscp_param_t **ppList);
void            lscp_plist_append      (lscp_param_t **ppList, const char *pszKey, const char *pszValue);
#ifdef LSCP_PLIST_COUNT
int             lscp_plist_count       (lscp_param_t **ppList);
int             lscp_plist_size        (lscp_param_t **ppList);
#endif

//-------------------------------------------------------------------------
// Server struct helper functions.

void            lscp_server_info_init       (lscp_server_info_t *pServerInfo);
void            lscp_server_info_free       (lscp_server_info_t *pServerInfo);
void            lscp_server_info_reset      (lscp_server_info_t *pServerInfo);

//-------------------------------------------------------------------------
// Engine struct helper functions.

void            lscp_engine_info_init       (lscp_engine_info_t *pEngineInfo);
void            lscp_engine_info_free       (lscp_engine_info_t *pEngineInfo);
void            lscp_engine_info_reset      (lscp_engine_info_t *pEngineInfo);

//-------------------------------------------------------------------------
// Channel struct helper functions.

void            lscp_channel_info_init      (lscp_channel_info_t *pChannelInfo);
void            lscp_channel_info_free      (lscp_channel_info_t *pChannelInfo);
void            lscp_channel_info_reset     (lscp_channel_info_t *pChannelInfo);

//-------------------------------------------------------------------------
// Driver struct helper functions.

void            lscp_driver_info_init       (lscp_driver_info_t *pDriverInfo);
void            lscp_driver_info_free       (lscp_driver_info_t *pDriverInfo);
void            lscp_driver_info_reset      (lscp_driver_info_t *pDriverInfo);

//-------------------------------------------------------------------------
// Device struct helper functions.

void            lscp_device_info_init       (lscp_device_info_t *pDeviceInfo);
void            lscp_device_info_free       (lscp_device_info_t *pDeviceInfo);
void            lscp_device_info_reset      (lscp_device_info_t *pDeviceInfo);

//-------------------------------------------------------------------------
// Device channel/port struct helper functions.

void            lscp_device_port_info_init  (lscp_device_port_info_t *pDevicePortInfo);
void            lscp_device_port_info_free  (lscp_device_port_info_t *pDevicePortInfo);
void            lscp_device_port_info_reset (lscp_device_port_info_t *pDevicePortInfo);

//-------------------------------------------------------------------------
// Parameter struct helper functions.

void            lscp_param_info_init        (lscp_param_info_t *pParamInfo);
void            lscp_param_info_free        (lscp_param_info_t *pParamInfo);
void            lscp_param_info_reset       (lscp_param_info_t *pParamInfo);

//-------------------------------------------------------------------------
// Concatenate a parameter list (key='value'...) into a string.

int             lscp_param_concat           (char *pszBuffer, int cchMaxBuffer, lscp_param_t *pParams);

//-------------------------------------------------------------------------
// MIDI instrument info struct helper functions.

void            lscp_midi_instrument_info_init      (lscp_midi_instrument_info_t *pInstrInfo);
void            lscp_midi_instrument_info_free      (lscp_midi_instrument_info_t *pInstrInfo);
void            lscp_midi_instrument_info_reset     (lscp_midi_instrument_info_t *pInstrInfo);


#endif // __LSCP_COMMON_H

// end of common.h
1	// common.h
2	//
3	/****************************************************************************
4	liblscp - LinuxSampler Control Protocol API
5	Copyright (C) 2004-2006, rncbc aka Rui Nuno Capela. All rights reserved.
6
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	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
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	// 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	// Client struct volatile caches.
56	lscp_driver_info_t audio_driver_info;
57	lscp_driver_info_t midi_driver_info;
58	lscp_device_info_t audio_device_info;
59	lscp_device_info_t midi_device_info;
60	lscp_param_info_t audio_param_info;
61	lscp_param_info_t midi_param_info;
62	lscp_device_port_info_t audio_channel_info;
63	lscp_device_port_info_t midi_port_info;
64	lscp_param_info_t audio_channel_param_info;
65	lscp_param_info_t midi_port_param_info;
66	lscp_server_info_t server_info;
67	lscp_engine_info_t engine_info;
68	lscp_channel_info_t channel_info;
69	lscp_midi_instrument_info_t midi_instrument_info;
70	// Result and error status.
71	char * pszResult;
72	int iErrno;
73	// Stream buffers status.
74	lscp_buffer_fill_t *buffer_fill;
75	int iStreamCount;
76	// Transaction call timeout (msecs).
77	int iTimeout;
78	lscp_mutex_t mutex;
79	lscp_cond_t cond;
80	// Flag last transaction timedout.
81	int iTimeoutCount;
82	};
83
84
85	//-------------------------------------------------------------------------
86	// Local client request executive.
87
88	lscp_status_t lscp_client_recv (lscp_client_t pClient, char pchBuffer, int *pcchBuffer, int iTimeout);
89	lscp_status_t lscp_client_call (lscp_client_t pClient, const char pszQuery);
90	void lscp_client_set_result (lscp_client_t pClient, char pszResult, int iErrno);
91
92	//-------------------------------------------------------------------------
93	// General utility function prototypes.
94
95	char * lscp_strtok (char pchBuffer, const char pszSeps, char **ppch);
96	char * lscp_ltrim (char *psz);
97	char * lscp_unquote (char **ppsz, int dup);
98	void lscp_unquote_dup (char ppszDst, char ppszSrc);
99
100	char ** lscp_szsplit_create (const char pszCsv, const char pszSeps);
101	void lscp_szsplit_destroy (char **ppszSplit);
102	#ifdef LSCP_SZSPLIT_COUNT
103	int lscp_szsplit_count (char **ppszSplit);
104	int lscp_szsplit_size (char **ppszSplit);
105	#endif
106
107	int * lscp_isplit_create (const char pszCsv, const char pszSeps);
108	void lscp_isplit_destroy (int *piSplit);
109	#ifdef LSCP_ISPLIT_COUNT
110	int lscp_isplit_count (int *piSplit);
111	int lscp_isplit_size (int *piSplit);
112	#endif
113
114	lscp_param_t * lscp_psplit_create (const char pszCsv, const char pszSep1, const char *pszSep2);
115	void lscp_psplit_destroy (lscp_param_t *ppSplit);
116	#ifdef LSCP_PSPLIT_COUNT
117	int lscp_psplit_count (lscp_param_t *ppSplit);
118	int lscp_psplit_size (lscp_param_t *ppSplit);
119	#endif
120
121	void lscp_plist_alloc (lscp_param_t **ppList);
122	void lscp_plist_free (lscp_param_t **ppList);
123	void lscp_plist_append (lscp_param_t *ppList, const char pszKey, const char *pszValue);
124	#ifdef LSCP_PLIST_COUNT
125	int lscp_plist_count (lscp_param_t **ppList);
126	int lscp_plist_size (lscp_param_t **ppList);
127	#endif
128
129	//-------------------------------------------------------------------------
130	// Server struct helper functions.
131
132	void lscp_server_info_init (lscp_server_info_t *pServerInfo);
133	void lscp_server_info_free (lscp_server_info_t *pServerInfo);
134	void lscp_server_info_reset (lscp_server_info_t *pServerInfo);
135
136	//-------------------------------------------------------------------------
137	// Engine struct helper functions.
138
139	void lscp_engine_info_init (lscp_engine_info_t *pEngineInfo);
140	void lscp_engine_info_free (lscp_engine_info_t *pEngineInfo);
141	void lscp_engine_info_reset (lscp_engine_info_t *pEngineInfo);
142
143	//-------------------------------------------------------------------------
144	// Channel struct helper functions.
145
146	void lscp_channel_info_init (lscp_channel_info_t *pChannelInfo);
147	void lscp_channel_info_free (lscp_channel_info_t *pChannelInfo);
148	void lscp_channel_info_reset (lscp_channel_info_t *pChannelInfo);
149
150	//-------------------------------------------------------------------------
151	// Driver struct helper functions.
152
153	void lscp_driver_info_init (lscp_driver_info_t *pDriverInfo);
154	void lscp_driver_info_free (lscp_driver_info_t *pDriverInfo);
155	void lscp_driver_info_reset (lscp_driver_info_t *pDriverInfo);
156
157	//-------------------------------------------------------------------------
158	// Device struct helper functions.
159
160	void lscp_device_info_init (lscp_device_info_t *pDeviceInfo);
161	void lscp_device_info_free (lscp_device_info_t *pDeviceInfo);
162	void lscp_device_info_reset (lscp_device_info_t *pDeviceInfo);
163
164	//-------------------------------------------------------------------------
165	// Device channel/port struct helper functions.
166
167	void lscp_device_port_info_init (lscp_device_port_info_t *pDevicePortInfo);
168	void lscp_device_port_info_free (lscp_device_port_info_t *pDevicePortInfo);
169	void lscp_device_port_info_reset (lscp_device_port_info_t *pDevicePortInfo);
170
171	//-------------------------------------------------------------------------
172	// Parameter struct helper functions.
173
174	void lscp_param_info_init (lscp_param_info_t *pParamInfo);
175	void lscp_param_info_free (lscp_param_info_t *pParamInfo);
176	void lscp_param_info_reset (lscp_param_info_t *pParamInfo);
177
178	//-------------------------------------------------------------------------
179	// Concatenate a parameter list (key='value'...) into a string.
180
181	int lscp_param_concat (char pszBuffer, int cchMaxBuffer, lscp_param_t pParams);
182
183	//-------------------------------------------------------------------------
184	// MIDI instrument info struct helper functions.
185
186	void lscp_midi_instrument_info_init (lscp_midi_instrument_info_t *pInstrInfo);
187	void lscp_midi_instrument_info_free (lscp_midi_instrument_info_t *pInstrInfo);
188	void lscp_midi_instrument_info_reset (lscp_midi_instrument_info_t *pInstrInfo);
189
190
191	#endif // __LSCP_COMMON_H
192
193	// end of common.h