Mon Mar 31 07:40:38 2008

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)
 Stops a stream.
int ast_stream_and_wait (struct ast_channel *chan, const char *file, const char *language, const char *digits)
int ast_stream_fastforward (struct ast_filestream *fs, off_t ms)
int ast_stream_rewind (struct ast_filestream *fs, off_t ms)
int ast_streamfile (struct ast_channel *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 152 of file file.h.

Referenced by load_module().

#define AST_RESERVED_POINTERS   20

Definition at line 413 of file file.h.

#define SEEK_FORCECUR   10

Definition at line 145 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 749 of file file.c.

References s.

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

00750 {
00751    s->owner = chan;
00752    return 0;
00753 }

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

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

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

00793 {
00794    char *cmd = NULL;
00795    size_t size = 0;
00796    /* Stop a running stream if there is one */
00797    if (f->owner) {
00798       if (f->fmt->format < AST_FORMAT_MAX_AUDIO) {
00799          f->owner->stream = NULL;
00800          AST_SCHED_DEL(f->owner->sched, f->owner->streamid);
00801 #ifdef HAVE_ZAPTEL
00802          ast_settimeout(f->owner, 0, NULL, NULL);
00803 #endif         
00804       } else {
00805          f->owner->vstream = NULL;
00806          AST_SCHED_DEL(f->owner->sched, f->owner->vstreamid);
00807       }
00808    }
00809    /* destroy the translator on exit */
00810    if (f->trans)
00811       ast_translator_free_path(f->trans);
00812 
00813    if (f->realfilename && f->filename) {
00814          size = strlen(f->filename) + strlen(f->realfilename) + 15;
00815          cmd = alloca(size);
00816          memset(cmd,0,size);
00817          snprintf(cmd,size,"/bin/mv -f %s %s",f->filename,f->realfilename);
00818          ast_safe_system(cmd);
00819    }
00820 
00821    if (f->filename)
00822       free(f->filename);
00823    if (f->realfilename)
00824       free(f->realfilename);
00825    if (f->fmt->close)
00826       f->fmt->close(f);
00827    fclose(f->f);
00828    if (f->vfs)
00829       ast_closestream(f->vfs);
00830    if (f->orig_chan_name)
00831       free((void *) f->orig_chan_name);
00832    ast_module_unref(f->fmt->module);
00833    free(f);
00834    return 0;
00835 }

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

References ast_cli_register_multiple(), and cli_file.

Referenced by main().

01315 {
01316    ast_cli_register_multiple(cli_file, sizeof(cli_file) / sizeof(struct ast_cli_entry));
01317    return 0;
01318 }

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

References ast_filehelper().

Referenced by copy_plain_file(), and vm_forwardoptions().

00866 {
00867    return ast_filehelper(filename, filename2, fmt, ACTION_COPY);
00868 }

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

References ACTION_DELETE, and ast_filehelper().

Referenced by __ast_play_and_record(), ast_monitor_start(), ast_monitor_stop(), cli_audio_convert(), cli_audio_convert_deprecated(), leave_voicemail(), play_mailbox_owner(), play_record_review(), vm_delete(), and vm_forwardoptions().

00856 {
00857    return ast_filehelper(filename, NULL, fmt, ACTION_DELETE);
00858 }

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

References ast_filestream::buf, and fileexists_core().

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

00842 {
00843    char *buf;
00844    int buflen;
00845 
00846    if (preflang == NULL)
00847       preflang = "";
00848    buflen = strlen(preflang) + strlen(filename) + 4;  /* room for everything */
00849    buf = alloca(buflen);
00850    if (buf == NULL)
00851       return 0;
00852    return fileexists_core(filename, fmt, preflang, buf, buflen);
00853 }

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

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

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

References ast_openstream_full().

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

00568 {
00569    return ast_openstream_full(chan, filename, preflang, 0);
00570 }

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

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

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

00573 {
00574    /* 
00575     * Use fileexists_core() to find a file in a compatible
00576     * language and format, set up a suitable translator,
00577     * and open the stream.
00578     */
00579    int fmts, res, buflen;
00580    char *buf;
00581 
00582    if (!asis) {
00583       /* do this first, otherwise we detect the wrong writeformat */
00584       ast_stopstream(chan);
00585       if (chan->generator)
00586          ast_deactivate_generator(chan);
00587    }
00588    if (preflang == NULL)
00589       preflang = "";
00590    buflen = strlen(preflang) + strlen(filename) + 4;
00591    buf = alloca(buflen);
00592    if (buf == NULL)
00593       return NULL;
00594    fmts = fileexists_core(filename, NULL, preflang, buf, buflen);
00595    if (fmts > 0)
00596       fmts &= AST_FORMAT_AUDIO_MASK;
00597    if (fmts < 1) {
00598       ast_log(LOG_WARNING, "File %s does not exist in any format\n", filename);
00599       return NULL;
00600    }
00601    chan->oldwriteformat = chan->writeformat;
00602    /* Set the channel to a format we can work with */
00603    res = ast_set_write_format(chan, fmts);
00604    res = ast_filehelper(buf, chan, NULL, ACTION_OPEN);
00605    if (res >= 0)
00606       return chan->stream;
00607    return NULL;
00608 }

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

00611 {
00612    /* As above, but for video. But here we don't have translators
00613     * so we must enforce a format.
00614     */
00615    unsigned int format;
00616    char *buf;
00617    int buflen;
00618 
00619    if (preflang == NULL)
00620       preflang = "";
00621    buflen = strlen(preflang) + strlen(filename) + 4;
00622    buf = alloca(buflen);
00623    if (buf == NULL)
00624       return NULL;
00625 
00626    for (format = AST_FORMAT_MAX_AUDIO << 1; format <= AST_FORMAT_MAX_VIDEO; format = format << 1) {
00627       int fd;
00628       const char *fmt;
00629 
00630       if (!(chan->nativeformats & format))
00631          continue;
00632       fmt = ast_getformatname(format);
00633       if ( fileexists_core(filename, fmt, preflang, buf, buflen) < 1)   /* no valid format */
00634          continue;
00635       fd = ast_filehelper(buf, chan, fmt, ACTION_OPEN);
00636       if (fd >= 0)
00637          return chan->vstream;
00638       ast_log(LOG_WARNING, "File %s has video but couldn't be opened\n", filename);
00639    }
00640    return NULL;
00641 }

int ast_playstream ( struct ast_filestream s  ) 

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

Definition at line 755 of file file.c.

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

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

00756 {
00757    enum fsread_res res;
00758 
00759    if (s->fmt->format < AST_FORMAT_MAX_AUDIO)
00760       res = ast_readaudio_callback(s);
00761    else
00762       res = ast_readvideo_callback(s);
00763 
00764    return (res == FSREAD_FAILURE) ? -1 : 0;
00765 }

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

References ast_free, ast_log(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, build_filename(), errno, 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().

00902 {
00903    FILE *bfile;
00904    struct ast_format *f;
00905    struct ast_filestream *fs = NULL;
00906    char *fn;
00907 
00908    AST_RWLIST_RDLOCK(&formats);
00909 
00910    AST_RWLIST_TRAVERSE(&formats, f, list) {
00911       fs = NULL;
00912       if (!exts_compare(f->exts, type))
00913          continue;
00914 
00915       fn = build_filename(filename, type);
00916       errno = 0;
00917       bfile = fopen(fn, "r");
00918       if (!bfile || (fs = get_filestream(f, bfile)) == NULL ||
00919           open_wrapper(fs) ) {
00920          ast_log(LOG_WARNING, "Unable to open %s\n", fn);
00921          if (fs)
00922             ast_free(fs);
00923          if (bfile)
00924             fclose(bfile);
00925          free(fn);
00926          continue;
00927       }
00928       /* found it */
00929       fs->trans = NULL;
00930       fs->fmt = f;
00931       fs->flags = flags;
00932       fs->mode = mode;
00933       fs->filename = strdup(filename);
00934       fs->vfs = NULL;
00935       break;
00936    }
00937 
00938    AST_RWLIST_UNLOCK(&formats);
00939    if (!fs) 
00940       ast_log(LOG_WARNING, "No such format '%s'\n", type);
00941 
00942    return fs;
00943 }

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

References f, and s.

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

00644 {
00645    struct ast_frame *f = NULL;
00646    int whennext = 0; 
00647    if (s && s->fmt)
00648       f = s->fmt->read(s, &whennext);
00649    return f;
00650 }

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

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

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

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

Referenced by 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    ast_channel_lock(tmp);
00134 
00135    /* Stop a running stream if there is one */
00136    if (tmp->stream) {
00137       ast_closestream(tmp->stream);
00138       tmp->stream = NULL;
00139       if (tmp->oldwriteformat && ast_set_write_format(tmp, tmp->oldwriteformat))
00140          ast_log(LOG_WARNING, "Unable to restore format back to %d\n", tmp->oldwriteformat);
00141    }
00142    /* Stop the video stream too */
00143    if (tmp->vstream != NULL) {
00144       ast_closestream(tmp->vstream);
00145       tmp->vstream = NULL;
00146    }
00147 
00148    ast_channel_unlock(tmp);
00149 
00150    return 0;
00151 }

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

Definition at line 1237 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().

01239 {
01240         int res = 0;
01241         if (!ast_strlen_zero(file)) {
01242                 res =  ast_streamfile(chan, file, language);
01243                 if (!res)
01244                         res = ast_waitstream(chan, digits);
01245         }
01246         return res;
01247 } 

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

References ast_seekstream(), and DEFAULT_SAMPLES_PER_MS.

Referenced by waitstream_core().

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

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

References ast_seekstream(), and DEFAULT_SAMPLES_PER_MS.

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

00788 {
00789    return ast_seekstream(fs, -ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
00790 }

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

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

Referenced by __login_exec(), action_bridge(), 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(), bridge_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(), play_greeting(), 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().

00871 {
00872    struct ast_filestream *fs;
00873    struct ast_filestream *vfs=NULL;
00874    char fmt[256];
00875 
00876    fs = ast_openstream(chan, filename, preflang);
00877    if (fs)
00878       vfs = ast_openvstream(chan, filename, preflang);
00879    if (vfs)
00880       ast_log(LOG_DEBUG, "Ooh, found a video stream, too, format %s\n", ast_getformatname(vfs->fmt->format));
00881    if (fs){
00882       int res;
00883       if (ast_test_flag(chan, AST_FLAG_MASQ_NOSTREAM))
00884          fs->orig_chan_name = ast_strdup(chan->name);
00885       if (ast_applystream(chan, fs))
00886          return -1;
00887       if (vfs && ast_applystream(chan, vfs))
00888          return -1;
00889       res = ast_playstream(fs);
00890       if (!res && vfs)
00891          res = ast_playstream(vfs);
00892       if (option_verbose > 2)
00893          ast_verbose(VERBOSE_PREFIX_3 "<%s> Playing '%s' (language '%s')\n", chan->name, filename, preflang ? preflang : "default");
00894 
00895       return res;
00896    }
00897    ast_log(LOG_WARNING, "Unable to open %s (format %s): %s\n", filename, ast_getformatname_multiple(fmt, sizeof(fmt), chan->nativeformats), strerror(errno));
00898    return -1;
00899 }

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

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

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

00778 {
00779    return fs->fmt->tell(fs);
00780 }

int ast_truncstream ( struct ast_filestream fs  ) 

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

Definition at line 772 of file file.c.

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

Referenced by __ast_play_and_record(), and handle_recordfile().

00773 {
00774    return fs->fmt->trunc(fs);
00775 }

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

References waitstream_core().

Referenced by __login_exec(), action_bridge(), 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(), bridge_exec(), 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(), play_greeting(), 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().

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

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

References ast_channel::context, and waitstream_core().

Referenced by pbx_builtin_background().

01222 {
01223    /* Waitstream, with return in the case of a valid 1 digit extension */
01224    /* in the current or specified context being pressed */
01225 
01226    if (!context)
01227       context = c->context;
01228    return waitstream_core(c, NULL, NULL, NULL, 0,
01229       -1, -1, context);
01230 }

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

References waitstream_core().

Referenced by ast_control_streamfile().

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

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

Definition at line 1215 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().

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

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 945 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(), errno, 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().

00946 {
00947    int fd, myflags = 0;
00948    /* compiler claims this variable can be used before initialization... */
00949    FILE *bfile = NULL;
00950    struct ast_format *f;
00951    struct ast_filestream *fs = NULL;
00952    char *buf = NULL;
00953    size_t size = 0;
00954    int format_found = 0;
00955 
00956    AST_RWLIST_RDLOCK(&formats);
00957 
00958    /* set the O_TRUNC flag if and only if there is no O_APPEND specified */
00959    /* We really can't use O_APPEND as it will break WAV header updates */
00960    if (flags & O_APPEND) { 
00961       flags &= ~O_APPEND;
00962    } else {
00963       myflags = O_TRUNC;
00964    }
00965    
00966    myflags |= O_WRONLY | O_CREAT;
00967 
00968    /* XXX need to fix this - we should just do the fopen,
00969     * not open followed by fdopen()
00970     */
00971    AST_RWLIST_TRAVERSE(&formats, f, list) {
00972       char *fn, *orig_fn = NULL;
00973       if (fs)
00974          break;
00975 
00976       if (!exts_compare(f->exts, type))
00977          continue;
00978       else
00979          format_found = 1;
00980 
00981       fn = build_filename(filename, type);
00982       fd = open(fn, flags | myflags, mode);
00983       if (fd > -1) {
00984          /* fdopen() the resulting file stream */
00985          bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
00986          if (!bfile) {
00987             ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
00988             close(fd);
00989             fd = -1;
00990          }
00991       }
00992       
00993       if (ast_opt_cache_record_files && (fd > -1)) {
00994          char *c;
00995 
00996          fclose(bfile); /* this also closes fd */
00997          /*
00998            We touch orig_fn just as a place-holder so other things (like vmail) see the file is there.
00999            What we are really doing is writing to record_cache_dir until we are done then we will mv the file into place.
01000          */
01001          orig_fn = ast_strdupa(fn);
01002          for (c = fn; *c; c++)
01003             if (*c == '/')
01004                *c = '_';
01005 
01006          size = strlen(fn) + strlen(record_cache_dir) + 2;
01007          buf = alloca(size);
01008          strcpy(buf, record_cache_dir);
01009          strcat(buf, "/");
01010          strcat(buf, fn);
01011          free(fn);
01012          fn = buf;
01013          fd = open(fn, flags | myflags, mode);
01014          if (fd > -1) {
01015             /* fdopen() the resulting file stream */
01016             bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
01017             if (!bfile) {
01018                ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
01019                close(fd);
01020                fd = -1;
01021             }
01022          }
01023       }
01024       if (fd > -1) {
01025          errno = 0;
01026          fs = get_filestream(f, bfile);
01027          if (!fs || rewrite_wrapper(fs, comment)) {
01028             ast_log(LOG_WARNING, "Unable to rewrite %s\n", fn);
01029             close(fd);
01030             if (orig_fn) {
01031                unlink(fn);
01032                unlink(orig_fn);
01033             }
01034             if (fs)
01035                ast_free(fs);
01036             fs = NULL;
01037             continue;
01038          }
01039          fs->trans = NULL;
01040          fs->fmt = f;
01041          fs->flags = flags;
01042          fs->mode = mode;
01043          if (orig_fn) {
01044             fs->realfilename = strdup(orig_fn);
01045             fs->filename = strdup(fn);
01046          } else {
01047             fs->realfilename = NULL;
01048             fs->filename = strdup(filename);
01049          }
01050          fs->vfs = NULL;
01051          /* If truncated, we'll be at the beginning; if not truncated, then append */
01052          f->seek(fs, 0, SEEK_END);
01053       } else if (errno != EEXIST) {
01054          ast_log(LOG_WARNING, "Unable to open file %s: %s\n", fn, strerror(errno));
01055          if (orig_fn)
01056             unlink(orig_fn);
01057       }
01058       /* if buf != NULL then fn is already free and pointing to it */
01059       if (!buf)
01060          free(fn);
01061    }
01062 
01063    AST_RWLIST_UNLOCK(&formats);
01064 
01065    if (!format_found)
01066       ast_log(LOG_WARNING, "No such format '%s'\n", type);
01067 
01068    return fs;
01069 }

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

References AST_FORMAT_MAX_AUDIO, AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_frfree, 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().

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


Generated on Mon Mar 31 07:40:40 2008 for Asterisk - the Open Source PBX by  doxygen 1.5.1