File: dtmf.lisp

package info (click to toggle)
cl-cluck 0.1.3.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 72 kB
  • sloc: lisp: 247; makefile: 34
file content (217 lines) | stat: -rw-r--r-- 7,995 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
;;;; *************************************************************************
;;;; FILE IDENTIFICATION
;;;;
;;;; Name:          dtmf.lisp
;;;; Purpose:       Common Lisp DTMF (dual tone) wave generator
;;;; Programmer:    Kevin M. Rosenberg
;;;; Date Started:  June 2007
;;;;
;;;; Copyright (c) 2007 Kevin M. Rosenberg
;;;;
;;;; Redistribution and use in source and binary forms, with or without
;;;; modification, are permitted provided that the following conditions
;;;; are met:
;;;; 1. Redistributions of source code must retain the above copyright
;;;;    notice, this list of conditions and the following disclaimer.
;;;; 2. Redistributions in binary form must reproduce the above copyright
;;;;    notice, this list of conditions and the following disclaimer in the
;;;;    documentation and/or other materials provided with the distribution.
;;;; 3. Neither the name of the author nor the names of the contributors
;;;;    may be used to endorse or promote products derived from this software
;;;;    without specific prior written permission.
;;;;
;;;; THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
;;;; ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
;;;; IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
;;;; ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
;;;; FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
;;;; DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
;;;; OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
;;;; HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
;;;; LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
;;;; OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
;;;; SUCH DAMAGE.
;;;; *************************************************************************

(in-package #:cluck)

(defconstant +dtmf-tones+
  '(
    ;; keypad
    (1 . (1209 . 697))
    (2 . (1336 . 697))
    (3 . (1477 . 697))
    (A . (1633 . 697))
    (4 . (1209 . 770))
    (5 . (1336 . 770))
    (6 . (1477 . 770))
    (B . (1633 . 770))
    (7 . (1209 . 852))
    (8 . (1336 . 852))
    (9 . (1477 . 852))
    (C . (1633 . 852))
    (* . (1209 . 941))
    (0 . (1336 . 941))
    (\# . (1477 . 941))
    (D . (1633 . 941))

    ;; events
    (busy . (620 . 480))
    (dial-tone . (440 . 350))
    (ringback . (480 . 440))
    ))

(defun dtmf-ratios ()
  (let ((unsorted nil))
    (dolist (record +dtmf-tones+)
      (push (list (car record) (cddr record) (/ (cadr record) (cddr record)))
            unsorted))
    (sort unsorted (lambda (a b) (< (third a) (third b))))))

(defun print-dtmf-ratios (&optional (stream *standard-output*))
  (dolist (v (dtmf-ratios))
    (format stream "~A ~D ~6,4F~%" (first v) (second v) (third v))))

;; DTMF formula: f(t) = A(high)*sin(2*pi*f(high)*t) + A(low)*sin(2*pi*f(low)*t)
;; A(low) / A(high) between 0.7 and 0.9

(defun dtmf-waveform (key duration sample-freq
                      &key (min -1d0) (max 1d0) (element-type 'double-float)
                      &aux dtmf-record)
  "Returns the DTMF waveform of a key code for duration seconds
at a sample frequency of sample-freq. Waveform normalized to -1 to 1 output."
  (setq dtmf-record (get-alist key +dtmf-tones+))
  (unless dtmf-record (return-from dtmf-waveform nil))

  (let* ((period (/ 1D0 sample-freq))
         (samples (ceiling (* duration sample-freq)))
         (wave (make-array (list samples) :element-type 'double-float))
         (out-wave (make-array (list samples) :element-type element-type))
         (time 0D0)
         (amplitude-ratio 0.8D0)
         (raw-min 0D0)
         (raw-max 0D0)
         (raw-range 0D0)
         (range (coerce (- max min) 'double-float))
         (f-high 0D0)
         (f-low 0D0))
    (declare (double-float raw-min raw-max raw-range range
                           time amplitude-ratio f-high f-low))
    (setq f-high (* 2 pi (car dtmf-record)))
    (setq f-low (* 2 pi (cdr dtmf-record)))

    (dotimes (i samples)
      (declare (fixnum i))

      (let ((a (+ (sin (* time f-high))
                  (* amplitude-ratio (sin (* time f-low))))))
        (cond
          ((> a raw-max)
           (setq raw-max a))
          ((< a raw-min)
           (setq raw-min a)))

        (setf (aref wave i) a))
      (incf time period))

    (setq raw-range (- raw-max raw-min))
    (dotimes (i samples)
      (declare (fixnum i))
      (let ((scaled (+ (* range (/ (- (aref wave i) raw-min) raw-range)) min)))
        (when (subtypep element-type 'integer)
          (setq scaled (round scaled)))
        (setf (aref out-wave i) scaled)))
    out-wave))


(defun write-dtmf (file key duration sample-freq &key (delimiter #\tab)
                   &aux wave)
  (setq wave (dtmf-waveform key duration sample-freq))
  (unless wave (return-from write-dtmf nil))

  (with-open-file (os file :direction :output)
    (let ((period (/ 1D0 sample-freq))
          (time 0D0))
      (declare (double-float time period))

      (dotimes (i (length wave))
        (declare (fixnum i))
        (format os "~F~A~F~%" time delimiter (aref wave i))
        (incf time period)))))


;;; Functions optionally defined if supporting packages have already
;;; been loaded
;;;
;;; Functions requiring CL-WAV-SYNTH, used for it WAV file writing

(eval-when (:compile-toplevel :load-toplevel :execute)
  (when (find-package '#:cl-wav-synth)
    (pushnew :kmr-cl-wav-synth cl:*features*)))

#+:kmr-cl-wav-synth
(defun write-dtmf-wav (file key duration &key (sample-freq 8000)
                       (n-bits-per-sample 8)
                       &aux wave)
  (setq wave (dtmf-waveform key duration sample-freq
                            :min (ecase n-bits-per-sample
                                   (8 0)
                                   (16 -32768))
                            :max (ecase n-bits-per-sample
                                   (8 255)
                                   (16 32767))
                            :element-type (ecase n-bits-per-sample
                                            (8 '(unsigned-byte 8))
                                            (16  '(signed-byte 16)))))
  (unless wave (return-from write-dtmf-wav nil))

  (let ((sample (make-instance 'cl-wav-synth:sample
                               :n-channels 1
                               :n-bits-per-sample n-bits-per-sample
                               :n-samples-per-sec sample-freq
                               :data wave)))
    (cl-wav-synth::set-sample-info sample)
    (cl-wav-synth::set-total-byte-from-data sample)
    (cl-wav-synth::set-last-sample sample)
    (cl-wav-synth:write-sample file sample)
    sample))

(eval-when (:compile-toplevel :load-toplevel :execute)
  (when (find :kmr-cl-wav-synth cl:*features*)
    (setq cl:*features* (delete :kmr-cl-wav-synth cl:*features*))))


;;; Functions requiring CGN, a plotting package

(eval-when (:compile-toplevel :load-toplevel :execute)
  (when (find-package '#:cgn)
    (pushnew :kmr-cgn cl:*features*)))

#+:kmr-cgn
(defun plot-dtmf (key duration sample-freq &aux wave)
  (setq wave (dtmf-waveform key duration sample-freq))
  (unless wave (return-from plot-dtmf nil))

  (let ((period (/ 1D0 sample-freq))
        (x (make-list (length wave)))
        (y (make-list (length wave)))
        (time 0D0))
    (declare (double-float time period)
             (list x y))

    (dotimes (i (length wave))
      (declare (fixnum i))
      (setf (nth i x) time)
      (setf (nth i y) (aref wave i))
      (incf time period))

    (cgn:with-gnuplot ('linux)
      (cgn:set-range 'x 0 duration)
      (cgn:set-range 'y -1 1)
      (cgn:plot-points x y)
      )))

(eval-when (:compile-toplevel :load-toplevel :execute)
  (when (find :kmr-cgn cl:*features*)
    (setq cl:*features* (delete :kmr-cgn cl:*features*))))