This is the cl-vorbis Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:51:26 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-vorbisBindings to stb_vorbis, a simple and free OGG/Vorbis decoding library
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shirakumo/cl-vorbis.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-vorbis/cl-vorbis.asdcl-vorbis/package.lispcl-vorbis/low-level.lispcl-vorbis/wrapper.lispcl-vorbis/documentation.lispcl-vorbis/low-level.lisppackage.lisp (file).
cl-vorbis (system).
buffer (class).
buffer-data (function).
(setf buffer-data) (function).
buffer-length (function).
(setf buffer-length) (function).
close (function).
comment (class).
comment-list (function).
(setf comment-list) (function).
comment-list-length (function).
(setf comment-list-length) (function).
comment-vendor (function).
(setf comment-vendor) (function).
decode-filename (function).
decode-frame-pushdata (function).
decode-memory (function).
flush-pushdata (function).
get-comment (function).
get-error (function).
get-file-offset (function).
get-frame-float (function).
get-frame-short (function).
get-frame-short-interleaved (function).
get-info (function).
get-sample-offset (function).
get-samples-float (function).
get-samples-float-interleaved (function).
get-samples-short (function).
get-samples-short-interleaved (function).
info (class).
info-channels (function).
(setf info-channels) (function).
info-max-frame-size (function).
(setf info-max-frame-size) (function).
info-samplerate (function).
(setf info-samplerate) (function).
info-setup-memory-required (function).
(setf info-setup-memory-required) (function).
info-setup-temp-memory-required (function).
(setf info-setup-temp-memory-required) (function).
info-temp-memory-required (function).
(setf info-temp-memory-required) (function).
open-file (function).
open-file-section (function).
open-filename (function).
open-memory (function).
open-pushdata (function).
seek (function).
seek-frame (function).
seek-start (function).
stream-length-in-samples (function).
stream-length-in-seconds (function).
cl-vorbis/wrapper.lisplow-level.lisp (file).
cl-vorbis (system).
channels (reader).
close (function).
code (reader method).
comments (function).
decode (function).
decode-frame (function).
decode-frame-ptrs (function).
decode-interleaved (function).
duration (function).
file (reader method).
file (structure).
file-offset (function).
handle (reader).
(setf handle) (writer).
init (function).
max-frame-size (reader).
need-more-data (condition).
open (function).
open-file (function).
open-pointer (function).
open-vector (function).
sample-count (function).
sample-index (function).
(setf sample-index) (function).
samplerate (reader).
seek (function).
seek-frame (function).
shutdown (function).
vendor (function).
vorbis-error (condition).
with-file (macro).
%make-file (function).
*init* (special variable).
check-error (function).
check-file-for-error (function).
make-file (function).
with-pinned-buffer (macro).
cl-vorbis/documentation.lispwrapper.lisp (file).
cl-vorbis (system).
Packages are listed by definition order.
org.shirakumo.fraf.vorbis.cfficommon-lisp.
buffer (class).
buffer-data (function).
(setf buffer-data) (function).
buffer-length (function).
(setf buffer-length) (function).
close (function).
comment (class).
comment-list (function).
(setf comment-list) (function).
comment-list-length (function).
(setf comment-list-length) (function).
comment-vendor (function).
(setf comment-vendor) (function).
decode-filename (function).
decode-frame-pushdata (function).
decode-memory (function).
flush-pushdata (function).
get-comment (function).
get-error (function).
get-file-offset (function).
get-frame-float (function).
get-frame-short (function).
get-frame-short-interleaved (function).
get-info (function).
get-sample-offset (function).
get-samples-float (function).
get-samples-float-interleaved (function).
get-samples-short (function).
get-samples-short-interleaved (function).
info (class).
info-channels (function).
(setf info-channels) (function).
info-max-frame-size (function).
(setf info-max-frame-size) (function).
info-samplerate (function).
(setf info-samplerate) (function).
info-setup-memory-required (function).
(setf info-setup-memory-required) (function).
info-setup-temp-memory-required (function).
(setf info-setup-temp-memory-required) (function).
info-temp-memory-required (function).
(setf info-temp-memory-required) (function).
open-file (function).
open-file-section (function).
open-filename (function).
open-memory (function).
open-pushdata (function).
seek (function).
seek-frame (function).
seek-start (function).
stream-length-in-samples (function).
stream-length-in-seconds (function).
org.shirakumo.fraf.vorbiscommon-lisp.
channels (reader).
close (function).
code (generic reader).
comments (function).
decode (function).
decode-frame (function).
decode-frame-ptrs (function).
decode-interleaved (function).
duration (function).
file (generic reader).
file (structure).
file-offset (function).
handle (reader).
(setf handle) (writer).
init (function).
max-frame-size (reader).
need-more-data (condition).
open (function).
open-file (function).
open-pointer (function).
open-vector (function).
sample-count (function).
sample-index (function).
(setf sample-index) (function).
samplerate (reader).
seek (function).
seek-frame (function).
shutdown (function).
vendor (function).
vorbis-error (condition).
with-file (macro).
%make-file (function).
*init* (special variable).
check-error (function).
check-file-for-error (function).
make-file (function).
with-pinned-buffer (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Shorthand macro to OPEN a file and CLOSE it on exit.
See FILE
See OPEN
See CLOSE
Returns the number of channels in the file.
See FILE
Closes the file and invalidates its handle.
See FILE
Returns a list of comments as strings embedded in the vorbis file.
See FILE
Decode a number of samples to per-channel buffers.
BUFFERS must be a list of pinnable vectors that will be filled with
samples, each starting by START and ending before END.
Returns the number of samples that were written to the buffers.
See FILE
See DECODE-INTERLEAVED
Decode a whole vorbis frame.
Returns three values: a list of buffers (one per channel) containaing
the frame data, the number of samples in the buffers, and the number
of channels.
If BUFFERS is passed it must be a list of pinnable vectors the length
of the number of channels in the file.
See FILE
See DECODE-FRAME-PTRS
Decode a whole vorbis frame.
Returns three values: a pointer to an array of pointers for the
buffers containing the samples, the number of samples in each buffer,
and the number of channels.
See FILE
See DECODE-FRAME
Decode a number of samples to a single buffer, inteleaved.
BUFFER must be a pinnable vector that will be filled with samples,
starting by START and ending before END.
Returns the number of samples that were written to the buffer.
See FILE
See DECODE
Returns the length of the vorbis file in seconds.
See FILE
Returns the current seek point within the file or memory region.
See FILE
Returns the pointer to the underlying C handle.
See FILE
Load the foreign library.
Automatically called by OPEN.
See SHUTDOWN
Returns the maximum size of a frame in bytes.
See FILE
Opens the given input as an OGG/Vorbis file.
Returns the newly generated FILE object or signals an error. The input
can be a STRING/PATHNAME, a CFFI:FOREIGN-POINTER, or an UNSIGNED-BYTE 8
static vector. If you pass a vector that is not pinned in memory, bad
things will happen.
This function automatically calls INIT to ensure the library is
loaded.
See OPEN-FILE
See OPEN-POINTER
See OPEN-VECTOR
See FILE
See VORBIS-ERROR
Open a vorbis file from the file system.
INIT must be called prior to this.
Returns a FILE instance if successful, signals an error otherwise.
See INIT
See FILE
See OPEN
Open a vorbis file from a CFFI:FOREIGN-POINTER
INIT must be called prior to this.
Returns a FILE instance if successful, signals an error otherwise.
The memory area MUST NOT move or be freed before CLOSE is called on
the returned file.
See INIT
See FILE
See OPEN
Open a vorbis file from an octet vector
INIT must be called prior to this.
Returns a FILE instance if successful, signals an error otherwise.
The vector must be a static-vector and MUST NOT move or be deallocated
before CLOSE is called on the returned file.
See INIT
See FILE
See OPEN
Returns the number of samples total in the vorbis file.
See FILE
Returns the sample index the decoder is currently at.
If the index is not known, -1 is returned.
This place may be SETFed, which is equivalent to calling SEEK.
See FILE
See SEEK
Returns the sample rate of the audio data in the file.
See FILE
Seek to the given sample in the vorbis file.
See FILE
See SEEK-FRAME
Seek in the file such that the next frame being decoded includes the requested sample.
See FILE
See SEEK
Unloads the foreign library.
See INIT
Returns the name of the vendor that produced the vorbis file.
See FILE
Returns the internal error code that produced the error.
See VORBIS-ERROR
vorbis-error)) ¶code.
vorbis-error)) ¶file.
Warning signalled when not enough data is available to complete the operation.
warning.
Error signalled when a vorbis operation fails.
See CODE
error.
Representation of an OGG/Vorbis file.
See OPEN
See HANDLE
See CHANNELS
See SAMPLERATE
See MAX-FRAME-SIZE
See CLOSE
See FILE-OFFSET
See SAMPLE-INDEX
See COMMENTS
See VENDOR
See SEEK
See SEEK-FRAME
See SAMPLE-COUNT
See DURATION
See DECODE-FRAME
See DECODE-FRAME-PTRS
See DECODE
See DECODE-INTERLEAVED
structure-object.
cffi-sys:foreign-pointer
(unsigned-byte 8)
0
This slot is read-only.
(unsigned-byte 32)
0
This slot is read-only.
(unsigned-byte 32)
0
This slot is read-only.
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 M O S V W |
|---|
| Jump to: | %
(
B C D F G H I M O S V W |
|---|
| Jump to: | *
C F H M S |
|---|
| Jump to: | *
C F H M S |
|---|
| Jump to: | B C D F I L N O P S V W |
|---|
| Jump to: | B C D F I L N O P S V W |
|---|