Generic File Format Support. Should be included by clients of the file handling routines. File service providers should instead include mod_format.h. More...

#include <fcntl.h>
#include <sys/mman.h>

Include dependency graph for file.h:

Go to the source code of this file.

Defines
#define	AST_DIGIT_ANY "0123456789#*ABCD"
#define	AST_DIGIT_ANYNUM "0123456789"
#define	AST_DIGIT_NONE ""
#define	AST_MAX_FORMATS 10
#define	AST_RESERVED_POINTERS 20
#define	SEEK_FORCECUR 10
Typedefs
typedef void(	ast_waitstream_fr_cb )(struct ast_channel *chan, long ms, enum ast_waitstream_fr_cb_values val)
	callback used during dtmf controlled file playback to indicate location of playback in a file after rewinding or fastfowarding a file.
Enumerations
enum	ast_waitstream_fr_cb_values { AST_WAITSTREAM_CB_REWIND = 1, AST_WAITSTREAM_CB_FASTFORWARD, AST_WAITSTREAM_CB_START }
Functions
int	ast_applystream (struct ast_channel chan, struct ast_filestream s)
	Applys a open stream to a channel.
int	ast_closestream (struct ast_filestream *f)
	Closes a stream.
int	ast_file_init (void)
int	ast_filecopy (const char oldname, const char newname, const char *fmt)
	Copies a file.
int	ast_filedelete (const char filename, const char fmt)
	Deletes a file.
int	ast_fileexists (const char filename, const char fmt, const char *preflang)
	Checks for the existence of a given file.
int	ast_filerename (const char oldname, const char newname, const char *fmt)
	Renames a file.
char *	ast_format_str_reduce (char *fmts)
struct ast_filestream *	ast_openstream (struct ast_channel chan, const char filename, const char *preflang)
	Opens stream for use in seeking, playing.
struct ast_filestream *	ast_openstream_full (struct ast_channel chan, const char filename, const char *preflang, int asis)
	Opens stream for use in seeking, playing.
struct ast_filestream *	ast_openvstream (struct ast_channel chan, const char filename, const char *preflang)
	Opens stream for use in seeking, playing.
int	ast_playstream (struct ast_filestream *s)
	Play a open stream on a channel.
struct ast_filestream *	ast_readfile (const char filename, const char type, const char *comment, int flags, int check, mode_t mode)
	Starts reading from a file.
struct ast_frame *	ast_readframe (struct ast_filestream *s)
	Read a frame from a filestream.
int	ast_seekstream (struct ast_filestream *fs, off_t sample_offset, int whence)
	Seeks into stream.
int	ast_stopstream (struct ast_channel *c)
	Stops a stream.
int	ast_stream_and_wait (struct ast_channel chan, const char file, const char *digits)
	stream file until digit If the file name is non-empty, try to play it.
int	ast_stream_fastforward (struct ast_filestream *fs, off_t ms)
	Fast forward stream ms.
int	ast_stream_rewind (struct ast_filestream *fs, off_t ms)
	Rewind stream ms.
int	ast_streamfile (struct ast_channel c, const char filename, const char *preflang)
	Streams a file.
off_t	ast_tellstream (struct ast_filestream *fs)
	Tell where we are in a stream.
int	ast_truncstream (struct ast_filestream *fs)
	Trunc stream at current location.
int	ast_waitstream (struct ast_channel c, const char breakon)
	Waits for a stream to stop or digit to be pressed.
int	ast_waitstream_exten (struct ast_channel c, const char context)
	Waits for a stream to stop or digit matching a valid one digit exten to be pressed.
int	ast_waitstream_fr (struct ast_channel c, const char breakon, const char forward, const char rewind, int ms)
	Same as waitstream but allows stream to be forwarded or rewound.
int	ast_waitstream_fr_w_cb (struct ast_channel c, const char breakon, const char forward, const char rewind, int ms, ast_waitstream_fr_cb cb)
	Same as waitstream_fr but allows a callback to be alerted when a user fastforwards or rewinds the file.
int	ast_waitstream_full (struct ast_channel c, const char breakon, int audiofd, int monfd)
struct ast_filestream *	ast_writefile (const char filename, const char type, const char *comment, int flags, int check, mode_t mode)
	Starts writing a file.
int	ast_writestream (struct ast_filestream fs, struct ast_frame f)
	Writes a frame to a stream.

Detailed Description

Generic File Format Support. Should be included by clients of the file handling routines. File service providers should instead include mod_format.h.

Definition in file file.h.

Define Documentation

#define AST_DIGIT_ANY "0123456789#*ABCD"

Definition at line 48 of file file.h.

Referenced by action_playback_and_continue(), ast_ivr_menu_run_internal(), ast_play_and_wait(), ast_readstring_full(), ast_record_review(), bridge_playfile(), builtin_atxfer(), builtin_blindtransfer(), conf_exec(), conf_get_pin(), conf_run(), dial_exec_full(), dictate_exec(), directory_exec(), feature_attended_transfer(), feature_blind_transfer(), festival_exec(), get_folder(), grab_transfer(), ivr_dispatch(), meetme_menu_admin(), meetme_menu_admin_extended(), 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(), sayname(), sayunixtime_exec(), select_item_menu(), select_item_seq(), try_calling(), vm_intro_gr(), vm_intro_he(), vm_intro_multilang(), vm_intro_pt(), vm_intro_pt_BR(), vmsayname_exec(), and wait_file2().

#define AST_DIGIT_ANYNUM "0123456789"

Definition at line 49 of file file.h.

Referenced by initreqprep().

#define AST_DIGIT_NONE ""

Convenient for waiting

Definition at line 47 of file file.h.

Referenced by sayunixtime_exec().

#define AST_MAX_FORMATS 10

The maximum number of formats we expect to see in a format string

Definition at line 44 of file file.h.

Referenced by ast_format_str_reduce().

#define AST_RESERVED_POINTERS 20

Definition at line 367 of file file.h.

#define SEEK_FORCECUR 10

Definition at line 51 of file file.h.

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

Typedef Documentation

typedef void( ast_waitstream_fr_cb)(struct ast_channel *chan, long ms, enum ast_waitstream_fr_cb_values val)

callback used during dtmf controlled file playback to indicate location of playback in a file after rewinding or fastfowarding a file.

Definition at line 65 of file file.h.

Enumeration Type Documentation

enum ast_waitstream_fr_cb_values

The type of event associated with a ast_waitstream_fr_cb invocation

Enumerator:

AST_WAITSTREAM_CB_REWIND
AST_WAITSTREAM_CB_FASTFORWARD
AST_WAITSTREAM_CB_START

Definition at line 54 of file file.h.

                                 {
   AST_WAITSTREAM_CB_REWIND = 1,
   AST_WAITSTREAM_CB_FASTFORWARD,
   AST_WAITSTREAM_CB_START
};

Function Documentation

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

Applys a open stream to a channel.

Parameters:

chan	channel to work
s	ast_filestream to apply

Return values:

0	on success.
-1	on failure.

Definition at line 921 of file file.c.

References ast_filestream::owner.

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 )

Closes a stream.

Parameters:

f	filestream to close Close a playback or recording stream

Return values:

0	on success.
-1	on failure.

Definition at line 964 of file file.c.

References ao2_ref, and filestream_close().

Referenced by __ast_play_and_record(), ast_hangup(), ast_moh_files_next(), ast_monitor_start(), ast_monitor_stop(), ast_readfile(), ast_stopstream(), ast_writefile(), dictate_exec(), filehelper(), filestream_destructor(), gen_closestream(), handle_cli_file_convert(), handle_recordfile(), local_ast_moh_stop(), mixmonitor_ds_close_fs(), moh_files_release(), record_exec(), and recordthread().

{
   /* This used to destroy the filestream, but it now just decrements a refcount.
    * We close the stream in order to quit queuing frames now, because we might
    * change the writeformat, which could result in a subsequent write error, if
    * the format is different. */
   filestream_close(f);
   ao2_ref(f, -1);
   return 0;
}

int ast_file_init ( void )

Initialize file stuff

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

Provided by file.c

Definition at line 1594 of file file.c.

References ARRAY_LEN, ast_cli_register_multiple(), ast_register_atexit(), and file_shutdown().

{
   ast_cli_register_multiple(cli_file, ARRAY_LEN(cli_file));
   ast_register_atexit(file_shutdown);
   return 0;
}

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

Copies a file.

Parameters:

oldname	name of the file you wish to copy (minus extension)
newname	name you wish the file to be copied to (minus extension)
fmt	the format of the file Copy a given file in a given format, or if fmt is NULL, then do so for all

Definition at line 1001 of file file.c.

References ACTION_COPY, and filehelper().

Referenced by copy_plain_file(), msg_create_from_file(), and vm_forwardoptions().

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

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

Deletes a file.

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

References ACTION_DELETE, and filehelper().

Referenced by __ast_play_and_record(), announce_thread(), ast_monitor_start(), ast_monitor_stop(), conf_free(), conf_run(), confbridge_exec(), dial_exec_full(), handle_cli_file_convert(), leave_voicemail(), msg_create_from_file(), play_record_review(), record_exec(), setup_privacy_args(), and vm_delete().

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

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

Checks for the existence of a given file.

Parameters:

filename	name of the file you wish to check, minus the extension
fmt	the format you wish to check (the extension)
preflang	(the preferred language you wisht to find the file in) See if a given file exists in a given format. If fmt is NULL, any format is accepted.

Return values:

0,false.	The file does not exist
1,true.	The file does exist.

Definition at line 979 of file file.c.

References ast_alloca, ast_filestream::buf, and fileexists_core().

Referenced by announce_thread(), app_exec(), ast_moh_files_next(), ast_monitor_start(), ast_monitor_stop(), common_exec(), conf_run(), dial_exec_full(), eivr_comm(), forward_message(), get_folder(), invent_message(), leave_voicemail(), meetme_menu_admin_extended(), minivm_delete_exec(), msg_create_from_file(), play_file(), play_message(), play_message_by_id_helper(), play_message_callerid(), readexten_exec(), record_exec(), retrydial_exec(), say_character_str_full(), say_digit_str_full(), say_phonetic_str_full(), sayname(), setup_privacy_args(), sound_file_exists(), vm_intro(), vm_msg_play(), 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 = ast_alloca(buflen);
   return fileexists_core(filename, fmt, preflang, buf, buflen, NULL) ? 1 : 0;
}

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

Renames a file.

Parameters:

oldname	the name of the file you wish to act upon (minus the extension)
newname	the name you wish to rename the file to (minus the extension)
fmt	the format of the file Rename a given file in a given format, or if fmt is NULL, then do so for all

Returns:: -1 on failure

Definition at line 996 of file file.c.

References ACTION_RENAME, and filehelper().

Referenced by __ast_play_and_record(), ast_monitor_stop(), forward_message(), leave_voicemail(), msg_create_from_file(), play_record_review(), rename_file(), and vm_forwardoptions().

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

char* ast_format_str_reduce ( char * fmts )

Remove duplicate formats from a format string.

Parameters:

fmts	a format string, this string will be modified

Return values:

NULL error

Returns:: a pointer to the reduced format string, this is a pointer to fmts

Definition at line 1473 of file file.c.

References ast_log(), AST_MAX_FORMATS, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_format_def::exts, exts_compare(), f, first, len(), ast_format_def::list, LOG_WARNING, and type.

Referenced by actual_load_config().

{
   struct ast_format_def *f;
   struct ast_format_def *fmts_ptr[AST_MAX_FORMATS];
   char *fmts_str[AST_MAX_FORMATS];
   char *stringp, *type;
   char *orig = fmts;
   int i, j, x, first, found = 0;
   int len = strlen(fmts) + 1;
   int res;

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

   stringp = ast_strdupa(fmts);

   for (x = 0; (type = strsep(&stringp, "|")) && x < AST_MAX_FORMATS; x++) {
      AST_RWLIST_TRAVERSE(&formats, f, list) {
         if (exts_compare(f->exts, type)) {
            found = 1;
            break;
         }
      }

      fmts_str[x] = type;
      if (found) {
         fmts_ptr[x] = f;
      } else {
         fmts_ptr[x] = NULL;
      }
   }
   AST_RWLIST_UNLOCK(&formats);

   first = 1;
   for (i = 0; i < x; i++) {
      /* ignore invalid entries */
      if (!fmts_ptr[i]) {
         ast_log(LOG_WARNING, "ignoring unknown format '%s'\n", fmts_str[i]);
         continue;
      }

      /* special handling for the first entry */
      if (first) {
         res = snprintf(fmts, len, "%s", fmts_str[i]);
         fmts += res;
         len -= res;
         first = 0;
         continue;
      }

      found = 0;
      for (j = 0; j < i; j++) {
         /* this is a duplicate */
         if (fmts_ptr[j] == fmts_ptr[i]) {
            found = 1;
            break;
         }
      }

      if (!found) {
         res = snprintf(fmts, len, "|%s", fmts_str[i]);
         fmts += res;
         len -= res;
      }
   }

   if (first) {
      ast_log(LOG_WARNING, "no known formats found in format list (%s)\n", orig);
      return NULL;
   }

   return orig;
}

struct ast_filestream* ast_openstream	(	struct ast_channel *	chan,
		const char *	filename,
		const char *	preflang
	)		`[read]`

Opens stream for use in seeking, playing.

Parameters:

chan	channel to work with
filename	to use
preflang	prefered language to use

Return values:

a	ast_filestream pointer if it opens the file.
NULL	on error.

Definition at line 667 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
	)		`[read]`

Opens stream for use in seeking, playing.

Parameters:

chan	channel to work with
filename	to use
preflang	prefered language to use
asis	if set, don't clear generators

Return values:

a	ast_filestream pointer if it opens the file.
NULL	on error.

Definition at line 672 of file file.c.

References ACTION_OPEN, ast_alloca, ast_channel_generator(), ast_channel_oldwriteformat(), ast_channel_stream(), ast_channel_writeformat(), ast_deactivate_generator(), ast_format_cap_alloc_nolock(), ast_format_cap_destroy(), ast_format_cap_has_type(), ast_format_copy(), AST_FORMAT_TYPE_AUDIO, ast_log(), ast_set_write_format_from_cap(), ast_stopstream(), fileexists_core(), filehelper(), and LOG_WARNING.

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.
    */
   struct ast_format_cap *file_fmt_cap;
   int res;
   int buflen;
   char *buf;

   if (!asis) {
      /* do this first, otherwise we detect the wrong writeformat */
      ast_stopstream(chan);
      if (ast_channel_generator(chan))
         ast_deactivate_generator(chan);
   }
   if (preflang == NULL)
      preflang = "";
   buflen = strlen(preflang) + strlen(filename) + 4;
   buf = ast_alloca(buflen);

   if (!(file_fmt_cap = ast_format_cap_alloc_nolock())) {
      return NULL;
   }
   if (!fileexists_core(filename, NULL, preflang, buf, buflen, file_fmt_cap) ||
      !ast_format_cap_has_type(file_fmt_cap, AST_FORMAT_TYPE_AUDIO)) {

      ast_log(LOG_WARNING, "File %s does not exist in any format\n", filename);
      file_fmt_cap = ast_format_cap_destroy(file_fmt_cap);
      return NULL;
   }

   /* Set the channel to a format we can work with and save off the previous format. */
   ast_format_copy(ast_channel_oldwriteformat(chan), ast_channel_writeformat(chan));
   /* Set the channel to the best format that exists for the file. */
   res = ast_set_write_format_from_cap(chan, file_fmt_cap);
   /* don't need this anymore now that the channel's write format is set. */
   file_fmt_cap = ast_format_cap_destroy(file_fmt_cap);

   if (res == -1) {  /* No format available that works with this channel */
      return NULL;
   }
   res = filehelper(buf, chan, NULL, ACTION_OPEN);
   if (res >= 0)
      return ast_channel_stream(chan);
   return NULL;
}

struct ast_filestream* ast_openvstream	(	struct ast_channel *	chan,
		const char *	filename,
		const char *	preflang
	)		`[read]`

Opens stream for use in seeking, playing.

Parameters:

chan	channel to work with
filename	to use
preflang	prefered language to use

Return values:

a	ast_filestream pointer if it opens the file.
NULL	on error.

Definition at line 722 of file file.c.

References ACTION_OPEN, ast_alloca, ast_channel_nativeformats(), ast_channel_vstream(), ast_format_cap_alloc_nolock(), ast_format_cap_destroy(), ast_format_cap_has_type(), ast_format_cap_iscompatible(), ast_format_cap_iter_end(), ast_format_cap_iter_next(), ast_format_cap_iter_start(), AST_FORMAT_GET_TYPE, AST_FORMAT_TYPE_VIDEO, ast_getformatname(), ast_log(), fileexists_core(), filehelper(), ast_format::id, and LOG_WARNING.

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.
    */
   struct ast_format tmp_fmt;
   struct ast_format_cap *tmp_cap;
   char *buf;
   int buflen;
   const char *fmt;
   int fd;

   if (preflang == NULL)
      preflang = "";
   buflen = strlen(preflang) + strlen(filename) + 4;
   buf = ast_alloca(buflen);

   /* is the channel capable of video without translation ?*/
   if (!ast_format_cap_has_type(ast_channel_nativeformats(chan), AST_FORMAT_TYPE_VIDEO)) {
      return NULL;
   }
   if (!(tmp_cap = ast_format_cap_alloc_nolock())) {
      return NULL;
   }
   /* Video is supported, so see what video formats exist for this file */
   if (!fileexists_core(filename, NULL, preflang, buf, buflen, tmp_cap)) {
      tmp_cap = ast_format_cap_destroy(tmp_cap);
      return NULL;
   }

   /* iterate over file formats and pick the first one compatible with the channel's native formats */
   ast_format_cap_iter_start(tmp_cap);
   while (!ast_format_cap_iter_next(tmp_cap, &tmp_fmt)) {
      fmt = ast_getformatname(&tmp_fmt);
      if ((AST_FORMAT_GET_TYPE(tmp_fmt.id) != AST_FORMAT_TYPE_VIDEO) ||
         !ast_format_cap_iscompatible(ast_channel_nativeformats(chan), &tmp_fmt)) {
         continue;
      }

      fd = filehelper(buf, chan, fmt, ACTION_OPEN);
      if (fd >= 0) {
         ast_format_cap_iter_end(tmp_cap);
         tmp_cap = ast_format_cap_destroy(tmp_cap);
         return ast_channel_vstream(chan);
      }
      ast_log(LOG_WARNING, "File %s has video but couldn't be opened\n", filename);
   }
   ast_format_cap_iter_end(tmp_cap);
   tmp_cap = ast_format_cap_destroy(tmp_cap);

   return NULL;
}

int ast_playstream ( struct ast_filestream * s )

Play a open stream on a channel.

Parameters:

s	filestream to play

Return values:

0	on success.
-1	on failure.

Definition at line 927 of file file.c.

References AST_FORMAT_GET_TYPE, AST_FORMAT_TYPE_AUDIO, ast_readaudio_callback(), ast_readvideo_callback(), ast_filestream::fmt, ast_format_def::format, FSREAD_FAILURE, and ast_format::id.

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

{
   enum fsread_res res;

   if (AST_FORMAT_GET_TYPE(s->fmt->format.id) == AST_FORMAT_TYPE_AUDIO)
      res = ast_readaudio_callback(s);
   else
      res = ast_readvideo_callback(s);

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

struct ast_filestream* ast_readfile	(	const char *	filename,
		const char *	type,
		const char *	comment,
		int	flags,
		int	check,
		mode_t	mode
	)		`[read]`

Starts reading from a file.

Parameters:

filename	the name of the file to read from
type	format of file you wish to read from
comment	comment to go with
flags	file flags
check	(unimplemented, hence negligible)
mode	Open mode Open an incoming file stream. flags are flags for the open() command, and if check is non-zero, then it will not read a file if there are any files that start with that name and have an extension Please note, this is a blocking function. Program execution will not return until ast_waitstream completes it's execution.

Return values:

a	struct ast_filestream on success.
NULL	on failure.

Definition at line 1056 of file file.c.

References ast_closestream(), ast_free, ast_log(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_strdup, build_filename(), errno, ast_format_def::exts, exts_compare(), f, ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, get_filestream(), LOG_WARNING, ast_filestream::mode, open_wrapper(), ast_filestream::trans, and ast_filestream::vfs.

Referenced by __ast_play_and_record(), handle_cli_file_convert(), and msg_create_from_file().

{
   FILE *bfile;
   struct ast_format_def *f;
   struct ast_filestream *fs = NULL;
   char *fn;
   int format_found = 0;

   AST_RWLIST_RDLOCK(&formats);

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

      fn = build_filename(filename, type);
      if (!fn) {
         continue;
      }
      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_closestream(fs);
         }
         fs = NULL;
         bfile = NULL;
         ast_free(fn);
         break;
      }
      /* found it */
      fs->trans = NULL;
      fs->fmt = f;
      fs->flags = flags;
      fs->mode = mode;
      fs->filename = ast_strdup(filename);
      fs->vfs = NULL;
      ast_free(fn);
      break;
   }

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

   return fs;
}

struct ast_frame* ast_readframe ( struct ast_filestream * s ) [read]

Read a frame from a filestream.

Parameters:

s	ast_filestream to act on

Returns:: a frame.

Return values:

NULL	if read failed.

Definition at line 800 of file file.c.

References read_frame().

Referenced by __ast_play_and_record(), dictate_exec(), gen_readframe(), handle_cli_file_convert(), and moh_files_readframe().

{
   int whennext = 0;

   return read_frame(s, &whennext);
}

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

Seeks into stream.

Parameters:

fs	ast_filestream to perform seek on
sample_offset	numbers of samples to seek
whence	SEEK_SET, SEEK_CUR, SEEK_END

Return values:

0	on success.
-1	on failure.

Definition at line 939 of file file.c.

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

Referenced by __ast_read(), ast_moh_files_next(), ast_stream_fastforward(), ast_stream_rewind(), ast_streamfile(), ast_write(), control_streamfile(), dictate_exec(), handle_getoption(), handle_recordfile(), handle_streamfile(), msg_create_from_file(), and speech_streamfile().

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

int ast_stopstream ( struct ast_channel * c )

Stops a stream.

Parameters:

c	The channel you wish to stop playback on

Stop playback of a stream

Return values:

0 always

Note:: The channel does not need to be locked before calling this function.

Definition at line 130 of file file.c.

References ast_channel_lock, ast_channel_oldwriteformat(), ast_channel_stream(), ast_channel_stream_set(), ast_channel_unlock, ast_channel_vstream(), ast_channel_vstream_set(), ast_closestream(), ast_getformatname(), ast_log(), ast_set_write_format(), and LOG_WARNING.

{
   ast_channel_lock(tmp);

   /* Stop a running stream if there is one */
   if (ast_channel_stream(tmp)) {
      ast_closestream(ast_channel_stream(tmp));
      ast_channel_stream_set(tmp, NULL);
      if (ast_channel_oldwriteformat(tmp)->id && ast_set_write_format(tmp, ast_channel_oldwriteformat(tmp)))
         ast_log(LOG_WARNING, "Unable to restore format back to %s\n", ast_getformatname(ast_channel_oldwriteformat(tmp)));
   }
   /* Stop the video stream too */
   if (ast_channel_vstream(tmp) != NULL) {
      ast_closestream(ast_channel_vstream(tmp));
      ast_channel_vstream_set(tmp, NULL);
   }

   ast_channel_unlock(tmp);

   return 0;
}

int ast_stream_and_wait	(	struct ast_channel *	chan,
		const char *	file,
		const char *	digits
	)

stream file until digit If the file name is non-empty, try to play it.

Note:: If digits == "" then we can simply check for non-zero.

Returns:: 0 if success.

Return values:

-1	if error.
digit	if interrupted by a digit.

Definition at line 1460 of file file.c.

References ast_channel_language(), ast_channel_name(), ast_streamfile(), ast_strlen_zero(), ast_test_suite_event_notify, and ast_waitstream().

Referenced by __ast_play_and_record(), action_kick_last(), action_playback(), action_toggle_mute(), action_toggle_mute_participants(), announce_user_count(), app_exec(), ast_pickup_call(), ast_record_review(), bridge_playfile(), builtin_atxfer(), builtin_automixmonitor(), builtin_blindtransfer(), confbridge_exec(), directory_exec(), execute_menu_entry(), feature_attended_transfer(), feature_blind_transfer(), forward_message(), grab_transfer(), invent_message(), ivr_dispatch(), join_conference_bridge(), leave_voicemail(), masq_park_call(), park_call_exec(), parked_call_exec(), play_files_helper(), play_mailbox_owner(), play_message_callerid(), play_message_on_chan(), play_prompt_to_user(), play_record_review(), play_sound_helper(), sayname(), select_item_seq(), vm_forwardoptions(), vmsayname_exec(), wait_file2(), and xfer_park_call_helper().

{
   int res = 0;
   if (!ast_strlen_zero(file)) {
      ast_test_suite_event_notify("PLAYBACK", "Message: %s\r\nChannel: %s", file, ast_channel_name(chan));
      res = ast_streamfile(chan, file, ast_channel_language(chan));
      if (!res) {
         res = ast_waitstream(chan, digits);
      }
   }
   return res;
}

int ast_stream_fastforward	(	struct ast_filestream *	fs,
		off_t	ms
	)

Fast forward stream ms.

Parameters:

fs	filestream to act on
ms	milliseconds to move

Return values:

0	on success.
-1	on failure.

Definition at line 954 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
	)

Rewind stream ms.

Parameters:

fs	filestream to act on
ms	milliseconds to move

Return values:

0	on success.
-1	on failure.

Definition at line 959 of file file.c.

References ast_seekstream(), and DEFAULT_SAMPLES_PER_MS.

Referenced by __ast_play_and_record(), handle_recordfile(), record_exec(), 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
	)

Streams a file.

Parameters:

c	channel to stream the file to
filename	the name of the file you wish to stream, minus the extension
preflang	the preferred language you wish to have the file streamed to you in Prepares a channel for the streaming of a file. To start the stream, afterward do a ast_waitstream() on the channel Also, it will stop any existing streams on the channel.

Return values:

0	on success.
-1	on failure.

Definition at line 1006 of file file.c.

References ast_applystream(), ast_channel_flags(), ast_channel_name(), ast_channel_nativeformats(), ast_channel_writeformat(), ast_debug, AST_FLAG_MASQ_NOSTREAM, ast_getformatname(), ast_getformatname_multiple(), ast_log(), ast_openstream(), ast_openvstream(), ast_playstream(), ast_seekstream(), ast_strdup, ast_test_flag, ast_verb, errno, ast_filestream::f, ast_filestream::fmt, ast_format_def::format, LOG_WARNING, ast_filestream::orig_chan_name, and ast_filestream::vfs.

{
   struct ast_filestream *fs;
   struct ast_filestream *vfs=NULL;
   char fmt[256];
   off_t pos;
   int seekattempt;
   int res;

   fs = ast_openstream(chan, filename, preflang);
   if (!fs) {
      ast_log(LOG_WARNING, "Unable to open %s (format %s): %s\n", filename, ast_getformatname_multiple(fmt, sizeof(fmt), ast_channel_nativeformats(chan)), strerror(errno));
      return -1;
   }

   /* check to see if there is any data present (not a zero length file),
    * done this way because there is no where for ast_openstream_full to
    * return the file had no data. */
   pos = ftello(fs->f);
   seekattempt = fseeko(fs->f, -1, SEEK_END);
   if (seekattempt) {
      if (errno == EINVAL) {
         /* Zero-length file, as opposed to a pipe */
         return 0;
      } else {
         ast_seekstream(fs, 0, SEEK_SET);
      }
   } else {
      fseeko(fs->f, pos, SEEK_SET);
   }

   vfs = ast_openvstream(chan, filename, preflang);
   if (vfs) {
      ast_debug(1, "Ooh, found a video stream, too, format %s\n", ast_getformatname(&vfs->fmt->format));
   }

   if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_MASQ_NOSTREAM))
      fs->orig_chan_name = ast_strdup(ast_channel_name(chan));
   if (ast_applystream(chan, fs))
      return -1;
   if (vfs && ast_applystream(chan, vfs))
      return -1;
   res = ast_playstream(fs);
   if (!res && vfs)
      res = ast_playstream(vfs);
   ast_verb(3, "<%s> Playing '%s.%s' (language '%s')\n", ast_channel_name(chan), filename, ast_getformatname(ast_channel_writeformat(chan)), preflang ? preflang : "default");

   return res;
}

off_t ast_tellstream ( struct ast_filestream * fs )

Tell where we are in a stream.

Parameters:

fs	fs to act on

Returns:: a long as a sample offset into stream

Definition at line 949 of file file.c.

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

Referenced by __ast_play_and_record(), ast_moh_files_next(), control_streamfile(), handle_getoption(), handle_recordfile(), handle_speechrecognize(), handle_streamfile(), msg_create_from_file(), and waitstream_core().

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

int ast_truncstream ( struct ast_filestream * fs )

Trunc stream at current location.

Parameters:

fs	filestream to act on

Return values:

0	on success.
-1	on failure.

Definition at line 944 of file file.c.

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

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

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

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

Waits for a stream to stop or digit to be pressed.

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,

Return values:

0	if the stream finishes
the	character if it was interrupted,
-1	on error

Definition at line 1433 of file file.c.

References waitstream_core().

{
   return waitstream_core(c, breakon, NULL, NULL, 0, -1, -1, NULL, NULL /* no callback */);
}

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

Waits for a stream to stop or digit matching a valid one digit exten to be pressed.

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,

Return values:

0	if the stream finishes.
the	character if it was interrupted.
-1	on error.

Definition at line 1444 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 = ast_channel_context(c);
   return waitstream_core(c, NULL, NULL, NULL, 0,
      -1, -1, context, NULL /* no callback */);
}

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

Same as waitstream but allows stream to be forwarded or rewound.

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,

Return values:

0	if the stream finishes.
the	character if it was interrupted.
-1	on error.

Definition at line 1427 of file file.c.

References waitstream_core().

Referenced by control_streamfile().

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

int ast_waitstream_fr_w_cb	(	struct ast_channel *	c,
		const char *	breakon,
		const char *	forward,
		const char *	rewind,
		int	ms,
		ast_waitstream_fr_cb	cb
	)

Same as waitstream_fr but allows a callback to be alerted when a user fastforwards or rewinds the file.

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 milliseconds to skip forward/back
cb	to call when rewind or fastfoward occurs. Begins playback of a stream... Wait for a stream to stop or for any one of a given digit to arrive,

Return values:

0	if the stream finishes.
the	character if it was interrupted.
-1	on error.

Definition at line 1416 of file file.c.

References waitstream_core().

Referenced by control_streamfile().

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

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

Same as waitstream, but with audio output to fd and monitored fd checking.

Returns:: 1 if monfd is ready for reading

Definition at line 1438 of file file.c.

References waitstream_core().

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

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

Starts writing a file.

Parameters:

filename	the name of the file to write to
type	format of file you wish to write out to
comment	comment to go with
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.

Return values:

a	struct ast_filestream on success.
NULL	on failure.

Definition at line 1108 of file file.c.

References ast_alloca, ast_closestream(), ast_free, ast_log(), ast_malloc, ast_opt_cache_record_files, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_strdup, ast_filestream::buf, build_filename(), errno, ast_format_def::exts, exts_compare(), ast_filestream::f, f, ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, get_filestream(), LOG_WARNING, ast_filestream::mode, ast_filestream::realfilename, record_cache_dir, rewrite_wrapper(), ast_format_def::seek, ast_filestream::trans, ast_filestream::vfs, and ast_filestream::write_buffer.

Referenced by __ast_play_and_record(), ast_monitor_start(), ast_writestream(), dictate_exec(), handle_cli_file_convert(), handle_recordfile(), mixmonitor_save_prep(), record_exec(), and recordthread().

{
   int fd, myflags = 0;
   /* compiler claims this variable can be used before initialization... */
   FILE *bfile = NULL;
   struct ast_format_def *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);
      if (!fn) {
         continue;
      }
      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 = ast_alloca(size);
         strcpy(buf, record_cache_dir);
         strcat(buf, "/");
         strcat(buf, fn);
         ast_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) {
            if ((fs->write_buffer = ast_malloc(32768))) {
               setvbuf(fs->f, fs->write_buffer, _IOFBF, 32768);
            }
         }
         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_closestream(fs);
               fs = NULL;
            }
            if (!buf) {
               ast_free(fn);
            }
            continue;
         }
         fs->trans = NULL;
         fs->fmt = f;
         fs->flags = flags;
         fs->mode = mode;
         if (orig_fn) {
            fs->realfilename = ast_strdup(orig_fn);
            fs->filename = ast_strdup(fn);
         } else {
            fs->realfilename = NULL;
            fs->filename = ast_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)
         ast_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
	)

Writes a frame to a stream.

Parameters:

fs	filestream to write to
f	frame to write to the filestream Send a frame to a filestream -- note: does NOT free the frame, call ast_frfree manually

Return values:

0	on success.
-1	on failure.

Definition at line 152 of file file.c.

References ast_debug, ast_format_cmp(), AST_FORMAT_CMP_EQUAL, AST_FORMAT_CMP_NOT_EQUAL, ast_format_copy(), AST_FORMAT_GET_TYPE, AST_FORMAT_TYPE_AUDIO, AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_frfree, ast_getformatname(), AST_LIST_NEXT, ast_log(), ast_translate(), ast_translator_build_path(), ast_translator_free_path(), ast_writefile(), ast_writestream(), ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, ast_format_def::format, ast_frame_subclass::format, ast_frame::frametype, ast_format::id, ast_filestream::lastwriteformat, LOG_WARNING, ast_filestream::mode, ast_format_def::name, ast_frame::subclass, ast_filestream::trans, type, ast_filestream::vfs, and ast_format_def::write.

Referenced by __ast_play_and_record(), __ast_read(), ast_write(), ast_writestream(), dictate_exec(), handle_cli_file_convert(), handle_recordfile(), mixmonitor_thread(), record_exec(), and recordthread().

{
   int res = -1;
   if (f->frametype == AST_FRAME_VIDEO) {
      if (AST_FORMAT_GET_TYPE(fs->fmt->format.id) == AST_FORMAT_TYPE_AUDIO) {
         /* This is the audio portion.  Call the video one... */
         if (!fs->vfs && fs->filename) {
            const char *type = ast_getformatname(&f->subclass.format);
            fs->vfs = ast_writefile(fs->filename, type, NULL, fs->flags, 0, fs->mode);
            ast_debug(1, "Opened video output file\n");
         }
         if (fs->vfs)
            return ast_writestream(fs->vfs, f);
         /* else ignore */
         return 0;
      }
   } else if (f->frametype != AST_FRAME_VOICE) {
      ast_log(LOG_WARNING, "Tried to write non-voice frame\n");
      return -1;
   }
   if (ast_format_cmp(&f->subclass.format, &fs->fmt->format) != AST_FORMAT_CMP_NOT_EQUAL) {
      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 && (ast_format_cmp(&f->subclass.format, &fs->lastwriteformat) != AST_FORMAT_CMP_EQUAL)) {
         ast_translator_free_path(fs->trans);
         fs->trans = NULL;
      }
      if (!fs->trans)
         fs->trans = ast_translator_build_path(&fs->fmt->format, &f->subclass.format);
      if (!fs->trans)
         ast_log(LOG_WARNING, "Unable to translate to format %s, source format %s\n",
            fs->fmt->name, ast_getformatname(&f->subclass.format));
      else {
         struct ast_frame *trf;
         ast_format_copy(&fs->lastwriteformat, &f->subclass.format);
         /* Get the translated frame but don't consume the original in case they're using it on another stream */
         if ((trf = ast_translate(fs->trans, f, 0))) {
            struct ast_frame *cur;

            /* the translator may have returned multiple frames, so process them */
            for (cur = trf; cur; cur = AST_LIST_NEXT(cur, frame_list)) {
               if ((res = fs->fmt->write(fs, trf))) {
                  ast_log(LOG_WARNING, "Translated frame write failed\n");
                  break;
               }
            }
            ast_frfree(trf);
         } else {
            res = 0;
         }
      }
   }
   return res;
}

Asterisk developer's documentation

Defines

Typedefs

Enumerations

Functions

Detailed Description

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation