From 669718ba3bb84f8f71f8fa9ebc54c6c7f63a9095 Mon Sep 17 00:00:00 2001 From: russell Date: Mon, 28 Jan 2008 23:16:56 +0000 Subject: Creating tag for the release of asterisk-1.6.0-beta2 git-svn-id: http://svn.digium.com/svn/asterisk/tags/1.6.0-beta2@100719 f38db490-d61c-443f-a65b-d21fe96a405b --- trunk/include/asterisk/file.h | 322 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 322 insertions(+) create mode 100644 trunk/include/asterisk/file.h (limited to 'trunk/include/asterisk/file.h') diff --git a/trunk/include/asterisk/file.h b/trunk/include/asterisk/file.h new file mode 100644 index 000000000..0f33b5340 --- /dev/null +++ b/trunk/include/asterisk/file.h @@ -0,0 +1,322 @@ +/* + * Asterisk -- An open source telephony toolkit. + * + * Copyright (C) 1999 - 2006, Digium, Inc. + * + * Mark Spencer + * + * See http://www.asterisk.org for more information about + * the Asterisk project. Please do not directly contact + * any of the maintainers of this project for assistance; + * the project provides a web site, mailing lists and IRC + * channels for your use. + * + * This program is free software, distributed under the terms of + * the GNU General Public License Version 2. See the LICENSE file + * at the top of the source tree. + */ + +/*! \file + * \brief Generic File Format Support. + * Should be included by clients of the file handling routines. + * File service providers should instead include mod_format.h + */ + +#ifndef _ASTERISK_FILE_H +#define _ASTERISK_FILE_H + +#ifdef HAVE_FCNTL_H +#include +#endif + +#ifdef HAVE_MMAP +#include +#endif + +#if defined(__cplusplus) || defined(c_plusplus) +extern "C" { +#endif + +struct ast_filestream; +struct ast_format; + +/*! Convenient for waiting */ +#define AST_DIGIT_ANY "0123456789#*ABCD" +#define AST_DIGIT_ANYNUM "0123456789" + +#define SEEK_FORCECUR 10 + +/*! + * \brief Streams a file + * \param c channel to stream the file to + * \param filename the name of the file you wish to stream, minus the extension + * \param 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. + * \retval 0 on success. + * \retval -1 on failure. + */ +int ast_streamfile(struct ast_channel *c, const char *filename, const char *preflang); + +/*! + * \brief 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. + * \return 0 if success. + * \retval -1 if error. + * \retval digit if interrupted by a digit. + */ +int ast_stream_and_wait(struct ast_channel *chan, const char *file, const char *digits); + +/*! + * \brief Stops a stream + * + * \param c The channel you wish to stop playback on + * + * Stop playback of a stream + * + * \retval 0 always + * + * \note The channel does not need to be locked before calling this function. + */ +int ast_stopstream(struct ast_channel *c); + +/*! + * \brief Checks for the existence of a given file + * \param filename name of the file you wish to check, minus the extension + * \param fmt the format you wish to check (the extension) + * \param preflang (the preferred language you wisht to find the file in) + * See if a given file exists in a given format. If fmt is NULL, any format is accepted. + * \return -1 if file does not exist, non-zero positive otherwise. + */ +int ast_fileexists(const char *filename, const char *fmt, const char *preflang); + +/*! + * \brief Renames a file + * \param oldname the name of the file you wish to act upon (minus the extension) + * \param newname the name you wish to rename the file to (minus the extension) + * \param fmt the format of the file + * Rename a given file in a given format, or if fmt is NULL, then do so for all + * \return -1 on failure + */ +int ast_filerename(const char *oldname, const char *newname, const char *fmt); + +/*! + * \brief Deletes a file + * \param filename name of the file you wish to delete (minus the extension) + * \param fmt of the file + * Delete a given file in a given format, or if fmt is NULL, then do so for all + */ +int ast_filedelete(const char *filename, const char *fmt); + +/*! + * \brief Copies a file + * \param oldname name of the file you wish to copy (minus extension) + * \param newname name you wish the file to be copied to (minus extension) + * \param fmt the format of the file + * Copy a given file in a given format, or if fmt is NULL, then do so for all + */ +int ast_filecopy(const char *oldname, const char *newname, const char *fmt); + +/*! + * \brief Waits for a stream to stop or digit to be pressed + * \param c channel to waitstream on + * \param 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, + * \retval 0 if the stream finishes + * \retval the character if it was interrupted, + * \retval -1 on error + */ +int ast_waitstream(struct ast_channel *c, const char *breakon); + +/*! + * \brief Waits for a stream to stop or digit matching a valid one digit exten to be pressed + * \param c channel to waitstream on + * \param 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, + * \retval 0 if the stream finishes. + * \retval the character if it was interrupted. + * \retval -1 on error. + */ +int ast_waitstream_exten(struct ast_channel *c, const char *context); + +/*! + * \brief Same as waitstream but allows stream to be forwarded or rewound + * \param c channel to waitstream on + * \param breakon string of DTMF digits to break upon + * \param forward DTMF digit to fast forward upon + * \param rewind DTMF digit to rewind upon + * \param 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, + * \retval 0 if the stream finishes. + * \retval the character if it was interrupted. + * \retval -1 on error. + */ +int ast_waitstream_fr(struct ast_channel *c, const char *breakon, const char *forward, const char *rewind, int ms); + +/*! + * Same as waitstream, but with audio output to fd and monitored fd checking. + * + * \return 1 if monfd is ready for reading + */ +int ast_waitstream_full(struct ast_channel *c, const char *breakon, int audiofd, int monfd); + +/*! + * \brief Starts reading from a file + * \param filename the name of the file to read from + * \param type format of file you wish to read from + * \param comment comment to go with + * \param flags file flags + * \param check (unimplemented, hence negligible) + * \param 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. + * \retval a struct ast_filestream on success. + * \retval NULL on failure. + */ +struct ast_filestream *ast_readfile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode); + +/*! + * \brief Starts writing a file + * \param filename the name of the file to write to + * \param type format of file you wish to write out to + * \param comment comment to go with + * \param flags output file flags + * \param check (unimplemented, hence negligible) + * \param 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. + * \retval a struct ast_filestream on success. + * \retval NULL on failure. + */ +struct ast_filestream *ast_writefile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode); + +/*! + * \brief Writes a frame to a stream + * \param fs filestream to write to + * \param f frame to write to the filestream + * Send a frame to a filestream -- note: does NOT free the frame, call ast_frfree manually + * \retval 0 on success. + * \retval -1 on failure. + */ +int ast_writestream(struct ast_filestream *fs, struct ast_frame *f); + +/*! + * \brief Closes a stream + * \param f filestream to close + * Close a playback or recording stream + * \retval 0 on success. + * \retval -1 on failure. + */ +int ast_closestream(struct ast_filestream *f); + +/*! + * \brief Opens stream for use in seeking, playing + * \param chan channel to work with + * \param filename to use + * \param preflang prefered language to use + * \retval a ast_filestream pointer if it opens the file. + * \retval NULL on error. + */ +struct ast_filestream *ast_openstream(struct ast_channel *chan, const char *filename, const char *preflang); + +/*! + * \brief Opens stream for use in seeking, playing + * \param chan channel to work with + * \param filename to use + * \param preflang prefered language to use + * \param asis if set, don't clear generators + * \retval a ast_filestream pointer if it opens the file. + * \retval NULL on error. + */ +struct ast_filestream *ast_openstream_full(struct ast_channel *chan, const char *filename, const char *preflang, int asis); +/*! + * \brief Opens stream for use in seeking, playing + * \param chan channel to work with + * \param filename to use + * \param preflang prefered language to use + * \retval a ast_filestream pointer if it opens the file. + * \retval NULL on error. + */ +struct ast_filestream *ast_openvstream(struct ast_channel *chan, const char *filename, const char *preflang); + +/*! + * \brief Applys a open stream to a channel. + * \param chan channel to work + * \param s ast_filestream to apply + * \retval 0 on success. + * \retval -1 on failure. + */ +int ast_applystream(struct ast_channel *chan, struct ast_filestream *s); + +/*! + * \brief Play a open stream on a channel. + * \param s filestream to play + * \retval 0 on success. + * \retval -1 on failure. + */ +int ast_playstream(struct ast_filestream *s); + +/*! + * \brief Seeks into stream + * \param fs ast_filestream to perform seek on + * \param sample_offset numbers of samples to seek + * \param whence SEEK_SET, SEEK_CUR, SEEK_END + * \retval 0 on success. + * \retval -1 on failure. + */ +int ast_seekstream(struct ast_filestream *fs, off_t sample_offset, int whence); + +/*! + * \brief Trunc stream at current location + * \param fs filestream to act on + * \retval 0 on success. + * \retval -1 on failure. + */ +int ast_truncstream(struct ast_filestream *fs); + +/*! + * \brief Fast forward stream ms + * \param fs filestream to act on + * \param ms milliseconds to move + * \retval 0 on success. + * \retval -1 on failure. + */ +int ast_stream_fastforward(struct ast_filestream *fs, off_t ms); + +/*! + * \brief Rewind stream ms + * \param fs filestream to act on + * \param ms milliseconds to move + * \retval 0 on success. + * \retval -1 on failure. + */ +int ast_stream_rewind(struct ast_filestream *fs, off_t ms); + +/*! + * \brief Tell where we are in a stream + * \param fs fs to act on + * \return a long as a sample offset into stream + */ +off_t ast_tellstream(struct ast_filestream *fs); + +/*! + * \brief Read a frame from a filestream + * \param s ast_filestream to act on + * \return a frame. + * \retval NULL if read failed. + */ +struct ast_frame *ast_readframe(struct ast_filestream *s); + +#if defined(__cplusplus) || defined(c_plusplus) +} +#endif + +#endif /* _ASTERISK_FILE_H */ -- cgit v1.2.3