~ubuntu-branches/ubuntu/oneiric/oss4/oneiric-proposed

« back to all changes in this revision

Viewing changes to misc/man9ossddk/ossddk_dmap_get_qhead.9ossddk

  • Committer: Bazaar Package Importer
  • Author(s): Stefano Rivera
  • Date: 2011-06-16 20:37:48 UTC
  • mfrom: (5.1.3 sid)
  • Revision ID: james.westby@ubuntu.com-20110616203748-jbrxik6ql33z54co
Tags: 4.2-build2004-1ubuntu1
* Merge from Debian unstable.
  - Supports our current kernel (LP: #746048)
  Remaining changes:
  - debian/oss4-dkms.dkms.in: s/source/build/ in Kernel headers paths.
* ld-as-needed.patch: Re-order CC arguments to enable building with ld
  --as-needed (LP: #770972)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
'\" te
 
2
.\"  Copyright (c) 2005, 4Front Technologies 2005\&.
 
3
.TH ossddk_dmap_get_qhead 9ossddk "12 Sep 2005" "SunOS 5.10" "OSS DDK Services"
 
4
.SH "NAME"
 
5
ossddk_dmap_get_qhead, ossddk_dmap_get_qtail \- Return the DMA buffer head/tail fragment numbers.
 
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
\fBint\fR ossddk_dmap_get_qhead(\fBdmap_t *\fIdmap\fP);
 
15
\fBint\fR ossddk_dmap_get_qtail(\fBdmap_t *\fIdmap\fP);
 
16
.PP
 
17
.SH "INTERFACE LEVEL"
 
18
.PP
 
19
Open Sound System specific (OSS 4.0 DDK)\&.
 
20
.PP
 
21
.SH "ARGUMENTS"
 
22
.PP
 
23
.sp
 
24
.ne 2
 
25
.mk
 
26
\fB\fIdmap\fR
 
27
.in +16n
 
28
.rt
 
29
Audio buffer handle.
 
30
.in -16n
 
31
.PP
 
32
.SH "DESCRIPTION"
 
33
.PP
 
34
Some drivers need to know which fragment it should copy to/from the device. 
 
35
The \fIossddk_dmap_get_qhead\fR function can be used to get the current
 
36
fragment number during playback. The \fIossddk_dmap_get_qtail\fR function
 
37
returns the current fragment the device is expected to fill in next during
 
38
recording. The fragment number will be in range 0 to num_fragments-1.
 
39
.PP
 
40
Pointer to the current fragment can be computed using formula
 
41
\fptr =d mabuf_address + Ifragment_number*fragment_size\fR.
 
42
.PP
 
43
.SH "RETURN VALUES"
 
44
These functions return the current fragment number.
 
45
.PP
 
46
.SH "SEE ALSO"
 
47
.PP
 
48
\fIWriting Sound Device Drivers with OSS DDK\fR
 
49
.LP
 
50
\fIOpen Sound System Programmer's Guide\fR