#include <csl/csldefs.h>
#include <csl/cslutils.h>
Go to the source code of this file.
Compounds | |
struct | _CslMutex |
User-defined mutex object. More... | |
struct | _CslOptions |
Command line options. More... | |
Defines | |
#define | CSL_DRIVER_NAME_ARTS "arts" |
Symbolic name for aRts driver. More... | |
#define | CSL_DRIVER_NAME_OSS "oss" |
Symbolic name for OSS driver. More... | |
Typedefs | |
typedef _CslDriver | CslDriver |
CSL Driver handle. More... | |
typedef _CslMutex | CslMutex |
CSL Mutex. More... | |
typedef void(* | CslMutexLock )(CslMutex *mutex) |
Mutex lock callback. More... | |
typedef void(* | CslMutexUnlock )(CslMutex *mutex) |
Mutex unlock callback. More... | |
typedef void(* | CslMutexDestroy )(CslMutex *mutex) |
Mutex destroy callback. More... | |
typedef _CslOptions | CslOptions |
Command line options. More... | |
Enumerations | |
enum | CslErrorType { CSL_ENONE, CSL_EINTERN, CSL_ENODRIVER, CSL_ENOIMPL, CSL_EBUSY, CSL_EPERMS, CSL_EIO, CSL_EFMTINVAL, CSL_EGETCAPS, CSL_ECAPSUPPORT, CSL_ESETCAPS } |
CSL return codes. More... | |
enum | CslDriverCaps { CSL_DRIVER_CAP_PCM = (1 << 0), CSL_DRIVER_CAP_SAMPLE = (1 << 1), CSL_DRIVER_CAP_MIXER = (1 << 2), CSL_DRIVER_CAP_MASK = 0x07 } |
Driver capabilities. More... | |
Functions | |
const char ** | csl_list_drivers (unsigned int *n_backends) |
Return list of drivers. More... | |
CslErrorType | csl_driver_init (const char *driver_name, CslDriver **driver) |
Initialize the CSL library. More... | |
CslErrorType | csl_driver_init_mutex (const char *driver_name, CslDriverCaps required_caps, CslMutex *mutex, CslDriver **driver) |
Initialize the CSL library. More... | |
void | csl_driver_shutdown (CslDriver *driver) |
Shutdown driver. More... | |
const char * | csl_strerror (CslErrorType error_type) |
Return error description. More... | |
void | csl_options_parse (CslOptions *options, int *argc_p, char **argv_p[]) |
Parse command line options. More... | |
char * | csl_options_dump (CslOptions *options) |
Dump CSL options. More... | |
char * | csl_options_describe (unsigned int indent) |
Describe command line options. More... | |
char * | csl_describe_pcm_format (unsigned int pcm_format) |
Describe a PCM format. More... |
|
Symbolic name for aRts driver. Can use this value when calling csl_driver_init or csl_driver_init_mutex.
|
|
Symbolic name for OSS driver. Can use this value when calling csl_driver_init or csl_driver_init_mutex.
|
|
CSL Driver handle. Opaque type used as a handle to a CSL driver. |
|
CSL Mutex. Data type used for CSL mutual exclusion/locking functions.
|
|
Mutex destroy callback. Function prototype for callback function to mutex destroy function. |
|
Mutex lock callback. Function prototype for callback function to mutex lock function. |
|
Mutex unlock callback. Function prototype for callback function to mutex unlock function. |
|
Command line options. Data type for storing CSL command line options. |
|
Driver capabilities. CSL driver capabilities. These are used when selecting a driver to be used when calling csl_driver_init_mutex.
|
|
CSL return codes. CSL error values, returned by most CSL function calls.
|
|
Describe a PCM format. Given a PCM format value, return a string describing the selected format (e.g. "16bit, little-endian, signed")
|
|
Initialize the CSL library. Call this function to initialize the CSL library. You need to call this to obtain a handle to a driver before performing any driver functions. For multithreaded applications you should use csl_driver_init_mutex instead.
|
|
Initialize the CSL library. Call this function to initialize the CSL library. You need to call this to obtain a handle to a driver before performing any driver functions. For non-multithreaded applications you can use csl_driver_init instead.
|
|
Shutdown driver. Shutdown a driver and release any resources associated with it. There is no way of determining if the call was successful. Be sure to close any PCM streams associated with the driver first.
|
|
Return list of drivers. Return a list of the available CSL back-end drivers.
|
|
Describe command line options. Outputs a usage string describing the command line options supported by csl_parse_options. Typical output is: -B, -L big/little endian -s, -u signed/unsigned samples -F float samples (32bit) -w [8|16] number of bits (width is 16 or 8) -c <n_channels> number of channels -r <rate> sampling frequency -D <level> debugging level
|
|
Dump CSL options. This function returns a debug string describing the CSL options.
|
|
Parse command line options. Parses the programs command line options and fills in a CslOptions variable.
|
|
Return error description. Return a string describing a CSL error code.
|