trunk/lscp/client.h

// client.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_CLIENT_H
#define __LSCP_CLIENT_H

#include "lscp/socket.h"
#include "lscp/event.h"

#if defined(__cplusplus)
extern "C" {
#endif

//-------------------------------------------------------------------------
// MIDI channel omni mode.

#define LSCP_MIDI_CHANNEL_ALL   16


//-------------------------------------------------------------------------
// Client data structures.

/** Server info cache struct. */
typedef struct _lscp_server_info_t
{
    char *        description;
    char *        version;

} lscp_server_info_t;


/** Engine info cache struct. */
typedef struct _lscp_engine_info_t
{
    char *        description;
    char *        version;

} lscp_engine_info_t;


/** Channel info cache struct. */
typedef struct _lscp_channel_info_t
{
    char *        engine_name;
    int           audio_device;
    int           audio_channels;
    char **       audio_routing;
    char *        instrument_file;
    int           instrument_nr;
    char *        instrument_name;
    int           instrument_status;
    int           midi_device;
    int           midi_port;
    int           midi_channel;
    float         volume;

} lscp_channel_info_t;


/** Buffer fill cache struct. */
typedef struct _lscp_buffer_fill_t
{
    unsigned int  stream_id;
    unsigned long stream_usage;

} lscp_buffer_fill_t;


/** Buffer fill stream usage types. */
typedef enum _lscp_usage_t
{
    LSCP_USAGE_BYTES = 0,
    LSCP_USAGE_PERCENTAGE

} lscp_usage_t;


//-------------------------------------------------------------------------
// Client socket main structure.

/** Client opaque descriptor struct. */
typedef struct _lscp_client_t lscp_client_t;

/** Client event callback procedure prototype. */
typedef lscp_status_t (*lscp_client_proc_t)
(
    struct _lscp_client_t *pClient,
    lscp_event_t event,
    const char *pchData,
    int cchData,
    void *pvData
);

//-------------------------------------------------------------------------
// Client versioning teller fuunction.

const char *            lscp_client_package             (void);
const char *            lscp_client_version             (void);
const char *            lscp_client_build               (void);

//-------------------------------------------------------------------------
// Client socket functions.

lscp_client_t *         lscp_client_create              (const char *pszHost, int iPort, lscp_client_proc_t pfnCallback, void *pvData);
lscp_status_t           lscp_client_join                (lscp_client_t *pClient);
lscp_status_t           lscp_client_destroy             (lscp_client_t *pClient);

lscp_status_t           lscp_client_set_timeout         (lscp_client_t *pClient, int iTimeout);
int                     lscp_client_get_timeout         (lscp_client_t *pClient);

//-------------------------------------------------------------------------
// Client common protocol functions.

lscp_status_t           lscp_client_query               (lscp_client_t *pClient, const char *pszQuery);
const char *            lscp_client_get_result          (lscp_client_t *pClient );
int                     lscp_client_get_errno           (lscp_client_t *pClient );

//-------------------------------------------------------------------------
// Client registration protocol functions.

lscp_status_t           lscp_client_subscribe           (lscp_client_t *pClient, lscp_event_t events);
lscp_status_t           lscp_client_unsubscribe         (lscp_client_t *pClient, lscp_event_t events);

lscp_event_t            lscp_client_get_events          (lscp_client_t *pClient);

//-------------------------------------------------------------------------
// Client command protocol functions.

lscp_status_t           lscp_load_instrument            (lscp_client_t *pClient, const char *pszFileName, int iInstrIndex, int iSamplerChannel);
lscp_status_t           lscp_load_instrument_non_modal  (lscp_client_t *pClient, const char *pszFileName, int iInstrIndex, int iSamplerChannel);
lscp_status_t           lscp_load_engine                (lscp_client_t *pClient, const char *pszEngineName, int iSamplerChannel);
int                     lscp_get_channels               (lscp_client_t *pClient);
int *                   lscp_list_channels              (lscp_client_t *pClient);
int                     lscp_add_channel                (lscp_client_t *pClient);
lscp_status_t           lscp_remove_channel             (lscp_client_t *pClient, int iSamplerChannel);

int                     lscp_get_available_engines      (lscp_client_t *pClient);
const char **           lscp_list_available_engines     (lscp_client_t *pClient);

lscp_engine_info_t *    lscp_get_engine_info            (lscp_client_t *pClient, const char *pszEngineName);
lscp_channel_info_t *   lscp_get_channel_info           (lscp_client_t *pClient, int iSamplerChannel);

int                     lscp_get_channel_voice_count    (lscp_client_t *pClient, int iSamplerChannel);
int                     lscp_get_channel_stream_count   (lscp_client_t *pClient, int iSamplerChannel);
int                     lscp_get_channel_stream_usage   (lscp_client_t *pClient, int iSamplerChannel);

lscp_buffer_fill_t *    lscp_get_channel_buffer_fill    (lscp_client_t *pClient, lscp_usage_t iUsageType, int iSamplerChannel);

lscp_status_t           lscp_set_channel_audio_type     (lscp_client_t *pClient, int iSamplerChannel, const char *pszAudioType);
lscp_status_t           lscp_set_channel_audio_device   (lscp_client_t *pClient, int iSamplerChannel, int iAudioDevice);
lscp_status_t           lscp_set_channel_audio_channel  (lscp_client_t *pClient, int iSamplerChannel, int iAudioOut, int iAudioIn);

lscp_status_t           lscp_set_channel_midi_type      (lscp_client_t *pClient, int iSamplerChannel, const char *pszMidiType);
lscp_status_t           lscp_set_channel_midi_device    (lscp_client_t *pClient, int iSamplerChannel, int iMidiDevice);
lscp_status_t           lscp_set_channel_midi_port      (lscp_client_t *pClient, int iSamplerChannel, int iMidiPort);
lscp_status_t           lscp_set_channel_midi_channel   (lscp_client_t *pClient, int iSamplerChannel, int iMidiChannel);
lscp_status_t           lscp_set_channel_volume         (lscp_client_t *pClient, int iSamplerChannel, float fVolume);

lscp_status_t           lscp_reset_channel              (lscp_client_t *pClient, int iSamplerChannel);

lscp_status_t           lscp_reset_sampler              (lscp_client_t *pClient);

lscp_server_info_t *    lscp_get_server_info            (lscp_client_t *pClient);

#if defined(__cplusplus)
}
#endif

#endif // __LSCP_CLIENT_H

// end of client.h
1	// client.h
2	//
3	/****************************************************************************
4	liblscp - LinuxSampler Control Protocol API
5	Copyright (C) 2004-2005, 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_CLIENT_H
24	#define __LSCP_CLIENT_H
25
26	#include "lscp/socket.h"
27	#include "lscp/event.h"
28
29	#if defined(__cplusplus)
30	extern "C" {
31	#endif
32
33	//-------------------------------------------------------------------------
34	// MIDI channel omni mode.
35
36	#define LSCP_MIDI_CHANNEL_ALL 16
37
38
39	//-------------------------------------------------------------------------
40	// Client data structures.
41
42	/** Server info cache struct. */
43	typedef struct _lscp_server_info_t
44	{
45	char * description;
46	char * version;
47
48	} lscp_server_info_t;
49
50
51	/** Engine info cache struct. */
52	typedef struct _lscp_engine_info_t
53	{
54	char * description;
55	char * version;
56
57	} lscp_engine_info_t;
58
59
60	/** Channel info cache struct. */
61	typedef struct _lscp_channel_info_t
62	{
63	char * engine_name;
64	int audio_device;
65	int audio_channels;
66	char ** audio_routing;
67	char * instrument_file;
68	int instrument_nr;
69	char * instrument_name;
70	int instrument_status;
71	int midi_device;
72	int midi_port;
73	int midi_channel;
74	float volume;
75
76	} lscp_channel_info_t;
77
78
79	/** Buffer fill cache struct. */
80	typedef struct _lscp_buffer_fill_t
81	{
82	unsigned int stream_id;
83	unsigned long stream_usage;
84
85	} lscp_buffer_fill_t;
86
87
88	/** Buffer fill stream usage types. */
89	typedef enum _lscp_usage_t
90	{
91	LSCP_USAGE_BYTES = 0,
92	LSCP_USAGE_PERCENTAGE
93
94	} lscp_usage_t;
95
96
97	//-------------------------------------------------------------------------
98	// Client socket main structure.
99
100	/** Client opaque descriptor struct. */
101	typedef struct _lscp_client_t lscp_client_t;
102
103	/** Client event callback procedure prototype. */
104	typedef lscp_status_t (*lscp_client_proc_t)
105	(
106	struct _lscp_client_t *pClient,
107	lscp_event_t event,
108	const char *pchData,
109	int cchData,
110	void *pvData
111	);
112
113	//-------------------------------------------------------------------------
114	// Client versioning teller fuunction.
115
116	const char * lscp_client_package (void);
117	const char * lscp_client_version (void);
118	const char * lscp_client_build (void);
119
120	//-------------------------------------------------------------------------
121	// Client socket functions.
122
123	lscp_client_t * lscp_client_create (const char pszHost, int iPort, lscp_client_proc_t pfnCallback, void pvData);
124	lscp_status_t lscp_client_join (lscp_client_t *pClient);
125	lscp_status_t lscp_client_destroy (lscp_client_t *pClient);
126
127	lscp_status_t lscp_client_set_timeout (lscp_client_t *pClient, int iTimeout);
128	int lscp_client_get_timeout (lscp_client_t *pClient);
129
130	//-------------------------------------------------------------------------
131	// Client common protocol functions.
132
133	lscp_status_t lscp_client_query (lscp_client_t pClient, const char pszQuery);
134	const char * lscp_client_get_result (lscp_client_t *pClient );
135	int lscp_client_get_errno (lscp_client_t *pClient );
136
137	//-------------------------------------------------------------------------
138	// Client registration protocol functions.
139
140	lscp_status_t lscp_client_subscribe (lscp_client_t *pClient, lscp_event_t events);
141	lscp_status_t lscp_client_unsubscribe (lscp_client_t *pClient, lscp_event_t events);
142
143	lscp_event_t lscp_client_get_events (lscp_client_t *pClient);
144
145	//-------------------------------------------------------------------------
146	// Client command protocol functions.
147
148	lscp_status_t lscp_load_instrument (lscp_client_t pClient, const char pszFileName, int iInstrIndex, int iSamplerChannel);
149	lscp_status_t lscp_load_instrument_non_modal (lscp_client_t pClient, const char pszFileName, int iInstrIndex, int iSamplerChannel);
150	lscp_status_t lscp_load_engine (lscp_client_t pClient, const char pszEngineName, int iSamplerChannel);
151	int lscp_get_channels (lscp_client_t *pClient);
152	int * lscp_list_channels (lscp_client_t *pClient);
153	int lscp_add_channel (lscp_client_t *pClient);
154	lscp_status_t lscp_remove_channel (lscp_client_t *pClient, int iSamplerChannel);
155
156	int lscp_get_available_engines (lscp_client_t *pClient);
157	const char ** lscp_list_available_engines (lscp_client_t *pClient);
158
159	lscp_engine_info_t * lscp_get_engine_info (lscp_client_t pClient, const char pszEngineName);
160	lscp_channel_info_t * lscp_get_channel_info (lscp_client_t *pClient, int iSamplerChannel);
161
162	int lscp_get_channel_voice_count (lscp_client_t *pClient, int iSamplerChannel);
163	int lscp_get_channel_stream_count (lscp_client_t *pClient, int iSamplerChannel);
164	int lscp_get_channel_stream_usage (lscp_client_t *pClient, int iSamplerChannel);
165
166	lscp_buffer_fill_t * lscp_get_channel_buffer_fill (lscp_client_t *pClient, lscp_usage_t iUsageType, int iSamplerChannel);
167
168	lscp_status_t lscp_set_channel_audio_type (lscp_client_t pClient, int iSamplerChannel, const char pszAudioType);
169	lscp_status_t lscp_set_channel_audio_device (lscp_client_t *pClient, int iSamplerChannel, int iAudioDevice);
170	lscp_status_t lscp_set_channel_audio_channel (lscp_client_t *pClient, int iSamplerChannel, int iAudioOut, int iAudioIn);
171
172	lscp_status_t lscp_set_channel_midi_type (lscp_client_t pClient, int iSamplerChannel, const char pszMidiType);
173	lscp_status_t lscp_set_channel_midi_device (lscp_client_t *pClient, int iSamplerChannel, int iMidiDevice);
174	lscp_status_t lscp_set_channel_midi_port (lscp_client_t *pClient, int iSamplerChannel, int iMidiPort);
175	lscp_status_t lscp_set_channel_midi_channel (lscp_client_t *pClient, int iSamplerChannel, int iMidiChannel);
176	lscp_status_t lscp_set_channel_volume (lscp_client_t *pClient, int iSamplerChannel, float fVolume);
177
178	lscp_status_t lscp_reset_channel (lscp_client_t *pClient, int iSamplerChannel);
179
180	lscp_status_t lscp_reset_sampler (lscp_client_t *pClient);
181
182	lscp_server_info_t * lscp_get_server_info (lscp_client_t *pClient);
183
184	#if defined(__cplusplus)
185	}
186	#endif
187
188	#endif // __LSCP_CLIENT_H
189
190	// end of client.h