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;
    lscp_midi_instrument_t *midi_instruments;
    // 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, int iResult);
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

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