Version 0.1.9 from FTP
[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 struct ast_modem_pvt {
66         int fd;                                                 /* Raw file descriptor for this device */
67         FILE *f;                                                /* FILE * representation of device */
68         struct ast_channel *owner;              /* Channel we belong to, possibly NULL */
69         char dev[256];                                  /* Device name */
70         struct ast_frame fr;                    /* Frame */
71         char offset[AST_FRIENDLY_OFFSET];
72         char obuf[MODEM_MAX_BUF];               /* Outgoing buffer */
73         int tail;
74         char dialtype;                                  /* Pulse or tone dialling */
75         char dialtimeout;                               /* Time to wait for dial timeout */
76         int obuflen;
77         int mode;                                               /* Immediate, or wait for an answer */
78         int ministate;                                  /* State of modem in miniature */
79         int stripmsd;                                   /* Digits to strip on outgoing numbers */
80         int escape;                                     /* Is the last thing we saw an escape */
81         int gotclid;                            /* flag to say if has caller*id yet*/
82         int ringt;                              /* ringer timeout */
83         time_t lastring;                        /* actual time of last ring */
84         char dtmfrx;                            /* dtmf receive state/data */
85         char context[AST_MAX_EXTENSION];
86         char msn[AST_MAX_EXTENSION];    /* Multiple Subscriber Number */
87         char cid[AST_MAX_EXTENSION];    /* Caller ID if available */
88         char dnid[AST_MAX_EXTENSION];   /* Dialed Number if available */
89         char initstr[AST_MAX_INIT_STR]; /* Modem initialization String */
90         char language[MAX_LANGUAGE];    /* default language */
91         char response[256];                             /* Static response buffer */
92         struct ast_modem_driver *mc;    /* Modem Capability */
93         struct ast_modem_pvt *next;                     /* Next channel in list */
94 };
95
96 /* Register a driver */
97 extern int ast_register_modem_driver(struct ast_modem_driver *mc);
98
99 /* Unregister a driver */
100 extern int ast_unregister_modem_driver(struct ast_modem_driver *mc);
101
102 /* Send the command cmd (length len, or 0 if pure ascii) on modem */
103 extern int ast_modem_send(struct ast_modem_pvt *p, char *cmd, int len);
104
105 /* Wait for result to occur.  Return non-zero if times out or error, last
106    response is stored in p->response  */
107 extern int ast_modem_expect(struct ast_modem_pvt *p,  char *result, int timeout);
108
109 /* Wait for result to occur.    response is stored in p->response  */
110 extern int ast_modem_read_response(struct ast_modem_pvt *p,  int timeout);
111
112 /* Used by modem drivers to start up the PBX on a RING */
113 extern struct ast_channel *ast_modem_new(struct ast_modem_pvt *i, int state);
114
115 /* Trim off trailing mess */
116 extern void ast_modem_trim(char *s);
117 #endif