trunk/src/common.h

// common.h
//
/****************************************************************************
   liblscp - LinuxSampler Control Protocol API
   Copyright (C) 2004, 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 tcp;
    lscp_socket_agent_t udp;
    // Session identifier.
    char *              sessid;
    // 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_info;
    lscp_driver_info_t  midi_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;
};


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

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 *ppiSplit);
#ifdef LSCP_ISPLIT_COUNT
int         lscp_isplit_count       (int *ppiSplit);
int         lscp_isplit_size        (int *ppiSplit);
#endif


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

void        lscp_engine_info_init   (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_reset (lscp_channel_info_t *pChannelInfo);

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

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


#endif // __LSCP_COMMON_H

// end of common.h
1	// common.h
2	//
3	/****************************************************************************
4	liblscp - LinuxSampler Control Protocol API
5	Copyright (C) 2004, 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 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	lscp_socket_agent_t tcp;
45	lscp_socket_agent_t udp;
46	// Session identifier.
47	char * sessid;
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_info;
57	lscp_driver_info_t midi_info;
58	lscp_engine_info_t engine_info;
59	lscp_channel_info_t channel_info;
60	// Result and error status.
61	char * pszResult;
62	int iErrno;
63	// Stream buffers status.
64	lscp_buffer_fill_t *buffer_fill;
65	int iStreamCount;
66	// Transaction call timeout (msecs).
67	int iTimeout;
68	lscp_mutex_t mutex;
69	};
70
71
72	//-------------------------------------------------------------------------
73	// General utility function prototypes.
74
75	char * lscp_strtok (char pchBuffer, const char pszSeps, char **ppch);
76	char * lscp_ltrim (char *psz);
77	char * lscp_unquote (char **ppsz, int dup);
78
79	char ** lscp_szsplit_create (const char pszCsv, const char pszSeps);
80	void lscp_szsplit_destroy (char **ppszSplit);
81	#ifdef LSCP_SZSPLIT_COUNT
82	int lscp_szsplit_count (char **ppszSplit);
83	int lscp_szsplit_size (char **ppszSplit);
84	#endif
85
86	int * lscp_isplit_create (const char pszCsv, const char pszSeps);
87	void lscp_isplit_destroy (int *ppiSplit);
88	#ifdef LSCP_ISPLIT_COUNT
89	int lscp_isplit_count (int *ppiSplit);
90	int lscp_isplit_size (int *ppiSplit);
91	#endif
92
93
94	//-------------------------------------------------------------------------
95	// Engine struct helper functions.
96
97	void lscp_engine_info_init (lscp_engine_info_t *pEngineInfo);
98	void lscp_engine_info_reset (lscp_engine_info_t *pEngineInfo);
99
100	//-------------------------------------------------------------------------
101	// Channel struct helper functions.
102
103	void lscp_channel_info_init (lscp_channel_info_t *pChannelInfo);
104	void lscp_channel_info_reset (lscp_channel_info_t *pChannelInfo);
105
106	//-------------------------------------------------------------------------
107	// Driver struct helper functions.
108
109	void lscp_driver_info_init (lscp_driver_info_t *pDriverInfo);
110	void lscp_driver_info_reset (lscp_driver_info_t *pDriverInfo);
111
112
113	#endif // __LSCP_COMMON_H
114
115	// end of common.h