Sat Nov 1 06:31:04 2008

Asterisk developer's documentation

---

file.c File Reference

Generic File Format Support. More...

#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.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 dependency graph for file.c:

Go to the source code of this file.

Data Structures
struct	ast_filestream
struct	ast_format
Defines
#define	ACTION_COPY   5
#define	ACTION_DELETE   2
#define	ACTION_EXISTS   1
#define	ACTION_OPEN   4
#define	ACTION_RENAME   3
#define	FORMAT   "%-10s %-10s %-20s\n"
#define	FORMAT2   "%-10s %-10s %-20s\n"
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 *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 char *filename2, const char *fmt, int action)
int	ast_filerename (const char *filename, const char *filename2, 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 sample_offset, int whence), int(*trunc)(struct ast_filestream *), long(*tell)(struct ast_filestream *), struct ast_frame *(*read)(struct ast_filestream *, int *whennext), void(*close)(struct ast_filestream *), char *(*getcomment)(struct ast_filestream *))
int	ast_format_unregister (const char *name)
	AST_MUTEX_DEFINE_STATIC (formatlock)
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 int	ast_readaudio_callback (void *data)
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 int	ast_readvideo_callback (void *data)
int	ast_seekstream (struct ast_filestream *fs, long sample_offset, int whence)
int	ast_stopstream (struct ast_channel *tmp)
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 *chan, 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 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)
static int	copy (const char *infile, const char *outfile)
static int	exts_compare (const char *exts, const char *type)
static int	show_file_formats (int fd, int argc, char *argv[])
Variables
static struct ast_format *	formats = NULL
ast_cli_entry	show_file

---

Detailed Description

Generic File Format Support.

Definition in file file.c.

---

Define Documentation

#define ACTION_COPY   5

Definition at line 349 of file file.c.

Referenced by ast_filecopy(), and ast_filehelper().

#define ACTION_DELETE   2

Definition at line 346 of file file.c.

Referenced by ast_filedelete(), and ast_filehelper().

#define ACTION_EXISTS   1

Definition at line 345 of file file.c.

Referenced by ast_fileexists(), and ast_filehelper().

#define ACTION_OPEN   4

Definition at line 348 of file file.c.

Referenced by ast_filehelper(), ast_openstream_full(), and ast_openvstream().

#define ACTION_RENAME   3

Definition at line 347 of file file.c.

Referenced by ast_filehelper(), and ast_filerename().

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

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

Referenced by __iax2_show_peers(), __sip_show_channels(), _sip_show_peers(), 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_image_formats(), sip_show_inuse(), sip_show_registry(), zap_show_channels(), and zap_show_status().

---

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;
}

static int ast_filehelper	(	const char *	filename,
		const char *	filename2,
		const char *	fmt,
		int	action
	)			[static]

Definition at line 351 of file file.c.

References ACTION_COPY, ACTION_DELETE, ACTION_EXISTS, ACTION_OPEN, ACTION_RENAME, ast_closestream(), AST_FORMAT_MAX_AUDIO, ast_log(), ast_mutex_lock(), ast_mutex_unlock(), ast_strdupa, build_filename(), copy(), ast_format::exts, exts_compare(), ast_format::format, formats, free, LOG_WARNING, ast_format::next, ast_format::open, s, ast_channel::stream, strsep(), ast_channel::vstream, and ast_channel::writeformat.

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

{
   struct stat st;
   struct ast_format *f;
   struct ast_filestream *s;
   int res=0, ret = 0;
   char *ext=NULL, *exts, *fn, *nfn;
   FILE *bfile;
   struct ast_channel *chan = (struct ast_channel *)filename2;
   
   /* Start with negative response */
   if (action == ACTION_EXISTS)
      res = 0;
   else
      res = -1;
   if (action == ACTION_OPEN)
      ret = -1;
   /* Check for a specific format */
   if (ast_mutex_lock(&formatlock)) {
      ast_log(LOG_WARNING, "Unable to lock format list\n");
      if (action == ACTION_EXISTS)
         return 0;
      else
         return -1;
   }
   f = formats;
   while(f) {
      if (!fmt || exts_compare(f->exts, fmt)) {
         char *stringp=NULL;
         exts = ast_strdupa(f->exts);
         /* Try each kind of extension */
         stringp=exts;
         ext = strsep(&stringp, "|");
         do {
            fn = build_filename(filename, ext);
            if (fn) {
               res = stat(fn, &st);
               if (!res) {
                  switch(action) {
                  case ACTION_EXISTS:
                     ret |= f->format;
                     break;
                  case ACTION_DELETE:
                     res = unlink(fn);
                     if (res)
                        ast_log(LOG_WARNING, "unlink(%s) failed: %s\n", fn, strerror(errno));
                     break;
                  case ACTION_RENAME:
                     nfn = build_filename(filename2, ext);
                     if (nfn) {
                        res = rename(fn, nfn);
                        if (res)
                           ast_log(LOG_WARNING, "rename(%s,%s) failed: %s\n", fn, nfn, strerror(errno));
                        free(nfn);
                     } else
                        ast_log(LOG_WARNING, "Out of memory\n");
                     break;
                  case ACTION_COPY:
                     nfn = build_filename(filename2, ext);
                     if (nfn) {
                        res = copy(fn, nfn);
                        if (res)
                           ast_log(LOG_WARNING, "copy(%s,%s) failed: %s\n", fn, nfn, strerror(errno));
                        free(nfn);
                     } else
                        ast_log(LOG_WARNING, "Out of memory\n");
                     break;
                  case ACTION_OPEN:
                     if ((ret < 0) && ((chan->writeformat & f->format) ||
                              ((f->format >= AST_FORMAT_MAX_AUDIO) && fmt))) {
                        bfile = fopen(fn, "r");
                        if (bfile) {
                           ret = 1;
                           s = f->open(bfile);
                           if (s) {
                              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;
                              }
                           } else {
                              fclose(bfile);
                              ast_log(LOG_WARNING, "Unable to open file on %s\n", fn);
                              ret = -1;
                           }
                        } else{
                           ast_log(LOG_WARNING, "Couldn't open file %s\n", fn);
                           ret = -1;
                        }
                     }
                     break;
                  default:
                     ast_log(LOG_WARNING, "Unknown helper %d\n", action);
                  }
                  /* Conveniently this logic is the same for all */
                  if (res)
                     break;
               }
               free(fn);
            }
            ext = strsep(&stringp, "|");
         } while(ext);
         
      }
      f = f->next;
   }
   ast_mutex_unlock(&formatlock);
   if ((action == ACTION_EXISTS) || (action == ACTION_OPEN))
      res = ret ? ret : -1;
   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 sample_offset, int whence)	seek,
		int(*)(struct ast_filestream *)	trunc,
		long(*)(struct ast_filestream *)	tell,
		struct ast_frame *(*)(struct ast_filestream *, int *whennext)	read,
		void(*)(struct ast_filestream *)	close,
		char *(*)(struct ast_filestream *)	getcomment
	)

Definition at line 105 of file file.c.

References ast_log(), ast_mutex_lock(), ast_mutex_unlock(), ast_verbose(), ast_format::close, ast_format::exts, ast_format::format, formats, ast_format::getcomment, LOG_WARNING, malloc, ast_format::name, ast_format::next, ast_format::open, option_verbose, ast_format::read, ast_format::rewrite, ast_format::seek, ast_format::tell, ast_format::trunc, VERBOSE_PREFIX_2, and ast_format::write.

Referenced by load_module().

{
   struct ast_format *tmp;
   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)) {
         ast_mutex_unlock(&formatlock);
         ast_log(LOG_WARNING, "Tried to register '%s' format, already registered\n", name);
         return -1;
      }
      tmp = tmp->next;
   }
   tmp = malloc(sizeof(struct ast_format));
   if (!tmp) {
      ast_log(LOG_WARNING, "Out of memory\n");
      ast_mutex_unlock(&formatlock);
      return -1;
   }
   ast_copy_string(tmp->name, name, sizeof(tmp->name));
   ast_copy_string(tmp->exts, exts, sizeof(tmp->exts));
   tmp->open = open;
   tmp->rewrite = rewrite;
   tmp->read = read;
   tmp->write = write;
   tmp->seek = seek;
   tmp->trunc = trunc;
   tmp->tell = tell;
   tmp->close = close;
   tmp->format = format;
   tmp->getcomment = getcomment;
   tmp->next = formats;
   formats = tmp;
   ast_mutex_unlock(&formatlock);
   if (option_verbose > 1)
      ast_verbose( VERBOSE_PREFIX_2 "Registered file format %s, extension(s) %s\n", name, exts);
   return 0;
}

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;
}

AST_MUTEX_DEFINE_STATIC

(

formatlock

)

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;
}

static int ast_readaudio_callback

(

void *

data

)

[static]

Definition at line 582 of file file.c.

References ast_log(), ast_sched_add(), ast_settimeout(), ast_write(), LOG_WARNING, and s.

Referenced by ast_playstream().

{
   struct ast_filestream *s = data;
   struct ast_frame *fr;
   int whennext = 0;

   while(!whennext) {
      fr = s->fmt->read(s, &whennext);
      if (fr) {
         if (ast_write(s->owner, fr)) {
            ast_log(LOG_WARNING, "Failed to write frame\n");
            s->owner->streamid = -1;
#ifdef ZAPTEL_OPTIMIZATIONS
            ast_settimeout(s->owner, 0, NULL, NULL);
#endif         
            return 0;
         }
      } else {
         /* Stream has finished */
         s->owner->streamid = -1;
#ifdef ZAPTEL_OPTIMIZATIONS
         ast_settimeout(s->owner, 0, NULL, NULL);
#endif         
         return 0;
      }
   }
   if (whennext != s->lasttimeout) {
#ifdef ZAPTEL_OPTIMIZATIONS
      if (s->owner->timingfd > -1)
         ast_settimeout(s->owner, whennext, ast_readaudio_callback, s);
      else
#endif      
         s->owner->streamid = ast_sched_add(s->owner->sched, whennext/8, ast_readaudio_callback, s);
      s->lasttimeout = whennext;
      return 0;
   }
   return 1;
}

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;