package.lisp

;;;; package.lisp - definition for the cl-patterns package.
;;; Note that additional exports are done in other files as well such as export.lisp.

(uiop:define-package #:cl-patterns
  (:use #:cl
        #:alexandria
        #:mutility)
  (:export

   ;;; utility.lisp

   #:*cl-patterns-temporary-directory*

   #:*event*
   #:*clock*
   #:eop

   #:note-name-and-octave

   #:multi-channel-funcall
   #:pyramid
   #:transpose
   #:next-beat-for-quant
   #:rerange

   #:tempo
   #:beat
   #:quant
   #:play-quant
   #:end-quant
   #:rest-p
   #:play
   #:launch
   #:stop
   #:end
   #:eop-p
   #:playing-p
   #:loop-p
   #:ended-p
   #:play-or-stop
   #:play-or-end
   #:play-solo
   #:play-swap
   #:all-instruments
   #:playing-nodes

   #:render

   ;;; conversions.lisp

   #:bipolar-unipolar
   #:unipolar-bipolar

   #:amp-db
   #:db-amp

   #:dur-time
   #:time-dur
   #:dur-freq
   #:freq-dur

   #:rate-freq
   #:freq-rate

   #:*c4-midinote*

   #:midinote-freq
   #:freq-midinote
   #:rate-midinote
   #:midinote-rate
   #:ratio-midi
   #:midi-ratio

   #:octave-freq
   #:freq-octave
   #:octave-midinote
   #:midinote-octave

   #:note-freq
   #:freq-note
   #:note-midinote
   #:midinote-note
   #:note-octave
   #:octave-note

   #:*note-names*
   #:chromatic-index-freq
   #:freq-chromatic-index
   #:chromatic-index-midinote
   #:midinote-chromatic-index
   #:chromatic-index-note
   #:note-chromatic-index

   #:degree-key

   #:degree-freq
   #:freq-degree
   #:degree-midinote
   #:midinote-degree
   #:degree-octave
   #:octave-degree
   #:degree-chromatic-index
   #:chromatic-index-degree
   #:degree-note
   #:note-degree

   #:midi-truncate-clamp
   #:bipolar-1-to-midi
   #:unipolar-1-to-midi
   #:frequency-to-midi

   ;;; scales.lisp

   #:note-number ; deprecated
   #:note-name ; deprecated

   #:tone-matrix

   #:define-tuning
   #:all-tunings
   #:tuning
   #:tuning-name
   #:tuning-pitches
   #:tuning-steps-per-octave
   #:tuning-octave-ratio

   #:load-scala-scale

   #:define-scale
   #:all-scales
   #:scale
   #:scale-name
   #:scale-notes
   #:scale-tuning
   #:scale-steps-per-octave
   #:scale-midinotes

   #:define-chord
   #:all-chords
   #:chord
   #:chord-name
   #:chord-scale
   #:chord-indexes
   #:chord-notes
   #:chord-midinotes

   ;;; event.lisp

   #:event
   #:event-p
   #:event-plist
   #:event-value
   #:remove-event-value
   #:e

   #:event-equal
   #:every-event-equal
   #:events-differing-keys
   #:events-lists-differing-keys
   #:combine-events
   #:copy-event
   #:split-event-by-lists
   #:combine-events-via-lists

   #:instrument

   #:amp
   #:db

   #:pan

   #:dur
   #:legato
   #:sustain
   #:delta

   #:freq
   #:midinote
   #:rate

   ;;; patterns.lisp
   ;; NOTE: patterns in `*patterns*' (such as those defined with `defpattern') are automatically exported in export.lisp.

   #:defpattern
   #:*max-pattern-yield-length*

   #:pattern
   #:pattern-p
   #:all-patterns

   #:pattern-parent
   #:parent-pattern ; deprecated
   #:parent-pbind ; deprecated
   #:pattern-children
   #:pstream-count
   #:pattern-metadata

   #:pstream-p
   #:as-pstream
   #:pattern-as-pstream

   #:t-pstream

   #:peek
   #:peek-n
   #:peek-upto-n
   #:next
   #:next-n
   #:next-upto-n

   #:pstream
   #:pstream-elt
   #:pstream-elt-future

   #:*post-pattern-output-processors*
   #:instrument-mapping

   #:bsubseq

   #:prest

   ;;; pdef.lisp

   #:pdef-p
   #:all-pdefs
   #:all-pdef-names
   #:playing-pdefs
   #:find-pdef
   #:pdef-name
   #:pdef-key
   #:pdef-pattern
   #:pdef-pstream
   #:pdef-task

   ;;; bjorklund.lisp

   #:bjorklund

   ;;; cycles.lisp

   ;;; track.lisp

   #:ptrack-rows
   #:ptrack-row
   #:ptrack-cell

   #:pt

   ;;; eseq.lisp

   #:eseq
   #:eseq-p
   #:eseq-events
   #:eseq-length
   #:eseq-add
   #:eseq-remove
   #:as-eseq
   #:eseq-pstream

   ;;; backend.lisp

   #:backend
   #:all-backend-types
   #:all-backends
   #:backend-p
   #:find-backend
   #:make-backend
   #:backend-start
   #:backend-stop

   ;; deprecated functions
   #:register-backend
   #:enable-backend
   #:disable-backend
   #:start-backend
   #:stop-backend
   #:enabled-backends

   ;;; clock.lisp

   #:task-pattern
   #:pattern-tasks

   #:make-clock
   #:clock-latency
   #:clock-tasks
   #:clock-process
   #:clock-condition-handler
   #:clock-caught-conditions

   #:*performance-mode*
   #:*performance-errors*

   #:clock-loop
   #:start-clock-loop)

  ;; we include this here so that all defined patterns are re-exported if we re-evaluate the define-package form
  #.(if (and (uiop:find-symbol* '*patterns* 'cl-patterns nil)
             (symbol-value (uiop:find-symbol* '*patterns* 'cl-patterns nil)))
        `(:export ,@(symbol-value (uiop:find-symbol* '*patterns* 'cl-patterns)))
        (values)))