adsi.h

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2005, Digium, Inc.
00005  *
00006  * Mark Spencer <markster@digium.com>
00007  *
00008  * See http://www.asterisk.org for more information about
00009  * the Asterisk project. Please do not directly contact
00010  * any of the maintainers of this project for assistance;
00011  * the project provides a web site, mailing lists and IRC
00012  * channels for your use.
00013  *
00014  * This program is free software, distributed under the terms of
00015  * the GNU General Public License Version 2. See the LICENSE file
00016  * at the top of the source tree.
00017  */
00018 
00019 /*! \file
00020  * \brief ADSI Support (built upon Caller*ID)
00021  */
00022 
00023 #ifndef _ASTERISK_ADSI_H
00024 #define _ASTERISK_ADSI_H
00025 
00026 #include "asterisk/callerid.h"
00027 
00028 /*! \name ADSI parameters */
00029 /*@{ */
00030 
00031 /* ADSI Message types */
00032 #define ADSI_MSG_DISPLAY   132
00033 #define ADSI_MSG_DOWNLOAD  133
00034 
00035 /* ADSI Parameters (display) */
00036 #define ADSI_LOAD_SOFTKEY  128
00037 #define ADSI_INIT_SOFTKEY_LINE   129
00038 #define ADSI_LOAD_VIRTUAL_DISP   130
00039 #define ADSI_LINE_CONTROL  131
00040 #define ADSI_INFORMATION   132
00041 #define ADSI_DISC_SESSION  133
00042 #define ADSI_SWITCH_TO_DATA   134
00043 #define ADSI_SWITCH_TO_VOICE  135
00044 #define ADSI_CLEAR_SOFTKEY 136
00045 #define ADSI_INPUT_CONTROL 137
00046 #define ADSI_INPUT_FORMAT  138
00047 #define ADSI_SWITCH_TO_PERIPH 139
00048 #define ADSI_MOVE_DATA     140
00049 #define ADSI_LOAD_DEFAULT  141
00050 #define ADSI_CONNECT_SESSION  142
00051 #define ADSI_CLEAR_TYPE_AHEAD 143
00052 #define ADSI_DISPLAY_CALL_BUF 144
00053 #define ADSI_CLEAR_CALL_BUF   145
00054 #define ADSI_SWITCH_TO_ALT 146
00055 #define ADSI_SWITCH_TO_GRAPHICS  147
00056 #define ADSI_CLEAR_SCREEN  148
00057 #define ADSI_QUERY_CONFIG  149
00058 #define ADSI_QUERY_CPEID   150
00059 #define ADSI_SWITCH_TO_APP 151
00060 
00061 /* Feature download messages */
00062 #define ADSI_LOAD_SOFTKEY_TABLE  128   /* Conveniently identical to the soft version */
00063 #define ADSI_LOAD_PREDEF_DISP 129   /* Load predefined display */
00064 #define ADSI_LOAD_SCRIPT   130
00065 #define ADSI_DOWNLOAD_CONNECT 131
00066 #define ADSI_DOWNLOAD_DISC 132
00067 
00068 /* Special return string codes */
00069 #define ADSI_ENCODED_DTMF  0x80  /* Transmit following chars with encoded dtmf */
00070 #define ADSI_ON_HOOK    0x81  /* Open switch-hook */
00071 #define ADSI_OFF_HOOK      0x82  /* Close switch-hook */
00072 #define ADSI_FLASH      0x83  /* Flash switch-hook */
00073 #define ADSI_DIAL_TONE_DETECT 0x84  /* Wait for dialtone */
00074 #define ADSI_LINE_NUMBER   0x85  /* Send current line number using DTMF/encoded DTMF */
00075 #define ADSI_BLANK      0x86  /* Blank (does nothing) */
00076 #define ADSI_SEND_CHARS    0x87  /* Send collected digits/characters */
00077 #define ADSI_CLEAR_CHARS   0x88  /* Clear characters/digits collected */
00078 #define ADSI_BACKSPACE     0x89  /* Erase last collected digit */
00079 #define ADSI_TAB_COLUMN    0x8A  /* Display specified display column of current line */
00080 #define ADSI_GOTO_LINE     0x8B  /* Go to given page and line number */
00081 #define ADSI_GOTO_LINE_REL 0x8C  /* Go to given line (relative to current) */
00082 #define ADSI_PAGE_UP    0x8D  /* Go up one page */
00083 #define ADSI_PAGE_DOWN     0x8E  /* Go down one page */
00084 #define ADSI_EXTENDED_DTMF 0x8F  /* Send DTMF tones for 250ms instead of 60 ms */
00085 #define ADSI_DELAY      0x90  /* Delay for given # (times 10) of ms */
00086 #define ADSI_DIAL_PULSE_ONE   0x91  /* Send a dial pulse "1" */
00087 #define ADSI_SWITCH_TO_DATA2  0x92  /* Switch CPE to data mode */
00088 #define ADSI_SWITCH_TO_VOICE2 0x93  /* Switch CPE to voice mode */
00089 #define ADSI_DISP_CALL_BUF 0x94  /* Display specified call buffer */
00090 #define ADSI_CLEAR_CALL_B  0x95  /* Clear specified call buffer */
00091 
00092 #ifdef __ADSI_CPE
00093 /* These messages are reserved for the ADSI CPE only */
00094 #define ADSI_DISPLAY_CONTROL  0x98  /* Store predefined display identified next / Display status display page */
00095 #define ADSI_DISPLAY_SOFT_KEYS   0x99  /* Display the script soft keys identified next */
00096 #define ADSI_CHANGE_STATE  0x9A  /* Change state of service script */
00097 #define ADSI_START_CLEAR_TIMER   0x9B  /* Start / Clear timer */
00098 #define ADSI_SET_SCRIPT_FLAG  0x9C  /* Set / clear a script flag */
00099 #define ADSI_JUMP_TO_SUBSCRIPT   0x9D  /* Jump to specified subscript */
00100 #define ADSI_EVENT_22_TRIGGER 0x9E  /* Trigger an occurance of event 22 */
00101 #define ADSI_EVENT_23_TRIGGER 0x9f  /* Trigger an occurance of event 23 */
00102 #define ADSI_EXIT    0xA0  /* Exit the service script interpreter */
00103 #endif
00104 
00105 /* Display pages */
00106 #define ADSI_INFO_PAGE  0x0
00107 #define ADSI_COMM_PAGE  0x1
00108 
00109 #define ADSI_KEY_APPS   16 /* 16 to 33 reserved for applications */
00110 
00111 /* Justification */
00112 #define ADSI_JUST_LEFT  0x2
00113 #define ADSI_JUST_RIGHT 0x1
00114 #define ADSI_JUST_CENT  0x0   /* Center */
00115 #define ADSI_JUST_IND   0x3   /* Indent */
00116 
00117 #define ADSI_KEY_SKT 0x80  /* Load from SKT */
00118 #define ADSI_KEY_HILITE 0x40  /* Highlight key */
00119 
00120 #define ADSI_DIR_FROM_LEFT (0)
00121 #define ADSI_DIR_FROM_RIGHT (1)
00122 
00123 #define AST_ADSI_VERSION 1
00124 
00125 /*@} */
00126 
00127 int ast_adsi_begin_download(struct ast_channel *chan, char *service, unsigned char *fdn, unsigned char *sec, int version);
00128 
00129 int ast_adsi_end_download(struct ast_channel *chan);
00130 
00131 /*! Restore ADSI initialization (for applications that play with ADSI
00132  *   and want to restore it to normal.  If you touch "INFO" then you
00133  *   have to use the ast_adsi_channel_init again instead.
00134  * \param chan Channel to restore
00135  *
00136  * \retval 0 on success (or adsi unavailable)
00137  * \retval -1 on hangup
00138  */
00139 int ast_adsi_channel_restore(struct ast_channel *chan);
00140 
00141 /*!
00142  * \brief Display some stuff on the screen
00143  * \param chan Channel to display on
00144  * \param lines NULL-terminated list of things to print (no more than 4 recommended)
00145  * \param align list of alignments to use (ADSI_JUST_LEFT, ADSI_JUST_RIGHT, ADSI_JUST_CEN, etc..)
00146  * \param voice whether to jump into voice mode when finished
00147  *
00148  * \retval 0 on success (or adsi unavailable)
00149  * \retval -1 on hangup
00150  */
00151 int ast_adsi_print(struct ast_channel *chan, char **lines, int *align, int voice);
00152 
00153 /*!
00154  * \brief Check if scripts for a given app are already loaded.
00155  * Version may be -1, if any version is okay, or 0-255 for a specific version.
00156  * \param chan Channel to test for loaded app
00157  * \param app Four character app name (must be unique to your application)
00158  * \param ver optional version number
00159  * \param data Non-zero if you want to be put in data mode
00160  *
00161  * \retval 0 if scripts is not loaded or not an ADSI CPE
00162  * \retval -1 on hangup
00163  * \retval 1 if script already loaded.
00164  */
00165 int ast_adsi_load_session(struct ast_channel *chan, unsigned char *app, int ver, int data);
00166 int ast_adsi_unload_session(struct ast_channel *chan);
00167 
00168 /* ADSI Layer 2 transmission functions */
00169 int ast_adsi_transmit_message(struct ast_channel *chan, unsigned char *msg, int msglen, int msgtype);
00170 int ast_adsi_transmit_message_full(struct ast_channel *chan, unsigned char *msg, int msglen, int msgtype, int dowait);
00171 /*! Read some encoded DTMF data.
00172  * Returns number of bytes received
00173  */
00174 int ast_adsi_read_encoded_dtmf(struct ast_channel *chan, unsigned char *buf, int maxlen);
00175 
00176 /* ADSI Layer 3 creation functions */
00177 
00178 /*!
00179  * \brief Connects an ADSI Display Session
00180  * \param buf Character buffer to create parameter in (must have at least 256 free)
00181  * \param fdn Optional 4 byte Feature Download Number (for loading soft keys)
00182  * \param ver Optional version number (0-255, or -1 to omit)
00183  *
00184  * \retval number of bytes added to buffer
00185  * \retval -1 on error.
00186  */
00187 
00188 int ast_adsi_connect_session(unsigned char *buf, unsigned char *fdn, int ver);
00189 
00190 /*! Build Query CPE ID of equipment.
00191  *  Returns number of bytes added to message
00192  */
00193 int ast_adsi_query_cpeid(unsigned char *buf);
00194 int ast_adsi_query_cpeinfo(unsigned char *buf);
00195 
00196 /*! Get CPE ID from an attached ADSI compatible CPE.
00197  * Returns 1 on success, storing 4 bytes of CPE ID at buf
00198  * or -1 on hangup, or 0 if there was no hangup but it failed to find the
00199  * device ID.  Returns to voice mode if "voice" is non-zero.
00200  */
00201 int ast_adsi_get_cpeid(struct ast_channel *chan, unsigned char *cpeid, int voice);
00202 
00203 int ast_adsi_get_cpeinfo(struct ast_channel *chan, int *width, int *height, int *buttons, int voice);
00204 
00205 /*!
00206  * \brief Begin an ADSI script download
00207  * \param buf Character buffer to create parameter in (must have at least 256 free)
00208  * \param service a 1-18 byte name of the feature
00209  * \param fdn 4 byte Feature Download Number (for loading soft keys)
00210  * \param sec 4 byte vendor security code
00211  * \param ver version number (0-255, or -1 to omit)
00212  *
00213  * \retval number of bytes added to buffer
00214  * \retval -1 on error.
00215  */
00216 
00217 int ast_adsi_download_connect(unsigned char *buf, char *service, unsigned char *fdn, unsigned char *sec, int ver);
00218 
00219 /*!
00220  * \brief Disconnects a running session.
00221  * \param buf Character buffer to create parameter in (must have at least 256 free)
00222  *
00223  * \retval number of bytes added to buffer
00224  * \retval -1 on error.
00225  */
00226 int ast_adsi_disconnect_session(unsigned char *buf);
00227 
00228 /*!
00229  * \brief Disconnects (and hopefully saves) a downloaded script
00230  * \param buf Character buffer to create parameter in (must have at least 256 free)
00231  *
00232  * \retval number of bytes added to buffer
00233  * \retval -1 on error.
00234  */
00235 int ast_adsi_download_disconnect(unsigned char *buf);
00236 
00237 /*!
00238  * \brief Puts CPE in data mode.
00239  * \param buf Character buffer to create parameter in (must have at least 256 free)
00240  *
00241  * \retval number of bytes added to buffer
00242  * \retval -1 on error.
00243  */
00244 int ast_adsi_data_mode(unsigned char *buf);
00245 int ast_adsi_clear_soft_keys(unsigned char *buf);
00246 int ast_adsi_clear_screen(unsigned char *buf);
00247 
00248 /*!
00249  * \brief Puts CPE in voice mode.
00250  * \param buf Character buffer to create parameter in (must have at least 256 free)
00251  * \param when (a time in seconds) to make the switch
00252  *
00253  * \retval number of bytes added to buffer
00254  * \retval -1 on error.
00255  */
00256 int ast_adsi_voice_mode(unsigned char *buf, int when);
00257 
00258 /*!
00259  * \brief Returns non-zero if Channel does or might support ADSI
00260  * \param chan Channel to check
00261  */
00262 int ast_adsi_available(struct ast_channel *chan);
00263 
00264 /*!
00265  * \brief Loads a line of info into the display.
00266  * \param buf Character buffer to create parameter in (must have at least 256 free)
00267  * \param page Page to load (ADSI_COMM_PAGE or ADSI_INFO_PAGE)
00268  * \param line Line number to load (1-4 for Comm page, 1-33 for info page)
00269  * \param just Line justification (ADSI_JUST_LEFT, ADSI_JUST_RIGHT, ADSI_JUST_CENT, ADSI_JUST_IND)
00270  * \param wrap Wrap (1 = yes, 0 = no)
00271  * \param col1 Text to place in first column
00272  * \param col2 Text to place in second column
00273  *
00274  * \retval number of bytes added to buffer
00275  * \retval -1 on error.
00276  */
00277 
00278 int ast_adsi_display(unsigned char *buf, int page, int line, int just, int wrap, char *col1, char *col2);
00279 
00280 /*!
00281  * \brief Sets the current line and page.
00282  * \param buf Character buffer to create parameter in (must have at least 256 free)
00283  * \param page Which page (ADSI_COMM_PAGE or ADSI_INFO_PAGE)
00284  * \param line Line number (1-33 for info page, 1-4 for comm page)
00285  *
00286  * \retval number of bytes added to buffer
00287  * \retval -1 on error.
00288  */
00289 
00290 int ast_adsi_set_line(unsigned char *buf, int page, int line);
00291 
00292 /*!
00293  * \brief Creates "load soft key" parameters
00294  * \param buf Character buffer to create parameter in (must have at least 256 free)
00295  * \param key Key code from 2 to 33, for which key we are loading
00296  * \param llabel Long label for key (1-18 bytes)
00297  * \param slabel Short label for key (1-7 bytes)
00298  * \param ret Optional return sequence (NULL for none)
00299  * \param data whether to put CPE in data mode before sending digits
00300  *
00301  * \retval number of bytes added to buffer
00302  * \retval -1 on error.
00303  */
00304 int ast_adsi_load_soft_key(unsigned char *buf, int key, const char *llabel, const char *slabel, char *ret, int data);
00305 
00306 /*!
00307  * \brief Set which soft keys should be displayed
00308  * \param buf Character buffer to create parameter in (must have at least 256 free)
00309  * \param keys Array of 8 unsigned chars with the key numbers, may be OR'd with ADSI_KEY_HILITE
00310  *             But remember, the last two keys aren't real keys, they're for scrolling
00311  *
00312  * \retval number of bytes added to buffer
00313  * \retval -1 on error.
00314  */
00315 int ast_adsi_set_keys(unsigned char *buf, unsigned char *keys);
00316 
00317 /*!
00318  * \brief Set input information
00319  * \param buf Character buffer to create parameter in (must have at least 256 free)
00320  * \param page Which page to input on (ADSI_COMM_PAGE or ADSI_INFO_PAGE)
00321  * \param line Line number to input on
00322  * \param display Set to zero to obscure input, or 1 to leave visible
00323  * \param format Format number to use (0-7)
00324  * \param just Justification (left, right center, indent)
00325  *
00326  * \retval number of bytes added to buffer
00327  * \retval -1 on error.
00328  */
00329 int ast_adsi_input_control(unsigned char *buf, int page, int line, int display, int format, int just);
00330 
00331 /*!
00332  * \brief Set input format
00333  * \param buf Character buffer to create parameter in (must have at least 256 free)
00334  * \param num Which format we are setting
00335  * \param dir Which direction (ADSI_DIR_FROM_LEFT or ADSI_DIR_FROM_RIGHT)
00336  * \param wrap Set to 1 to permit line wrap, or 0 if not
00337  * \param format1 Format for column 1
00338  * \param format2 Format for column 2
00339  *
00340  * \retval number of bytes added to buffer
00341  * \retval -1 on error.
00342  */
00343 int ast_adsi_input_format(unsigned char *buf, int num, int dir, int wrap, char *format1, char *format2);
00344 
00345 struct adsi_funcs {
00346    unsigned int version;
00347    int (*begin_download)(struct ast_channel *chan, char *service, unsigned char *fdn, unsigned char *sec, int version);
00348    int (*end_download)(struct ast_channel *chan);
00349    int (*channel_restore) (struct ast_channel *chan);
00350    int (*print) (struct ast_channel *chan, char **lines, int *align, int voice);
00351    int (*load_session) (struct ast_channel *chan, unsigned char *app, int ver, int data);
00352    int (*unload_session) (struct ast_channel *chan);
00353    int (*transmit_message) (struct ast_channel *chan, unsigned char *msg, int msglen, int msgtype);
00354    int (*transmit_message_full) (struct ast_channel *chan, unsigned char *msg, int msglen, int msgtype, int dowait);
00355    int (*read_encoded_dtmf) (struct ast_channel *chan, unsigned char *buf, int maxlen);
00356    int (*connect_session) (unsigned char *buf, unsigned char *fdn, int ver);
00357    int (*query_cpeid) (unsigned char *buf);
00358    int (*query_cpeinfo) (unsigned char *buf);
00359    int (*get_cpeid) (struct ast_channel *chan, unsigned char *cpeid, int voice);
00360    int (*get_cpeinfo) (struct ast_channel *chan, int *width, int *height, int *buttons, int voice);
00361    int (*download_connect) (unsigned char *buf, char *service, unsigned char *fdn, unsigned char *sec, int ver);
00362    int (*disconnect_session) (unsigned char *buf);
00363    int (*download_disconnect) (unsigned char *buf);
00364    int (*data_mode) (unsigned char *buf);
00365    int (*clear_soft_keys) (unsigned char *buf);
00366    int (*clear_screen) (unsigned char *buf);
00367    int (*voice_mode) (unsigned char *buf, int when);
00368    int (*available) (struct ast_channel *chan);
00369    int (*display) (unsigned char *buf, int page, int line, int just, int wrap, char *col1, char *col2);
00370    int (*set_line) (unsigned char *buf, int page, int line);
00371    int (*load_soft_key) (unsigned char *buf, int key, const char *llabel, const char *slabel, char *ret, int data);
00372    int (*set_keys) (unsigned char *buf, unsigned char *keys);
00373    int (*input_control) (unsigned char *buf, int page, int line, int display, int format, int just);
00374    int (*input_format) (unsigned char *buf, int num, int dir, int wrap, char *format1, char *format2);
00375 };
00376 
00377 void ast_adsi_install_funcs(const struct adsi_funcs *funcs);
00378 
00379 #endif /* _ASTERISK_ADSI_H */
00380 

Generated on Thu Apr 16 06:27:06 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6