Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-flac Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 03:45:05 2022 GMT+0.
Next: Systems, Previous: The cl-flac Reference Manual, Up: The cl-flac Reference Manual [Contents][Index]
This is a bindings library to libflac, a simple library for decoding FLAC files.
Precompiled versions of the underlying library are included in this. If you want to build it manually however, refer to the libflac page.
Load the system through ASDF or Quicklisp:
(ql:quickload :cl-flac)
Create a new file object:
(defvar *file* (cl-flac:make-file #p"~/my-cool-music.flac"))
You can query the file information with samplerate, channels, sample-count, frame-count, and bits-per-sample.
Reading samples from the file happens with read-directly, read-into-vector, or read-to-vector. A basic playback loop could look like this:
(loop with buffer = (make-array 512 :element-type 'single-float)
for samples = (cl-flac:read-into-vector *file* buffer)
until (= 0 samples)
do (process-buffer-somehow buffer))
When you're done with the file, you can either just let it be GCd or close it explicitly with close-file.
A complete test that allows you to play back a flac file is included in test.lisp
Next: Files, Previous: Introduction, Up: The cl-flac Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Bindings to libflac, a simple FLAC decoding library
Nicolas Hafner <shinmera@tymoon.eu>
Nicolas Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shirakumo/cl-flac.git)
zlib
1.0.0
Next: Packages, Previous: Systems, Up: The cl-flac Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: cl-flac/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
cl-flac (system).
Next: cl-flac/low-level.lisp, Previous: cl-flac/cl-flac.asd, Up: Lisp [Contents][Index]
cl-flac (system).
Next: cl-flac/wrapper.lisp, Previous: cl-flac/package.lisp, Up: Lisp [Contents][Index]
package.lisp (file).
cl-flac (system).
Next: cl-flac/documentation.lisp, Previous: cl-flac/low-level.lisp, Up: Lisp [Contents][Index]
low-level.lisp (file).
cl-flac (system).
Previous: cl-flac/wrapper.lisp, Up: Lisp [Contents][Index]
wrapper.lisp (file).
cl-flac (system).
Next: Definitions, Previous: Files, Up: The cl-flac Reference Manual [Contents][Index]
Packages are listed by definition order.
org.shirakumo.fraf.flac.cffi
Previous: cl-flac-cffi, Up: Packages [Contents][Index]
org.shirakumo.fraf.flac
common-lisp.
Next: Indexes, Previous: Packages, Up: The cl-flac Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Standalone methods, Previous: Public Interface, Up: Public Interface [Contents][Index]
Returns the number of bits per sample as encoded in the file.
See FILE
Returns the number of channels that the file encodes.
See FILE
Explicitly close the file.
Note that this will render the instance useless.
See FILE
Returns the number of frames stored in the file.
This is the number of samples divided by the number
of channels, this giving the number of frames.
See SAMPLE-COUNT
See FILE
Accessor to the handle for the underlying C data of the FLAC file.
See FILE
Create a new FLAC file from the given path.
If the path is not accessible, or the file is malformatted,
an error is signalled.
See FILE
Directly decode samples from the file into the buffer.
BUFFER-SIZE is in number of bytes, but must be aligned
with the sample size. The buffer is filled with 32-bit
float samples.
Returns the number of bytes successfully read. If this
number is lower than the requested amount, the file has
reached its end.
See FILE
Decode samples into the vector.
The vector must have an element-type of either SINGLE-FLOAT, (SIGNED-BYTE 16), or (SIGNED-BYTE 32).
Returned is the number of samples that were actually
decoded, as that might be lower than the requested
amount if the file does not contain enough samples
anymore.
See FILE
Reads the given number of samples into a single-float vector.
Returns the vector and the number of samples that were
actually decoded.
See READ-INTO-VECTOR
See FILE
Returns the total number of samples stored in the file.
See FRAME-COUNT
See FILE
Returns the samplerate of the file in Hertz.
See FILE
Seek to the requested frame.
Returns the file on success, signals a condition on
failure.
See FILE
Next: Structures, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
Previous: Standalone methods, Up: Public Interface [Contents][Index]
Container for the FLAC file.
Note that you do not need to explicitly close the file.
It will automatically clean up when this instance is
garbage collected.
See MAKE-FILE
See CLOSE-FILE
See HANDLE
See PATH
See CHANNELS
See SAMPLERATE
See BITS-PER-SAMPLE
See SAMPLE-COUNT
See FRAME-COUNT
See READ-DIRECTLY
See READ-INTO-VECTOR
See READ-TO-VECTOR
See SEEK
structure-object.
cffi-sys:foreign-pointer
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]
Defines a wrapper function that just returns what the inner C function returns.
Checks the returned code for error-ness and signals a condition if applicable.
See FLAC-ERROR
Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]
Returns the path namestring that was used to read the file.
See FILE
path.
Next: Conditions, Previous: Ordinary functions, Up: Internals [Contents][Index]
Returns the error code encapsulated in the condition.
See FLAC-ERROR
code.
code.
Previous: Generic functions, Up: Internals [Contents][Index]
This condition is signalled when an error in the underlying library is detected.
See CODE
Previous: Definitions, Up: The cl-flac Reference Manual [Contents][Index]
| Jump to: | %
(
B C D F G H M O P R S W |
|---|
| Jump to: | %
(
B C D F G H M O P R S W |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
| Jump to: | *
C H P S |
|---|
| Jump to: | *
C H P S |
|---|
| Jump to: | C D F L P S W |
|---|
| Jump to: | C D F L P S W |
|---|