Mon Apr 30 07:42:20 2007

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.

Data Structures
struct	ast_filestream
struct	ast_format
struct	ast_format_lock
Defines
#define	AST_DIGIT_ANY   "0123456789#*ABCD"
#define	AST_DIGIT_ANYNUM   "0123456789"
#define	ast_format_register(f)   __ast_format_register(f, ast_module_info->self)
#define	AST_RESERVED_POINTERS   20
#define	SEEK_FORCECUR   10
Functions
int	__ast_format_register (const struct ast_format *f, struct ast_module *mod)
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_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, off_t sample_offset, int whence)
int	ast_stopstream (struct ast_channel *c)
int	ast_stream_and_wait (struct ast_channel *chan, const char *file, const char *language, const char *digits)
int	ast_stream_fastforward (struct ast_filestream *fs, off_t ms)
int	ast_stream_rewind (struct ast_filestream *fs, off_t ms)
int	ast_streamfile (struct ast_channel *c, const char *filename, const char *preflang)
off_t	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 40 of file file.h.

Referenced by __login_exec(), ast_app_getdata(), ast_ivr_menu_run_internal(), ast_play_and_wait(), ast_readstring_full(), ast_record_review(), background_file(), bridge_playfile(), builtin_atxfer(), builtin_blindtransfer(), conf_exec(), conf_run(), 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(), vm_intro_pt_BR(), and wait_file2().

#define AST_DIGIT_ANYNUM   "0123456789"

Definition at line 41 of file file.h.

Referenced by initreqprep().

#define ast_format_register

(

f

)

__ast_format_register(f, ast_module_info->self)

Definition at line 145 of file file.h.

Referenced by load_module().

#define AST_RESERVED_POINTERS   20

Definition at line 401 of file file.h.

#define SEEK_FORCECUR   10

Definition at line 138 of file file.h.

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

---

Function Documentation

int __ast_format_register	(	const struct ast_format *	f,
		struct ast_module *	mod
	)

Register a new file format capability Adds a format to Asterisk's format abilities. returns 0 on success, -1 on failure

Definition at line 68 of file file.c.

References ast_calloc, ast_log(), AST_RWLIST_INSERT_HEAD, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verbose(), ast_format::buf_size, ast_format::exts, f, LOG_WARNING, ast_format::module, ast_format::name, option_verbose, and VERBOSE_PREFIX_2.

{
   struct ast_format *tmp;

   AST_RWLIST_WRLOCK(&formats);
   AST_RWLIST_TRAVERSE(&formats, tmp, list) {
      if (!strcasecmp(f->name, tmp->name)) {
         AST_RWLIST_UNLOCK(&formats);
         ast_log(LOG_WARNING, "Tried to register '%s' format, already registered\n", f->name);
         return -1;
      }
   }
   if (!(tmp = ast_calloc(1, sizeof(*tmp)))) {
      AST_RWLIST_UNLOCK(&formats);
      return -1;
   }
   *tmp = *f;
   tmp->module = mod;
   if (tmp->buf_size) {
      /*
       * Align buf_size properly, rounding up to the machine-specific
       * alignment for pointers.
       */
      struct _test_align { void *a, *b; } p;
      int align = (char *)&p.b - (char *)&p.a;
      tmp->buf_size = ((f->buf_size + align - 1)/align)*align;
   }
   
   memset(&tmp->list, 0, sizeof(tmp->list));

   AST_RWLIST_INSERT_HEAD(&formats, tmp, list);
   AST_RWLIST_UNLOCK(&formats);
   if (option_verbose > 1)
      ast_verbose( VERBOSE_PREFIX_2 "Registered file format %s, extension(s) %s\n", f->name, f->exts);

   return 0;
}

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

References s.

Referenced by ast_streamfile(), handle_getoption(), handle_recordfile(), handle_streamfile(), and speech_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 695 of file file.c.

References ast_closestream(), AST_FORMAT_MAX_AUDIO, ast_module_unref(), ast_safe_system(), ast_sched_del(), ast_settimeout(), ast_translator_free_path(), ast_format::close, f, ast_format::format, free, and ast_format::module.

Referenced by __ast_play_and_record(), ast_closestream(), ast_filehelper(), ast_hangup(), ast_moh_files_next(), ast_monitor_start(), ast_monitor_stop(), ast_stopstream(), channel_spy(), cli_audio_convert(), cli_audio_convert_deprecated(), dictate_exec(), gen_closestream(), handle_recordfile(), local_ast_moh_stop(), mixmonitor_thread(), and moh_files_release().

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

   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);
   if (f->realfilename)
      free(f->realfilename);
   if (f->fmt->close)
      f->fmt->close(f);
   fclose(f->f);
   if (f->vfs)
      ast_closestream(f->vfs);
   ast_module_unref(f->fmt->module);
   free(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 1185 of file file.c.

References ast_cli_register_multiple(), and cli_file.

Referenced by main().

{
   ast_cli_register_multiple(cli_file, sizeof(cli_file) / sizeof(struct ast_cli_entry));
   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 770 of file file.c.

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

References ACTION_DELETE, and ast_filehelper().

Referenced by __ast_play_and_record(), ast_monitor_start(), ast_monitor_stop(), cli_audio_convert(), cli_audio_convert_deprecated(), leave_voicemail(), play_mailbox_owner(), 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 746 of file file.c.

References fileexists_core().

Referenced by app_exec(), ast_moh_files_next(), ast_monitor_start(), ast_monitor_stop(), common_exec(), conf_run(), invent_message(), last_message_index(), leave_voicemail(), play_mailbox_owner(), play_message_callerid(), record_exec(), rxfax_exec(), vm_intro(), vm_newuser(), and vm_tempgreeting().

{
   char *buf;
   int buflen;

   if (preflang == NULL)
      preflang = "";
   buflen = strlen(preflang) + strlen(filename) + 2;  /* room for everything */
   buf = alloca(buflen);
   if (buf == NULL)
      return 0;
   return fileexists_core(filename, fmt, preflang, buf, buflen);
}

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

References ACTION_RENAME, and ast_filehelper().

Referenced by __ast_play_and_record(), ast_monitor_stop(), leave_voicemail(), and rename_file().

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

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

References ast_log(), AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verbose(), free, LOG_WARNING, ast_format::name, option_verbose, and VERBOSE_PREFIX_2.

Referenced by unload_module().

{
   struct ast_format *tmp;
   int res = -1;

   AST_RWLIST_WRLOCK(&formats);
   AST_RWLIST_TRAVERSE_SAFE_BEGIN(&formats, tmp, list) {
      if (!strcasecmp(name, tmp->name)) {
         AST_RWLIST_REMOVE_CURRENT(&formats, list);
         free(tmp);
         res = 0;
      }
   }
   AST_RWLIST_TRAVERSE_SAFE_END
   AST_RWLIST_UNLOCK(&formats);

   if (!res) {
      if (option_verbose > 1)
         ast_verbose( VERBOSE_PREFIX_2 "Unregistered format %s\n", name);
   } else
      ast_log(LOG_WARNING, "Tried to unregister format %s, already unregistered\n", name);

   return res;
}

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

References ast_openstream_full().

Referenced by ast_streamfile(), dictate_exec(), handle_getoption(), handle_streamfile(), and speech_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 523 of file file.c.

References ACTION_OPEN, ast_deactivate_generator(), ast_filehelper(), AST_FORMAT_AUDIO_MASK, ast_log(), ast_set_write_format(), ast_stopstream(), ast_filestream::buf, fileexists_core(), LOG_WARNING, ast_channel::oldwriteformat, ast_channel::stream, and ast_channel::writeformat.

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

{
   /* 
    * Use fileexists_core() to find a file in a compatible
    * language and format, set up a suitable translator,
    * and open the stream.
    */
   int fmts, res, buflen;
   char *buf;

   if (!asis) {
      /* do this first, otherwise we detect the wrong writeformat */
      ast_stopstream(chan);
      if (chan->generator)
         ast_deactivate_generator(chan);
   }
   if (preflang == NULL)
      preflang = "";
   buflen = strlen(preflang) + strlen(filename) + 2;
   buf = alloca(buflen);
   if (buf == NULL)
      return NULL;
   fmts = fileexists_core(filename, NULL, preflang, buf, buflen);
   if (fmts > 0)
      fmts &= AST_FORMAT_AUDIO_MASK;
   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(buf, 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 561 of file file.c.

References ACTION_OPEN, ast_filehelper(), AST_FORMAT_MAX_AUDIO, AST_FORMAT_MAX_VIDEO, ast_getformatname(), ast_log(), ast_filestream::buf, fileexists_core(), fmt, format, LOG_WARNING, ast_channel::nativeformats, and ast_channel::vstream.

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

{
   /* As above, but for video. But here we don't have translators
    * so we must enforce a format.
    */
   unsigned int format;
   char *buf;
   int buflen;

   if (preflang == NULL)
      preflang = "";
   buflen = strlen(preflang) + strlen(filename) + 2;
   buf = alloca(buflen);
   if (buf == NULL)
      return NULL;

   for (format = AST_FORMAT_MAX_AUDIO << 1; format <= AST_FORMAT_MAX_VIDEO; format = format << 1) {
      int fd;
      const char *fmt;

      if (!(chan->nativeformats & format))
         continue;
      fmt = ast_getformatname(format);
      if ( fileexists_core(filename, fmt, preflang, buf, buflen) < 1)   /* no valid format */
         continue;
      fd = ast_filehelper(buf, 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 661 of file file.c.

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

Referenced by ast_streamfile(), handle_getoption(), handle_streamfile(), and speech_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 804 of file file.c.

References ast_free, ast_log(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, build_filename(), ast_format::exts, exts_compare(), f, ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, free, get_filestream(), LOG_WARNING, ast_filestream::mode, open_wrapper(), strdup, ast_filestream::trans, and ast_filestream::vfs.

Referenced by __ast_play_and_record(), cli_audio_convert(), and cli_audio_convert_deprecated().

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

   AST_RWLIST_RDLOCK(&formats);

   AST_RWLIST_TRAVERSE(&formats, f, list) {
      fs = NULL;
      if (!exts_compare(f->exts, type))
         continue;

      fn = build_filename(filename, type);
      errno = 0;
      bfile = fopen(fn, "r");
      if (!bfile || (fs = get_filestream(f, bfile)) == NULL ||
          open_wrapper(fs) ) {
         ast_log(LOG_WARNING, "Unable to open %s\n", fn);
         if (fs)
            ast_free(fs);
         if (bfile)
            fclose(bfile);
         free(fn);
         continue;
      }
      /* found it */
      fs->trans = NULL;
      fs->fmt = f;
      fs->flags = flags;
      fs->mode = mode;
      fs->filename = strdup(filename);
      fs->vfs = NULL;
      break;
   }

   AST_RWLIST_UNLOCK(&formats);
   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 594 of file file.c.

References f, and s.

Referenced by __ast_play_and_record(), channel_spy(), cli_audio_convert(), cli_audio_convert_deprecated(), 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,
		off_t	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 670 of file file.c.

References ast_filestream::fmt, and ast_format::seek.

Referenced by __ast_read(), ast_control_streamfile(), 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 131 of file file.c.

References ast_closestream(), ast_log(), ast_set_write_format(), LOG_WARNING, ast_channel::oldwriteformat, and ast_channel::stream.

Referenced by app_exec(), ast_adsi_transmit_message_full(), ast_app_getdata(), ast_control_streamfile(), ast_openstream_full(), ast_play_and_wait(), ast_readstring_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_ge(), 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(), 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(), nv_background_detect_exec(), parkandannounce_exec(), pbx_builtin_background(), pl_odtworz_plik(), play_file(), play_mailbox_owner(), playback_exec(), queue_exec(), read_exec(), recordthread(), rpt_tele_thread(), s_streamwait3(), say_character_str_full(), say_digit_str_full(), say_phonetic_str_full(), saycharstr(), sayfile(), saynum(), send_morse(), send_tone_telemetry(), send_waveform_to_channel(), speech_background(), vm_authenticate(), vm_execmain(), wait_for_winner(), waitstream_core(), and zapateller_exec().

{
   /* Stop a running stream if there is one */
   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_and_wait	(	struct ast_channel *	chan,
		const char *	file,
		const char *	language,
		const char *	digits
	)

Definition at line 1108 of file file.c.

References ast_streamfile(), ast_strlen_zero(), and ast_waitstream().

Referenced by __ast_play_and_record(), app_exec(), ast_record_review(), bridge_playfile(), builtin_atxfer(), builtin_automonitor(), builtin_blindtransfer(), directory_exec(), invent_message(), ivr_dispatch(), leave_voicemail(), park_exec(), play_mailbox_owner(), play_message_callerid(), play_record_review(), and wait_file2().

{
        int res = 0;
        if (!ast_strlen_zero(file)) {
                res =  ast_streamfile(chan, file, language);
                if (!res)
                        res = ast_waitstream(chan, digits);
        }
        return res;
} 

int ast_stream_fastforward	(	struct ast_filestream *	fs,
		off_t	ms
	)

Parameters:

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

Definition at line 685 of file file.c.

References ast_seekstream(), and DEFAULT_SAMPLES_PER_MS.

Referenced by waitstream_core().

{
   return ast_seekstream(fs, ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
}

int ast_stream_rewind	(	struct ast_filestream *	fs,
		off_t	ms
	)

Parameters:

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

Definition at line 690 of file file.c.

References ast_seekstream(), and DEFAULT_SAMPLES_PER_MS.

Referenced by __ast_play_and_record(), handle_recordfile(), and waitstream_core().

{
   return ast_seekstream(fs, -ms * DEFAULT_SAMPLES_PER_MS, 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 775 of file file.c.

References ast_applystream(), ast_getformatname(), ast_getformatname_multiple(), ast_log(), ast_openstream(), ast_openvstream(), ast_playstream(), ast_verbose(), ast_filestream::fmt, fmt, ast_format::format, LOG_DEBUG, LOG_WARNING, ast_channel::nativeformats, option_verbose, VERBOSE_PREFIX_3, and ast_filestream::vfs.

Referenced by __login_exec(), agent_call(), app_exec(), ast_app_getdata(), ast_app_getdata_full(), ast_control_streamfile(), ast_play_and_wait(), ast_say_date_da(), ast_say_date_de(), ast_say_date_en(), ast_say_date_fr(), ast_say_date_ge(), 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_from_now_ge(), ast_say_datetime_gr(), ast_say_datetime_nl(), ast_say_datetime_pt(), ast_say_datetime_tw(), 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_ge(), 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_time_de(), ast_say_time_en(), ast_say_time_fr(), ast_say_time_ge(), ast_say_time_gr(), ast_say_time_nl(), ast_say_time_tw(), ast_stream_and_wait(), background_detect_exec(), background_file(), check_availability(), check_beep(), common_exec(), conf_exec(), conf_run(), do_directory(), forward_message(), gr_say_number_female(), handle_recordfile(), leave_voicemail(), nv_background_detect_exec(), page_exec(), park_exec(), parkandannounce_exec(), pbx_builtin_background(), pl_odtworz_plik(), play_and_wait(), play_file(), playback_exec(), privacy_exec(), retrydial_exec(), rpt_tele_thread(), s_streamwait3(), say_character_str_full(), say_digit_str_full(), say_phonetic_str_full(), sayfile(), ss_thread(), vm_authenticate(), wait_file(), and wait_for_winner().

{
   struct ast_filestream *fs;
   struct ast_filestream *vfs=NULL;
   char fmt[256];

   fs = ast_openstream(chan, filename, preflang);
   if (fs)
      vfs = ast_openvstream(chan, filename, preflang);
   if (vfs)
      ast_log(LOG_DEBUG, "Ooh, found a video stream, too, format %s\n", ast_getformatname(vfs->fmt->format));
   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 (option_verbose > 2)
         ast_verbose(VERBOSE_PREFIX_3 "<%s> Playing '%s' (language '%s')\n", chan->name, filename, preflang ? preflang : "default");

      return 0;
   }
   ast_log(LOG_WARNING, "Unable to open %s (format %s): %s\n", filename, ast_getformatname_multiple(fmt, sizeof(fmt), chan->nativeformats), strerror(errno));
   return -1;
}

off_t ast_tellstream

(

struct ast_filestream *

fs

)

Parameters:

fs

fs to act on Returns a long as a sample offset into stream

Definition at line 680 of file file.c.

References ast_filestream::fmt, and ast_format::tell.

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

{
   return fs->fmt->tell(fs);
}

int ast_truncstream

(

struct ast_filestream *

fs

)

Parameters:

fs

filestream to act on Returns 0 for success, or -1 for error

Definition at line 675 of file file.c.

References ast_filestream::fmt, and ast_format::trunc.

Referenced by __ast_play_and_record(), and handle_recordfile().

{
   return fs->fmt->trunc(fs);
}

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

Parameters:

	c	channel to waitstream 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 1081 of file file.c.

References waitstream_core().

Referenced by __login_exec(), agent_call(), app_exec(), ast_app_getdata(), ast_play_and_wait(), ast_say_date_da(), ast_say_date_de(), ast_say_date_en(), ast_say_date_fr(), ast_say_date_ge(), 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_from_now_ge(), ast_say_datetime_gr(), ast_say_datetime_nl(), ast_say_datetime_pt(), ast_say_datetime_tw(), 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_ge(), 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_time_de(), ast_say_time_en(), ast_say_time_ge(), ast_say_time_gr(), ast_say_time_nl(), ast_say_time_tw(), ast_stream_and_wait(), background_file(), check_availability(), check_beep(), common_exec(), conf_exec(), conf_run(), directory_exec(), gr_say_number_female(), handle_recordfile(), leave_voicemail(), page_exec(), park_exec(), parkandannounce_exec(), pbx_builtin_background(), pl_odtworz_plik(), play_and_wait(), play_file(), playback_exec(), privacy_exec(), retrydial_exec(), rpt_tele_thread(), s_streamwait3(), saycharstr(), sayfile(), saynum(), send_morse(), send_tone_telemetry(), ss_thread(), vm_authenticate(), and wait_file().

{
   return waitstream_core(c, breakon, NULL, NULL, 0, -1, -1, NULL);
}

int ast_waitstream_exten	(	struct ast_channel *	c,
		const char *	context
	)

Parameters:

	c	channel to waitstream on
	context	string of context to match digits to break upon Begins playback of a stream... Wait for a stream to stop or for any one of a valid extension digit to arrive, Returns 0 if the stream finishes, the character if it was interrupted, and -1 on error

Definition at line 1092 of file file.c.

References ast_channel::context, and waitstream_core().

Referenced by pbx_builtin_background().

{
   /* Waitstream, with return in the case of a valid 1 digit extension */
   /* in the current or specified context being pressed */

   if (!context)
      context = c->context;
   return waitstream_core(c, NULL, NULL, NULL, 0,
      -1, -1, context);
}

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

Parameters:

	c	channel to waitstream 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 1075 of file file.c.

References waitstream_core().

Referenced by ast_control_streamfile().

{
   return waitstream_core(c, breakon, forward, rewind, ms,
      -1 /* no audiofd */, -1 /* no cmdfd */, NULL /* no context */);
}

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

Definition at line 1086 of file file.c.

References waitstream_core().

Referenced by ast_readstring_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_ge(), 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(), handle_getoption(), handle_streamfile(), pl_odtworz_plik(), s_streamwait3(), say_character_str_full(), say_digit_str_full(), and say_phonetic_str_full().

{
   return waitstream_core(c, breakon, NULL, NULL, 0,
      audiofd, cmdfd, NULL /* no context */);
}

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

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

References ast_free, ast_log(), ast_opt_cache_record_files, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_strdupa, ast_filestream::buf, build_filename(), ast_format::exts, exts_compare(), f, ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, free, get_filestream(), LOG_WARNING, ast_filestream::mode, ast_filestream::realfilename, record_cache_dir, rewrite_wrapper(), ast_format::seek, strdup, ast_filestream::trans, and ast_filestream::vfs.

Referenced by __ast_play_and_record(), ast_monitor_start(), ast_writestream(), cli_audio_convert(), cli_audio_convert_deprecated(), dictate_exec(), handle_recordfile(), mixmonitor_thread(), and recordthread().

{
   int fd, myflags = 0;
   /* compiler claims this variable can be used before initialization... */
   FILE *bfile = NULL;
   struct ast_format *f;
   struct ast_filestream *fs = NULL;
   char *buf = NULL;
   size_t size = 0;
   int format_found = 0;

   AST_RWLIST_RDLOCK(&formats);

   /* set the O_TRUNC flag if and only if there is no O_APPEND specified */
   /* We really can't use O_APPEND as it will break WAV header updates */
   if (flags & O_APPEND) { 
      flags &= ~O_APPEND;
   } else {
      myflags = O_TRUNC;
   }
   
   myflags |= O_WRONLY | O_CREAT;

   /* XXX need to fix this - we should just do the fopen,
    * not open followed by fdopen()
    */
   AST_RWLIST_TRAVERSE(&formats, f, list) {
      char *fn, *orig_fn = NULL;
      if (fs)
         break;

      if (!exts_compare(f->exts, type))
         continue;
      else
         format_found = 1;

      fn = build_filename(filename, type);
      fd = open(fn, flags | myflags, mode);
      if (fd > -1) {
         /* fdopen() the resulting file stream */
         bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
         if (!bfile) {
            ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
            close(fd);
            fd = -1;
         }
      }
      
      if (ast_opt_cache_record_files && (fd > -1)) {
         char *c;

         fclose(bfile); /* this also closes 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 (c = fn; *c; c++)
            if (*c == '/')
               *c = '_';

         size = strlen(fn) + strlen(record_cache_dir) + 2;
         buf = alloca(size);
         strcpy(buf, record_cache_dir);
         strcat(buf, "/");
         strcat(buf, fn);
         free(fn);
         fn = buf;
         fd = open(fn, flags | myflags, mode);
         if (fd > -1) {
            /* fdopen() the resulting file stream */
            bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
            if (!bfile) {
               ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
               close(fd);
               fd = -1;
            }
         }
      }
      if (fd > -1) {
         errno = 0;
         fs = get_filestream(f, bfile);
         if (!fs || rewrite_wrapper(fs, comment)) {
            ast_log(LOG_WARNING, "Unable to rewrite %s\n", fn);
            close(fd);
            if (orig_fn) {
               unlink(fn);
               unlink(orig_fn);
            }
            if (fs)
               ast_free(fs);
         }
         fs->trans = NULL;
         fs->fmt = f;
         fs->flags = flags;
         fs->mode = mode;
         if (orig_fn) {
            fs->realfilename = strdup(orig_fn);
            fs->filename = strdup(fn);
         } else {
            fs->realfilename = NULL;
            fs->filename = strdup(filename);
         }
         fs->vfs = NULL;
         /* If truncated, we'll be at the beginning; if not truncated, then append */
         f->seek(fs, 0, SEEK_END);
      } 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 != NULL then fn is already free and pointing to it */
      if (!buf)
         free(fn);
   }

   AST_RWLIST_UNLOCK(&formats);

   if (!format_found)
      ast_log(LOG_WARNING, "No such format '%s'\n", type);

   return fs;
}

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

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 143 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(), f, ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, ast_format::format, ast_filestream::lastwriteformat, LOG_DEBUG, LOG_WARNING, ast_filestream::mode, ast_format::name, ast_filestream::trans, type, ast_filestream::vfs, and ast_format::write.

Referenced by __ast_play_and_record(), __ast_read(), ast_write(), ast_writestream(), cli_audio_convert(), cli_audio_convert_deprecated(), dictate_exec(), handle_recordfile(), mixmonitor_thread(), and recordthread().

{
   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) {
            const char *type = ast_getformatname(f->subclass & ~0x1);
            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);
         /* else 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");
      else if (res > 0)
         ast_log(LOG_WARNING, "Huh??\n");
   } 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 {
         struct ast_frame *trf;
         fs->lastwriteformat = f->subclass;
         /* 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;
}

---