app.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
int	ast_app_getdata (struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout)
	Plays a stream and gets DTMF data from a channel.
int	ast_app_getdata_full (struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd)
int	ast_app_getvoice (struct ast_channel *c, char *dest, char *dstfmt, char *prompt, int silence, int maxsec)
	Record voice (after playing prompt if specified), waiting for silence (in ms) up to a given timeout (in s) or '#'.
int	ast_app_has_voicemail (const char *mailbox)
	Determine if a given mailbox has any voicemail.
int	ast_app_messagecount (const char *mailbox, int *newmsgs, int *oldmsgs)
	Determine number of new/old messages in a mailbox.
int	ast_safe_system (const char *s)
	Safely spawn an external program while closingn file descriptors.
int	ast_dtmf_stream (struct ast_channel *chan, struct ast_channel *peer, char *digits, int between)
	Send DTMF to chan (optionally entertain peer).
int	ast_linear_stream (struct ast_channel *chan, const char *filename, int fd, int allowoverride)
	Stream a filename (or file descriptor) as a generator.
int	ast_control_streamfile (struct ast_channel *chan, char *file, char *fwd, char *rev, char *stop, char *pause, int skipms)
	Stream a file with fast forward, pause, reverse.

---

Function Documentation

int ast_app_getdata (  struct ast_channel *  c, char *  prompt, char *  s, int  maxlen, int  timeout )

Plays a stream and gets DTMF data from a channel. Parameters: c  Which channel one is interacting with prompt  File to pass to ast_streamfile (the one that you wish to play) s  The location where the DTMF data will be stored maxlen  Max Length of the data timeout  Timeout length waiting for data(in milliseconds). Set to 0 for standard timeout(six seconds), or -1 for no time out. This function was designed for application programmers for situations where they need to play a message and then get some DTMF data in response to the message. If a digit is pressed during playback, it will immediately break out of the message and continue execution of your code. Definition at line 36 of file app.c. References ast_readstring(), ast_streamfile(), ast_pbx::dtimeout, ast_channel::language, ast_channel::pbx, ast_pbx::rtimeout, and s. { int res,to,fto; /* XXX Merge with full version? XXX */ if (prompt) { res = ast_streamfile(c, prompt, c->language); if (res < 0) return res; } fto = c->pbx ? c->pbx->rtimeout * 1000 : 6000; to = c->pbx ? c->pbx->dtimeout * 1000 : 2000; if (timeout > 0) fto = to = timeout; if (timeout < 0) fto = to = 1000000000; res = ast_readstring(c, s, maxlen, to, fto, "#"); return res; }

int ast_app_getdata_full (  struct ast_channel *  c, char *  prompt, char *  s, int  maxlen, int  timeout, int  audiofd, int  ctrlfd )

Definition at line 55 of file app.c. References ast_readstring_full(), ast_streamfile(), ast_channel::language, and s. { int res,to,fto; if (prompt) { res = ast_streamfile(c, prompt, c->language); if (res < 0) return res; } fto = 6000; to = 2000; if (timeout > 0) fto = to = timeout; if (timeout < 0) fto = to = 1000000000; res = ast_readstring_full(c, s, maxlen, to, fto, "#", audiofd, ctrlfd); return res; }

int ast_app_getvoice (  struct ast_channel *  c, char *  dest, char *  dstfmt, char *  prompt, int  silence, int  maxsec )

Record voice (after playing prompt if specified), waiting for silence (in ms) up to a given timeout (in s) or '#'. Definition at line 71 of file app.c. References ast_closestream(), ast_dsp_free(), ast_dsp_new(), ast_dsp_silence(), AST_FORMAT_SLINEAR, AST_FRAME_DTMF, AST_FRAME_VOICE, ast_frfree(), ast_log(), ast_read(), ast_set_read_format(), ast_streamfile(), ast_waitfor(), ast_waitstream(), ast_writefile(), ast_channel::language, LOG_NOTICE, LOG_WARNING, ast_channel::name, and ast_channel::readformat. { int res; struct ast_filestream *writer; int rfmt; int totalms=0, total; struct ast_frame *f; struct ast_dsp *sildet; /* Play prompt if requested */ if (prompt) { res = ast_streamfile(c, prompt, c->language); if (res < 0) return res; res = ast_waitstream(c,""); if (res < 0) return res; } rfmt = c->readformat; res = ast_set_read_format(c, AST_FORMAT_SLINEAR); if (res < 0) { ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n"); return -1; } sildet = ast_dsp_new(); if (!sildet) { ast_log(LOG_WARNING, "Unable to create silence detector :(\n"); return -1; } writer = ast_writefile(dest, dstfmt, "Voice file", 0, 0, 0666); if (!writer) { ast_log(LOG_WARNING, "Unable to open file '%s' in format '%s' for writing\n", dest, dstfmt); ast_dsp_free(sildet); return -1; } for(;;) { if ((res = ast_waitfor(c, 2000)) < 0) { ast_log(LOG_NOTICE, "Waitfor failed while recording file '%s' format '%s'\n", dest, dstfmt); break; } if (res) { f = ast_read(c); if (!f) { ast_log(LOG_NOTICE, "Hungup while recording file '%s' format '%s'\n", dest, dstfmt); break; } if ((f->frametype == AST_FRAME_DTMF) && (f->subclass == '#')) { /* Ended happily with DTMF */ ast_frfree(f); break; } else if (f->frametype == AST_FRAME_VOICE) { ast_dsp_silence(sildet, f, &total); if (total > silence) { /* Ended happily with silence */ ast_frfree(f); break; } totalms += f->samples / 8; if (totalms > maxsec * 1000) { /* Ended happily with too much stuff */ ast_log(LOG_NOTICE, "Constraining voice on '%s' to %d seconds\n", c->name, maxsec); ast_frfree(f); break; } } ast_frfree(f); } } res = ast_set_read_format(c, rfmt); if (res) ast_log(LOG_WARNING, "Unable to restore read format on '%s'\n", c->name); ast_dsp_free(sildet); ast_closestream(writer); return 0; }

int ast_app_has_voicemail (  const char *  mailbox  )

Determine if a given mailbox has any voicemail. Definition at line 147 of file app.c. References ast_config_AST_SPOOL_DIR. { DIR *dir; struct dirent *de; char fn[256]; char tmp[256]=""; char *mb, *cur; char *context; int ret; /* If no mailbox, return immediately */ if (ast_strlen_zero(mailbox)) return 0; if (strchr(mailbox, ',')) { strncpy(tmp, mailbox, sizeof(tmp)); mb = tmp; ret = 0; while((cur = strsep(&mb, ","))) { if (!ast_strlen_zero(cur)) { if (ast_app_has_voicemail(cur)) return 1; } } return 0; } strncpy(tmp, mailbox, sizeof(tmp) - 1); context = strchr(tmp, '@'); if (context) { *context = '\0'; context++; } else context = "default"; snprintf(fn, sizeof(fn), "%s/voicemail/%s/%s/INBOX", (char *)ast_config_AST_SPOOL_DIR, context, tmp); dir = opendir(fn); if (!dir) return 0; while ((de = readdir(dir))) { if (!strncasecmp(de->d_name, "msg", 3)) break; } closedir(dir); if (de) return 1; return 0; }

int ast_app_messagecount (  const char *  mailbox, int *  newmsgs, int *  oldmsgs )

Determine number of new/old messages in a mailbox. Definition at line 192 of file app.c. References ast_config_AST_SPOOL_DIR. { DIR *dir; struct dirent *de; char fn[256]; char tmp[256]=""; char *mb, *cur; char *context; int ret; if (newmsgs) *newmsgs = 0; if (oldmsgs) *oldmsgs = 0; /* If no mailbox, return immediately */ if (ast_strlen_zero(mailbox)) return 0; if (strchr(mailbox, ',')) { int tmpnew, tmpold; strncpy(tmp, mailbox, sizeof(tmp)); mb = tmp; ret = 0; while((cur = strsep(&mb, ", "))) { if (!ast_strlen_zero(cur)) { if (ast_app_messagecount(cur, newmsgs ? &tmpnew : NULL, oldmsgs ? &tmpold : NULL)) return -1; else { if (newmsgs) *newmsgs += tmpnew; if (oldmsgs) *oldmsgs += tmpold; } } } return 0; } strncpy(tmp, mailbox, sizeof(tmp) - 1); context = strchr(tmp, '@'); if (context) { *context = '\0'; context++; } else context = "default"; if (newmsgs) { snprintf(fn, sizeof(fn), "%s/voicemail/%s/%s/INBOX", (char *)ast_config_AST_SPOOL_DIR, context, tmp); dir = opendir(fn); if (dir) { while ((de = readdir(dir))) { if ((strlen(de->d_name) > 3) && !strncasecmp(de->d_name, "msg", 3) && !strcasecmp(de->d_name + strlen(de->d_name) - 3, "txt")) (*newmsgs)++; } closedir(dir); } } if (oldmsgs) { snprintf(fn, sizeof(fn), "%s/voicemail/%s/%s/Old", (char *)ast_config_AST_SPOOL_DIR, context, tmp); dir = opendir(fn); if (dir) { while ((de = readdir(dir))) { if ((strlen(de->d_name) > 3) && !strncasecmp(de->d_name, "msg", 3) && !strcasecmp(de->d_name + strlen(de->d_name) - 3, "txt")) (*oldmsgs)++; } closedir(dir); } } return 0; }

int ast_control_streamfile (  struct ast_channel *  chan, char *  file, char *  fwd, char *  rev, char *  stop, char *  pause, int  skipms )

Stream a file with fast forward, pause, reverse. Definition at line 410 of file app.c. References ast_channel::_state, ast_answer(), AST_STATE_UP, ast_stopstream(), ast_stream_fastforward(), ast_streamfile(), ast_waitfordigit(), ast_waitstream_fr(), ast_channel::language, and ast_channel::stream. { struct timeval started, ended; long elapsed = 0,last_elapsed =0; char *breaks; int blen=2; int res=0; if (stop) blen += strlen(stop); if (pause) blen += strlen(pause); breaks = alloca(blen + 1); breaks[0] = '\0'; strcat(breaks, stop); strcat(breaks, pause); if (chan->_state != AST_STATE_UP) res = ast_answer(chan); if (chan) ast_stopstream(chan); for (;;) { gettimeofday(&started,NULL); if (chan) ast_stopstream(chan); res = ast_streamfile(chan, file, chan->language); if (!res) { res = 1; if (elapsed) { ast_stream_fastforward(chan->stream, elapsed); last_elapsed = elapsed - 200; } if (res) res = ast_waitstream_fr(chan, breaks, fwd, rev, skipms); else break; } if (res < 1) break; if (pause != NULL && strchr(pause, res)) { gettimeofday(&ended, NULL); elapsed = (((ended.tv_sec * 1000) + ended.tv_usec / 1000) - ((started.tv_sec * 1000) + started.tv_usec / 1000) + last_elapsed); for(;;) { if (chan) ast_stopstream(chan); res = ast_waitfordigit(chan, 1000); if(res == 0) continue; else if(res == -1 || strchr(pause, res) || (stop && strchr(stop, res))) break; } if (res == *pause) { res = 0; continue; } } if (res == -1) break; if (stop && strchr(stop, res)) { res = 0; break; } } if (chan) ast_stopstream(chan); return res; }

int ast_dtmf_stream (  struct ast_channel *  chan, struct ast_channel *  peer, char *  digits, int  between )

Send DTMF to chan (optionally entertain peer). Definition at line 263 of file app.c. References ast_autoservice_start(), ast_autoservice_stop(), AST_FRAME_DTMF, ast_log(), ast_safe_sleep(), ast_waitfor(), ast_write(), and LOG_WARNING. { char *ptr=NULL; int res=0; struct ast_frame f; if (!between) between = 100; if (peer) res = ast_autoservice_start(peer); if (!res) { res = ast_waitfor(chan,100); if (res > -1) { for (ptr=digits;*ptr;*ptr++) { if (*ptr == 'w') { res = ast_safe_sleep(chan, 500); if (res) break; continue; } memset(&f, 0, sizeof(f)); f.frametype = AST_FRAME_DTMF; f.subclass = *ptr; f.src = "ast_dtmf_stream"; if (strchr("0123456789*#abcdABCD",*ptr)==NULL) { ast_log(LOG_WARNING, "Illegal DTMF character '%c' in string. (0-9*#aAbBcCdD allowed)\n",*ptr); } else { res = ast_write(chan, &f); if (res) break; /* pause between digits */ res = ast_safe_sleep(chan,between); if (res) break; } } } if (peer) res = ast_autoservice_stop(peer); } return res; }

int ast_linear_stream (  struct ast_channel *  chan, const char *  filename, int  fd, int  allowoverride )

Stream a filename (or file descriptor) as a generator. Definition at line 379 of file app.c. References ast_activate_generator(), ast_config_AST_VAR_DIR, ast_log(), LOG_WARNING, and malloc. { struct linear_state *lin; char tmpf[256] = ""; int res = -1; int autoclose = 0; if (fd < 0) { if (!filename || ast_strlen_zero(filename)) return -1; autoclose = 1; if (filename[0] == '/') strncpy(tmpf, filename, sizeof(tmpf) - 1); else snprintf(tmpf, sizeof(tmpf), "%s/%s/%s", (char *)ast_config_AST_VAR_DIR, "sounds", filename); fd = open(tmpf, O_RDONLY); if (fd < 0){ ast_log(LOG_WARNING, "Unable to open file '%s': %s\n", tmpf, strerror(errno)); return -1; } } lin = malloc(sizeof(struct linear_state)); if (lin) { memset(lin, 0, sizeof(lin)); lin->fd = fd; lin->allowoverride = allowoverride; lin->autoclose = autoclose; res = ast_activate_generator(chan, &linearstream, lin); } return res; }

int ast_safe_system (  const char *  s  )

Safely spawn an external program while closingn file descriptors. Definition at line 163 of file asterisk.c. References ast_log(), LOG_WARNING, and s. { /* XXX This function needs some optimization work XXX */ pid_t pid; int x; int res; struct rusage rusage; int status; pid = fork(); if (pid == 0) { /* Close file descriptors and launch system command */ for (x=STDERR_FILENO + 1; x<4096;x++) { close(x); } res = execl("/bin/sh", "/bin/sh", "-c", s, NULL); exit(1); } else if (pid > 0) { for(;;) { res = wait4(pid, &status, 0, &rusage); if (res > -1) { if (WIFEXITED(status)) res = WEXITSTATUS(status); else res = -1; } else { if (errno != EINTR) break; } } } else { ast_log(LOG_WARNING, "Fork failed: %s\n", strerror(errno)); res = -1; } return res; }

---