Wed Oct 28 11:46:09 2009

Asterisk developer's documentation


file.h File Reference

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

Go to the source code of this file.

Defines

#define AST_DIGIT_ANY   "0123456789#*ABCD"
#define AST_DIGIT_ANYNUM   "0123456789"
#define SEEK_FORCECUR   10

Functions

int ast_applystream (struct ast_channel *chan, struct ast_filestream *s)
 Applys a open stream to a channel.
int ast_closestream (struct ast_filestream *f)
 Closes a stream.
int ast_filecopy (const char *oldname, const char *newname, const char *fmt)
 Copies a file.
int ast_filedelete (const char *filename, const char *fmt)
 Deletes a file.
int ast_fileexists (const char *filename, const char *fmt, const char *preflang)
 Checks for the existence of a given file.
int ast_filerename (const char *oldname, const char *newname, const char *fmt)
 Renames a file.
struct ast_filestreamast_openstream (struct ast_channel *chan, const char *filename, const char *preflang)
 Opens stream for use in seeking, playing.
struct ast_filestreamast_openstream_full (struct ast_channel *chan, const char *filename, const char *preflang, int asis)
 Opens stream for use in seeking, playing.
struct ast_filestreamast_openvstream (struct ast_channel *chan, const char *filename, const char *preflang)
 Opens stream for use in seeking, playing.
int ast_playstream (struct ast_filestream *s)
 Play a open stream on a channel.
struct ast_filestreamast_readfile (const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode)
 Starts reading from a file.
struct ast_frameast_readframe (struct ast_filestream *s)
 Read a frame from a filestream.
int ast_seekstream (struct ast_filestream *fs, off_t sample_offset, int whence)
 Seeks into stream.
int ast_stopstream (struct ast_channel *c)
 Stops a stream.
int ast_stream_and_wait (struct ast_channel *chan, const char *file, const char *digits)
 stream file until digit If the file name is non-empty, try to play it.
int ast_stream_fastforward (struct ast_filestream *fs, off_t ms)
 Fast forward stream ms.
int ast_stream_rewind (struct ast_filestream *fs, off_t ms)
 Rewind stream ms.
int ast_streamfile (struct ast_channel *c, const char *filename, const char *preflang)
 Streams a file.
off_t ast_tellstream (struct ast_filestream *fs)
 Tell where we are in a stream.
int ast_truncstream (struct ast_filestream *fs)
 Trunc stream at current location.
int ast_waitstream (struct ast_channel *c, const char *breakon)
 Waits for a stream to stop or digit to be pressed.
int ast_waitstream_exten (struct ast_channel *c, const char *context)
 Waits for a stream to stop or digit matching a valid one digit exten to be pressed.
int ast_waitstream_fr (struct ast_channel *c, const char *breakon, const char *forward, const char *rewind, int ms)
 Same as waitstream but allows stream to be forwarded or rewound.
int ast_waitstream_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)
 Starts writing a file.
int ast_writestream (struct ast_filestream *fs, struct ast_frame *f)
 Writes a frame to a stream.


Detailed Description

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

Definition in file file.h.


Define Documentation

#define AST_DIGIT_ANY   "0123456789#*ABCD"

#define AST_DIGIT_ANYNUM   "0123456789"

Definition at line 45 of file file.h.

Referenced by initreqprep().

#define SEEK_FORCECUR   10


Function Documentation

int ast_applystream ( struct ast_channel chan,
struct ast_filestream s 
)

Applys a open stream to a channel.

Parameters:
chan channel to work
s ast_filestream to apply
Return values:
0 on success.
-1 on failure.

Definition at line 844 of file file.c.

References ast_filestream::owner.

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

00845 {
00846    s->owner = chan;
00847    return 0;
00848 }

int ast_closestream ( struct ast_filestream f  ) 

Closes a stream.

Parameters:
f filestream to close Close a playback or recording stream
Return values:
0 on success.
-1 on failure.

Definition at line 887 of file file.c.

References ao2_ref(), AST_FORMAT_AUDIO_MASK, AST_SCHED_DEL, ast_settimeout(), ast_filestream::fmt, ast_format::format, ast_filestream::owner, ast_channel::sched, ast_channel::stream, ast_channel::streamid, ast_channel::vstream, and ast_channel::vstreamid.

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

00888 {
00889    /* This used to destroy the filestream, but it now just decrements a refcount.
00890     * We need to force the stream to quit queuing frames now, because we might
00891     * change the writeformat, which could result in a subsequent write error, if
00892     * the format is different. */
00893 
00894    /* Stop a running stream if there is one */
00895    if (f->owner) {
00896       if (f->fmt->format < AST_FORMAT_AUDIO_MASK) {
00897          f->owner->stream = NULL;
00898          AST_SCHED_DEL(f->owner->sched, f->owner->streamid);
00899          ast_settimeout(f->owner, 0, NULL, NULL);
00900       } else {
00901          f->owner->vstream = NULL;
00902          AST_SCHED_DEL(f->owner->sched, f->owner->vstreamid);
00903       }
00904    }
00905 
00906    ao2_ref(f, -1);
00907    return 0;
00908 }

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

References ACTION_COPY, and ast_filehelper().

Referenced by copy_plain_file(), and vm_forwardoptions().

00939 {
00940    return ast_filehelper(filename, filename2, fmt, ACTION_COPY);
00941 }

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

References ACTION_DELETE, and ast_filehelper().

Referenced by __ast_play_and_record(), announce_thread(), ast_monitor_start(), ast_monitor_stop(), conf_free(), conf_run(), handle_cli_file_convert(), leave_voicemail(), play_mailbox_owner(), play_record_review(), record_exec(), setup_privacy_args(), vm_delete(), and vm_forwardoptions().

00929 {
00930    return ast_filehelper(filename, NULL, fmt, ACTION_DELETE);
00931 }

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

References buf, and fileexists_core().

Referenced by announce_thread(), app_exec(), ast_moh_files_next(), ast_monitor_start(), ast_monitor_stop(), common_exec(), eivr_comm(), forward_message(), invent_message(), leave_voicemail(), minivm_delete_exec(), play_greeting(), play_mailbox_owner(), play_message_callerid(), record_exec(), retrydial_exec(), say_character_str_full(), say_digit_str_full(), say_phonetic_str_full(), setup_privacy_args(), vm_intro(), vm_newuser(), vm_options(), and vm_tempgreeting().

00915 {
00916    char *buf;
00917    int buflen;
00918 
00919    if (preflang == NULL)
00920       preflang = "";
00921    buflen = strlen(preflang) + strlen(filename) + 4;  /* room for everything */
00922    buf = alloca(buflen);
00923    if (buf == NULL)
00924       return 0;
00925    return fileexists_core(filename, fmt, preflang, buf, buflen);
00926 }

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

00934 {
00935    return ast_filehelper(filename, filename2, fmt, ACTION_RENAME);
00936 }

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

Opens stream for use in seeking, playing.

Parameters:
chan channel to work with
filename to use
preflang prefered language to use
Return values:
a ast_filestream pointer if it opens the file.
NULL on error.

Definition at line 613 of file file.c.

References ast_openstream_full().

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

00614 {
00615    return ast_openstream_full(chan, filename, preflang, 0);
00616 }

struct ast_filestream* ast_openstream_full ( struct ast_channel chan,
const char *  filename,
const char *  preflang,
int  asis 
) [read]

Opens stream for use in seeking, playing.

Parameters:
chan channel to work with
filename to use
preflang prefered language to use
asis if set, don't clear generators
Return values:
a ast_filestream pointer if it opens the file.
NULL on error.

Definition at line 618 of file file.c.

References ACTION_OPEN, ast_deactivate_generator(), ast_filehelper(), AST_FORMAT_AUDIO_MASK, ast_log(), ast_set_write_format(), ast_stopstream(), 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().

00619 {
00620    /* 
00621     * Use fileexists_core() to find a file in a compatible
00622     * language and format, set up a suitable translator,
00623     * and open the stream.
00624     */
00625    int fmts, res, buflen;
00626    char *buf;
00627 
00628    if (!asis) {
00629       /* do this first, otherwise we detect the wrong writeformat */
00630       ast_stopstream(chan);
00631       if (chan->generator)
00632          ast_deactivate_generator(chan);
00633    }
00634    if (preflang == NULL)
00635       preflang = "";
00636    buflen = strlen(preflang) + strlen(filename) + 4;
00637    buf = alloca(buflen);
00638    if (buf == NULL)
00639       return NULL;
00640    fmts = fileexists_core(filename, NULL, preflang, buf, buflen);
00641    if (fmts > 0)
00642       fmts &= AST_FORMAT_AUDIO_MASK;
00643    if (fmts < 1) {
00644       ast_log(LOG_WARNING, "File %s does not exist in any format\n", filename);
00645       return NULL;
00646    }
00647    chan->oldwriteformat = chan->writeformat;
00648    /* Set the channel to a format we can work with */
00649    res = ast_set_write_format(chan, fmts);
00650    res = ast_filehelper(buf, chan, NULL, ACTION_OPEN);
00651    if (res >= 0)
00652       return chan->stream;
00653    return NULL;
00654 }

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

Opens stream for use in seeking, playing.

Parameters:
chan channel to work with
filename to use
preflang prefered language to use
Return values:
a ast_filestream pointer if it opens the file.
NULL on error.

Definition at line 656 of file file.c.

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

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

00657 {
00658    /* As above, but for video. But here we don't have translators
00659     * so we must enforce a format.
00660     */
00661    unsigned int format;
00662    char *buf;
00663    int buflen;
00664 
00665    if (preflang == NULL)
00666       preflang = "";
00667    buflen = strlen(preflang) + strlen(filename) + 4;
00668    buf = alloca(buflen);
00669    if (buf == NULL)
00670       return NULL;
00671 
00672    for (format = AST_FORMAT_AUDIO_MASK + 1; format <= AST_FORMAT_VIDEO_MASK; format = format << 1) {
00673       int fd;
00674       const char *fmt;
00675 
00676       if (!(chan->nativeformats & format))
00677          continue;
00678       fmt = ast_getformatname(format);
00679       if ( fileexists_core(filename, fmt, preflang, buf, buflen) < 1)   /* no valid format */
00680          continue;
00681       fd = ast_filehelper(buf, chan, fmt, ACTION_OPEN);
00682       if (fd >= 0)
00683          return chan->vstream;
00684       ast_log(LOG_WARNING, "File %s has video but couldn't be opened\n", filename);
00685    }
00686    return NULL;
00687 }

int ast_playstream ( struct ast_filestream s  ) 

Play a open stream on a channel.

Parameters:
s filestream to play
Return values:
0 on success.
-1 on failure.

Definition at line 850 of file file.c.

References AST_FORMAT_AUDIO_MASK, 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().

00851 {
00852    enum fsread_res res;
00853 
00854    if (s->fmt->format & AST_FORMAT_AUDIO_MASK)
00855       res = ast_readaudio_callback(s);
00856    else
00857       res = ast_readvideo_callback(s);
00858 
00859    return (res == FSREAD_FAILURE) ? -1 : 0;
00860 }

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

Starts reading from a file.

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

Definition at line 974 of file file.c.

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

Referenced by __ast_play_and_record(), and handle_cli_file_convert().

00975 {
00976    FILE *bfile;
00977    struct ast_format *f;
00978    struct ast_filestream *fs = NULL;
00979    char *fn;
00980    int format_found = 0;   
00981 
00982    AST_RWLIST_RDLOCK(&formats);
00983 
00984    AST_RWLIST_TRAVERSE(&formats, f, list) {
00985       fs = NULL;
00986       if (!exts_compare(f->exts, type))
00987          continue;
00988       else 
00989          format_found = 1;
00990 
00991       fn = build_filename(filename, type);
00992       errno = 0;
00993       bfile = fopen(fn, "r");
00994 
00995       if (!bfile || (fs = get_filestream(f, bfile)) == NULL || open_wrapper(fs) ) {
00996          ast_log(LOG_WARNING, "Unable to open %s\n", fn);
00997          if (fs) {
00998             ast_closestream(fs);
00999          }
01000          fs = NULL;
01001          bfile = NULL;
01002          ast_free(fn);
01003          break;            
01004       }
01005       /* found it */
01006       fs->trans = NULL;
01007       fs->fmt = f;
01008       fs->flags = flags;
01009       fs->mode = mode;
01010       fs->filename = ast_strdup(filename);
01011       fs->vfs = NULL;
01012       break;
01013    }
01014 
01015    AST_RWLIST_UNLOCK(&formats);
01016    if (!format_found)
01017       ast_log(LOG_WARNING, "No such format '%s'\n", type);
01018 
01019    return fs;
01020 }

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

Read a frame from a filestream.

Parameters:
s ast_filestream to act on
Returns:
a frame.
Return values:
NULL if read failed.

Definition at line 714 of file file.c.

References read_frame().

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

00715 {
00716    int whennext = 0;
00717 
00718    return read_frame(s, &whennext);
00719 }

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

Seeks into stream.

Parameters:
fs ast_filestream to perform seek on
sample_offset numbers of samples to seek
whence SEEK_SET, SEEK_CUR, SEEK_END
Return values:
0 on success.
-1 on failure.

Definition at line 862 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(), handle_streamfile(), and speech_streamfile().

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

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 121 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_enumeration_full_he(), ast_say_number_full_cs(), 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_gr(), ast_say_number_full_he(), ast_say_number_full_hu(), ast_say_number_full_it(), ast_say_number_full_ka(), 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_th(), ast_say_number_full_zh(), background_detect_exec(), builtin_blindtransfer(), conf_exec(), conf_run(), directory_exec(), handle_getoption(), handle_speechrecognize(), handle_streamfile(), ices_exec(), ivr_dispatch(), leave_voicemail(), minivm_greet_exec(), mp3_exec(), NBScat_exec(), parkandannounce_exec(), pbx_builtin_background(), pl_odtworz_plik(), play_file(), play_mailbox_owner(), playback_exec(), queue_exec(), read_exec(), readexten_exec(), record_exec(), recordthread(), rpt_tele_thread(), s_streamwait3(), say_character_str_full(), say_digit_str_full(), say_phonetic_str_full(), saycharstr(), saydigits(), sayfile(), saynum(), select_item_seq(), send_morse(), send_tone_telemetry(), send_waveform_to_channel(), speech_background(), vm_authenticate(), vm_execmain(), wait_for_winner(), waitstream_core(), and zapateller_exec().

00122 {
00123    ast_channel_lock(tmp);
00124 
00125    /* Stop a running stream if there is one */
00126    if (tmp->stream) {
00127       ast_closestream(tmp->stream);
00128       tmp->stream = NULL;
00129       if (tmp->oldwriteformat && ast_set_write_format(tmp, tmp->oldwriteformat))
00130          ast_log(LOG_WARNING, "Unable to restore format back to %d\n", tmp->oldwriteformat);
00131    }
00132    /* Stop the video stream too */
00133    if (tmp->vstream != NULL) {
00134       ast_closestream(tmp->vstream);
00135       tmp->vstream = NULL;
00136    }
00137 
00138    ast_channel_unlock(tmp);
00139 
00140    return 0;
00141 }

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

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

Note:
If digits == "" then we can simply check for non-zero.
Returns:
0 if success.
Return values:
-1 if error.
digit if interrupted by a digit.

Definition at line 1326 of file file.c.

References ast_streamfile(), ast_strlen_zero(), ast_waitstream(), and ast_channel::language.

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

01327 {
01328    int res = 0;
01329    if (!ast_strlen_zero(file)) {
01330       res = ast_streamfile(chan, file, chan->language);
01331       if (!res) {
01332          res = ast_waitstream(chan, digits);
01333       }
01334    }
01335    return res;
01336 } 

int ast_stream_fastforward ( struct ast_filestream fs,
off_t  ms 
)

Fast forward stream ms.

Parameters:
fs filestream to act on
ms milliseconds to move
Return values:
0 on success.
-1 on failure.

Definition at line 877 of file file.c.

References ast_seekstream(), and DEFAULT_SAMPLES_PER_MS.

Referenced by waitstream_core().

00878 {
00879    return ast_seekstream(fs, ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
00880 }

int ast_stream_rewind ( struct ast_filestream fs,
off_t  ms 
)

Rewind stream ms.

Parameters:
fs filestream to act on
ms milliseconds to move
Return values:
0 on success.
-1 on failure.

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

00883 {
00884    return ast_seekstream(fs, -ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
00885 }

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

Streams a file.

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

Definition at line 943 of file file.c.

References ast_applystream(), ast_debug, AST_FLAG_MASQ_NOSTREAM, ast_getformatname(), ast_getformatname_multiple(), ast_log(), ast_openstream(), ast_openvstream(), ast_playstream(), ast_strdup, ast_test_flag, ast_verb, errno, ast_filestream::fmt, ast_format::format, LOG_WARNING, ast_channel::name, ast_channel::nativeformats, ast_filestream::orig_chan_name, ast_filestream::vfs, and ast_channel::writeformat.

Referenced by action_bridge(), agent_call(), announce_thread(), 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_gr(), ast_say_date_he(), ast_say_date_hu(), ast_say_date_ka(), ast_say_date_nl(), ast_say_date_th(), 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_he(), ast_say_datetime_from_now_ka(), ast_say_datetime_gr(), ast_say_datetime_he(), ast_say_datetime_nl(), ast_say_datetime_pt(), ast_say_datetime_th(), ast_say_datetime_zh(), ast_say_enumeration_full_da(), ast_say_enumeration_full_de(), ast_say_enumeration_full_en(), ast_say_enumeration_full_he(), ast_say_number_full_cs(), 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_gr(), ast_say_number_full_he(), ast_say_number_full_hu(), ast_say_number_full_it(), ast_say_number_full_ka(), 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_th(), ast_say_number_full_zh(), ast_say_time_de(), ast_say_time_en(), ast_say_time_fr(), ast_say_time_gr(), ast_say_time_hu(), ast_say_time_ka(), ast_say_time_nl(), ast_say_time_zh(), ast_stream_and_wait(), auth_exec(), background_detect_exec(), bridge_exec(), check_availability(), check_beep(), common_exec(), conf_exec(), conf_run(), dial_exec_full(), do_directory(), find_conf_realtime(), forward_message(), gr_say_number_female(), handle_recordfile(), invent_message(), leave_voicemail(), login_exec(), minivm_greet_exec(), page_exec(), park_exec(), parkandannounce_exec(), pbx_builtin_background(), pl_odtworz_plik(), play_and_wait(), play_file(), play_greeting(), play_record_review(), playback_exec(), privacy_exec(), readexten_exec(), record_exec(), retrydial_exec(), rpt_tele_thread(), s_streamwait3(), say_character_str_full(), say_digit_str_full(), say_phonetic_str_full(), sayfile(), select_item_menu(), setup_privacy_args(), ss_thread(), vm_authenticate(), wait_file(), and wait_for_winner().

00944 {
00945    struct ast_filestream *fs;
00946    struct ast_filestream *vfs=NULL;
00947    char fmt[256];
00948 
00949    fs = ast_openstream(chan, filename, preflang);
00950    if (fs)
00951       vfs = ast_openvstream(chan, filename, preflang);
00952    if (vfs) {
00953       ast_debug(1, "Ooh, found a video stream, too, format %s\n", ast_getformatname(vfs->fmt->format));
00954    }
00955    if (fs){
00956       int res;
00957       if (ast_test_flag(chan, AST_FLAG_MASQ_NOSTREAM))
00958          fs->orig_chan_name = ast_strdup(chan->name);
00959       if (ast_applystream(chan, fs))
00960          return -1;
00961       if (vfs && ast_applystream(chan, vfs))
00962          return -1;
00963       res = ast_playstream(fs);
00964       if (!res && vfs)
00965          res = ast_playstream(vfs);
00966       ast_verb(3, "<%s> Playing '%s.%s' (language '%s')\n", chan->name, filename, ast_getformatname(chan->writeformat), preflang ? preflang : "default");
00967 
00968       return res;
00969    }
00970    ast_log(LOG_WARNING, "Unable to open %s (format %s): %s\n", filename, ast_getformatname_multiple(fmt, sizeof(fmt), chan->nativeformats), strerror(errno));
00971    return -1;
00972 }

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 872 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(), handle_speechrecognize(), and handle_streamfile().

00873 {
00874    return fs->fmt->tell(fs);
00875 }

int ast_truncstream ( struct ast_filestream fs  ) 

Trunc stream at current location.

Parameters:
fs filestream to act on
Return values:
0 on success.
-1 on failure.

Definition at line 867 of file file.c.

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

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

00868 {
00869    return fs->fmt->trunc(fs);
00870 }

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

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

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

Definition at line 1299 of file file.c.

References waitstream_core().

Referenced by action_bridge(), agent_call(), announce_thread(), app_exec(), ast_play_and_wait(), ast_say_date_da(), ast_say_date_de(), ast_say_date_en(), ast_say_date_fr(), ast_say_date_gr(), ast_say_date_he(), ast_say_date_hu(), ast_say_date_ka(), ast_say_date_nl(), ast_say_date_th(), 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_he(), ast_say_datetime_from_now_ka(), ast_say_datetime_gr(), ast_say_datetime_he(), ast_say_datetime_nl(), ast_say_datetime_pt(), ast_say_datetime_th(), ast_say_datetime_zh(), ast_say_enumeration_full_da(), ast_say_enumeration_full_de(), ast_say_enumeration_full_en(), ast_say_enumeration_full_he(), ast_say_number_full_cs(), 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_gr(), ast_say_number_full_he(), ast_say_number_full_hu(), ast_say_number_full_it(), ast_say_number_full_ka(), 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_th(), ast_say_number_full_zh(), ast_say_time_de(), ast_say_time_en(), ast_say_time_gr(), ast_say_time_he(), ast_say_time_hu(), ast_say_time_ka(), ast_say_time_nl(), ast_say_time_zh(), ast_stream_and_wait(), auth_exec(), bridge_exec(), check_availability(), check_beep(), common_exec(), conf_exec(), conf_run(), dial_exec_full(), directory_exec(), find_conf_realtime(), gr_say_number_female(), handle_recordfile(), invent_message(), leave_voicemail(), login_exec(), minivm_greet_exec(), page_exec(), park_exec(), parkandannounce_exec(), pbx_builtin_background(), pl_odtworz_plik(), play_and_wait(), play_file(), play_greeting(), play_record_review(), 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(), saydigits(), sayfile(), saynum(), select_item_menu(), send_morse(), send_tone_telemetry(), setup_privacy_args(), ss_thread(), vm_authenticate(), and wait_file().

01300 {
01301    return waitstream_core(c, breakon, NULL, NULL, 0, -1, -1, NULL);
01302 }

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

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

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

Definition at line 1310 of file file.c.

References ast_channel::context, and waitstream_core().

Referenced by pbx_builtin_background().

01311 {
01312    /* Waitstream, with return in the case of a valid 1 digit extension */
01313    /* in the current or specified context being pressed */
01314 
01315    if (!context)
01316       context = c->context;
01317    return waitstream_core(c, NULL, NULL, NULL, 0,
01318       -1, -1, context);
01319 }

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

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

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

Definition at line 1293 of file file.c.

References waitstream_core().

Referenced by ast_control_streamfile().

01294 {
01295    return waitstream_core(c, breakon, forward, rewind, ms,
01296       -1 /* no audiofd */, -1 /* no cmdfd */, NULL /* no context */);
01297 }

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.
Return values:
a struct ast_filestream on success.
NULL on failure.

Definition at line 1022 of file file.c.

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

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

01023 {
01024    int fd, myflags = 0;
01025    /* compiler claims this variable can be used before initialization... */
01026    FILE *bfile = NULL;
01027    struct ast_format *f;
01028    struct ast_filestream *fs = NULL;
01029    char *buf = NULL;
01030    size_t size = 0;
01031    int format_found = 0;
01032 
01033    AST_RWLIST_RDLOCK(&formats);
01034 
01035    /* set the O_TRUNC flag if and only if there is no O_APPEND specified */
01036    /* We really can't use O_APPEND as it will break WAV header updates */
01037    if (flags & O_APPEND) { 
01038       flags &= ~O_APPEND;
01039    } else {
01040       myflags = O_TRUNC;
01041    }
01042    
01043    myflags |= O_WRONLY | O_CREAT;
01044 
01045    /* XXX need to fix this - we should just do the fopen,
01046     * not open followed by fdopen()
01047     */
01048    AST_RWLIST_TRAVERSE(&formats, f, list) {
01049       char *fn, *orig_fn = NULL;
01050       if (fs)
01051          break;
01052 
01053       if (!exts_compare(f->exts, type))
01054          continue;
01055       else
01056          format_found = 1;
01057 
01058       fn = build_filename(filename, type);
01059       fd = open(fn, flags | myflags, mode);
01060       if (fd > -1) {
01061          /* fdopen() the resulting file stream */
01062          bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
01063          if (!bfile) {
01064             ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
01065             close(fd);
01066             fd = -1;
01067          }
01068       }
01069       
01070       if (ast_opt_cache_record_files && (fd > -1)) {
01071          char *c;
01072 
01073          fclose(bfile); /* this also closes fd */
01074          /*
01075            We touch orig_fn just as a place-holder so other things (like vmail) see the file is there.
01076            What we are really doing is writing to record_cache_dir until we are done then we will mv the file into place.
01077          */
01078          orig_fn = ast_strdupa(fn);
01079          for (c = fn; *c; c++)
01080             if (*c == '/')
01081                *c = '_';
01082 
01083          size = strlen(fn) + strlen(record_cache_dir) + 2;
01084          buf = alloca(size);
01085          strcpy(buf, record_cache_dir);
01086          strcat(buf, "/");
01087          strcat(buf, fn);
01088          ast_free(fn);
01089          fn = buf;
01090          fd = open(fn, flags | myflags, mode);
01091          if (fd > -1) {
01092             /* fdopen() the resulting file stream */
01093             bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
01094             if (!bfile) {
01095                ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
01096                close(fd);
01097                fd = -1;
01098             }
01099          }
01100       }
01101       if (fd > -1) {
01102          errno = 0;
01103          fs = get_filestream(f, bfile);
01104          if (!fs || rewrite_wrapper(fs, comment)) {
01105             ast_log(LOG_WARNING, "Unable to rewrite %s\n", fn);
01106             close(fd);
01107             if (orig_fn) {
01108                unlink(fn);
01109                unlink(orig_fn);
01110             }
01111             if (fs) {
01112                ast_closestream(fs);
01113                fs = NULL;
01114             }
01115             continue;
01116          }
01117          fs->trans = NULL;
01118          fs->fmt = f;
01119          fs->flags = flags;
01120          fs->mode = mode;
01121          if (orig_fn) {
01122             fs->realfilename = ast_strdup(orig_fn);
01123             fs->filename = ast_strdup(fn);
01124          } else {
01125             fs->realfilename = NULL;
01126             fs->filename = ast_strdup(filename);
01127          }
01128          fs->vfs = NULL;
01129          /* If truncated, we'll be at the beginning; if not truncated, then append */
01130          f->seek(fs, 0, SEEK_END);
01131       } else if (errno != EEXIST) {
01132          ast_log(LOG_WARNING, "Unable to open file %s: %s\n", fn, strerror(errno));
01133          if (orig_fn)
01134             unlink(orig_fn);
01135       }
01136       /* if buf != NULL then fn is already free and pointing to it */
01137       if (!buf)
01138          ast_free(fn);
01139    }
01140 
01141    AST_RWLIST_UNLOCK(&formats);
01142 
01143    if (!format_found)
01144       ast_log(LOG_WARNING, "No such format '%s'\n", type);
01145 
01146    return fs;
01147 }

int ast_writestream ( struct ast_filestream fs,
struct ast_frame f 
)

Writes a frame to a stream.

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

Definition at line 143 of file file.c.

References ast_debug, AST_FORMAT_AUDIO_MASK, AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_frfree, ast_getformatname(), AST_LIST_NEXT, ast_log(), ast_translate(), ast_translator_build_path(), ast_translator_free_path(), ast_writefile(), ast_writestream(), ast_filestream::filename, ast_filestream::flags, ast_filestream::fmt, ast_format::format, ast_frame::frame_list, ast_frame::frametype, ast_filestream::lastwriteformat, 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(), dictate_exec(), handle_cli_file_convert(), handle_recordfile(), mixmonitor_thread(), record_exec(), and recordthread().

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


Generated on Wed Oct 28 11:46:09 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6