/[svn]/liblscp/trunk/src/client.c
ViewVC logotype

Annotation of /liblscp/trunk/src/client.c

Parent Directory Parent Directory | Revision Log Revision Log


Revision 278 - (hide annotations) (download)
Mon Oct 11 11:59:31 2004 UTC (19 years, 5 months ago) by capela
File MIME type: text/plain
File size: 46772 byte(s)
* Fixed lscp_set_channel_midi_channel() again, MIDI
  channels should be given in the range 0-15, and omni
  mode with the LSCP_MIDI_CHANNEL_ALL symbol (16).

1 capela 107 // client.c
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     #include "common.h"
24    
25     // Default timeout value (in milliseconds).
26     #define LSCP_TIMEOUT_MSECS 500
27    
28    
29     // Local prototypes.
30    
31 capela 144 static void _lscp_client_evt_proc (void *pvClient);
32 capela 107
33 capela 144 static lscp_status_t _lscp_client_evt_connect (lscp_client_t *pClient);
34     static lscp_status_t _lscp_client_evt_request (lscp_client_t *pClient, int iSubscribe, lscp_event_t event);
35 capela 107
36 capela 144
37 capela 107 //-------------------------------------------------------------------------
38 capela 132 // Event service (datagram oriented).
39 capela 107
40 capela 132 static void _lscp_client_evt_proc ( void *pvClient )
41 capela 107 {
42     lscp_client_t *pClient = (lscp_client_t *) pvClient;
43 capela 177
44     fd_set fds; // File descriptor list for select().
45     int fd, fdmax; // Maximum file descriptor number.
46     struct timeval tv; // For specifying a timeout value.
47     int iSelect; // Holds select return status.
48     int iTimeout;
49    
50     char achBuffer[LSCP_BUFSIZ];
51     int cchBuffer;
52 capela 144 const char *pszSeps = ":\r\n";
53 capela 177 char * pszToken;
54     char * pch;
55     int cchToken;
56 capela 146 lscp_event_t event;
57 capela 107
58     #ifdef DEBUG
59 capela 132 fprintf(stderr, "_lscp_client_evt_proc: Client waiting for events.\n");
60 capela 107 #endif
61    
62 capela 132 while (pClient->evt.iState) {
63 capela 177
64     // Prepare for waiting on select...
65     fd = (int) pClient->evt.sock;
66     FD_ZERO(&fds);
67     FD_SET((unsigned int) fd, &fds);
68     fdmax = fd;
69    
70     // Use the timeout (x10) select feature ...
71     iTimeout = 10 * pClient->iTimeout;
72     if (iTimeout > 1000) {
73     tv.tv_sec = iTimeout / 1000;
74     iTimeout -= tv.tv_sec * 1000;
75     }
76     else tv.tv_sec = 0;
77     tv.tv_usec = iTimeout * 1000;
78    
79 capela 144 // Wait for event...
80 capela 177 iSelect = select(fdmax + 1, &fds, NULL, NULL, &tv);
81     if (iSelect > 0 && FD_ISSET(fd, &fds)) {
82     // May recv now...
83     cchBuffer = recv(pClient->evt.sock, achBuffer, sizeof(achBuffer), 0);
84     if (cchBuffer > 0) {
85     // Make sure received buffer it's null terminated.
86     achBuffer[cchBuffer] = (char) 0;
87     // Parse for the notification event message...
88     pszToken = lscp_strtok(achBuffer, pszSeps, &(pch)); // Have "NOTIFY".
89     if (strcasecmp(pszToken, "NOTIFY") == 0) {
90     pszToken = lscp_strtok(NULL, pszSeps, &(pch));
91     event = lscp_event_from_text(pszToken);
92     // And pick the rest of data...
93     pszToken = lscp_strtok(NULL, pszSeps, &(pch));
94     cchToken = (pszToken == NULL ? 0 : strlen(pszToken));
95     // Double-check if we're really up to it...
96     if (pClient->events & event) {
97     // Invoke the client event callback...
98     if ((*pClient->pfnCallback)(
99     pClient,
100     event,
101     pszToken,
102     cchToken,
103     pClient->pvData) != LSCP_OK) {
104     pClient->evt.iState = 0;
105     }
106 capela 107 }
107     }
108 capela 177 } else {
109     lscp_socket_perror("_lscp_client_evt_proc: recv");
110     pClient->evt.iState = 0;
111 capela 107 }
112 capela 177 } // Check if select has in error.
113     else if (iSelect < 0) {
114     lscp_socket_perror("_lscp_client_call: select");
115 capela 132 pClient->evt.iState = 0;
116 capela 107 }
117 capela 177
118     // Finally, always signal the event.
119     lscp_cond_signal(pClient->cond);
120 capela 107 }
121    
122     #ifdef DEBUG
123 capela 132 fprintf(stderr, "_lscp_client_evt_proc: Client closing.\n");
124 capela 107 #endif
125     }
126    
127    
128     //-------------------------------------------------------------------------
129 capela 144 // Event subscription helpers.
130    
131     // Open the event service socket connection.
132     static lscp_status_t _lscp_client_evt_connect ( lscp_client_t *pClient )
133     {
134     lscp_socket_t sock;
135     struct sockaddr_in addr;
136     int cAddr;
137     #if defined(WIN32)
138     int iSockOpt = (-1);
139     #endif
140    
141     // Prepare the event connection socket...
142     sock = socket(AF_INET, SOCK_STREAM, 0);
143     if (sock == INVALID_SOCKET) {
144     lscp_socket_perror("_lscp_client_evt_connect: socket");
145     return LSCP_FAILED;
146     }
147    
148     #if defined(WIN32)
149     if (setsockopt(sock, SOL_SOCKET, SO_DONTLINGER, (char *) &iSockOpt, sizeof(int)) == SOCKET_ERROR)
150     lscp_socket_perror("lscp_client_evt_connect: setsockopt(SO_DONTLINGER)");
151     #endif
152    
153     #ifdef DEBUG
154     lscp_socket_getopts("_lscp_client_evt_connect:", sock);
155     #endif
156    
157     // Use same address of the command connection.
158     cAddr = sizeof(struct sockaddr_in);
159     memmove((char *) &addr, &(pClient->cmd.addr), cAddr);
160    
161     // Start the connection...
162     if (connect(sock, (struct sockaddr *) &addr, cAddr) == SOCKET_ERROR) {
163     lscp_socket_perror("_lscp_client_evt_connect: connect");
164     closesocket(sock);
165     return LSCP_FAILED;
166     }
167    
168     // Set our socket agent struct...
169     lscp_socket_agent_init(&(pClient->evt), sock, &addr, cAddr);
170    
171     // And finally the service thread...
172     return lscp_socket_agent_start(&(pClient->evt), _lscp_client_evt_proc, pClient, 0);
173     }
174    
175    
176     // Subscribe to a single event.
177     static lscp_status_t _lscp_client_evt_request ( lscp_client_t *pClient, int iSubscribe, lscp_event_t event )
178     {
179 capela 146 const char *pszEvent;
180 capela 144 char szQuery[LSCP_BUFSIZ];
181     int cchQuery;
182    
183     if (pClient == NULL)
184     return LSCP_FAILED;
185    
186     // Which (single) event?
187 capela 146 pszEvent = lscp_event_to_text(event);
188     if (pszEvent == NULL)
189 capela 144 return LSCP_FAILED;
190 capela 146
191 capela 144 // Build the query string...
192     cchQuery = sprintf(szQuery, "%sSUBSCRIBE %s\n\n", (iSubscribe == 0 ? "UN" : ""), pszEvent);
193     // Just send data, forget result...
194     if (send(pClient->evt.sock, szQuery, cchQuery, 0) < cchQuery) {
195     lscp_socket_perror("_lscp_client_evt_request: send");
196     return LSCP_FAILED;
197     }
198    
199 capela 177 // Wait on response.
200     lscp_cond_wait(pClient->cond, pClient->mutex);
201    
202 capela 144 // Update as naively as we can...
203     if (iSubscribe)
204     pClient->events |= event;
205     else
206     pClient->events &= ~event;
207    
208     return LSCP_OK;
209     }
210    
211    
212     //-------------------------------------------------------------------------
213 capela 107 // Client versioning teller fuunction.
214    
215    
216     /** Retrieve the current client library version string. */
217     const char* lscp_client_package (void) { return LSCP_PACKAGE; }
218    
219     /** Retrieve the current client library version string. */
220     const char* lscp_client_version (void) { return LSCP_VERSION; }
221    
222     /** Retrieve the current client library build timestamp string. */
223     const char* lscp_client_build (void) { return __DATE__ " " __TIME__; }
224    
225    
226     //-------------------------------------------------------------------------
227     // Client socket functions.
228    
229     /**
230     * Create a client instance, estabilishing a connection to a server hostname,
231     * which must be listening on the given port. A client callback function is
232     * also supplied for server notification event handling.
233     *
234     * @param pszHost Hostname of the linuxsampler listening server.
235     * @param iPort Port number of the linuxsampler listening server.
236     * @param pfnCallback Callback function to receive event notifications.
237     * @param pvData User context opaque data, that will be passed
238     * to the callback function.
239     *
240     * @returns The new client instance pointer if successfull, which shall be
241     * used on all subsequent client calls, NULL otherwise.
242     */
243     lscp_client_t* lscp_client_create ( const char *pszHost, int iPort, lscp_client_proc_t pfnCallback, void *pvData )
244     {
245     lscp_client_t *pClient;
246     struct hostent *pHost;
247     lscp_socket_t sock;
248     struct sockaddr_in addr;
249     int cAddr;
250 capela 144 #if defined(WIN32)
251 capela 107 int iSockOpt = (-1);
252 capela 144 #endif
253 capela 107
254     if (pfnCallback == NULL) {
255     fprintf(stderr, "lscp_client_create: Invalid client callback function.\n");
256     return NULL;
257     }
258    
259     pHost = gethostbyname(pszHost);
260     if (pHost == NULL) {
261 capela 114 lscp_socket_herror("lscp_client_create: gethostbyname");
262 capela 107 return NULL;
263     }
264    
265     // Allocate client descriptor...
266    
267     pClient = (lscp_client_t *) malloc(sizeof(lscp_client_t));
268     if (pClient == NULL) {
269     fprintf(stderr, "lscp_client_create: Out of memory.\n");
270     return NULL;
271     }
272     memset(pClient, 0, sizeof(lscp_client_t));
273    
274     pClient->pfnCallback = pfnCallback;
275     pClient->pvData = pvData;
276    
277     #ifdef DEBUG
278     fprintf(stderr, "lscp_client_create: pClient=%p: pszHost=%s iPort=%d.\n", pClient, pszHost, iPort);
279     #endif
280    
281 capela 132 // Prepare the command connection socket...
282 capela 107
283     sock = socket(AF_INET, SOCK_STREAM, 0);
284     if (sock == INVALID_SOCKET) {
285 capela 132 lscp_socket_perror("lscp_client_create: cmd: socket");
286 capela 107 free(pClient);
287     return NULL;
288     }
289    
290     #if defined(WIN32)
291     if (setsockopt(sock, SOL_SOCKET, SO_DONTLINGER, (char *) &iSockOpt, sizeof(int)) == SOCKET_ERROR)
292 capela 132 lscp_socket_perror("lscp_client_create: cmd: setsockopt(SO_DONTLINGER)");
293 capela 107 #endif
294    
295     #ifdef DEBUG
296 capela 132 lscp_socket_getopts("lscp_client_create: cmd", sock);
297 capela 107 #endif
298    
299     cAddr = sizeof(struct sockaddr_in);
300     memset((char *) &addr, 0, cAddr);
301     addr.sin_family = pHost->h_addrtype;
302     memmove((char *) &(addr.sin_addr), pHost->h_addr, pHost->h_length);
303     addr.sin_port = htons((short) iPort);
304    
305     if (connect(sock, (struct sockaddr *) &addr, cAddr) == SOCKET_ERROR) {
306 capela 132 lscp_socket_perror("lscp_client_create: cmd: connect");
307 capela 107 closesocket(sock);
308     free(pClient);
309     return NULL;
310     }
311    
312 capela 144 // Initialize the command socket agent struct...
313 capela 132 lscp_socket_agent_init(&(pClient->cmd), sock, &addr, cAddr);
314 capela 107
315     #ifdef DEBUG
316 capela 132 fprintf(stderr, "lscp_client_create: cmd: pClient=%p: sock=%d addr=%s port=%d.\n", pClient, pClient->cmd.sock, inet_ntoa(pClient->cmd.addr.sin_addr), ntohs(pClient->cmd.addr.sin_port));
317 capela 107 #endif
318    
319 capela 144 // Initialize the event service socket struct...
320     lscp_socket_agent_init(&(pClient->evt), INVALID_SOCKET, NULL, 0);
321     // No events subscribed, yet.
322     pClient->events = LSCP_EVENT_NONE;
323 capela 107 // Initialize cached members.
324     pClient->audio_drivers = NULL;
325     pClient->midi_drivers = NULL;
326 capela 125 pClient->audio_devices = NULL;
327     pClient->midi_devices = NULL;
328 capela 107 pClient->engines = NULL;
329 capela 125 pClient->channels = NULL;
330 capela 171 lscp_driver_info_init(&(pClient->audio_driver_info));
331     lscp_driver_info_init(&(pClient->midi_driver_info));
332     lscp_device_info_init(&(pClient->audio_device_info));
333     lscp_device_info_init(&(pClient->midi_device_info));
334 capela 163 lscp_param_info_init(&(pClient->audio_param_info));
335     lscp_param_info_init(&(pClient->midi_param_info));
336 capela 171 lscp_device_port_info_init(&(pClient->audio_channel_info));
337     lscp_device_port_info_init(&(pClient->midi_port_info));
338     lscp_param_info_init(&(pClient->audio_channel_param_info));
339     lscp_param_info_init(&(pClient->midi_port_param_info));
340 capela 107 lscp_engine_info_init(&(pClient->engine_info));
341     lscp_channel_info_init(&(pClient->channel_info));
342     // Initialize error stuff.
343     pClient->pszResult = NULL;
344     pClient->iErrno = -1;
345     // Stream usage stuff.
346     pClient->buffer_fill = NULL;
347     pClient->iStreamCount = 0;
348     // Default timeout value.
349     pClient->iTimeout = LSCP_TIMEOUT_MSECS;
350    
351     // Initialize the transaction mutex.
352     lscp_mutex_init(pClient->mutex);
353 capela 177 lscp_cond_init(pClient->cond);
354 capela 107
355     // Finally we've some success...
356     return pClient;
357     }
358    
359    
360     /**
361     * Wait for a client instance to terminate graciously.
362     *
363     * @param pClient Pointer to client instance structure.
364     */
365     lscp_status_t lscp_client_join ( lscp_client_t *pClient )
366     {
367     if (pClient == NULL)
368     return LSCP_FAILED;
369    
370     #ifdef DEBUG
371     fprintf(stderr, "lscp_client_join: pClient=%p.\n", pClient);
372     #endif
373    
374 capela 132 // lscp_socket_agent_join(&(pClient->evt));
375     lscp_socket_agent_join(&(pClient->cmd));
376 capela 107
377     return LSCP_OK;
378     }
379    
380    
381     /**
382     * Terminate and destroy a client instance.
383     *
384     * @param pClient Pointer to client instance structure.
385     *
386     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
387     */
388     lscp_status_t lscp_client_destroy ( lscp_client_t *pClient )
389     {
390     if (pClient == NULL)
391     return LSCP_FAILED;
392    
393     #ifdef DEBUG
394     fprintf(stderr, "lscp_client_destroy: pClient=%p.\n", pClient);
395     #endif
396    
397 capela 132 // Lock this section up.
398     lscp_mutex_lock(pClient->mutex);
399    
400 capela 107 // Free up all cached members.
401 capela 179 lscp_channel_info_free(&(pClient->channel_info));
402     lscp_engine_info_free(&(pClient->engine_info));
403     lscp_param_info_free(&(pClient->midi_port_param_info));
404     lscp_param_info_free(&(pClient->audio_channel_param_info));
405     lscp_device_port_info_free(&(pClient->midi_port_info));
406     lscp_device_port_info_free(&(pClient->audio_channel_info));
407     lscp_param_info_free(&(pClient->midi_param_info));
408     lscp_param_info_free(&(pClient->audio_param_info));
409     lscp_device_info_free(&(pClient->midi_device_info));
410     lscp_device_info_free(&(pClient->audio_device_info));
411     lscp_driver_info_free(&(pClient->midi_driver_info));
412     lscp_driver_info_free(&(pClient->audio_driver_info));
413 capela 107 // Free available engine table.
414     lscp_szsplit_destroy(pClient->audio_drivers);
415     lscp_szsplit_destroy(pClient->midi_drivers);
416 capela 125 lscp_isplit_destroy(pClient->audio_devices);
417     lscp_isplit_destroy(pClient->midi_devices);
418 capela 107 lscp_szsplit_destroy(pClient->engines);
419 capela 125 lscp_isplit_destroy(pClient->channels);
420 capela 107 // Make them null.
421     pClient->audio_drivers = NULL;
422     pClient->midi_drivers = NULL;
423     pClient->engines = NULL;
424     // Free result error stuff.
425 capela 132 lscp_client_set_result(pClient, NULL, 0);
426 capela 167 // Free stream usage stuff.
427 capela 107 if (pClient->buffer_fill)
428     free(pClient->buffer_fill);
429     pClient->buffer_fill = NULL;
430     pClient->iStreamCount = 0;
431     pClient->iTimeout = 0;
432    
433     // Free socket agents.
434 capela 132 lscp_socket_agent_free(&(pClient->evt));
435     lscp_socket_agent_free(&(pClient->cmd));
436 capela 107
437     // Last but not least, free good ol'transaction mutex.
438 capela 132 lscp_mutex_unlock(pClient->mutex);
439 capela 107 lscp_mutex_destroy(pClient->mutex);
440 capela 177 lscp_cond_destroy(pClient->cond);
441 capela 107
442     free(pClient);
443    
444     return LSCP_OK;
445     }
446    
447    
448     /**
449     * Set the client transaction timeout interval.
450     *
451     * @param pClient Pointer to client instance structure.
452     * @param iTimeout Transaction timeout in milliseconds.
453     *
454     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
455     */
456     lscp_status_t lscp_client_set_timeout ( lscp_client_t *pClient, int iTimeout )
457     {
458     if (pClient == NULL)
459     return LSCP_FAILED;
460     if (iTimeout < 0)
461     return LSCP_FAILED;
462    
463     pClient->iTimeout = iTimeout;
464     return LSCP_OK;
465     }
466    
467    
468     /**
469     * Get the client transaction timeout interval.
470     *
471     * @param pClient Pointer to client instance structure.
472     *
473     * @returns The current timeout value milliseconds, -1 in case of failure.
474     */
475     int lscp_client_get_timeout ( lscp_client_t *pClient )
476     {
477     if (pClient == NULL)
478     return -1;
479    
480     return pClient->iTimeout;
481     }
482    
483    
484     //-------------------------------------------------------------------------
485     // Client common protocol functions.
486    
487     /**
488     * Submit a command query line string to the server. The query string
489     * must be cr/lf and null terminated. Besides the return code, the
490     * specific server response to the command request is made available
491     * by the @ref lscp_client_get_result and @ref lscp_client_get_errno
492     * function calls.
493     *
494     * @param pClient Pointer to client instance structure.
495     * @param pszQuery Command request line to be sent to server,
496     * must be cr/lf and null terminated.
497     *
498     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
499     */
500     lscp_status_t lscp_client_query ( lscp_client_t *pClient, const char *pszQuery )
501     {
502 capela 132 lscp_status_t ret;
503    
504 capela 107 // Lock this section up.
505     lscp_mutex_lock(pClient->mutex);
506    
507 capela 132 // Just make the now guarded call.
508     ret = lscp_client_call(pClient, pszQuery);
509    
510     // Unlock this section down.
511 capela 107 lscp_mutex_unlock(pClient->mutex);
512 capela 132
513 capela 107 return ret;
514     }
515    
516     /**
517     * Get the last received result string. In case of error or warning,
518     * this is the text of the error or warning message issued.
519     *
520     * @param pClient Pointer to client instance structure.
521     *
522     * @returns A pointer to the literal null-terminated result string as
523     * of the last command request.
524     */
525     const char *lscp_client_get_result ( lscp_client_t *pClient )
526     {
527     if (pClient == NULL)
528     return NULL;
529    
530     return pClient->pszResult;
531     }
532    
533    
534     /**
535     * Get the last error/warning number received.
536     *
537     * @param pClient Pointer to client instance structure.
538     *
539     * @returns The numerical value of the last error or warning
540     * response code received.
541     */
542     int lscp_client_get_errno ( lscp_client_t *pClient )
543     {
544     if (pClient == NULL)
545     return -1;
546    
547     return pClient->iErrno;
548     }
549    
550    
551     //-------------------------------------------------------------------------
552     // Client registration protocol functions.
553    
554     /**
555 capela 144 * Register frontend for receiving event messages:
556     * SUBSCRIBE CHANNELS | VOICE_COUNT | STREAM_COUNT | BUFFER_FILL
557     * | CHANNEL_INFO | MISCELLANEOUS
558 capela 107 *
559     * @param pClient Pointer to client instance structure.
560 capela 144 * @param events Bit-wise OR'ed event flags to subscribe.
561 capela 107 *
562     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
563     */
564 capela 144 lscp_status_t lscp_client_subscribe ( lscp_client_t *pClient, lscp_event_t events )
565 capela 107 {
566 capela 144 lscp_status_t ret = LSCP_FAILED;
567 capela 107
568 capela 144 if (pClient == NULL)
569 capela 107 return LSCP_FAILED;
570    
571 capela 132 // Lock this section up.
572     lscp_mutex_lock(pClient->mutex);
573 capela 144
574     // If applicable, start the alternate connection...
575     if (pClient->events == LSCP_EVENT_NONE)
576     ret = _lscp_client_evt_connect(pClient);
577 capela 132
578 capela 144 // Send the subscription commands.
579     if (ret == LSCP_OK && (events & LSCP_EVENT_CHANNELS))
580     ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_CHANNELS);
581     if (ret == LSCP_OK && (events & LSCP_EVENT_VOICE_COUNT))
582     ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_VOICE_COUNT);
583     if (ret == LSCP_OK && (events & LSCP_EVENT_STREAM_COUNT))
584     ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_STREAM_COUNT);
585     if (ret == LSCP_OK && (events & LSCP_EVENT_BUFFER_FILL))
586     ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_BUFFER_FILL);
587     if (ret == LSCP_OK && (events & LSCP_EVENT_CHANNEL_INFO))
588     ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_CHANNEL_INFO);
589     if (ret == LSCP_OK && (events & LSCP_EVENT_MISCELLANEOUS))
590     ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_MISCELLANEOUS);
591 capela 107
592 capela 132 // Unlock this section down.
593     lscp_mutex_unlock(pClient->mutex);
594    
595 capela 107 return ret;
596     }
597    
598    
599     /**
600 capela 144 * Deregister frontend from receiving UDP event messages anymore:
601     * SUBSCRIBE CHANNELS | VOICE_COUNT | STREAM_COUNT | BUFFER_FILL
602     * | CHANNEL_INFO | MISCELLANEOUS
603 capela 107 *
604     * @param pClient Pointer to client instance structure.
605 capela 144 * @param events Bit-wise OR'ed event flags to unsubscribe.
606 capela 107 *
607     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
608     */
609 capela 144 lscp_status_t lscp_client_unsubscribe ( lscp_client_t *pClient, lscp_event_t events )
610 capela 107 {
611 capela 144 lscp_status_t ret = LSCP_OK;
612 capela 107
613     if (pClient == NULL)
614     return LSCP_FAILED;
615    
616 capela 132 // Lock this section up.
617     lscp_mutex_lock(pClient->mutex);
618    
619 capela 144 // Send the unsubscription commands.
620     if (ret == LSCP_OK && (events & LSCP_EVENT_CHANNELS))
621     ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_CHANNELS);
622     if (ret == LSCP_OK && (events & LSCP_EVENT_VOICE_COUNT))
623     ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_VOICE_COUNT);
624     if (ret == LSCP_OK && (events & LSCP_EVENT_STREAM_COUNT))
625     ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_STREAM_COUNT);
626     if (ret == LSCP_OK && (events & LSCP_EVENT_BUFFER_FILL))
627     ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_BUFFER_FILL);
628     if (ret == LSCP_OK && (events & LSCP_EVENT_CHANNEL_INFO))
629     ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_CHANNEL_INFO);
630     if (ret == LSCP_OK && (events & LSCP_EVENT_MISCELLANEOUS))
631     ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_MISCELLANEOUS);
632 capela 107
633 capela 144 // If necessary, close the alternate connection...
634     if (pClient->events == LSCP_EVENT_NONE)
635     lscp_socket_agent_free(&(pClient->evt));
636    
637 capela 132 // Unlock this section down.
638     lscp_mutex_unlock(pClient->mutex);
639    
640 capela 107 return ret;
641     }
642    
643    
644 capela 213 /**
645     * Getting current subscribed events.
646     *
647     * @param pClient Pointer to client instance structure.
648     *
649     * @returns The current subscrived bit-wise OR'ed event flags.
650     */
651     lscp_event_t lscp_client_get_events ( lscp_client_t *pClient )
652     {
653     if (pClient == NULL)
654     return LSCP_EVENT_NONE;
655    
656     return pClient->events;
657     }
658    
659    
660 capela 107 //-------------------------------------------------------------------------
661     // Client command protocol functions.
662    
663     /**
664     * Loading an instrument:
665     * LOAD INSTRUMENT <filename> <instr-index> <sampler-channel>
666     *
667     * @param pClient Pointer to client instance structure.
668     * @param pszFileName Instrument file name.
669     * @param iInstrIndex Instrument index number.
670     * @param iSamplerChannel Sampler Channel.
671     *
672     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
673     */
674     lscp_status_t lscp_load_instrument ( lscp_client_t *pClient, const char *pszFileName, int iInstrIndex, int iSamplerChannel )
675     {
676     char szQuery[LSCP_BUFSIZ];
677    
678     if (pszFileName == NULL || iSamplerChannel < 0)
679     return LSCP_FAILED;
680    
681 capela 144 sprintf(szQuery, "LOAD INSTRUMENT '%s' %d %d\r\n", pszFileName, iInstrIndex, iSamplerChannel);
682 capela 107 return lscp_client_query(pClient, szQuery);
683     }
684    
685    
686     /**
687 capela 144 * Loading an instrument in the background (non modal):
688     * LOAD INSTRUMENT NON_MODAL <filename> <instr-index> <sampler-channel>
689     *
690     * @param pClient Pointer to client instance structure.
691     * @param pszFileName Instrument file name.
692     * @param iInstrIndex Instrument index number.
693     * @param iSamplerChannel Sampler Channel.
694     *
695     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
696     */
697     lscp_status_t lscp_load_instrument_non_modal ( lscp_client_t *pClient, const char *pszFileName, int iInstrIndex, int iSamplerChannel )
698     {
699     char szQuery[LSCP_BUFSIZ];
700    
701     if (pszFileName == NULL || iSamplerChannel < 0)
702     return LSCP_FAILED;
703    
704     sprintf(szQuery, "LOAD INSTRUMENT NON_MODAL '%s' %d %d\r\n", pszFileName, iInstrIndex, iSamplerChannel);
705     return lscp_client_query(pClient, szQuery);
706     }
707    
708    
709     /**
710 capela 107 * Loading a sampler engine:
711     * LOAD ENGINE <engine-name> <sampler-channel>
712     *
713     * @param pClient Pointer to client instance structure.
714     * @param pszEngineName Engine name.
715     * @param iSamplerChannel Sampler channel number.
716     *
717     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
718     */
719     lscp_status_t lscp_load_engine ( lscp_client_t *pClient, const char *pszEngineName, int iSamplerChannel )
720     {
721     char szQuery[LSCP_BUFSIZ];
722    
723     if (pszEngineName == NULL || iSamplerChannel < 0)
724     return LSCP_FAILED;
725    
726     sprintf(szQuery, "LOAD ENGINE %s %d\r\n", pszEngineName, iSamplerChannel);
727     return lscp_client_query(pClient, szQuery);
728     }
729    
730    
731     /**
732     * Current number of sampler channels:
733     * GET CHANNELS
734     *
735     * @param pClient Pointer to client instance structure.
736     *
737     * @returns The current total number of sampler channels on success,
738     * -1 otherwise.
739     */
740     int lscp_get_channels ( lscp_client_t *pClient )
741     {
742     int iChannels = -1;
743 capela 132
744     // Lock this section up.
745     lscp_mutex_lock(pClient->mutex);
746    
747     if (lscp_client_call(pClient, "GET CHANNELS\r\n") == LSCP_OK)
748 capela 107 iChannels = atoi(lscp_client_get_result(pClient));
749 capela 132
750     // Unlock this section doen.
751     lscp_mutex_unlock(pClient->mutex);
752    
753 capela 107 return iChannels;
754     }
755    
756    
757     /**
758 capela 125 * List current sampler channels number identifiers:
759     * LIST CHANNELS
760     *
761     * @param pClient Pointer to client instance structure.
762     *
763     * @returns An array of the sampler channels identifiers as positive integers,
764     * terminated with -1 on success, NULL otherwise.
765     */
766     int *lscp_list_channels ( lscp_client_t *pClient )
767     {
768     const char *pszSeps = ",";
769    
770     if (pClient == NULL)
771     return NULL;
772    
773 capela 132 // Lock this section up.
774     lscp_mutex_lock(pClient->mutex);
775    
776 capela 125 if (pClient->channels) {
777     lscp_isplit_destroy(pClient->channels);
778     pClient->channels = NULL;
779     }
780    
781 capela 132 if (lscp_client_call(pClient, "LIST CHANNELS\r\n") == LSCP_OK)
782 capela 125 pClient->channels = lscp_isplit_create(lscp_client_get_result(pClient), pszSeps);
783    
784 capela 132 // Unlock this section down.
785     lscp_mutex_unlock(pClient->mutex);
786    
787 capela 125 return pClient->channels;
788     }
789    
790    
791     /**
792 capela 107 * Adding a new sampler channel:
793     * ADD CHANNEL
794     *
795     * @param pClient Pointer to client instance structure.
796     *
797     * @returns The new sampler channel number identifier,
798     * or -1 in case of failure.
799     */
800     int lscp_add_channel ( lscp_client_t *pClient )
801     {
802     int iSamplerChannel = -1;
803 capela 132
804     // Lock this section up.
805     lscp_mutex_lock(pClient->mutex);
806    
807     if (lscp_client_call(pClient, "ADD CHANNEL\r\n") == LSCP_OK)
808 capela 107 iSamplerChannel = atoi(lscp_client_get_result(pClient));
809 capela 132
810     // Unlock this section down.
811     lscp_mutex_unlock(pClient->mutex);
812    
813 capela 107 return iSamplerChannel;
814     }
815    
816    
817     /**
818     * Removing a sampler channel:
819     * REMOVE CHANNEL <sampler-channel>
820     *
821     * @param pClient Pointer to client instance structure.
822     * @param iSamplerChannel Sampler channel number.
823     *
824     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
825     */
826     lscp_status_t lscp_remove_channel ( lscp_client_t *pClient, int iSamplerChannel )
827     {
828     char szQuery[LSCP_BUFSIZ];
829    
830     if (iSamplerChannel < 0)
831     return LSCP_FAILED;
832    
833     sprintf(szQuery, "REMOVE CHANNEL %d\r\n", iSamplerChannel);
834     return lscp_client_query(pClient, szQuery);
835     }
836    
837    
838     /**
839     * Getting all available engines:
840     * GET AVAILABLE_ENGINES
841     *
842     * @param pClient Pointer to client instance structure.
843     *
844     * @returns A NULL terminated array of engine name strings,
845     * or NULL in case of failure.
846     */
847     const char **lscp_get_available_engines ( lscp_client_t *pClient )
848     {
849     const char *pszSeps = ",";
850    
851 capela 132 // Lock this section up.
852     lscp_mutex_lock(pClient->mutex);
853    
854 capela 107 if (pClient->engines) {
855     lscp_szsplit_destroy(pClient->engines);
856     pClient->engines = NULL;
857     }
858    
859 capela 132 if (lscp_client_call(pClient, "GET AVAILABLE_ENGINES\r\n") == LSCP_OK)
860 capela 107 pClient->engines = lscp_szsplit_create(lscp_client_get_result(pClient), pszSeps);
861    
862 capela 132 // Unlock this section down.
863     lscp_mutex_unlock(pClient->mutex);
864    
865 capela 107 return (const char **) pClient->engines;
866     }
867    
868    
869     /**
870     * Getting information about an engine.
871     * GET ENGINE INFO <engine-name>
872     *
873     * @param pClient Pointer to client instance structure.
874     * @param pszEngineName Engine name.
875     *
876     * @returns A pointer to a @ref lscp_engine_info_t structure, with all the
877     * information of the given sampler engine, or NULL in case of failure.
878     */
879     lscp_engine_info_t *lscp_get_engine_info ( lscp_client_t *pClient, const char *pszEngineName )
880     {
881     lscp_engine_info_t *pEngineInfo;
882     char szQuery[LSCP_BUFSIZ];
883     const char *pszResult;
884     const char *pszSeps = ":";
885     const char *pszCrlf = "\r\n";
886     char *pszToken;
887     char *pch;
888    
889     if (pszEngineName == NULL)
890     return NULL;
891    
892 capela 132 // Lock this section up.
893     lscp_mutex_lock(pClient->mutex);
894    
895 capela 107 pEngineInfo = &(pClient->engine_info);
896     lscp_engine_info_reset(pEngineInfo);
897    
898     sprintf(szQuery, "GET ENGINE INFO %s\r\n", pszEngineName);
899 capela 132 if (lscp_client_call(pClient, szQuery) == LSCP_OK) {
900     pszResult = lscp_client_get_result(pClient);
901     pszToken = lscp_strtok((char *) pszResult, pszSeps, &(pch));
902     while (pszToken) {
903     if (strcasecmp(pszToken, "DESCRIPTION") == 0) {
904     pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
905     if (pszToken)
906 capela 180 lscp_unquote_dup(&(pEngineInfo->description), &pszToken);
907 capela 132 }
908     else if (strcasecmp(pszToken, "VERSION") == 0) {
909     pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
910     if (pszToken)
911 capela 180 lscp_unquote_dup(&(pEngineInfo->version), &pszToken);
912 capela 132 }
913     pszToken = lscp_strtok(NULL, pszSeps, &(pch));
914 capela 107 }
915     }
916 capela 132 else pEngineInfo = NULL;
917    
918     // Unlock this section down.
919     lscp_mutex_unlock(pClient->mutex);
920 capela 107
921     return pEngineInfo;
922     }
923    
924    
925     /**
926     * Getting sampler channel informations:
927     * GET CHANNEL INFO <sampler-channel>
928     *
929     * @param pClient Pointer to client instance structure.
930     * @param iSamplerChannel Sampler channel number.
931     *
932     * @returns A pointer to a @ref lscp_channel_info_t structure, with all the
933     * information of the given sampler channel, or NULL in case of failure.
934     */
935     lscp_channel_info_t *lscp_get_channel_info ( lscp_client_t *pClient, int iSamplerChannel )
936     {
937     lscp_channel_info_t *pChannelInfo;
938     char szQuery[LSCP_BUFSIZ];
939     const char *pszResult;
940     const char *pszSeps = ":";
941     const char *pszCrlf = "\r\n";
942     char *pszToken;
943     char *pch;
944    
945     if (iSamplerChannel < 0)
946     return NULL;
947    
948 capela 132 // Lock this section up.
949     lscp_mutex_lock(pClient->mutex);
950    
951 capela 107 pChannelInfo = &(pClient->channel_info);
952     lscp_channel_info_reset(pChannelInfo);
953    
954     sprintf(szQuery, "GET CHANNEL INFO %d\r\n", iSamplerChannel);
955 capela 132 if (lscp_client_call(pClient, szQuery) == LSCP_OK) {
956     pszResult = lscp_client_get_result(pClient);
957     pszToken = lscp_strtok((char *) pszResult, pszSeps, &(pch));
958     while (pszToken) {
959     if (strcasecmp(pszToken, "ENGINE_NAME") == 0) {
960     pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
961     if (pszToken)
962 capela 180 lscp_unquote_dup(&(pChannelInfo->engine_name), &pszToken);
963 capela 132 }
964     else if (strcasecmp(pszToken, "AUDIO_OUTPUT_DEVICE") == 0) {
965     pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
966     if (pszToken)
967     pChannelInfo->audio_device = atoi(lscp_ltrim(pszToken));
968     }
969     else if (strcasecmp(pszToken, "AUDIO_OUTPUT_CHANNELS") == 0) {
970     pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
971     if (pszToken)
972     pChannelInfo->audio_channels = atoi(lscp_ltrim(pszToken));
973     }
974     else if (strcasecmp(pszToken, "AUDIO_OUTPUT_ROUTING") == 0) {
975     pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
976 capela 180 if (pszToken) {
977     if (pChannelInfo->audio_routing)
978     lscp_szsplit_destroy(pChannelInfo->audio_routing);
979 capela 132 pChannelInfo->audio_routing = lscp_szsplit_create(pszToken, ",");
980 capela 180 }
981 capela 132 }
982     else if (strcasecmp(pszToken, "INSTRUMENT_FILE") == 0) {
983     pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
984     if (pszToken)
985 capela 180 lscp_unquote_dup(&(pChannelInfo->instrument_file), &pszToken);
986 capela 132 }
987     else if (strcasecmp(pszToken, "INSTRUMENT_NR") == 0) {
988     pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
989     if (pszToken)
990     pChannelInfo->instrument_nr = atoi(lscp_ltrim(pszToken));
991     }
992     else if (strcasecmp(pszToken, "INSTRUMENT_STATUS") == 0) {
993     pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
994     if (pszToken)
995     pChannelInfo->instrument_status = atoi(lscp_ltrim(pszToken));
996     }
997     else if (strcasecmp(pszToken, "MIDI_INPUT_DEVICE") == 0) {
998     pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
999     if (pszToken)
1000     pChannelInfo->midi_device = atoi(lscp_ltrim(pszToken));
1001     }
1002     else if (strcasecmp(pszToken, "MIDI_INPUT_PORT") == 0) {
1003     pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
1004     if (pszToken)
1005     pChannelInfo->midi_port = atoi(lscp_ltrim(pszToken));
1006     }
1007     else if (strcasecmp(pszToken, "MIDI_INPUT_CHANNEL") == 0) {
1008     pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
1009     if (pszToken)
1010     pChannelInfo->midi_channel = atoi(lscp_ltrim(pszToken));
1011     }
1012     else if (strcasecmp(pszToken, "VOLUME") == 0) {
1013     pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
1014     if (pszToken)
1015     pChannelInfo->volume = (float) atof(lscp_ltrim(pszToken));
1016     }
1017     pszToken = lscp_strtok(NULL, pszSeps, &(pch));
1018 capela 107 }
1019     }
1020 capela 132 else pChannelInfo = NULL;
1021    
1022     // Unlock this section up.
1023     lscp_mutex_unlock(pClient->mutex);
1024 capela 107
1025     return pChannelInfo;
1026     }
1027    
1028    
1029     /**
1030     * Current number of active voices:
1031     * GET CHANNEL VOICE_COUNT <sampler-channel>
1032     *
1033     * @param pClient Pointer to client instance structure.
1034     * @param iSamplerChannel Sampler channel number.
1035     *
1036     * @returns The number of voices currently active, -1 in case of failure.
1037     */
1038     int lscp_get_channel_voice_count ( lscp_client_t *pClient, int iSamplerChannel )
1039     {
1040     char szQuery[LSCP_BUFSIZ];
1041     int iVoiceCount = -1;
1042    
1043     if (iSamplerChannel < 0)
1044     return iVoiceCount;
1045    
1046 capela 132 // Lock this section up.
1047     lscp_mutex_lock(pClient->mutex);
1048    
1049 capela 107 sprintf(szQuery, "GET CHANNEL VOICE_COUNT %d\r\n", iSamplerChannel);
1050 capela 132 if (lscp_client_call(pClient, szQuery) == LSCP_OK)
1051 capela 107 iVoiceCount = atoi(lscp_client_get_result(pClient));
1052    
1053 capela 132 // Unlock this section down.
1054     lscp_mutex_unlock(pClient->mutex);
1055    
1056 capela 107 return iVoiceCount;
1057     }
1058    
1059    
1060     /**
1061     * Current number of active disk streams:
1062     * GET CHANNEL STREAM_COUNT <sampler-channel>
1063     *
1064 capela 167 * @param pClient Pointer to client instance structure.
1065     * @param iSamplerChannel Sampler channel number.
1066     *
1067 capela 107 * @returns The number of active disk streams on success, -1 otherwise.
1068     */
1069     int lscp_get_channel_stream_count ( lscp_client_t *pClient, int iSamplerChannel )
1070     {
1071     char szQuery[LSCP_BUFSIZ];
1072     int iStreamCount = -1;
1073    
1074     if (iSamplerChannel < 0)
1075     return iStreamCount;
1076    
1077 capela 132 // Lock this section up.
1078     lscp_mutex_lock(pClient->mutex);
1079    
1080 capela 107 sprintf(szQuery, "GET CHANNEL STREAM_COUNT %d\r\n", iSamplerChannel);
1081 capela 132 if (lscp_client_call(pClient, szQuery) == LSCP_OK)
1082 capela 107 iStreamCount = atoi(lscp_client_get_result(pClient));
1083    
1084 capela 132 // Unlock this section down.
1085     lscp_mutex_unlock(pClient->mutex);
1086    
1087 capela 107 return iStreamCount;
1088     }
1089    
1090    
1091     /**
1092 capela 167 * Current least usage of active disk streams.
1093     *
1094     * @param pClient Pointer to client instance structure.
1095     * @param iSamplerChannel Sampler channel number.
1096     *
1097     * @returns The usage percentage of the least filled active disk stream
1098     * on success, -1 otherwise.
1099     */
1100     int lscp_get_channel_stream_usage ( lscp_client_t *pClient, int iSamplerChannel )
1101     {
1102     char szQuery[LSCP_BUFSIZ];
1103     int iStreamUsage = -1;
1104     const char *pszResult;
1105     const char *pszSeps = "[]%,";
1106     char *pszToken;
1107     char *pch;
1108     int iStream;
1109     int iPercent;
1110    
1111     if (iSamplerChannel < 0)
1112     return iStreamUsage;
1113    
1114     // Lock this section up.
1115     lscp_mutex_lock(pClient->mutex);
1116    
1117     iStream = 0;
1118     sprintf(szQuery, "GET CHANNEL BUFFER_FILL PERCENTAGE %d\r\n", iSamplerChannel);
1119     if (lscp_client_call(pClient, szQuery) == LSCP_OK) {
1120     pszResult = lscp_client_get_result(pClient);
1121     pszToken = lscp_strtok((char *) pszResult, pszSeps, &(pch));
1122     while (pszToken) {
1123     if (*pszToken) {
1124     // Skip stream id.
1125     pszToken = lscp_strtok(NULL, pszSeps, &(pch));
1126     if (pszToken == NULL)
1127     break;
1128     // Get least buffer fill percentage.
1129     iPercent = atol(pszToken);
1130     if (iStreamUsage > iPercent || iStream == 0)
1131     iStreamUsage = iPercent;
1132     iStream++;
1133     }
1134     pszToken = lscp_strtok(NULL, pszSeps, &(pch));
1135     }
1136     }
1137    
1138     // Unlock this section down.
1139     lscp_mutex_unlock(pClient->mutex);
1140    
1141     return iStreamUsage;
1142     }
1143    
1144    
1145     /**
1146 capela 107 * Current fill state of disk stream buffers:
1147     * GET CHANNEL BUFFER_FILL {BYTES|PERCENTAGE} <sampler-channel>
1148     *
1149     * @param pClient Pointer to client instance structure.
1150     * @param usage_type Usage type to be returned, either
1151     * @ref LSCP_USAGE_BYTES, or
1152     * @ref LSCP_USAGE_PERCENTAGE.
1153     * @param iSamplerChannel Sampler channel number.
1154     *
1155     * @returns A pointer to a @ref lscp_buffer_fill_t structure, with the
1156     * information of the current disk stream buffer fill usage, for the given
1157     * sampler channel, or NULL in case of failure.
1158     */
1159     lscp_buffer_fill_t *lscp_get_channel_buffer_fill ( lscp_client_t *pClient, lscp_usage_t usage_type, int iSamplerChannel )
1160     {
1161     lscp_buffer_fill_t *pBufferFill;
1162     char szQuery[LSCP_BUFSIZ];
1163     int iStreamCount;
1164     const char *pszUsageType = (usage_type == LSCP_USAGE_BYTES ? "BYTES" : "PERCENTAGE");
1165     const char *pszResult;
1166     const char *pszSeps = "[]%,";
1167     char *pszToken;
1168     char *pch;
1169     int iStream;
1170    
1171 capela 132 // Retrieve a channel stream estimation.
1172 capela 107 iStreamCount = lscp_get_channel_stream_count(pClient, iSamplerChannel);
1173 capela 132 if (pClient->iStreamCount < 0)
1174     return NULL;
1175    
1176     // Lock this section up.
1177     lscp_mutex_lock(pClient->mutex);
1178    
1179     // Check if we need to reallocate the stream usage array.
1180 capela 107 if (pClient->iStreamCount != iStreamCount) {
1181     if (pClient->buffer_fill)
1182     free(pClient->buffer_fill);
1183     if (iStreamCount > 0)
1184     pClient->buffer_fill = (lscp_buffer_fill_t *) malloc(iStreamCount * sizeof(lscp_buffer_fill_t));
1185     else
1186     pClient->buffer_fill = NULL;
1187     pClient->iStreamCount = iStreamCount;
1188     }
1189    
1190 capela 132 // Get buffer fill usage...
1191 capela 107 pBufferFill = pClient->buffer_fill;
1192 capela 132 if (pBufferFill && iStreamCount > 0) {
1193     iStream = 0;
1194     pBufferFill = pClient->buffer_fill;
1195     sprintf(szQuery, "GET CHANNEL BUFFER_FILL %s %d\r\n", pszUsageType, iSamplerChannel);
1196     if (lscp_client_call(pClient, szQuery) == LSCP_OK) {
1197     pszResult = lscp_client_get_result(pClient);
1198     pszToken = lscp_strtok((char *) pszResult, pszSeps, &(pch));
1199     while (pszToken && iStream < pClient->iStreamCount) {
1200     if (*pszToken) {
1201     pBufferFill[iStream].stream_id = atol(pszToken);
1202     pszToken = lscp_strtok(NULL, pszSeps, &(pch));
1203     if (pszToken == NULL)
1204     break;
1205     pBufferFill[iStream].stream_usage = atol(pszToken);
1206     iStream++;
1207     }
1208 capela 107 pszToken = lscp_strtok(NULL, pszSeps, &(pch));
1209     }
1210 capela 132 } // Reset the usage, whatever it was before.
1211     else while (iStream < pClient->iStreamCount)
1212     pBufferFill[iStream++].stream_usage = 0;
1213     }
1214    
1215     // Unlock this section down.
1216     lscp_mutex_unlock(pClient->mutex);
1217 capela 107
1218     return pBufferFill;
1219     }
1220    
1221    
1222     /**
1223     * Setting audio output type:
1224     * SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-type>
1225     *
1226     * @param pClient Pointer to client instance structure.
1227     * @param iSamplerChannel Sampler channel number.
1228     * @param pszAudioDriver Audio output driver type (e.g. "ALSA" or "JACK").
1229     */
1230     lscp_status_t lscp_set_channel_audio_type ( lscp_client_t *pClient, int iSamplerChannel, const char *pszAudioDriver )
1231     {
1232     char szQuery[LSCP_BUFSIZ];
1233    
1234     if (iSamplerChannel < 0 || pszAudioDriver == NULL)
1235     return LSCP_FAILED;
1236    
1237     sprintf(szQuery, "SET CHANNEL AUDIO_OUTPUT_TYPE %d %s\r\n", iSamplerChannel, pszAudioDriver);
1238     return lscp_client_query(pClient, szQuery);
1239     }
1240    
1241    
1242     /**
1243 capela 144 * Setting audio output device:
1244     * SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel> <device-id>
1245     *
1246     * @param pClient Pointer to client instance structure.
1247     * @param iSamplerChannel Sampler channel number.
1248     * @param iAudioDevice Audio output device number identifier.
1249     */
1250     lscp_status_t lscp_set_channel_audio_device ( lscp_client_t *pClient, int iSamplerChannel, int iAudioDevice )
1251     {
1252     char szQuery[LSCP_BUFSIZ];
1253    
1254     if (iSamplerChannel < 0 || iAudioDevice < 0)
1255     return LSCP_FAILED;
1256    
1257     sprintf(szQuery, "SET CHANNEL AUDIO_OUTPUT_DEVICE %d %d\r\n", iSamplerChannel, iAudioDevice);
1258     return lscp_client_query(pClient, szQuery);
1259     }
1260    
1261    
1262     /**
1263 capela 107 * Setting audio output channel:
1264     * SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-channel> <audio-output-chan> <audio-input-chan>
1265     *
1266     * @param pClient Pointer to client instance structure.
1267     * @param iSamplerChannel Sampler channel number.
1268     * @param iAudioOut Audio output device channel to be routed from.
1269     * @param iAudioIn Audio output device channel to be routed into.
1270     *
1271     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
1272     */
1273     lscp_status_t lscp_set_channel_audio_channel ( lscp_client_t *pClient, int iSamplerChannel, int iAudioOut, int iAudioIn )
1274     {
1275     char szQuery[LSCP_BUFSIZ];
1276    
1277     if (iSamplerChannel < 0 || iAudioOut < 0 || iAudioIn < 0)
1278     return LSCP_FAILED;
1279    
1280 capela 188 sprintf(szQuery, "SET CHANNEL AUDIO_OUTPUT_CHANNEL %d %d %d\r\n", iSamplerChannel, iAudioOut, iAudioIn);
1281 capela 107 return lscp_client_query(pClient, szQuery);
1282     }
1283    
1284    
1285     /**
1286     * Setting MIDI input type:
1287     * SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type>
1288     *
1289     * @param pClient Pointer to client instance structure.
1290     * @param iSamplerChannel Sampler channel number.
1291     * @param pszMidiDriver MIDI input driver type (e.g. "ALSA").
1292     *
1293     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
1294     */
1295     lscp_status_t lscp_set_channel_midi_type ( lscp_client_t *pClient, int iSamplerChannel, const char *pszMidiDriver )
1296     {
1297     char szQuery[LSCP_BUFSIZ];
1298    
1299     if (iSamplerChannel < 0 || pszMidiDriver == NULL)
1300     return LSCP_FAILED;
1301    
1302     sprintf(szQuery, "SET CHANNEL MIDI_INPUT_TYPE %d %s\r\n", iSamplerChannel, pszMidiDriver);
1303     return lscp_client_query(pClient, szQuery);
1304     }
1305    
1306    
1307     /**
1308 capela 144 * Setting MIDI input device:
1309     * SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <device-id>
1310     *
1311     * @param pClient Pointer to client instance structure.
1312     * @param iSamplerChannel Sampler channel number.
1313     * @param iMidiDevice MIDI input device number identifier.
1314     */
1315     lscp_status_t lscp_set_channel_midi_device ( lscp_client_t *pClient, int iSamplerChannel, int iMidiDevice )
1316     {
1317     char szQuery[LSCP_BUFSIZ];
1318    
1319     if (iSamplerChannel < 0 || iMidiDevice < 0)
1320     return LSCP_FAILED;
1321    
1322     sprintf(szQuery, "SET CHANNEL MIDI_INPUT_DEVICE %d %d\r\n", iSamplerChannel, iMidiDevice);
1323     return lscp_client_query(pClient, szQuery);
1324     }
1325    
1326    
1327     /**
1328 capela 107 * Setting MIDI input port:
1329     * SET CHANNEL MIDI_INPUT_PORT <sampler-channel> <midi-input-port>
1330     *
1331     * @param pClient Pointer to client instance structure.
1332     * @param iSamplerChannel Sampler channel number.
1333     * @param iMidiPort MIDI input driver virtual port number.
1334     *
1335     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
1336     */
1337     lscp_status_t lscp_set_channel_midi_port ( lscp_client_t *pClient, int iSamplerChannel, int iMidiPort )
1338     {
1339     char szQuery[LSCP_BUFSIZ];
1340    
1341     if (iSamplerChannel < 0 || iMidiPort < 0)
1342     return LSCP_FAILED;
1343    
1344     sprintf(szQuery, "SET CHANNEL MIDI_INPUT_PORT %d %d\r\n", iSamplerChannel, iMidiPort);
1345     return lscp_client_query(pClient, szQuery);
1346     }
1347    
1348    
1349     /**
1350     * Setting MIDI input channel:
1351     * SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>
1352     *
1353     * @param pClient Pointer to client instance structure.
1354     * @param iSamplerChannel Sampler channel number.
1355 capela 278 * @param iMidiChannel MIDI channel address number to listen (0-15) or
1356     * LSCP_MIDI_CHANNEL_ALL (16) to listen on all channels.
1357 capela 107 *
1358     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
1359     */
1360     lscp_status_t lscp_set_channel_midi_channel ( lscp_client_t *pClient, int iSamplerChannel, int iMidiChannel )
1361     {
1362     char szQuery[LSCP_BUFSIZ];
1363    
1364 capela 254 if (iSamplerChannel < 0 || iMidiChannel < 0 || iMidiChannel > 16)
1365 capela 107 return LSCP_FAILED;
1366    
1367 capela 278 if (iMidiChannel == LSCP_MIDI_CHANNEL_ALL)
1368     sprintf(szQuery, "SET CHANNEL MIDI_INPUT_CHANNEL %d ALL\r\n", iSamplerChannel);
1369     else
1370 capela 107 sprintf(szQuery, "SET CHANNEL MIDI_INPUT_CHANNEL %d %d\r\n", iSamplerChannel, iMidiChannel);
1371     return lscp_client_query(pClient, szQuery);
1372     }
1373    
1374    
1375     /**
1376     * Setting channel volume:
1377     * SET CHANNEL VOLUME <sampler-channel> <volume>
1378     *
1379     * @param pClient Pointer to client instance structure.
1380     * @param iSamplerChannel Sampler channel number.
1381     * @param fVolume Sampler channel volume as a positive floating point
1382     * number, where a value less than 1.0 for attenuation,
1383     * and greater than 1.0 for amplification.
1384     *
1385     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
1386     */
1387     lscp_status_t lscp_set_channel_volume ( lscp_client_t *pClient, int iSamplerChannel, float fVolume )
1388     {
1389     char szQuery[LSCP_BUFSIZ];
1390    
1391     if (iSamplerChannel < 0 || fVolume < 0.0)
1392     return LSCP_FAILED;
1393    
1394     sprintf(szQuery, "SET CHANNEL VOLUME %d %g\r\n", iSamplerChannel, fVolume);
1395     return lscp_client_query(pClient, szQuery);
1396     }
1397    
1398    
1399     /**
1400     * Resetting a sampler channel:
1401     * RESET CHANNEL <sampler-channel>
1402     *
1403     * @param pClient Pointer to client instance structure.
1404     * @param iSamplerChannel Sampler channel number.
1405     *
1406     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
1407     */
1408     lscp_status_t lscp_reset_channel ( lscp_client_t *pClient, int iSamplerChannel )
1409     {
1410     char szQuery[LSCP_BUFSIZ];
1411    
1412     if (iSamplerChannel < 0)
1413     return LSCP_FAILED;
1414    
1415     sprintf(szQuery, "RESET CHANNEL %d\r\n", iSamplerChannel);
1416     return lscp_client_query(pClient, szQuery);
1417     }
1418    
1419    
1420 capela 213 /**
1421     * Resetting the sampler:
1422     * RESET
1423     *
1424     * @param pClient Pointer to client instance structure.
1425     *
1426     * @returns LSCP_OK on success, LSCP_FAILED otherwise.
1427     */
1428     lscp_status_t lscp_reset_sampler ( lscp_client_t *pClient )
1429     {
1430     return lscp_client_query(pClient, "RESET\r\n");
1431     }
1432    
1433    
1434 capela 107 // end of client.c

  ViewVC Help
Powered by ViewVC