file.h File Reference

#include <asterisk/channel.h>
#include <asterisk/frame.h>
#include <fcntl.h>

Go to the source code of this file.

Defines
#define	AST_DIGIT_ANY   "0123456789#*"
	Convenient for waiting.
#define	SEEK_FORCECUR   10
#define	AST_RESERVED_POINTERS   20
Functions
int	ast_format_register (char *name, char *exts, int format, struct ast_filestream *(*open)(int fd), struct ast_filestream *(*rewrite)(int fd, char *comment), int(*write)(struct ast_filestream *, struct ast_frame *), int(*seek)(struct ast_filestream *, long offset, int whence), int(*trunc)(struct ast_filestream *), long(*tell)(struct ast_filestream *), struct ast_frame *(*read)(struct ast_filestream *, int *timetonext), void(*close)(struct ast_filestream *), char *(*getcomment)(struct ast_filestream *))
	Registers a new file format.
int	ast_format_unregister (char *name)
	Unregisters a file format.
int	ast_streamfile (struct ast_channel *c, char *filename, char *preflang)
	Streams a file.
int	ast_stopstream (struct ast_channel *c)
	Stops a stream.
int	ast_fileexists (char *filename, char *fmt, char *preflang)
	Checks for the existence of a given file.
int	ast_filerename (char *oldname, char *newname, char *fmt)
	Renames a file.
int	ast_filedelete (char *filename, char *fmt)
	Deletes a file.
int	ast_filecopy (char *oldname, char *newname, char *fmt)
	Copies a file.
int	ast_waitstream (struct ast_channel *c, char *breakon)
	Waits for a stream to stop or digit to be pressed.
int	ast_waitstream_fr (struct ast_channel *c, char *breakon, char *forward, char *rewind, int ms)
	Same as waitstream but allows stream to be forwarded or rewound.
int	ast_waitstream_full (struct ast_channel *c, char *breakon, int audiofd, int monfd)
ast_filestream *	ast_readfile (char *filename, char *type, char *comment, int flags, int check, mode_t mode)
	Starts reading from a file.
ast_filestream *	ast_writefile (char *filename, char *type, char *comment, int flags, int check, mode_t mode)
	Starts writing a file.
int	ast_writestream (struct ast_filestream *fs, struct ast_frame *f)
	Writes a frame to a stream.
int	ast_closestream (struct ast_filestream *f)
	Closes a stream.
ast_filestream *	ast_openstream (struct ast_channel *chan, char *filename, char *preflang)
	Opens stream for use in seeking, playing.
ast_filestream *	ast_openvstream (struct ast_channel *chan, char *filename, char *preflang)
	Opens stream for use in seeking, playing.
int	ast_applystream (struct ast_channel *chan, struct ast_filestream *s)
	Applys a open stream to a channel.
int	ast_playstream (struct ast_filestream *s)
	play a open stream on a channel.
int	ast_seekstream (struct ast_filestream *fs, long sample_offset, int whence)
	Seeks into stream.
int	ast_truncstream (struct ast_filestream *fs)
	Trunc stream at current location.
int	ast_stream_fastforward (struct ast_filestream *fs, long ms)
	Fast forward stream ms.
int	ast_stream_rewind (struct ast_filestream *fs, long ms)
	Rewind stream ms.
long	ast_tellstream (struct ast_filestream *fs)
	Tell where we are in a stream.
ast_frame *	ast_readframe (struct ast_filestream *s)
	Read a frame from a filestream.
int	ast_file_init (void)
	Initialize file stuff.

---

Define Documentation

#define AST_DIGIT_ANY   "0123456789#*"

Convenient for waiting. Definition at line 28 of file file.h. Referenced by ast_play_and_wait(), ast_readstring(), and ast_readstring_full().

#define AST_RESERVED_POINTERS   20

Definition at line 295 of file file.h.

#define SEEK_FORCECUR   10

Definition at line 30 of file file.h. Referenced by ast_read(), and ast_write().

---

Function Documentation

int ast_applystream (  struct ast_channel *  chan, struct ast_filestream *  s )

Applys a open stream to a channel. Parameters: chan  channel to work ast_filestream  s to apply Returns 0 for success, -1 on failure Definition at line 607 of file file.c. References ast_filestream::owner. Referenced by ast_streamfile(). { s->owner = chan; return 0; }

int ast_closestream (  struct ast_filestream *  f  )

Closes a stream. Parameters: f  filestream to close Close a playback or recording stream Returns 0 on success, -1 on failure Definition at line 652 of file file.c. References AST_FORMAT_MAX_AUDIO, ast_safe_system(), ast_sched_del(), ast_settimeout(), ast_translator_free_path(), ast_format::close, ast_filestream::filename, ast_filestream::fmt, ast_format::format, free, ast_filestream::owner, ast_filestream::realfilename, ast_channel::sched, ast_channel::stream, ast_channel::streamid, ast_filestream::trans, ast_channel::vstream, and ast_channel::vstreamid. Referenced by ast_app_getvoice(), ast_hangup(), ast_play_and_prepend(), ast_play_and_record(), and ast_stopstream(). { char *cmd = NULL; size_t size = 0; /* Stop a running stream if there is one */ if (f->owner) { if (f->fmt->format < AST_FORMAT_MAX_AUDIO) { f->owner->stream = NULL; if (f->owner->streamid > -1) ast_sched_del(f->owner->sched, f->owner->streamid); f->owner->streamid = -1; #ifdef ZAPTEL_OPTIMIZATIONS ast_settimeout(f->owner, 0, NULL, NULL); #endif } else { f->owner->vstream = NULL; if (f->owner->vstreamid > -1) ast_sched_del(f->owner->sched, f->owner->vstreamid); f->owner->vstreamid = -1; } } /* destroy the translator on exit */ if (f->trans) { ast_translator_free_path(f->trans); f->trans = NULL; } if (f->realfilename && f->filename) { size = strlen(f->filename) + strlen(f->realfilename) + 15; cmd = alloca(size); memset(cmd,0,size); snprintf(cmd,size,"/bin/mv -f %s %s",f->filename,f->realfilename); ast_safe_system(cmd); } if (f->filename) { free(f->filename); f->filename = NULL; } if (f->realfilename) { free(f->realfilename); f->realfilename = NULL; } f->fmt->close(f); return 0; }

int ast_file_init (  void   )

Initialize file stuff. Initializes all the various file stuff. Basically just registers the cli stuff Returns 0 all the time Definition at line 1165 of file file.c. References ast_cli_register(). Referenced by main(). { ast_cli_register(&show_file); return 0; }

int ast_filecopy (  char *  oldname, char *  newname, char *  fmt )

Copies a file. Parameters: oldname  name of the file you wish to copy (minus extension) newname  name you wish the file to be copied to (minus extension) fmt  the format of the file Copy a given file in a given format, or if fmt is NULL, then do so for all Definition at line 758 of file file.c. References ACTION_COPY. { return ast_filehelper(filename, filename2, fmt, ACTION_COPY); }

int ast_filedelete (  char *  filename, char *  fmt )

Deletes a file. Parameters: filename  name of the file you wish to delete (minus the extension) format  of the file Delete a given file in a given format, or if fmt is NULL, then do so for all Definition at line 748 of file file.c. References ACTION_DELETE. Referenced by ast_play_and_prepend(). { return ast_filehelper(filename, NULL, fmt, ACTION_DELETE); }

int ast_fileexists (  char *  filename, char *  fmt, char *  preflang )

Checks for the existence of a given file. Parameters: filename  name of the file you wish to check, minus the extension fmt  the format you wish to check (the extension) preflang  (the preferred language you wisht to find the file in) See if a given file exists in a given format. If fmt is NULL, any format is accepted. Returns -1 if file does not exist, non-zero positive otherwise. Definition at line 700 of file file.c. References ACTION_EXISTS, and MAX_LANGUAGE. Referenced by ast_openstream(), and ast_openvstream(). { char filename2[256]; char tmp[256]; char *postfix; char *prefix; char *c; char lang2[MAX_LANGUAGE]; int res = -1; if (preflang && !ast_strlen_zero(preflang)) { /* Insert the language between the last two parts of the path */ strncpy(tmp, filename, sizeof(tmp) - 1); c = strrchr(tmp, '/'); if (c) { *c = '\0'; postfix = c+1; prefix = tmp; snprintf(filename2, sizeof(filename2), "%s/%s/%s", prefix, preflang, postfix); } else { postfix = tmp; prefix=""; snprintf(filename2, sizeof(filename2), "%s/%s", preflang, postfix); } res = ast_filehelper(filename2, NULL, fmt, ACTION_EXISTS); if (res < 1) { char *stringp=NULL; strncpy(lang2, preflang, sizeof(lang2)-1); stringp=lang2; strsep(&stringp, "_"); /* If language is a specific locality of a language (like es_MX), strip the locality and try again */ if (strcmp(lang2, preflang)) { if (ast_strlen_zero(prefix)) { snprintf(filename2, sizeof(filename2), "%s/%s", lang2, postfix); } else { snprintf(filename2, sizeof(filename2), "%s/%s/%s", prefix, lang2, postfix); } res = ast_filehelper(filename2, NULL, fmt, ACTION_EXISTS); } } } /* Fallback to no language (usually winds up being American English) */ if (res < 1) { res = ast_filehelper(filename, NULL, fmt, ACTION_EXISTS); } return res; }

int ast_filerename (  char *  oldname, char *  newname, char *  fmt )

Renames a file. Parameters: oldname  the name of the file you wish to act upon (minus the extension) newname  the name you wish to rename the file to (minus the extension) fmt  the format of the file Rename a given file in a given format, or if fmt is NULL, then do so for all Returns -1 on failure Definition at line 753 of file file.c. References ACTION_RENAME. Referenced by ast_play_and_prepend(). { return ast_filehelper(filename, filename2, fmt, ACTION_RENAME); }

int ast_format_register (  char *  name, char *  exts, int  format, struct ast_filestream *(*)(int fd)  open, struct ast_filestream *(*)(int fd, char *comment)  rewrite, int(*)(struct ast_filestream *, struct ast_frame *)  write, int(*)(struct ast_filestream *, long offset, int whence)  seek, int(*)(struct ast_filestream *)  trunc, long(*)(struct ast_filestream *)  tell, struct ast_frame *(*)(struct ast_filestream *, int *timetonext)  read, void(*)(struct ast_filestream *)  close, char *(*)(struct ast_filestream *)  getcomment )

Registers a new file format. Register a new file format capability Adds a format to asterisk's format abilities. Fill in the fields, and it will work. For examples, look at some of the various format code. returns 0 on success, -1 on failure

int ast_format_unregister (  char *  name  )

Unregisters a file format. Parameters: name  the name of the format you wish to unregister Unregisters a format based on the name of the format. Returns 0 on success, -1 on failure to unregister Definition at line 141 of file file.c. References ast_log(), ast_mutex_lock, ast_mutex_unlock, ast_verbose(), free, LOG_WARNING, ast_format::name, ast_format::next, option_verbose, and VERBOSE_PREFIX_2. { struct ast_format *tmp, *tmpl = NULL; if (ast_mutex_lock(&formatlock)) { ast_log(LOG_WARNING, "Unable to lock format list\n"); return -1; } tmp = formats; while(tmp) { if (!strcasecmp(name, tmp->name)) { if (tmpl) tmpl->next = tmp->next; else formats = tmp->next; free(tmp); ast_mutex_unlock(&formatlock); if (option_verbose > 1) ast_verbose( VERBOSE_PREFIX_2 "Unregistered format %s\n", name); return 0; } tmpl = tmp; tmp = tmp->next; } ast_log(LOG_WARNING, "Tried to unregister format %s, already unregistered\n", name); return -1; }

struct ast_filestream* ast_openstream (  struct ast_channel *  chan, char *  filename, char *  preflang )

Opens stream for use in seeking, playing. Parameters: chan  channel to work with filename  to use preflang  prefered language to use Returns a ast_filestream pointer if it opens the file, NULL on error Definition at line 435 of file file.c. References ACTION_OPEN, ast_deactivate_generator(), ast_fileexists(), ast_log(), ast_set_write_format(), ast_stopstream(), ast_channel::generator, LOG_WARNING, ast_channel::oldwriteformat, and ast_channel::writeformat. Referenced by ast_streamfile(). { /* This is a fairly complex routine. Essentially we should do the following: 1) Find which file handlers produce our type of format. 2) Look for a filename which it can handle. 3) If we find one, then great. 4) If not, see what files are there 5) See what we can actually support 6) Choose the one with the least costly translator path and set it up. */ int fd = -1; int fmts = -1; char filename2[256]=""; char filename3[256]=""; char *endpart; int res; ast_stopstream(chan); /* do this first, otherwise we detect the wrong writeformat */ if (chan->generator) ast_deactivate_generator(chan); if (preflang && !ast_strlen_zero(preflang)) { strncpy(filename3, filename, sizeof(filename3) - 1); endpart = strrchr(filename3, '/'); if (endpart) { *endpart = '\0'; endpart++; snprintf(filename2, sizeof(filename2), "%s/%s/%s", filename3, preflang, endpart); } else snprintf(filename2, sizeof(filename2), "%s/%s", preflang, filename); fmts = ast_fileexists(filename2, NULL, NULL); } if (fmts < 1) { strncpy(filename2, filename, sizeof(filename2)-1); fmts = ast_fileexists(filename2, NULL, NULL); } if (fmts < 1) { ast_log(LOG_WARNING, "File %s does not exist in any format\n", filename); return NULL; } chan->oldwriteformat = chan->writeformat; /* Set the channel to a format we can work with */ res = ast_set_write_format(chan, fmts); fd = ast_filehelper(filename2, (char *)chan, NULL, ACTION_OPEN); if (fd >= 0) return chan->stream; return NULL; }

struct ast_filestream* ast_openvstream (  struct ast_channel *  chan, char *  filename, char *  preflang )

Opens stream for use in seeking, playing. Parameters: chan  channel to work with filename  to use preflang  prefered language to use Returns a ast_filestream pointer if it opens the file, NULL on error Definition at line 488 of file file.c. References ACTION_OPEN, ast_fileexists(), ast_log(), ast_filestream::fmt, LOG_WARNING, and MAX_LANGUAGE. Referenced by ast_streamfile(). { /* This is a fairly complex routine. Essentially we should do the following: 1) Find which file handlers produce our type of format. 2) Look for a filename which it can handle. 3) If we find one, then great. 4) If not, see what files are there 5) See what we can actually support 6) Choose the one with the least costly translator path and set it up. */ int fd = -1; int fmts = -1; char filename2[256]; char lang2[MAX_LANGUAGE]; /* XXX H.263 only XXX */ char *fmt = "h263"; if (preflang && !ast_strlen_zero(preflang)) { snprintf(filename2, sizeof(filename2), "%s/%s", preflang, filename); fmts = ast_fileexists(filename2, fmt, NULL); if (fmts < 1) { strncpy(lang2, preflang, sizeof(lang2)-1); snprintf(filename2, sizeof(filename2), "%s/%s", lang2, filename); fmts = ast_fileexists(filename2, fmt, NULL); } } if (fmts < 1) { strncpy(filename2, filename, sizeof(filename2)-1); fmts = ast_fileexists(filename2, fmt, NULL); } if (fmts < 1) { return NULL; } fd = ast_filehelper(filename2, (char *)chan, fmt, ACTION_OPEN); if (fd >= 0) return chan->vstream; ast_log(LOG_WARNING, "File %s has video but couldn't be opened\n", filename); return NULL; }

int ast_playstream (  struct ast_filestream *  s  )

play a open stream on a channel. Parameters: ast_filestream  s to play Returns 0 for success, -1 on failure Definition at line 613 of file file.c. References AST_FORMAT_MAX_AUDIO, ast_filestream::fmt, and ast_format::format. Referenced by ast_streamfile(). { if (s->fmt->format < AST_FORMAT_MAX_AUDIO) ast_readaudio_callback(s); else ast_readvideo_callback(s); return 0; }

struct ast_filestream* ast_readfile (  char *  filename, char *  type, char *  comment, int  flags, int  check, mode_t  mode )

Starts reading from a file. Parameters: filename  the name of the file to read from type  format of file you wish to read from comment  comment to go with flags  file flags check  (unimplemented, hence negligible) mode  Open mode Open an incoming file stream. flags are flags for the open() command, and if check is non-zero, then it will not read a file if there are any files that start with that name and have an extension Please note, this is a blocking function. Program execution will not return until ast_waitstream completes it's execution. Returns a struct ast_filestream on success, NULL on failure Definition at line 791 of file file.c. References ast_log(), ast_mutex_lock, ast_mutex_unlock, ast_format::exts, ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, free, LOG_WARNING, ast_filestream::mode, ast_format::next, ast_format::open, strdup, ast_filestream::trans, and ast_filestream::vfs. Referenced by ast_play_and_prepend(). { int fd,myflags = 0; struct ast_format *f; struct ast_filestream *fs=NULL; char *fn; char *ext; if (ast_mutex_lock(&formatlock)) { ast_log(LOG_WARNING, "Unable to lock format list\n"); return NULL; } f = formats; while(f) { if (exts_compare(f->exts, type)) { char *stringp=NULL; /* XXX Implement check XXX */ ext = strdup(f->exts); stringp=ext; ext = strsep(&stringp, "|"); fn = build_filename(filename, ext); fd = open(fn, flags | myflags); if (fd >= 0) { errno = 0; if ((fs = f->open(fd))) { fs->trans = NULL; fs->fmt = f; fs->flags = flags; fs->mode = mode; fs->filename = strdup(filename); fs->vfs = NULL; } else { ast_log(LOG_WARNING, "Unable to open %s\n", fn); close(fd); unlink(fn); } } else if (errno != EEXIST) ast_log(LOG_WARNING, "Unable to open file %s: %s\n", fn, strerror(errno)); free(fn); free(ext); break; } f = f->next; } ast_mutex_unlock(&formatlock); if (!f) ast_log(LOG_WARNING, "No such format '%s'\n", type); return fs; }

struct ast_frame* ast_readframe (  struct ast_filestream *  s  )

Read a frame from a filestream. Parameters: ast_filestream  fs to act on Returns a frame or NULL if read failed Definition at line 531 of file file.c. References ast_filestream::fmt, and ast_format::read. Referenced by ast_play_and_prepend(). { struct ast_frame *f = NULL; int whennext = 0; if (s && s->fmt) f = s->fmt->read(s, &whennext); return f; }

int ast_seekstream (  struct ast_filestream *  fs, long  sample_offset, int  whence )

Seeks into stream. Parameters: ast_filestream  to perform seek on sample_offset  numbers of samples to seek whence  SEEK_SET, SEEK_CUR, SEEK_END Returns 0 for success, or -1 for error Definition at line 622 of file file.c. References ast_filestream::fmt, and ast_format::seek. Referenced by ast_control_streamfile(), ast_read(), ast_stream_fastforward(), ast_stream_rewind(), and ast_write(). { return fs->fmt->seek(fs, sample_offset, whence); }

int ast_stopstream (  struct ast_channel *  c  )

Stops a stream. Parameters: c  The channel you wish to stop playback on Stop playback of a stream Returns 0 regardless Definition at line 168 of file file.c. References ast_closestream(), ast_log(), ast_set_write_format(), LOG_WARNING, ast_channel::oldwriteformat, ast_channel::stream, and ast_channel::vstream. Referenced by ast_control_streamfile(), ast_openstream(), ast_play_and_wait(), ast_readstring(), ast_readstring_full(), ast_say_character_str(), ast_say_character_str_full(), ast_say_digit_str(), ast_say_digit_str_full(), ast_say_phonetic_str(), ast_say_phonetic_str_full(), ast_waitstream(), ast_waitstream_fr(), and ast_waitstream_full(). { /* Stop a running stream if there is one */ if (tmp->vstream) ast_closestream(tmp->vstream); if (tmp->stream) { ast_closestream(tmp->stream); if (tmp->oldwriteformat && ast_set_write_format(tmp, tmp->oldwriteformat)) ast_log(LOG_WARNING, "Unable to restore format back to %d\n", tmp->oldwriteformat); } return 0; }

int ast_stream_fastforward (  struct ast_filestream *  fs, long  ms )

Fast forward stream ms. Parameters: ast_filestream  fs filestream to act on ms  milliseconds to move Returns 0 for success, or -1 for error Definition at line 637 of file file.c. References ast_seekstream(), and ast_frame::samples. Referenced by ast_control_streamfile(), and ast_waitstream_fr(). { /* I think this is right, 8000 samples per second, 1000 ms a second so 8 * samples per ms */ long samples = ms * 8; return ast_seekstream(fs, samples, SEEK_CUR); }

int ast_stream_rewind (  struct ast_filestream *  fs, long  ms )

Rewind stream ms. Parameters: ast_filestream  fs filestream to act on ms  milliseconds to move Returns 0 for success, or -1 for error Definition at line 645 of file file.c. References ast_seekstream(), and ast_frame::samples. Referenced by ast_play_and_prepend(), ast_play_and_record(), and ast_waitstream_fr(). { long samples = ms * 8; samples = samples * -1; return ast_seekstream(fs, samples, SEEK_CUR); }

int ast_streamfile (  struct ast_channel *  c, char *  filename, char *  preflang )

Streams a file. Parameters: c  channel to stream the file to filename  the name of the file you wish to stream, minus the extension preflang  the preferred language you wish to have the file streamed to you in Prepares a channel for the streaming of a file. To start the stream, afterward do a ast_waitstream() on the channel Also, it will stop any existing streams on the channel. Returns 0 on success, or -1 on failure. Definition at line 763 of file file.c. References ast_applystream(), ast_getformatname(), ast_log(), ast_openstream(), ast_openvstream(), ast_playstream(), ast_verbose(), LOG_DEBUG, LOG_WARNING, ast_channel::nativeformats, option_verbose, VERBOSE_PREFIX_3, and ast_filestream::vfs. Referenced by ast_app_getdata(), ast_app_getdata_full(), ast_app_getvoice(), ast_control_streamfile(), ast_play_and_prepend(), ast_play_and_record(), ast_play_and_wait(), ast_say_character_str(), ast_say_character_str_full(), ast_say_digit_str(), ast_say_digit_str_full(), ast_say_phonetic_str(), and ast_say_phonetic_str_full(). { struct ast_filestream *fs; struct ast_filestream *vfs; fs = ast_openstream(chan, filename, preflang); vfs = ast_openvstream(chan, filename, preflang); if (vfs) ast_log(LOG_DEBUG, "Ooh, found a video stream, too\n"); if (fs){ if (ast_applystream(chan, fs)) return -1; if (vfs && ast_applystream(chan, vfs)) return -1; if (ast_playstream(fs)) return -1; if (vfs && ast_playstream(vfs)) return -1; #if 1 if (option_verbose > 2) ast_verbose(VERBOSE_PREFIX_3 "Playing '%s' (language '%s')\n", filename, preflang ? preflang : "default"); #endif return 0; } ast_log(LOG_WARNING, "Unable to open %s (format %s): %s\n", filename, ast_getformatname(chan->nativeformats), strerror(errno)); return -1; }

long ast_tellstream (  struct ast_filestream *  fs  )

Tell where we are in a stream. Parameters: ast_filestream  fs to act on Returns a long as a sample offset into stream Definition at line 632 of file file.c. References ast_filestream::fmt, and ast_format::tell. { return fs->fmt->tell(fs); }

int ast_truncstream (  struct ast_filestream *  fs  )

Trunc stream at current location. Parameters: ast_filestream  fs Returns 0 for success, or -1 for error Definition at line 627 of file file.c. References ast_filestream::fmt, and ast_format::trunc. Referenced by ast_play_and_prepend(), and ast_play_and_record(). { return fs->fmt->trunc(fs); }

int ast_waitstream (  struct ast_channel *  c, char *  breakon )

Waits for a stream to stop or digit to be pressed. Parameters: c  channel to waitstram on breakon  string of DTMF digits to break upon Begins playback of a stream... Wait for a stream to stop or for any one of a given digit to arrive, Returns 0 if the stream finishes, the character if it was interrupted, and -1 on error Definition at line 935 of file file.c. References ast_channel::_softhangup, AST_CONTROL_ANSWER, AST_CONTROL_HANGUP, AST_CONTROL_RINGING, AST_FRAME_CONTROL, AST_FRAME_DTMF, ast_frfree(), ast_log(), ast_read(), ast_sched_runq(), ast_sched_wait(), ast_stopstream(), ast_waitfor(), ast_frame::frametype, LOG_DEBUG, LOG_WARNING, ast_channel::sched, ast_channel::stream, ast_frame::subclass, and ast_channel::timingfunc. Referenced by ast_app_getvoice(), ast_play_and_prepend(), ast_play_and_record(), ast_play_and_wait(), ast_readstring(), ast_say_character_str(), ast_say_digit_str(), and ast_say_phonetic_str(). { /* XXX Maybe I should just front-end ast_waitstream_full ? XXX */ int res; struct ast_frame *fr; if (!breakon) breakon = ""; while(c->stream) { res = ast_sched_wait(c->sched); if ((res < 0) && !c->timingfunc) { ast_stopstream(c); break; } if (res < 0) res = 1000; res = ast_waitfor(c, res); if (res < 0) { ast_log(LOG_WARNING, "Select failed (%s)\n", strerror(errno)); return res; } else if (res > 0) { fr = ast_read(c); if (!fr) { #if 0 ast_log(LOG_DEBUG, "Got hung up\n"); #endif return -1; } switch(fr->frametype) { case AST_FRAME_DTMF: res = fr->subclass; if (strchr(breakon, res)) { ast_frfree(fr); return res; } break; case AST_FRAME_CONTROL: switch(fr->subclass) { case AST_CONTROL_HANGUP: ast_frfree(fr); return -1; case AST_CONTROL_RINGING: case AST_CONTROL_ANSWER: /* Unimportant */ break; default: ast_log(LOG_WARNING, "Unexpected control subclass '%d'\n", fr->subclass); } } /* Ignore */ ast_frfree(fr); } ast_sched_runq(c->sched); } return (c->_softhangup ? -1 : 0); }

int ast_waitstream_fr (  struct ast_channel *  c, char *  breakon, char *  forward, char *  rewind, int  ms )

Same as waitstream but allows stream to be forwarded or rewound. Parameters: c  channel to waitstram on breakon  string of DTMF digits to break upon forward  DTMF digit to fast forward upon rewind  DTMF digit to rewind upon ms  How many miliseconds to skip forward/back Begins playback of a stream... Wait for a stream to stop or for any one of a given digit to arrive, Returns 0 if the stream finishes, the character if it was interrupted, and -1 on error Definition at line 991 of file file.c. References ast_channel::_softhangup, AST_CONTROL_ANSWER, AST_CONTROL_HANGUP, AST_CONTROL_RINGING, AST_FRAME_CONTROL, AST_FRAME_DTMF, ast_frfree(), ast_log(), ast_read(), ast_sched_runq(), ast_sched_wait(), ast_stopstream(), ast_stream_fastforward(), ast_stream_rewind(), ast_waitfor(), ast_frame::frametype, LOG_DEBUG, LOG_WARNING, ast_channel::sched, ast_channel::stream, ast_frame::subclass, and ast_channel::timingfunc. Referenced by ast_control_streamfile(). { int res; struct ast_frame *fr; if (!breakon) breakon = ""; if (!forward) forward = ""; if (!rewind) rewind = ""; while(c->stream) { res = ast_sched_wait(c->sched); if ((res < 0) && !c->timingfunc) { ast_stopstream(c); break; } if (res < 0) res = 1000; res = ast_waitfor(c, res); if (res < 0) { ast_log(LOG_WARNING, "Select failed (%s)\n", strerror(errno)); return res; } else if (res > 0) { fr = ast_read(c); if (!fr) { #if 0 ast_log(LOG_DEBUG, "Got hung up\n"); #endif return -1; } switch(fr->frametype) { case AST_FRAME_DTMF: res = fr->subclass; if (strchr(forward,res)) { ast_stream_fastforward(c->stream, ms); } else if (strchr(rewind,res)) { ast_stream_rewind(c->stream, ms); } else if (strchr(breakon, res)) { ast_frfree(fr); return res; } break; case AST_FRAME_CONTROL: switch(fr->subclass) { case AST_CONTROL_HANGUP: ast_frfree(fr); return -1; case AST_CONTROL_RINGING: case AST_CONTROL_ANSWER: /* Unimportant */ break; default: ast_log(LOG_WARNING, "Unexpected control subclass '%d'\n", fr->subclass); } } /* Ignore */ ast_frfree(fr); } else ast_sched_runq(c->sched); } return (c->_softhangup ? -1 : 0); }

int ast_waitstream_full (  struct ast_channel *  c, char *  breakon, int  audiofd, int  monfd )

Definition at line 1060 of file file.c. References ast_channel::_softhangup, AST_CONTROL_ANSWER, AST_CONTROL_HANGUP, AST_CONTROL_RINGING, AST_FRAME_CONTROL, AST_FRAME_DTMF, AST_FRAME_VOICE, ast_frfree(), ast_log(), ast_read(), ast_sched_runq(), ast_sched_wait(), ast_stopstream(), ast_waitfor_nandfds(), ast_frame::data, ast_frame::datalen, ast_frame::frametype, LOG_DEBUG, LOG_WARNING, ast_channel::sched, ast_channel::stream, ast_frame::subclass, and ast_channel::timingfunc. Referenced by ast_readstring_full(), ast_say_character_str_full(), ast_say_digit_str_full(), and ast_say_phonetic_str_full(). { int res; int ms; int outfd; struct ast_frame *fr; struct ast_channel *rchan; if (!breakon) breakon = ""; while(c->stream) { ms = ast_sched_wait(c->sched); if ((ms < 0) && !c->timingfunc) { ast_stopstream(c); break; } if (ms < 0) ms = 1000; rchan = ast_waitfor_nandfds(&c, 1, &cmdfd, (cmdfd > -1) ? 1 : 0, NULL, &outfd, &ms); if (!rchan && (outfd < 0) && (ms)) { /* Continue */ if (errno == EINTR) continue; ast_log(LOG_WARNING, "Wait failed (%s)\n", strerror(errno)); return -1; } else if (outfd > -1) { /* The FD we were watching has something waiting */ return 1; } else if (rchan) { fr = ast_read(c); if (!fr) { #if 0 ast_log(LOG_DEBUG, "Got hung up\n"); #endif return -1; } switch(fr->frametype) { case AST_FRAME_DTMF: res = fr->subclass; if (strchr(breakon, res)) { ast_frfree(fr); return res; } break; case AST_FRAME_CONTROL: switch(fr->subclass) { case AST_CONTROL_HANGUP: ast_frfree(fr); return -1; case AST_CONTROL_RINGING: case AST_CONTROL_ANSWER: /* Unimportant */ break; default: ast_log(LOG_WARNING, "Unexpected control subclass '%d'\n", fr->subclass); } case AST_FRAME_VOICE: /* Write audio if appropriate */ if (audiofd > -1) write(audiofd, fr->data, fr->datalen); } /* Ignore */ ast_frfree(fr); } ast_sched_runq(c->sched); } return (c->_softhangup ? -1 : 0); }

struct ast_filestream* ast_writefile (  char *  filename, char *  type, char *  comment, int  flags, int  check, mode_t  mode )

Starts writing a file. Parameters: filename  the name of the file to write to type  format of file you wish to write out to comment  comment to go with oflags  output file flags check  (unimplemented, hence negligible) mode  Open mode Create an outgoing file stream. oflags are flags for the open() command, and if check is non-zero, then it will not write a file if there are any files that start with that name and have an extension Please note, this is a blocking function. Program execution will not return until ast_waitstream completes it's execution. Returns a struct ast_filestream on success, NULL on failure Definition at line 840 of file file.c. References ast_log(), ast_mutex_lock, ast_mutex_unlock, ast_format::exts, ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, free, LOG_WARNING, ast_filestream::mode, ast_format::next, option_cache_record_files, ast_filestream::realfilename, record_cache_dir, ast_format::rewrite, strdup, ast_filestream::trans, and ast_filestream::vfs. Referenced by ast_app_getvoice(), ast_play_and_prepend(), ast_play_and_record(), and ast_writestream(). { int fd,myflags = 0; struct ast_format *f; struct ast_filestream *fs=NULL; char *fn,*orig_fn=NULL; char *ext; char *buf=NULL; size_t size = 0; if (ast_mutex_lock(&formatlock)) { ast_log(LOG_WARNING, "Unable to lock format list\n"); return NULL; } /* set the O_TRUNC flag if and only if there is no O_APPEND specified */ if (flags & O_APPEND){ /* We really can't use O_APPEND as it will break WAV header updates */ flags &= ~O_APPEND; }else{ myflags = O_TRUNC; } myflags |= O_WRONLY | O_CREAT; f = formats; while(f) { if (exts_compare(f->exts, type)) { char *stringp=NULL; /* XXX Implement check XXX */ ext = ast_strdupa(f->exts); stringp=ext; ext = strsep(&stringp, "|"); fn = build_filename(filename, ext); fd = open(fn, flags | myflags, mode); if (option_cache_record_files && fd >= 0) { close(fd); /* We touch orig_fn just as a place-holder so other things (like vmail) see the file is there. What we are really doing is writing to record_cache_dir until we are done then we will mv the file into place. */ orig_fn = ast_strdupa(fn); for (size=0;size<strlen(fn);size++) { if (fn[size] == '/') fn[size] = '_'; } size += (strlen(record_cache_dir) + 10); buf = alloca(size); memset(buf, 0, size); snprintf(buf, size, "%s/%s", record_cache_dir, fn); free(fn); fn=buf; fd = open(fn, flags | myflags, mode); } if (fd >= 0) { errno = 0; if ((fs = f->rewrite(fd, comment))) { fs->trans = NULL; fs->fmt = f; fs->flags = flags; fs->mode = mode; if (option_cache_record_files) { fs->realfilename = build_filename(filename, ext); fs->filename = strdup(fn); } else { fs->realfilename = NULL; fs->filename = strdup(filename); } fs->vfs = NULL; } else { ast_log(LOG_WARNING, "Unable to rewrite %s\n", fn); close(fd); unlink(fn); if (orig_fn) unlink(orig_fn); } } else if (errno != EEXIST) { ast_log(LOG_WARNING, "Unable to open file %s: %s\n", fn, strerror(errno)); if (orig_fn) unlink(orig_fn); } if (!buf) /* if buf != NULL then fn is already free and pointing to it */ free(fn); break; } f = f->next; } ast_mutex_unlock(&formatlock); if (!f) ast_log(LOG_WARNING, "No such format '%s'\n", type); return fs; }

int ast_writestream (  struct ast_filestream *  fs, struct ast_frame *  f )

Writes a frame to a stream. Parameters: fs  filestream to write to f  frame to write to the filestream Send a frame to a filestream -- note: does NOT free the frame, call ast_frfree manually Returns 0 on success, -1 on failure. Definition at line 181 of file file.c. References AST_FORMAT_MAX_AUDIO, AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_getformatname(), ast_log(), ast_translate(), ast_translator_build_path(), ast_translator_free_path(), ast_writefile(), ast_writestream(), ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, ast_format::format, ast_frame::frametype, ast_filestream::lastwriteformat, LOG_DEBUG, LOG_WARNING, ast_filestream::mode, ast_format::name, ast_frame::subclass, ast_filestream::trans, type, ast_filestream::vfs, and ast_format::write. Referenced by ast_play_and_prepend(), ast_play_and_record(), ast_read(), ast_write(), and ast_writestream(). { struct ast_frame *trf; int res = -1; int alt=0; if (f->frametype == AST_FRAME_VIDEO) { if (fs->fmt->format < AST_FORMAT_MAX_AUDIO) { /* This is the audio portion. Call the video one... */ if (!fs->vfs && fs->filename) { /* XXX Support other video formats XXX */ char *type = "h263"; fs->vfs = ast_writefile(fs->filename, type, NULL, fs->flags, 0, fs->mode); ast_log(LOG_DEBUG, "Opened video output file\n"); } if (fs->vfs) return ast_writestream(fs->vfs, f); /* Ignore */ return 0; } else { /* Might / might not have mark set */ alt = 1; } } else if (f->frametype != AST_FRAME_VOICE) { ast_log(LOG_WARNING, "Tried to write non-voice frame\n"); return -1; } if (((fs->fmt->format | alt) & f->subclass) == f->subclass) { res = fs->fmt->write(fs, f); if (res < 0) ast_log(LOG_WARNING, "Natural write failed\n"); if (res > 0) ast_log(LOG_WARNING, "Huh??\n"); return res; } else { /* XXX If they try to send us a type of frame that isn't the normal frame, and isn't the one we've setup a translator for, we do the "wrong thing" XXX */ if (fs->trans && (f->subclass != fs->lastwriteformat)) { ast_translator_free_path(fs->trans); fs->trans = NULL; } if (!fs->trans) fs->trans = ast_translator_build_path(fs->fmt->format, f->subclass); if (!fs->trans) ast_log(LOG_WARNING, "Unable to translate to format %s, source format %s\n", fs->fmt->name, ast_getformatname(f->subclass)); else { fs->lastwriteformat = f->subclass; res = 0; /* Get the translated frame but don't consume the original in case they're using it on another stream */ trf = ast_translate(fs->trans, f, 0); if (trf) { res = fs->fmt->write(fs, trf); if (res) ast_log(LOG_WARNING, "Translated frame write failed\n"); } else res = 0; } return res; } }

---