The cl-vorbis Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-vorbis Reference Manual

This is the cl-vorbis Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 04:17:07 2022 GMT+0.

Table of Contents


1 Introduction

## About
This is a small library wrapping stb_vorbis to provide a fast, libre, and easy-to-ship OGG/Vorbis decoder.

## How To
For this tutorial we assume that ``org.shirakumo.fraf.vorbis`` has a local nickname of ``vorbis``.

:: common lisp
(vorbis:with-file (file "test.ogg")
  (values (vorbis:channels file)
          (vorbis:samplerate file)
          (vorbis:decode-frame file)))
::

There's functions to decode a full frame (``decode-frame``), return the pointers to a decoded frame (``decode-frame-ptrs``), decode samples to a list of buffers (``decode``), and decode to an interleaved buffer (``decode-interleaved``).

If need-be, you can also access the underlying C functions directly through the ``org.shirakumo.vorbis.cffi`` package and the ``handle`` function.

## Pinnable Vectors
Where mentioned, a "pinnable vector" must be either a vector allocated through ``static-vectors``, or on SBCL a vector of type ``sb-kernel:simple-unboxed-array``.

## Included Sources
- "stb_vorbis.c"(https://github.com/nothings/stb/blob/master/stb_vorbis.c)
- "glibc-2.13.h"(https://github.com/wheybags/glibc_version_header/blob/master/version_headers/x64/force_link_glibc_2.13.h)


2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-vorbis

Bindings to stb_vorbis, a simple and free OGG/Vorbis decoding library

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://Shirakumo.github.io/cl-vorbis/

Source Control

(GIT https://github.com/Shirakumo/cl-vorbis.git)

Bug Tracker

https://github.com/Shirakumo/cl-vorbis/issues

License

zlib

Version

1.0.0

Dependencies
  • cffi (system).
  • trivial-features (system).
  • trivial-garbage (system).
  • static-vectors (system).
  • documentation-utils (system).
Source

cl-vorbis.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.1 cl-vorbis/cl-vorbis.asd

Source

cl-vorbis.asd.

Parent Component

cl-vorbis (system).

ASDF Systems

cl-vorbis.


3.1.2 cl-vorbis/package.lisp

Source

cl-vorbis.asd.

Parent Component

cl-vorbis (system).

Packages

3.1.3 cl-vorbis/low-level.lisp

Dependency

package.lisp (file).

Source

cl-vorbis.asd.

Parent Component

cl-vorbis (system).

Public Interface
Internals

3.1.4 cl-vorbis/wrapper.lisp

Dependency

low-level.lisp (file).

Source

cl-vorbis.asd.

Parent Component

cl-vorbis (system).

Public Interface
Internals

Previous: , Up: Lisp   [Contents][Index]

3.1.5 cl-vorbis/documentation.lisp

Dependency

wrapper.lisp (file).

Source

cl-vorbis.asd.

Parent Component

cl-vorbis (system).


4 Packages

Packages are listed by definition order.


4.1 org.shirakumo.fraf.vorbis.cffi

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

4.2 org.shirakumo.fraf.vorbis

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


5.1.1 Macros

Macro: with-file ((file input &rest args) &body body)

Shorthand macro to OPEN a file and CLOSE it on exit.

See FILE
See OPEN
See CLOSE

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.


5.1.2 Ordinary functions

Function: buffer-data (pointer-to-buffer)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: (setf buffer-data) (pointer-to-buffer)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: buffer-length (pointer-to-buffer)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: (setf buffer-length) (pointer-to-buffer)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Reader: channels (instance)

Returns the number of channels in the file.

See FILE

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Target Slot

channels.

Function: close (vorbis)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: close (file)

Closes the file and invalidates its handle.

See FILE

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: comment-list (pointer-to-comment)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: (setf comment-list) (pointer-to-comment)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: comment-list-length (pointer-to-comment)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: (setf comment-list-length) (pointer-to-comment)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: comment-vendor (pointer-to-comment)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: (setf comment-vendor) (pointer-to-comment)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: comments (file)

Returns a list of comments as strings embedded in the vorbis file.

See FILE

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: decode (file buffers &key start end)

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

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: decode-filename (filename channels samplerate output)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: decode-frame (file &optional buffers)

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

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: decode-frame-ptrs (file)

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

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: decode-frame-pushdata (vorbis datablock length channels output samples)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: decode-interleaved (file buffer &key start end)

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

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: decode-memory (mem length channels samplerate output)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: duration (file)

Returns the length of the vorbis file in seconds.

See FILE

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: file-offset (file)

Returns the current seek point within the file or memory region.

See FILE

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: flush-pushdata (vorbis)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: get-comment (vorbis comment)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: get-error (vorbis)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: get-file-offset (vorbis)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: get-frame-float (vorbis channels output)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: get-frame-short (vorbis channel buffers length)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: get-frame-short-interleaved (vorbis channel buffer length)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: get-info (vorbis info)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: get-sample-offset (vorbis)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: get-samples-float (vorbis channels buffers length)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: get-samples-float-interleaved (vorbis channels buffer length)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: get-samples-short (vorbis channels buffers length)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: get-samples-short-interleaved (vorbis channels buffer length)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Reader: handle (instance)

Returns the pointer to the underlying C handle.

See FILE

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Target Slot

handle.

Writer: (setf handle) (instance)
Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Target Slot

handle.

Function: info-channels (pointer-to-info)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: (setf info-channels) (pointer-to-info)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: info-max-frame-size (pointer-to-info)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: (setf info-max-frame-size) (pointer-to-info)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: info-samplerate (pointer-to-info)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: (setf info-samplerate) (pointer-to-info)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: info-setup-memory-required (pointer-to-info)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: (setf info-setup-memory-required) (pointer-to-info)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: info-setup-temp-memory-required (pointer-to-info)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: (setf info-setup-temp-memory-required) (pointer-to-info)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: info-temp-memory-required (pointer-to-info)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: (setf info-temp-memory-required) (pointer-to-info)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: init ()

Load the foreign library.

Automatically called by OPEN.

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Reader: max-frame-size (instance)

Returns the maximum size of a frame in bytes.

See FILE

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Target Slot

max-frame-size.

Function: open (thing &rest initargs &key buffer start end)

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

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: open-file (file close-handle-on-close error buffer)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: open-file (path &key buffer)

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

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: open-file-section (file close-handle-on-close error buffer length)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: open-filename (filename error buffer)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: open-memory (data length error buffer)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: open-pointer (memory length &key buffer)

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

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: open-pushdata (datablock length consumed error buffer)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: open-vector (vector &key buffer start end)

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

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: sample-count (file)

Returns the number of samples total in the vorbis file.

See FILE

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: sample-index (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

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: (setf sample-index) (file)
Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Reader: samplerate (instance)

Returns the sample rate of the audio data in the file.

See FILE

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Target Slot

samplerate.

Function: seek (vorbis sample)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: seek (file sample)

Seek to the given sample in the vorbis file.

See FILE
See SEEK-FRAME

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: seek-frame (vorbis sample)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: seek-frame (file sample)

Seek in the file such that the next frame being decoded includes the requested sample.

See FILE
See SEEK

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: seek-start (vorbis)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: stream-length-in-samples (vorbis)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: stream-length-in-seconds (vorbis)
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Function: vendor (file)

Returns the name of the vendor that produced the vorbis file.

See FILE

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.


5.1.3 Generic functions

Generic Reader: code (condition)

Returns the internal error code that produced the error.

See VORBIS-ERROR

Package

org.shirakumo.fraf.vorbis.

Methods
Reader Method: code ((condition vorbis-error))
Source

wrapper.lisp.

Target Slot

code.

Generic Reader: file (condition)
Package

org.shirakumo.fraf.vorbis.

Methods
Reader Method: file ((condition vorbis-error))
Source

wrapper.lisp.

Target Slot

file.


5.1.4 Conditions

Condition: need-more-data

Warning signalled when not enough data is available to complete the operation.

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Direct superclasses

warning.

Condition: vorbis-error

Error signalled when a vorbis operation fails.

See CODE

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: file
Initargs

:file

Readers

file.

Writers

This slot is read-only.

Slot: code
Initargs

:code

Readers

code.

Writers

This slot is read-only.


Next: , Previous: , Up: Public Interface   [Contents][Index]

5.1.5 Structures

Structure: file

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

Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: handle
Type

cffi-sys:foreign-pointer

Readers

handle.

Writers

(setf handle).

Slot: channels
Type

(unsigned-byte 8)

Initform

0

Readers

channels.

Writers

This slot is read-only.

Slot: samplerate
Type

(unsigned-byte 32)

Initform

0

Readers

samplerate.

Writers

This slot is read-only.

Slot: max-frame-size
Type

(unsigned-byte 32)

Initform

0

Readers

max-frame-size.

Writers

This slot is read-only.


Previous: , Up: Public Interface   [Contents][Index]

5.1.6 Classes

Class: buffer
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: comment
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: info
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.

5.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

5.2.1 Special variables

Special Variable: *here*
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.

Special Variable: *static*
Package

org.shirakumo.fraf.vorbis.cffi.

Source

low-level.lisp.


5.2.2 Macros

Macro: with-pinned-buffer ((ptr data &key offset) &body body)
Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.


Previous: , Up: Internals   [Contents][Index]

5.2.3 Ordinary functions

Function: %make-file (handle channels samplerate max-frame-size)
Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: check-error (file error)
Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: check-file-for-error (file)
Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.

Function: make-file (handle error)
Package

org.shirakumo.fraf.vorbis.

Source

wrapper.lisp.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
B   C   D   F   G   H   I   M   O   S   V   W  
Index Entry  Section

%
%make-file: Private ordinary functions

(
(setf buffer-data): Public ordinary functions
(setf buffer-length): Public ordinary functions
(setf comment-list): Public ordinary functions
(setf comment-list-length): Public ordinary functions
(setf comment-vendor): Public ordinary functions
(setf handle): Public ordinary functions
(setf info-channels): Public ordinary functions
(setf info-max-frame-size): Public ordinary functions
(setf info-samplerate): Public ordinary functions
(setf info-setup-memory-required): Public ordinary functions
(setf info-setup-temp-memory-required): Public ordinary functions
(setf info-temp-memory-required): Public ordinary functions
(setf sample-index): Public ordinary functions

B
buffer-data: Public ordinary functions
buffer-length: Public ordinary functions

C
channels: Public ordinary functions
check-error: Private ordinary functions
check-file-for-error: Private ordinary functions
close: Public ordinary functions
close: Public ordinary functions
code: Public generic functions
code: Public generic functions
comment-list: Public ordinary functions
comment-list-length: Public ordinary functions
comment-vendor: Public ordinary functions
comments: Public ordinary functions

D
decode: Public ordinary functions
decode-filename: Public ordinary functions
decode-frame: Public ordinary functions
decode-frame-ptrs: Public ordinary functions
decode-frame-pushdata: Public ordinary functions
decode-interleaved: Public ordinary functions
decode-memory: Public ordinary functions
duration: Public ordinary functions

F
file: Public generic functions
file: Public generic functions
file-offset: Public ordinary functions
flush-pushdata: Public ordinary functions
Function, %make-file: Private ordinary functions
Function, (setf buffer-data): Public ordinary functions
Function, (setf buffer-length): Public ordinary functions
Function, (setf comment-list): Public ordinary functions
Function, (setf comment-list-length): Public ordinary functions
Function, (setf comment-vendor): Public ordinary functions
Function, (setf handle): Public ordinary functions
Function, (setf info-channels): Public ordinary functions
Function, (setf info-max-frame-size): Public ordinary functions
Function, (setf info-samplerate): Public ordinary functions
Function, (setf info-setup-memory-required): Public ordinary functions
Function, (setf info-setup-temp-memory-required): Public ordinary functions
Function, (setf info-temp-memory-required): Public ordinary functions
Function, (setf sample-index): Public ordinary functions
Function, buffer-data: Public ordinary functions
Function, buffer-length: Public ordinary functions
Function, channels: Public ordinary functions
Function, check-error: Private ordinary functions
Function, check-file-for-error: Private ordinary functions
Function, close: Public ordinary functions
Function, close: Public ordinary functions
Function, comment-list: Public ordinary functions
Function, comment-list-length: Public ordinary functions
Function, comment-vendor: Public ordinary functions
Function, comments: Public ordinary functions
Function, decode: Public ordinary functions
Function, decode-filename: Public ordinary functions
Function, decode-frame: Public ordinary functions
Function, decode-frame-ptrs: Public ordinary functions
Function, decode-frame-pushdata: Public ordinary functions
Function, decode-interleaved: Public ordinary functions
Function, decode-memory: Public ordinary functions
Function, duration: Public ordinary functions
Function, file-offset: Public ordinary functions
Function, flush-pushdata: Public ordinary functions
Function, get-comment: Public ordinary functions
Function, get-error: Public ordinary functions
Function, get-file-offset: Public ordinary functions
Function, get-frame-float: Public ordinary functions
Function, get-frame-short: Public ordinary functions
Function, get-frame-short-interleaved: Public ordinary functions
Function, get-info: Public ordinary functions
Function, get-sample-offset: Public ordinary functions
Function, get-samples-float: Public ordinary functions
Function, get-samples-float-interleaved: Public ordinary functions
Function, get-samples-short: Public ordinary functions
Function, get-samples-short-interleaved: Public ordinary functions
Function, handle: Public ordinary functions
Function, info-channels: Public ordinary functions
Function, info-max-frame-size: Public ordinary functions
Function, info-samplerate: Public ordinary functions
Function, info-setup-memory-required: Public ordinary functions
Function, info-setup-temp-memory-required: Public ordinary functions
Function, info-temp-memory-required: Public ordinary functions
Function, init: Public ordinary functions
Function, make-file: Private ordinary functions
Function, max-frame-size: Public ordinary functions
Function, open: Public ordinary functions
Function, open-file: Public ordinary functions
Function, open-file: Public ordinary functions
Function, open-file-section: Public ordinary functions
Function, open-filename: Public ordinary functions
Function, open-memory: Public ordinary functions
Function, open-pointer: Public ordinary functions
Function, open-pushdata: Public ordinary functions
Function, open-vector: Public ordinary functions
Function, sample-count: Public ordinary functions
Function, sample-index: Public ordinary functions
Function, samplerate: Public ordinary functions
Function, seek: Public ordinary functions
Function, seek: Public ordinary functions
Function, seek-frame: Public ordinary functions
Function, seek-frame: Public ordinary functions
Function, seek-start: Public ordinary functions
Function, stream-length-in-samples: Public ordinary functions
Function, stream-length-in-seconds: Public ordinary functions
Function, vendor: Public ordinary functions

G
Generic Function, code: Public generic functions
Generic Function, file: Public generic functions
get-comment: Public ordinary functions
get-error: Public ordinary functions
get-file-offset: Public ordinary functions
get-frame-float: Public ordinary functions
get-frame-short: Public ordinary functions
get-frame-short-interleaved: Public ordinary functions
get-info: Public ordinary functions
get-sample-offset: Public ordinary functions
get-samples-float: Public ordinary functions
get-samples-float-interleaved: Public ordinary functions
get-samples-short: Public ordinary functions
get-samples-short-interleaved: Public ordinary functions

H
handle: Public ordinary functions

I
info-channels: Public ordinary functions
info-max-frame-size: Public ordinary functions
info-samplerate: Public ordinary functions
info-setup-memory-required: Public ordinary functions
info-setup-temp-memory-required: Public ordinary functions
info-temp-memory-required: Public ordinary functions
init: Public ordinary functions

M
Macro, with-file: Public macros
Macro, with-pinned-buffer: Private macros
make-file: Private ordinary functions
max-frame-size: Public ordinary functions
Method, code: Public generic functions
Method, file: Public generic functions

O
open: Public ordinary functions
open-file: Public ordinary functions
open-file: Public ordinary functions
open-file-section: Public ordinary functions
open-filename: Public ordinary functions
open-memory: Public ordinary functions
open-pointer: Public ordinary functions
open-pushdata: Public ordinary functions
open-vector: Public ordinary functions

S
sample-count: Public ordinary functions
sample-index: Public ordinary functions
samplerate: Public ordinary functions
seek: Public ordinary functions
seek: Public ordinary functions
seek-frame: Public ordinary functions
seek-frame: Public ordinary functions
seek-start: Public ordinary functions
stream-length-in-samples: Public ordinary functions
stream-length-in-seconds: Public ordinary functions

V
vendor: Public ordinary functions

W
with-file: Public macros
with-pinned-buffer: Private macros

Jump to:   %   (  
B   C   D   F   G   H   I   M   O   S   V   W  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   B   C   D   F   I   L   N   O   P   S   V   W  
Index Entry  Section

B
buffer: Public classes

C
cl-vorbis: The cl-vorbis system
cl-vorbis.asd: The cl-vorbis/cl-vorbis․asd file
Class, buffer: Public classes
Class, comment: Public classes
Class, info: Public classes
comment: Public classes
Condition, need-more-data: Public conditions
Condition, vorbis-error: Public conditions

D
documentation.lisp: The cl-vorbis/documentation․lisp file

F
file: Public structures
File, cl-vorbis.asd: The cl-vorbis/cl-vorbis․asd file
File, documentation.lisp: The cl-vorbis/documentation․lisp file
File, low-level.lisp: The cl-vorbis/low-level․lisp file
File, package.lisp: The cl-vorbis/package․lisp file
File, wrapper.lisp: The cl-vorbis/wrapper․lisp file

I
info: Public classes

L
low-level.lisp: The cl-vorbis/low-level․lisp file

N
need-more-data: Public conditions

O
org.shirakumo.fraf.vorbis: The org․shirakumo․fraf․vorbis package
org.shirakumo.fraf.vorbis.cffi: The org․shirakumo․fraf․vorbis․cffi package

P
Package, org.shirakumo.fraf.vorbis: The org․shirakumo․fraf․vorbis package
Package, org.shirakumo.fraf.vorbis.cffi: The org․shirakumo․fraf․vorbis․cffi package
package.lisp: The cl-vorbis/package․lisp file

S
Structure, file: Public structures
System, cl-vorbis: The cl-vorbis system

V
vorbis-error: Public conditions

W
wrapper.lisp: The cl-vorbis/wrapper․lisp file

Jump to:   B   C   D   F   I   L   N   O   P   S   V   W