~ubuntu-branches/ubuntu/vivid/oss4/vivid

« back to all changes in this revision

Viewing changes to misc/man9ossddk/ossddk_adev_set_buflimits.9ossddk

  • Committer: Bazaar Package Importer
  • Author(s): Romain Beauxis, Samuel Thibault, Romain Beauxis, Sebastien NOEL
  • Date: 2011-06-14 10:06:56 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20110614100656-cx4oc7u426zn812z
Tags: 4.2-build2004-1
[ Samuel Thibault ]
* debian/control: Add liboss4-salsa2, liboss4-salsa-dev and
  liboss4-salsa-asound2 packages, equivalent to (and will replace) those from
  the oss-libsalsa package (Closes: #589127).
* debian/patches/liboss4-salsa.patch: New patch to rename libsalsa into
  liboss4-salsa to avoid conflicts in the archive for no good reason.
* debian/rules: Make in libOSSlib and libsalsa.
* debian/liboss4-salsa-dev.install, debian/liboss4-salsa2.install,
  debian/liboss4-salsa-asound2.links, debian/liboss4-salsa-dev.links:
  Install liboss4-salsa libraries like was done in the oss-libsalsa package.
* include-alsa: Add a copy of ALSA 1.0.5 headers: Cf ALSA_1.0.* symbols in
  libsalsa, this is the roughly supported version.
* debian/copyright: Update for new include-alsa files.
* alsa.pc: New file for compatibility with libasound-dev.
* debian/control:
  - Add Vcs-Browser and Vcs-Svn fields.
  - Use linux-any instead of the list of Linux archs (Closes: #604679).
  - Make dkms dependency linux-any only.
* debian/patches/hurd_iot.patch: New patch to fix soundcard.h usage in
  libsalsa on hurd-i386.
* debian/patches/libsalsa_fixes.patch: New patch to fix some printf usages
  and ioctl declaration in libsalsa.
* debian/patches/no_EBADE.patch: New patch to cope with hurd-i386 not having
  EBADE.
* debian/patches/CFLAGS.patch: New patch to make oss4 take debian/rules
  CFLAGS into account.
* debian/patches/snd_asoundlib_version.patch: New patch to add
  snd_asoundlib_version().
* debian/patches/generic_srccconf.patch: New patch to fix source
  configuration on unknown archs.

[ Romain Beauxis ]
* Fixed README.Debian to only mention dkms' modules.
* Switch to dpkg-source 3.0 (quilt) format
* Added DM-Upload-Allowed: yes

[ Sebastien NOEL ]
* New upstream release (Closes: #595298, #619272).
* Fix typo in initscript (Closes: #627149).
* debian/control: adjust linux-headers dependencies (Closes: #628879).

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
'\" te
 
2
.\"  Copyright (c) 2005, 4Front Technologies 2005\&.
 
3
.TH ossddk_adev_set_buflimits 9ossddk "12 Sep 2005" "SunOS 5.10" "OSS DDK Services"
 
4
.SH "NAME"
 
5
ossddk_adev_set_buflimits \- Set fragment size constraints
 
6
.PP
 
7
.SH "SYNOPSIS"
 
8
.nf
 
9
#include <sys/soundcard.h>
 
10
.LP
 
11
#include <sys/ossddk/ossddk.h>
 
12
.fi
 
13
.LP
 
14
\fBvoid\fR ossddk_adev_set_buflimits(\fBint \fIdev\fP, \fBint \fImin_fragment\fP, \fBint \fImax_fragment\fP);
 
15
.PP
 
16
.SH "INTERFACE LEVEL"
 
17
.PP
 
18
Open Sound System specific (OSS 4.0 DDK)\&.
 
19
.PP
 
20
.SH "ARGUMENTS"
 
21
.PP
 
22
.sp
 
23
.ne 2
 
24
.mk
 
25
\fB\fIdev\fR
 
26
.in +16n
 
27
.rt
 
28
OSS audio device number.
 
29
.in -16n
 
30
.sp
 
31
.ne 2
 
32
.mk
 
33
\fB\fImin_fragment\fR
 
34
.in +16n
 
35
.rt
 
36
Minimum fragment size (in bytes) supported by the device. Value of 0 means no limit.
 
37
.in -16n
 
38
.sp
 
39
.ne 2
 
40
.mk
 
41
\fB\fImax_fragment\fR
 
42
.in +16n
 
43
.rt
 
44
Maximum fragment size (in bytes) supported by the device. Value of 0 means no limit.
 
45
.in -16n
 
46
.PP
 
47
.SH "DESCRIPTION"
 
48
.PP
 
49
Fragment size of an audio stream is the number of bytes (not samples) to be played
 
50
or recorded between interrupts genererated by the device. In other words the device
 
51
will generate an interrupt exactly at the fragment boundaries. The audio core of OSS
 
52
will select the fragment size. However if the device has any size restrictions it can
 
53
inform the audio core about them. In most cases there are no restrictions and the driver
 
54
should not call this function at all.
 
55
The minimum fragment size must be smaller or equal to the maximum.
 
56
.PP
 
57
For example many devices can not support fragment sizes larger than one 4k page. In
 
58
this case the driver can call \fIossddk_adev_set_buflimits(device_num, 0, 4096)\fR.
 
59
.PP
 
60
This function can be called immediately after installing the audio device using
 
61
\fIossddk_install_audiodev(9ossddk)\fR. Alternatively it can be called in driver's open,
 
62
set_speed, set_channels and/or set_format entry points. If the latter method is used 
 
63
then the open entry point must restore the default value.
 
64
.PP
 
65
Changing the fragment size limits when (or after) the prepare_for_output/prepare_for_input
 
66
entry point is called doesn't have any effect. If the fragment size depends on the
 
67
sampling rate or the other parameters then the set_speed, set_channels and set_format
 
68
driver entgry points must update the fragment size limits depending on the situation.
 
69
.PP
 
70
The limits should preferably be powers of 2 but this is not an absolute requirement.
 
71
Both limits can be the same if the device supports fixed fragment size.
 
72
.PP
 
73
.SH "SEE ALSO"
 
74
.PP
 
75
\fIWriting Sound Device Drivers with OSS DDK\fR
 
76
\fIOpen Sound System Programmer's Guide\fR