This is the bodge-sndfile Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 03:24:37 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
bodge-sndfileWrapper over libsndfile for cl-bodge system
Pavel Korolev
MIT
1.0.0
alexandria (system).
static-vectors (system).
cffi (system).
cffi-c-ref (system).
claw (system).
claw-utils (system).
bodge-libc-essentials (system).
packages.lisp (file).
claw.lisp (file).
sndfile.lisp (file).
spec (module).
sndfile-includes (module).
Modules are listed depth-first from the system components tree.
bodge-sndfile/specsndfile.lisp (file).
bodge-sndfile (system).
bodge-sndfile/sndfile-includesspec (module).
bodge-sndfile (system).
Files are sorted by type and then listed depth-first from the systems components trees.
bodge-sndfile/bodge-sndfile.asdbodge-sndfile/packages.lispbodge-sndfile/claw.lispbodge-sndfile/sndfile.lispbodge-sndfile/claw.lisppackages.lisp (file).
bodge-sndfile (system).
+ambisonic-b-format+ (special variable).
+ambisonic-none+ (special variable).
+c-calc-max-all-channels+ (special variable).
+c-calc-norm-max-all-channels+ (special variable).
+c-calc-norm-signal-max+ (special variable).
+c-calc-signal-max+ (special variable).
+c-file-truncate+ (special variable).
+c-get-broadcast-info+ (special variable).
+c-get-cart-info+ (special variable).
+c-get-channel-map-info+ (special variable).
+c-get-clipping+ (special variable).
+c-get-cue+ (special variable).
+c-get-cue-count+ (special variable).
+c-get-current-sf-info+ (special variable).
+c-get-dither-info+ (special variable).
+c-get-dither-info-count+ (special variable).
+c-get-embed-file-info+ (special variable).
+c-get-format-info+ (special variable).
+c-get-format-major+ (special variable).
+c-get-format-major-count+ (special variable).
+c-get-format-subtype+ (special variable).
+c-get-format-subtype-count+ (special variable).
+c-get-instrument+ (special variable).
+c-get-lib-version+ (special variable).
+c-get-log-info+ (special variable).
+c-get-loop-info+ (special variable).
+c-get-max-all-channels+ (special variable).
+c-get-norm-double+ (special variable).
+c-get-norm-float+ (special variable).
+c-get-original-samplerate+ (special variable).
+c-get-signal-max+ (special variable).
+c-get-simple-format+ (special variable).
+c-get-simple-format-count+ (special variable).
+c-raw-data-needs-endswap+ (special variable).
+c-rf64-auto-downgrade+ (special variable).
+c-set-add-dither-on-read+ (special variable).
+c-set-add-dither-on-write+ (special variable).
+c-set-add-header-pad-chunk+ (special variable).
+c-set-add-peak-chunk+ (special variable).
+c-set-broadcast-info+ (special variable).
+c-set-cart-info+ (special variable).
+c-set-channel-map-info+ (special variable).
+c-set-clipping+ (special variable).
+c-set-compression-level+ (special variable).
+c-set-cue+ (special variable).
+c-set-dither-on-read+ (special variable).
+c-set-dither-on-write+ (special variable).
+c-set-instrument+ (special variable).
+c-set-norm-double+ (special variable).
+c-set-norm-float+ (special variable).
+c-set-original-samplerate+ (special variable).
+c-set-raw-start-offset+ (special variable).
+c-set-scale-float-int-read+ (special variable).
+c-set-scale-int-float-write+ (special variable).
+c-set-update-header-auto+ (special variable).
+c-set-vbr-encoding-quality+ (special variable).
+c-test-ieee-float-replace+ (special variable).
+c-update-header-now+ (special variable).
+c-wavex-get-ambisonic+ (special variable).
+c-wavex-set-ambisonic+ (special variable).
+channel-map-ambisonic-b-w+ (special variable).
+channel-map-ambisonic-b-x+ (special variable).
+channel-map-ambisonic-b-y+ (special variable).
+channel-map-ambisonic-b-z+ (special variable).
+channel-map-center+ (special variable).
+channel-map-front-center+ (special variable).
+channel-map-front-left+ (special variable).
+channel-map-front-left-of-center+ (special variable).
+channel-map-front-right+ (special variable).
+channel-map-front-right-of-center+ (special variable).
+channel-map-invalid+ (special variable).
+channel-map-left+ (special variable).
+channel-map-lfe+ (special variable).
+channel-map-max+ (special variable).
+channel-map-mono+ (special variable).
+channel-map-rear-center+ (special variable).
+channel-map-rear-left+ (special variable).
+channel-map-rear-right+ (special variable).
+channel-map-right+ (special variable).
+channel-map-side-left+ (special variable).
+channel-map-side-right+ (special variable).
+channel-map-top-center+ (special variable).
+channel-map-top-front-center+ (special variable).
+channel-map-top-front-left+ (special variable).
+channel-map-top-front-right+ (special variable).
+channel-map-top-rear-center+ (special variable).
+channel-map-top-rear-left+ (special variable).
+channel-map-top-rear-right+ (special variable).
+count-max+ (special variable).
+d-custom-level+ (special variable).
+d-default-level+ (special variable).
+d-no-dither+ (special variable).
+d-triangular-pdf+ (special variable).
+d-white+ (special variable).
+endian-big+ (special variable).
+endian-cpu+ (special variable).
+endian-file+ (special variable).
+endian-little+ (special variable).
+err-malformed-file+ (special variable).
+err-no-error+ (special variable).
+err-system+ (special variable).
+err-unrecognised-format+ (special variable).
+err-unsupported-encoding+ (special variable).
+false+ (special variable).
+format-aiff+ (special variable).
+format-alac-16+ (special variable).
+format-alac-20+ (special variable).
+format-alac-24+ (special variable).
+format-alac-32+ (special variable).
+format-alaw+ (special variable).
+format-au+ (special variable).
+format-avr+ (special variable).
+format-caf+ (special variable).
+format-double+ (special variable).
+format-dpcm-16+ (special variable).
+format-dpcm-8+ (special variable).
+format-dwvw-12+ (special variable).
+format-dwvw-16+ (special variable).
+format-dwvw-24+ (special variable).
+format-dwvw-n+ (special variable).
+format-endmask+ (special variable).
+format-flac+ (special variable).
+format-float+ (special variable).
+format-g721-32+ (special variable).
+format-g723-24+ (special variable).
+format-g723-40+ (special variable).
+format-gsm610+ (special variable).
+format-htk+ (special variable).
+format-ima-adpcm+ (special variable).
+format-ircam+ (special variable).
+format-mat4+ (special variable).
+format-mat5+ (special variable).
+format-mpc2k+ (special variable).
+format-ms-adpcm+ (special variable).
+format-nist+ (special variable).
+format-nms-adpcm-16+ (special variable).
+format-nms-adpcm-24+ (special variable).
+format-nms-adpcm-32+ (special variable).
+format-ogg+ (special variable).
+format-opus+ (special variable).
+format-paf+ (special variable).
+format-pcm-16+ (special variable).
+format-pcm-24+ (special variable).
+format-pcm-32+ (special variable).
+format-pcm-s8+ (special variable).
+format-pcm-u8+ (special variable).
+format-pvf+ (special variable).
+format-raw+ (special variable).
+format-rf64+ (special variable).
+format-sd2+ (special variable).
+format-sds+ (special variable).
+format-submask+ (special variable).
+format-svx+ (special variable).
+format-typemask+ (special variable).
+format-ulaw+ (special variable).
+format-voc+ (special variable).
+format-vorbis+ (special variable).
+format-vox-adpcm+ (special variable).
+format-w64+ (special variable).
+format-wav+ (special variable).
+format-wavex+ (special variable).
+format-wve+ (special variable).
+format-xi+ (special variable).
+loop-alternating+ (special variable).
+loop-backward+ (special variable).
+loop-forward+ (special variable).
+loop-none+ (special variable).
+m-rdwr+ (special variable).
+m-read+ (special variable).
+m-write+ (special variable).
+seek-cur+ (special variable).
+seek-end+ (special variable).
+seek-set+ (special variable).
+str-album+ (special variable).
+str-artist+ (special variable).
+str-comment+ (special variable).
+str-copyright+ (special variable).
+str-date+ (special variable).
+str-first+ (special variable).
+str-genre+ (special variable).
+str-last+ (special variable).
+str-license+ (special variable).
+str-software+ (special variable).
+str-title+ (special variable).
+str-tracknumber+ (special variable).
+true+ (special variable).
close (function).
command (function).
current-byterate (function).
error (function).
error-number (function).
error-str (function).
format-check (function).
get-chunk-data (function).
get-chunk-iterator (function).
get-chunk-size (function).
get-string (function).
next-chunk-iterator (function).
open (function).
open-fd (function).
open-virtual (function).
perror (function).
read-double (function).
read-float (function).
read-int (function).
read-raw (function).
read-short (function).
readf-double (function).
readf-float (function).
readf-int (function).
readf-short (function).
seek (function).
set-chunk (function).
set-string (function).
strerror (function).
version-string (function).
write-double (function).
write-float (function).
write-int (function).
write-raw (function).
write-short (function).
write-sync (function).
writef-double (function).
writef-float (function).
writef-int (function).
writef-short (function).
bodge-sndfile/sndfile.lispclaw.lisp (file).
bodge-sndfile (system).
read-short-samples-into-array (function).
sound-channels (reader).
sound-format (reader).
sound-frames (reader).
sound-sample-rate (reader).
with-open-sound-file (macro).
with-sound-file-from-stream (macro).
write-short-samples-into-stream (function).
%catch-sound-errors (macro).
%make-sound-file (function).
%make-virtual-file (function).
copy-sound-file (function).
copy-virtual-file (function).
enlarge-virtual-file (function).
make-virtual-file (function).
make-virtual-file-from-stream (function).
make-virtual-io (function).
min-count (function).
parse-format (function).
replace-foreign-memory (function).
sound-file (structure).
sound-file-p (function).
sound-handle (reader).
static-vector-pointer (function).
update-max-position (function).
virtual-file (structure).
virtual-file-data (reader).
(setf virtual-file-data) (writer).
virtual-file-length (function).
virtual-file-max-position (reader).
(setf virtual-file-max-position) (writer).
virtual-file-p (function).
virtual-file-position (reader).
(setf virtual-file-position) (writer).
with-sound-file-handle (macro).
with-sound-info (macro).
with-virtual-io (macro).
Packages are listed by definition order.
sndfilesf
alexandria.
cffi-c-ref.
claw.
common-lisp.
read-short-samples-into-array (function).
sound-channels (reader).
sound-format (reader).
sound-frames (reader).
sound-sample-rate (reader).
with-open-sound-file (macro).
with-sound-file-from-stream (macro).
write-short-samples-into-stream (function).
%catch-sound-errors (macro).
%make-sound-file (function).
%make-virtual-file (function).
*virtual-file* (special variable).
copy-sound-file (function).
copy-virtual-file (function).
enlarge-virtual-file (function).
make-virtual-file (function).
make-virtual-file-from-stream (function).
make-virtual-io (function).
min-count (function).
parse-format (function).
replace-foreign-memory (function).
sound-file (structure).
sound-file-p (function).
sound-handle (reader).
static-vector-pointer (function).
update-max-position (function).
virtual-file (structure).
virtual-file-data (reader).
(setf virtual-file-data) (writer).
virtual-file-length (function).
virtual-file-max-position (reader).
(setf virtual-file-max-position) (writer).
virtual-file-p (function).
virtual-file-position (reader).
(setf virtual-file-position) (writer).
with-sound-file-handle (macro).
with-sound-info (macro).
with-virtual-io (macro).
%sndfile%sf
+ambisonic-b-format+ (special variable).
+ambisonic-none+ (special variable).
+c-calc-max-all-channels+ (special variable).
+c-calc-norm-max-all-channels+ (special variable).
+c-calc-norm-signal-max+ (special variable).
+c-calc-signal-max+ (special variable).
+c-file-truncate+ (special variable).
+c-get-broadcast-info+ (special variable).
+c-get-cart-info+ (special variable).
+c-get-channel-map-info+ (special variable).
+c-get-clipping+ (special variable).
+c-get-cue+ (special variable).
+c-get-cue-count+ (special variable).
+c-get-current-sf-info+ (special variable).
+c-get-dither-info+ (special variable).
+c-get-dither-info-count+ (special variable).
+c-get-embed-file-info+ (special variable).
+c-get-format-info+ (special variable).
+c-get-format-major+ (special variable).
+c-get-format-major-count+ (special variable).
+c-get-format-subtype+ (special variable).
+c-get-format-subtype-count+ (special variable).
+c-get-instrument+ (special variable).
+c-get-lib-version+ (special variable).
+c-get-log-info+ (special variable).
+c-get-loop-info+ (special variable).
+c-get-max-all-channels+ (special variable).
+c-get-norm-double+ (special variable).
+c-get-norm-float+ (special variable).
+c-get-original-samplerate+ (special variable).
+c-get-signal-max+ (special variable).
+c-get-simple-format+ (special variable).
+c-get-simple-format-count+ (special variable).
+c-raw-data-needs-endswap+ (special variable).
+c-rf64-auto-downgrade+ (special variable).
+c-set-add-dither-on-read+ (special variable).
+c-set-add-dither-on-write+ (special variable).
+c-set-add-header-pad-chunk+ (special variable).
+c-set-add-peak-chunk+ (special variable).
+c-set-broadcast-info+ (special variable).
+c-set-cart-info+ (special variable).
+c-set-channel-map-info+ (special variable).
+c-set-clipping+ (special variable).
+c-set-compression-level+ (special variable).
+c-set-cue+ (special variable).
+c-set-dither-on-read+ (special variable).
+c-set-dither-on-write+ (special variable).
+c-set-instrument+ (special variable).
+c-set-norm-double+ (special variable).
+c-set-norm-float+ (special variable).
+c-set-original-samplerate+ (special variable).
+c-set-raw-start-offset+ (special variable).
+c-set-scale-float-int-read+ (special variable).
+c-set-scale-int-float-write+ (special variable).
+c-set-update-header-auto+ (special variable).
+c-set-vbr-encoding-quality+ (special variable).
+c-test-ieee-float-replace+ (special variable).
+c-update-header-now+ (special variable).
+c-wavex-get-ambisonic+ (special variable).
+c-wavex-set-ambisonic+ (special variable).
+channel-map-ambisonic-b-w+ (special variable).
+channel-map-ambisonic-b-x+ (special variable).
+channel-map-ambisonic-b-y+ (special variable).
+channel-map-ambisonic-b-z+ (special variable).
+channel-map-center+ (special variable).
+channel-map-front-center+ (special variable).
+channel-map-front-left+ (special variable).
+channel-map-front-left-of-center+ (special variable).
+channel-map-front-right+ (special variable).
+channel-map-front-right-of-center+ (special variable).
+channel-map-invalid+ (special variable).
+channel-map-left+ (special variable).
+channel-map-lfe+ (special variable).
+channel-map-max+ (special variable).
+channel-map-mono+ (special variable).
+channel-map-rear-center+ (special variable).
+channel-map-rear-left+ (special variable).
+channel-map-rear-right+ (special variable).
+channel-map-right+ (special variable).
+channel-map-side-left+ (special variable).
+channel-map-side-right+ (special variable).
+channel-map-top-center+ (special variable).
+channel-map-top-front-center+ (special variable).
+channel-map-top-front-left+ (special variable).
+channel-map-top-front-right+ (special variable).
+channel-map-top-rear-center+ (special variable).
+channel-map-top-rear-left+ (special variable).
+channel-map-top-rear-right+ (special variable).
+count-max+ (special variable).
+d-custom-level+ (special variable).
+d-default-level+ (special variable).
+d-no-dither+ (special variable).
+d-triangular-pdf+ (special variable).
+d-white+ (special variable).
+endian-big+ (special variable).
+endian-cpu+ (special variable).
+endian-file+ (special variable).
+endian-little+ (special variable).
+err-malformed-file+ (special variable).
+err-no-error+ (special variable).
+err-system+ (special variable).
+err-unrecognised-format+ (special variable).
+err-unsupported-encoding+ (special variable).
+false+ (special variable).
+format-aiff+ (special variable).
+format-alac-16+ (special variable).
+format-alac-20+ (special variable).
+format-alac-24+ (special variable).
+format-alac-32+ (special variable).
+format-alaw+ (special variable).
+format-au+ (special variable).
+format-avr+ (special variable).
+format-caf+ (special variable).
+format-double+ (special variable).
+format-dpcm-16+ (special variable).
+format-dpcm-8+ (special variable).
+format-dwvw-12+ (special variable).
+format-dwvw-16+ (special variable).
+format-dwvw-24+ (special variable).
+format-dwvw-n+ (special variable).
+format-endmask+ (special variable).
+format-flac+ (special variable).
+format-float+ (special variable).
+format-g721-32+ (special variable).
+format-g723-24+ (special variable).
+format-g723-40+ (special variable).
+format-gsm610+ (special variable).
+format-htk+ (special variable).
+format-ima-adpcm+ (special variable).
+format-ircam+ (special variable).
+format-mat4+ (special variable).
+format-mat5+ (special variable).
+format-mpc2k+ (special variable).
+format-ms-adpcm+ (special variable).
+format-nist+ (special variable).
+format-nms-adpcm-16+ (special variable).
+format-nms-adpcm-24+ (special variable).
+format-nms-adpcm-32+ (special variable).
+format-ogg+ (special variable).
+format-opus+ (special variable).
+format-paf+ (special variable).
+format-pcm-16+ (special variable).
+format-pcm-24+ (special variable).
+format-pcm-32+ (special variable).
+format-pcm-s8+ (special variable).
+format-pcm-u8+ (special variable).
+format-pvf+ (special variable).
+format-raw+ (special variable).
+format-rf64+ (special variable).
+format-sd2+ (special variable).
+format-sds+ (special variable).
+format-submask+ (special variable).
+format-svx+ (special variable).
+format-typemask+ (special variable).
+format-ulaw+ (special variable).
+format-voc+ (special variable).
+format-vorbis+ (special variable).
+format-vox-adpcm+ (special variable).
+format-w64+ (special variable).
+format-wav+ (special variable).
+format-wavex+ (special variable).
+format-wve+ (special variable).
+format-xi+ (special variable).
+loop-alternating+ (special variable).
+loop-backward+ (special variable).
+loop-forward+ (special variable).
+loop-none+ (special variable).
+m-rdwr+ (special variable).
+m-read+ (special variable).
+m-write+ (special variable).
+seek-cur+ (special variable).
+seek-end+ (special variable).
+seek-set+ (special variable).
+str-album+ (special variable).
+str-artist+ (special variable).
+str-comment+ (special variable).
+str-copyright+ (special variable).
+str-date+ (special variable).
+str-first+ (special variable).
+str-genre+ (special variable).
+str-last+ (special variable).
+str-license+ (special variable).
+str-software+ (special variable).
+str-title+ (special variable).
+str-tracknumber+ (special variable).
+true+ (special variable).
close (function).
command (function).
current-byterate (function).
error (function).
error-number (function).
error-str (function).
format-check (function).
get-chunk-data (function).
get-chunk-iterator (function).
get-chunk-size (function).
get-string (function).
next-chunk-iterator (function).
open (function).
open-fd (function).
open-virtual (function).
perror (function).
read-double (function).
read-float (function).
read-int (function).
read-raw (function).
read-short (function).
readf-double (function).
readf-float (function).
readf-int (function).
readf-short (function).
seek (function).
set-chunk (function).
set-string (function).
strerror (function).
version-string (function).
write-double (function).
write-float (function).
write-int (function).
write-raw (function).
write-short (function).
write-sync (function).
writef-double (function).
writef-float (function).
writef-int (function).
writef-short (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
int sf_command(SNDFILE* sndfile, int command, void* data, int datasize);
int sf_current_byterate(SNDFILE* sndfile);
char* sf_error_number(int errnum);
int sf_error_str(SNDFILE* sndfile, char* str, size_t len);
int sf_format_check(SF_INFO* info);
int sf_get_chunk_data(SF_CHUNK_ITERATOR* it, SF_CHUNK_INFO* chunk_info);
SF_CHUNK_ITERATOR* sf_get_chunk_iterator(SNDFILE* sndfile, SF_CHUNK_INFO* chunk_info);
int sf_get_chunk_size(SF_CHUNK_ITERATOR* it, SF_CHUNK_INFO* chunk_info);
char* sf_get_string(SNDFILE* sndfile, int str_type);
SF_CHUNK_ITERATOR* sf_next_chunk_iterator(SF_CHUNK_ITERATOR* iterator);
SNDFILE* sf_open(char* path, int mode, SF_INFO* sfinfo);
SNDFILE* sf_open_fd(int fd, int mode, SF_INFO* sfinfo, int close_desc);
SNDFILE* sf_open_virtual(SF_VIRTUAL_IO* sfvirtual, int mode, SF_INFO* sfinfo, void* user_data);
sf_count_t sf_read_double(SNDFILE* sndfile, double* ptr, sf_count_t items);
sf_count_t sf_read_float(SNDFILE* sndfile, float* ptr, sf_count_t items);
sf_count_t sf_read_int(SNDFILE* sndfile, int* ptr, sf_count_t items);
sf_count_t sf_read_raw(SNDFILE* sndfile, void* ptr, sf_count_t bytes);
sf_count_t sf_read_short(SNDFILE* sndfile, short* ptr, sf_count_t items);
sf_count_t sf_readf_double(SNDFILE* sndfile, double* ptr, sf_count_t frames);
sf_count_t sf_readf_float(SNDFILE* sndfile, float* ptr, sf_count_t frames);
sf_count_t sf_readf_int(SNDFILE* sndfile, int* ptr, sf_count_t frames);
sf_count_t sf_readf_short(SNDFILE* sndfile, short* ptr, sf_count_t frames);
sf_count_t sf_seek(SNDFILE* sndfile, sf_count_t frames, int whence);
int sf_set_chunk(SNDFILE* sndfile, SF_CHUNK_INFO* chunk_info);
int sf_set_string(SNDFILE* sndfile, int str_type, char* str);
char* sf_strerror(SNDFILE* sndfile);
sf_count_t sf_write_double(SNDFILE* sndfile, double* ptr, sf_count_t items);
sf_count_t sf_write_float(SNDFILE* sndfile, float* ptr, sf_count_t items);
sf_count_t sf_write_int(SNDFILE* sndfile, int* ptr, sf_count_t items);
sf_count_t sf_write_raw(SNDFILE* sndfile, void* ptr, sf_count_t bytes);
sf_count_t sf_write_short(SNDFILE* sndfile, short* ptr, sf_count_t items);
void sf_write_sync(SNDFILE* sndfile);
sf_count_t sf_writef_double(SNDFILE* sndfile, double* ptr, sf_count_t frames);
sf_count_t sf_writef_float(SNDFILE* sndfile, float* ptr, sf_count_t frames);
sf_count_t sf_writef_int(SNDFILE* sndfile, int* ptr, sf_count_t frames);
sf_count_t sf_writef_short(SNDFILE* sndfile, short* ptr, sf_count_t frames);
data.
structure-object.
This slot is read-only.
fixnum
0
This slot is read-only.
fixnum
0
This slot is read-only.
fixnum
0
This slot is read-only.
common-lisp.
list
This slot is read-only.
structure-object.
(simple-array (unsigned-byte 8) (*))
(static-vectors:make-static-vector 0)
fixnum
0
common-lisp.
fixnum
0
| Jump to: | %
(
C E F G M N O P R S U V W |
|---|
| Jump to: | %
(
C E F G M N O P R S U V W |
|---|
| Jump to: | *
+
C D F H M P S |
|---|
| Jump to: | *
+
C D F H M P S |
|---|
| Jump to: | %
B C F M P S V |
|---|
| Jump to: | %
B C F M P S V |
|---|