Main Page   Data Structures   File List   Data Fields   Globals  

types.h File Reference

#include <limits.h>

Go to the source code of this file.

Defines

#define JACK_MAX_FRAMES   ULONG_MAX;
#define JACK_DEFAULT_AUDIO_TYPE   "32 bit float mono audio"

Typedefs

typedef unsigned long jack_nframes_t
typedef _jack_port jack_port_t
typedef _jack_client jack_client_t
typedef unsigned long jack_port_id_t
typedef int(* JackProcessCallback )(jack_nframes_t nframes, void *arg)
typedef int(* JackGraphOrderCallback )(void *arg)
typedef int(* JackXRunCallback )(void *arg)
typedef int(* JackBufferSizeCallback )(jack_nframes_t nframes, void *arg)
typedef int(* JackSampleRateCallback )(jack_nframes_t nframes, void *arg)
typedef void(* JackPortRegistrationCallback )(jack_port_id_t port, int, void *arg)
typedef float jack_default_audio_sample_t

Enumerations

enum  JackPortFlags {
  JackPortIsInput = 0x1, JackPortIsOutput = 0x2, JackPortIsPhysical = 0x4, JackPortCanMonitor = 0x8,
  JackPortIsTerminal = 0x10
}


Define Documentation

#define JACK_DEFAULT_AUDIO_TYPE   "32 bit float mono audio"
 

Used for the type argument of jack_port_register().

#define JACK_MAX_FRAMES   ULONG_MAX;
 

Maximum value that can be stored in jack_nframes_t


Typedef Documentation

typedef struct _jack_client jack_client_t
 

jack_client_t is an opaque type. You may only access it using the API provided.

typedef float jack_default_audio_sample_t
 

For convenience, use this typedef if you want to be able to change between float and double. You may want to typedef sample_t to jack_default_audio_sample_t in your application.

typedef unsigned long jack_nframes_t
 

Type used to represent sample frame counts.

typedef unsigned long jack_port_id_t
 

Ports have unique ids. You will very rarely need to know them, however, except in the case of the port registration callback.

typedef struct _jack_port jack_port_t
 

jack_port_t is an opaque type. You may only access it using the API provided.

typedef int(* JackBufferSizeCallback)(jack_nframes_t nframes, void *arg)
 

Prototype for the client supplied function that is called when the engine buffersize changes.

Note! Use of this callback function is deprecated!

Parameters:
nframes  new engine buffer size
arg  pointer to a client supplied structure
Returns:
zero on success, non-zero on error

typedef int(* JackGraphOrderCallback)(void *arg)
 

Prototype for the client supplied function that is called whenever the processing graph is reordered.

Parameters:
arg  pointer to a client supplied structure
Returns:
zero on success, non-zero on error

typedef void(* JackPortRegistrationCallback)(jack_port_id_t port, int, void *arg)
 

Prototype for the client supplied function that is called whenever a port is registered or unregistered.

Parameters:
arg  pointer to a client supplied structure

typedef int(* JackProcessCallback)(jack_nframes_t nframes, void *arg)
 

Prototype for the client supplied function that is called by the engine anytime there is work to be done.

Precondition:
nframes == jack_get_buffer_size()
nframes == pow(2,x)
Parameters:
nframes  number of frames to process
arg  pointer to a client supplied structure
Returns:
zero on success, non-zero on error

typedef int(* JackSampleRateCallback)(jack_nframes_t nframes, void *arg)
 

Prototype for the client supplied function that is called when the engine sample rate changes.

Parameters:
nframes  new engine sample rate
arg  pointer to a client supplied structure
Returns:
zero on success, non-zero on error

typedef int(* JackXRunCallback)(void *arg)
 

Prototype for the client supplied function that is called whenever an xrun has occured.

Parameters:
arg  pointer to a client supplied structure
Returns:
zero on success, non-zero on error


Enumeration Type Documentation

enum JackPortFlags
 

A port has a set of flags that are formed by AND-ing together the desired values from the list below. The flags "JackPortIsInput" and "JackPortIsOutput" are mutually exclusive and it is an error to use them both.

Enumeration values:
JackPortIsInput  if JackPortIsInput is set, then the port can receive data.
JackPortIsOutput  if JackPortIsOutput is set, then data can be read from the port.
JackPortIsPhysical  if JackPortIsPhysical is set, then the port corresponds to some kind of physical I/O connector.
JackPortCanMonitor  if JackPortCanMonitor is set, then a call to jack_port_request_monitor() makes sense.

Precisely what this means is dependent on the client. A typical result of it being called with TRUE as the second argument is that data that would be available from an output port (with JackPortIsPhysical set) is sent to a physical output connector as well, so that it can be heard/seen/whatever.

Clients that do not control physical interfaces should never create ports with this bit set.

JackPortIsTerminal  JackPortIsTerminal means:

for an input port: the data received by the port will not be passed on or made available at any other port

for an output port: the data available at the port does not originate from any other port

Audio synthesizers, i/o h/w interface clients, HDR systems are examples of things that would set this flag for their ports.


Generated on Sun Feb 16 13:21:27 2003 for Jack by doxygen1.2.18