wavelet-audio ยป API documentation

Conditions.
wavelet-audio-error
wavelet-audio error
    wavelet-audio-warning
    wavelet-audio warning
      wavelet-audio-frame-error
      wavelet-audio frame error, e.g. stream is out of sync
      • stream
        Allocationinstance
        Typenil
        Initarg:stream
        Readers(frame-error-stream)
      wavelet-audio-unknown-metadata
      Signaled when metadata type is unknown
      • metadata
        Allocationinstance
        Typenil
        Initarg:metadata
        Readers(unknown-metadata)
      Metadata and audio blocks.
      wavelet-audio-streaminfo
      Superclasses(wavelet-audio-metadata t)
      Metaclassstandard-class
      Default Initargs(:size 14 :type wavelet-audio::+metadata-streaminfo+)
      Stream info metadata.
      • version
        Stream version.
        Allocationinstance
        Type(wavelet-audio::ub 8)
        Initarg:version
        Initformwavelet-audio::+current-version+
        Accessors(streaminfo-version)
      • samplerate
        Sample rate in Hertz.
        Allocationinstance
        Type(wavelet-audio::ub 24)
        Initarg:samplerate
        Accessors(streaminfo-samplerate)
      • bps
        Bits per sample.
        Allocationinstance
        Type(wavelet-audio::ub 8)
        Initarg:bps
        Accessors(streaminfo-bps)
      • channels
        Number of channels.
        Allocationinstance
        Type(wavelet-audio::ub 8)
        Initarg:channels
        Accessors(streaminfo-channels)
      • samples
        Number of interchannel samples.
        Allocationinstance
        Type(wavelet-audio::ub 32)
        Initarg:samples
        Accessors(streaminfo-samples)
      • block-size
        Block size in samples.
        Allocationinstance
        Type(wavelet-audio::ub 16)
        Initarg:block-size
        Initformwavelet-audio:*block-size*
        Accessors(streaminfo-block-size)
      • skip-steps
        Number of the last steps of DWT to skip
        Allocationinstance
        Typewavelet-audio::skip-steps
        Initarg:skip-steps
        Initformwavelet-audio:*skip-steps*
        Accessors(streaminfo-skip-steps)
      • history-size
        History size for adaptive Rice coder
        Allocationinstance
        Type(wavelet-audio::ub 8)
        Initarg:history-size
        Initformwavelet-audio:*history-size*
        Accessors(streaminfo-history-size)
      wavelet-audio-block
      Superclasses(t)
      Metaclassstandard-class
      Default Initargsnil
      Audio block.
      • streaminfo
        streaminfo metadata block for this stream
        Allocationinstance
        Typewavelet-audio:wavelet-audio-streaminfo
        Initarg:streaminfo
        Accessors(block-streaminfo)
      • channels
        Channel buffers.
        Allocationinstance
        Typelist
        Initarg:channels
        Accessors(block-channels)
      • number
        Number of block in the stream.
        Allocationinstance
        Typewavelet-audio::non-negative-fixnum
        Initarg:number
        Initform0
        Accessors(block-number)
      Stream decoding.
      open-wavelet-audio(stream)
      Check if stream is wavelet audio stream and read metadata.
      read-block(stream streaminfo)
      Read block from previously opened stream stream. streaminfo metadata block must be given.
      decode-block(wa-block)
      Decode audio block.
      Stream encoding.
      write-wavelet-audio-header(stream metadata)
      Write identifier and metadata to the stream. This function must be called first to newly created stream.
      encode-block(streaminfo channels)
      Encode channels and return wavelet audio block ready for writing. NB: content of channels is destructively modified.
      write-block(stream wa-block)
      Write encoded block wa-block to the stream stream.
      Tunables.
      *block-size*
      Audio block size in samples.
      *history-size*
      History size for adaptive Rice coder
      *skip-steps*
      Number of the last DWT steps to skip
      No node with name *min-rice-parameter*.
      No node with name *max-rice-parameter*.