Open Sound Control Server

Collaboration diagram for Open Sound Control Server:

Data Structures
struct	OSC_packet_s
	DEfines en OSC packet instance. TODO: this is not a RAM-efficient implementation... EIther leave packet data as raw or slice it in URI/Payload but not both. More...
struct	OSC_server_s
	Defines an OSC server instance. Open Sound Control (OSC) is a protocol for networking sound synthesizers, computers, and other multimedia devices for purposes such as musical performance or show control. More...

Macros
#define	OSC_PACKET_URI_PATH_DELIMITOR   '/'
#define	OSC_PACKET_MESSAGE_DELIMITOR   ','
#define	OSC_PACKET_DATA_TYPE_INTEGER   'i'
#define	OSC_PACKET_DATA_TYPE_FLOAT   'f'
#define	OSC_PACKET_DATA_TYPE_STTRING   's'
#define	OSC_PACKET_NULL_CHAR   '\0'
#define	OSC_PACKET_URI_FORMAT   "/%d/%d/%d"
#define	OSC_PACKET_PAYLOAD_LEN   8
#define	OSC_PACKET_URI_BASEPATH_LEN   4

Enumerations
enum	osc_media_type_e {   OSC_MEDIATYPE_LIGHTING ,   OSC_MEDIATYPE_PYROTECHNICS ,   OSC_MEDIATYPE_MEDIASERVER }
	List of OSC-controllable media types (As implemented by ASLS) More...
enum	osc_control_type_e {   OSC_CTRLTYPE_CUE ,   OSC_CTRLTYPE_VAL }
	List of OSC control types (As implemented by ASLS) More...

Functions
void	osc_server_init (void)
	Initialises the OSC server instance. More...
void	osc_packet_send (osc_media_type_e media_type, osc_control_type_e ctrl_type, uint16_t ctrl_id, uint32_t ctrl_val)
	Prepares and send an OSC packet over UDP. More...

Detailed Description

Handles inter-system communication through Open SOund Control protocol.

Macro Definition Documentation

OSC_PACKET_DATA_TYPE_FLOAT

#define OSC_PACKET_DATA_TYPE_FLOAT   'f'

Definition at line 18 of file osc_server.h.

OSC_PACKET_DATA_TYPE_INTEGER

#define OSC_PACKET_DATA_TYPE_INTEGER   'i'

Definition at line 17 of file osc_server.h.

OSC_PACKET_DATA_TYPE_STTRING

#define OSC_PACKET_DATA_TYPE_STTRING   's'

Definition at line 19 of file osc_server.h.

OSC_PACKET_MESSAGE_DELIMITOR

#define OSC_PACKET_MESSAGE_DELIMITOR   ','

Definition at line 16 of file osc_server.h.

OSC_PACKET_NULL_CHAR

#define OSC_PACKET_NULL_CHAR   '\0'

Definition at line 20 of file osc_server.h.

OSC_PACKET_PAYLOAD_LEN

#define OSC_PACKET_PAYLOAD_LEN   8

Definition at line 23 of file osc_server.h.

OSC_PACKET_URI_BASEPATH_LEN

#define OSC_PACKET_URI_BASEPATH_LEN   4

Definition at line 24 of file osc_server.h.

OSC_PACKET_URI_FORMAT

#define OSC_PACKET_URI_FORMAT   "/%d/%d/%d"

Definition at line 21 of file osc_server.h.

OSC_PACKET_URI_PATH_DELIMITOR

#define OSC_PACKET_URI_PATH_DELIMITOR   '/'

Definition at line 15 of file osc_server.h.

Enumeration Type Documentation

osc_control_type_e

enum osc_control_type_e

List of OSC control types (As implemented by ASLS)

Enumerator
OSC_CTRLTYPE_CUE	The parameter to be controlled is a cue (value may either be 0 or 255)
OSC_CTRLTYPE_VAL	The parameter to be controlled is a value (value may be defined between 0-255 range)

Definition at line 42 of file osc_server.h.

osc_media_type_e

enum osc_media_type_e

List of OSC-controllable media types (As implemented by ASLS)

Enumerator
OSC_MEDIATYPE_LIGHTING	Targets OSC-Compatible lighting systems on the network
OSC_MEDIATYPE_PYROTECHNICS	Targets OSC-Compatible pyrotechnic systems on the network
OSC_MEDIATYPE_MEDIASERVER	Targets OSC-Compatible media servrs on the network

Definition at line 31 of file osc_server.h.

Function Documentation

osc_packet_send()

void osc_packet_send	(	osc_media_type_e	media_type,
		osc_control_type_e	ctrl_type,
		uint16_t	ctrl_id,
		uint32_t	ctrl_val
	)

Prepares and send an OSC packet over UDP.

Parameters

media_type

Type of media to be controlled over OSC

See also

osc_server.h for further informations.

Parameters

ctrl_type

Type of control to be modified over OSC

See also

osc_server.h for further informations.

Parameters

ctrl_id

Identifier of the control to be modified OSC

See also

osc_server.h for further informations.

Parameters

ctrl_val

Value of the control to be modified.

WARNING: the use of sprintf tends to cause memory leaks... FIXED by implementing thread-safe printf-stdarg library.

Definition at line 115 of file osc_server.c.

osc_server_init()

void osc_server_init

(

void

)

Initialises the OSC server instance.

Parameters

input_port	Input port of the OSC Server
output_port	Output port of the OSC Server

Definition at line 101 of file osc_server.c.