Sat Nov 1 06:31:04 2008

Asterisk developer's documentation

---

file.h File Reference

Generic File Format Support. More...

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

Include dependency graph for file.h:

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

Go to the source code of this file.

Defines
#define	AST_DIGIT_ANY   "0123456789#*ABCD"
#define	AST_DIGIT_ANYNUM   "0123456789"
#define	AST_RESERVED_POINTERS   20
#define	SEEK_FORCECUR   10
Functions
int	ast_applystream (struct ast_channel *chan, struct ast_filestream *s)
int	ast_closestream (struct ast_filestream *f)
int	ast_file_init (void)
int	ast_filecopy (const char *oldname, const char *newname, const char *fmt)
int	ast_filedelete (const char *filename, const char *fmt)
int	ast_fileexists (const char *filename, const char *fmt, const char *preflang)
int	ast_filerename (const char *oldname, const char *newname, const char *fmt)
int	ast_format_register (const char *name, const char *exts, int format, struct ast_filestream *(*open)(FILE *f), struct ast_filestream *(*rewrite)(FILE *f, const 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 *))
int	ast_format_unregister (const char *name)
ast_filestream *	ast_openstream (struct ast_channel *chan, const char *filename, const char *preflang)
ast_filestream *	ast_openstream_full (struct ast_channel *chan, const char *filename, const char *preflang, int asis)
ast_filestream *	ast_openvstream (struct ast_channel *chan, const char *filename, const char *preflang)
int	ast_playstream (struct ast_filestream *s)
ast_filestream *	ast_readfile (const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode)
ast_frame *	ast_readframe (struct ast_filestream *s)
int	ast_seekstream (struct ast_filestream *fs, long sample_offset, int whence)
int	ast_stopstream (struct ast_channel *c)
int	ast_stream_fastforward (struct ast_filestream *fs, long ms)
int	ast_stream_rewind (struct ast_filestream *fs, long ms)
int	ast_streamfile (struct ast_channel *c, const char *filename, const char *preflang)
long	ast_tellstream (struct ast_filestream *fs)
int	ast_truncstream (struct ast_filestream *fs)
int	ast_waitstream (struct ast_channel *c, const char *breakon)
int	ast_waitstream_exten (struct ast_channel *c, const char *context)
int	ast_waitstream_fr (struct ast_channel *c, const char *breakon, const char *forward, const char *rewind, int ms)
int	ast_waitstream_full (struct ast_channel *c, const char *breakon, int audiofd, int monfd)
ast_filestream *	ast_writefile (const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode)
int	ast_writestream (struct ast_filestream *fs, struct ast_frame *f)

---

Detailed Description

Generic File Format Support.

Definition in file file.h.

---

Define Documentation

#define AST_DIGIT_ANY   "0123456789#*ABCD"

Convenient for waiting

Definition at line 41 of file file.h.

Referenced by __login_exec(), ast_ivr_menu_run_internal(), ast_play_and_wait(), ast_readstring(), ast_readstring_full(), ast_record_review(), background_file(), bridge_playfile(), builtin_atxfer(), builtin_blindtransfer(), conf_exec(), conf_run(), dial_exec_full(), dictate_exec(), directory_exec(), festival_exec(), get_folder(), ivr_dispatch(), pbx_builtin_background(), play_file(), play_mailbox_owner(), play_message(), play_message_callerid(), play_message_datetime(), play_message_duration(), play_record_review(), retrydial_exec(), say_and_wait(), say_position(), sayunixtime_exec(), try_calling(), vm_intro_gr(), vm_intro_pt(), and wait_file2().

#define AST_DIGIT_ANYNUM   "0123456789"

Definition at line 42 of file file.h.

Referenced by initreqprep().

#define AST_RESERVED_POINTERS   20

Definition at line 312 of file file.h.

#define SEEK_FORCECUR   10

Definition at line 44 of file file.h.

Referenced by ast_read(), ast_write(), au_seek(), g729_seek(), gsm_seek(), ilbc_seek(), pcm_seek(), slinear_seek(), vox_seek(), and wav_seek().

---

Function Documentation

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

Parameters:

	chan	channel to work
	s	ast_filestream to apply Returns 0 for success, -1 on failure

Definition at line 649 of file file.c.

References s.

Referenced by ast_streamfile(), handle_getoption(), handle_recordfile(), and handle_streamfile().

{
   s->owner = chan;
   return 0;
}

int ast_closestream

(

struct ast_filestream *

f

)

Parameters:

f

filestream to close Close a playback or recording stream Returns 0 on success, -1 on failure

Definition at line 694 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_filehelper(), ast_hangup(), ast_moh_files_next(), ast_monitor_start(), ast_monitor_stop(), ast_play_and_prepend(), ast_play_and_record_full(), ast_stopstream(), dictate_exec(), gen_closestream(), handle_recordfile(), local_ast_moh_stop(), mixmonitor_thread(), moh_files_release(), and recordthread().

{
   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

)

Initializes all the various file stuff. Basically just registers the cli stuff Returns 0 all the time

Definition at line 1302 of file file.c.

References ast_cli_register(), and show_file.

Referenced by main().

{
   ast_cli_register(&show_file);
   return 0;
}

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

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 800 of file file.c.

References ACTION_COPY, and ast_filehelper().

Referenced by copy_file().

{
   return ast_filehelper(filename, filename2, fmt, ACTION_COPY);
}

int ast_filedelete	(	const char *	filename,
		const char *	fmt
	)

Parameters:

	filename	name of the file you wish to delete (minus the extension)
	fmt	of the file Delete a given file in a given format, or if fmt is NULL, then do so for all

Definition at line 790 of file file.c.

References ACTION_DELETE, and ast_filehelper().

Referenced by ast_monitor_start(), ast_monitor_stop(), ast_play_and_prepend(), dial_exec_full(), leave_voicemail(), play_mailbox_owner(), play_record_review(), and vm_delete().

{
   return ast_filehelper(filename, NULL, fmt, ACTION_DELETE);
}

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

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 742 of file file.c.

References ACTION_EXISTS, ast_filehelper(), ast_strlen_zero(), MAX_LANGUAGE, and strsep().

Referenced by app_exec(), ast_moh_files_next(), ast_monitor_start(), ast_monitor_stop(), ast_openstream_full(), ast_openvstream(), chanspy_exec(), conf_run(), dial_exec_full(), invent_message(), last_message_index(), leave_voicemail(), play_mailbox_owner(), play_message_callerid(), record_exec(), vm_newuser(), and vm_tempgreeting().

{
   char filename2[256];
   char tmp[256];
   char *postfix;
   char *prefix;
   char *c;
   char lang2[MAX_LANGUAGE];
   int res = -1;
   if (!ast_strlen_zero(preflang)) {
      /* Insert the language between the last two parts of the path */
      ast_copy_string(tmp, filename, sizeof(tmp));
      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;
         ast_copy_string(lang2, preflang, sizeof(lang2));
         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	(	const char *	oldname,
		const char *	newname,
		const char *	fmt
	)

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 795 of file file.c.

References ACTION_RENAME, and ast_filehelper().

Referenced by ast_monitor_stop(), ast_play_and_prepend(), leave_voicemail(), play_record_review(), and rename_file().

{
   return ast_filehelper(filename, filename2, fmt, ACTION_RENAME);
}

int ast_format_register	(	const char *	name,
		const char *	exts,
		int	format,
		struct ast_filestream *(*)(FILE *f)	open,
		struct ast_filestream *(*)(FILE *f, const 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
	)

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

(

const char *

name

)

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 156 of file file.c.

References ast_log(), ast_mutex_lock(), ast_mutex_unlock(), ast_verbose(), formats, free, LOG_WARNING, ast_format::name, ast_format::next, option_verbose, and VERBOSE_PREFIX_2.

Referenced by unload_module().

{
   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_mutex_unlock(&formatlock);
   ast_log(LOG_WARNING, "Tried to unregister format %s, already unregistered\n", name);
   return -1;
}

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

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 470 of file file.c.

References ast_openstream_full().

Referenced by ast_streamfile(), dictate_exec(), handle_getoption(), and handle_streamfile().

{
   return ast_openstream_full(chan, filename, preflang, 0);
}

struct ast_filestream* ast_openstream_full	(	struct ast_channel *	chan,
		const char *	filename,
		const char *	preflang,
		int	asis
	)

Parameters:

	chan	channel to work with
	filename	to use
	preflang	prefered language to use
	asis	if set, don't clear generators Returns a ast_filestream pointer if it opens the file, NULL on error

Definition at line 475 of file file.c.

References ACTION_OPEN, ast_deactivate_generator(), ast_fileexists(), ast_filehelper(), ast_log(), ast_set_write_format(), ast_stopstream(), ast_strlen_zero(), LOG_WARNING, ast_channel::oldwriteformat, and ast_channel::writeformat.

Referenced by ast_moh_files_next(), ast_openstream(), and gen_nextfile().

{
   /* 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 fmts = -1;
   char filename2[256]="";
   char filename3[256];
   char *endpart;
   int res;

   if (!asis) {
      /* do this first, otherwise we detect the wrong writeformat */
      ast_stopstream(chan);
      if (chan->generator)
         ast_deactivate_generator(chan);
   }
   if (!ast_strlen_zero(preflang)) {
      ast_copy_string(filename3, filename, sizeof(filename3));
      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) {
      ast_copy_string(filename2, filename, sizeof(filename2));
      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);
   
   res = ast_filehelper(filename2, (char *)chan, NULL, ACTION_OPEN);
   if (res >= 0)
      return chan->stream;
   return NULL;
}

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

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 530 of file file.c.

References ACTION_OPEN, ast_fileexists(), ast_filehelper(), ast_log(), ast_strlen_zero(), 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 (!ast_strlen_zero(preflang)) {
      snprintf(filename2, sizeof(filename2), "%s/%s", preflang, filename);
      fmts = ast_fileexists(filename2, fmt, NULL);
      if (fmts < 1) {
         ast_copy_string(lang2, preflang, sizeof(lang2));
         snprintf(filename2, sizeof(filename2), "%s/%s", lang2, filename);
         fmts = ast_fileexists(filename2, fmt, NULL);
      }
   }
   if (fmts < 1) {
      ast_copy_string(filename2, filename, sizeof(filename2));
      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

)

Parameters:

s

filestream to play Returns 0 for success, -1 on failure

Definition at line 655 of file file.c.

References AST_FORMAT_MAX_AUDIO, ast_readaudio_callback(), ast_readvideo_callback(), and s.

Referenced by ast_streamfile(), handle_getoption(), and handle_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	(	const char *	filename,
		const char *	type,
		const char *	comment,
		int	flags,
		int	check,
		mode_t	mode
	)

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 832 of file file.c.

References ast_log(), ast_mutex_lock(), ast_mutex_unlock(), build_filename(), exts_compare(), ast_filestream::f, ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, formats, free, LOG_WARNING, ast_filestream::mode, strdup, ast_filestream::trans, and ast_filestream::vfs.

Referenced by ast_play_and_prepend().

{
   FILE *bfile;
   struct ast_format *f;
   struct ast_filestream *fs = NULL;
   char *fn;

   if (ast_mutex_lock(&formatlock)) {
      ast_log(LOG_WARNING, "Unable to lock format list\n");
      return NULL;
   }

   for (f = formats; f && !fs; f = f->next) {
      if (!exts_compare(f->exts, type))
         continue;

      fn = build_filename(filename, type);
      bfile = fopen(fn, "r");
      if (bfile) {
         errno = 0;

         if (!(fs = f->open(bfile))) {
            ast_log(LOG_WARNING, "Unable to open %s\n", fn);
            fclose(bfile);
            free(fn);
            continue;
         }

         fs->trans = NULL;
         fs->fmt = f;
         fs->flags = flags;
         fs->mode = mode;
         fs->filename = strdup(filename);
         fs->vfs = NULL;
      } else if (errno != EEXIST)
         ast_log(LOG_WARNING, "Unable to open file %s: %s\n", fn, strerror(errno));
      free(fn);
   }

   ast_mutex_unlock(&formatlock);
   if (!fs) 
      ast_log(LOG_WARNING, "No such format '%s'\n", type);

   return fs;
}

struct ast_frame* ast_readframe

(

struct ast_filestream *

s

)

Parameters:

s

ast_filestream to act on Returns a frame or NULL if read failed

Definition at line 573 of file file.c.

References s.

Referenced by ast_play_and_prepend(), dictate_exec(), gen_readframe(), and moh_files_readframe().

{
   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
	)

Parameters:

	fs	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 664 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(), ast_write(), dictate_exec(), handle_getoption(), handle_recordfile(), and handle_streamfile().

{
   return fs->fmt->seek(fs, sample_offset, whence);
}

int ast_stopstream

(

struct ast_channel *

c

)

Parameters:

c

The channel you wish to stop playback on Stop playback of a stream Returns 0 regardless

Definition at line 184 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 adsi_transmit_message_full(), ast_control_streamfile(), ast_openstream_full(), ast_play_and_wait(), ast_readstring(), ast_readstring_full(), ast_say_character_str_full(), ast_say_digit_str_full(), ast_say_enumeration_full_da(), ast_say_enumeration_full_de(), ast_say_enumeration_full_en(), ast_say_number_full_cz(), ast_say_number_full_da(), ast_say_number_full_de(), ast_say_number_full_en(), ast_say_number_full_en_GB(), ast_say_number_full_es(), ast_say_number_full_fr(), ast_say_number_full_gr(), ast_say_number_full_he(), ast_say_number_full_it(), ast_say_number_full_nl(), ast_say_number_full_no(), ast_say_number_full_pt(), ast_say_number_full_ru(), ast_say_number_full_se(), ast_say_number_full_tw(), ast_say_phonetic_str_full(), ast_waitstream(), ast_waitstream_exten(), ast_waitstream_fr(), ast_waitstream_full(), background_detect_exec(), background_file(), builtin_blindtransfer(), conf_exec(), conf_run(), directory_exec(), handle_getoption(), handle_streamfile(), ices_exec(), ivr_dispatch(), leave_voicemail(), mp3_exec(), NBScat_exec(), parkandannounce_exec(), pbx_builtin_background(), pl_odtworz_plik(), play_file(), play_mailbox_owner(), playback_exec(), queue_exec(), read_exec(), recordthread(), rpt_tele_thread(), saycharstr(), sayfile(), saynum(), send_morse(), send_tone_telemetry(), send_waveform_to_channel(), vm_authenticate(), vm_execmain(), and zapateller_exec().

{
   /* Stop a running stream if there is one */
   if (tmp->vstream) {
      ast_closestream(tmp->vstream);
      tmp->vstream = NULL;
   }
   if (tmp->stream) {
      ast_closestream(tmp->stream);
      tmp->stream = NULL;
      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
	)

Parameters:

	fs	filestream to act on
	ms	milliseconds to move Returns 0 for success, or -1 for error

Definition at line 679 of file file.c.

References ast_seekstream(), and ast_frame::samples.

Referenced by 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
	)

Parameters:

	fs	filestream to act on
	ms	milliseconds to move Returns 0 for success, or -1 for error

Definition at line 687 of file file.c.

References ast_seekstream(), and ast_frame::samples.

Referenced by ast_play_and_prepend(), ast_play_and_record_full(), ast_waitstream_fr(), and handle_recordfile().

{
   long samples = ms * 8;
   samples = samples * -1;
   return ast_seekstream(fs, samples, SEEK_CUR);
}

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

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 805 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 __login_exec(), agent_call(), ast_app_getdata(), ast_app_getdata_full(), ast_app_getvoice(), ast_control_streamfile(), ast_play_and_prepend(), ast_play_and_record_full(), ast_play_and_wait(), ast_record_review(), ast_say_character_str_full(), ast_say_date_da(), ast_say_date_de(), ast_say_date_en(), ast_say_date_fr(), ast_say_date_gr(), ast_say_date_nl(), ast_say_date_with_format_gr(), ast_say_datetime_en(), ast_say_datetime_fr(), ast_say_datetime_from_now_en(), ast_say_datetime_from_now_fr(), ast_say_datetime_gr(), ast_say_datetime_nl(), ast_say_datetime_pt(), ast_say_datetime_tw(), ast_say_digit_str_full(), ast_say_enumeration_full_da(), ast_say_enumeration_full_de(), ast_say_enumeration_full_en(), ast_say_number_full_cz(), ast_say_number_full_da(), ast_say_number_full_de(), ast_say_number_full_en(), ast_say_number_full_en_GB(), ast_say_number_full_es(), ast_say_number_full_fr(), ast_say_number_full_gr(), ast_say_number_full_he(), ast_say_number_full_it(), ast_say_number_full_nl(), ast_say_number_full_no(), ast_say_number_full_pt(), ast_say_number_full_ru(), ast_say_number_full_se(), ast_say_number_full_tw(), ast_say_phonetic_str_full(), ast_say_time_de(), ast_say_time_en(), ast_say_time_fr(), ast_say_time_gr(), ast_say_time_nl(), ast_say_time_tw(), auth_exec(), background_detect_exec(), background_file(), bridge_playfile(), builtin_atxfer(), builtin_automonitor(), builtin_blindtransfer(), chanspy_exec(), check_availability(), check_beep(), conf_exec(), conf_run(), dial_exec_