#include <locale.h>
#include "common.h"
#include <sys/time.h>
#include <sys/errno.h>

Data Structures
struct	_locale_t

Macros
#define	LSCP_TIMEOUT_MSECS 500
#define	USE_GETADDRINFO 1

Functions
const char *	lscp_client_package (void)
const char *	lscp_client_version (void)
const char *	lscp_client_build (void)
lscp_client_t *	lscp_client_create (const char pszHost, int iPort, lscp_client_proc_t pfnCallback, void pvData)
lscp_status_t	lscp_client_join (lscp_client_t *pClient)
lscp_status_t	lscp_client_destroy (lscp_client_t *pClient)
lscp_status_t	lscp_client_set_timeout (lscp_client_t *pClient, int iTimeout)
int	lscp_client_get_timeout (lscp_client_t *pClient)
bool	lscp_client_connection_lost (lscp_client_t *pClient)
lscp_status_t	lscp_client_query (lscp_client_t pClient, const char pszQuery)
const char *	lscp_client_get_result (lscp_client_t *pClient)
int	lscp_client_get_errno (lscp_client_t *pClient)
lscp_status_t	lscp_client_subscribe (lscp_client_t *pClient, lscp_event_t events)
lscp_status_t	lscp_client_unsubscribe (lscp_client_t *pClient, lscp_event_t events)
lscp_event_t	lscp_client_get_events (lscp_client_t *pClient)
lscp_status_t	lscp_load_instrument (lscp_client_t pClient, const char pszFileName, int iInstrIndex, int iSamplerChannel)
lscp_status_t	lscp_load_instrument_non_modal (lscp_client_t pClient, const char pszFileName, int iInstrIndex, int iSamplerChannel)
lscp_status_t	lscp_load_engine (lscp_client_t pClient, const char pszEngineName, int iSamplerChannel)
int	lscp_get_channels (lscp_client_t *pClient)
int *	lscp_list_channels (lscp_client_t *pClient)
int	lscp_add_channel (lscp_client_t *pClient)
lscp_status_t	lscp_remove_channel (lscp_client_t *pClient, int iSamplerChannel)
int	lscp_get_available_engines (lscp_client_t *pClient)
const char **	lscp_list_available_engines (lscp_client_t *pClient)
lscp_engine_info_t *	lscp_get_engine_info (lscp_client_t pClient, const char pszEngineName)
lscp_channel_info_t *	lscp_get_channel_info (lscp_client_t *pClient, int iSamplerChannel)
int	lscp_get_channel_voice_count (lscp_client_t *pClient, int iSamplerChannel)
int	lscp_get_channel_stream_count (lscp_client_t *pClient, int iSamplerChannel)
int	lscp_get_channel_stream_usage (lscp_client_t *pClient, int iSamplerChannel)
lscp_buffer_fill_t *	lscp_get_channel_buffer_fill (lscp_client_t *pClient, lscp_usage_t usage_type, int iSamplerChannel)
lscp_status_t	lscp_set_channel_audio_type (lscp_client_t pClient, int iSamplerChannel, const char pszAudioDriver)
lscp_status_t	lscp_set_channel_audio_device (lscp_client_t *pClient, int iSamplerChannel, int iAudioDevice)
lscp_status_t	lscp_set_channel_audio_channel (lscp_client_t *pClient, int iSamplerChannel, int iAudioOut, int iAudioIn)
lscp_status_t	lscp_set_channel_midi_type (lscp_client_t pClient, int iSamplerChannel, const char pszMidiDriver)
lscp_status_t	lscp_set_channel_midi_device (lscp_client_t *pClient, int iSamplerChannel, int iMidiDevice)
lscp_status_t	lscp_set_channel_midi_port (lscp_client_t *pClient, int iSamplerChannel, int iMidiPort)
lscp_status_t	lscp_set_channel_midi_channel (lscp_client_t *pClient, int iSamplerChannel, int iMidiChannel)
lscp_status_t	lscp_set_channel_midi_map (lscp_client_t *pClient, int iSamplerChannel, int iMidiMap)
lscp_status_t	lscp_set_channel_volume (lscp_client_t *pClient, int iSamplerChannel, float fVolume)
lscp_status_t	lscp_set_channel_mute (lscp_client_t *pClient, int iSamplerChannel, int iMute)
lscp_status_t	lscp_set_channel_solo (lscp_client_t *pClient, int iSamplerChannel, int iSolo)
lscp_status_t	lscp_reset_channel (lscp_client_t *pClient, int iSamplerChannel)
lscp_status_t	lscp_reset_sampler (lscp_client_t *pClient)
lscp_server_info_t *	lscp_get_server_info (lscp_client_t *pClient)
int	lscp_get_total_voice_count (lscp_client_t *pClient)
int	lscp_get_total_voice_count_max (lscp_client_t *pClient)
float	lscp_get_volume (lscp_client_t *pClient)
lscp_status_t	lscp_set_volume (lscp_client_t *pClient, float fVolume)
int	lscp_get_voices (lscp_client_t *pClient)
lscp_status_t	lscp_set_voices (lscp_client_t *pClient, int iMaxVoices)
int	lscp_get_streams (lscp_client_t *pClient)
lscp_status_t	lscp_set_streams (lscp_client_t *pClient, int iMaxStreams)
int	lscp_create_fxsend (lscp_client_t pClient, int iSamplerChannel, int iMidiController, const char pszFxName)
lscp_status_t	lscp_destroy_fxsend (lscp_client_t *pClient, int iSamplerChannel, int iFxSend)
int	lscp_get_fxsends (lscp_client_t *pClient, int iSamplerChannel)
int *	lscp_list_fxsends (lscp_client_t *pClient, int iSamplerChannel)
lscp_fxsend_info_t *	lscp_get_fxsend_info (lscp_client_t *pClient, int iSamplerChannel, int iFxSend)
lscp_status_t	lscp_set_fxsend_name (lscp_client_t pClient, int iSamplerChannel, int iFxSend, const char pszFxName)
lscp_status_t	lscp_set_fxsend_audio_channel (lscp_client_t *pClient, int iSamplerChannel, int iFxSend, int iAudioSrc, int iAudioDst)
lscp_status_t	lscp_set_fxsend_midi_controller (lscp_client_t *pClient, int iSamplerChannel, int iFxSend, int iMidiController)
lscp_status_t	lscp_set_fxsend_level (lscp_client_t *pClient, int iSamplerChannel, int iFxSend, float fLevel)
int	lscp_add_midi_instrument_map (lscp_client_t pClient, const char pszMapName)
lscp_status_t	lscp_remove_midi_instrument_map (lscp_client_t *pClient, int iMidiMap)
int	lscp_get_midi_instrument_maps (lscp_client_t *pClient)
int *	lscp_list_midi_instrument_maps (lscp_client_t *pClient)
const char *	lscp_get_midi_instrument_map_name (lscp_client_t *pClient, int iMidiMap)
lscp_status_t	lscp_set_midi_instrument_map_name (lscp_client_t pClient, int iMidiMap, const char pszMapName)
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)
lscp_status_t	lscp_unmap_midi_instrument (lscp_client_t pClient, lscp_midi_instrument_t pMidiInstr)
int	lscp_get_midi_instruments (lscp_client_t *pClient, int iMidiMap)
lscp_midi_instrument_t *	lscp_list_midi_instruments (lscp_client_t *pClient, int iMidiMap)
lscp_midi_instrument_info_t *	lscp_get_midi_instrument_info (lscp_client_t pClient, lscp_midi_instrument_t pMidiInstr)
lscp_status_t	lscp_clear_midi_instruments (lscp_client_t *pClient, int iMidiMap)
lscp_status_t	lscp_edit_channel_instrument (lscp_client_t *pClient, int iSamplerChannel)

Macro Definition Documentation

◆ LSCP_TIMEOUT_MSECS

#define LSCP_TIMEOUT_MSECS 500

Referenced by lscp_client_create().

◆ USE_GETADDRINFO

#define USE_GETADDRINFO 1

Function Documentation

◆ lscp_add_channel()

int lscp_add_channel ( lscp_client_t * pClient )

Adding a new sampler channel: ADD CHANNEL

Parameters

pClient Pointer to client instance structure.

Returns: The new sampler channel number identifier, or -1 in case of failure.

References lscp_add_channel(), lscp_client_get_result(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_add_channel().

◆ lscp_add_midi_instrument_map()

int lscp_add_midi_instrument_map	(	lscp_client_t *	pClient,
		const char *	pszMapName )

Create a new MIDI instrument map: ADD MIDI_INSTRUMENT_MAP [<name>]

Parameters

pClient	Pointer to client instance structure.
pszMapName	MIDI instrument map name (optional)

Returns: The new MIDI instrument map number identifier, or -1 in case of failure.

References lscp_add_midi_instrument_map(), LSCP_BUFSIZ, lscp_client_get_result(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_add_midi_instrument_map().

◆ lscp_clear_midi_instruments()

lscp_status_t lscp_clear_midi_instruments	(	lscp_client_t *	pClient,
		int	iMidiMap )

Clear the MIDI instrumnet map: CLEAR MIDI_INSTRUMENTS ALL|<midi-map>

Parameters

pClient	Pointer to client instance structure.
iMidiMap	MIDI instrument map number, or LSCP_MIDI_MAP_ALL .

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_clear_midi_instruments(), and lscp_client_query().

Referenced by lscp_clear_midi_instruments().

◆ lscp_client_build()

const char * lscp_client_build ( void )

Retrieve the current client library build string.

References LSCP_BUILD, and lscp_client_build().

Referenced by lscp_client_build().

◆ lscp_client_connection_lost()

bool lscp_client_connection_lost ( lscp_client_t * pClient )

Check whether connection to server is lost.

Parameters

pClient Pointer to client instance structure.

Returns: true if client lost connection to server, false otherwise.

References lscp_client_connection_lost(), and lscp_client_get_errno().

Referenced by lscp_client_connection_lost().

◆ lscp_client_create()

lscp_client_t * lscp_client_create	(	const char *	pszHost,
		int	iPort,
		lscp_client_proc_t	pfnCallback,
		void *	pvData )

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.

Parameters

pszHost	Hostname of the linuxsampler listening server.
iPort	Port number of the linuxsampler listening server.
pfnCallback	Callback function to receive event notifications.
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.

References closesocket, INVALID_SOCKET, lscp_client_create(), lscp_cond_init, LSCP_EVENT_NONE, lscp_mutex_init, lscp_socket_agent_init(), lscp_socket_getopts(), lscp_socket_herror(), lscp_socket_perror(), LSCP_TIMEOUT_MSECS, and SOCKET_ERROR.

Referenced by lscp_client_create().

◆ lscp_client_destroy()

lscp_status_t lscp_client_destroy ( lscp_client_t * pClient )

Terminate and destroy a client instance.

Parameters

pClient Pointer to client instance structure.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References lscp_client_destroy(), lscp_cond_destroy, LSCP_FAILED, lscp_mutex_destroy, lscp_mutex_lock, lscp_mutex_unlock, LSCP_OK, and lscp_socket_agent_free().

Referenced by lscp_client_destroy().

◆ lscp_client_get_errno()

int lscp_client_get_errno ( lscp_client_t * pClient )

Get the last error/warning number received.

Parameters

pClient Pointer to client instance structure.

Returns: The numerical value of the last error or warning response code received.

References lscp_client_get_errno().

Referenced by lscp_client_connection_lost(), and lscp_client_get_errno().

◆ lscp_client_get_events()

lscp_event_t lscp_client_get_events ( lscp_client_t * pClient )

Getting current subscribed events.

Parameters

pClient Pointer to client instance structure.

Returns: The current subscrived bit-wise OR'ed event flags.

References lscp_client_get_events(), and LSCP_EVENT_NONE.

Referenced by lscp_client_get_events().

◆ lscp_client_get_result()

const char * lscp_client_get_result ( lscp_client_t * pClient )

Get the last received result string. In case of error or warning, this is the text of the error or warning message issued.

Parameters

pClient Pointer to client instance structure.

Returns: A pointer to the literal null-terminated result string as of the last command request.

References lscp_client_get_result().

Referenced by lscp_add_channel(), lscp_add_midi_instrument_map(), lscp_client_get_result(), lscp_create_audio_device(), lscp_create_fxsend(), lscp_create_midi_device(), lscp_get_audio_devices(), lscp_get_available_audio_drivers(), lscp_get_available_engines(), lscp_get_available_midi_drivers(), lscp_get_channel_buffer_fill(), lscp_get_channel_info(), lscp_get_channel_stream_count(), lscp_get_channel_stream_usage(), lscp_get_channel_voice_count(), lscp_get_channels(), lscp_get_engine_info(), lscp_get_fxsend_info(), lscp_get_fxsends(), lscp_get_midi_devices(), lscp_get_midi_instrument_info(), lscp_get_midi_instrument_map_name(), lscp_get_midi_instrument_maps(), lscp_get_midi_instruments(), lscp_get_server_info(), lscp_get_streams(), lscp_get_total_voice_count(), lscp_get_total_voice_count_max(), lscp_get_voices(), lscp_get_volume(), lscp_list_audio_devices(), lscp_list_available_audio_drivers(), lscp_list_available_engines(), lscp_list_available_midi_drivers(), lscp_list_channels(), lscp_list_fxsends(), lscp_list_midi_devices(), lscp_list_midi_instrument_maps(), and lscp_list_midi_instruments().

◆ lscp_client_get_timeout()

int lscp_client_get_timeout ( lscp_client_t * pClient )

Get the client transaction timeout interval.

Parameters

pClient Pointer to client instance structure.

Returns: The current timeout value milliseconds, -1 in case of failure.

References lscp_client_get_timeout().

Referenced by lscp_client_get_timeout().

◆ lscp_client_join()

lscp_status_t lscp_client_join ( lscp_client_t * pClient )

Wait for a client instance to terminate graciously.

Parameters

pClient Pointer to client instance structure.

References lscp_client_join(), LSCP_FAILED, LSCP_OK, and lscp_socket_agent_join().

Referenced by lscp_client_join().

◆ lscp_client_package()

const char * lscp_client_package ( void )

Retrieve the current client library version string.

References lscp_client_package(), and LSCP_PACKAGE.

Referenced by lscp_client_package().

◆ lscp_client_query()

lscp_status_t lscp_client_query	(	lscp_client_t *	pClient,
		const char *	pszQuery )

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 lscp_client_get_result and lscp_client_get_errno function calls.

Parameters

pClient	Pointer to client instance structure.
pszQuery	Command request line to be sent to server, must be cr/lf and null terminated.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References lscp_client_query(), LSCP_FAILED, lscp_mutex_lock, and lscp_mutex_unlock.

Referenced by lscp_clear_midi_instruments(), lscp_client_query(), lscp_destroy_audio_device(), lscp_destroy_fxsend(), lscp_destroy_midi_device(), lscp_edit_channel_instrument(), lscp_load_engine(), lscp_load_instrument(), lscp_load_instrument_non_modal(), lscp_map_midi_instrument(), lscp_remove_channel(), lscp_remove_midi_instrument_map(), lscp_reset_channel(), lscp_reset_sampler(), lscp_set_audio_channel_param(), lscp_set_audio_device_param(), lscp_set_channel_audio_channel(), lscp_set_channel_audio_device(), lscp_set_channel_audio_type(), lscp_set_channel_midi_channel(), lscp_set_channel_midi_device(), lscp_set_channel_midi_map(), lscp_set_channel_midi_port(), lscp_set_channel_midi_type(), lscp_set_channel_mute(), lscp_set_channel_solo(), lscp_set_channel_volume(), lscp_set_fxsend_audio_channel(), lscp_set_fxsend_level(), lscp_set_fxsend_midi_controller(), lscp_set_fxsend_name(), lscp_set_midi_device_param(), lscp_set_midi_instrument_map_name(), lscp_set_midi_port_param(), lscp_set_streams(), lscp_set_voices(), lscp_set_volume(), and lscp_unmap_midi_instrument().

◆ lscp_client_set_timeout()

lscp_status_t lscp_client_set_timeout	(	lscp_client_t *	pClient,
		int	iTimeout )

Set the client transaction timeout interval.

Parameters

pClient	Pointer to client instance structure.
iTimeout	Transaction timeout in milliseconds.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References lscp_client_set_timeout(), LSCP_FAILED, and LSCP_OK.

Referenced by lscp_client_set_timeout().

◆ lscp_client_subscribe()

lscp_status_t lscp_client_subscribe	(	lscp_client_t *	pClient,
		lscp_event_t	events )

Register frontend for receiving event messages by the sampler backend. Caution: since liblscp v0.5.5.4 you have to call lscp_client_subscribe() for 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:

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

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:

SUBSCRIBE CHANNEL_MIDI

Parameters

pClient	Pointer to client instance structure.
events	LSCP event to subscribe.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References lscp_client_subscribe(), LSCP_EVENT_AUDIO_OUTPUT_DEVICE_COUNT, LSCP_EVENT_AUDIO_OUTPUT_DEVICE_INFO, LSCP_EVENT_BUFFER_FILL, LSCP_EVENT_CHANNEL_COUNT, LSCP_EVENT_CHANNEL_INFO, LSCP_EVENT_CHANNEL_MIDI, LSCP_EVENT_DEVICE_MIDI, LSCP_EVENT_MIDI_INPUT_DEVICE_COUNT, LSCP_EVENT_MIDI_INPUT_DEVICE_INFO, LSCP_EVENT_MIDI_INSTRUMENT_COUNT, LSCP_EVENT_MIDI_INSTRUMENT_INFO, LSCP_EVENT_MIDI_INSTRUMENT_MAP_COUNT, LSCP_EVENT_MIDI_INSTRUMENT_MAP_INFO, LSCP_EVENT_MISCELLANEOUS, LSCP_EVENT_NONE, LSCP_EVENT_STREAM_COUNT, LSCP_EVENT_TOTAL_VOICE_COUNT, LSCP_EVENT_VOICE_COUNT, LSCP_FAILED, lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_client_subscribe().

◆ lscp_client_unsubscribe()

lscp_status_t lscp_client_unsubscribe	(	lscp_client_t *	pClient,
		lscp_event_t	events )

Deregister frontend from receiving UDP event messages anymore. Caution: since liblscp v0.5.5.4 you have to call lscp_client_unsubscribe() for 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:

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

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:

UNSUBSCRIBE CHANNEL_MIDI

Parameters

pClient	Pointer to client instance structure.
events	LSCP event to unsubscribe.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References lscp_client_unsubscribe(), LSCP_EVENT_AUDIO_OUTPUT_DEVICE_COUNT, LSCP_EVENT_AUDIO_OUTPUT_DEVICE_INFO, LSCP_EVENT_BUFFER_FILL, LSCP_EVENT_CHANNEL_COUNT, LSCP_EVENT_CHANNEL_INFO, LSCP_EVENT_CHANNEL_MIDI, LSCP_EVENT_DEVICE_MIDI, LSCP_EVENT_MIDI_INPUT_DEVICE_COUNT, LSCP_EVENT_MIDI_INPUT_DEVICE_INFO, LSCP_EVENT_MIDI_INSTRUMENT_COUNT, LSCP_EVENT_MIDI_INSTRUMENT_INFO, LSCP_EVENT_MIDI_INSTRUMENT_MAP_COUNT, LSCP_EVENT_MIDI_INSTRUMENT_MAP_INFO, LSCP_EVENT_MISCELLANEOUS, LSCP_EVENT_NONE, LSCP_EVENT_STREAM_COUNT, LSCP_EVENT_TOTAL_VOICE_COUNT, LSCP_EVENT_VOICE_COUNT, LSCP_FAILED, lscp_mutex_lock, lscp_mutex_unlock, LSCP_OK, and lscp_socket_agent_free().

Referenced by lscp_client_unsubscribe().

◆ lscp_client_version()

const char * lscp_client_version ( void )

Retrieve the current client library version string.

References lscp_client_version(), and LSCP_VERSION.

Referenced by lscp_client_version().

◆ lscp_create_fxsend()

int lscp_create_fxsend	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		int	iMidiController,
		const char *	pszFxName )

Add an effect send to a sampler channel: CREATE FX_SEND <sampler-channel> <midi-ctrl> [<fx-name>]

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
iMidiController	MIDI controller used to alter the effect, usually a number between 0 and 127.
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.

References LSCP_BUFSIZ, lscp_client_get_result(), lscp_create_fxsend(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_create_fxsend().

◆ lscp_destroy_fxsend()

lscp_status_t lscp_destroy_fxsend	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		int	iFxSend )

Remove an effect send from a sampler channel: DESTROY FX_SEND <sampler-channel> <fx-send-id>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
iFxSend	Effect send number.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), lscp_destroy_fxsend(), and LSCP_FAILED.

Referenced by lscp_destroy_fxsend().

◆ lscp_edit_channel_instrument()

lscp_status_t lscp_edit_channel_instrument	(	lscp_client_t *	pClient,
		int	iSamplerChannel )

Open an instrument editor application for the instrument on the given sampler channel: EDIT CHANNEL INSTRUMENT <sampler-channel>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler Channel.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), lscp_edit_channel_instrument(), and LSCP_FAILED.

Referenced by lscp_edit_channel_instrument().

◆ lscp_get_available_engines()

int lscp_get_available_engines ( lscp_client_t * pClient )

Getting all available engines count: GET AVAILABLE_ENGINES

Parameters

pClient Pointer to client instance structure.

Returns: The current total number of sampler engines on success, -1 otherwise.

References lscp_client_get_result(), lscp_get_available_engines(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_get_available_engines().

◆ lscp_get_channel_buffer_fill()

lscp_buffer_fill_t * lscp_get_channel_buffer_fill	(	lscp_client_t *	pClient,
		lscp_usage_t	usage_type,
		int	iSamplerChannel )

Current fill state of disk stream buffers: GET CHANNEL BUFFER_FILL {BYTES|PERCENTAGE} <sampler-channel>

Parameters

pClient	Pointer to client instance structure.
usage_type	Usage type to be returned, either LSCP_USAGE_BYTES, or LSCP_USAGE_PERCENTAGE.
iSamplerChannel	Sampler channel number.

Returns: A pointer to a 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.

References LSCP_BUFSIZ, lscp_client_get_result(), lscp_get_channel_buffer_fill(), lscp_get_channel_stream_count(), lscp_mutex_lock, lscp_mutex_unlock, LSCP_OK, LSCP_USAGE_BYTES, _lscp_buffer_fill_t::stream_id, and _lscp_buffer_fill_t::stream_usage.

Referenced by lscp_get_channel_buffer_fill().

◆ lscp_get_channel_info()

lscp_channel_info_t * lscp_get_channel_info	(	lscp_client_t *	pClient,
		int	iSamplerChannel )

Getting sampler channel informations: GET CHANNEL INFO <sampler-channel>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.

Returns: A pointer to a lscp_channel_info_t structure, with all the information of the given sampler channel, or NULL in case of failure.

Referenced by lscp_get_channel_info().

◆ lscp_get_channel_stream_count()

int lscp_get_channel_stream_count	(	lscp_client_t *	pClient,
		int	iSamplerChannel )

Current number of active disk streams: GET CHANNEL STREAM_COUNT <sampler-channel>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.

Returns: The number of active disk streams on success, -1 otherwise.

References LSCP_BUFSIZ, lscp_client_get_result(), lscp_get_channel_stream_count(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_get_channel_buffer_fill(), and lscp_get_channel_stream_count().

◆ lscp_get_channel_stream_usage()

int lscp_get_channel_stream_usage	(	lscp_client_t *	pClient,
		int	iSamplerChannel )

Current least usage of active disk streams.

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.

Returns: The usage percentage of the least filled active disk stream on success, -1 otherwise.

References LSCP_BUFSIZ, lscp_client_get_result(), lscp_get_channel_stream_usage(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_get_channel_stream_usage().

◆ lscp_get_channel_voice_count()

int lscp_get_channel_voice_count	(	lscp_client_t *	pClient,
		int	iSamplerChannel )

Current number of active voices: GET CHANNEL VOICE_COUNT <sampler-channel>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.

Returns: The number of voices currently active, -1 in case of failure.

References LSCP_BUFSIZ, lscp_client_get_result(), lscp_get_channel_voice_count(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_get_channel_voice_count().

◆ lscp_get_channels()

int lscp_get_channels ( lscp_client_t * pClient )

Current number of sampler channels: GET CHANNELS

Parameters

pClient Pointer to client instance structure.

Returns: The current total number of sampler channels on success, -1 otherwise.

References lscp_client_get_result(), lscp_get_channels(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_get_channels().

◆ lscp_get_engine_info()

lscp_engine_info_t * lscp_get_engine_info	(	lscp_client_t *	pClient,
		const char *	pszEngineName )

Getting information about an engine. GET ENGINE INFO <engine-name>

Parameters

pClient	Pointer to client instance structure.
pszEngineName	Engine name.

Returns: A pointer to a lscp_engine_info_t structure, with all the information of the given sampler engine, or NULL in case of failure.

References _lscp_engine_info_t::description, LSCP_BUFSIZ, lscp_client_get_result(), lscp_get_engine_info(), lscp_mutex_lock, lscp_mutex_unlock, LSCP_OK, and _lscp_engine_info_t::version.

Referenced by lscp_get_engine_info().

◆ lscp_get_fxsend_info()

lscp_fxsend_info_t * lscp_get_fxsend_info	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		int	iFxSend )

Getting effect send information GET FX_SEND INFO <sampler-channel> <fx-send-id>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
iFxSend	Effect send number.

Returns: A pointer to a lscp_fxsend_info_t structure, with the information of the given FX send, or NULL in case of failure.

References _lscp_fxsend_info_t::audio_routing, _lscp_fxsend_info_t::level, LSCP_BUFSIZ, lscp_client_get_result(), lscp_get_fxsend_info(), lscp_mutex_lock, lscp_mutex_unlock, LSCP_OK, _lscp_fxsend_info_t::midi_controller, and _lscp_fxsend_info_t::name.

Referenced by lscp_get_fxsend_info().

◆ lscp_get_fxsends()

int lscp_get_fxsends	(	lscp_client_t *	pClient,
		int	iSamplerChannel )

Get amount of effect sends on a sampler channel: GET FX_SENDS <sampler-channel>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.

Returns: The current total number of effect sends of the sampler channel on success, -1 otherwise.

References LSCP_BUFSIZ, lscp_client_get_result(), lscp_get_fxsends(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_get_fxsends().

◆ lscp_get_midi_instrument_info()

lscp_midi_instrument_info_t * lscp_get_midi_instrument_info	(	lscp_client_t *	pClient,
		lscp_midi_instrument_t *	pMidiInstr )

Getting information about a MIDI instrument map entry: GET MIDI_INSTRUMENT INFO <midi-map> <midi-bank> <midi-prog>

Parameters

pClient	Pointer to client instance structure.
pMidiInstr	MIDI instrument bank and program parameter key.

Returns: A pointer to a lscp_midi_instrument_info_t structure, with all the information of the given MIDI instrument map entry, or NULL in case of failure.

Referenced by lscp_get_midi_instrument_info().

◆ lscp_get_midi_instrument_map_name()

const char * lscp_get_midi_instrument_map_name	(	lscp_client_t *	pClient,
		int	iMidiMap )

Getting a MIDI instrument map name: GET MIDI_INSTRUMENT_MAP INFO <midi-map>

Parameters

pClient	Pointer to client instance structure.
iMidiMap	MIDI instrument map number.

Returns: The MIDI instrument map name on success, NULL on failure.

References LSCP_BUFSIZ, lscp_client_get_result(), lscp_get_midi_instrument_map_name(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_get_midi_instrument_map_name().

◆ lscp_get_midi_instrument_maps()

int lscp_get_midi_instrument_maps ( lscp_client_t * pClient )

Get amount of existing MIDI instrument maps: GET MIDI_INSTRUMENT_MAPS

Parameters

pClient Pointer to client instance structure.

Returns: The current total number of MIDI instrument maps on success, -1 otherwise.

References lscp_client_get_result(), lscp_get_midi_instrument_maps(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_get_midi_instrument_maps().

◆ lscp_get_midi_instruments()

int lscp_get_midi_instruments	(	lscp_client_t *	pClient,
		int	iMidiMap )

Get the total count of MIDI instrument map entries: GET MIDI_INSTRUMENTS ALL|<midi-map>

Parameters

pClient	Pointer to client instance structure.
iMidiMap	MIDI instrument map number, or LSCP_MIDI_MAP_ALL .

Returns: The current total number of MIDI instrument map entries on success, -1 otherwise.

References LSCP_BUFSIZ, lscp_client_get_result(), lscp_get_midi_instruments(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_get_midi_instruments().

◆ lscp_get_server_info()

lscp_server_info_t * lscp_get_server_info ( lscp_client_t * pClient )

Getting information about the server. GET SERVER INFO

Parameters

pClient Pointer to client instance structure.

Returns: A pointer to a lscp_server_info_t structure, with all the information of the current connected server, or NULL in case of failure.

References _lscp_server_info_t::description, lscp_client_get_result(), lscp_get_server_info(), lscp_mutex_lock, lscp_mutex_unlock, LSCP_OK, _lscp_server_info_t::protocol_version, and _lscp_server_info_t::version.

Referenced by lscp_get_server_info().

◆ lscp_get_streams()

int lscp_get_streams ( lscp_client_t * pClient )

Get global disk streams limit setting:

GET STREAMS

This value reflects the maximum amount of disk streams a sampler engine processes simultaniously.

Parameters

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).

References lscp_client_get_result(), lscp_get_streams(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_get_streams().

◆ lscp_get_total_voice_count()

int lscp_get_total_voice_count ( lscp_client_t * pClient )

Current total number of active voices: GET TOTAL_VOICE_COUNT

Parameters

pClient Pointer to client instance structure.

Returns: The total number of voices currently active, -1 in case of failure.

References lscp_client_get_result(), lscp_get_total_voice_count(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_get_total_voice_count().

◆ lscp_get_total_voice_count_max()

int lscp_get_total_voice_count_max ( lscp_client_t * pClient )

Maximum amount of active voices: GET TOTAL_VOICE_COUNT_MAX

Parameters

pClient Pointer to client instance structure.

Returns: The maximum amount of voices currently active, -1 in case of failure.

References lscp_client_get_result(), lscp_get_total_voice_count_max(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_get_total_voice_count_max().

◆ lscp_get_voices()

int lscp_get_voices ( lscp_client_t * pClient )

Get global voice limit setting:

GET VOICES

This value reflects the maximum amount of voices a sampler engine processes simultaniously before voice stealing kicks in.

Parameters

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).

References lscp_client_get_result(), lscp_get_voices(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_get_voices().

◆ lscp_get_volume()

float lscp_get_volume ( lscp_client_t * pClient )

Get global volume attenuation: GET VOLUME

Parameters

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.

References lscp_client_get_result(), lscp_get_volume(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_get_volume().

◆ lscp_list_available_engines()

const char ** lscp_list_available_engines ( lscp_client_t * pClient )

Getting all available engines: LIST AVAILABLE_ENGINES

Parameters

pClient Pointer to client instance structure.

Returns: A NULL terminated array of engine name strings, or NULL in case of failure.

References lscp_client_get_result(), lscp_list_available_engines(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_list_available_engines().

◆ lscp_list_channels()

int * lscp_list_channels ( lscp_client_t * pClient )

List current sampler channels number identifiers: LIST CHANNELS

Parameters

pClient Pointer to client instance structure.

Returns: An array of the sampler channels identifiers as positive integers, terminated with -1 on success, NULL otherwise.

References lscp_client_get_result(), lscp_list_channels(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_list_channels().

◆ lscp_list_fxsends()

int * lscp_list_fxsends	(	lscp_client_t *	pClient,
		int	iSamplerChannel )

List all effect sends on a sampler channel: LIST FX_SENDS <sampler-channel>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.

Returns: An array of the effect sends identifiers as positive integers, terminated with -1 on success, NULL otherwise.

References LSCP_BUFSIZ, lscp_client_get_result(), lscp_list_fxsends(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_list_fxsends().

◆ lscp_list_midi_instrument_maps()

int * lscp_list_midi_instrument_maps ( lscp_client_t * pClient )

Getting all created MIDI instrument maps: LIST MIDI_INSTRUMENT_MAPS

Parameters

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.

References lscp_client_get_result(), lscp_list_midi_instrument_maps(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_list_midi_instrument_maps().

◆ lscp_list_midi_instruments()

lscp_midi_instrument_t * lscp_list_midi_instruments	(	lscp_client_t *	pClient,
		int	iMidiMap )

Getting indeces of all MIDI instrument map entries: LIST MIDI_INSTRUMENTS ALL|<midi-map>

Parameters

pClient	Pointer to client instance structure.
iMidiMap	MIDI instrument map number, or LSCP_MIDI_MAP_ALL .

Returns: An array of lscp_midi_instrument_t, terminated with the {-1,-1,-1} triplet, NULL otherwise.

References LSCP_BUFSIZ, lscp_client_get_result(), lscp_list_midi_instruments(), lscp_mutex_lock, lscp_mutex_unlock, and LSCP_OK.

Referenced by lscp_list_midi_instruments().

◆ lscp_load_engine()

lscp_status_t lscp_load_engine	(	lscp_client_t *	pClient,
		const char *	pszEngineName,
		int	iSamplerChannel )

Loading a sampler engine: LOAD ENGINE <engine-name> <sampler-channel>

Parameters

pClient	Pointer to client instance structure.
pszEngineName	Engine name.
iSamplerChannel	Sampler channel number.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_load_engine().

Referenced by lscp_load_engine().

◆ lscp_load_instrument()

lscp_status_t lscp_load_instrument	(	lscp_client_t *	pClient,
		const char *	pszFileName,
		int	iInstrIndex,
		int	iSamplerChannel )

Loading an instrument: LOAD INSTRUMENT <filename> <instr-index> <sampler-channel>

Parameters

pClient	Pointer to client instance structure.
pszFileName	Instrument file name.
iInstrIndex	Instrument index number.
iSamplerChannel	Sampler Channel.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_load_instrument().

Referenced by lscp_load_instrument().

◆ lscp_load_instrument_non_modal()

lscp_status_t lscp_load_instrument_non_modal	(	lscp_client_t *	pClient,
		const char *	pszFileName,
		int	iInstrIndex,
		int	iSamplerChannel )

Loading an instrument in the background (non modal): LOAD INSTRUMENT NON_MODAL <filename> <instr-index> <sampler-channel>

Parameters

pClient	Pointer to client instance structure.
pszFileName	Instrument file name.
iInstrIndex	Instrument index number.
iSamplerChannel	Sampler Channel.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_load_instrument_non_modal().

Referenced by lscp_load_instrument_non_modal().

◆ lscp_map_midi_instrument()

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 )

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>]}

Parameters

pClient	Pointer to client instance structure.
pMidiInstr	MIDI instrument bank and program parameter key.
pszEngineName	Engine name.
pszFileName	Instrument file name.
iInstrIndex	Instrument index number.
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.
load_mode	Instrument load life-time strategy, either LSCP_LOAD_DEFAULT, or LSCP_LOAD_ON_DEMAND, or LSCP_LOAD_ON_DEMAND_HOLD, or LSCP_LOAD_PERSISTENT.
pszName	Instrument custom name for the map entry (optional).

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References _lscp_midi_instrument_t::bank, LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, LSCP_LOAD_DEFAULT, LSCP_LOAD_ON_DEMAND, LSCP_LOAD_ON_DEMAND_HOLD, LSCP_LOAD_PERSISTENT, lscp_map_midi_instrument(), _lscp_midi_instrument_t::map, and _lscp_midi_instrument_t::prog.

Referenced by lscp_map_midi_instrument().

◆ lscp_remove_channel()

lscp_status_t lscp_remove_channel	(	lscp_client_t *	pClient,
		int	iSamplerChannel )

Removing a sampler channel: REMOVE CHANNEL <sampler-channel>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_remove_channel().

Referenced by lscp_remove_channel().

◆ lscp_remove_midi_instrument_map()

lscp_status_t lscp_remove_midi_instrument_map	(	lscp_client_t *	pClient,
		int	iMidiMap )

Delete one particular or all MIDI instrument maps: REMOVE MIDI_INSTRUMENT_MAP <midi-map>

Parameters

pClient	Pointer to client instance structure.
iMidiMap	MIDI instrument map number.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_remove_midi_instrument_map().

Referenced by lscp_remove_midi_instrument_map().

◆ lscp_reset_channel()

lscp_status_t lscp_reset_channel	(	lscp_client_t *	pClient,
		int	iSamplerChannel )

Resetting a sampler channel: RESET CHANNEL <sampler-channel>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_reset_channel().

Referenced by lscp_reset_channel().

◆ lscp_reset_sampler()

lscp_status_t lscp_reset_sampler ( lscp_client_t * pClient )

Resetting the sampler: RESET

Parameters

pClient Pointer to client instance structure.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References lscp_client_query(), and lscp_reset_sampler().

Referenced by lscp_reset_sampler().

◆ lscp_set_channel_audio_channel()

lscp_status_t lscp_set_channel_audio_channel	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		int	iAudioOut,
		int	iAudioIn )

Setting audio output channel: SET CHANNEL AUDIO_OUTPUT_CHANNEL <sampler-channel> <audio-output-chan> <audio-input-chan>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
iAudioOut	Audio output device channel to be routed from.
iAudioIn	Audio output device channel to be routed into.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_channel_audio_channel().

Referenced by lscp_set_channel_audio_channel().

◆ lscp_set_channel_audio_device()

lscp_status_t lscp_set_channel_audio_device	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		int	iAudioDevice )

Setting audio output device: SET CHANNEL AUDIO_OUTPUT_DEVICE <sampler-channel> <device-id>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
iAudioDevice	Audio output device number identifier.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_channel_audio_device().

Referenced by lscp_set_channel_audio_device().

◆ lscp_set_channel_audio_type()

lscp_status_t lscp_set_channel_audio_type	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		const char *	pszAudioDriver )

Setting audio output type: SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-type>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
pszAudioDriver	Audio output driver type (e.g. "ALSA" or "JACK").

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_channel_audio_type().

Referenced by lscp_set_channel_audio_type().

◆ lscp_set_channel_midi_channel()

lscp_status_t lscp_set_channel_midi_channel	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		int	iMidiChannel )

Setting MIDI input channel: SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
iMidiChannel	MIDI channel address number to listen (0-15) or LSCP_MIDI_CHANNEL_ALL (16) to listen on all channels.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, LSCP_MIDI_CHANNEL_ALL, and lscp_set_channel_midi_channel().

Referenced by lscp_set_channel_midi_channel().

◆ lscp_set_channel_midi_device()

lscp_status_t lscp_set_channel_midi_device	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		int	iMidiDevice )

Setting MIDI input device: SET CHANNEL MIDI_INPUT_DEVICE <sampler-channel> <device-id>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
iMidiDevice	MIDI input device number identifier.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_channel_midi_device().

Referenced by lscp_set_channel_midi_device().

◆ lscp_set_channel_midi_map()

lscp_status_t lscp_set_channel_midi_map	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		int	iMidiMap )

Setting MIDI instrument map: SET CHANNEL MIDI_INSTRUMENT_MAP <sampler-channel> <midi-map>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
iMidiMap	MIDI instrument map number, or either LSCP_MIDI_MAP_NONE or LSCP_MIDI_MAP_DEFAULT .

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, LSCP_MIDI_MAP_DEFAULT, LSCP_MIDI_MAP_NONE, and lscp_set_channel_midi_map().

Referenced by lscp_set_channel_midi_map().

◆ lscp_set_channel_midi_port()

lscp_status_t lscp_set_channel_midi_port	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		int	iMidiPort )

Setting MIDI input port: SET CHANNEL MIDI_INPUT_PORT <sampler-channel> <midi-input-port>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
iMidiPort	MIDI input driver virtual port number.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_channel_midi_port().

Referenced by lscp_set_channel_midi_port().

◆ lscp_set_channel_midi_type()

lscp_status_t lscp_set_channel_midi_type	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		const char *	pszMidiDriver )

Setting MIDI input type: SET CHANNEL MIDI_INPUT_TYPE <sampler-channel> <midi-input-type>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
pszMidiDriver	MIDI input driver type (e.g. "ALSA").

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_channel_midi_type().

Referenced by lscp_set_channel_midi_type().

◆ lscp_set_channel_mute()

lscp_status_t lscp_set_channel_mute	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		int	iMute )

Muting a sampler channel: SET CHANNEL MUTE <sampler-channel> <mute>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
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.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_channel_mute().

Referenced by lscp_set_channel_mute().

◆ lscp_set_channel_solo()

lscp_status_t lscp_set_channel_solo	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		int	iSolo )

Soloing a sampler channel: SET CHANNEL SOLO <sampler-channel> <solo>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
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.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_channel_solo().

Referenced by lscp_set_channel_solo().

◆ lscp_set_channel_volume()

lscp_status_t lscp_set_channel_volume	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		float	fVolume )

Setting channel volume: SET CHANNEL VOLUME <sampler-channel> <volume>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
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.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_channel_volume().

Referenced by lscp_set_channel_volume().

◆ lscp_set_fxsend_audio_channel()

lscp_status_t lscp_set_fxsend_audio_channel	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		int	iFxSend,
		int	iAudioSrc,
		int	iAudioDst )

Alter effect send's audio routing: SET FX_SEND AUDIO_OUTPUT_CHANNEL <sampler-chan> <fx-send-id> <audio-src> <audio-dst>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
iFxSend	Effect send number.
iAudioSrc	Audio output device channel to be routed from.
iAudioDst	Audio output device channel to be routed into.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_fxsend_audio_channel().

Referenced by lscp_set_fxsend_audio_channel().

◆ lscp_set_fxsend_level()

lscp_status_t lscp_set_fxsend_level	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		int	iFxSend,
		float	fLevel )

Alter effect send's audio level: SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <level>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
iFxSend	Effect send number.
fLevel	Effect send volume level.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_fxsend_level().

Referenced by lscp_set_fxsend_level().

◆ lscp_set_fxsend_midi_controller()

lscp_status_t lscp_set_fxsend_midi_controller	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		int	iFxSend,
		int	iMidiController )

Alter effect send's MIDI controller: SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-ctrl>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
iFxSend	Effect send number.
iMidiController	MIDI controller used to alter the effect, usually a number between 0 and 127.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_fxsend_midi_controller().

Referenced by lscp_set_fxsend_midi_controller().

◆ lscp_set_fxsend_name()

lscp_status_t lscp_set_fxsend_name	(	lscp_client_t *	pClient,
		int	iSamplerChannel,
		int	iFxSend,
		const char *	pszFxName )

Alter effect send's name:

SET FX_SEND NAME <sampler-chan> <fx-send-id> <name>

Parameters

pClient	Pointer to client instance structure.
iSamplerChannel	Sampler channel number.
iFxSend	Effect send number.
pszFxName	Effect send's new name.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_fxsend_name().

Referenced by lscp_set_fxsend_name().

◆ lscp_set_midi_instrument_map_name()

lscp_status_t lscp_set_midi_instrument_map_name	(	lscp_client_t *	pClient,
		int	iMidiMap,
		const char *	pszMapName )

Renaming a MIDI instrument map: SET MIDI_INSTRUMENT_MAP NAME <midi-map> <map-name>

Parameters

pClient	Pointer to client instance structure.
iMidiMap	MIDI instrument map number.
pszMapName	MIDI instrument map name.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_midi_instrument_map_name().

Referenced by lscp_set_midi_instrument_map_name().

◆ lscp_set_streams()

lscp_status_t lscp_set_streams	(	lscp_client_t *	pClient,
		int	iMaxStreams )

Setting global disk streams limit setting:

SET STREAMS <max-streams>

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

Parameters

iMaxStreams	multiplied with the current amount of sampler engine instances.
pClient	Pointer to client instance structure.
iMaxStreams	Global streams limit setting as positive integer value (larger or equal to 0).

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_streams().

Referenced by lscp_set_streams().

◆ lscp_set_voices()

lscp_status_t lscp_set_voices	(	lscp_client_t *	pClient,
		int	iMaxVoices )

Setting global voice limit setting:

SET VOICES <max-voices>

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

Parameters

iMaxVoices	multiplied with the current amount of sampler engine instances.
pClient	Pointer to client instance structure.
iMaxVoices	Global voice limit setting as integer value larger or equal to 1.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_voices().

Referenced by lscp_set_voices().

◆ lscp_set_volume()

lscp_status_t lscp_set_volume	(	lscp_client_t *	pClient,
		float	fVolume )

Setting global volume attenuation: SET VOLUME <volume>

Parameters

pClient	Pointer to client instance structure.
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.

References LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, and lscp_set_volume().

Referenced by lscp_set_volume().

◆ lscp_unmap_midi_instrument()

lscp_status_t lscp_unmap_midi_instrument	(	lscp_client_t *	pClient,
		lscp_midi_instrument_t *	pMidiInstr )

Remove an entry from the MIDI instrument map: UNMAP MIDI_INSTRUMENT <midi-map> <midi-bank> <midi-prog>

Parameters

pClient	Pointer to client instance structure.
pMidiInstr	MIDI instrument bank and program parameter key.

Returns: LSCP_OK on success, LSCP_FAILED otherwise.

References _lscp_midi_instrument_t::bank, LSCP_BUFSIZ, lscp_client_query(), LSCP_FAILED, lscp_unmap_midi_instrument(), _lscp_midi_instrument_t::map, and _lscp_midi_instrument_t::prog.

Referenced by lscp_unmap_midi_instrument().

Data Structures

Macros

Functions

Macro Definition Documentation

◆ LSCP_TIMEOUT_MSECS

◆ USE_GETADDRINFO

Function Documentation

◆ lscp_add_channel()

◆ lscp_add_midi_instrument_map()

◆ lscp_clear_midi_instruments()

◆ lscp_client_build()

◆ lscp_client_connection_lost()

◆ lscp_client_create()

◆ lscp_client_destroy()

◆ lscp_client_get_errno()

◆ lscp_client_get_events()

◆ lscp_client_get_result()

◆ lscp_client_get_timeout()

◆ lscp_client_join()

◆ lscp_client_package()

◆ lscp_client_query()

◆ lscp_client_set_timeout()

◆ lscp_client_subscribe()

◆ lscp_client_unsubscribe()

◆ lscp_client_version()

◆ lscp_create_fxsend()

◆ lscp_destroy_fxsend()

◆ lscp_edit_channel_instrument()

◆ lscp_get_available_engines()

◆ lscp_get_channel_buffer_fill()

◆ lscp_get_channel_info()

◆ lscp_get_channel_stream_count()

◆ lscp_get_channel_stream_usage()

◆ lscp_get_channel_voice_count()

◆ lscp_get_channels()

◆ lscp_get_engine_info()

◆ lscp_get_fxsend_info()

◆ lscp_get_fxsends()

◆ lscp_get_midi_instrument_info()

◆ lscp_get_midi_instrument_map_name()

◆ lscp_get_midi_instrument_maps()

◆ lscp_get_midi_instruments()

◆ lscp_get_server_info()

◆ lscp_get_streams()

◆ lscp_get_total_voice_count()

◆ lscp_get_total_voice_count_max()

◆ lscp_get_voices()

◆ lscp_get_volume()

◆ lscp_list_available_engines()

◆ lscp_list_channels()

◆ lscp_list_fxsends()

◆ lscp_list_midi_instrument_maps()

◆ lscp_list_midi_instruments()

◆ lscp_load_engine()

◆ lscp_load_instrument()

◆ lscp_load_instrument_non_modal()

◆ lscp_map_midi_instrument()

◆ lscp_remove_channel()

◆ lscp_remove_midi_instrument_map()

◆ lscp_reset_channel()

◆ lscp_reset_sampler()

◆ lscp_set_channel_audio_channel()

◆ lscp_set_channel_audio_device()

◆ lscp_set_channel_audio_type()

◆ lscp_set_channel_midi_channel()

◆ lscp_set_channel_midi_device()

◆ lscp_set_channel_midi_map()

◆ lscp_set_channel_midi_port()

◆ lscp_set_channel_midi_type()

◆ lscp_set_channel_mute()

◆ lscp_set_channel_solo()

◆ lscp_set_channel_volume()

◆ lscp_set_fxsend_audio_channel()

◆ lscp_set_fxsend_level()

◆ lscp_set_fxsend_midi_controller()

◆ lscp_set_fxsend_name()

◆ lscp_set_midi_instrument_map_name()

◆ lscp_set_streams()

◆ lscp_set_voices()

◆ lscp_set_volume()