audio_oss.h revision 260256302ac564fcfed9ebfa5a6c98a2e6ef3808
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright (C) 4Front Technologies 1996-2008.
*
* Copyright 2009 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _SYS_AUDIO_OSS_H
#define _SYS_AUDIO_OSS_H
/*
* devices.
*
* Note that the contents of this file include definitions which exist
* primarily for compatibility. Many of the defines here are not
* actually implemented, but exist solely to facilitate compilation of
* programs from other operating systems. Other definitions here may
* not be fully supported or may otherwise be obsolete. There are many
* things in this file which should not be used on SunOS.
*
* Please read the documentation to determine which portions of the
* API are fully supported and recommended for use in new
* applications.
*/
#ifdef __cplusplus
extern "C" {
#endif
/*
* Buffer status queries.
* SNDCTL_DSP_GETOSPACE and SNDCTL_DSP_GETISPACE
*/
typedef struct audio_buf_info {
int fragments; /* # of available fragments */
int fragstotal; /* Total # of fragments allocated */
int fragsize; /* Size of a fragment in bytes */
int bytes; /* Available space in bytes */
/* Note! 'bytes' could be more than fragments*fragsize */
/*
* Sync groups for audio devices.
* SNDCTL_DSP_SYNCGROUP and SNDCTL_DSP_SYNCSTART
*/
typedef struct oss_syncgroup {
int id;
int mode;
int filler[16];
/*
* SNDCTL_DSP_GETERROR
*/
typedef struct audio_errinfo {
int play_underruns;
int rec_overruns;
unsigned int play_ptradjust;
unsigned int rec_ptradjust;
int play_errorcount;
int rec_errorcount;
int play_lasterror;
int rec_lasterror;
int play_errorparm;
int rec_errorparm;
int filler[16];
/*
* SNDCTL_DSP_GETIPTR and SNDCTL_DSP_GETOPTR
*/
typedef struct count_info {
unsigned int bytes; /* Total # of bytes processed */
int blocks; /* # of fragment transitions since last time */
int ptr; /* Current DMA pointer value */
} count_info;
/*
* SNDCTL_DSP_CURENT_IPTR and SNDCTL_DSP_CURRENT_OPTR
*/
typedef struct {
long long samples; /* Total # of samples */
int fifo_samples; /* Samples in device FIFO */
} oss_count_t;
/*
* SNDCTL_DSP_GET_RECSRC_NAMES and SNDCTL_DSP_GET_PLAYTGT_NAMES
*/
#define OSS_ENUM_MAXVALUE 255
typedef struct oss_mixer_enuminfo {
int dev;
int ctrl;
int nvalues;
int version;
short strindex[OSS_ENUM_MAXVALUE];
char strings[3000];
/*
* SNDCTL_DSP_READCTL and SNDCTL_DSP_WRITECTL
*/
typedef struct oss_digital_control {
unsigned int caps;
#define DIG_CBITIN_NONE 0x00000000
#define DIG_CBITIN_LIMITED 0x00000001
#define DIG_CBITIN_DATA 0x00000002
#define DIG_CBITIN_BYTE0 0x00000004
#define DIG_CBITIN_FULL 0x00000008
#define DIG_CBITIN_MASK 0x0000000f
#define DIG_CBITOUT_NONE 0x00000000
#define DIG_CBITOUT_LIMITED 0x00000010
#define DIG_CBITOUT_BYTE0 0x00000020
#define DIG_CBITOUT_FULL 0x00000040
#define DIG_CBITOUT_DATA 0x00000080
#define DIG_CBITOUT_MASK 0x000000f0
#define DIG_UBITIN 0x00000100
#define DIG_UBITOUT 0x00000200
#define DIG_VBITOUT 0x00000400
#define DIG_OUTRATE 0x00000800
#define DIG_INRATE 0x00001000
#define DIG_INBITS 0x00002000
#define DIG_OUTBITS 0x00004000
#define DIG_EXACT 0x00010000
#define DIG_PRO 0x00020000
#define DIG_CONSUMER 0x00040000
#define DIG_PASSTHROUGH 0x00080000
#define DIG_OUTSEL 0x00100000
unsigned int valid;
#define VAL_CBITIN 0x00000001
#define VAL_UBITIN 0x00000002
#define VAL_CBITOUT 0x00000004
#define VAL_UBITOUT 0x00000008
#define VAL_ISTATUS 0x00000010
#define VAL_IRATE 0x00000020
#define VAL_ORATE 0x00000040
#define VAL_INBITS 0x00000080
#define VAL_OUTBITS 0x00000100
#define VAL_REQUEST 0x00000200
#define VAL_OUTSEL 0x00000400
unsigned int request;
unsigned int param;
#define SPD_RQ_PASSTHROUGH 1
unsigned char cbitin[24];
unsigned char ubitin[24];
unsigned char cbitout[24];
unsigned char ubitout[24];
unsigned int outsel;
#define OUTSEL_DIGITAL 1
#define OUTSEL_ANALOG 2
#define IND_UNKNOWN 0
#define IND_AUDIO 1
#define IND_DATA 2
int in_locked; /* Receiver locked */
#define LOCK_NOT_INDICATED 0
#define LOCK_UNLOCKED 1
#define LOCK_LOCKED 2
int in_quality; /* Input signal quality */
#define IN_QUAL_NOT_INDICATED 0
#define IN_QUAL_POOR 1
#define IN_QUAL_GOOD 2
int in_vbit;
int out_vbit; /* V bits */
#define VBIT_NOT_INDICATED 0
#define VBIT_OFF 1
#define VBIT_ON 2
unsigned int in_errors; /* Various input error conditions */
#define INERR_CRC 0x0001
#define INERR_QCODE_CRC 0x0002
#define INERR_PARITY 0x0004
#define INERR_BIPHASE 0x0008
int srate_in;
int srate_out;
int bits_in;
int bits_out;
int filler[32];
/*
* The "new" mixer API.
*
* This improved mixer API makes it possible to access every possible feature
* of every possible device. However you should read the mixer programming
* section of the OSS API Developer's Manual. There is no chance that you
* could use this interface correctly just by examining this header.
*/
#define OSS_VERSION 0x040003
#define SOUND_VERSION OSS_VERSION
typedef struct oss_sysinfo {
int versionnum; /* See OSS_GETVERSION */
int numsynths; /* NOT SUPPORTED, always 0 */
int nummidis; /* NOT SUPPORTED, always 0 */
int numtimers; /* NOT SUPPORTED, always 0 */
int nummixers; /* # of mixer devices */
int numcards; /* Number of sound cards in the system */
int numaudioengines; /* Number of audio engines in the system */
} oss_sysinfo;
typedef struct oss_mixext {
int dev; /* Mixer device number */
int ctrl; /* Extension number */
int type; /* Entry type */
#define MIXT_DEVROOT 0 /* Device root entry */
#define MIXT_3D 18
/* Possible value range (minvalue to maxvalue) */
/* Note that maxvalue may also be smaller than minvalue */
int maxvalue;
int minvalue;
int flags;
int parent; /* Entry# of parent (-1 if root) */
int dummy; /* NOT SUPPORTED */
int timestamp;
int control_no; /* NOT SUPPORTED, always -1 */
unsigned int desc; /* Scope flags, etc */
#define MIXEXT_SCOPE_MASK 0x0000003f
#define MIXEXT_SCOPE_OTHER 0x00000000
#define MIXEXT_SCOPE_INPUT 0x00000001
#define MIXEXT_SCOPE_OUTPUT 0x00000002
#define MIXEXT_SCOPE_MONITOR 0x00000003
#define MIXEXT_SCOPE_RECSWITCH 0x00000004
char extname[32];
int update_counter;
#ifdef _KERNEL
int filler[6];
int enumbit;
#else
int filler[7];
#endif
} oss_mixext;
typedef struct oss_mixext_root {
char id[16];
char name[48];
typedef struct oss_mixer_value {
int dev;
int ctrl;
int value;
int flags; /* Reserved for future use. Initialize to 0 */
int timestamp; /* Must be set to oss_mixext.timestamp */
#define OSS_LONGNAME_SIZE 64
#define OSS_LABEL_SIZE 16
#define OSS_DEVNODE_SIZE 32
typedef char oss_longname_t[OSS_LONGNAME_SIZE];
typedef char oss_label_t[OSS_LABEL_SIZE];
typedef char oss_devnode_t[OSS_DEVNODE_SIZE];
typedef struct oss_audioinfo {
int dev; /* Audio device number */
char name[64];
int busy; /* 0, OPEN_READ, OPEN_WRITE, OPEN_READWRITE */
int pid; /* Process ID, not used in SunOS */
int caps; /* PCM_CAP_INPUT, PCM_CAP_OUTPUT */
int iformats; /* Supported input formats */
int oformats; /* Supported output formats */
int magic; /* Internal use only */
int card_number;
int port_number;
int mixer_dev;
int legacy_device; /* Obsolete field. Replaced by devnode */
int enabled; /* 1=enabled, 0=device not ready */
int flags; /* internal use only - no practical meaning */
int min_rate; /* Minimum sample rate */
int max_rate; /* Maximum sample rate */
int min_channels; /* Minimum number of channels */
int max_channels; /* Maximum number of channels */
int binding; /* DSP_BIND_FRONT, etc. 0 means undefined */
int rate_source;
char handle[32];
unsigned int nrates; /* Array of supported sample rates */
unsigned int rates[OSS_MAX_SAMPLE_RATES];
int latency; /* In usecs, -1=unknown */
int next_play_engine;
int next_rec_engine;
int filler[184];
typedef struct oss_mixerinfo {
int dev;
char id[16];
char name[32];
int modify_counter;
int card_number;
int port_number;
char handle[32];
int magic; /* Reserved */
int enabled; /* Reserved */
int caps;
#define MIXER_CAP_VIRTUAL 0x00000001
int flags; /* Reserved */
int nrext;
/*
* The priority field can be used to select the default
* (motherboard) mixer device. The mixer with the highest
* priority is the most preferred one. -2 or less means that
* this device cannot be used as the default mixer.
*/
int priority;
int legacy_device;
typedef struct oss_card_info {
int card;
char shortname[16];
char longname[128];
int flags;
char hw_info[400];
int intr_count;
int ack_count;
int filler[154];
typedef struct mixer_info { /* OBSOLETE */
char id[16];
char name[32];
int modify_counter;
int card_number;
int port_number;
char handle[32];
} mixer_info;
#define MAX_PEAK_CHANNELS 128
typedef unsigned short oss_peaks_t[MAX_PEAK_CHANNELS];
/* For use with SNDCTL_DSP_GET_CHNORDER */
#define CHID_UNDEF 0
#define CHID_L 1
#define CHID_R 2
#define CHID_C 3
#define CHID_LFE 4
#define CHID_LS 5
#define CHID_RS 6
#define CHID_LR 7
#define CHID_RR 8
#define CHNORDER_UNDEF 0x0000000000000000ULL
#define CHNORDER_NORMAL 0x0000000087654321ULL
/* ioctl codes 'X', 200-255 are reserved for internal use */
/*
* Few more "globally" available ioctl calls.
*/
/*
*/
#define APF_NORMAL 0 /* Normal applications */
/*
* These definitions are here for the benefit of compiling application
* code. Most of these are NOT implemented in the Solaris code,
* however. This is the older 3.x OSS API, and only the master input and
* output levels are actually supported.
*/
#define SOUND_MIXER_NRDEVICES 28
#define SOUND_MIXER_VOLUME 0
#define SOUND_MIXER_BASS 1
#define SOUND_MIXER_TREBLE 2
#define SOUND_MIXER_SYNTH 3
#define SOUND_MIXER_PCM 4
#define SOUND_MIXER_SPEAKER 5
#define SOUND_MIXER_LINE 6
#define SOUND_MIXER_MIC 7
#define SOUND_MIXER_CD 8
#define SOUND_MIXER_ALTPCM 10
#define SOUND_ONOFF_MIN 28
#define SOUND_ONOFF_MAX 30
#define SOUND_MIXER_NONE 31
#define SOUND_MIXER_OUTSRC 0xfa
#define SOUND_MIXER_OUTMASK 0xf9
#define SOUND_MIXER_ENHANCE SOUND_MIXER_NONE
#define SOUND_MIXER_MUTE SOUND_MIXER_NONE
#define SOUND_MIXER_LOUD SOUND_MIXER_NONE
#define SOUND_MASK_SURRVOL SOUND_MASK_SIDEVOL
/*
* Again, DO NOT USE the following two macros. They are here for SOURCE
* COMPATIBILITY ONLY.
*/
#define SOUND_DEVICE_LABELS { \
"Vol ", "Bass ", "Treble", "Synth", "Pcm ", "Speaker ", "Line ", \
"Mic ", "CD ", "Mix ", "Pcm2 ", "Rec ", "IGain", "OGain", \
"Aux1", "Aux2", "Aux3", "Digital1", "Digital2", "Digital3", \
"Phone", "Mono", "Video", "Radio", "Depth", \
"Rear", "Center", "Side" }
#define SOUND_DEVICE_NAMES { \
"vol", "bass", "treble", "synth", "pcm", "speaker", "line", \
"mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", \
"aux1", "aux2", "aux3", "dig1", "dig2", "dig3", \
"phone", "mono", "video", "radio", "depth", \
"rear", "center", "side" }
/*
* These macros are useful for some applications. They are implemented
* as soft values for the application, and do not affect real hardware.
*/
/*
* These macros are here for source compatibility. They intentionally don't
* map to any real hardware. NOT SUPPORTED!
*/
/*
* Audio encoding types (Note! U8=8 and S16_LE=16 for compatibility)
*/
#define AFMT_MU_LAW 0x00000001
#define AFMT_A_LAW 0x00000002
#define AFMT_IMA_ADPCM 0x00000004
#define AFMT_U8 0x00000008
#define AFMT_S16_LE 0x00000010
#define AFMT_S16_BE 0x00000020
#define AFMT_S8 0x00000040
#define AFMT_U16_LE 0x00000080
#define AFMT_U16_BE 0x00000100
#define AFMT_S32_LE 0x00001000
#define AFMT_S32_BE 0x00002000
/*
* opposite endian formats).
*/
#if defined(_BIG_ENDIAN)
#define AFMT_S16_NE AFMT_S16_BE
#define AFMT_U16_NE AFMT_U16_BE
#define AFMT_S32_NE AFMT_S32_BE
#define AFMT_S24_NE AFMT_S24_BE
#define AFMT_S16_OE AFMT_S16_LE
#define AFMT_S32_OE AFMT_S32_LE
#define AFMT_S24_OE AFMT_S24_LE
#else
#define AFMT_S16_NE AFMT_S16_LE
#define AFMT_U16_NE AFMT_U16_LE
#define AFMT_S32_NE AFMT_S32_LE
#define AFMT_S24_NE AFMT_S24_LE
#define AFMT_S16_OE AFMT_S16_BE
#define AFMT_S32_OE AFMT_S32_BE
#define AFMT_S24_OE AFMT_S24_BE
#endif
/*
* SNDCTL_DSP_GETCAPS bits
*/
#define PCM_CAP_FREERATE 0x10000000
/*
* Preferred channel usage. These bits can be used to give
* recommendations to the application. Used by few drivers. For
* example if ((caps & DSP_CH_MASK) == DSP_CH_MONO) means that the
* device works best in mono mode. However it doesn't necessarily mean
* that the device cannot be used in stereo. These bits should only be
* used by special applications such as multi track hard disk
* recorders to find out the initial setup. However the user should be
* able to override this selection.
*
* To find out which modes are actually supported the application
* should try to select them using SNDCTL_DSP_CHANNELS.
*/
#define DSP_CH_MONO 0x02000000
#define DSP_CH_STEREO 0x04000000
/*
* The PCM_CAP_* capability names used to be known as DSP_CAP_*, so
* it's necessary to define the older names too.
*/
#define DSP_CAP_ADMASK PCM_CAP_ADMASK
#define DSP_CAP_ANALOGIN PCM_CAP_ANALOGIN
#define DSP_CAP_ANALOGOUT PCM_CAP_ANALOGOUT
#define DSP_CAP_BATCH PCM_CAP_BATCH
#define DSP_CAP_BIND PCM_CAP_BIND
#define DSP_CAP_COPROC PCM_CAP_COPROC
#define DSP_CAP_DEFAULT PCM_CAP_DEFAULT
#define DSP_CAP_DIGITALIN PCM_CAP_DIGITALIN
#define DSP_CAP_DIGITALOUT PCM_CAP_DIGITALOUT
#define DSP_CAP_DUPLEX PCM_CAP_DUPLEX
#define DSP_CAP_FREERATE PCM_CAP_FREERATE
#define DSP_CAP_HIDDEN PCM_CAP_HIDDEN
#define DSP_CAP_INPUT PCM_CAP_INPUT
#define DSP_CAP_MMAP PCM_CAP_MMAP
#define DSP_CAP_MODEM PCM_CAP_MODEM
#define DSP_CAP_MULTI PCM_CAP_MULTI
#define DSP_CAP_OUTPUT PCM_CAP_OUTPUT
#define DSP_CAP_REALTIME PCM_CAP_REALTIME
#define DSP_CAP_REVISION PCM_CAP_REVISION
#define DSP_CAP_SHADOW PCM_CAP_SHADOW
#define DSP_CAP_TRIGGER PCM_CAP_TRIGGER
#define DSP_CAP_VIRTUAL PCM_CAP_VIRTUAL
/*
* SNDCTL_DSP_GETTRIGGER and SNDCTL_DSP_SETTRIGGER
*/
#define PCM_ENABLE_INPUT 0x00000001
#define PCM_ENABLE_OUTPUT 0x00000002
/*
* SNDCTL_DSP_BIND_CHANNEL
*/
#define DSP_BIND_QUERY 0x00000000
#define DSP_BIND_FRONT 0x00000001
#define DSP_BIND_SURR 0x00000002
#define DSP_BIND_CENTER_LFE 0x00000004
#define DSP_BIND_HANDSET 0x00000008
#define DSP_BIND_MIC 0x00000010
#define DSP_BIND_MODEM1 0x00000020
#define DSP_BIND_MODEM2 0x00000040
#define DSP_BIND_I2S 0x00000080
#define DSP_BIND_SPDIF 0x00000100
#define DSP_BIND_REAR 0x00000200
/*
* SOUND_MIXER_READ_CAPS
*/
#define SOUND_CAP_EXCL_INPUT 0x00000001
#define SOUND_CAP_NOLEGACY 0x00000004
#define SOUND_CAP_NORECSRC 0x00000008
/*
* The following ioctl is for internal use only -- it is used to
* as well.)
*/
#ifdef __cplusplus
}
#endif
#endif /* _SYS_AUDIO_OSS_H */