The cl-vorbis Reference Manual

Table of Contents

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 3.0 "Montgomery Scott" on Wed Oct 13 10:17:59 2021 GMT+0.


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

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)


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

2 Systems

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


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

2.1 cl-vorbis

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

Description

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

Version

1.0.0

Dependencies
Source

cl-vorbis.asd (file)

Components

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

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 files   [Contents][Index]

3.1.1 cl-vorbis.asd

Location

cl-vorbis.asd

Systems

cl-vorbis (system)


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

3.1.2 cl-vorbis/package.lisp

Parent

cl-vorbis (system)

Location

package.lisp

Packages

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

3.1.3 cl-vorbis/low-level.lisp

Dependency

package.lisp (file)

Parent

cl-vorbis (system)

Location

low-level.lisp

Exported Definitions
Internal Definitions

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

3.1.4 cl-vorbis/wrapper.lisp

Dependency

low-level.lisp (file)

Parent

cl-vorbis (system)

Location

wrapper.lisp

Exported Definitions
Internal Definitions

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

3.1.5 cl-vorbis/documentation.lisp

Dependency

wrapper.lisp (file)

Parent

cl-vorbis (system)

Location

documentation.lisp


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

4 Packages

Packages are listed by definition order.


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

4.1 org.shirakumo.fraf.vorbis.cffi

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

4.2 org.shirakumo.fraf.vorbis

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: buffer-data POINTER-TO-BUFFER
Function: (setf buffer-data) VALUE POINTER-TO-BUFFER
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: buffer-length POINTER-TO-BUFFER
Function: (setf buffer-length) VALUE POINTER-TO-BUFFER
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: channels INSTANCE

Returns the number of channels in the file.

See FILE

Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)

Function: close VORBIS
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: close FILE

Closes the file and invalidates its handle.

See FILE

Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)

Function: comment-list POINTER-TO-COMMENT
Function: (setf comment-list) VALUE POINTER-TO-COMMENT
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: comment-list-length POINTER-TO-COMMENT
Function: (setf comment-list-length) VALUE POINTER-TO-COMMENT
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: comment-vendor POINTER-TO-COMMENT
Function: (setf comment-vendor) VALUE POINTER-TO-COMMENT
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

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 (file)

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 (file)

Function: decode-filename FILENAME CHANNELS SAMPLERATE OUTPUT
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

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 (file)

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 (file)

Function: decode-frame-pushdata VORBIS DATABLOCK LENGTH CHANNELS OUTPUT SAMPLES
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

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 (file)

Function: decode-memory MEM LENGTH CHANNELS SAMPLERATE OUTPUT
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: duration FILE

Returns the length of the vorbis file in seconds.

See FILE

Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)

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 (file)

Function: flush-pushdata VORBIS
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: get-comment VORBIS COMMENT
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: get-error VORBIS
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: get-file-offset VORBIS
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: get-frame-float VORBIS CHANNELS OUTPUT
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: get-frame-short VORBIS CHANNEL BUFFERS LENGTH
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: get-frame-short-interleaved VORBIS CHANNEL BUFFER LENGTH
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: get-info VORBIS INFO
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: get-sample-offset VORBIS
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: get-samples-float VORBIS CHANNELS BUFFERS LENGTH
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: get-samples-float-interleaved VORBIS CHANNELS BUFFER LENGTH
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: get-samples-short VORBIS CHANNELS BUFFERS LENGTH
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: get-samples-short-interleaved VORBIS CHANNELS BUFFER LENGTH
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: handle INSTANCE

Returns the pointer to the underlying C handle.

See FILE

Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)

Writer

(setf handle) (function)

Function: (setf handle) VALUE INSTANCE
Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)

Reader

handle (function)

Function: info-channels POINTER-TO-INFO
Function: (setf info-channels) VALUE POINTER-TO-INFO
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: info-max-frame-size POINTER-TO-INFO
Function: (setf info-max-frame-size) VALUE POINTER-TO-INFO
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: info-samplerate POINTER-TO-INFO
Function: (setf info-samplerate) VALUE POINTER-TO-INFO
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: info-setup-memory-required POINTER-TO-INFO
Function: (setf info-setup-memory-required) VALUE POINTER-TO-INFO
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: info-setup-temp-memory-required POINTER-TO-INFO
Function: (setf info-setup-temp-memory-required) VALUE POINTER-TO-INFO
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: info-temp-memory-required POINTER-TO-INFO
Function: (setf info-temp-memory-required) VALUE POINTER-TO-INFO
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: init ()

Load the foreign library.

Automatically called by OPEN.

Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)

Function: max-frame-size INSTANCE

Returns the maximum size of a frame in bytes.

See FILE

Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)

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 (file)

Function: open-file FILE CLOSE-HANDLE-ON-CLOSE ERROR BUFFER
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

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 (file)

Function: open-file-section FILE CLOSE-HANDLE-ON-CLOSE ERROR BUFFER LENGTH
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: open-filename FILENAME ERROR BUFFER
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: open-memory DATA LENGTH ERROR BUFFER
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

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 (file)

Function: open-pushdata DATABLOCK LENGTH CONSUMED ERROR BUFFER
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

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 (file)

Function: sample-count FILE

Returns the number of samples total in the vorbis file.

See FILE

Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)

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 (file)

Writer

(setf sample-index) (function)

Function: (setf sample-index) INDEX FILE
Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)

Reader

sample-index (function)

Function: samplerate INSTANCE

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

See FILE

Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)

Function: seek VORBIS SAMPLE
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

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 (file)

Function: seek-frame VORBIS SAMPLE
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

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 (file)

Function: seek-start VORBIS
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: stream-length-in-samples VORBIS
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: stream-length-in-seconds VORBIS
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Function: vendor FILE

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

See FILE

Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Generic functions

Generic Function: code CONDITION

Returns the internal error code that produced the error.

See VORBIS-ERROR

Package

org.shirakumo.fraf.vorbis

Methods
Method: code (CONDITION vorbis-error)
Source

wrapper.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

Direct superclasses

warning (condition)

Condition: vorbis-error ()

Error signalled when a vorbis operation fails.

See CODE

Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)

Direct superclasses

error (condition)

Direct methods

code (method)

Direct slots
Slot: code
Initargs

:code

Readers

code (generic function)


Next: , Previous: , Up: Exported definitions   [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 (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: handle
Type

cffi-sys:foreign-pointer

Readers

handle (function)

Writers

(setf handle) (function)

Slot: channels
Type

(unsigned-byte 8)

Initform

0

Readers

channels (function)

Writers

(setf channels) (function)

Slot: samplerate
Type

(unsigned-byte 32)

Initform

0

Readers

samplerate (function)

Writers

(setf samplerate) (function)

Slot: max-frame-size
Type

(unsigned-byte 32)

Initform

0

Readers

max-frame-size (function)

Writers

(setf max-frame-size) (function)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.6 Classes

Class: buffer ()
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: comment ()
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: info ()
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)

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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *here*
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)

Special Variable: *static*
Package

org.shirakumo.fraf.vorbis.cffi

Source

low-level.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

Macro: with-pinned-buffer (PTR DATA &key OFFSET) &body BODY
Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: %make-file HANDLE CHANNELS SAMPLERATE MAX-FRAME-SIZE
Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)

Function: check-error ERROR
Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)

Function: check-file-for-error FILE
Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)

Function: make-file HANDLE ERROR
Package

org.shirakumo.fraf.vorbis

Source

wrapper.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-vorbis.asd: The cl-vorbis․asd file
cl-vorbis/documentation.lisp: The cl-vorbis/documentation․lisp file
cl-vorbis/low-level.lisp: The cl-vorbis/low-level․lisp file
cl-vorbis/package.lisp: The cl-vorbis/package․lisp file
cl-vorbis/wrapper.lisp: The cl-vorbis/wrapper․lisp file

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

L
Lisp File, cl-vorbis.asd: The cl-vorbis․asd file
Lisp File, cl-vorbis/documentation.lisp: The cl-vorbis/documentation․lisp file
Lisp File, cl-vorbis/low-level.lisp: The cl-vorbis/low-level․lisp file
Lisp File, cl-vorbis/package.lisp: The cl-vorbis/package․lisp file
Lisp File, cl-vorbis/wrapper.lisp: The cl-vorbis/wrapper․lisp file

Jump to:   C   F   L  

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: Internal functions

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

B
buffer-data: Exported functions
buffer-length: Exported functions

C
channels: Exported functions
check-error: Internal functions
check-file-for-error: Internal functions
close: Exported functions
close: Exported functions
code: Exported generic functions
code: Exported generic functions
comment-list: Exported functions
comment-list-length: Exported functions
comment-vendor: Exported functions
comments: Exported functions

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

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

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

H
handle: Exported functions

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

M
Macro, with-file: Exported macros
Macro, with-pinned-buffer: Internal macros
make-file: Internal functions
max-frame-size: Exported functions
Method, code: Exported generic functions

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

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

V
vendor: Exported functions

W
with-file: Exported macros
with-pinned-buffer: Internal macros

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

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

A.3 Variables

Jump to:   *  
C   H   M   S  
Index Entry  Section

*
*here*: Internal special variables
*static*: Internal special variables

C
channels: Exported structures
code: Exported conditions

H
handle: Exported structures

M
max-frame-size: Exported structures

S
samplerate: Exported structures
Slot, channels: Exported structures
Slot, code: Exported conditions
Slot, handle: Exported structures
Slot, max-frame-size: Exported structures
Slot, samplerate: Exported structures
Special Variable, *here*: Internal special variables
Special Variable, *static*: Internal special variables

Jump to:   *  
C   H   M   S  

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

A.4 Data types

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

B
buffer: Exported classes

C
cl-vorbis: The cl-vorbis system
Class, buffer: Exported classes
Class, comment: Exported classes
Class, info: Exported classes
comment: Exported classes
Condition, need-more-data: Exported conditions
Condition, vorbis-error: Exported conditions

F
file: Exported structures

I
info: Exported classes

N
need-more-data: Exported 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

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

V
vorbis-error: Exported conditions

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