Sat Nov 1 06:29:04 2008

Asterisk developer's documentation

---

file.c File Reference

Generic File Format Support. More...

#include "asterisk.h"
#include <sys/types.h>
#include <errno.h>
#include <unistd.h>
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <fcntl.h>
#include <dirent.h>
#include <sys/stat.h>
#include "asterisk/frame.h"
#include "asterisk/file.h"
#include "asterisk/cli.h"
#include "asterisk/logger.h"
#include "asterisk/channel.h"
#include "asterisk/sched.h"
#include "asterisk/options.h"
#include "asterisk/translate.h"
#include "asterisk/utils.h"
#include "asterisk/lock.h"
#include "asterisk/app.h"
#include "asterisk/pbx.h"
#include "asterisk/linkedlists.h"
#include "asterisk/module.h"

Include dependency graph for file.c:

Go to the source code of this file.

Defines
#define	FORMAT   "%-10s %-10s %-20s\n"
#define	FORMAT   "%-10s %-10s %-20s\n"
#define	FORMAT2   "%-10s %-10s %-20s\n"
#define	FORMAT2   "%-10s %-10s %-20s\n"
Enumerations
enum	file_action {   ACTION_EXISTS = 1, ACTION_DELETE, ACTION_RENAME, ACTION_OPEN,   ACTION_COPY }
enum	fsread_res { FSREAD_FAILURE, FSREAD_SUCCESS_SCHED, FSREAD_SUCCESS_NOSCHED }
enum	wrap_fn { WRAP_OPEN, WRAP_REWRITE }
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 *filename, const char *filename2, const char *fmt)
int	ast_filedelete (const char *filename, const char *fmt)
int	ast_fileexists (const char *filename, const char *fmt, const char *preflang)
static int	ast_filehelper (const char *filename, const void *arg2, const char *fmt, const enum file_action action)
	perform various actions on a file. Second argument arg2 depends on the command: unused for EXISTS and DELETE destination file name (const char *) for COPY and RENAME struct ast_channel * for OPEN if fmt is NULL, OPEN will return the first matching entry, whereas other functions will run on all matching entries.
int	ast_filerename (const char *filename, const char *filename2, const char *fmt)
int	ast_format_unregister (const char *name)
static int	ast_fsread_audio (const void *data)
static int	ast_fsread_video (const void *data)
static	AST_LIST_HEAD_STATIC (formats, ast_format)
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)
static enum fsread_res	ast_readaudio_callback (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)
static enum fsread_res	ast_readvideo_callback (struct ast_filestream *s)
int	ast_seekstream (struct ast_filestream *fs, off_t sample_offset, int whence)
int	ast_stopstream (struct ast_channel *tmp)
	Stops a stream.
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 *chan, 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 cmdfd)
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)
static char *	build_filename (const char *filename, const char *ext)
	construct a filename. Absolute pathnames are preserved, relative names are prefixed by the sounds/ directory. The wav49 suffix is replaced by 'WAV'. Returns a malloc'ed string to be freed by the caller.
static int	copy (const char *infile, const char *outfile)
static int	exts_compare (const char *exts, const char *type)
static int	fileexists_core (const char *filename, const char *fmt, const char *preflang, char *buf, int buflen)
	helper routine to locate a file with a given format and language preference. Try preflang, preflang with stripped '_' suffix, or NULL. In the standard asterisk, language goes just before the last component. In an alternative configuration, the language should be a prefix to the actual filename.
static int	fileexists_test (const char *filename, const char *fmt, const char *lang, char *buf, int buflen)
static int	fn_wrapper (struct ast_filestream *s, const char *comment, enum wrap_fn mode)
static struct ast_filestream *	get_filestream (struct ast_format *fmt, FILE *bfile)
static int	is_absolute_path (const char *filename)
static int	open_wrapper (struct ast_filestream *s)
static int	rewrite_wrapper (struct ast_filestream *s, const char *comment)
static int	show_file_formats (int fd, int argc, char *argv[])
static int	show_file_formats_deprecated (int fd, int argc, char *argv[])
static int	waitstream_core (struct ast_channel *c, const char *breakon, const char *forward, const char *rewind, int skip_ms, int audiofd, int cmdfd, const char *context)
	the core of all waitstream() functions
Variables
int	ast_language_is_prefix
ast_cli_entry	cli_file []
ast_cli_entry	cli_show_file_formats_deprecated
char	show_file_formats_usage []

---

Detailed Description

Generic File Format Support.

Author:

Mark Spencer <markster@digium.com>

Definition in file file.c.

---

Define Documentation

#define FORMAT   "%-10s %-10s %-20s\n"

#define FORMAT   "%-10s %-10s %-20s\n"

#define FORMAT2   "%-10s %-10s %-20s\n"

#define FORMAT2   "%-10s %-10s %-20s\n"

Referenced by __iax2_show_peers(), __sip_show_channels(), _sip_show_peers(), dahdi_show_channels(), dahdi_show_status(), dundi_show_mappings(), dundi_show_peers(), dundi_show_precache(), dundi_show_requests(), dundi_show_trans(), iax2_show_channels(), iax2_show_firmware(), iax2_show_registry(), iax2_show_users(), show_file_formats(), show_file_formats_deprecated(), show_image_formats(), show_image_formats_deprecated(), sip_show_inuse(), and sip_show_registry().

---

Enumeration Type Documentation

enum file_action

Enumerator:

ACTION_EXISTS
ACTION_DELETE
ACTION_RENAME
ACTION_OPEN
ACTION_COPY

Definition at line 343 of file file.c.

                 {
   ACTION_EXISTS = 1, /* return matching format if file exists, 0 otherwise */
   ACTION_DELETE, /* delete file, return 0 on success, -1 on error */
   ACTION_RENAME, /* rename file. return 0 on success, -1 on error */
   ACTION_OPEN,
   ACTION_COPY /* copy file. return 0 on success, -1 on error */
};

enum fsread_res

Enumerator:

FSREAD_FAILURE
FSREAD_SUCCESS_SCHED
FSREAD_SUCCESS_NOSCHED

Definition at line 656 of file file.c.

                {
   FSREAD_FAILURE,
   FSREAD_SUCCESS_SCHED,
   FSREAD_SUCCESS_NOSCHED,
};

enum wrap_fn

Enumerator:

WRAP_OPEN
WRAP_REWRITE

Definition at line 314 of file file.c.

{ WRAP_OPEN, WRAP_REWRITE };

---

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_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log(), 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;

   if (AST_LIST_LOCK(&formats)) {
      ast_log(LOG_WARNING, "Unable to lock format list\n");
      return -1;
   }
   AST_LIST_TRAVERSE(&formats, tmp, list) {
      if (!strcasecmp(f->name, tmp->name)) {
         AST_LIST_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_LIST_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_LIST_INSERT_HEAD(&formats, tmp, list);
   AST_LIST_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 764 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 807 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(), cli_audio_convert(), cli_audio_convert_deprecated(), dictate_exec(), gen_closestream(), handle_recordfile(), local_ast_moh_stop(), mixmonitor_thread(), moh_files_release(), and rpt().

{
   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;
         AST_SCHED_DEL(f->owner->sched, f->owner->streamid);
#ifdef HAVE_DAHDI
         ast_settimeout(f->owner, 0, NULL, NULL);
#endif         
      } else {
         f->owner->vstream = NULL;
         AST_SCHED_DEL(f->owner->sched, f->owner->vstreamid);
      }
   }
   /* 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);
   if (f->orig_chan_name)
      free((void *) f->orig_chan_name);
   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 1340 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 880 of file file.c.

References ast_filehelper().

Referenced by copy_plain_file(), and vm_forwardoptions().

{
   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 870 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(), play_record_review(), vm_delete(), and vm_forwardoptions().

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

References ast_filestream::buf, and fileexists_core().

Referenced by app_exec(), ast_moh_files_next(), ast_monitor_start(), ast_monitor_stop(), common_exec(), conf_run(), last_message_index(), leave_voicemail(), play_greeting(), play_mailbox_owner(), play_message_callerid(), record_exec(), retrydial_exec(), say_character_str_full(), say_digit_str_full(), say_phonetic_str_full(), vm_intro(), vm_newuser(), vm_options(), and vm_tempgreeting().

{
   char *buf;
   int buflen;

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

static int ast_filehelper	(	const char *	filename,
		const void *	arg2,
		const char *	fmt,
		const enum file_action	action
	)			[static]

perform various actions on a file. Second argument arg2 depends on the command: unused for EXISTS and DELETE destination file name (const char *) for COPY and RENAME struct ast_channel * for OPEN if fmt is NULL, OPEN will return the first matching entry, whereas other functions will run on all matching entries.

Definition at line 360 of file file.c.

References ACTION_DELETE, ACTION_EXISTS, ACTION_OPEN, ACTION_RENAME, ast_closestream(), AST_FORMAT_MAX_AUDIO, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log(), ast_strdupa, build_filename(), copy(), errno, ext, ast_format::exts, exts_compare(), f, ast_format::format, free, get_filestream(), LOG_WARNING, open_wrapper(), s, ast_channel::stream, strsep(), ast_channel::vstream, and ast_channel::writeformat.

Referenced by ast_filecopy(), ast_filedelete(), ast_filerename(), ast_openstream_full(), ast_openvstream(), and fileexists_test().

{
   struct ast_format *f;
   int res = (action == ACTION_EXISTS) ? 0 : -1;

   if (AST_LIST_LOCK(&formats)) {
      ast_log(LOG_WARNING, "Unable to lock format list\n");
      return res;
   }
   /* Check for a specific format */
   AST_LIST_TRAVERSE(&formats, f, list) {
      char *stringp, *ext = NULL;

      if (fmt && !exts_compare(f->exts, fmt))
         continue;

      /* Look for a file matching the supported extensions.
       * The file must exist, and for OPEN, must match
       * one of the formats supported by the channel.
       */
      stringp = ast_strdupa(f->exts);  /* this is in the stack so does not need to be freed */
      while ( (ext = strsep(&stringp, "|")) ) {
         struct stat st;
         char *fn = build_filename(filename, ext);

         if (fn == NULL)
            continue;

         if ( stat(fn, &st) ) { /* file not existent */
            free(fn);
            continue;
         }
         /* for 'OPEN' we need to be sure that the format matches
          * what the channel can process
          */
         if (action == ACTION_OPEN) {
            struct ast_channel *chan = (struct ast_channel *)arg2;
            FILE *bfile;
            struct ast_filestream *s;

            if ( !(chan->writeformat & f->format) &&
                 !(f->format >= AST_FORMAT_MAX_AUDIO && fmt)) {
               free(fn);
               continue;   /* not a supported format */
            }
            if ( (bfile = fopen(fn, "r")) == NULL) {
               free(fn);
               continue;   /* cannot open file */
            }
            s = get_filestream(f, bfile);
            if (!s) {
               fclose(bfile);
               free(fn);   /* cannot allocate descriptor */
               continue;
            }
            if (open_wrapper(s)) {
               fclose(bfile);
               free(fn);
               free(s);
               continue;   /* cannot run open on file */
            }
            /* ok this is good for OPEN */
            res = 1; /* found */
            s->lasttimeout = -1;
            s->fmt = f;
            s->trans = NULL;
            s->filename = NULL;
            if (s->fmt->format < AST_FORMAT_MAX_AUDIO) {
               if (chan->stream)
                  ast_closestream(chan->stream);
               chan->stream = s;
            } else {
               if (chan->vstream)
                  ast_closestream(chan->vstream);
               chan->vstream = s;
            }
            free(fn);
            break;
         }
         switch (action) {
         case ACTION_OPEN:
            break;   /* will never get here */

         case ACTION_EXISTS:  /* return the matching format */
            res |= f->format;
            break;

         case ACTION_DELETE:
            if ( (res = unlink(fn)) )
               ast_log(LOG_WARNING, "unlink(%s) failed: %s\n", fn, strerror(errno));
            break;

         case ACTION_RENAME:
         case ACTION_COPY: {
            char *nfn = build_filename((const char *)arg2, ext);
            if (!nfn)
               ast_log(LOG_WARNING, "Out of memory\n");
            else {
               res = action == ACTION_COPY ? copy(fn, nfn) : rename(fn, nfn);
               if (res)
                  ast_log(LOG_WARNING, "%s(%s,%s) failed: %s\n",
                     action == ACTION_COPY ? "copy" : "rename",
                      fn, nfn, strerror(errno));
               free(nfn);
            }
             }
            break;

         default:
            ast_log(LOG_WARNING, "Unknown helper %d\n", action);
         }
         free(fn);
      }
   }
   AST_LIST_UNLOCK(&formats);
   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 875 of file file.c.

References ACTION_RENAME, and ast_filehelper().

Referenced by __ast_play_and_record(), ast_monitor_stop(), leave_voicemail(), play_record_review(), 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 109 of file file.c.

References AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, ast_log(), 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;

   if (AST_LIST_LOCK(&formats)) {
      ast_log(LOG_WARNING, "Unable to lock format list\n");
      return -1;
   }
   AST_LIST_TRAVERSE_SAFE_BEGIN(&formats, tmp, list) {
      if (!strcasecmp(name, tmp->name)) {
         AST_LIST_REMOVE_CURRENT(&formats, list);
         free(tmp);
         res = 0;
      }
   }
   AST_LIST_TRAVERSE_SAFE_END
   AST_LIST_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;
}

static int ast_fsread_audio

(

const void *

data

)

[static]

Definition at line 711 of file file.c.

References ast_readaudio_callback(), and FSREAD_SUCCESS_SCHED.

Referenced by ast_readaudio_callback().

{
   struct ast_filestream *fs = (struct ast_filestream *)data;
   enum fsread_res res;

   res = ast_readaudio_callback(fs);

   if (res == FSREAD_SUCCESS_SCHED)
      return 1;
   
   return 0;
}

static int ast_fsread_video

(

const void *

data

)

[static]

Definition at line 751 of file file.c.

References ast_readvideo_callback(), and FSREAD_SUCCESS_SCHED.

Referenced by ast_readvideo_callback().

{
   struct ast_filestream *fs = (struct ast_filestream *)data;
   enum fsread_res res;

   res = ast_readvideo_callback(fs);

   if (res == FSREAD_SUCCESS_SCHED)
      return 1;
   
   return 0;
}

static AST_LIST_HEAD_STATIC	(	formats	,
		ast_format
	)			[static]

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 571 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 576 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(), 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) + 4;
   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 614 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) + 4;
   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 770 of file file.c.

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

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

{
   enum fsread_res res;

   if (s->fmt->format < AST_FORMAT_MAX_AUDIO)
      res = ast_readaudio_callback(s);
   else
      res = ast_readvideo_callback(s);

   return (res == FSREAD_FAILURE) ? -1 : 0;
}

static enum fsread_res ast_readaudio_callback

(

struct ast_filestream *

s

)

[static]

Definition at line 664 of file file.c.

References ast_format_rate(), ast_fsread_audio(), ast_log(), ast_sched_add(), ast_settimeout(), ast_write(), FSREAD_FAILURE, FSREAD_SUCCESS_NOSCHED, FSREAD_SUCCESS_SCHED, LOG_WARNING, and s.

Referenced by ast_fsread_audio(), and ast_playstream().

{
   int whennext = 0;

   while (!whennext) {
      struct ast_frame *fr;
      
      if (s->orig_chan_name && strcasecmp(s->owner->name, s->orig_chan_name))
         goto return_failure;
      
      fr = s->fmt->read(s, &whennext);
      if (!fr /* stream complete */ || ast_write(s->owner, fr) /* error writing */) {
         if (fr)
            ast_log(LOG_WARNING, "Failed to write frame\n");
         goto return_failure;
      }
   }
   if (whennext != s->lasttimeout) {
#ifdef HAVE_DAHDI
      if (s->owner->timingfd > -1) {
         int zap_timer_samples = whennext;
         int rate;
         /* whennext is in samples, but DAHDI timers operate in 8 kHz samples. */
         if ((rate = ast_format_rate(s->fmt->format)) != 8000) {
            float factor;
            factor = ((float) rate) / ((float) 8000.0); 
            zap_timer_samples = (int) ( ((float) zap_timer_samples) / factor );
         }
         ast_settimeout(s->owner, zap_timer_samples, ast_fsread_audio, s);
      } else