ab7274c2c4be8de23c0566242cbd1b71a10a3785
[asterisk/asterisk.git] / include / asterisk / vmodem.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Voice Modem Definitions
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #ifndef _ASTERISK_VMODEM_H
15 #define _ASTERISK_VMODEM_H
16
17 #include <asterisk/frame.h>
18 #include <asterisk/channel.h>
19
20 #define CHAR_DLE                0x10
21 #define CHAR_ETX                0x03
22 #define CHAR_DC4                0x14
23
24 #define MODEM_DEV_TELCO         0
25 #define MODEM_DEV_TELCO_SPK     4
26 #define MODEM_DEV_SPKRPHONE     6
27 #define MODEM_DEV_HANDSET       9
28
29 /* Thirty millisecond sections */
30 #define MODEM_MAX_LEN 30
31 #define MODEM_MAX_BUF MODEM_MAX_LEN * 16
32
33 #define AST_MAX_INIT_STR        256
34
35 struct ast_modem_pvt;
36
37 struct ast_modem_driver {
38         char *name;
39         char **idents;
40         int formats;
41         int fullduplex;
42         void (*incusecnt)();
43         void (*decusecnt)();
44         char * (*identify)(struct ast_modem_pvt *);
45         int (*init)(struct ast_modem_pvt *);
46         int (*setdev)(struct ast_modem_pvt *, int dev);
47         struct ast_frame * (*read)(struct ast_modem_pvt *);
48         int (*write)(struct ast_modem_pvt *, struct ast_frame *fr);
49         int (*dial)(struct ast_modem_pvt *, char *);
50         int (*answer)(struct ast_modem_pvt *);
51         int (*hangup)(struct ast_modem_pvt *);
52         int (*startrec)(struct ast_modem_pvt *);
53         int (*stoprec)(struct ast_modem_pvt *);
54         int (*startpb)(struct ast_modem_pvt *);
55         int (*stoppb)(struct ast_modem_pvt *);
56         int (*setsilence)(struct ast_modem_pvt *, int onoff);
57         int (*dialdigit)(struct ast_modem_pvt *, char digit);
58         struct ast_modem_driver *next;
59 };
60
61 #define MODEM_MODE_IMMEDIATE            0
62 #define MODEM_MODE_WAIT_RING            1
63 #define MODEM_MODE_WAIT_ANSWER          2
64
65 //! Private data that needs to be filled by modem driver
66 struct ast_modem_pvt {
67         /*! Raw file descriptor for this device */
68         int fd;                                                 
69         /*! FILE * representation of device */
70         FILE *f;                                                
71         /*! Channel we belong to, possibly NULL */
72         struct ast_channel *owner;              
73         /* Device name */
74         char dev[256];                                  
75         /*! Frame */
76         struct ast_frame fr;                    
77         
78         char offset[AST_FRIENDLY_OFFSET];
79         /*! Outgoing buffer */
80         char obuf[MODEM_MAX_BUF];               
81         
82         int tail;
83         /*! Pulse or tone dialling */
84         char dialtype;                                  
85         /*! Time to wait for dial timeout */
86         char dialtimeout;                               
87         
88         int obuflen;
89         /*! Immediate, or wait for an answer */
90         int mode;                                               
91         /*! State of modem in miniature */
92         int ministate;                                  
93         /*! Digits to strip on outgoing numbers */
94         int stripmsd;                                   
95         /*! Is the last thing we saw an escape */
96         int escape;                                     
97         /*! flag to say if has caller*id yet*/
98         int gotclid;                            
99         /*! ringer timeout */
100         int ringt;                              
101         /*! actual time of last ring */
102         time_t lastring;                        
103         /*! dtmf receive state/data */
104         char dtmfrx;                            
105         
106         char context[AST_MAX_EXTENSION];
107         /*! Multiple Subscriber Number */
108         char msn[AST_MAX_EXTENSION];    
109         /*! Caller ID if available */
110         char cid[AST_MAX_EXTENSION];    
111         /*! Dialed Number if available */
112         char dnid[AST_MAX_EXTENSION];   
113         /*! Modem initialization String */
114         char initstr[AST_MAX_INIT_STR]; 
115         /*! default language */
116         char language[MAX_LANGUAGE];    
117         /*! Static response buffer */
118         char response[256];                             
119         /*! Modem Capability */
120         struct ast_modem_driver *mc;    
121         /*! Next channel in list */
122         struct ast_modem_pvt *next;                     
123 };
124
125
126 //! Register a modem driver
127 /*! Register a driver */
128 extern int ast_register_modem_driver(struct ast_modem_driver *mc);
129
130 //! Unregisters a modem driver
131 /*! Unregister a driver */
132 extern int ast_unregister_modem_driver(struct ast_modem_driver *mc);
133
134 //! Sends command
135 /*! Send the command cmd (length len, or 0 if pure ascii) on modem */
136 extern int ast_modem_send(struct ast_modem_pvt *p, char *cmd, int len);
137
138 //! Waits for result
139 /*! Wait for result to occur.  Return non-zero if times out or error, last
140    response is stored in p->response  */
141 extern int ast_modem_expect(struct ast_modem_pvt *p,  char *result, int timeout);
142
143 //! Waits for result
144 /*! Wait for result to occur.    response is stored in p->response  */
145 extern int ast_modem_read_response(struct ast_modem_pvt *p,  int timeout);
146
147 //! Used to start up the PBX on a RING
148 /*! Used by modem drivers to start up the PBX on a RING */
149 extern struct ast_channel *ast_modem_new(struct ast_modem_pvt *i, int state);
150
151 //! Trim string of trailing stuff
152 /*! Trim off trailing mess */
153 extern void ast_modem_trim(char *s);
154 #endif