Sun Jun 12 16:37:57 2011

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:

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)
struct ast_filestreamast_openstream (struct ast_channel *chan, const char *filename, const char *preflang)
struct ast_filestreamast_openstream_full (struct ast_channel *chan, const char *filename, const char *preflang, int asis)
struct ast_filestreamast_openvstream (struct ast_channel *chan, const char *filename, const char *preflang)
int ast_playstream (struct ast_filestream *s)
struct ast_filestreamast_readfile (const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode)
struct 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)
struct 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"

#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


Function Documentation

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

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

Definition at line 68 of file file.c.

References ast_calloc, AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log(), ast_verbose(), ast_format::buf_size, ast_format::exts, LOG_WARNING, ast_format::module, ast_format::name, option_verbose, and VERBOSE_PREFIX_2.

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

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 Returns 0 for success, -1 on failure

Definition at line 764 of file file.c.

References ast_filestream::owner.

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

00765 {
00766    s->owner = chan;
00767    return 0;
00768 }

int ast_closestream ( struct ast_filestream f  ) 

Closes a stream

Parameters:
f filestream to close Close a playback or recording stream Returns 0 on success, -1 on failure

Definition at line 807 of file file.c.

References ast_closestream(), AST_FORMAT_MAX_AUDIO, ast_module_unref(), ast_safe_system(), AST_SCHED_DEL, ast_settimeout(), ast_translator_free_path(), ast_format::close, ast_filestream::f, ast_filestream::filename, ast_filestream::fmt, ast_format::format, free, ast_format::module, ast_filestream::orig_chan_name, ast_filestream::owner, ast_filestream::realfilename, ast_channel::sched, ast_channel::stream, ast_channel::streamid, ast_filestream::trans, ast_filestream::vfs, ast_channel::vstream, and ast_channel::vstreamid.

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(), record_exec(), recordthread(), and rpt().

00808 {
00809    char *cmd = NULL;
00810    size_t size = 0;
00811    /* Stop a running stream if there is one */
00812    if (f->owner) {
00813       if (f->fmt->format < AST_FORMAT_MAX_AUDIO) {
00814          f->owner->stream = NULL;
00815          AST_SCHED_DEL(f->owner->sched, f->owner->streamid);
00816 #ifdef HAVE_ZAPTEL
00817          ast_settimeout(f->owner, 0, NULL, NULL);
00818 #endif         
00819       } else {
00820          f->owner->vstream = NULL;
00821          AST_SCHED_DEL(f->owner->sched, f->owner->vstreamid);
00822       }
00823    }
00824    /* destroy the translator on exit */
00825    if (f->trans)
00826       ast_translator_free_path(f->trans);
00827 
00828    if (f->realfilename && f->filename) {
00829          size = strlen(f->filename) + strlen(f->realfilename) + 15;
00830          cmd = alloca(size);
00831          memset(cmd,0,size);
00832          snprintf(cmd,size,"/bin/mv -f %s %s",f->filename,f->realfilename);
00833          ast_safe_system(cmd);
00834    }
00835 
00836    if (f->filename)
00837       free(f->filename);
00838    if (f->realfilename)
00839       free(f->realfilename);
00840    if (f->fmt->close)
00841       f->fmt->close(f);
00842    fclose(f->f);
00843    if (f->vfs)
00844       ast_closestream(f->vfs);
00845    if (f->orig_chan_name)
00846       free((void *) f->orig_chan_name);
00847    ast_module_unref(f->fmt->module);
00848    free(f);
00849    return 0;
00850 }

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

Definition at line 1339 of file file.c.

References ast_cli_register_multiple().

Referenced by main().

01340 {
01341    ast_cli_register_multiple(cli_file, sizeof(cli_file) / sizeof(struct ast_cli_entry));
01342    return 0;
01343 }

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

References ACTION_COPY, and ast_filehelper().

Referenced by copy_plain_file(), and vm_forwardoptions().

00881 {
00882    return ast_filehelper(filename, filename2, fmt, ACTION_COPY);
00883 }

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

References ACTION_DELETE, and ast_filehelper().

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

00871 {
00872    return ast_filehelper(filename, NULL, fmt, ACTION_DELETE);
00873 }

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. Returns -1 if file does not exist, non-zero positive otherwise.

Definition at line 856 of file file.c.

References ast_filestream::buf, and fileexists_core().

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

00857 {
00858    char *buf;
00859    int buflen;
00860 
00861    if (preflang == NULL)
00862       preflang = "";
00863    buflen = strlen(preflang) + strlen(filename) + 4;  /* room for everything */
00864    buf = alloca(buflen);
00865    if (buf == NULL)
00866       return 0;
00867    return fileexists_core(filename, fmt, preflang, buf, buflen);
00868 }

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

References ACTION_RENAME, and ast_filehelper().

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

00876 {
00877    return ast_filehelper(filename, filename2, fmt, ACTION_RENAME);
00878 }

int ast_format_unregister ( const char *  name  ) 

Unregisters a file format

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

Definition at line 109 of file file.c.

References AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, ast_log(), ast_verbose(), free, LOG_WARNING, ast_format::name, option_verbose, and VERBOSE_PREFIX_2.

Referenced by unload_module().

00110 {
00111    struct ast_format *tmp;
00112    int res = -1;
00113 
00114    if (AST_LIST_LOCK(&formats)) {
00115       ast_log(LOG_WARNING, "Unable to lock format list\n");
00116       return -1;
00117    }
00118    AST_LIST_TRAVERSE_SAFE_BEGIN(&formats, tmp, list) {
00119       if (!strcasecmp(name, tmp->name)) {
00120          AST_LIST_REMOVE_CURRENT(&formats, list);
00121          free(tmp);
00122          res = 0;
00123       }
00124    }
00125    AST_LIST_TRAVERSE_SAFE_END
00126    AST_LIST_UNLOCK(&formats);
00127 
00128    if (!res) {
00129       if (option_verbose > 1)
00130          ast_verbose( VERBOSE_PREFIX_2 "Unregistered format %s\n", name);
00131    } else
00132       ast_log(LOG_WARNING, "Tried to unregister format %s, already unregistered\n", name);
00133 
00134    return res;
00135 }

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 Returns a ast_filestream pointer if it opens the file, NULL on error

Definition at line 571 of file file.c.

References ast_openstream_full().

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

00572 {
00573    return ast_openstream_full(chan, filename, preflang, 0);
00574 }

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 Returns a ast_filestream pointer if it opens the file, NULL on error

Definition at line 576 of file file.c.

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

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

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

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 Returns a ast_filestream pointer if it opens the file, NULL on error

Definition at line 614 of file file.c.

References ACTION_OPEN, ast_filehelper(), AST_FORMAT_MAX_AUDIO, AST_FORMAT_MAX_VIDEO, ast_getformatname(), ast_log(), ast_filestream::buf, fileexists_core(), fmt, format, LOG_WARNING, ast_channel::nativeformats, and ast_channel::vstream.

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

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

int ast_playstream ( struct ast_filestream s  ) 

play a open stream on a channel.

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

Definition at line 770 of file file.c.

References AST_FORMAT_MAX_AUDIO, ast_readaudio_callback(), ast_readvideo_callback(), ast_filestream::fmt, ast_format::format, and FSREAD_FAILURE.

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

00771 {
00772    enum fsread_res res;
00773 
00774    if (s->fmt->format < AST_FORMAT_MAX_AUDIO)
00775       res = ast_readaudio_callback(s);
00776    else
00777       res = ast_readvideo_callback(s);
00778 
00779    return (res == FSREAD_FAILURE) ? -1 : 0;
00780 }

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. Returns a struct ast_filestream on success, NULL on failure

Definition at line 916 of file file.c.

References ast_free, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log(), 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().

00917 {
00918    FILE *bfile;
00919    struct ast_format *f;
00920    struct ast_filestream *fs = NULL;
00921    char *fn;
00922 
00923    if (AST_LIST_LOCK(&formats)) {
00924       ast_log(LOG_WARNING, "Unable to lock format list\n");
00925       return NULL;
00926    }
00927 
00928    AST_LIST_TRAVERSE(&formats, f, list) {
00929       fs = NULL;
00930       if (!exts_compare(f->exts, type))
00931          continue;
00932 
00933       fn = build_filename(filename, type);
00934       errno = 0;
00935       bfile = fopen(fn, "r");
00936       if (!bfile || (fs = get_filestream(f, bfile)) == NULL ||
00937           open_wrapper(fs) ) {
00938          ast_log(LOG_WARNING, "Unable to open %s\n", fn);
00939          if (fs)
00940             ast_free(fs);
00941          if (bfile)
00942             fclose(bfile);
00943          free(fn);
00944          continue;
00945       }
00946       /* found it */
00947       fs->trans = NULL;
00948       fs->fmt = f;
00949       fs->flags = flags;
00950       fs->mode = mode;
00951       fs->filename = strdup(filename);
00952       fs->vfs = NULL;
00953       break;
00954    }
00955 
00956    AST_LIST_UNLOCK(&formats);
00957    if (!fs) 
00958       ast_log(LOG_WARNING, "No such format '%s'\n", type);
00959 
00960    return fs;
00961 }

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 or NULL if read failed

Definition at line 647 of file file.c.

References f, ast_filestream::fmt, and ast_format::read.

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

00648 {
00649    struct ast_frame *f = NULL;
00650    int whennext = 0; 
00651    if (s && s->fmt)
00652       f = s->fmt->read(s, &whennext);
00653    return f;
00654 }

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 Returns 0 for success, or -1 for error

Definition at line 782 of file file.c.

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

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

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

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 137 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_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(), parkandannounce_exec(), pbx_builtin_background(), pl_odtworz_plik(), play_file(), play_mailbox_owner(), playback_exec(), queue_exec(), read_exec(), record_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().

00138 {
00139    ast_channel_lock(tmp);
00140 
00141    /* Stop a running stream if there is one */
00142    if (tmp->stream) {
00143       ast_closestream(tmp->stream);
00144       tmp->stream = NULL;
00145       if (tmp->oldwriteformat && ast_set_write_format(tmp, tmp->oldwriteformat))
00146          ast_log(LOG_WARNING, "Unable to restore format back to %d\n", tmp->oldwriteformat);
00147    }
00148    /* Stop the video stream too */
00149    if (tmp->vstream != NULL) {
00150       ast_closestream(tmp->vstream);
00151       tmp->vstream = NULL;
00152    }
00153 
00154    ast_channel_unlock(tmp);
00155 
00156    return 0;
00157 }

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 
)

Fast forward stream ms

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

Definition at line 797 of file file.c.

References ast_seekstream(), and DEFAULT_SAMPLES_PER_MS.

Referenced by waitstream_core().

00798 {
00799    return ast_seekstream(fs, ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
00800 }

int ast_stream_rewind ( struct ast_filestream fs,
off_t  ms 
)

Rewind stream ms

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

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

00803 {
00804    return ast_seekstream(fs, -ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
00805 }

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. Returns 0 on success, or -1 on failure.

Definition at line 885 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_retrieve_call(), 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(), auth_exec(), autoanswer_exec(), 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(), page_exec(), park_exec(), parkandannounce_exec(), pbx_builtin_background(), pl_odtworz_plik(), play_and_wait(), play_file(), play_greeting(), playback_exec(), privacy_exec(), record_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().

00886 {
00887    struct ast_filestream *fs;
00888    struct ast_filestream *vfs=NULL;
00889    char fmt[256];
00890 
00891    fs = ast_openstream(chan, filename, preflang);
00892    if (fs)
00893       vfs = ast_openvstream(chan, filename, preflang);
00894    if (vfs)
00895       ast_log(LOG_DEBUG, "Ooh, found a video stream, too, format %s\n", ast_getformatname(vfs->fmt->format));
00896    if (fs){
00897       int res;
00898       if (ast_test_flag(chan, AST_FLAG_MASQ_NOSTREAM))
00899          fs->orig_chan_name = ast_strdup(chan->name);
00900       if (ast_applystream(chan, fs))
00901          return -1;
00902       if (vfs && ast_applystream(chan, vfs))
00903          return -1;
00904       res = ast_playstream(fs);
00905       if (!res && vfs)
00906          res = ast_playstream(vfs);
00907       if (option_verbose > 2)
00908          ast_verbose(VERBOSE_PREFIX_3 "<%s> Playing '%s' (language '%s')\n", chan->name, filename, preflang ? preflang : "default");
00909 
00910       return res;
00911    }
00912    ast_log(LOG_WARNING, "Unable to open %s (format %s): %s\n", filename, ast_getformatname_multiple(fmt, sizeof(fmt), chan->nativeformats), strerror(errno));
00913    return -1;
00914 }

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

00793 {
00794    return fs->fmt->tell(fs);
00795 }

int ast_truncstream ( struct ast_filestream fs  ) 

Trunc stream at current location

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

Definition at line 787 of file file.c.

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

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

00788 {
00789    return fs->fmt->trunc(fs);
00790 }

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, Returns 0 if the stream finishes, the character if it was interrupted, and -1 on error

Definition at line 1231 of file file.c.

References waitstream_core().

Referenced by __login_exec(), action_bridge(), agent_call(), app_exec(), ast_play_and_wait(), ast_retrieve_call(), 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(), auth_exec(), autoanswer_exec(), 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(), record_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().

01232 {
01233    return waitstream_core(c, breakon, NULL, NULL, 0, -1, -1, NULL);
01234 }

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, Returns 0 if the stream finishes, the character if it was interrupted, and -1 on error

Definition at line 1242 of file file.c.

References ast_channel::context, and waitstream_core().

Referenced by pbx_builtin_background().

01243 {
01244    /* Waitstream, with return in the case of a valid 1 digit extension */
01245    /* in the current or specified context being pressed */
01246 
01247    if (!context)
01248       context = c->context;
01249    return waitstream_core(c, NULL, NULL, NULL, 0,
01250       -1, -1, context);
01251 }

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, Returns 0 if the stream finishes, the character if it was interrupted, and -1 on error

Definition at line 1225 of file file.c.

References waitstream_core().

Referenced by ast_control_streamfile().

01226 {
01227    return waitstream_core(c, breakon, forward, rewind, ms,
01228       -1 /* no audiofd */, -1 /* no cmdfd */, NULL /* no context */);
01229 }

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 
) [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. Returns a struct ast_filestream on success, NULL on failure

Definition at line 963 of file file.c.

References ast_free, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log(), ast_opt_cache_record_files, 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(), record_exec(), recordthread(), and rpt().

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

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 Returns 0 on success, -1 on failure.

Definition at line 159 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(), ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, ast_format::format, ast_frame::frametype, ast_filestream::lastwriteformat, LOG_DEBUG, LOG_WARNING, ast_filestream::mode, ast_format::name, ast_frame::subclass, 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(), record_exec(), recordthread(), and rpt().

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


Generated on Sun Jun 12 16:37:57 2011 for Asterisk - the Open Source PBX by  doxygen 1.5.6