summaryrefslogtreecommitdiff
path: root/misc/man9ossddk/ossddk_dmap_get_buffused.9ossddk
diff options
context:
space:
mode:
authorIgor Pashev <pashev.igor@gmail.com>2013-05-03 21:08:42 +0400
committerIgor Pashev <pashev.igor@gmail.com>2013-05-03 21:08:42 +0400
commit1058def8e7827e56ce4a70afb4aeacb5dc44148f (patch)
tree4495d23e7b54ab5700e3839081e797c1eafe0db9 /misc/man9ossddk/ossddk_dmap_get_buffused.9ossddk
downloadoss4-upstream.tar.gz
Imported Upstream version 4.2-build2006upstream/4.2-build2006upstream
Diffstat (limited to 'misc/man9ossddk/ossddk_dmap_get_buffused.9ossddk')
-rw-r--r--misc/man9ossddk/ossddk_dmap_get_buffused.9ossddk46
1 files changed, 46 insertions, 0 deletions
diff --git a/misc/man9ossddk/ossddk_dmap_get_buffused.9ossddk b/misc/man9ossddk/ossddk_dmap_get_buffused.9ossddk
new file mode 100644
index 0000000..d33001c
--- /dev/null
+++ b/misc/man9ossddk/ossddk_dmap_get_buffused.9ossddk
@@ -0,0 +1,46 @@
+'\" te
+.\" Copyright (c) 2005, 4Front Technologies 2005\&.
+.TH ossddk_dmap_get_buffused 9ossddk "12 Sep 2005" "SunOS 5.10" "OSS DDK Services"
+.SH "NAME"
+ossddk_dmap_get_buffused \- Returns the size of buffer that is actually in use
+.PP
+.SH "SYNOPSIS"
+.nf
+#include <sys/soundcard.h>
+.LP
+#include <sys/ossddk/ossddk.h>
+.fi
+.LP
+\fBint\fR ossddk_dmap_get_buffused(\fBdmap_t *\fIdmap\fP);
+.PP
+.SH "INTERFACE LEVEL"
+.PP
+Open Sound System specific (OSS 4.0 DDK)\&.
+.PP
+.SH "ARGUMENTS"
+.PP
+.sp
+.ne 2
+.mk
+\fB\fIdmap\fR
+.in +16n
+.rt
+Audio buffer handle.
+.in -16n
+.PP
+.SH "DESCRIPTION"
+.PP
+OSS audio devices have a DMA buffer with the maximum size returned by
+\fIossddk_dmap_get_buffsize\fR. However in most cases just part of the available
+buffer is actually in use. The driver can call \fIossddk_dmap_get_buffused\fR
+to find out the transfer count to be programmed in the device registers.
+.PP
+.SH "RETURN VALUES"
+Amount of buffer currently in use (in bytes). This value equals to
+fragment_size*num_fragments.
+.PP
+.SH "SEE ALSO"
+.PP
+\fIWriting Sound Device Drivers with OSS DDK\fR
+.LP
+\fIOpen Sound System Programmer's Guide\fR