Fri Aug 24 02:25:22 2007

Asterisk developer's documentation


file.h File Reference

Generic File Format Support. More...

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

Include dependency graph for file.h:

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

Go to the source code of this file.

Data Structures

struct  ast_filestream
struct  ast_format
struct  ast_format_lock

Defines

#define AST_DIGIT_ANY   "0123456789#*ABCD"
#define AST_DIGIT_ANYNUM   "0123456789"
#define ast_format_register(f)   __ast_format_register(f, ast_module_info->self)
#define AST_RESERVED_POINTERS   20
#define SEEK_FORCECUR   10

Functions

int __ast_format_register (const struct ast_format *f, struct ast_module *mod)
int ast_applystream (struct ast_channel *chan, struct ast_filestream *s)
int ast_closestream (struct ast_filestream *f)
int ast_file_init (void)
int ast_filecopy (const char *oldname, const char *newname, const char *fmt)
int ast_filedelete (const char *filename, const char *fmt)
int ast_fileexists (const char *filename, const char *fmt, const char *preflang)
int ast_filerename (const char *oldname, const char *newname, const char *fmt)
int ast_format_unregister (const char *name)
ast_filestreamast_openstream (struct ast_channel *chan, const char *filename, const char *preflang)
ast_filestreamast_openstream_full (struct ast_channel *chan, const char *filename, const char *preflang, int asis)
ast_filestreamast_openvstream (struct ast_channel *chan, const char *filename, const char *preflang)
int ast_playstream (struct ast_filestream *s)
ast_filestreamast_readfile (const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode)
ast_frameast_readframe (struct ast_filestream *s)
int ast_seekstream (struct ast_filestream *fs, off_t sample_offset, int whence)
int ast_stopstream (struct ast_channel *c)
int ast_stream_and_wait (struct ast_channel *chan, const char *file, const char *language, const char *digits)
int ast_stream_fastforward (struct ast_filestream *fs, off_t ms)
int ast_stream_rewind (struct ast_filestream *fs, off_t ms)
int ast_streamfile (struct ast_channel *c, const char *filename, const char *preflang)
off_t ast_tellstream (struct ast_filestream *fs)
int ast_truncstream (struct ast_filestream *fs)
int ast_waitstream (struct ast_channel *c, const char *breakon)
int ast_waitstream_exten (struct ast_channel *c, const char *context)
int ast_waitstream_fr (struct ast_channel *c, const char *breakon, const char *forward, const char *rewind, int ms)
int ast_waitstream_full (struct ast_channel *c, const char *breakon, int audiofd, int monfd)
ast_filestreamast_writefile (const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode)
int ast_writestream (struct ast_filestream *fs, struct ast_frame *f)


Detailed Description

Generic File Format Support.

Definition in file file.h.


Define Documentation

#define AST_DIGIT_ANY   "0123456789#*ABCD"

Convenient for waiting

Definition at line 40 of file file.h.

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

#define AST_DIGIT_ANYNUM   "0123456789"

Definition at line 41 of file file.h.

Referenced by initreqprep().

#define ast_format_register ( f   )     __ast_format_register(f, ast_module_info->self)

Definition at line 145 of file file.h.

Referenced by load_module().

#define AST_RESERVED_POINTERS   20

Definition at line 401 of file file.h.

#define SEEK_FORCECUR   10

Definition at line 138 of file file.h.

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


Function Documentation

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

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

Definition at line 68 of file file.c.

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

00069 {
00070    struct ast_format *tmp;
00071 
00072    AST_RWLIST_WRLOCK(&formats);
00073    AST_RWLIST_TRAVERSE(&formats, tmp, list) {
00074       if (!strcasecmp(f->name, tmp->name)) {
00075          AST_RWLIST_UNLOCK(&formats);
00076          ast_log(LOG_WARNING, "Tried to register '%s' format, already registered\n", f->name);
00077          return -1;
00078       }
00079    }
00080    if (!(tmp = ast_calloc(1, sizeof(*tmp)))) {
00081       AST_RWLIST_UNLOCK(&formats);
00082       return -1;
00083    }
00084    *tmp = *f;
00085    tmp->module = mod;
00086    if (tmp->buf_size) {
00087       /*
00088        * Align buf_size properly, rounding up to the machine-specific
00089        * alignment for pointers.
00090        */
00091       struct _test_align { void *a, *b; } p;
00092       int align = (char *)&p.b - (char *)&p.a;
00093       tmp->buf_size = ((f->buf_size + align - 1)/align)*align;
00094    }
00095    
00096    memset(&tmp->list, 0, sizeof(tmp->list));
00097 
00098    AST_RWLIST_INSERT_HEAD(&formats, tmp, list);
00099    AST_RWLIST_UNLOCK(&formats);
00100    if (option_verbose > 1)
00101       ast_verbose( VERBOSE_PREFIX_2 "Registered file format %s, extension(s) %s\n", f->name, f->exts);
00102 
00103    return 0;
00104 }

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

References s.

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

00661 {
00662    s->owner = chan;
00663    return 0;
00664 }

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

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

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

00701 {
00702    char *cmd = NULL;
00703    size_t size = 0;
00704    /* Stop a running stream if there is one */
00705    if (f->owner) {
00706       if (f->fmt->format < AST_FORMAT_MAX_AUDIO) {
00707          f->owner->stream = NULL;
00708          if (f->owner->streamid > -1)
00709             ast_sched_del(f->owner->sched, f->owner->streamid);
00710          f->owner->streamid = -1;
00711 #ifdef HAVE_ZAPTEL
00712          ast_settimeout(f->owner, 0, NULL, NULL);
00713 #endif         
00714       } else {
00715          f->owner->vstream = NULL;
00716          if (f->owner->vstreamid > -1)
00717             ast_sched_del(f->owner->sched, f->owner->vstreamid);
00718          f->owner->vstreamid = -1;
00719       }
00720    }
00721    /* destroy the translator on exit */
00722    if (f->trans)
00723       ast_translator_free_path(f->trans);
00724 
00725    if (f->realfilename && f->filename) {
00726          size = strlen(f->filename) + strlen(f->realfilename) + 15;
00727          cmd = alloca(size);
00728          memset(cmd,0,size);
00729          snprintf(cmd,size,"/bin/mv -f %s %s",f->filename,f->realfilename);
00730          ast_safe_system(cmd);
00731    }
00732 
00733    if (f->filename)
00734       free(f->filename);
00735    if (f->realfilename)
00736       free(f->realfilename);
00737    if (f->fmt->close)
00738       f->fmt->close(f);
00739    fclose(f->f);
00740    if (f->vfs)
00741       ast_closestream(f->vfs);
00742    ast_module_unref(f->fmt->module);
00743    free(f);
00744    return 0;
00745 }

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

References ast_cli_register_multiple(), and cli_file.

Referenced by main().

01206 {
01207    ast_cli_register_multiple(cli_file, sizeof(cli_file) / sizeof(struct ast_cli_entry));
01208    return 0;
01209 }

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

References ast_filehelper().

Referenced by copy_file().

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

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 765 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(), and vm_delete().

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

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

References fileexists_core().

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

00752 {
00753    char *buf;
00754    int buflen;
00755 
00756    if (preflang == NULL)
00757       preflang = "";
00758    buflen = strlen(preflang) + strlen(filename) + 2;  /* room for everything */
00759    buf = alloca(buflen);
00760    if (buf == NULL)
00761       return 0;
00762    return fileexists_core(filename, fmt, preflang, buf, buflen);
00763 }

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 770 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().

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

int ast_format_unregister ( const char *  name  ) 

Parameters:
name the name of the format you wish to unregister Unregisters a format based on the name of the format. Returns 0 on success, -1 on failure to unregister

Definition at line 106 of file file.c.

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

Referenced by unload_module().

00107 {
00108    struct ast_format *tmp;
00109    int res = -1;
00110 
00111    AST_RWLIST_WRLOCK(&formats);
00112    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&formats, tmp, list) {
00113       if (!strcasecmp(name, tmp->name)) {
00114          AST_RWLIST_REMOVE_CURRENT(&formats, list);
00115          free(tmp);
00116          res = 0;
00117       }
00118    }
00119    AST_RWLIST_TRAVERSE_SAFE_END
00120    AST_RWLIST_UNLOCK(&formats);
00121 
00122    if (!res) {
00123       if (option_verbose > 1)
00124          ast_verbose( VERBOSE_PREFIX_2 "Unregistered format %s\n", name);
00125    } else
00126       ast_log(LOG_WARNING, "Tried to unregister format %s, already unregistered\n", name);
00127 
00128    return res;
00129 }

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

References ast_openstream_full().

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

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

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

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

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

00529 {
00530    /* 
00531     * Use fileexists_core() to find a file in a compatible
00532     * language and format, set up a suitable translator,
00533     * and open the stream.
00534     */
00535    int fmts, res, buflen;
00536    char *buf;
00537 
00538    if (!asis) {
00539       /* do this first, otherwise we detect the wrong writeformat */
00540       ast_stopstream(chan);
00541       if (chan->generator)
00542          ast_deactivate_generator(chan);
00543    }
00544    if (preflang == NULL)
00545       preflang = "";
00546    buflen = strlen(preflang) + strlen(filename) + 2;
00547    buf = alloca(buflen);
00548    if (buf == NULL)
00549       return NULL;
00550    fmts = fileexists_core(filename, NULL, preflang, buf, buflen);
00551    if (fmts > 0)
00552       fmts &= AST_FORMAT_AUDIO_MASK;
00553    if (fmts < 1) {
00554       ast_log(LOG_WARNING, "File %s does not exist in any format\n", filename);
00555       return NULL;
00556    }
00557    chan->oldwriteformat = chan->writeformat;
00558    /* Set the channel to a format we can work with */
00559    res = ast_set_write_format(chan, fmts);
00560    res = ast_filehelper(buf, chan, NULL, ACTION_OPEN);
00561    if (res >= 0)
00562       return chan->stream;
00563    return NULL;
00564 }

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 566 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().

00567 {
00568    /* As above, but for video. But here we don't have translators
00569     * so we must enforce a format.
00570     */
00571    unsigned int format;
00572    char *buf;
00573    int buflen;
00574 
00575    if (preflang == NULL)
00576       preflang = "";
00577    buflen = strlen(preflang) + strlen(filename) + 2;
00578    buf = alloca(buflen);
00579    if (buf == NULL)
00580       return NULL;
00581 
00582    for (format = AST_FORMAT_MAX_AUDIO << 1; format <= AST_FORMAT_MAX_VIDEO; format = format << 1) {
00583       int fd;
00584       const char *fmt;
00585 
00586       if (!(chan->nativeformats & format))
00587          continue;
00588       fmt = ast_getformatname(format);
00589       if ( fileexists_core(filename, fmt, preflang, buf, buflen) < 1)   /* no valid format */
00590          continue;
00591       fd = ast_filehelper(buf, chan, fmt, ACTION_OPEN);
00592       if (fd >= 0)
00593          return chan->vstream;
00594       ast_log(LOG_WARNING, "File %s has video but couldn't be opened\n", filename);
00595    }
00596    return NULL;
00597 }

int ast_playstream ( struct ast_filestream s  ) 

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

Definition at line 666 of file file.c.

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

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

00667 {
00668    if (s->fmt->format < AST_FORMAT_MAX_AUDIO)
00669       ast_readaudio_callback(s);
00670    else
00671       ast_readvideo_callback(s);
00672    return 0;
00673 }

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

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

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

00809 {
00810    FILE *bfile;
00811    struct ast_format *f;
00812    struct ast_filestream *fs = NULL;
00813    char *fn;
00814 
00815    AST_RWLIST_RDLOCK(&formats);
00816 
00817    AST_RWLIST_TRAVERSE(&formats, f, list) {
00818       fs = NULL;
00819       if (!exts_compare(f->exts, type))
00820          continue;
00821 
00822       fn = build_filename(filename, type);
00823       errno = 0;
00824       bfile = fopen(fn, "r");
00825       if (!bfile || (fs = get_filestream(f, bfile)) == NULL ||
00826           open_wrapper(fs) ) {
00827          ast_log(LOG_WARNING, "Unable to open %s\n", fn);
00828          if (fs)
00829             ast_free(fs);
00830          if (bfile)
00831             fclose(bfile);
00832          free(fn);
00833          continue;
00834       }
00835       /* found it */
00836       fs->trans = NULL;
00837       fs->fmt = f;
00838       fs->flags = flags;
00839       fs->mode = mode;
00840       fs->filename = strdup(filename);
00841       fs->vfs = NULL;
00842       break;
00843    }
00844 
00845    AST_RWLIST_UNLOCK(&formats);
00846    if (!fs) 
00847       ast_log(LOG_WARNING, "No such format '%s'\n", type);
00848 
00849    return fs;
00850 }

struct ast_frame* ast_readframe ( struct ast_filestream s  ) 

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

Definition at line 599 of file file.c.

References f, and s.

Referenced by __ast_play_and_record(), channel_spy(), cli_audio_convert(), cli_audio_convert_deprecated(), dictate_exec(), gen_readframe(), and moh_files_readframe().

00600 {
00601    struct ast_frame *f = NULL;
00602    int whennext = 0; 
00603    if (s && s->fmt)
00604       f = s->fmt->read(s, &whennext);
00605    return f;
00606 }

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

Parameters:
fs ast_filestream to perform seek on
sample_offset numbers of samples to seek
whence SEEK_SET, SEEK_CUR, SEEK_END Returns 0 for success, or -1 for error

Definition at line 675 of file file.c.

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

Referenced by __ast_read(), ast_control_streamfile(), ast_stream_fastforward(), ast_stream_rewind(), ast_write(), dictate_exec(), handle_getoption(), handle_recordfile(), and handle_streamfile().

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

int ast_stopstream ( struct ast_channel c  ) 

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

Definition at line 131 of file file.c.

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

Referenced by app_exec(), ast_adsi_transmit_message_full(), ast_app_getdata(), ast_control_streamfile(), ast_openstream_full(), ast_play_and_wait(), ast_readstring_full(), ast_say_enumeration_full_da(), ast_say_enumeration_full_de(), ast_say_enumeration_full_en(), ast_say_number_full_cz(), ast_say_number_full_da(), ast_say_number_full_de(), ast_say_number_full_en(), ast_say_number_full_en_GB(), ast_say_number_full_es(), ast_say_number_full_fr(), ast_say_number_full_ge(), ast_say_number_full_gr(), ast_say_number_full_he(), ast_say_number_full_it(), ast_say_number_full_nl(), ast_say_number_full_no(), ast_say_number_full_pt(), ast_say_number_full_ru(), ast_say_number_full_se(), ast_say_number_full_tw(), background_detect_exec(), builtin_blindtransfer(), conf_exec(), conf_run(), directory_exec(), handle_getoption(), handle_streamfile(), ices_exec(), ivr_dispatch(), leave_voicemail(), mp3_exec(), NBScat_exec(), nv_background_detect_exec(), parkandannounce_exec(), pbx_builtin_background(), pl_odtworz_plik(), play_file(), play_mailbox_owner(), playback_exec(), queue_exec(), read_exec(), recordthread(), rpt_tele_thread(), s_streamwait3(), say_character_str_full(), say_digit_str_full(), say_phonetic_str_full(), saycharstr(), sayfile(), saynum(), send_morse(), send_tone_telemetry(), send_waveform_to_channel(), speech_background(), vm_authenticate(), vm_execmain(), wait_for_winner(), waitstream_core(), and zapateller_exec().

00132 {
00133    /* Stop a running stream if there is one */
00134    if (tmp->stream) {
00135       ast_closestream(tmp->stream);
00136       tmp->stream = NULL;
00137       if (tmp->oldwriteformat && ast_set_write_format(tmp, tmp->oldwriteformat))
00138          ast_log(LOG_WARNING, "Unable to restore format back to %d\n", tmp->oldwriteformat);
00139    }
00140    /* Stop the video stream too */
00141    if (tmp->vstream != NULL) {
00142       ast_closestream(tmp->vstream);
00143       tmp->vstream = NULL;
00144    }
00145    return 0;
00146 }

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

Definition at line 1128 of file file.c.

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

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

01130 {
01131         int res = 0;
01132         if (!ast_strlen_zero(file)) {
01133                 res =  ast_streamfile(chan, file, language);
01134                 if (!res)
01135                         res = ast_waitstream(chan, digits);
01136         }
01137         return res;
01138 } 

int ast_stream_fastforward ( struct ast_filestream fs,
off_t  ms 
)

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

Definition at line 690 of file file.c.

References ast_seekstream(), and DEFAULT_SAMPLES_PER_MS.

Referenced by waitstream_core().

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

int ast_stream_rewind ( struct ast_filestream fs,
off_t  ms 
)

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

Definition at line 695 of file file.c.

References ast_seekstream(), and DEFAULT_SAMPLES_PER_MS.

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

00696 {
00697    return ast_seekstream(fs, -ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
00698 }

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

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

Definition at line 780 of file file.c.

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

Referenced by __login_exec(), agent_call(), app_exec(), ast_app_getdata(), ast_app_getdata_full(), ast_control_streamfile(), ast_play_and_wait(), ast_say_date_da(), ast_say_date_de(), ast_say_date_en(), ast_say_date_fr(), ast_say_date_ge(), ast_say_date_gr(), ast_say_date_nl(), ast_say_date_with_format_gr(), ast_say_datetime_en(), ast_say_datetime_fr(), ast_say_datetime_from_now_en(), ast_say_datetime_from_now_fr(), ast_say_datetime_from_now_ge(), ast_say_datetime_gr(), ast_say_datetime_nl(), ast_say_datetime_pt(), ast_say_datetime_tw(), ast_say_enumeration_full_da(), ast_say_enumeration_full_de(), ast_say_enumeration_full_en(), ast_say_number_full_cz(), ast_say_number_full_da(), ast_say_number_full_de(), ast_say_number_full_en(), ast_say_number_full_en_GB(), ast_say_number_full_es(), ast_say_number_full_fr(), ast_say_number_full_ge(), ast_say_number_full_gr(), ast_say_number_full_he(), ast_say_number_full_it(), ast_say_number_full_nl(), ast_say_number_full_no(), ast_say_number_full_pt(), ast_say_number_full_ru(), ast_say_number_full_se(), ast_say_number_full_tw(), ast_say_time_de(), ast_say_time_en(), ast_say_time_fr(), ast_say_time_ge(), ast_say_time_gr(), ast_say_time_nl(), ast_say_time_tw(), ast_stream_and_wait(), background_detect_exec(), check_availability(), check_beep(), common_exec(), conf_exec(), conf_run(), do_directory(), forward_message(), gr_say_number_female(), handle_recordfile(), leave_voicemail(), nv_background_detect_exec(), page_exec(), park_exec(), parkandannounce_exec(), pbx_builtin_background(), pl_odtworz_plik(), play_and_wait(), play_file(), playback_exec(), privacy_exec(), retrydial_exec(), rpt_tele_thread(), s_streamwait3(), say_character_str_full(), say_digit_str_full(), say_phonetic_str_full(), sayfile(), ss_thread(), vm_authenticate(), wait_file(), and wait_for_winner().

00781 {
00782    struct ast_filestream *fs;
00783    struct ast_filestream *vfs=NULL;
00784    char fmt[256];
00785 
00786    fs = ast_openstream(chan, filename, preflang);
00787    if (fs)
00788       vfs = ast_openvstream(chan, filename, preflang);
00789    if (vfs)
00790       ast_log(LOG_DEBUG, "Ooh, found a video stream, too, format %s\n", ast_getformatname(vfs->fmt->format));
00791    if (fs){
00792       if (ast_applystream(chan, fs))
00793          return -1;
00794       if (vfs && ast_applystream(chan, vfs))
00795          return -1;
00796       ast_playstream(fs);
00797       if (vfs)
00798          ast_playstream(vfs);
00799       if (option_verbose > 2)
00800          ast_verbose(VERBOSE_PREFIX_3 "<%s> Playing '%s' (language '%s')\n", chan->name, filename, preflang ? preflang : "default");
00801 
00802       return 0;
00803    }
00804    ast_log(LOG_WARNING, "Unable to open %s (format %s): %s\n", filename, ast_getformatname_multiple(fmt, sizeof(fmt), chan->nativeformats), strerror(errno));
00805    return -1;
00806 }

off_t ast_tellstream ( struct ast_filestream fs  ) 

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

Definition at line 685 of file file.c.

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

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

00686 {
00687    return fs->fmt->tell(fs);
00688 }

int ast_truncstream ( struct ast_filestream fs  ) 

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

Definition at line 680 of file file.c.

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

Referenced by __ast_play_and_record(), and handle_recordfile().

00681 {
00682    return fs->fmt->trunc(fs);
00683 }

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

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

Definition at line 1101 of file file.c.

References waitstream_core().

Referenced by __login_exec(), agent_call(), app_exec(), ast_app_getdata(), ast_play_and_wait(), ast_say_date_da(), ast_say_date_de(), ast_say_date_en(), ast_say_date_fr(), ast_say_date_ge(), ast_say_date_gr(), ast_say_date_nl(), ast_say_date_with_format_gr(), ast_say_datetime_en(), ast_say_datetime_fr(), ast_say_datetime_from_now_en(), ast_say_datetime_from_now_fr(), ast_say_datetime_from_now_ge(), ast_say_datetime_gr(), ast_say_datetime_nl(), ast_say_datetime_pt(), ast_say_datetime_tw(), ast_say_enumeration_full_da(), ast_say_enumeration_full_de(), ast_say_enumeration_full_en(), ast_say_number_full_cz(), ast_say_number_full_da(), ast_say_number_full_de(), ast_say_number_full_en(), ast_say_number_full_en_GB(), ast_say_number_full_es(), ast_say_number_full_fr(), ast_say_number_full_ge(), ast_say_number_full_gr(), ast_say_number_full_he(), ast_say_number_full_it(), ast_say_number_full_nl(), ast_say_number_full_no(), ast_say_number_full_pt(), ast_say_number_full_ru(), ast_say_number_full_se(), ast_say_number_full_tw(), ast_say_time_de(), ast_say_time_en(), ast_say_time_ge(), ast_say_time_gr(), ast_say_time_nl(), ast_say_time_tw(), ast_stream_and_wait(), check_availability(), check_beep(), common_exec(), conf_exec(), conf_run(), directory_exec(), gr_say_number_female(), handle_recordfile(), leave_voicemail(), page_exec(), park_exec(), parkandannounce_exec(), pbx_builtin_background(), pl_odtworz_plik(), play_and_wait(), play_file(), playback_exec(), privacy_exec(), retrydial_exec(), rpt_tele_thread(), s_streamwait3(), say_character_str_full(), say_digit_str_full(), say_phonetic_str_full(), saycharstr(), sayfile(), saynum(), send_morse(), send_tone_telemetry(), ss_thread(), vm_authenticate(), and wait_file().

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

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

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

Definition at line 1112 of file file.c.

References ast_channel::context, and waitstream_core().

Referenced by pbx_builtin_background().

01113 {
01114    /* Waitstream, with return in the case of a valid 1 digit extension */
01115    /* in the current or specified context being pressed */
01116 
01117    if (!context)
01118       context = c->context;
01119    return waitstream_core(c, NULL, NULL, NULL, 0,
01120       -1, -1, context);
01121 }

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

Parameters:
c channel to waitstream on
breakon string of DTMF digits to break upon
forward DTMF digit to fast forward upon
rewind DTMF digit to rewind upon
ms How many miliseconds to skip forward/back Begins playback of a stream... Wait for a stream to stop or for any one of a given digit to arrive, Returns 0 if the stream finishes, the character if it was interrupted, and -1 on error

Definition at line 1095 of file file.c.

References waitstream_core().

Referenced by ast_control_streamfile().

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

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

Definition at line 1106 of file file.c.

References waitstream_core().

Referenced by ast_readstring_full(), ast_say_enumeration_full_da(), ast_say_enumeration_full_de(), ast_say_enumeration_full_en(), ast_say_number_full_cz(), ast_say_number_full_da(), ast_say_number_full_de(), ast_say_number_full_en(), ast_say_number_full_en_GB(), ast_say_number_full_es(), ast_say_number_full_fr(), ast_say_number_full_ge(), ast_say_number_full_gr(), ast_say_number_full_he(), ast_say_number_full_it(), ast_say_number_full_nl(), ast_say_number_full_no(), ast_say_number_full_pt(), ast_say_number_full_ru(), ast_say_number_full_se(), ast_say_number_full_tw(), handle_getoption(), handle_streamfile(), pl_odtworz_plik(), s_streamwait3(), say_character_str_full(), say_digit_str_full(), and say_phonetic_str_full().

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

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

Parameters:
filename the name of the file to write to
type format of file you wish to write out to
comment comment to go with
flags output file flags
check (unimplemented, hence negligible)
mode Open mode Create an outgoing file stream. oflags are flags for the open() command, and if check is non-zero, then it will not write a file if there are any files that start with that name and have an extension Please note, this is a blocking function. Program execution will not return until ast_waitstream completes it's execution. Returns a struct ast_filestream on success, NULL on failure

Definition at line 852 of file file.c.

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

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

00853 {
00854    int fd, myflags = 0;
00855    /* compiler claims this variable can be used before initialization... */
00856    FILE *bfile = NULL;
00857    struct ast_format *f;
00858    struct ast_filestream *fs = NULL;
00859    char *buf = NULL;
00860    size_t size = 0;
00861    int format_found = 0;
00862 
00863    AST_RWLIST_RDLOCK(&formats);
00864 
00865    /* set the O_TRUNC flag if and only if there is no O_APPEND specified */
00866    /* We really can't use O_APPEND as it will break WAV header updates */
00867    if (flags & O_APPEND) { 
00868       flags &= ~O_APPEND;
00869    } else {
00870       myflags = O_TRUNC;
00871    }
00872    
00873    myflags |= O_WRONLY | O_CREAT;
00874 
00875    /* XXX need to fix this - we should just do the fopen,
00876     * not open followed by fdopen()
00877     */
00878    AST_RWLIST_TRAVERSE(&formats, f, list) {
00879       char *fn, *orig_fn = NULL;
00880       if (fs)
00881          break;
00882 
00883       if (!exts_compare(f->exts, type))
00884          continue;
00885       else
00886          format_found = 1;
00887 
00888       fn = build_filename(filename, type);
00889       fd = open(fn, flags | myflags, mode);
00890       if (fd > -1) {
00891          /* fdopen() the resulting file stream */
00892          bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
00893          if (!bfile) {
00894             ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
00895             close(fd);
00896             fd = -1;
00897          }
00898       }
00899       
00900       if (ast_opt_cache_record_files && (fd > -1)) {
00901          char *c;
00902 
00903          fclose(bfile); /* this also closes fd */
00904          /*
00905            We touch orig_fn just as a place-holder so other things (like vmail) see the file is there.
00906            What we are really doing is writing to record_cache_dir until we are done then we will mv the file into place.
00907          */
00908          orig_fn = ast_strdupa(fn);
00909          for (c = fn; *c; c++)
00910             if (*c == '/')
00911                *c = '_';
00912 
00913          size = strlen(fn) + strlen(record_cache_dir) + 2;
00914          buf = alloca(size);
00915          strcpy(buf, record_cache_dir);
00916          strcat(buf, "/");
00917          strcat(buf, fn);
00918          free(fn);
00919          fn = buf;
00920          fd = open(fn, flags | myflags, mode);
00921          if (fd > -1) {
00922             /* fdopen() the resulting file stream */
00923             bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
00924             if (!bfile) {
00925                ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
00926                close(fd);
00927                fd = -1;
00928             }
00929          }
00930       }
00931       if (fd > -1) {
00932          errno = 0;
00933          fs = get_filestream(f, bfile);
00934          if (!fs || rewrite_wrapper(fs, comment)) {
00935             ast_log(LOG_WARNING, "Unable to rewrite %s\n", fn);
00936             close(fd);
00937             if (orig_fn) {
00938                unlink(fn);
00939                unlink(orig_fn);
00940             }
00941             if (fs)
00942                ast_free(fs);
00943             fs = NULL;
00944             continue;
00945          }
00946          fs->trans = NULL;
00947          fs->fmt = f;
00948          fs->flags = flags;
00949          fs->mode = mode;
00950          if (orig_fn) {
00951             fs->realfilename = strdup(orig_fn);
00952             fs->filename = strdup(fn);
00953          } else {
00954             fs->realfilename = NULL;
00955             fs->filename = strdup(filename);
00956          }
00957          fs->vfs = NULL;
00958          /* If truncated, we'll be at the beginning; if not truncated, then append */
00959          f->seek(fs, 0, SEEK_END);
00960       } else if (errno != EEXIST) {
00961          ast_log(LOG_WARNING, "Unable to open file %s: %s\n", fn, strerror(errno));
00962          if (orig_fn)
00963             unlink(orig_fn);
00964       }
00965       /* if buf != NULL then fn is already free and pointing to it */
00966       if (!buf)
00967          free(fn);
00968    }
00969 
00970    AST_RWLIST_UNLOCK(&formats);
00971 
00972    if (!format_found)
00973       ast_log(LOG_WARNING, "No such format '%s'\n", type);
00974 
00975    return fs;
00976 }

int ast_writestream ( struct ast_filestream fs,
struct ast_frame f 
)

Parameters:
fs filestream to write to
f frame to write to the filestream Send a frame to a filestream -- note: does NOT free the frame, call ast_frfree manually Returns 0 on success, -1 on failure.

Definition at line 148 of file file.c.

References AST_FORMAT_MAX_AUDIO, AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_getformatname(), ast_log(), ast_translate(), ast_translator_build_path(), ast_translator_free_path(), ast_writefile(), ast_writestream(), f, ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, ast_format::format, ast_filestream::lastwriteformat, LOG_DEBUG, LOG_WARNING, ast_filestream::mode, ast_format::name, ast_filestream::trans, type, ast_filestream::vfs, and ast_format::write.

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

00149 {
00150    int res = -1;
00151    int alt = 0;
00152    if (f->frametype == AST_FRAME_VIDEO) {
00153       if (fs->fmt->format < AST_FORMAT_MAX_AUDIO) {
00154          /* This is the audio portion.  Call the video one... */
00155          if (!fs->vfs && fs->filename) {
00156             const char *type = ast_getformatname(f->subclass & ~0x1);
00157             fs->vfs = ast_writefile(fs->filename, type, NULL, fs->flags, 0, fs->mode);
00158             ast_log(LOG_DEBUG, "Opened video output file\n");
00159          }
00160          if (fs->vfs)
00161             return ast_writestream(fs->vfs, f);
00162          /* else ignore */
00163          return 0;            
00164       } else {
00165          /* Might / might not have mark set */
00166          alt = 1;
00167       }
00168    } else if (f->frametype != AST_FRAME_VOICE) {
00169       ast_log(LOG_WARNING, "Tried to write non-voice frame\n");
00170       return -1;
00171    }
00172    if (((fs->fmt->format | alt) & f->subclass) == f->subclass) {
00173       res =  fs->fmt->write(fs, f);
00174       if (res < 0) 
00175          ast_log(LOG_WARNING, "Natural write failed\n");
00176       else if (res > 0)
00177          ast_log(LOG_WARNING, "Huh??\n");
00178    } else {
00179       /* XXX If they try to send us a type of frame that isn't the normal frame, and isn't
00180              the one we've setup a translator for, we do the "wrong thing" XXX */
00181       if (fs->trans && f->subclass != fs->lastwriteformat) {
00182          ast_translator_free_path(fs->trans);
00183          fs->trans = NULL;
00184       }
00185       if (!fs->trans) 
00186          fs->trans = ast_translator_build_path(fs->fmt->format, f->subclass);
00187       if (!fs->trans)
00188          ast_log(LOG_WARNING, "Unable to translate to format %s, source format %s\n",
00189             fs->fmt->name, ast_getformatname(f->subclass));
00190       else {
00191          struct ast_frame *trf;
00192          fs->lastwriteformat = f->subclass;
00193          /* Get the translated frame but don't consume the original in case they're using it on another stream */
00194          trf = ast_translate(fs->trans, f, 0);
00195          if (trf) {
00196             res = fs->fmt->write(fs, trf);
00197             if (res) 
00198                ast_log(LOG_WARNING, "Translated frame write failed\n");
00199          } else
00200             res = 0;
00201       }
00202    }
00203    return res;
00204 }


Generated on Fri Aug 24 02:25:23 2007 for Asterisk - the Open Source PBX by  doxygen 1.5.1