This is the cl-opus Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:32:54 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-opusBindings to libopusfile, a simple and free OGG/Opus decoding library
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shirakumo/cl-opus.git)
zlib
1.0.0
cffi (system).
trivial-features (system).
trivial-garbage (system).
static-vectors (system).
documentation-utils (system).
package.lisp (file).
low-level.lisp (file).
wrapper.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-opus/cl-opus.asdcl-opus/package.lispcl-opus/low-level.lispcl-opus/wrapper.lispcl-opus/documentation.lispcl-opus/low-level.lisppackage.lisp (file).
cl-opus (system).
bitrate (function).
bitrate-instant (function).
callbacks-close (function).
(setf callbacks-close) (function).
callbacks-read (function).
(setf callbacks-read) (function).
callbacks-seek (function).
(setf callbacks-seek) (function).
callbacks-tell (function).
(setf callbacks-tell) (function).
channel-count (function).
current-link (function).
fdopen (function).
fopen (function).
free (function).
freopen (function).
granule-sample (function).
head (function).
head-channel-count (function).
(setf head-channel-count) (function).
head-coupled-count (function).
(setf head-coupled-count) (function).
head-input-sample-rate (function).
(setf head-input-sample-rate) (function).
head-mapping (function).
(setf head-mapping) (function).
head-mapping-family (function).
(setf head-mapping-family) (function).
head-output-gain (function).
(setf head-output-gain) (function).
head-parse (function).
head-pre-skip (function).
(setf head-pre-skip) (function).
head-stream-count (function).
(setf head-stream-count) (function).
head-version (function).
(setf head-version) (function).
link-count (function).
mem-stream-create (function).
open-callbacks (function).
open-file (function).
open-memory (function).
pcm-seek (function).
pcm-tell (function).
pcm-total (function).
picture-tag-clear (function).
picture-tag-colors (function).
(setf picture-tag-colors) (function).
picture-tag-data (function).
(setf picture-tag-data) (function).
picture-tag-depth (function).
(setf picture-tag-depth) (function).
picture-tag-description (function).
(setf picture-tag-description) (function).
picture-tag-format (function).
(setf picture-tag-format) (function).
picture-tag-height (function).
(setf picture-tag-height) (function).
picture-tag-init (function).
picture-tag-mime-type (function).
(setf picture-tag-mime-type) (function).
picture-tag-parse (function).
picture-tag-type (function).
(setf picture-tag-type) (function).
picture-tag-width (function).
(setf picture-tag-width) (function).
raw-seek (function).
raw-tell (function).
raw-total (function).
read (function).
read-float (function).
read-stereo (function).
read-stereo-float (function).
seekable-p (function).
serial-number (function).
server-info-bitrate-kbps (function).
(setf server-info-bitrate-kbps) (function).
server-info-clear (function).
server-info-content-type (function).
(setf server-info-content-type) (function).
server-info-description (function).
(setf server-info-description) (function).
server-info-genre (function).
(setf server-info-genre) (function).
server-info-init (function).
server-info-name (function).
(setf server-info-name) (function).
server-info-public-p (function).
(setf server-info-public-p) (function).
server-info-server (function).
(setf server-info-server) (function).
server-info-ssl-p (function).
(setf server-info-ssl-p) (function).
server-info-url (function).
(setf server-info-url) (function).
set-decode-callback (function).
set-dither-enabled (function).
set-gain-offset (function).
tags (function).
tags-add (function).
tags-add-comment (function).
tags-clear (function).
tags-comment-lengths (function).
(setf tags-comment-lengths) (function).
tags-comments (function).
(setf tags-comments) (function).
tags-copy (function).
tags-get-album-gain (function).
tags-get-binary-suffix (function).
tags-get-track-gain (function).
tags-init (function).
tags-parse (function).
tags-query (function).
tags-query-count (function).
tags-set-binary-suffix (function).
tags-user-comments (function).
(setf tags-user-comments) (function).
tags-vendor (function).
(setf tags-vendor) (function).
test (function).
test-callbacks (function).
test-file (function).
test-memory (function).
test-open (function).
*here* (special variable).
*static* (special variable).
callbacks-tclass (class).
head-tclass (class).
picture-tag-data-length (function).
(setf picture-tag-data-length) (function).
picture-tag-tclass (class).
server-info-tclass (class).
tag-compare (function).
tag-n-compare (function).
tags-tclass (class).
cl-opus/wrapper.lisplow-level.lisp (file).
cl-opus (system).
bitrate (function).
channels (function).
check-return (function).
close (function).
close-fun (reader).
(setf close-fun) (writer).
code (reader method).
comments (function).
current-link (function).
decode-float (function).
decode-int16 (function).
describe-object (method).
duration (function).
file (reader method).
file (structure).
gain (function).
(setf gain) (function).
handle (reader).
(setf handle) (writer).
index (function).
(setf index) (function).
index-fun (reader).
(setf index-fun) (writer).
init (function).
instant-bitrate (function).
link-count (function).
open (function).
open-callback (function).
open-file (function).
open-pointer (function).
open-vector (function).
opus-error (condition).
print-object (method).
read-fun (reader).
(setf read-fun) (writer).
sample-count (function).
samplerate (function).
seek (function).
seek-fun (reader).
(setf seek-fun) (writer).
seekable-p (function).
serial-number (function).
shutdown (function).
vendor (function).
with-file (macro).
%make-file (function).
*callback-counter* (special variable).
*callbacks* (special variable).
*init* (special variable).
copy-stream-wrapper (function).
define-callback (macro).
make-file (function).
make-stream-wrapper (function).
open-stream (function).
stream-close (function).
stream-index (function).
stream-read (function).
stream-seek (function).
stream-wrapper (structure).
stream-wrapper-offset (reader).
(setf stream-wrapper-offset) (writer).
stream-wrapper-p (function).
stream-wrapper-stream (reader).
(setf stream-wrapper-stream) (writer).
user-data (reader).
(setf user-data) (writer).
with-pinned-buffer (macro).
cl-opus/documentation.lispwrapper.lisp (file).
cl-opus (system).
Packages are listed by definition order.
org.shirakumo.fraf.opuscommon-lisp.
bitrate (function).
channels (function).
check-return (function).
close (function).
close-fun (reader).
(setf close-fun) (writer).
code (generic reader).
comments (function).
current-link (function).
decode-float (function).
decode-int16 (function).
duration (function).
file (generic reader).
file (structure).
gain (function).
(setf gain) (function).
handle (reader).
(setf handle) (writer).
index (function).
(setf index) (function).
index-fun (reader).
(setf index-fun) (writer).
init (function).
instant-bitrate (function).
link-count (function).
open (function).
open-callback (function).
open-file (function).
open-pointer (function).
open-vector (function).
opus-error (condition).
read-fun (reader).
(setf read-fun) (writer).
sample-count (function).
samplerate (function).
seek (function).
seek-fun (reader).
(setf seek-fun) (writer).
seekable-p (function).
serial-number (function).
shutdown (function).
vendor (function).
with-file (macro).
%make-file (function).
*callback-counter* (special variable).
*callbacks* (special variable).
*init* (special variable).
copy-stream-wrapper (function).
define-callback (macro).
make-file (function).
make-stream-wrapper (function).
open-stream (function).
stream-close (function).
stream-index (function).
stream-read (function).
stream-seek (function).
stream-wrapper (structure).
stream-wrapper-offset (reader).
(setf stream-wrapper-offset) (writer).
stream-wrapper-p (function).
stream-wrapper-stream (reader).
(setf stream-wrapper-stream) (writer).
user-data (reader).
(setf user-data) (writer).
with-pinned-buffer (macro).
org.shirakumo.fraf.opus.cfficommon-lisp.
bitrate (function).
bitrate-instant (function).
callbacks-close (function).
(setf callbacks-close) (function).
callbacks-read (function).
(setf callbacks-read) (function).
callbacks-seek (function).
(setf callbacks-seek) (function).
callbacks-tell (function).
(setf callbacks-tell) (function).
channel-count (function).
current-link (function).
fdopen (function).
fopen (function).
free (function).
freopen (function).
granule-sample (function).
head (function).
head-channel-count (function).
(setf head-channel-count) (function).
head-coupled-count (function).
(setf head-coupled-count) (function).
head-input-sample-rate (function).
(setf head-input-sample-rate) (function).
head-mapping (function).
(setf head-mapping) (function).
head-mapping-family (function).
(setf head-mapping-family) (function).
head-output-gain (function).
(setf head-output-gain) (function).
head-parse (function).
head-pre-skip (function).
(setf head-pre-skip) (function).
head-stream-count (function).
(setf head-stream-count) (function).
head-version (function).
(setf head-version) (function).
link-count (function).
mem-stream-create (function).
open-callbacks (function).
open-file (function).
open-memory (function).
pcm-seek (function).
pcm-tell (function).
pcm-total (function).
picture-tag-clear (function).
picture-tag-colors (function).
(setf picture-tag-colors) (function).
picture-tag-data (function).
(setf picture-tag-data) (function).
picture-tag-depth (function).
(setf picture-tag-depth) (function).
picture-tag-description (function).
(setf picture-tag-description) (function).
picture-tag-format (function).
(setf picture-tag-format) (function).
picture-tag-height (function).
(setf picture-tag-height) (function).
picture-tag-init (function).
picture-tag-mime-type (function).
(setf picture-tag-mime-type) (function).
picture-tag-parse (function).
picture-tag-type (function).
(setf picture-tag-type) (function).
picture-tag-width (function).
(setf picture-tag-width) (function).
raw-seek (function).
raw-tell (function).
raw-total (function).
read (function).
read-float (function).
read-stereo (function).
read-stereo-float (function).
seekable-p (function).
serial-number (function).
server-info-bitrate-kbps (function).
(setf server-info-bitrate-kbps) (function).
server-info-clear (function).
server-info-content-type (function).
(setf server-info-content-type) (function).
server-info-description (function).
(setf server-info-description) (function).
server-info-genre (function).
(setf server-info-genre) (function).
server-info-init (function).
server-info-name (function).
(setf server-info-name) (function).
server-info-public-p (function).
(setf server-info-public-p) (function).
server-info-server (function).
(setf server-info-server) (function).
server-info-ssl-p (function).
(setf server-info-ssl-p) (function).
server-info-url (function).
(setf server-info-url) (function).
set-decode-callback (function).
set-dither-enabled (function).
set-gain-offset (function).
tags (function).
tags-add (function).
tags-add-comment (function).
tags-clear (function).
tags-comment-lengths (function).
(setf tags-comment-lengths) (function).
tags-comments (function).
(setf tags-comments) (function).
tags-copy (function).
tags-get-album-gain (function).
tags-get-binary-suffix (function).
tags-get-track-gain (function).
tags-init (function).
tags-parse (function).
tags-query (function).
tags-query-count (function).
tags-set-binary-suffix (function).
tags-user-comments (function).
(setf tags-user-comments) (function).
tags-vendor (function).
(setf tags-vendor) (function).
test (function).
test-callbacks (function).
test-file (function).
test-memory (function).
test-open (function).
*here* (special variable).
*static* (special variable).
callbacks-tclass (class).
head-tclass (class).
picture-tag-data-length (function).
(setf picture-tag-data-length) (function).
picture-tag-tclass (class).
server-info-tclass (class).
tag-compare (function).
tag-n-compare (function).
tags-tclass (class).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Open a file within a dynamic extent.
Automatically calls OPEN, and CLOSE on unwind.
See OPEN
see CLOSE
See FILE (type)
Returns the bitrate of the (current) link.
See FILE (type)
Returns the number of channels in the file.
Returns the number of channels in the file or link.
The channel layout is as follows:
1 — center
2 — left, right
3 — left, center, right
4 — front left, front right, rear left, rear right
5 — front left, center, front right, rear left, rear right
6 — front left, center, front right, rear left, rear right, LFE
7 — front left, center, front right, side left, side right, rear
center, LFE
8 — front left, center, front right, side left, side right, rear
left, rear right, LFE
For any other number of channels the layout is up to the application.
See FILE (type)
Checks whether the return value was valid or an error.
If valid, returns the value. Otherwise, signals an OPUS-ERROR.
See OPUS-ERROR (type)
Close the file and free its resources.
Once closed, a file cannot be reopened and you must create a new file
instead.
See FILE (type)
Accesses the close function for callback-driven files.
The function must accept one argument:
FILE — The FILE instance.
It should return 0 on success or -1 on error.
See FILE (type)
Returns a list of user comments contained in the file or link.
See FILE (type)
Returns the current link index.
See FILE (type)
Decodes the file into the float buffer.
You may designate the region of the buffer to fill by START and
END. Returns the index after the last element in the buffer that was
set, same as READ-SEQUENCE.
The buffer must be a (SIMPLE-ARRAY SINGLE-FLOAT (*)), where the
data is represented as frames of interleaved channels.
If STEREO is T, remixes the signal to stereo regardless of the actual
channel count.
See FILE (type)
Decodes the file into the (unsigned-byte 16) buffer.
You may designate the region of the buffer to fill by START and
END. Returns the index after the last element in the buffer that was
set, same as READ-SEQUENCE.
The buffer must be a (SIMPLE-ARRAY (UNSIGNED-BYTE 16) (*)), where the
data is represented as frames of interleaved channels.
If STEREO is T, remixes the signal to stereo regardless of the actual
channel count.
See FILE (type)
Returns the total duration in seconds of the file or link.
See FILE (type)
Accesses the gain in dB of the file.
See FILE (type)
Returns the internal foreign pointer handle of the file.
See FILE (type)
Accesses the current sample (frame!) index.
See FILE (type)
Accesses the index function for callback-driven files.
The function must accept one argument:
FILE — The FILE instance.
It should return the byte index of the stream, or -1 on error.
See FILE (type)
Initialises the Opus API.
See SHUTDOWN
Returns the bitrate between now and the last time this function was called.
See FILE (type)
Returns the total number of links in the file.
See FILE (type)
Open a file from the given storage.
The storage may either be a STRING, PATHNAME, CFFI:FOREIGN-POINTER,
STATIC-VECTOR, FUNCTION, or STREAM.
See OPEN-FILE
See OPEN-POINTER
See OPEN-VECTOR
See OPEN-CALLBACK
See OPEN-STREAM
See FILE (type)
Open a file using the callbacks API.
While the seek, index, and close functions are optional, it is highly
recommended that you pass them as well as the read function. You may
pass INITIAL-DATA (a static vector or foreign pointer) if you’ve
already begun processing part of the data stream.
Automatically calls INIT.
See INIT
See READ-FUN
See SEEK-FUN
See INDEX-FUN
See CLOSE-FUN
See FILE (type)
Open a file from a filesystem PATH.
Automatically calls INIT.
See INIT
See FILE (type)
Open a file from a raw pointer.
You may specify START to offset from the pointer, and you must pass
END to designate the buffer’s maximum length.
Automatically calls INIT.
See INIT
See FILE (type)
Open a file from a static vector.
You may specify START and END to define a sub region within the
vector. The vector MUST have been created with
STATIC-VECTORS:MAKE-STATIC-VECTOR.
Automatically calls INIT.
See INIT
See FILE (type)
Accesses the read function for callback-driven files.
The function must accept three arguments:
FILE — The FILE instance.
BUFFER — A pointer to a buffer to fill.
BYTES — The number of bytes in the buffer to fill.
It must return the number of bytes written to the buffer or -1 on
error.
See FILE (type)
Returns the total number of samples (frames!) in the file or link.
See FILE (type)
Returns the samplerate of the file.
This is fixed to 48000 Hz.
See FILE (type)
Seeks the file to the specified place.
BY — May be one of:
:SECOND — The index is a float in seconds
:SAMPLE — The index is an integer in samples (frames!)
:BYTE — The index is an integer in bytes of the stream
MODE — May be one of:
:ABSOLUTE — The index is from the beginning of the file
:RELATIVE — The index is relative to the current position
See (SETF INDEX)
See FILE (type)
Accesses the seek function for callback-driven files.
The function must accept three arguments:
FILE — The FILE instance.
OFFSET — The offset in bytes.
WHENCE — One of:
:START — OFFSET is from the start of the file.
:CURRENT — OFFSET is from the current index.
:END — OFFSET is from the end of the file.
It should return 0 on success or -1 on error.
See FILE (type)
Returns whether the file is seekable or not.
See FILE (type)
Returns the vendor serial number of the (current) link.
See FILE (type)
Closes the Opus API.
See INIT
Returns the vendor identification string of the file or link.
See FILE (type)
Returns the error code returned by the failed API call.
See OPUS-ERROR
opus-error)) ¶code.
Returns the FILE instance associated with the error, if any.
See FILE (type)
See OPUS-ERROR
opus-error)) ¶file.
Condition signalled on failed API calls.
See FILE
See CODE
error.
Representation of an Opus file.
Use one of the OPEN* functions to obtain this instance. when you are
done, use CLOSE to properly dispose of the file.
See HANDLE
See READ-FUN
See SEEK-FUN
See INDEX-FUN
See CLOSE-FUN
See CLOSE
See OPEN-FILE
See OPEN-POINTER
See OPEN-VECTOR
See OPEN-CALLBACK
See OPEN
See WITH-FILE
See SAMPLERATE
See CHANNELS
See SAMPLE-COUNT
See DURATION
See SEEKABLE-P
See LINK-COUNT
See SERIAL-NUMBER
See CURRENT-LINK
See BITRATE
See INSTANT-BITRATE
See INDEX
See SEEK
See COMMENTS
See VENDOR
See GAIN
See DECODE-FLOAT
See DECODE-INT16
structure-object.
cffi-sys:foreign-pointer
function
(constantly -1)
function
(constantly -1)
function
(constantly -1)
function
(constantly -1)
Open a file from a stream.
Note that seeking is only supported if the stream is a FILE-STREAM.
This uses the callbacks API in the back.
Automatically calls INIT.
See INIT
See OPEN-CALLBACK
See FILE (type)
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
foreign-struct-type.
translatable-foreign-type.
| Jump to: | %
(
B C D F G H I L M O P R S T U V W |
|---|
| Jump to: | %
(
B C D F G H I L M O P R S T U V W |
|---|
| Jump to: | *
C F H I O R S U |
|---|
| Jump to: | *
C F H I O R S U |
|---|
| Jump to: | C D F H L O P S T W |
|---|
| Jump to: | C D F H L O P S T W |
|---|