The cl-opus Reference Manual

This is the cl-opus Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:20:32 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-opus

Bindings to libopusfile, a simple and free OGG/Opus decoding library

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

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

Source Control

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

Bug Tracker

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

License

zlib

Version

1.0.0

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

cl-opus.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cl-opus/cl-opus.asd

Source

cl-opus.asd.

Parent Component

cl-opus (system).

ASDF Systems

cl-opus.


3.1.2 cl-opus/package.lisp

Source

cl-opus.asd.

Parent Component

cl-opus (system).

Packages

3.1.3 cl-opus/low-level.lisp

Dependency

package.lisp (file).

Source

cl-opus.asd.

Parent Component

cl-opus (system).

Public Interface
Internals

3.1.4 cl-opus/wrapper.lisp

Dependency

low-level.lisp (file).

Source

cl-opus.asd.

Parent Component

cl-opus (system).

Public Interface
Internals

3.1.5 cl-opus/documentation.lisp

Dependency

wrapper.lisp (file).

Source

cl-opus.asd.

Parent Component

cl-opus (system).


4 Packages

Packages are listed by definition order.


4.1 org.shirakumo.fraf.opus

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

4.2 org.shirakumo.fraf.opus.cffi

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.


5.1 Public Interface


5.1.1 Macros

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

Open a file within a dynamic extent.

Automatically calls OPEN, and CLOSE on unwind.

See OPEN
see CLOSE
See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.


5.1.2 Ordinary functions

Function: bitrate (file &optional link)

Returns the bitrate of the (current) link.

See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: bitrate (file link-index)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: bitrate-instant (file)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: callbacks-close (pointer-to-callbacks)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf callbacks-close) (pointer-to-callbacks)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: callbacks-read (pointer-to-callbacks)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf callbacks-read) (pointer-to-callbacks)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: callbacks-seek (pointer-to-callbacks)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf callbacks-seek) (pointer-to-callbacks)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: callbacks-tell (pointer-to-callbacks)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf callbacks-tell) (pointer-to-callbacks)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: channel-count (file link-index)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: channels (file &optional link)

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)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: check-return (file return)

Checks whether the return value was valid or an error.

If valid, returns the value. Otherwise, signals an OPUS-ERROR.

See OPUS-ERROR (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: close (file)

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)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Reader: close-fun (instance)

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)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Target Slot

close-fun.

Writer: (setf close-fun) (instance)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Target Slot

close-fun.

Function: comments (file &optional link)

Returns a list of user comments contained in the file or link.

See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Returns the current link index.

See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

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

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)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

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

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)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: duration (file &optional link)

Returns the total duration in seconds of the file or link.

See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: fdopen (callbacks fd mode)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: fopen (callbacks path mode)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: free (file)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: freopen (callbacks path mode stream)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: gain (file &optional type)

Accesses the gain in dB of the file.

See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: (setf gain) (file &optional type)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: granule-sample (head granule-position)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Reader: handle (instance)

Returns the internal foreign pointer handle of the file.

See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Target Slot

handle.

Writer: (setf handle) (instance)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Target Slot

handle.

Function: head (file link-index)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: head-channel-count (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf head-channel-count) (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: head-coupled-count (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf head-coupled-count) (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: head-input-sample-rate (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf head-input-sample-rate) (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: head-mapping (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf head-mapping) (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: head-mapping-family (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf head-mapping-family) (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: head-output-gain (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf head-output-gain) (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: head-parse (head data length)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: head-pre-skip (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf head-pre-skip) (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: head-stream-count (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf head-stream-count) (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: head-version (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf head-version) (pointer-to-head)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: index (file)

Accesses the current sample (frame!) index.

See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: (setf index) (file)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Reader: index-fun (instance)

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)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Target Slot

index-fun.

Writer: (setf index-fun) (instance)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Target Slot

index-fun.

Function: init ()

Initialises the Opus API.

See SHUTDOWN

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: instant-bitrate (file)

Returns the bitrate between now and the last time this function was called.

See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Returns the total number of links in the file.

See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: mem-stream-create (callbacks data size)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: open (thing &rest initargs &key &allow-other-keys)

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)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: open-callback (read-fun &key seek-fun index-fun close-fun user-data initial-data initial-data-start initial-data-end)

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)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: open-callbacks (stream callbacks initial-data initial-bytes error)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: open-file (path &key)

Open a file from a filesystem PATH.

Automatically calls INIT.

See INIT
See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: open-file (path error)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: open-memory (data size error)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: open-pointer (ptr &key start end)

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)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

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

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)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: pcm-seek (file pcm-offset)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: pcm-tell (file)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: pcm-total (file link-index)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: picture-tag-clear (picture)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: picture-tag-colors (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf picture-tag-colors) (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: picture-tag-data (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf picture-tag-data) (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: picture-tag-depth (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf picture-tag-depth) (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: picture-tag-description (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf picture-tag-description) (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: picture-tag-format (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf picture-tag-format) (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: picture-tag-height (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf picture-tag-height) (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: picture-tag-init (picture)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: picture-tag-mime-type (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf picture-tag-mime-type) (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: picture-tag-parse (picture tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: picture-tag-type (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf picture-tag-type) (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: picture-tag-width (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf picture-tag-width) (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: raw-seek (file byte-offset)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: raw-tell (file)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: raw-total (file link-index)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: read (file pcm buffer-size link-index)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: read-float (file pcm buffer-size link-index)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Reader: read-fun (instance)

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)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Target Slot

read-fun.

Writer: (setf read-fun) (instance)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Target Slot

read-fun.

Function: read-stereo (file pcm buffer-size)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: read-stereo-float (file pcm buffer-size)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: sample-count (file &optional link)

Returns the total number of samples (frames!) in the file or link.

See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: samplerate (file)

Returns the samplerate of the file.

This is fixed to 48000 Hz.

See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: seek (file to &key by mode)

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)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Reader: seek-fun (instance)

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)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Target Slot

seek-fun.

Writer: (setf seek-fun) (instance)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Target Slot

seek-fun.

Function: seekable-p (file)

Returns whether the file is seekable or not.

See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: seekable-p (file)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: serial-number (file &optional link)

Returns the vendor serial number of the (current) link.

See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: serial-number (file link-index)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: server-info-bitrate-kbps (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf server-info-bitrate-kbps) (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: server-info-clear (server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: server-info-content-type (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf server-info-content-type) (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: server-info-description (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf server-info-description) (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: server-info-genre (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf server-info-genre) (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: server-info-init (server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: server-info-name (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf server-info-name) (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: server-info-public-p (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf server-info-public-p) (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

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

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

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

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: server-info-ssl-p (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf server-info-ssl-p) (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: server-info-url (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf server-info-url) (pointer-to-server-info)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: set-decode-callback (file function user)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: set-dither-enabled (file enabled)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: set-gain-offset (file gain-type offset-q8)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: shutdown ()

Closes the Opus API.

See INIT

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: tags (file link-index)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tags-add (tags tag value)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tags-add-comment (tags comment)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tags-clear (tags)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tags-comment-lengths (pointer-to-tags)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf tags-comment-lengths) (pointer-to-tags)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tags-comments (pointer-to-tags)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf tags-comments) (pointer-to-tags)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tags-copy (dst src)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tags-get-album-gain (tags gain-q8)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tags-get-binary-suffix (tags length)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tags-get-track-gain (tags gain-q8)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tags-init (tags)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tags-parse (tags data length)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tags-query (tags tag count)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tags-query-count (tags tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tags-set-binary-suffix (tags data length)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tags-user-comments (pointer-to-tags)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf tags-user-comments) (pointer-to-tags)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

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

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

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

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: test (head initial-data initial-bytes)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: test-callbacks (stream callbacks initial-data initial-bytes error)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: test-file (path error)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: test-memory (data size error)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: test-open (file)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: vendor (file &optional link)

Returns the vendor identification string of the file or link.

See FILE (type)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.


5.1.3 Generic functions

Generic Reader: code (condition)

Returns the error code returned by the failed API call.

See OPUS-ERROR

Package

org.shirakumo.fraf.opus.

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

wrapper.lisp.

Target Slot

code.

Generic Reader: file (condition)

Returns the FILE instance associated with the error, if any.

See FILE (type)
See OPUS-ERROR

Package

org.shirakumo.fraf.opus.

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

wrapper.lisp.

Target Slot

file.


5.1.4 Standalone methods

Method: describe-object ((file file) stream)
Source

wrapper.lisp.

Method: print-object ((file file) stream)
Source

wrapper.lisp.


5.1.5 Conditions

Condition: opus-error

Condition signalled on failed API calls.

See FILE
See CODE

Package

org.shirakumo.fraf.opus.

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.


5.1.6 Structures

Structure: file

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

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Direct superclasses

structure-object.

Direct methods
Direct slots
Slot: handle
Type

cffi-sys:foreign-pointer

Readers

handle.

Writers

(setf handle).

Slot: read-fun
Type

function

Initform

(constantly -1)

Readers

read-fun.

Writers

(setf read-fun).

Slot: seek-fun
Type

function

Initform

(constantly -1)

Readers

seek-fun.

Writers

(setf seek-fun).

Slot: index-fun
Type

function

Initform

(constantly -1)

Readers

index-fun.

Writers

(setf index-fun).

Slot: close-fun
Type

function

Initform

(constantly -1)

Readers

close-fun.

Writers

(setf close-fun).

Slot: user-data
Readers

user-data.

Writers

(setf user-data).


5.2 Internals


5.2.1 Special variables

Special Variable: *callback-counter*
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Special Variable: *callbacks*
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Special Variable: *here*
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Special Variable: *init*
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Special Variable: *static*
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.


5.2.2 Macros

Macro: define-callback (name retval args &body body)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

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

org.shirakumo.fraf.opus.

Source

wrapper.lisp.


5.2.3 Ordinary functions

Function: %make-file (handle &key read-fun seek-fun index-fun close-fun)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: copy-stream-wrapper (instance)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: make-file (handle error &rest args)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: make-stream-wrapper (stream offset)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: open-stream (stream &rest args &key initial-data initial-data-start initial-data-end)

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)

Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: picture-tag-data-length (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: (setf picture-tag-data-length) (pointer-to-picture-tag)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: stream-close (wrapper)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: stream-index (wrapper)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: stream-read (wrapper out bytes)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Function: stream-seek (wrapper offset whence)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Reader: stream-wrapper-offset (instance)
Writer: (setf stream-wrapper-offset) (instance)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Target Slot

offset.

Function: stream-wrapper-p (object)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Reader: stream-wrapper-stream (instance)
Writer: (setf stream-wrapper-stream) (instance)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Target Slot

stream.

Function: tag-compare (tag-name comment)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Function: tag-n-compare (tag-name tag-length comment)
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Reader: user-data (instance)
Writer: (setf user-data) (instance)
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Target Slot

user-data.


5.2.4 Structures

Structure: stream-wrapper
Package

org.shirakumo.fraf.opus.

Source

wrapper.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: stream
Package

common-lisp.

Type

stream

Readers

stream-wrapper-stream.

Writers

(setf stream-wrapper-stream).

Slot: offset
Type

(unsigned-byte 64)

Initform

0

Readers

stream-wrapper-offset.

Writers

(setf stream-wrapper-offset).


5.2.5 Classes

Class: callbacks-tclass
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

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

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: picture-tag-tclass
Package

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

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

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

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

org.shirakumo.fraf.opus.cffi.

Source

low-level.lisp.

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

Appendix A Indexes


A.1 Concepts


A.2 Functions

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

%
%make-file: Private ordinary functions

(
(setf callbacks-close): Public ordinary functions
(setf callbacks-read): Public ordinary functions
(setf callbacks-seek): Public ordinary functions
(setf callbacks-tell): Public ordinary functions
(setf close-fun): Public ordinary functions
(setf gain): Public ordinary functions
(setf handle): Public ordinary functions
(setf head-channel-count): Public ordinary functions
(setf head-coupled-count): Public ordinary functions
(setf head-input-sample-rate): Public ordinary functions
(setf head-mapping): Public ordinary functions
(setf head-mapping-family): Public ordinary functions
(setf head-output-gain): Public ordinary functions
(setf head-pre-skip): Public ordinary functions
(setf head-stream-count): Public ordinary functions
(setf head-version): Public ordinary functions
(setf index): Public ordinary functions
(setf index-fun): Public ordinary functions
(setf picture-tag-colors): Public ordinary functions
(setf picture-tag-data): Public ordinary functions
(setf picture-tag-data-length): Private ordinary functions
(setf picture-tag-depth): Public ordinary functions
(setf picture-tag-description): Public ordinary functions
(setf picture-tag-format): Public ordinary functions
(setf picture-tag-height): Public ordinary functions
(setf picture-tag-mime-type): Public ordinary functions
(setf picture-tag-type): Public ordinary functions
(setf picture-tag-width): Public ordinary functions
(setf read-fun): Public ordinary functions
(setf seek-fun): Public ordinary functions
(setf server-info-bitrate-kbps): Public ordinary functions
(setf server-info-content-type): Public ordinary functions
(setf server-info-description): Public ordinary functions
(setf server-info-genre): Public ordinary functions
(setf server-info-name): Public ordinary functions
(setf server-info-public-p): Public ordinary functions
(setf server-info-server): Public ordinary functions
(setf server-info-ssl-p): Public ordinary functions
(setf server-info-url): Public ordinary functions
(setf stream-wrapper-offset): Private ordinary functions
(setf stream-wrapper-stream): Private ordinary functions
(setf tags-comment-lengths): Public ordinary functions
(setf tags-comments): Public ordinary functions
(setf tags-user-comments): Public ordinary functions
(setf tags-vendor): Public ordinary functions
(setf user-data): Private ordinary functions

B
bitrate: Public ordinary functions
bitrate: Public ordinary functions
bitrate-instant: Public ordinary functions

C
callbacks-close: Public ordinary functions
callbacks-read: Public ordinary functions
callbacks-seek: Public ordinary functions
callbacks-tell: Public ordinary functions
channel-count: Public ordinary functions
channels: Public ordinary functions
check-return: Public ordinary functions
close: Public ordinary functions
close-fun: Public ordinary functions
code: Public generic functions
code: Public generic functions
comments: Public ordinary functions
copy-stream-wrapper: Private ordinary functions
current-link: Public ordinary functions
current-link: Public ordinary functions

D
decode-float: Public ordinary functions
decode-int16: Public ordinary functions
define-callback: Private macros
describe-object: Public standalone methods
duration: Public ordinary functions

F
fdopen: Public ordinary functions
file: Public generic functions
file: Public generic functions
fopen: Public ordinary functions
free: Public ordinary functions
freopen: Public ordinary functions
Function, %make-file: Private ordinary functions
Function, (setf callbacks-close): Public ordinary functions
Function, (setf callbacks-read): Public ordinary functions
Function, (setf callbacks-seek): Public ordinary functions
Function, (setf callbacks-tell): Public ordinary functions
Function, (setf close-fun): Public ordinary functions
Function, (setf gain): Public ordinary functions
Function, (setf handle): Public ordinary functions
Function, (setf head-channel-count): Public ordinary functions
Function, (setf head-coupled-count): Public ordinary functions
Function, (setf head-input-sample-rate): Public ordinary functions
Function, (setf head-mapping): Public ordinary functions
Function, (setf head-mapping-family): Public ordinary functions
Function, (setf head-output-gain): Public ordinary functions
Function, (setf head-pre-skip): Public ordinary functions
Function, (setf head-stream-count): Public ordinary functions
Function, (setf head-version): Public ordinary functions
Function, (setf index): Public ordinary functions
Function, (setf index-fun): Public ordinary functions
Function, (setf picture-tag-colors): Public ordinary functions
Function, (setf picture-tag-data): Public ordinary functions
Function, (setf picture-tag-data-length): Private ordinary functions
Function, (setf picture-tag-depth): Public ordinary functions
Function, (setf picture-tag-description): Public ordinary functions
Function, (setf picture-tag-format): Public ordinary functions
Function, (setf picture-tag-height): Public ordinary functions
Function, (setf picture-tag-mime-type): Public ordinary functions
Function, (setf picture-tag-type): Public ordinary functions
Function, (setf picture-tag-width): Public ordinary functions
Function, (setf read-fun): Public ordinary functions
Function, (setf seek-fun): Public ordinary functions
Function, (setf server-info-bitrate-kbps): Public ordinary functions
Function, (setf server-info-content-type): Public ordinary functions
Function, (setf server-info-description): Public ordinary functions
Function, (setf server-info-genre): Public ordinary functions
Function, (setf server-info-name): Public ordinary functions
Function, (setf server-info-public-p): Public ordinary functions
Function, (setf server-info-server): Public ordinary functions
Function, (setf server-info-ssl-p): Public ordinary functions
Function, (setf server-info-url): Public ordinary functions
Function, (setf stream-wrapper-offset): Private ordinary functions
Function, (setf stream-wrapper-stream): Private ordinary functions
Function, (setf tags-comment-lengths): Public ordinary functions
Function, (setf tags-comments): Public ordinary functions
Function, (setf tags-user-comments): Public ordinary functions
Function, (setf tags-vendor): Public ordinary functions
Function, (setf user-data): Private ordinary functions
Function, bitrate: Public ordinary functions
Function, bitrate: Public ordinary functions
Function, bitrate-instant: Public ordinary functions
Function, callbacks-close: Public ordinary functions
Function, callbacks-read: Public ordinary functions
Function, callbacks-seek: Public ordinary functions
Function, callbacks-tell: Public ordinary functions
Function, channel-count: Public ordinary functions
Function, channels: Public ordinary functions
Function, check-return: Public ordinary functions
Function, close: Public ordinary functions
Function, close-fun: Public ordinary functions
Function, comments: Public ordinary functions
Function, copy-stream-wrapper: Private ordinary functions
Function, current-link: Public ordinary functions
Function, current-link: Public ordinary functions
Function, decode-float: Public ordinary functions
Function, decode-int16: Public ordinary functions
Function, duration: Public ordinary functions
Function, fdopen: Public ordinary functions
Function, fopen: Public ordinary functions
Function, free: Public ordinary functions
Function, freopen: Public ordinary functions
Function, gain: Public ordinary functions
Function, granule-sample: Public ordinary functions
Function, handle: Public ordinary functions
Function, head: Public ordinary functions
Function, head-channel-count: Public ordinary functions
Function, head-coupled-count: Public ordinary functions
Function, head-input-sample-rate: Public ordinary functions
Function, head-mapping: Public ordinary functions
Function, head-mapping-family: Public ordinary functions
Function, head-output-gain: Public ordinary functions
Function, head-parse: Public ordinary functions
Function, head-pre-skip: Public ordinary functions
Function, head-stream-count: Public ordinary functions
Function, head-version: Public ordinary functions
Function, index: Public ordinary functions
Function, index-fun: Public ordinary functions
Function, init: Public ordinary functions
Function, instant-bitrate: Public ordinary functions
Function, link-count: Public ordinary functions
Function, link-count: Public ordinary functions
Function, make-file: Private ordinary functions
Function, make-stream-wrapper: Private ordinary functions
Function, mem-stream-create: Public ordinary functions
Function, open: Public ordinary functions
Function, open-callback: Public ordinary functions
Function, open-callbacks: Public ordinary functions
Function, open-file: Public ordinary functions
Function, open-file: Public ordinary functions
Function, open-memory: Public ordinary functions
Function, open-pointer: Public ordinary functions
Function, open-stream: Private ordinary functions
Function, open-vector: Public ordinary functions
Function, pcm-seek: Public ordinary functions
Function, pcm-tell: Public ordinary functions
Function, pcm-total: Public ordinary functions
Function, picture-tag-clear: Public ordinary functions
Function, picture-tag-colors: Public ordinary functions
Function, picture-tag-data: Public ordinary functions
Function, picture-tag-data-length: Private ordinary functions
Function, picture-tag-depth: Public ordinary functions
Function, picture-tag-description: Public ordinary functions
Function, picture-tag-format: Public ordinary functions
Function, picture-tag-height: Public ordinary functions
Function, picture-tag-init: Public ordinary functions
Function, picture-tag-mime-type: Public ordinary functions
Function, picture-tag-parse: Public ordinary functions
Function, picture-tag-type: Public ordinary functions
Function, picture-tag-width: Public ordinary functions
Function, raw-seek: Public ordinary functions
Function, raw-tell: Public ordinary functions
Function, raw-total: Public ordinary functions
Function, read: Public ordinary functions
Function, read-float: Public ordinary functions
Function, read-fun: Public ordinary functions
Function, read-stereo: Public ordinary functions
Function, read-stereo-float: Public ordinary functions
Function, sample-count: Public ordinary functions
Function, samplerate: Public ordinary functions
Function, seek: Public ordinary functions
Function, seek-fun: Public ordinary functions
Function, seekable-p: Public ordinary functions
Function, seekable-p: Public ordinary functions
Function, serial-number: Public ordinary functions
Function, serial-number: Public ordinary functions
Function, server-info-bitrate-kbps: Public ordinary functions
Function, server-info-clear: Public ordinary functions
Function, server-info-content-type: Public ordinary functions
Function, server-info-description: Public ordinary functions
Function, server-info-genre: Public ordinary functions
Function, server-info-init: Public ordinary functions
Function, server-info-name: Public ordinary functions
Function, server-info-public-p: Public ordinary functions
Function, server-info-server: Public ordinary functions
Function, server-info-ssl-p: Public ordinary functions
Function, server-info-url: Public ordinary functions
Function, set-decode-callback: Public ordinary functions
Function, set-dither-enabled: Public ordinary functions
Function, set-gain-offset: Public ordinary functions
Function, shutdown: Public ordinary functions
Function, stream-close: Private ordinary functions
Function, stream-index: Private ordinary functions
Function, stream-read: Private ordinary functions
Function, stream-seek: Private ordinary functions
Function, stream-wrapper-offset: Private ordinary functions
Function, stream-wrapper-p: Private ordinary functions
Function, stream-wrapper-stream: Private ordinary functions
Function, tag-compare: Private ordinary functions
Function, tag-n-compare: Private ordinary functions
Function, tags: Public ordinary functions
Function, tags-add: Public ordinary functions
Function, tags-add-comment: Public ordinary functions
Function, tags-clear: Public ordinary functions
Function, tags-comment-lengths: Public ordinary functions
Function, tags-comments: Public ordinary functions
Function, tags-copy: Public ordinary functions
Function, tags-get-album-gain: Public ordinary functions
Function, tags-get-binary-suffix: Public ordinary functions
Function, tags-get-track-gain: Public ordinary functions
Function, tags-init: Public ordinary functions
Function, tags-parse: Public ordinary functions
Function, tags-query: Public ordinary functions
Function, tags-query-count: Public ordinary functions
Function, tags-set-binary-suffix: Public ordinary functions
Function, tags-user-comments: Public ordinary functions
Function, tags-vendor: Public ordinary functions
Function, test: Public ordinary functions
Function, test-callbacks: Public ordinary functions
Function, test-file: Public ordinary functions
Function, test-memory: Public ordinary functions
Function, test-open: Public ordinary functions
Function, user-data: Private ordinary functions
Function, vendor: Public ordinary functions

G
gain: Public ordinary functions
Generic Function, code: Public generic functions
Generic Function, file: Public generic functions
granule-sample: Public ordinary functions

H
handle: Public ordinary functions
head: Public ordinary functions
head-channel-count: Public ordinary functions
head-coupled-count: Public ordinary functions
head-input-sample-rate: Public ordinary functions
head-mapping: Public ordinary functions
head-mapping-family: Public ordinary functions
head-output-gain: Public ordinary functions
head-parse: Public ordinary functions
head-pre-skip: Public ordinary functions
head-stream-count: Public ordinary functions
head-version: Public ordinary functions

I
index: Public ordinary functions
index-fun: Public ordinary functions
init: Public ordinary functions
instant-bitrate: Public ordinary functions

L
link-count: Public ordinary functions
link-count: Public ordinary functions

M
Macro, define-callback: Private macros
Macro, with-file: Public macros
Macro, with-pinned-buffer: Private macros
make-file: Private ordinary functions
make-stream-wrapper: Private ordinary functions
mem-stream-create: Public ordinary functions
Method, code: Public generic functions
Method, describe-object: Public standalone methods
Method, file: Public generic functions
Method, print-object: Public standalone methods

O
open: Public ordinary functions
open-callback: Public ordinary functions
open-callbacks: Public ordinary functions
open-file: Public ordinary functions
open-file: Public ordinary functions
open-memory: Public ordinary functions
open-pointer: Public ordinary functions
open-stream: Private ordinary functions
open-vector: Public ordinary functions

P
pcm-seek: Public ordinary functions
pcm-tell: Public ordinary functions
pcm-total: Public ordinary functions
picture-tag-clear: Public ordinary functions
picture-tag-colors: Public ordinary functions
picture-tag-data: Public ordinary functions
picture-tag-data-length: Private ordinary functions
picture-tag-depth: Public ordinary functions
picture-tag-description: Public ordinary functions
picture-tag-format: Public ordinary functions
picture-tag-height: Public ordinary functions
picture-tag-init: Public ordinary functions
picture-tag-mime-type: Public ordinary functions
picture-tag-parse: Public ordinary functions
picture-tag-type: Public ordinary functions
picture-tag-width: Public ordinary functions
print-object: Public standalone methods

R
raw-seek: Public ordinary functions
raw-tell: Public ordinary functions
raw-total: Public ordinary functions
read: Public ordinary functions
read-float: Public ordinary functions
read-fun: Public ordinary functions
read-stereo: Public ordinary functions
read-stereo-float: Public ordinary functions

S
sample-count: Public ordinary functions
samplerate: Public ordinary functions
seek: Public ordinary functions
seek-fun: Public ordinary functions
seekable-p: Public ordinary functions
seekable-p: Public ordinary functions
serial-number: Public ordinary functions
serial-number: Public ordinary functions
server-info-bitrate-kbps: Public ordinary functions
server-info-clear: Public ordinary functions
server-info-content-type: Public ordinary functions
server-info-description: Public ordinary functions
server-info-genre: Public ordinary functions
server-info-init: Public ordinary functions
server-info-name: Public ordinary functions
server-info-public-p: Public ordinary functions
server-info-server: Public ordinary functions
server-info-ssl-p: Public ordinary functions
server-info-url: Public ordinary functions
set-decode-callback: Public ordinary functions
set-dither-enabled: Public ordinary functions
set-gain-offset: Public ordinary functions
shutdown: Public ordinary functions
stream-close: Private ordinary functions
stream-index: Private ordinary functions
stream-read: Private ordinary functions
stream-seek: Private ordinary functions
stream-wrapper-offset: Private ordinary functions
stream-wrapper-p: Private ordinary functions
stream-wrapper-stream: Private ordinary functions

T
tag-compare: Private ordinary functions
tag-n-compare: Private ordinary functions
tags: Public ordinary functions
tags-add: Public ordinary functions
tags-add-comment: Public ordinary functions
tags-clear: Public ordinary functions
tags-comment-lengths: Public ordinary functions
tags-comments: Public ordinary functions
tags-copy: Public ordinary functions
tags-get-album-gain: Public ordinary functions
tags-get-binary-suffix: Public ordinary functions
tags-get-track-gain: Public ordinary functions
tags-init: Public ordinary functions
tags-parse: Public ordinary functions
tags-query: Public ordinary functions
tags-query-count: Public ordinary functions
tags-set-binary-suffix: Public ordinary functions
tags-user-comments: Public ordinary functions
tags-vendor: Public ordinary functions
test: Public ordinary functions
test-callbacks: Public ordinary functions
test-file: Public ordinary functions
test-memory: Public ordinary functions
test-open: Public ordinary functions

U
user-data: Private ordinary functions

V
vendor: Public ordinary functions

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


A.4 Data types

Jump to:   C   D   F   H   L   O   P   S   T   W  
Index Entry  Section

C
callbacks-tclass: Private classes
cl-opus: The cl-opus system
cl-opus.asd: The cl-opus/cl-opus․asd file
Class, callbacks-tclass: Private classes
Class, head-tclass: Private classes
Class, picture-tag-tclass: Private classes
Class, server-info-tclass: Private classes
Class, tags-tclass: Private classes
Condition, opus-error: Public conditions

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

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

H
head-tclass: Private classes

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

O
opus-error: Public conditions
org.shirakumo.fraf.opus: The org․shirakumo․fraf․opus package
org.shirakumo.fraf.opus.cffi: The org․shirakumo․fraf․opus․cffi package

P
Package, org.shirakumo.fraf.opus: The org․shirakumo․fraf․opus package
Package, org.shirakumo.fraf.opus.cffi: The org․shirakumo․fraf․opus․cffi package
package.lisp: The cl-opus/package․lisp file
picture-tag-tclass: Private classes

S
server-info-tclass: Private classes
stream-wrapper: Private structures
Structure, file: Public structures
Structure, stream-wrapper: Private structures
System, cl-opus: The cl-opus system

T
tags-tclass: Private classes

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