trunk/src/client.c

// client.c
//
/****************************************************************************
   liblscp - LinuxSampler Control Protocol API
   Copyright (C) 2004-2021, rncbc aka Rui Nuno Capela. All rights reserved.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU General Public License along
   with this program; if not, write to the Free Software Foundation, Inc.,
   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

*****************************************************************************/

#include <locale.h>
#include "common.h"
#include <sys/time.h>
#ifdef WIN32
# include <errno.h>
#else
# include <sys/errno.h>
#endif


// Default timeout value (in milliseconds).
#define LSCP_TIMEOUT_MSECS  500


// Whether to use getaddrinfo() instead
// of deprecated gethostbyname()
#if !defined(WIN32)
#define USE_GETADDRINFO 1
#endif


// Local prototypes.

static void _lscp_client_evt_proc (void *pvClient);

static lscp_status_t _lscp_client_evt_connect (lscp_client_t *pClient);
static lscp_status_t _lscp_client_evt_request (lscp_client_t *pClient,
        int iSubscribe, lscp_event_t event);


//-------------------------------------------------------------------------
// General helper functions.

struct _locale_t {
        char numeric[32+1];
        char ctype[32+1];
};

// we need to ensure a constant locale setting e.g. for parsing
// floating point numbers with atof(), as the floating point separator
// character varies by the invidual locale settings
static void _save_and_set_c_locale(struct _locale_t* locale)
{
        locale->numeric[32] = locale->ctype[32] = 0;
        strncpy(locale->numeric, setlocale(LC_NUMERIC, NULL), 32);
        strncpy(locale->ctype, setlocale(LC_CTYPE, NULL), 32);
        setlocale(LC_NUMERIC, "C");
        setlocale(LC_CTYPE, "C");
}

// restore the original locale setting as nothing happened
static void _restore_locale(struct _locale_t* locale)
{
        setlocale(LC_NUMERIC, locale->numeric);
        setlocale(LC_CTYPE, locale->ctype);
}

// seems the standard atof() function doesnt care much about locale
// runtime modifications, so we use this workaround
static float _atof(const char* txt) {
        float f;
        sscanf(txt, "%f", &f); // yeah, you're a good boy sscanf()
        return f;
}


//-------------------------------------------------------------------------
// Event service (datagram oriented).

static void _lscp_client_evt_proc ( void *pvClient )
{
        lscp_client_t *pClient = (lscp_client_t *) pvClient;

        fd_set fds;                         // File descriptor list for select().
        int    fd, fdmax;                   // Maximum file descriptor number.
        struct timeval tv;                  // For specifying a timeout value.
        int    iSelect;                     // Holds select return status.
        int    iTimeout;

        char   achBuffer[LSCP_BUFSIZ];
        int    cchBuffer;
        const char *pszSeps = ":\r\n";
        char  *pszToken;
        char  *pch;
        int    cchToken;

        lscp_event_t event;

#ifdef CONFIG_DEBUG
        fprintf(stderr, "_lscp_client_evt_proc: Client waiting for events.\n");
#endif

        while (pClient->evt.iState) {

                // Prepare for waiting on select...
                fd = (int) pClient->evt.sock;
                FD_ZERO(&fds);
                FD_SET((unsigned int) fd, &fds);
                fdmax = fd;

                // Use the timeout (x10) select feature ...
                iTimeout = 10 * pClient->iTimeout;
                if (iTimeout >= 1000) {
                        tv.tv_sec = iTimeout / 1000;
                        iTimeout -= tv.tv_sec * 1000;
                }
                else tv.tv_sec = 0;
                tv.tv_usec = iTimeout * 1000;

                // Wait for event...
                iSelect = select(fdmax + 1, &fds, NULL, NULL, &tv);
                if (iSelect > 0 && FD_ISSET(fd, &fds)) {
                        // May recv now...
                        cchBuffer = recv(pClient->evt.sock, achBuffer, sizeof(achBuffer), 0);
                        if (cchBuffer > 0) {
                                // Make sure received buffer it's null terminated.
                                achBuffer[cchBuffer] = (char) 0;
                                pch = achBuffer;
                                do {
                                        // Parse for the notification event message...
                                        pszToken = lscp_strtok(NULL, pszSeps, &(pch)); // Have "NOTIFY"
                                        if (strcasecmp(pszToken, "NOTIFY") == 0) {
                                                pszToken = lscp_strtok(NULL, pszSeps, &(pch));
                                                event    = lscp_event_from_text(pszToken);
                                                // And pick the rest of data...
                                                pszToken = lscp_strtok(NULL, pszSeps, &(pch));
                                                cchToken = (pszToken == NULL ? 0 : strlen(pszToken));
                                                // Double-check if we're really up to it...
                                                if (pClient->events & event) {
                                                        // Invoke the client event callback...
                                                        if ((*pClient->pfnCallback)(
                                                                        pClient,
                                                                        event,
                                                                        pszToken,
                                                                        cchToken,
                                                                        pClient->pvData) != LSCP_OK) {
                                                                pClient->evt.iState = 0;
                                                        }
                                                }
                                        }
                                } while (*pch);
                        } else {
                                lscp_socket_perror("_lscp_client_evt_proc: recv");
                                pClient->evt.iState = 0;
                                pClient->iErrno = -errno;
                        }
                }   // Check if select has in error.
                else if (iSelect < 0) {
                        lscp_socket_perror("_lscp_client_evt_proc: select");
                        pClient->evt.iState = 0;
                        pClient->iErrno = -errno;
                }

                // Finally, always signal the event.
                lscp_cond_signal(pClient->cond);
        }

#ifdef CONFIG_DEBUG
        fprintf(stderr, "_lscp_client_evt_proc: Client closing.\n");
#endif
}


//-------------------------------------------------------------------------
// Event subscription helpers.

// Open the event service socket connection.
static lscp_status_t _lscp_client_evt_connect ( lscp_client_t *pClient )
{
        lscp_socket_t sock;
        struct sockaddr_in addr;
        int cAddr;
#if defined(WIN32)
        int iSockOpt = (-1);
#endif

        // Prepare the event connection socket...
        sock = socket(AF_INET, SOCK_STREAM, 0);
        if (sock == INVALID_SOCKET) {
                lscp_socket_perror("_lscp_client_evt_connect: socket");
                return LSCP_FAILED;
        }

#if defined(WIN32)
        if (setsockopt(sock, SOL_SOCKET, SO_DONTLINGER,
                        (char *) &iSockOpt, sizeof(int)) == SOCKET_ERROR)
                lscp_socket_perror("lscp_client_evt_connect: setsockopt(SO_DONTLINGER)");
#endif

#ifdef CONFIG_DEBUG
        lscp_socket_getopts("_lscp_client_evt_connect:", sock);
#endif

        // Use same address of the command connection.
        cAddr = sizeof(struct sockaddr_in);
        memmove((char *) &addr, &(pClient->cmd.addr), cAddr);

        // Start the connection...
        if (connect(sock, (struct sockaddr *) &addr, cAddr) == SOCKET_ERROR) {
                lscp_socket_perror("_lscp_client_evt_connect: connect");
                closesocket(sock);
                return LSCP_FAILED;
        }

        // Set our socket agent struct...
        lscp_socket_agent_init(&(pClient->evt), sock, &addr, cAddr);

        // And finally the service thread...
        return lscp_socket_agent_start(&(pClient->evt), _lscp_client_evt_proc, pClient, 0);
}


// Subscribe to a single event.
static lscp_status_t _lscp_client_evt_request ( lscp_client_t *pClient,
        int iSubscribe, lscp_event_t event )
{
        const char *pszEvent;
        char  szQuery[LSCP_BUFSIZ];
        int   cchQuery;

        if (pClient == NULL)
                return LSCP_FAILED;

        // Which (single) event?
        pszEvent = lscp_event_to_text(event);
        if (pszEvent == NULL)
                return LSCP_FAILED;

        // Build the query string...
        cchQuery = sprintf(szQuery, "%sSUBSCRIBE %s\n\n",
                (iSubscribe == 0 ? "UN" : ""), pszEvent);
        // Just send data, forget result...
        if (send(pClient->evt.sock, szQuery, cchQuery, 0) < cchQuery) {
                lscp_socket_perror("_lscp_client_evt_request: send");
                return LSCP_FAILED;
        }

        // Wait on response.
        lscp_cond_wait(pClient->cond, pClient->mutex);

        // Update as naively as we can...
        if (iSubscribe)
                pClient->events |=  event;
        else
                pClient->events &= ~event;

        return LSCP_OK;
}


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


/** Retrieve the current client library version string. */
const char* lscp_client_package (void) { return LSCP_PACKAGE; }

/** Retrieve the current client library version string. */
const char* lscp_client_version (void) { return LSCP_VERSION; }

/** Retrieve the current client library build string. */
const char* lscp_client_build   (void) { return LSCP_BUILD; }


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

/**
 *  Create a client instance, estabilishing a connection to a server hostname,
 *  which must be listening on the given port. A client callback function is
 *  also supplied for server notification event handling.
 *
 *  @param pszHost      Hostname of the linuxsampler listening server.
 *  @param iPort        Port number of the linuxsampler listening server.
 *  @param pfnCallback  Callback function to receive event notifications.
 *  @param pvData       User context opaque data, that will be passed
 *                      to the callback function.
 *
 *  @returns The new client instance pointer if successfull, which shall be
 *  used on all subsequent client calls, NULL otherwise.
 */
lscp_client_t* lscp_client_create ( const char *pszHost, int iPort,
        lscp_client_proc_t pfnCallback, void *pvData )
{
        lscp_client_t  *pClient;
#if defined(USE_GETADDRINFO)
        char szPort[33];
        struct addrinfo hints;
        struct addrinfo *result, *res;
#else
        struct hostent *pHost;
        struct sockaddr_in addr;
        int cAddr;
#endif  /* !USE_GETADDRINFO */
        lscp_socket_t sock;
#if defined(WIN32)
        int iSockOpt = (-1);
#endif

        if (pfnCallback == NULL) {
                fprintf(stderr, "lscp_client_create: Invalid client callback function.\n");
                return NULL;
        }

#if defined(USE_GETADDRINFO)

        // Convert port number to string/name...
        snprintf(szPort, sizeof(szPort), "%d", iPort);

        // Obtain address(es) matching host/port...
        memset(&hints, 0, sizeof(struct addrinfo));
        hints.ai_family = AF_INET;
        hints.ai_socktype = SOCK_STREAM;

        result = NULL;

        if (getaddrinfo(pszHost, szPort, &hints, &result)) {
                lscp_socket_herror("lscp_client_create: getaddrinfo");
                return NULL;
        }

#else

        // Obtain host matching name...
        pHost = gethostbyname(pszHost);
        if (pHost == NULL) {
                lscp_socket_herror("lscp_client_create: gethostbyname");
                return NULL;
        }

#endif  /* !USE_GETADDRINFO */

        // Allocate client descriptor...

        pClient = (lscp_client_t *) malloc(sizeof(lscp_client_t));
        if (pClient == NULL) {
                fprintf(stderr, "lscp_client_create: Out of memory.\n");
                return NULL;
        }
        memset(pClient, 0, sizeof(lscp_client_t));

        pClient->pfnCallback = pfnCallback;
        pClient->pvData = pvData;

#ifdef CONFIG_DEBUG
        fprintf(stderr,
                "lscp_client_create: pClient=%p: pszHost=%s iPort=%d.\n",
                 pClient, pszHost, iPort);
#endif

        // Prepare the command connection socket...

#if defined(USE_GETADDRINFO)

        // getaddrinfo() returns a list of address structures;
        // try each address until we successfully connect(2);
        // if socket or connect fails, we close the socket and
        // try the next address...
        sock = INVALID_SOCKET;

        for (res = result; res; res = res->ai_next) {
                sock = socket(res->ai_family, res->ai_socktype, res->ai_protocol);
                if (sock == INVALID_SOCKET)
                        continue;
        #if defined(WIN32)
                if (setsockopt(sock, SOL_SOCKET, SO_DONTLINGER,
                                (char *) &iSockOpt, sizeof(int)) == SOCKET_ERROR)
                        lscp_socket_perror("lscp_client_create: cmd: setsockopt(SO_DONTLINGER)");
        #endif
        #ifdef CONFIG_DEBUG
                lscp_socket_getopts("lscp_client_create: cmd", sock);
        #endif
                if (connect(sock, res->ai_addr, res->ai_addrlen) != SOCKET_ERROR)
                        break;
                closesocket(sock);
        }

        if (sock == INVALID_SOCKET) {
                lscp_socket_perror("lscp_client_create: cmd: socket");
                free(pClient);
                return NULL;
        }

        if (res == NULL) {
                lscp_socket_perror("lscp_client_create: cmd: connect");
                free(pClient);
                return NULL;
        }

        // Initialize the command socket agent struct...
        lscp_socket_agent_init(&(pClient->cmd), sock,
                (struct sockaddr_in *) res->ai_addr, res->ai_addrlen);

        // No longer needed...
        freeaddrinfo(result);

#else

        sock = socket(AF_INET, SOCK_STREAM, 0);
        if (sock == INVALID_SOCKET) {
                lscp_socket_perror("lscp_client_create: cmd: socket");
                free(pClient);
                return NULL;
        }

#if defined(WIN32)
        if (setsockopt(sock, SOL_SOCKET, SO_DONTLINGER,
                        (char *) &iSockOpt, sizeof(int)) == SOCKET_ERROR)
                lscp_socket_perror("lscp_client_create: cmd: setsockopt(SO_DONTLINGER)");
#endif

#ifdef CONFIG_DEBUG
        lscp_socket_getopts("lscp_client_create: cmd", sock);
#endif

        cAddr = sizeof(struct sockaddr_in);
        memset((char *) &addr, 0, cAddr);
        addr.sin_family = pHost->h_addrtype;
        memmove((char *) &(addr.sin_addr), pHost->h_addr, pHost->h_length);
        addr.sin_port = htons((short) iPort);

        if (connect(sock, (struct sockaddr *) &addr, cAddr) == SOCKET_ERROR) {
                lscp_socket_perror("lscp_client_create: cmd: connect");
                closesocket(sock);
                free(pClient);
                return NULL;
        }

        // Initialize the command socket agent struct...
        lscp_socket_agent_init(&(pClient->cmd), sock, &addr, cAddr);

#endif  /* !USE_GETADDRINFO */

#ifdef CONFIG_DEBUG
        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));
#endif

        // Initialize the event service socket struct...
        lscp_socket_agent_init(&(pClient->evt), INVALID_SOCKET, NULL, 0);
        // No events subscribed, yet.
        pClient->events = LSCP_EVENT_NONE;
        // Initialize cached members.
        pClient->audio_drivers = NULL;
        pClient->midi_drivers = NULL;
        pClient->audio_devices = NULL;
        pClient->midi_devices = NULL;
        pClient->engines = NULL;
        pClient->channels = NULL;
        pClient->fxsends = NULL;
        pClient->midi_instruments = NULL;
        pClient->midi_maps = NULL;
        pClient->midi_map_name = NULL;
        lscp_driver_info_init(&(pClient->audio_driver_info));
        lscp_driver_info_init(&(pClient->midi_driver_info));
        lscp_device_info_init(&(pClient->audio_device_info));
        lscp_device_info_init(&(pClient->midi_device_info));
        lscp_param_info_init(&(pClient->audio_param_info));
        lscp_param_info_init(&(pClient->midi_param_info));
        lscp_device_port_info_init(&(pClient->audio_channel_info));
        lscp_device_port_info_init(&(pClient->midi_port_info));
        lscp_param_info_init(&(pClient->audio_channel_param_info));
        lscp_param_info_init(&(pClient->midi_port_param_info));
        lscp_server_info_init(&(pClient->server_info));
        lscp_engine_info_init(&(pClient->engine_info));
        lscp_channel_info_init(&(pClient->channel_info));
        lscp_fxsend_info_init(&(pClient->fxsend_info));
        lscp_midi_instrument_info_init(&(pClient->midi_instrument_info));
        // Initialize error stuff.
        pClient->pszResult = NULL;
        pClient->iErrno = -1;
        // Stream usage stuff.
        pClient->buffer_fill = NULL;
        pClient->iStreamCount = 0;
        // Default timeout value.
        pClient->iTimeout = LSCP_TIMEOUT_MSECS;
        pClient->iTimeoutCount = 0;

        // Initialize the transaction mutex.
        lscp_mutex_init(pClient->mutex);
        lscp_cond_init(pClient->cond);

        // Finally we've some success...
        return pClient;
}


/**
 *  Wait for a client instance to terminate graciously.
 *
 *  @param pClient  Pointer to client instance structure.
 */
lscp_status_t lscp_client_join ( lscp_client_t *pClient )
{
        if (pClient == NULL)
                return LSCP_FAILED;

#ifdef CONFIG_DEBUG
        fprintf(stderr, "lscp_client_join: pClient=%p.\n", pClient);
#endif

//  lscp_socket_agent_join(&(pClient->evt));
        lscp_socket_agent_join(&(pClient->cmd));

        return LSCP_OK;
}


/**
 *  Terminate and destroy a client instance.
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_client_destroy ( lscp_client_t *pClient )
{
        if (pClient == NULL)
                return LSCP_FAILED;

#ifdef CONFIG_DEBUG
        fprintf(stderr, "lscp_client_destroy: pClient=%p.\n", pClient);
#endif

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        // Free up all cached members.
        lscp_midi_instrument_info_free(&(pClient->midi_instrument_info));
        lscp_fxsend_info_free(&(pClient->fxsend_info));
        lscp_channel_info_free(&(pClient->channel_info));
        lscp_engine_info_free(&(pClient->engine_info));
        lscp_server_info_free(&(pClient->server_info));
        lscp_param_info_free(&(pClient->midi_port_param_info));
        lscp_param_info_free(&(pClient->audio_channel_param_info));
        lscp_device_port_info_free(&(pClient->midi_port_info));
        lscp_device_port_info_free(&(pClient->audio_channel_info));
        lscp_param_info_free(&(pClient->midi_param_info));
        lscp_param_info_free(&(pClient->audio_param_info));
        lscp_device_info_free(&(pClient->midi_device_info));
        lscp_device_info_free(&(pClient->audio_device_info));
        lscp_driver_info_free(&(pClient->midi_driver_info));
        lscp_driver_info_free(&(pClient->audio_driver_info));
        // Free available engine table.
        lscp_szsplit_destroy(pClient->audio_drivers);
        lscp_szsplit_destroy(pClient->midi_drivers);
        lscp_isplit_destroy(pClient->audio_devices);
        lscp_isplit_destroy(pClient->midi_devices);
        lscp_szsplit_destroy(pClient->engines);
        lscp_isplit_destroy(pClient->channels);
        lscp_isplit_destroy(pClient->fxsends);
        lscp_midi_instruments_destroy(pClient->midi_instruments);
        lscp_isplit_destroy(pClient->midi_maps);
        if (pClient->midi_map_name)
                free(pClient->midi_map_name);
        // Make them null.
        pClient->audio_drivers = NULL;
        pClient->midi_drivers = NULL;
        pClient->audio_devices = NULL;
        pClient->midi_devices = NULL;
        pClient->engines = NULL;
        pClient->channels = NULL;
        pClient->fxsends = NULL;
        pClient->midi_instruments = NULL;
        pClient->midi_maps = NULL;
        pClient->midi_map_name = NULL;
        // Free result error stuff.
        lscp_client_set_result(pClient, NULL, 0);
        // Free stream usage stuff.
        if (pClient->buffer_fill)
                free(pClient->buffer_fill);
        pClient->buffer_fill = NULL;
        pClient->iStreamCount = 0;
        pClient->iTimeout = 0;

        // Free socket agents.
        lscp_socket_agent_free(&(pClient->evt));
        lscp_socket_agent_free(&(pClient->cmd));

        // Last but not least, free good ol'transaction mutex.
        lscp_mutex_unlock(pClient->mutex);
        lscp_mutex_destroy(pClient->mutex);
        lscp_cond_destroy(pClient->cond);

        free(pClient);

        return LSCP_OK;
}


/**
 *  Set the client transaction timeout interval.
 *
 *  @param pClient  Pointer to client instance structure.
 *  @param iTimeout Transaction timeout in milliseconds.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_client_set_timeout ( lscp_client_t *pClient, int iTimeout )
{
        if (pClient == NULL)
                return LSCP_FAILED;
        if (iTimeout < 0)
                return LSCP_FAILED;

        pClient->iTimeout = iTimeout;
        return LSCP_OK;
}


/**
 *  Get the client transaction timeout interval.
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns The current timeout value milliseconds, -1 in case of failure.
 */
int lscp_client_get_timeout ( lscp_client_t *pClient )
{
        if (pClient == NULL)
                return -1;

        return pClient->iTimeout;
}

/**
 *  Check whether connection to server is lost.
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns @c true if client lost connection to server, @c false otherwise.
 */
bool lscp_client_connection_lost ( lscp_client_t *pClient )
{
    int err = lscp_client_get_errno(pClient);
    if (err >= 0) return false;
    return err == -EPIPE || err == -ECONNRESET || err == -ECONNABORTED;
}


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

/**
 *  Submit a command query line string to the server. The query string
 *  must be cr/lf and null terminated. Besides the return code, the
 *  specific server response to the command request is made available
 *  by the @ref lscp_client_get_result and @ref lscp_client_get_errno
 *  function calls.
 *
 *  @param pClient      Pointer to client instance structure.
 *  @param pszQuery     Command request line to be sent to server,
 *                      must be cr/lf and null terminated.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_client_query ( lscp_client_t *pClient, const char *pszQuery )
{
        lscp_status_t ret;

        if (pClient == NULL)
                return LSCP_FAILED;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        // Just make the now guarded call.
        ret = lscp_client_call(pClient, pszQuery, 0);

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return ret;
}

/**
 *  Get the last received result string. In case of error or warning,
 *  this is the text of the error or warning message issued.
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns A pointer to the literal null-terminated result string as
 *  of the last command request.
 */
const char *lscp_client_get_result ( lscp_client_t *pClient )
{
        if (pClient == NULL)
                return NULL;

        return pClient->pszResult;
}


/**
 *  Get the last error/warning number received.
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns The numerical value of the last error or warning
 *  response code received.
 */
int lscp_client_get_errno ( lscp_client_t *pClient )
{
        if (pClient == NULL)
                return -1;

        return pClient->iErrno;
}


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

/**
 *  Register frontend for receiving event messages by the sampler backend.
 *  @e Caution: since liblscp v0.5.5.4 you have to call lscp_client_subscribe()
 *  for @e each event you want to subscribe. That is the old bitflag approach
 *  was abondoned at this point. You can however still register all older
 *  events with one lscp_client_subscribe() call at once. Thus, the old
 *  behavior of this functions was not broken. Those older events are namely:
 *  @code
 *  SUBSCRIBE CHANNEL_COUNT | VOICE_COUNT | STREAM_COUNT
 *      | BUFFER_FILL | CHANNEL_INFO | TOTAL_VOICE_COUNT
 *      | AUDIO_OUTPUT_DEVICE_COUNT | AUDIO_OUTPUT_DEVICE_INFO
 *      | MIDI_INPUT_DEVICE_COUNT | MIDI_INPUT_DEVICE_INFO
 *      | MIDI_INSTRUMENT_MAP_COUNT | MIDI_INSTRUMENT_MAP_INFO
 *      | MIDI_INSTRUMENT_COUNT | MIDI_INSTRUMENT_INFO
 *      | MISCELLANEOUS
 *  @endcode
 *  The old events occupy the lower 16 bits (as bit flags), and all younger
 *  events enumerate the whole upper 16 bits range. The new, enumerated
 *  events are namely:
 *  @code
 *  SUBSCRIBE CHANNEL_MIDI
 *  @endcode
 *
 *  @param pClient  Pointer to client instance structure.
 *  @param events   LSCP event to subscribe.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_client_subscribe ( lscp_client_t *pClient, lscp_event_t events )
{
        lscp_status_t ret = LSCP_OK;
        lscp_event_t currentEvent;

        if (pClient == NULL)
                return LSCP_FAILED;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        // If applicable, start the alternate connection...
        if (pClient->events == LSCP_EVENT_NONE)
                ret = _lscp_client_evt_connect(pClient);

        // Send the subscription commands.
        if (ret == LSCP_OK && (events & LSCP_EVENT_CHANNEL_COUNT))
                ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_CHANNEL_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_VOICE_COUNT))
                ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_VOICE_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_STREAM_COUNT))
                ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_STREAM_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_BUFFER_FILL))
                ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_BUFFER_FILL);
        if (ret == LSCP_OK && (events & LSCP_EVENT_CHANNEL_INFO))
                ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_CHANNEL_INFO);
        if (ret == LSCP_OK && (events & LSCP_EVENT_TOTAL_VOICE_COUNT))
                ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_TOTAL_VOICE_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_AUDIO_OUTPUT_DEVICE_COUNT))
                ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_AUDIO_OUTPUT_DEVICE_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_AUDIO_OUTPUT_DEVICE_INFO))
                ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_AUDIO_OUTPUT_DEVICE_INFO);
        if (ret == LSCP_OK && (events & LSCP_EVENT_MIDI_INPUT_DEVICE_COUNT))
                ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_MIDI_INPUT_DEVICE_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_MIDI_INPUT_DEVICE_INFO))
                ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_MIDI_INPUT_DEVICE_INFO);
        if (ret == LSCP_OK && (events & LSCP_EVENT_MIDI_INSTRUMENT_MAP_COUNT))
                ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_MIDI_INSTRUMENT_MAP_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_MIDI_INSTRUMENT_MAP_INFO))
                ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_MIDI_INSTRUMENT_MAP_INFO);
        if (ret == LSCP_OK && (events & LSCP_EVENT_MIDI_INSTRUMENT_COUNT))
                ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_MIDI_INSTRUMENT_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_MIDI_INSTRUMENT_INFO))
                ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_MIDI_INSTRUMENT_INFO);
        if (ret == LSCP_OK && (events & LSCP_EVENT_MISCELLANEOUS))
                ret = _lscp_client_evt_request(pClient, 1, LSCP_EVENT_MISCELLANEOUS);
        // Caution: for the upper 16 bits, we don't use bit flags anymore ...
        currentEvent = events & 0xffff0000;
        if (ret == LSCP_OK && currentEvent) {
                switch (currentEvent) {
                        case LSCP_EVENT_CHANNEL_MIDI:
                        case LSCP_EVENT_DEVICE_MIDI:
                                ret = _lscp_client_evt_request(pClient, 1, currentEvent);
                                break;
                        default: // unknown "upper" event type
                                ret = LSCP_FAILED;
                                break;
                }
        }

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return ret;
}


/**
 *  Deregister frontend from receiving UDP event messages anymore.
 *  @e Caution: since liblscp v0.5.5.4 you have to call
 *  lscp_client_unsubscribe() for @e each event you want to unsubscribe.
 *  That is the old bitflag approach was abondoned at this point. You can
 *  however still register all older events with one lscp_client_subscribe()
 *  call at once. Thus, the old behavior of this functions was not broken.
 *  Those older events are namely:
 *  @code
 *  UNSUBSCRIBE CHANNEL_COUNT | VOICE_COUNT | STREAM_COUNT
 *      | BUFFER_FILL | CHANNEL_INFO | TOTAL_VOICE_COUNT
 *      | AUDIO_OUTPUT_DEVICE_COUNT | AUDIO_OUTPUT_DEVICE_INFO
 *      | MIDI_INPUT_DEVICE_COUNT | MIDI_INPUT_DEVICE_INFO
 *      | MIDI_INSTRUMENT_MAP_COUNT | MIDI_INSTRUMENT_MAP_INFO
 *      | MIDI_INSTRUMENT_COUNT | MIDI_INSTRUMENT_INFO
 *      | MISCELLANEOUS
 *  @endcode
 *  The old events occupy the lower 16 bits (as bit flags), and all younger
 *  events enumerate the whole upper 16 bits range. The new, enumerated
 *  events are namely:
 *  @code
 *  UNSUBSCRIBE CHANNEL_MIDI
 *  @endcode
 *
 *  @param pClient  Pointer to client instance structure.
 *  @param events   LSCP event to unsubscribe.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_client_unsubscribe ( lscp_client_t *pClient, lscp_event_t events )
{
        lscp_status_t ret = LSCP_OK;
        lscp_event_t currentEvent;

        if (pClient == NULL)
                return LSCP_FAILED;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        // Send the unsubscription commands.
        if (ret == LSCP_OK && (events & LSCP_EVENT_CHANNEL_COUNT))
                ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_CHANNEL_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_VOICE_COUNT))
                ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_VOICE_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_STREAM_COUNT))
                ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_STREAM_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_BUFFER_FILL))
                ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_BUFFER_FILL);
        if (ret == LSCP_OK && (events & LSCP_EVENT_CHANNEL_INFO))
                ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_CHANNEL_INFO);
        if (ret == LSCP_OK && (events & LSCP_EVENT_TOTAL_VOICE_COUNT))
                ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_TOTAL_VOICE_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_AUDIO_OUTPUT_DEVICE_COUNT))
                ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_AUDIO_OUTPUT_DEVICE_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_AUDIO_OUTPUT_DEVICE_INFO))
                ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_AUDIO_OUTPUT_DEVICE_INFO);
        if (ret == LSCP_OK && (events & LSCP_EVENT_MIDI_INPUT_DEVICE_COUNT))
                ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_MIDI_INPUT_DEVICE_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_MIDI_INPUT_DEVICE_INFO))
                ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_MIDI_INPUT_DEVICE_INFO);
        if (ret == LSCP_OK && (events & LSCP_EVENT_MIDI_INSTRUMENT_MAP_COUNT))
                ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_MIDI_INSTRUMENT_MAP_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_MIDI_INSTRUMENT_MAP_INFO))
                ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_MIDI_INSTRUMENT_MAP_INFO);
        if (ret == LSCP_OK && (events & LSCP_EVENT_MIDI_INSTRUMENT_COUNT))
                ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_MIDI_INSTRUMENT_COUNT);
        if (ret == LSCP_OK && (events & LSCP_EVENT_MIDI_INSTRUMENT_INFO))
                ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_MIDI_INSTRUMENT_INFO);
        if (ret == LSCP_OK && (events & LSCP_EVENT_MISCELLANEOUS))
                ret = _lscp_client_evt_request(pClient, 0, LSCP_EVENT_MISCELLANEOUS);
        // Caution: for the upper 16 bits, we don't use bit flags anymore ...
        currentEvent = events & 0xffff0000;
        if (ret == LSCP_OK && currentEvent) {
                switch (currentEvent) {
                        case LSCP_EVENT_CHANNEL_MIDI:
                        case LSCP_EVENT_DEVICE_MIDI:
                                ret = _lscp_client_evt_request(pClient, 0, currentEvent);
                                break;
                        default: // unknown "upper" event type
                                ret = LSCP_FAILED;
                                break;
                }
        }

        // If necessary, close the alternate connection...
        if (pClient->events == LSCP_EVENT_NONE)
                lscp_socket_agent_free(&(pClient->evt));

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return ret;
}


/**
 *  Getting current subscribed events.
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns The current subscrived bit-wise OR'ed event flags.
 */
lscp_event_t lscp_client_get_events ( lscp_client_t *pClient )
{
        if (pClient == NULL)
                return LSCP_EVENT_NONE;

        return pClient->events;
}


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

/**
 *  Loading an instrument:
 *  LOAD INSTRUMENT <filename> <instr-index> <sampler-channel>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param pszFileName      Instrument file name.
 *  @param iInstrIndex      Instrument index number.
 *  @param iSamplerChannel  Sampler Channel.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_load_instrument ( lscp_client_t *pClient,
        const char *pszFileName, int iInstrIndex, int iSamplerChannel )
{
        char szQuery[LSCP_BUFSIZ];

        if (pszFileName == NULL || iSamplerChannel < 0)
                return LSCP_FAILED;

        sprintf(szQuery, "LOAD INSTRUMENT '%s' %d %d\r\n",
                pszFileName, iInstrIndex, iSamplerChannel);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Loading an instrument in the background (non modal):
 *  LOAD INSTRUMENT NON_MODAL <filename> <instr-index> <sampler-channel>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param pszFileName      Instrument file name.
 *  @param iInstrIndex      Instrument index number.
 *  @param iSamplerChannel  Sampler Channel.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_load_instrument_non_modal ( lscp_client_t *pClient,
        const char *pszFileName, int iInstrIndex, int iSamplerChannel )
{
        char szQuery[LSCP_BUFSIZ];

        if (pszFileName == NULL || iSamplerChannel < 0)
                return LSCP_FAILED;

        sprintf(szQuery, "LOAD INSTRUMENT NON_MODAL '%s' %d %d\r\n",
                pszFileName, iInstrIndex, iSamplerChannel);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Loading a sampler engine:
 *  LOAD ENGINE <engine-name> <sampler-channel>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param pszEngineName    Engine name.
 *  @param iSamplerChannel  Sampler channel number.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_load_engine ( lscp_client_t *pClient, const char *pszEngineName, int iSamplerChannel )
{
        char szQuery[LSCP_BUFSIZ];

        if (pszEngineName == NULL || iSamplerChannel < 0)
                return LSCP_FAILED;

        sprintf(szQuery, "LOAD ENGINE %s %d\r\n",
                pszEngineName, iSamplerChannel);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Current number of sampler channels:
 *  GET CHANNELS
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns The current total number of sampler channels on success,
 *  -1 otherwise.
 */
int lscp_get_channels ( lscp_client_t *pClient )
{
        int iChannels = -1;

        if (pClient == NULL)
                return -1;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        if (lscp_client_call(pClient, "GET CHANNELS\r\n", 0) == LSCP_OK)
                iChannels = atoi(lscp_client_get_result(pClient));

        // Unlock this section doen.
        lscp_mutex_unlock(pClient->mutex);

        return iChannels;
}


/**
 *  List current sampler channels number identifiers:
 *  LIST CHANNELS
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns An array of the sampler channels identifiers as positive integers,
 *  terminated with -1 on success, NULL otherwise.
 */
int *lscp_list_channels ( lscp_client_t *pClient )
{
        const char *pszSeps = ",";

        if (pClient == NULL)
                return NULL;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        if (pClient->channels) {
                lscp_isplit_destroy(pClient->channels);
                pClient->channels = NULL;
        }

        if (lscp_client_call(pClient, "LIST CHANNELS\r\n", 0) == LSCP_OK)
                pClient->channels = lscp_isplit_create(lscp_client_get_result(pClient), pszSeps);

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return pClient->channels;
}


/**
 *  Adding a new sampler channel:
 *  ADD CHANNEL
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns The new sampler channel number identifier,
 *  or -1 in case of failure.
 */
int lscp_add_channel ( lscp_client_t *pClient )
{
        int iSamplerChannel = -1;

        if (pClient == NULL)
                return -1;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        if (lscp_client_call(pClient, "ADD CHANNEL\r\n", 0) == LSCP_OK)
                iSamplerChannel = atoi(lscp_client_get_result(pClient));

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return iSamplerChannel;
}


/**
 *  Removing a sampler channel:
 *  REMOVE CHANNEL <sampler-channel>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_remove_channel ( lscp_client_t *pClient, int iSamplerChannel )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0)
                return LSCP_FAILED;

        sprintf(szQuery, "REMOVE CHANNEL %d\r\n", iSamplerChannel);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Getting all available engines count:
 *  GET AVAILABLE_ENGINES
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns The current total number of sampler engines on success,
 *  -1 otherwise.
 */
int lscp_get_available_engines ( lscp_client_t *pClient )
{
        int iAvailableEngines = -1;

        if (pClient == NULL)
                return -1;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        if (lscp_client_call(pClient, "GET AVAILABLE_ENGINES\r\n", 0) == LSCP_OK)
                iAvailableEngines = atoi(lscp_client_get_result(pClient));

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return iAvailableEngines;
}


/**
 *  Getting all available engines:
 *  LIST AVAILABLE_ENGINES
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns A NULL terminated array of engine name strings,
 *  or NULL in case of failure.
 */
const char **lscp_list_available_engines ( lscp_client_t *pClient )
{
        const char *pszSeps = ",";

        if (pClient == NULL)
                return NULL;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        if (pClient->engines) {
                lscp_szsplit_destroy(pClient->engines);
                pClient->engines = NULL;
        }

        if (lscp_client_call(pClient, "LIST AVAILABLE_ENGINES\r\n", 0) == LSCP_OK)
                pClient->engines = lscp_szsplit_create(lscp_client_get_result(pClient), pszSeps);

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return (const char **) pClient->engines;
}


/**
 *  Getting information about an engine.
 *  GET ENGINE INFO <engine-name>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param pszEngineName    Engine name.
 *
 *  @returns A pointer to a @ref lscp_engine_info_t structure, with all the
 *  information of the given sampler engine, or NULL in case of failure.
 */
lscp_engine_info_t *lscp_get_engine_info ( lscp_client_t *pClient,
        const char *pszEngineName )
{
        lscp_engine_info_t *pEngineInfo;
        char szQuery[LSCP_BUFSIZ];
        const char *pszResult;
        const char *pszSeps = ":";
        const char *pszCrlf = "\r\n";
        char *pszToken;
        char *pch;

        if (pClient == NULL)
                return NULL;
        if (pszEngineName == NULL)
                return NULL;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        pEngineInfo = &(pClient->engine_info);
        lscp_engine_info_reset(pEngineInfo);

        sprintf(szQuery, "GET ENGINE INFO %s\r\n", pszEngineName);
        if (lscp_client_call(pClient, szQuery, 1) == LSCP_OK) {
                pszResult = lscp_client_get_result(pClient);
                pszToken = lscp_strtok((char *) pszResult, pszSeps, &(pch));
                while (pszToken) {
                        if (strcasecmp(pszToken, "DESCRIPTION") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        lscp_unquote_dup(&(pEngineInfo->description), &pszToken);
                        }
                        else if (strcasecmp(pszToken, "VERSION") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        lscp_unquote_dup(&(pEngineInfo->version), &pszToken);
                        }
                        pszToken = lscp_strtok(NULL, pszSeps, &(pch));
                }
        }
        else pEngineInfo = NULL;

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return pEngineInfo;
}


/**
 *  Getting sampler channel informations:
 *  GET CHANNEL INFO <sampler-channel>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *
 *  @returns A pointer to a @ref lscp_channel_info_t structure, with all the
 *  information of the given sampler channel, or NULL in case of failure.
 */
lscp_channel_info_t *lscp_get_channel_info ( lscp_client_t *pClient, int iSamplerChannel )
{
        lscp_channel_info_t *pChannelInfo;
        char szQuery[LSCP_BUFSIZ];
        const char *pszResult;
        const char *pszSeps = ":";
        const char *pszCrlf = "\r\n";
        char *pszToken;
        char *pch;
        struct _locale_t locale;

        if (pClient == NULL)
                return NULL;
        if (iSamplerChannel < 0)
                return NULL;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        pChannelInfo = &(pClient->channel_info);
        lscp_channel_info_reset(pChannelInfo);

        _save_and_set_c_locale(&locale);

        sprintf(szQuery, "GET CHANNEL INFO %d\r\n", iSamplerChannel);
        if (lscp_client_call(pClient, szQuery, 1) == LSCP_OK) {
                pszResult = lscp_client_get_result(pClient);
                pszToken = lscp_strtok((char *) pszResult, pszSeps, &(pch));
                while (pszToken) {
                        if (strcasecmp(pszToken, "ENGINE_NAME") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        lscp_unquote_dup(&(pChannelInfo->engine_name), &pszToken);
                        }
                        else if (strcasecmp(pszToken, "AUDIO_OUTPUT_DEVICE") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        pChannelInfo->audio_device = atoi(lscp_ltrim(pszToken));
                        }
                        else if (strcasecmp(pszToken, "AUDIO_OUTPUT_CHANNELS") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        pChannelInfo->audio_channels = atoi(lscp_ltrim(pszToken));
                        }
                        else if (strcasecmp(pszToken, "AUDIO_OUTPUT_ROUTING") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken) {
                                        if (pChannelInfo->audio_routing)
                                                lscp_isplit_destroy(pChannelInfo->audio_routing);
                                        pChannelInfo->audio_routing = lscp_isplit_create(pszToken, ",");
                                }
                        }
                        else if (strcasecmp(pszToken, "INSTRUMENT_FILE") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        lscp_unquote_dup(&(pChannelInfo->instrument_file), &pszToken);
                        }
                        else if (strcasecmp(pszToken, "INSTRUMENT_NR") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        pChannelInfo->instrument_nr = atoi(lscp_ltrim(pszToken));
                        }
                        else if (strcasecmp(pszToken, "INSTRUMENT_NAME") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        lscp_unquote_dup(&(pChannelInfo->instrument_name), &pszToken);
                        }
                        else if (strcasecmp(pszToken, "INSTRUMENT_STATUS") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        pChannelInfo->instrument_status = atoi(lscp_ltrim(pszToken));
                        }
                        else if (strcasecmp(pszToken, "MIDI_INPUT_DEVICE") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        pChannelInfo->midi_device = atoi(lscp_ltrim(pszToken));
                        }
                        else if (strcasecmp(pszToken, "MIDI_INPUT_PORT") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        pChannelInfo->midi_port = atoi(lscp_ltrim(pszToken));
                        }
                        else if (strcasecmp(pszToken, "MIDI_INPUT_CHANNEL") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken) {
                                        pszToken = lscp_ltrim(pszToken);
                                        if (strcasecmp(pszToken, "ALL") == 0)
                                                pChannelInfo->midi_channel = LSCP_MIDI_CHANNEL_ALL;
                                        else
                                                pChannelInfo->midi_channel = atoi(pszToken);
                                }
                        }
                        else if (strcasecmp(pszToken, "MIDI_INSTRUMENT_MAP") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken) {
                                        pszToken = lscp_ltrim(pszToken);
                                        if (strcasecmp(pszToken, "NONE") == 0)
                                                pChannelInfo->midi_map = LSCP_MIDI_MAP_NONE;
                                        else
                                        if (strcasecmp(pszToken, "DEFAULT") == 0)
                                                pChannelInfo->midi_map = LSCP_MIDI_MAP_DEFAULT;
                                        else
                                                pChannelInfo->midi_map = atoi(pszToken);
                                }
                        }
                        else if (strcasecmp(pszToken, "VOLUME") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        pChannelInfo->volume = _atof(lscp_ltrim(pszToken));
                        }
                        else if (strcasecmp(pszToken, "MUTE") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        pChannelInfo->mute = (strcasecmp(lscp_unquote(&pszToken, 0), "TRUE") == 0);
                        }
                        else if (strcasecmp(pszToken, "SOLO") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        pChannelInfo->solo = (strcasecmp(lscp_unquote(&pszToken, 0), "TRUE") == 0);
                        }
                        pszToken = lscp_strtok(NULL, pszSeps, &(pch));
                }
        }
        else pChannelInfo = NULL;

        _restore_locale(&locale);

        // Unlock this section up.
        lscp_mutex_unlock(pClient->mutex);

        return pChannelInfo;
}


/**
 *  Current number of active voices:
 *  GET CHANNEL VOICE_COUNT <sampler-channel>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *
 *  @returns The number of voices currently active, -1 in case of failure.
 */
int lscp_get_channel_voice_count ( lscp_client_t *pClient, int iSamplerChannel )
{
        char szQuery[LSCP_BUFSIZ];
        int iVoiceCount = -1;

        if (pClient == NULL)
                return -1;
        if (iSamplerChannel < 0)
                return -1;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        sprintf(szQuery, "GET CHANNEL VOICE_COUNT %d\r\n", iSamplerChannel);
        if (lscp_client_call(pClient, szQuery, 0) == LSCP_OK)
                iVoiceCount = atoi(lscp_client_get_result(pClient));

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return iVoiceCount;
}


/**
 *  Current number of active disk streams:
 *  GET CHANNEL STREAM_COUNT <sampler-channel>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *
 *  @returns The number of active disk streams on success, -1 otherwise.
 */
int lscp_get_channel_stream_count ( lscp_client_t *pClient, int iSamplerChannel )
{
        char szQuery[LSCP_BUFSIZ];
        int iStreamCount = -1;

        if (pClient == NULL)
                return -1;
        if (iSamplerChannel < 0)
                return -1;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        sprintf(szQuery, "GET CHANNEL STREAM_COUNT %d\r\n", iSamplerChannel);
        if (lscp_client_call(pClient, szQuery, 0) == LSCP_OK)
                iStreamCount = atoi(lscp_client_get_result(pClient));

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return iStreamCount;
}


/**
 *  Current least usage of active disk streams.
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *
 *  @returns The usage percentage of the least filled active disk stream
 *  on success, -1 otherwise.
 */
int lscp_get_channel_stream_usage ( lscp_client_t *pClient, int iSamplerChannel )
{
        char szQuery[LSCP_BUFSIZ];
        int  iStreamUsage = -1;
        const char *pszResult;
        const char *pszSeps = "[]%,";
        char *pszToken;
        char *pch;
        int   iStream;
        int   iPercent;

        if (pClient == NULL)
                return -1;
        if (iSamplerChannel < 0)
                return -1;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        iStream = 0;
        sprintf(szQuery, "GET CHANNEL BUFFER_FILL PERCENTAGE %d\r\n", iSamplerChannel);
        if (lscp_client_call(pClient, szQuery, 0) == LSCP_OK) {
                pszResult = lscp_client_get_result(pClient);
                pszToken = lscp_strtok((char *) pszResult, pszSeps, &(pch));
                while (pszToken) {
                        if (*pszToken) {
                                // Skip stream id.
                                pszToken = lscp_strtok(NULL, pszSeps, &(pch));
                                if (pszToken == NULL)
                                        break;
                                // Get least buffer fill percentage.
                                iPercent = atol(pszToken);
                                if (iStreamUsage > iPercent || iStream == 0)
                                        iStreamUsage = iPercent;
                                iStream++;
                        }
                        pszToken = lscp_strtok(NULL, pszSeps, &(pch));
                }
        }

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return iStreamUsage;
}


/**
 *  Current fill state of disk stream buffers:
 *  GET CHANNEL BUFFER_FILL {BYTES|PERCENTAGE} <sampler-channel>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param usage_type       Usage type to be returned, either
 *                          @ref LSCP_USAGE_BYTES, or
 *                          @ref LSCP_USAGE_PERCENTAGE.
 *  @param iSamplerChannel  Sampler channel number.
 *
 *  @returns A pointer to a @ref lscp_buffer_fill_t structure, with the
 *  information of the current disk stream buffer fill usage, for the given
 *  sampler channel, or NULL in case of failure.
 */
lscp_buffer_fill_t *lscp_get_channel_buffer_fill ( lscp_client_t *pClient,
        lscp_usage_t usage_type, int iSamplerChannel )
{
        lscp_buffer_fill_t *pBufferFill;
        char szQuery[LSCP_BUFSIZ];
        int iStreamCount;
        const char *pszUsageType = (usage_type == LSCP_USAGE_BYTES ? "BYTES" : "PERCENTAGE");
        const char *pszResult;
        const char *pszSeps = "[]%,";
        char *pszToken;
        char *pch;
        int   iStream;

        // Retrieve a channel stream estimation.
        iStreamCount = lscp_get_channel_stream_count(pClient, iSamplerChannel);
        if (iStreamCount < 0)
                return NULL;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        // Check if we need to reallocate the stream usage array.
        if (pClient->iStreamCount != iStreamCount) {
                if (pClient->buffer_fill)
                        free(pClient->buffer_fill);
                if (iStreamCount > 0)
                        pClient->buffer_fill = (lscp_buffer_fill_t *) malloc(iStreamCount * sizeof(lscp_buffer_fill_t));
                else
                        pClient->buffer_fill = NULL;
                pClient->iStreamCount = iStreamCount;
        }

        // Get buffer fill usage...
        pBufferFill = pClient->buffer_fill;
        if (pBufferFill && iStreamCount > 0) {
                iStream = 0;
                pBufferFill = pClient->buffer_fill;
                sprintf(szQuery, "GET CHANNEL BUFFER_FILL %s %d\r\n", pszUsageType, iSamplerChannel);
                if (lscp_client_call(pClient, szQuery, 0) == LSCP_OK) {
                        pszResult = lscp_client_get_result(pClient);
                        pszToken = lscp_strtok((char *) pszResult, pszSeps, &(pch));
                        while (pszToken && iStream < pClient->iStreamCount) {
                                if (*pszToken) {
                                        pBufferFill[iStream].stream_id = atol(pszToken);
                                        pszToken = lscp_strtok(NULL, pszSeps, &(pch));
                                        if (pszToken == NULL)
                                                break;
                                        pBufferFill[iStream].stream_usage = atol(pszToken);
                                        iStream++;
                                }
                                pszToken = lscp_strtok(NULL, pszSeps, &(pch));
                        }
                }   // Reset the usage, whatever it was before.
                else while (iStream < pClient->iStreamCount)
                        pBufferFill[iStream++].stream_usage = 0;
        }

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return pBufferFill;
}


/**
 *  Setting audio output type:
 *  SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-type>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param pszAudioDriver   Audio output driver type (e.g. "ALSA" or "JACK").
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_channel_audio_type ( lscp_client_t *pClient,
        int iSamplerChannel, const char *pszAudioDriver )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0 || pszAudioDriver == NULL)
                return LSCP_FAILED;

        sprintf(szQuery, "SET CHANNEL AUDIO_OUTPUT_TYPE %d %s\r\n",
                iSamplerChannel, pszAudioDriver);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Setting audio output device:
 *  SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel> <device-id>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param iAudioDevice     Audio output device number identifier.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_channel_audio_device ( lscp_client_t *pClient,
        int iSamplerChannel, int iAudioDevice )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0 || iAudioDevice < 0)
                return LSCP_FAILED;

        sprintf(szQuery, "SET CHANNEL AUDIO_OUTPUT_DEVICE %d %d\r\n",
                iSamplerChannel, iAudioDevice);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Setting audio output channel:
 *  SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-channel> <audio-output-chan> <audio-input-chan>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param iAudioOut        Audio output device channel to be routed from.
 *  @param iAudioIn         Audio output device channel to be routed into.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_channel_audio_channel ( lscp_client_t *pClient,
        int iSamplerChannel, int iAudioOut, int iAudioIn )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0 || iAudioOut < 0 || iAudioIn < 0)
                return LSCP_FAILED;

        sprintf(szQuery, "SET CHANNEL AUDIO_OUTPUT_CHANNEL %d %d %d\r\n",
                iSamplerChannel, iAudioOut, iAudioIn);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Setting MIDI input type:
 *  SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param pszMidiDriver    MIDI input driver type (e.g. "ALSA").
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_channel_midi_type ( lscp_client_t *pClient,
        int iSamplerChannel, const char *pszMidiDriver )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0 || pszMidiDriver == NULL)
                return LSCP_FAILED;

        sprintf(szQuery, "SET CHANNEL MIDI_INPUT_TYPE %d %s\r\n",
                iSamplerChannel, pszMidiDriver);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Setting MIDI input device:
 *  SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <device-id>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param iMidiDevice      MIDI input device number identifier.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_channel_midi_device ( lscp_client_t *pClient,
        int iSamplerChannel, int iMidiDevice )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0 || iMidiDevice < 0)
                return LSCP_FAILED;

        sprintf(szQuery, "SET CHANNEL MIDI_INPUT_DEVICE %d %d\r\n",
                iSamplerChannel, iMidiDevice);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Setting MIDI input port:
 *  SET CHANNEL MIDI_INPUT_PORT <sampler-channel> <midi-input-port>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param iMidiPort        MIDI input driver virtual port number.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_channel_midi_port ( lscp_client_t *pClient,
        int iSamplerChannel, int iMidiPort )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0 || iMidiPort < 0)
                return LSCP_FAILED;

        sprintf(szQuery, "SET CHANNEL MIDI_INPUT_PORT %d %d\r\n",
                iSamplerChannel, iMidiPort);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Setting MIDI input channel:
 *  SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param iMidiChannel     MIDI channel address number to listen (0-15) or
 *                          @ref LSCP_MIDI_CHANNEL_ALL (16) to listen on all channels.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_channel_midi_channel ( lscp_client_t *pClient,
        int iSamplerChannel, int iMidiChannel )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0 || iMidiChannel < 0 || iMidiChannel > 16)
                return LSCP_FAILED;

        if (iMidiChannel == LSCP_MIDI_CHANNEL_ALL)
                sprintf(szQuery, "SET CHANNEL MIDI_INPUT_CHANNEL %d ALL\r\n",
                        iSamplerChannel);
        else
                sprintf(szQuery, "SET CHANNEL MIDI_INPUT_CHANNEL %d %d\r\n",
                        iSamplerChannel, iMidiChannel);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Setting MIDI instrument map:
 *  SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <midi-map>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param iMidiMap         MIDI instrument map number, or either
 *                          @ref LSCP_MIDI_MAP_NONE or
 *                          @ref LSCP_MIDI_MAP_DEFAULT .
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_channel_midi_map ( lscp_client_t *pClient,
        int iSamplerChannel, int iMidiMap )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0)
                return LSCP_FAILED;

        sprintf(szQuery, "SET CHANNEL MIDI_INSTRUMENT_MAP %d ", iSamplerChannel);
        if (iMidiMap == LSCP_MIDI_MAP_NONE)
                strcat(szQuery , "NONE");
        else
        if (iMidiMap == LSCP_MIDI_MAP_DEFAULT)
                strcat(szQuery , "DEFAULT");
        else
                sprintf(szQuery + strlen(szQuery), "%d", iMidiMap);

        strcat(szQuery, "\r\n");

        return lscp_client_query(pClient, szQuery);
}


/**
 *  Setting channel volume:
 *  SET CHANNEL VOLUME <sampler-channel> <volume>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param fVolume          Sampler channel volume as a positive floating point
 *                          number, where a value less than 1.0 for attenuation,
 *                          and greater than 1.0 for amplification.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_channel_volume ( lscp_client_t *pClient,
        int iSamplerChannel, float fVolume )
{
        char szQuery[LSCP_BUFSIZ];
        struct _locale_t locale;

        if (iSamplerChannel < 0 || fVolume < 0.0f)
                return LSCP_FAILED;

        _save_and_set_c_locale(&locale);
        sprintf(szQuery, "SET CHANNEL VOLUME %d %g\r\n",
                iSamplerChannel, fVolume);
        _restore_locale(&locale);

        return lscp_client_query(pClient, szQuery);
}


/**
 *  Muting a sampler channel:
 *  SET CHANNEL MUTE <sampler-channel> <mute>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param iMute            Sampler channel mute state as a boolean value,
 *                          either 1 (one) to mute the channel or 0 (zero)
 *                          to unmute the channel.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_channel_mute ( lscp_client_t *pClient,
        int iSamplerChannel, int iMute )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0 || iMute < 0 || iMute > 1)
                return LSCP_FAILED;

        sprintf(szQuery, "SET CHANNEL MUTE %d %d\r\n",
                iSamplerChannel, iMute);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Soloing a sampler channel:
 *  SET CHANNEL SOLO <sampler-channel> <solo>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param iSolo            Sampler channel solo state as a boolean value,
 *                          either 1 (one) to solo the channel or 0 (zero)
 *                          to unsolo the channel.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_channel_solo ( lscp_client_t *pClient,
        int iSamplerChannel, int iSolo )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0 || iSolo < 0 || iSolo > 1)
                return LSCP_FAILED;

        sprintf(szQuery, "SET CHANNEL SOLO %d %d\r\n",
                iSamplerChannel, iSolo);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Resetting a sampler channel:
 *  RESET CHANNEL <sampler-channel>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_reset_channel ( lscp_client_t *pClient, int iSamplerChannel )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0)
                return LSCP_FAILED;

        sprintf(szQuery, "RESET CHANNEL %d\r\n", iSamplerChannel);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Resetting the sampler:
 *  RESET
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_reset_sampler ( lscp_client_t *pClient )
{
        // Do actual whole sampler reset...
        return lscp_client_query(pClient, "RESET\r\n");
}


/**
 *  Getting information about the server.
 *  GET SERVER INFO
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns A pointer to a @ref lscp_server_info_t structure, with all the
 *  information of the current connected server, or NULL in case of failure.
 */
lscp_server_info_t *lscp_get_server_info ( lscp_client_t *pClient )
{
        lscp_server_info_t *pServerInfo;
        const char *pszResult;
        const char *pszSeps = ":";
        const char *pszCrlf = "\r\n";
        char *pszToken;
        char *pch;

        if (pClient == NULL)
                return NULL;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        pServerInfo = &(pClient->server_info);
        lscp_server_info_reset(pServerInfo);

        if (lscp_client_call(pClient, "GET SERVER INFO\r\n", 1) == LSCP_OK) {
                pszResult = lscp_client_get_result(pClient);
                pszToken = lscp_strtok((char *) pszResult, pszSeps, &(pch));
                while (pszToken) {
                        if (strcasecmp(pszToken, "DESCRIPTION") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        lscp_unquote_dup(&(pServerInfo->description), &pszToken);
                        }
                        else if (strcasecmp(pszToken, "VERSION") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        lscp_unquote_dup(&(pServerInfo->version), &pszToken);
                        }
                        else if (strcasecmp(pszToken, "PROTOCOL_VERSION") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        lscp_unquote_dup(&(pServerInfo->protocol_version), &pszToken);
                        }
                        pszToken = lscp_strtok(NULL, pszSeps, &(pch));
                }
        }
        else pServerInfo = NULL;

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return pServerInfo;
}


/**
 *  Current total number of active voices:
 *  GET TOTAL_VOICE_COUNT
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns The total number of voices currently active,
 *  -1 in case of failure.
 */
int lscp_get_total_voice_count ( lscp_client_t *pClient )
{
        int iVoiceCount = -1;

        if (pClient == NULL)
                return -1;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        if (lscp_client_call(pClient, "GET TOTAL_VOICE_COUNT\r\n", 0) == LSCP_OK)
                iVoiceCount = atoi(lscp_client_get_result(pClient));

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return iVoiceCount;
}


/**
 *  Maximum amount of active voices:
 *  GET TOTAL_VOICE_COUNT_MAX
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns The maximum amount of voices currently active,
 *  -1 in case of failure.
 */
int lscp_get_total_voice_count_max ( lscp_client_t *pClient )
{
        int iVoiceCount = -1;

        if (pClient == NULL)
                return -1;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        if (lscp_client_call(pClient, "GET TOTAL_VOICE_COUNT_MAX\r\n", 0) == LSCP_OK)
                iVoiceCount = atoi(lscp_client_get_result(pClient));

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return iVoiceCount;
}


/**
 *  Get global volume attenuation:
 *  GET VOLUME
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns The global volume as positive floating point value usually in
 *  the range between 0.0 and 1.0; in case of failure 0.0 is returned.
 */
float lscp_get_volume ( lscp_client_t *pClient )
{
        float fVolume = 0.0f;
        struct _locale_t locale;

        if (pClient == NULL)
                return 0.0f;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        _save_and_set_c_locale(&locale);

        if (lscp_client_call(pClient, "GET VOLUME\r\n", 0) == LSCP_OK)
                fVolume = _atof(lscp_client_get_result(pClient));

        _restore_locale(&locale);

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return fVolume;
}


/**
 *  Setting global volume attenuation:
 *  SET VOLUME <volume>
 *
 *  @param pClient  Pointer to client instance structure.
 *  @param fVolume  Global volume parameter as positive floating point
 *                  value usually be in the range between 0.0 and 1.0,
 *                  that is for attenuating the overall volume.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_volume ( lscp_client_t *pClient, float fVolume )
{
        char szQuery[LSCP_BUFSIZ];
        struct _locale_t locale;

        if (fVolume < 0.0f)
                return LSCP_FAILED;

        _save_and_set_c_locale(&locale);
        sprintf(szQuery, "SET VOLUME %g\r\n", fVolume);
        _restore_locale(&locale);

        return lscp_client_query(pClient, szQuery);
}


/**
 *  Get global voice limit setting:
 *  @code
 *  GET VOICES
 *  @endcode
 *  This value reflects the maximum amount of voices a sampler engine
 *  processes simultaniously before voice stealing kicks in.
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns The current global maximum amount of voices limit or a
 *           negative value on error (e.g. if sampler doesn't support
 *           this command).
 */
int lscp_get_voices ( lscp_client_t *pClient )
{
        int iVoices = -1;

        if (pClient == NULL)
                return -1;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        if (lscp_client_call(pClient, "GET VOICES\r\n", 0) == LSCP_OK)
                iVoices = atoi(lscp_client_get_result(pClient));

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return iVoices;
}


/**
 *  Setting global voice limit setting:
 *  @code
 *  SET VOICES <max-voices>
 *  @endcode
 *  This value reflects the maximum amount of voices a sampler engine
 *  processes simultaniously before voice stealing kicks in. Note that
 *  this value will be passed to all sampler engine instances, that is
 *  the total amount of maximum voices on the running system is thus
 *  @param iMaxVoices multiplied with the current amount of sampler
 *  engine instances.
 *
 *  @param pClient     Pointer to client instance structure.
 *  @param iMaxVoices  Global voice limit setting as integer value larger
 *                     or equal to 1.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_voices ( lscp_client_t *pClient, int iMaxVoices )
{
        char szQuery[LSCP_BUFSIZ];

        if (iMaxVoices < 1)
                return LSCP_FAILED;

        sprintf(szQuery, "SET VOICES %d\r\n", iMaxVoices);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Get global disk streams limit setting:
 *  @code
 *  GET STREAMS
 *  @endcode
 *  This value reflects the maximum amount of disk streams a sampler
 *  engine processes simultaniously.
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns The current global maximum amount of disk streams limit
 *           or a negative value on error (e.g. if sampler doesn't
 *           support this command).
 */
int lscp_get_streams ( lscp_client_t *pClient )
{
        int iStreams = -1;

        if (pClient == NULL)
                return -1;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        if (lscp_client_call(pClient, "GET STREAMS\r\n", 0) == LSCP_OK)
                iStreams = atoi(lscp_client_get_result(pClient));

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return iStreams;
}


/**
 *  Setting global disk streams limit setting:
 *  @code
 *  SET STREAMS <max-streams>
 *  @endcode
 *  This value reflects the maximum amount of dist streams a sampler
 *  engine instance processes simultaniously. Note that this value will
 *  be passed to all sampler engine instances, that is the total amount
 *  of maximum disk streams on the running system is thus
 *  @param iMaxStreams multiplied with the current amount of sampler
 *  engine instances.
 *
 *  @param pClient      Pointer to client instance structure.
 *  @param iMaxStreams  Global streams limit setting as positive integer
 *                      value (larger or equal to 0).
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_streams ( lscp_client_t *pClient, int iMaxStreams )
{
        char szQuery[LSCP_BUFSIZ];

        if (iMaxStreams < 0)
                return LSCP_FAILED;

        sprintf(szQuery, "SET STREAMS %d\r\n", iMaxStreams);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Add an effect send to a sampler channel:
 *  CREATE FX_SEND <sampler-channel> <midi-ctrl> [<fx-name>]
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param iMidiController  MIDI controller used to alter the effect,
 *                          usually a number between 0 and 127.
 *  @param pszFxName        Optional name for the effect send entity,
 *                          does not have to be unique.
 *
 *  @returns The new effect send number identifier, or -1 in case of failure.
 */
int lscp_create_fxsend ( lscp_client_t *pClient,
        int iSamplerChannel, int iMidiController, const char *pszFxName )
{
        int iFxSend = -1;
        char szQuery[LSCP_BUFSIZ];

        if (pClient == NULL)
                return -1;
        if (iSamplerChannel < 0 || iMidiController < 0 || iMidiController > 127)
                return -1;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        sprintf(szQuery, "CREATE FX_SEND %d %d",
                iSamplerChannel, iMidiController);

        if (pszFxName)
                sprintf(szQuery + strlen(szQuery), " '%s'", pszFxName);

        strcat(szQuery, "\r\n");

        if (lscp_client_call(pClient, szQuery, 0) == LSCP_OK)
                iFxSend = atoi(lscp_client_get_result(pClient));

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return iFxSend;
}


/**
 *  Remove an effect send from a sampler channel:
 *  DESTROY FX_SEND <sampler-channel> <fx-send-id>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param iFxSend          Effect send number.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_destroy_fxsend ( lscp_client_t *pClient,
        int iSamplerChannel, int iFxSend )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0 || iFxSend < 0)
                return LSCP_FAILED;

        sprintf(szQuery, "DESTROY FX_SEND %d %d\r\n",
                iSamplerChannel, iFxSend);

        return lscp_client_query(pClient, szQuery);
}


/**
 *  Get amount of effect sends on a sampler channel:
 *  GET FX_SENDS <sampler-channel>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *
 *  @returns The current total number of effect sends of the sampler channel
 *  on success, -1 otherwise.
 */
int lscp_get_fxsends ( lscp_client_t *pClient, int iSamplerChannel )
{
        int iFxSends = -1;
        char szQuery[LSCP_BUFSIZ];

        if (pClient == NULL)
                return -1;
        if (iSamplerChannel < 0)
                return -1;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        sprintf(szQuery, "GET FX_SENDS %d\r\n", iSamplerChannel);

        if (lscp_client_call(pClient, szQuery, 0) == LSCP_OK)
                iFxSends = atoi(lscp_client_get_result(pClient));

        // Unlock this section doen.
        lscp_mutex_unlock(pClient->mutex);

        return iFxSends;
}


/**
 *  List all effect sends on a sampler channel:
 *  LIST FX_SENDS <sampler-channel>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *
 *  @returns An array of the effect sends identifiers as positive integers,
 *  terminated with -1 on success, NULL otherwise.
 */
int *lscp_list_fxsends ( lscp_client_t *pClient, int iSamplerChannel )
{
        const char *pszSeps = ",";
        char szQuery[LSCP_BUFSIZ];

        if (pClient == NULL)
                return NULL;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        if (pClient->fxsends) {
                lscp_isplit_destroy(pClient->fxsends);
                pClient->fxsends = NULL;
        }

        sprintf(szQuery, "LIST FX_SENDS %d\r\n", iSamplerChannel);

        if (lscp_client_call(pClient, szQuery, 0) == LSCP_OK)
                pClient->fxsends = lscp_isplit_create(lscp_client_get_result(pClient), pszSeps);

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return pClient->fxsends;
}


/**
 *  Getting effect send information
 *  GET FX_SEND INFO <sampler-channel> <fx-send-id>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param iFxSend          Effect send number.
 *
 *  @returns A pointer to a @ref lscp_fxsend_info_t structure, with the
 *  information of the given FX send, or NULL in case of failure.
 */
lscp_fxsend_info_t *lscp_get_fxsend_info ( lscp_client_t *pClient,
        int iSamplerChannel, int iFxSend )
{
        lscp_fxsend_info_t *pFxSendInfo;
        char szQuery[LSCP_BUFSIZ];
        const char *pszResult;
        const char *pszSeps = ":";
        const char *pszCrlf = "\r\n";
        char *pszToken;
        char *pch;
        struct _locale_t locale;

        if (pClient == NULL)
                return NULL;
        if (iSamplerChannel < 0 || iFxSend < 0)
                return NULL;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        _save_and_set_c_locale(&locale);

        pFxSendInfo = &(pClient->fxsend_info);
        lscp_fxsend_info_reset(pFxSendInfo);

        sprintf(szQuery, "GET FX_SEND INFO %d %d\r\n", iSamplerChannel, iFxSend);
        if (lscp_client_call(pClient, szQuery, 1) == LSCP_OK) {
                pszResult = lscp_client_get_result(pClient);
                pszToken = lscp_strtok((char *) pszResult, pszSeps, &(pch));
                while (pszToken) {
                        if (strcasecmp(pszToken, "NAME") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        lscp_unquote_dup(&(pFxSendInfo->name), &pszToken);
                        }
                        else if (strcasecmp(pszToken, "MIDI_CONTROLLER") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        pFxSendInfo->midi_controller = atoi(lscp_ltrim(pszToken));
                        }
                        else if (strcasecmp(pszToken, "AUDIO_OUTPUT_ROUTING") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken) {
                                        if (pFxSendInfo->audio_routing)
                                                lscp_isplit_destroy(pFxSendInfo->audio_routing);
                                        pFxSendInfo->audio_routing = lscp_isplit_create(pszToken, ",");
                                }
                        }
                        else if (strcasecmp(pszToken, "LEVEL") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        pFxSendInfo->level = _atof(lscp_ltrim(pszToken));
                        }
                        pszToken = lscp_strtok(NULL, pszSeps, &(pch));
                }
        }
        else pFxSendInfo = NULL;

        _restore_locale(&locale);

        // Unlock this section up.
        lscp_mutex_unlock(pClient->mutex);

        return pFxSendInfo;
}


/**
 *  Alter effect send's name:
 *  @code
 *  SET FX_SEND NAME <sampler-chan> <fx-send-id> <name>
 *  @endcode
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param iFxSend          Effect send number.
 *  @param pszFxName        Effect send's new name.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_fxsend_name ( lscp_client_t *pClient,
        int iSamplerChannel, int iFxSend, const char *pszFxName )
{
        char szQuery[LSCP_BUFSIZ];

        if (!pClient || iSamplerChannel < 0 || iFxSend < 0 || !pszFxName)
                return LSCP_FAILED;

        snprintf(szQuery, LSCP_BUFSIZ, "SET FX_SEND NAME %d %d '%s'\r\n",
                iSamplerChannel, iFxSend, pszFxName);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Alter effect send's audio routing:
 *  SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id>
 *    <audio-src> <audio-dst>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param iFxSend          Effect send number.
 *  @param iAudioSrc        Audio output device channel to be routed from.
 *  @param iAudioDst        Audio output device channel to be routed into.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_fxsend_audio_channel ( lscp_client_t *pClient,
        int iSamplerChannel, int iFxSend, int iAudioSrc, int iAudioDst )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0 || iFxSend < 0 || iAudioSrc < 0 || iAudioDst < 0)
                return LSCP_FAILED;

        sprintf(szQuery, "SET FX_SEND AUDIO_OUTPUT_CHANNEL %d %d %d %d\r\n",
                iSamplerChannel, iFxSend, iAudioSrc, iAudioDst);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Alter effect send's MIDI controller:
 *  SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-ctrl>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param iFxSend          Effect send number.
 *  @param iMidiController  MIDI controller used to alter the effect,
 *                          usually a number between 0 and 127.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_fxsend_midi_controller ( lscp_client_t *pClient,
        int iSamplerChannel, int iFxSend, int iMidiController )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0 || iFxSend < 0 ||
                iMidiController < 0 || iMidiController > 127)
                return LSCP_FAILED;

        sprintf(szQuery, "SET FX_SEND MIDI_CONTROLLER %d %d %d\r\n",
                iSamplerChannel, iFxSend, iMidiController);
        return lscp_client_query(pClient, szQuery);
}


/**
 *  Alter effect send's audio level:
 *  SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <level>
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param iSamplerChannel  Sampler channel number.
 *  @param iFxSend          Effect send number.
 *  @param fLevel           Effect send volume level.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_fxsend_level ( lscp_client_t *pClient,
        int iSamplerChannel, int iFxSend, float fLevel )
{
        char szQuery[LSCP_BUFSIZ];
        struct _locale_t locale;

        if (iSamplerChannel < 0 || iFxSend < 0 || fLevel < 0.0f)
                return LSCP_FAILED;

        _save_and_set_c_locale(&locale);
        sprintf(szQuery, "SET FX_SEND LEVEL %d %d %f\r\n",
                iSamplerChannel, iFxSend, fLevel);
        _restore_locale(&locale);

        return lscp_client_query(pClient, szQuery);
}


/**
 *  Create a new MIDI instrument map:
 *  ADD MIDI_INSTRUMENT_MAP [<name>]
 *
 *  @param pClient      Pointer to client instance structure.
 *  @param pszMapName   MIDI instrument map name (optional)
 *
 *  @returns The new MIDI instrument map number identifier,
 *  or -1 in case of failure.
 */
int lscp_add_midi_instrument_map ( lscp_client_t *pClient, const char *pszMapName )
{
        int iMidiMap = -1;
        char szQuery[LSCP_BUFSIZ];

        if (pClient == NULL)
                return -1;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        strcpy(szQuery, "ADD MIDI_INSTRUMENT_MAP");

        if (pszMapName)
                sprintf(szQuery + strlen(szQuery), " '%s'", pszMapName);

        strcat(szQuery, "\r\n");

        if (lscp_client_call(pClient, szQuery, 0) == LSCP_OK)
                iMidiMap = atoi(lscp_client_get_result(pClient));

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return iMidiMap;
}


/**
 *  Delete one particular or all MIDI instrument maps:
 *  REMOVE MIDI_INSTRUMENT_MAP <midi-map>
 *
 *  @param pClient  Pointer to client instance structure.
 *  @param iMidiMap MIDI instrument map number.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_remove_midi_instrument_map ( lscp_client_t *pClient, int iMidiMap )
{
        char szQuery[LSCP_BUFSIZ];

        if (iMidiMap < 0)
                return LSCP_FAILED;

        sprintf(szQuery, "REMOVE MIDI_INSTRUMENT_MAP %d\r\n", iMidiMap);

        return lscp_client_query(pClient, szQuery);
}


/**
 *  Get amount of existing MIDI instrument maps:
 *  GET MIDI_INSTRUMENT_MAPS
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns The current total number of MIDI instrument maps
 *  on success, -1 otherwise.
 */
int lscp_get_midi_instrument_maps ( lscp_client_t *pClient )
{
        int iMidiMaps = -1;

        if (pClient == NULL)
                return -1;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        if (lscp_client_call(pClient, "GET MIDI_INSTRUMENT_MAPS\r\n", 0) == LSCP_OK)
                iMidiMaps = atoi(lscp_client_get_result(pClient));

        // Unlock this section doen.
        lscp_mutex_unlock(pClient->mutex);

        return iMidiMaps;
}


/**
 *  Getting all created MIDI instrument maps:
 *  LIST MIDI_INSTRUMENT_MAPS
 *
 *  @param pClient  Pointer to client instance structure.
 *
 *  @returns An array of the MIDI instrument map identifiers as positive
 *  integers, terminated with -1 on success, NULL otherwise.
 */
int *lscp_list_midi_instrument_maps ( lscp_client_t *pClient )
{
        const char *pszSeps = ",";

        if (pClient == NULL)
                return NULL;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        if (pClient->midi_maps) {
                lscp_isplit_destroy(pClient->midi_maps);
                pClient->midi_maps = NULL;
        }

        if (lscp_client_call(pClient, "LIST MIDI_INSTRUMENT_MAPS\r\n", 0) == LSCP_OK)
                pClient->midi_maps = lscp_isplit_create(lscp_client_get_result(pClient), pszSeps);

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return pClient->midi_maps;
}


/**
 *  Getting a MIDI instrument map name:
 *  GET MIDI_INSTRUMENT_MAP INFO <midi-map>
 *
 *  @param pClient  Pointer to client instance structure.
 *  @param iMidiMap MIDI instrument map number.
 *
 *  @returns The MIDI instrument map name on success, NULL on failure.
 */
const char *lscp_get_midi_instrument_map_name ( lscp_client_t *pClient, int iMidiMap )
{
        char szQuery[LSCP_BUFSIZ];
        const char *pszResult;
        const char *pszSeps = ":";
        const char *pszCrlf = "\r\n";
        char *pszToken;
        char *pch;

        if (pClient == NULL)
                return NULL;
        if (iMidiMap < 0)
                return NULL;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        if (pClient->midi_map_name) {
                free(pClient->midi_map_name);
                pClient->midi_map_name = NULL;
        }

        sprintf(szQuery, "GET MIDI_INSTRUMENT_MAP INFO %d\r\n", iMidiMap);
        if (lscp_client_call(pClient, szQuery, 1) == LSCP_OK) {
                pszResult = lscp_client_get_result(pClient);
                pszToken = lscp_strtok((char *) pszResult, pszSeps, &(pch));
                while (pszToken) {
                        if (strcasecmp(pszToken, "NAME") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        lscp_unquote_dup(&(pClient->midi_map_name), &pszToken);
                        }
                        pszToken = lscp_strtok(NULL, pszSeps, &(pch));
                }
        }

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return pClient->midi_map_name;
}


/**
 *  Renaming a MIDI instrument map:
 *  SET MIDI_INSTRUMENT_MAP NAME <midi-map> <map-name>
 *
 *  @param pClient      Pointer to client instance structure.
 *  @param iMidiMap     MIDI instrument map number.
 *  @param pszMapName   MIDI instrument map name.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_set_midi_instrument_map_name ( lscp_client_t *pClient, int iMidiMap, const char *pszMapName )
{
        char szQuery[LSCP_BUFSIZ];

        if (iMidiMap < 0)
                return LSCP_FAILED;
        if (pszMapName == NULL)
                return LSCP_FAILED;

        sprintf(szQuery, "SET MIDI_INSTRUMENT_MAP NAME %d '%s'\r\n",
                iMidiMap, pszMapName);

        return lscp_client_query(pClient, szQuery);
}


/**
 *  Create or replace a MIDI instrumnet map entry:
 *  MAP MIDI_INSTRUMENT <midi-map> <midi-bank> <midi-prog>
 *      <engine-name> <filename> <instr-index> <volume> [<load-mode> [<name>]}
 *
 *  @param pClient          Pointer to client instance structure.
 *  @param pMidiInstr       MIDI instrument bank and program parameter key.
 *  @param pszEngineName    Engine name.
 *  @param pszFileName      Instrument file name.
 *  @param iInstrIndex      Instrument index number.
 *  @param fVolume          Reflects the master volume of the instrument as
 *                          a positive floating point number, where a value
 *                          less than 1.0 for attenuation, and greater than
 *                          1.0 for amplification.
 *  @param load_mode        Instrument load life-time strategy, either
 *                          @ref LSCP_LOAD_DEFAULT, or
 *                          @ref LSCP_LOAD_ON_DEMAND, or
 *                          @ref LSCP_LOAD_ON_DEMAND_HOLD, or
 *                          @ref LSCP_LOAD_PERSISTENT.
 *  @param pszName         Instrument custom name for the map entry (optional).
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_map_midi_instrument ( lscp_client_t *pClient,
        lscp_midi_instrument_t *pMidiInstr, const char *pszEngineName,
        const char *pszFileName, int iInstrIndex, float fVolume,
        lscp_load_mode_t load_mode, const char *pszName )
{
        char szQuery[LSCP_BUFSIZ];
        struct _locale_t locale;

        if (pMidiInstr->map < 0)
                return LSCP_FAILED;
        if (pMidiInstr->bank < 0 || pMidiInstr->bank > 16383)
                return LSCP_FAILED;
        if (pMidiInstr->prog < 0 || pMidiInstr->prog > 127)
                return LSCP_FAILED;
        if (pszEngineName == NULL || pszFileName == NULL)
                return LSCP_FAILED;

        if (fVolume < 0.0f)
                fVolume = 1.0f;

        _save_and_set_c_locale(&locale);
        sprintf(szQuery, "MAP MIDI_INSTRUMENT %d %d %d %s '%s' %d %g",
                pMidiInstr->map, pMidiInstr->bank, pMidiInstr->prog,
                pszEngineName, pszFileName, iInstrIndex, fVolume);
        _restore_locale(&locale);

        switch (load_mode) {
        case LSCP_LOAD_PERSISTENT:
                strcat(szQuery, " PERSISTENT");
                break;
        case LSCP_LOAD_ON_DEMAND_HOLD:
                strcat(szQuery, " ON_DEMAND_HOLD");
                break;
        case LSCP_LOAD_ON_DEMAND:
                strcat(szQuery, " ON_DEMAND");
                break;
        case LSCP_LOAD_DEFAULT:
        default:
                break;
        }

        if (pszName)
                sprintf(szQuery + strlen(szQuery), " '%s'", pszName);

        strcat(szQuery, "\r\n");

        return lscp_client_query(pClient, szQuery);
}


/**
 *  Remove an entry from the MIDI instrument map:
 *  UNMAP MIDI_INSTRUMENT <midi-map> <midi-bank> <midi-prog>
 *
 *  @param pClient      Pointer to client instance structure.
 *  @param pMidiInstr   MIDI instrument bank and program parameter key.
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_unmap_midi_instrument ( lscp_client_t *pClient,
        lscp_midi_instrument_t *pMidiInstr )
{
        char szQuery[LSCP_BUFSIZ];

        if (pMidiInstr->map < 0)
                return LSCP_FAILED;
        if (pMidiInstr->bank < 0 || pMidiInstr->bank > 16383)
                return LSCP_FAILED;
        if (pMidiInstr->prog < 0 || pMidiInstr->prog > 127)
                return LSCP_FAILED;

        sprintf(szQuery, "UNMAP MIDI_INSTRUMENT %d %d %d\r\n",
                pMidiInstr->map, pMidiInstr->bank, pMidiInstr->prog);

        return lscp_client_query(pClient, szQuery);
}


/**
 *  Get the total count of MIDI instrument map entries:
 *  GET MIDI_INSTRUMENTS ALL|<midi-map>
 *
 *  @param pClient  Pointer to client instance structure.
 *  @param iMidiMap MIDI instrument map number, or @ref LSCP_MIDI_MAP_ALL .
 *
 *  @returns The current total number of MIDI instrument map entries
 *  on success, -1 otherwise.
 */
int lscp_get_midi_instruments ( lscp_client_t *pClient, int iMidiMap )
{
        int iInstruments = -1;
        char szQuery[LSCP_BUFSIZ];

        if (pClient == NULL)
                return -1;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        strcpy(szQuery, "GET MIDI_INSTRUMENTS ");

        if (iMidiMap < 0)
                strcat(szQuery, "ALL");
        else
                sprintf(szQuery + strlen(szQuery), "%d", iMidiMap);

        strcat(szQuery, "\r\n");

        if (lscp_client_call(pClient, szQuery, 0) == LSCP_OK)
                iInstruments = atoi(lscp_client_get_result(pClient));

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return iInstruments;
}


/**
 *  Getting indeces of all MIDI instrument map entries:
 *  LIST MIDI_INSTRUMENTS ALL|<midi-map>
 *
 *  @param pClient  Pointer to client instance structure.
 *  @param iMidiMap MIDI instrument map number, or @ref LSCP_MIDI_MAP_ALL .
 *
 *  @returns An array of @ref lscp_midi_instrument_t, terminated with the
 *  {-1,-1,-1} triplet, NULL otherwise.
 */
lscp_midi_instrument_t *lscp_list_midi_instruments ( lscp_client_t *pClient, int iMidiMap )
{
        char szQuery[LSCP_BUFSIZ];

        if (pClient == NULL)
                return NULL;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        if (pClient->midi_instruments) {
                lscp_midi_instruments_destroy(pClient->midi_instruments);
                pClient->midi_instruments = NULL;
        }

        strcpy(szQuery, "LIST MIDI_INSTRUMENTS ");

        if (iMidiMap < 0)
                strcat(szQuery, "ALL");
        else
                sprintf(szQuery + strlen(szQuery), "%d", iMidiMap);

        strcat(szQuery, "\r\n");

        if (lscp_client_call(pClient, szQuery, 0) == LSCP_OK)
                pClient->midi_instruments = lscp_midi_instruments_create(
                        lscp_client_get_result(pClient));

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return pClient->midi_instruments;
}


/**
 *  Getting information about a MIDI instrument map entry:
 *  GET MIDI_INSTRUMENT INFO <midi-map> <midi-bank> <midi-prog>
 *
 *  @param pClient      Pointer to client instance structure.
 *  @param pMidiInstr   MIDI instrument bank and program parameter key.
 *
 *  @returns A pointer to a @ref lscp_midi_instrument_info_t structure,
 *  with all the information of the given MIDI instrument map entry,
 *  or NULL in case of failure.
 */
lscp_midi_instrument_info_t *lscp_get_midi_instrument_info ( lscp_client_t *pClient,
        lscp_midi_instrument_t *pMidiInstr )
{
        lscp_midi_instrument_info_t *pInstrInfo;
        char szQuery[LSCP_BUFSIZ];
        const char *pszResult;
        const char *pszSeps = ":";
        const char *pszCrlf = "\r\n";
        char *pszToken;
        char *pch;
        struct _locale_t locale;

        if (pClient == NULL)
                return NULL;
        if (pMidiInstr->map < 0)
                return NULL;
        if (pMidiInstr->bank < 0 || pMidiInstr->bank > 16383)
                return NULL;
        if (pMidiInstr->prog < 0 || pMidiInstr->prog > 127)
                return NULL;

        // Lock this section up.
        lscp_mutex_lock(pClient->mutex);

        _save_and_set_c_locale(&locale);

        pInstrInfo = &(pClient->midi_instrument_info);
        lscp_midi_instrument_info_reset(pInstrInfo);

        sprintf(szQuery, "GET MIDI_INSTRUMENT INFO %d %d %d\r\n",
                pMidiInstr->map, pMidiInstr->bank, pMidiInstr->prog);
        if (lscp_client_call(pClient, szQuery, 1) == LSCP_OK) {
                pszResult = lscp_client_get_result(pClient);
                pszToken = lscp_strtok((char *) pszResult, pszSeps, &(pch));
                while (pszToken) {
                        if (strcasecmp(pszToken, "NAME") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        lscp_unquote_dup(&(pInstrInfo->name), &pszToken);
                        }
                        else if (strcasecmp(pszToken, "ENGINE_NAME") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        lscp_unquote_dup(&(pInstrInfo->engine_name), &pszToken);
                        }
                        else if (strcasecmp(pszToken, "INSTRUMENT_FILE") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        lscp_unquote_dup(&(pInstrInfo->instrument_file), &pszToken);
                        }
                        else if (strcasecmp(pszToken, "INSTRUMENT_NR") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        pInstrInfo->instrument_nr = atoi(lscp_ltrim(pszToken));
                        }
                        else if (strcasecmp(pszToken, "INSTRUMENT_NAME") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        lscp_unquote_dup(&(pInstrInfo->instrument_name), &pszToken);
                        }
                        else if (strcasecmp(pszToken, "LOAD_MODE") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken) {
                                        pszToken = lscp_ltrim(pszToken);
                                        if (strcasecmp(pszToken, "ON_DEMAND") == 0)
                                                pInstrInfo->load_mode = LSCP_LOAD_ON_DEMAND;
                                        else
                                        if (strcasecmp(pszToken, "ON_DEMAND_HOLD") == 0)
                                                pInstrInfo->load_mode = LSCP_LOAD_ON_DEMAND_HOLD;
                                        else
                                        if (strcasecmp(pszToken, "PERSISTENT") == 0)
                                                pInstrInfo->load_mode = LSCP_LOAD_PERSISTENT;
                                        else
                                                pInstrInfo->load_mode = LSCP_LOAD_DEFAULT;
                                }
                        }
                        else if (strcasecmp(pszToken, "VOLUME") == 0) {
                                pszToken = lscp_strtok(NULL, pszCrlf, &(pch));
                                if (pszToken)
                                        pInstrInfo->volume = _atof(lscp_ltrim(pszToken));
                        }
                        pszToken = lscp_strtok(NULL, pszSeps, &(pch));
                }
        }
        else pInstrInfo = NULL;

        _restore_locale(&locale);

        // Unlock this section down.
        lscp_mutex_unlock(pClient->mutex);

        return pInstrInfo;
}


/**
 *  Clear the MIDI instrumnet map:
 *  CLEAR MIDI_INSTRUMENTS ALL|<midi-map>
 *
 *  @param pClient  Pointer to client instance structure.
 *  @param iMidiMap MIDI instrument map number, or @ref LSCP_MIDI_MAP_ALL .
 *
 *  @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_clear_midi_instruments  ( lscp_client_t *pClient, int iMidiMap )
{
        char szQuery[LSCP_BUFSIZ];

        strcpy(szQuery, "CLEAR MIDI_INSTRUMENTS ");

        if (iMidiMap < 0)
                strcat(szQuery, "ALL");
        else
                sprintf(szQuery + strlen(szQuery), "%d", iMidiMap);

        strcat(szQuery, "\r\n");

        return lscp_client_query(pClient, szQuery);
}


/**
 * Open an instrument editor application for the instrument
 * on the given sampler channel:
 * EDIT CHANNEL INSTRUMENT <sampler-channel>
 *
 * @param pClient         Pointer to client instance structure.
 * @param iSamplerChannel Sampler Channel.
 *
 * @returns LSCP_OK on success, LSCP_FAILED otherwise.
 */
lscp_status_t lscp_edit_channel_instrument ( lscp_client_t *pClient, int iSamplerChannel )
{
        char szQuery[LSCP_BUFSIZ];

        if (iSamplerChannel < 0)
                return LSCP_FAILED;

        sprintf(szQuery, "EDIT CHANNEL INSTRUMENT %d\r\n", iSamplerChannel);

        return lscp_client_query(pClient, szQuery);
}


// end of client.c