trunk/src/common.h

// common.h
//
/****************************************************************************
   liblscp - LinuxSampler Control Protocol API
   Copyright (C) 2004-2005, 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 Lesser General Public
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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;
    // 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;
};


//-------------------------------------------------------------------------
// 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);


#endif // __LSCP_COMMON_H

// end of common.h
1	capela	103	// common.h
2			//
3			/****************************************************************************
4			liblscp - LinuxSampler Control Protocol API
5	capela	415	Copyright (C) 2004-2005, 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			You should have received a copy of the GNU Lesser General Public
18			License along with this library; if not, write to the Free Software
19			Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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	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	103	// Client struct volatile caches.
56	capela	171	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	capela	163	lscp_param_info_t audio_param_info;
61			lscp_param_info_t midi_param_info;
62	capela	171	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	capela	564	lscp_server_info_t server_info;
67	capela	103	lscp_engine_info_t engine_info;
68			lscp_channel_info_t channel_info;
69			// Result and error status.
70			char * pszResult;
71			int iErrno;
72			// Stream buffers status.
73			lscp_buffer_fill_t *buffer_fill;
74			int iStreamCount;
75			// Transaction call timeout (msecs).
76			int iTimeout;
77			lscp_mutex_t mutex;
78	capela	177	lscp_cond_t cond;
79	capela	103	};
80
81
82			//-------------------------------------------------------------------------
83	capela	132	// Local client request executive.
84
85	capela	253	lscp_status_t lscp_client_recv (lscp_client_t pClient, char pchBuffer, int *pcchBuffer, int iTimeout);
86	capela	132	lscp_status_t lscp_client_call (lscp_client_t pClient, const char pszQuery);
87			void lscp_client_set_result (lscp_client_t pClient, char pszResult, int iErrno);
88
89			//-------------------------------------------------------------------------
90	capela	103	// General utility function prototypes.
91
92	capela	132	char * lscp_strtok (char pchBuffer, const char pszSeps, char **ppch);
93			char * lscp_ltrim (char *psz);
94			char * lscp_unquote (char **ppsz, int dup);
95	capela	180	void lscp_unquote_dup (char ppszDst, char ppszSrc);
96	capela	103
97	capela	132	char ** lscp_szsplit_create (const char pszCsv, const char pszSeps);
98			void lscp_szsplit_destroy (char **ppszSplit);
99	capela	103	#ifdef LSCP_SZSPLIT_COUNT
100	capela	132	int lscp_szsplit_count (char **ppszSplit);
101			int lscp_szsplit_size (char **ppszSplit);
102	capela	103	#endif
103
104	capela	132	int * lscp_isplit_create (const char pszCsv, const char pszSeps);
105	capela	158	void lscp_isplit_destroy (int *piSplit);
106	capela	125	#ifdef LSCP_ISPLIT_COUNT
107	capela	158	int lscp_isplit_count (int *piSplit);
108			int lscp_isplit_size (int *piSplit);
109	capela	125	#endif
110	capela	103
111	capela	158	lscp_param_t * lscp_psplit_create (const char pszCsv, const char pszSep1, const char *pszSep2);
112			void lscp_psplit_destroy (lscp_param_t *ppSplit);
113			#ifdef LSCP_PSPLIT_COUNT
114			int lscp_psplit_count (lscp_param_t *ppSplit);
115			int lscp_psplit_size (lscp_param_t *ppSplit);
116			#endif
117
118	capela	171	void lscp_plist_alloc (lscp_param_t **ppList);
119			void lscp_plist_free (lscp_param_t **ppList);
120			void lscp_plist_append (lscp_param_t *ppList, const char pszKey, const char *pszValue);
121			#ifdef LSCP_PLIST_COUNT
122			int lscp_plist_count (lscp_param_t **ppList);
123			int lscp_plist_size (lscp_param_t **ppList);
124			#endif
125
126	capela	103	//-------------------------------------------------------------------------
127	capela	564	// Server struct helper functions.
128
129			void lscp_server_info_init (lscp_server_info_t *pServerInfo);
130			void lscp_server_info_free (lscp_server_info_t *pServerInfo);
131			void lscp_server_info_reset (lscp_server_info_t *pServerInfo);
132
133			//-------------------------------------------------------------------------
134	capela	103	// Engine struct helper functions.
135
136	capela	132	void lscp_engine_info_init (lscp_engine_info_t *pEngineInfo);
137	capela	179	void lscp_engine_info_free (lscp_engine_info_t *pEngineInfo);
138	capela	132	void lscp_engine_info_reset (lscp_engine_info_t *pEngineInfo);
139	capela	103
140			//-------------------------------------------------------------------------
141			// Channel struct helper functions.
142
143	capela	132	void lscp_channel_info_init (lscp_channel_info_t *pChannelInfo);
144	capela	179	void lscp_channel_info_free (lscp_channel_info_t *pChannelInfo);
145	capela	132	void lscp_channel_info_reset (lscp_channel_info_t *pChannelInfo);
146	capela	103
147			//-------------------------------------------------------------------------
148			// Driver struct helper functions.
149
150	capela	132	void lscp_driver_info_init (lscp_driver_info_t *pDriverInfo);
151	capela	179	void lscp_driver_info_free (lscp_driver_info_t *pDriverInfo);
152	capela	132	void lscp_driver_info_reset (lscp_driver_info_t *pDriverInfo);
153	capela	103
154	capela	163	//-------------------------------------------------------------------------
155	capela	171	// Device struct helper functions.
156
157			void lscp_device_info_init (lscp_device_info_t *pDeviceInfo);
158	capela	179	void lscp_device_info_free (lscp_device_info_t *pDeviceInfo);
159	capela	171	void lscp_device_info_reset (lscp_device_info_t *pDeviceInfo);
160
161			//-------------------------------------------------------------------------
162			// Device channel/port struct helper functions.
163
164			void lscp_device_port_info_init (lscp_device_port_info_t *pDevicePortInfo);
165	capela	179	void lscp_device_port_info_free (lscp_device_port_info_t *pDevicePortInfo);
166	capela	171	void lscp_device_port_info_reset (lscp_device_port_info_t *pDevicePortInfo);
167
168			//-------------------------------------------------------------------------
169	capela	163	// Parameter struct helper functions.
170	capela	103
171	capela	163	void lscp_param_info_init (lscp_param_info_t *pParamInfo);
172	capela	179	void lscp_param_info_free (lscp_param_info_t *pParamInfo);
173	capela	163	void lscp_param_info_reset (lscp_param_info_t *pParamInfo);
174
175			//-------------------------------------------------------------------------
176			// Concatenate a parameter list (key='value'...) into a string.
177
178			int lscp_param_concat (char pszBuffer, int cchMaxBuffer, lscp_param_t pParams);
179
180
181	capela	103	#endif // __LSCP_COMMON_H
182
183			// end of common.h