Google
 

Open Sound System
The Hitchhiker's Guide to OSS 4.1 Internals

Do you have problems with sound/audio application development? Don't panic! Click here for help!

adrv_set_format

Audio driver method for setting/getting the sample format

Usage

unsigned int (*adrv_set_format) (int dev, unsigned int fmt);

Description

The first paramater (dev) is anways the audio engine number which is an index to the audio_engines table. The driver can use the audio_engines entry to find out some of the current parameters. In particular the devc, portc, portc_play and portc_record fields can be used to locate the driver defined structures for the audio engine.

The purpose of this audio driver method is very simple. It sets the sample format to be used when the adrv_prepare_for_input and adrv_prepare_for_output methods get called to start the device. The change in the format must in no case take effect immediately. Instead the driver should store the new format in the portc structure for the engine until the adrv_prepare_for_* method gets called.

The available sample formats are documented in the Supported audio formats section of the OSS Programmer's guide.

The fmt parameter gives the new sample format. Value of 0 is a special case used when the audio core wants to know the current format (it should get returned without any change to the device state or the driver variables).

The driver should verify that the requested format is supported by the device. If the rate is not supported then the default format (such as AFMT_S16_LE should be returned.

The function return value should be the sample format the device will be used when the device is started.

In some cases the driver may need to check that the sampling rate, sample format and number of channels are compatible with each other. This may be tricky to implement since all these parameters are set separately. However it's safe to assume that number of channels will be set first and sampling rate last. Applications that don't follow this recommendation will not work properly.

Return value

Audio driver entry point should return 0 if the call was successful. Negative return value (-errno) means that an error has occurred. However some of the functions have void type and they don't return any value.

Referenced by

vmix_core/vmix_input.cVirtual mixing audio driver recording routines
vmix_core/vmix_output.cVirtual mixing audio driver output mixing routines
audio/oss_audio_core.cAudio core functionality of OSS
include/ossddk.hSource file oss-current/kernel/framework/include/ossddk/ossddk.h
remux/oss_remux.cMulti channel playback support for devices with multiple stereo engines.


Copyright (C) 4Front Technologies, 2007. All rights reserved.
Back to index OSS web site