cl opus
1.0.0Bindings to libopusfile, a simple and free OGG/Opus decoding library
About cl-opus
This library implements a wrapper library around opusfile to allow easy decoding of OGG/Opus sound files. Opus is a new codec providing better quality at lower decompression overhead and file size than other formats like Vorbis, AAC, or MP3.
How To
In order to use cl-opus, we'll assume a local nickname for org.shirakumo.fraf.opus called opus.
(opus:with-file (file #p"file.opus")
(describe file))
Please see the file entry for a reference to all the information you can retrieve about a file. Please also see the reference entry to open for the kinds of data sources cl-opus can decode from.
In order to decode samples, you can use decode-float or decode-int16.
(opus:with-file (file #p"file.opus")
(let ((samples (make-array (* 2 4096) :element-type 'single-float)))
(opus:decode-float file samples :stereo T)))You might also directly use the low-level functions in the org.shirakumo.fraf.opus.cffi package, using the handle of the file for its pointer representation.
Foreign Library
This library ships the required C library by default for the most common operating systems to make it easy to deploy. If you would like to compile the library yourself, please see the readme in the lib/ directory.
System Information
Definition Index
-
ORG.SHIRAKUMO.FRAF.OPUS.CFFI
No documentation provided.-
EXTERNAL FUNCTION BITRATE
- FILE
- LINK-INDEX
No documentation provided. -
EXTERNAL FUNCTION BITRATE-INSTANT
- FILE
No documentation provided. -
EXTERNAL FUNCTION CALLBACKS-CLOSE
- POINTER-TO-CALLBACKS
No documentation provided. -
EXTERNAL FUNCTION (SETF CALLBACKS-CLOSE)
- VALUE
- POINTER-TO-CALLBACKS
No documentation provided. -
EXTERNAL FUNCTION CALLBACKS-READ
- POINTER-TO-CALLBACKS
No documentation provided. -
EXTERNAL FUNCTION (SETF CALLBACKS-READ)
- VALUE
- POINTER-TO-CALLBACKS
No documentation provided. -
EXTERNAL FUNCTION CALLBACKS-SEEK
- POINTER-TO-CALLBACKS
No documentation provided. -
EXTERNAL FUNCTION (SETF CALLBACKS-SEEK)
- VALUE
- POINTER-TO-CALLBACKS
No documentation provided. -
EXTERNAL FUNCTION CALLBACKS-TELL
- POINTER-TO-CALLBACKS
No documentation provided. -
EXTERNAL FUNCTION (SETF CALLBACKS-TELL)
- VALUE
- POINTER-TO-CALLBACKS
No documentation provided. -
EXTERNAL FUNCTION CHANNEL-COUNT
- FILE
- LINK-INDEX
No documentation provided. -
EXTERNAL FUNCTION CURRENT-LINK
- FILE
No documentation provided. -
EXTERNAL FUNCTION FDOPEN
- CALLBACKS
- FD
- MODE
No documentation provided. -
EXTERNAL FUNCTION FOPEN
- CALLBACKS
- PATH
- MODE
No documentation provided. -
EXTERNAL FUNCTION FREE
- FILE
No documentation provided. -
EXTERNAL FUNCTION FREOPEN
- CALLBACKS
- PATH
- MODE
- STREAM
No documentation provided. -
EXTERNAL FUNCTION GRANULE-SAMPLE
- HEAD
- GRANULE-POSITION
No documentation provided. -
EXTERNAL FUNCTION HEAD
- FILE
- LINK-INDEX
No documentation provided. -
EXTERNAL FUNCTION HEAD-CHANNEL-COUNT
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION (SETF HEAD-CHANNEL-COUNT)
- VALUE
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION HEAD-COUPLED-COUNT
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION (SETF HEAD-COUPLED-COUNT)
- VALUE
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION HEAD-INPUT-SAMPLE-RATE
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION (SETF HEAD-INPUT-SAMPLE-RATE)
- VALUE
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION HEAD-MAPPING
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION (SETF HEAD-MAPPING)
- VALUE
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION HEAD-MAPPING-FAMILY
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION (SETF HEAD-MAPPING-FAMILY)
- VALUE
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION HEAD-OUTPUT-GAIN
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION (SETF HEAD-OUTPUT-GAIN)
- VALUE
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION HEAD-PARSE
- HEAD
- DATA
- LENGTH
No documentation provided. -
EXTERNAL FUNCTION HEAD-PRE-SKIP
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION (SETF HEAD-PRE-SKIP)
- VALUE
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION HEAD-STREAM-COUNT
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION (SETF HEAD-STREAM-COUNT)
- VALUE
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION HEAD-VERSION
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION (SETF HEAD-VERSION)
- VALUE
- POINTER-TO-HEAD
No documentation provided. -
EXTERNAL FUNCTION LINK-COUNT
- FILE
No documentation provided. -
EXTERNAL FUNCTION MEM-STREAM-CREATE
- CALLBACKS
- DATA
- SIZE
No documentation provided. -
EXTERNAL FUNCTION OPEN-CALLBACKS
- STREAM
- CALLBACKS
- INITIAL-DATA
- INITIAL-BYTES
- ERROR
No documentation provided. -
EXTERNAL FUNCTION OPEN-FILE
- PATH
- ERROR
No documentation provided. -
EXTERNAL FUNCTION OPEN-MEMORY
- DATA
- SIZE
- ERROR
No documentation provided. -
EXTERNAL FUNCTION PCM-SEEK
- FILE
- PCM-OFFSET
No documentation provided. -
EXTERNAL FUNCTION PCM-TELL
- FILE
No documentation provided. -
EXTERNAL FUNCTION PCM-TOTAL
- FILE
- LINK-INDEX
No documentation provided. -
EXTERNAL FUNCTION PICTURE-TAG-CLEAR
- PICTURE
No documentation provided. -
EXTERNAL FUNCTION PICTURE-TAG-COLORS
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION (SETF PICTURE-TAG-COLORS)
- VALUE
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION PICTURE-TAG-DATA
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION (SETF PICTURE-TAG-DATA)
- VALUE
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION PICTURE-TAG-DEPTH
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION (SETF PICTURE-TAG-DEPTH)
- VALUE
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION PICTURE-TAG-DESCRIPTION
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION (SETF PICTURE-TAG-DESCRIPTION)
- VALUE
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION PICTURE-TAG-FORMAT
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION (SETF PICTURE-TAG-FORMAT)
- VALUE
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION PICTURE-TAG-HEIGHT
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION (SETF PICTURE-TAG-HEIGHT)
- VALUE
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION PICTURE-TAG-INIT
- PICTURE
No documentation provided. -
EXTERNAL FUNCTION PICTURE-TAG-MIME-TYPE
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION (SETF PICTURE-TAG-MIME-TYPE)
- VALUE
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION PICTURE-TAG-PARSE
- PICTURE
- TAG
No documentation provided. -
EXTERNAL FUNCTION PICTURE-TAG-TYPE
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION (SETF PICTURE-TAG-TYPE)
- VALUE
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION PICTURE-TAG-WIDTH
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION (SETF PICTURE-TAG-WIDTH)
- VALUE
- POINTER-TO-PICTURE-TAG
No documentation provided. -
EXTERNAL FUNCTION RAW-SEEK
- FILE
- BYTE-OFFSET
No documentation provided. -
EXTERNAL FUNCTION RAW-TELL
- FILE
No documentation provided. -
EXTERNAL FUNCTION RAW-TOTAL
- FILE
- LINK-INDEX
No documentation provided. -
EXTERNAL FUNCTION READ
- FILE
- PCM
- BUFFER-SIZE
- LINK-INDEX
No documentation provided. -
EXTERNAL FUNCTION READ-FLOAT
- FILE
- PCM
- BUFFER-SIZE
- LINK-INDEX
No documentation provided. -
EXTERNAL FUNCTION READ-STEREO
- FILE
- PCM
- BUFFER-SIZE
No documentation provided. -
EXTERNAL FUNCTION READ-STEREO-FLOAT
- FILE
- PCM
- BUFFER-SIZE
No documentation provided. -
EXTERNAL FUNCTION SEEKABLE-P
- FILE
No documentation provided. -
EXTERNAL FUNCTION SERIAL-NUMBER
- FILE
- LINK-INDEX
No documentation provided. -
EXTERNAL FUNCTION SERVER-INFO-BITRATE-KBPS
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION (SETF SERVER-INFO-BITRATE-KBPS)
- VALUE
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION SERVER-INFO-CLEAR
- SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION SERVER-INFO-CONTENT-TYPE
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION (SETF SERVER-INFO-CONTENT-TYPE)
- VALUE
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION SERVER-INFO-DESCRIPTION
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION (SETF SERVER-INFO-DESCRIPTION)
- VALUE
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION SERVER-INFO-GENRE
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION (SETF SERVER-INFO-GENRE)
- VALUE
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION SERVER-INFO-INIT
- SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION SERVER-INFO-NAME
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION (SETF SERVER-INFO-NAME)
- VALUE
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION SERVER-INFO-PUBLIC-P
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION (SETF SERVER-INFO-PUBLIC-P)
- VALUE
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION SERVER-INFO-SERVER
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION (SETF SERVER-INFO-SERVER)
- VALUE
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION SERVER-INFO-SSL-P
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION (SETF SERVER-INFO-SSL-P)
- VALUE
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION SERVER-INFO-URL
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION (SETF SERVER-INFO-URL)
- VALUE
- POINTER-TO-SERVER-INFO
No documentation provided. -
EXTERNAL FUNCTION SET-DECODE-CALLBACK
- FILE
- FUNCTION
- USER
No documentation provided. -
EXTERNAL FUNCTION SET-DITHER-ENABLED
- FILE
- ENABLED
No documentation provided. -
EXTERNAL FUNCTION SET-GAIN-OFFSET
- FILE
- GAIN-TYPE
- OFFSET-Q8
No documentation provided. -
EXTERNAL FUNCTION TAGS
- FILE
- LINK-INDEX
No documentation provided. -
EXTERNAL FUNCTION TAGS-ADD
- TAGS
- TAG
- VALUE
No documentation provided. -
EXTERNAL FUNCTION TAGS-ADD-COMMENT
- TAGS
- COMMENT
No documentation provided. -
EXTERNAL FUNCTION TAGS-CLEAR
- TAGS
No documentation provided. -
EXTERNAL FUNCTION TAGS-COMMENT-LENGTHS
- POINTER-TO-TAGS
No documentation provided. -
EXTERNAL FUNCTION (SETF TAGS-COMMENT-LENGTHS)
- VALUE
- POINTER-TO-TAGS
No documentation provided. -
EXTERNAL FUNCTION TAGS-COMMENTS
- POINTER-TO-TAGS
No documentation provided. -
EXTERNAL FUNCTION (SETF TAGS-COMMENTS)
- VALUE
- POINTER-TO-TAGS
No documentation provided. -
EXTERNAL FUNCTION TAGS-COPY
- DST
- SRC
No documentation provided. -
EXTERNAL FUNCTION TAGS-GET-ALBUM-GAIN
- TAGS
- GAIN-Q8
No documentation provided. -
EXTERNAL FUNCTION TAGS-GET-BINARY-SUFFIX
- TAGS
- LENGTH
No documentation provided. -
EXTERNAL FUNCTION TAGS-GET-TRACK-GAIN
- TAGS
- GAIN-Q8
No documentation provided. -
EXTERNAL FUNCTION TAGS-INIT
- TAGS
No documentation provided. -
EXTERNAL FUNCTION TAGS-PARSE
- TAGS
- DATA
- LENGTH
No documentation provided. -
EXTERNAL FUNCTION TAGS-QUERY
- TAGS
- TAG
- COUNT
No documentation provided. -
EXTERNAL FUNCTION TAGS-QUERY-COUNT
- TAGS
- TAG
No documentation provided. -
EXTERNAL FUNCTION TAGS-SET-BINARY-SUFFIX
- TAGS
- DATA
- LENGTH
No documentation provided. -
EXTERNAL FUNCTION TAGS-USER-COMMENTS
- POINTER-TO-TAGS
No documentation provided. -
EXTERNAL FUNCTION (SETF TAGS-USER-COMMENTS)
- VALUE
- POINTER-TO-TAGS
No documentation provided. -
EXTERNAL FUNCTION TAGS-VENDOR
- POINTER-TO-TAGS
No documentation provided. -
EXTERNAL FUNCTION (SETF TAGS-VENDOR)
- VALUE
- POINTER-TO-TAGS
No documentation provided. -
EXTERNAL FUNCTION TEST
- HEAD
- INITIAL-DATA
- INITIAL-BYTES
No documentation provided. -
EXTERNAL FUNCTION TEST-CALLBACKS
- STREAM
- CALLBACKS
- INITIAL-DATA
- INITIAL-BYTES
- ERROR
No documentation provided. -
EXTERNAL FUNCTION TEST-FILE
- PATH
- ERROR
No documentation provided. -
EXTERNAL FUNCTION TEST-MEMORY
- DATA
- SIZE
- ERROR
No documentation provided. -
EXTERNAL FUNCTION TEST-OPEN
- FILE
No documentation provided.
-
-
ORG.SHIRAKUMO.FRAF.OPUS
No documentation provided.-
EXTERNAL CONDITION OPUS-ERROR
-
EXTERNAL 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
-
EXTERNAL FUNCTION BITRATE
- FILE
- &OPTIONAL
- LINK
Returns the bitrate of the (current) link. See FILE (type)
-
EXTERNAL 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) -
EXTERNAL 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)
-
EXTERNAL 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)
-
EXTERNAL FUNCTION 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)
-
EXTERNAL FUNCTION (SETF CLOSE-FUN)
- VALUE
- INSTANCE
No documentation provided. -
EXTERNAL FUNCTION COMMENTS
- FILE
- &OPTIONAL
- LINK
Returns a list of user comments contained in the file or link. See FILE (type)
-
EXTERNAL FUNCTION CURRENT-LINK
- FILE
Returns the current link index. See FILE (type)
-
EXTERNAL 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)
-
EXTERNAL 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)
-
EXTERNAL FUNCTION DURATION
- FILE
- &OPTIONAL
- LINK
Returns the total duration in seconds of the file or link. See FILE (type)
-
EXTERNAL FUNCTION GAIN
- FILE
- &OPTIONAL
- TYPE
Accesses the gain in dB of the file. See FILE (type)
-
EXTERNAL FUNCTION (SETF GAIN)
- GAIN
- FILE
- &OPTIONAL
- TYPE
No documentation provided. -
EXTERNAL FUNCTION HANDLE
- INSTANCE
Returns the internal foreign pointer handle of the file. See FILE (type)
-
EXTERNAL FUNCTION (SETF HANDLE)
- VALUE
- INSTANCE
No documentation provided. -
EXTERNAL FUNCTION INDEX
- FILE
Accesses the current sample (frame!) index. See FILE (type)
-
EXTERNAL FUNCTION (SETF INDEX)
- INDEX
- FILE
No documentation provided. -
EXTERNAL FUNCTION 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)
-
EXTERNAL FUNCTION (SETF INDEX-FUN)
- VALUE
- INSTANCE
No documentation provided. -
EXTERNAL FUNCTION INIT
Initialises the Opus API. See SHUTDOWN
-
EXTERNAL FUNCTION INSTANT-BITRATE
- FILE
Returns the bitrate between now and the last time this function was called. See FILE (type)
-
EXTERNAL FUNCTION LINK-COUNT
- FILE
Returns the total number of links in the file. See FILE (type)
-
EXTERNAL 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)
-
EXTERNAL 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)
-
EXTERNAL FUNCTION OPEN-FILE
- PATH
- &KEY
Open a file from a filesystem PATH. Automatically calls INIT. See INIT See FILE (type)
-
EXTERNAL 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)
-
EXTERNAL 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)
-
EXTERNAL FUNCTION 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)
-
EXTERNAL FUNCTION (SETF READ-FUN)
- VALUE
- INSTANCE
No documentation provided. -
EXTERNAL FUNCTION SAMPLE-COUNT
- FILE
- &OPTIONAL
- LINK
Returns the total number of samples (frames!) in the file or link. See FILE (type)
-
EXTERNAL FUNCTION SAMPLERATE
- FILE
Returns the samplerate of the file. This is fixed to 48000 Hz. See FILE (type)
-
EXTERNAL 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) -
EXTERNAL FUNCTION 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) -
EXTERNAL FUNCTION (SETF SEEK-FUN)
- VALUE
- INSTANCE
No documentation provided. -
EXTERNAL FUNCTION SEEKABLE-P
- FILE
Returns whether the file is seekable or not. See FILE (type)
-
EXTERNAL FUNCTION SERIAL-NUMBER
- FILE
- &OPTIONAL
- LINK
Returns the vendor serial number of the (current) link. See FILE (type)
-
EXTERNAL FUNCTION SHUTDOWN
Closes the Opus API. See INIT
-
EXTERNAL FUNCTION VENDOR
- FILE
- &OPTIONAL
- LINK
Returns the vendor identification string of the file or link. See FILE (type)
-
EXTERNAL GENERIC-FUNCTION CODE
- CONDITION
Returns the error code returned by the failed API call. See OPUS-ERROR
-
EXTERNAL GENERIC-FUNCTION FILE
- CONDITION
Returns the FILE instance associated with the error, if any. See FILE (type) See OPUS-ERROR
-
EXTERNAL 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)
-
EXTERNAL SOURCE-TRANSFORM CLOSE-FUN
No documentation provided. -
EXTERNAL SOURCE-TRANSFORM (SETF CLOSE-FUN)
No documentation provided. -
EXTERNAL SOURCE-TRANSFORM HANDLE
No documentation provided. -
EXTERNAL SOURCE-TRANSFORM (SETF HANDLE)
No documentation provided. -
EXTERNAL SOURCE-TRANSFORM INDEX-FUN
No documentation provided. -
EXTERNAL SOURCE-TRANSFORM (SETF INDEX-FUN)
No documentation provided. -
EXTERNAL SOURCE-TRANSFORM READ-FUN
No documentation provided. -
EXTERNAL SOURCE-TRANSFORM (SETF READ-FUN)
No documentation provided. -
EXTERNAL SOURCE-TRANSFORM SEEK-FUN
No documentation provided. -
EXTERNAL SOURCE-TRANSFORM (SETF SEEK-FUN)
No documentation provided.
-