mirror of https://github.com/asterisk/asterisk
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
439 lines
15 KiB
439 lines
15 KiB
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 1999 - 2006, Digium, Inc.
|
|
*
|
|
* Mark Spencer <markster@digium.com>
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
#ifndef _ASTERISK_FILE_H
|
|
#define _ASTERISK_FILE_H
|
|
|
|
#ifndef stdin
|
|
#error You must include stdio.h before file.h!
|
|
#endif /* !stdin */
|
|
|
|
#include "asterisk/channel.h"
|
|
#include "asterisk/frame.h"
|
|
#include <fcntl.h>
|
|
|
|
#if defined(__cplusplus) || defined(c_plusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
/*! Convenient for waiting */
|
|
#define AST_DIGIT_ANY "0123456789#*ABCD"
|
|
#define AST_DIGIT_ANYNUM "0123456789"
|
|
|
|
/*! structure used for lock and refcount of format handlers.
|
|
* Should not be here, but this is a temporary workaround
|
|
* until we implement a more general mechanism.
|
|
* The format handler should include a pointer to
|
|
* this structure.
|
|
* As a trick, if usecnt is initialized with -1,
|
|
* ast_format_register will init the mutex for you.
|
|
*/
|
|
struct ast_format_lock {
|
|
ast_mutex_t lock;
|
|
int usecnt; /* number of active clients */
|
|
};
|
|
|
|
/*!
|
|
* Each supported file format is described by the following fields.
|
|
* Not all are necessary, the support routine implement default
|
|
* values for some of them.
|
|
* A handler typically fills a structure initializing the desired
|
|
* fields, and then calls ast_format_register() with the (readonly)
|
|
* structure as an argument.
|
|
*/
|
|
struct ast_format {
|
|
char name[80]; /*!< Name of format */
|
|
char exts[80]; /*!< Extensions (separated by | if more than one)
|
|
this format can read. First is assumed for writing (e.g. .mp3) */
|
|
int format; /*!< Format of frames it uses/provides (one only) */
|
|
/*!
|
|
* \brief Prepare an input stream for playback.
|
|
* \return 0 on success, -1 on error.
|
|
* The FILE is already open (in s->f) so this function only needs to perform
|
|
* any applicable validity checks on the file. If none is required, the
|
|
* function can be omitted.
|
|
*/
|
|
int (*open)(struct ast_filestream *s);
|
|
/*!
|
|
* \brief Prepare a stream for output, and comment it appropriately if applicable.
|
|
* \return 0 on success, -1 on error.
|
|
* Same as the open, the FILE is already open so the function just needs to
|
|
* prepare any header and other fields, if any.
|
|
* The function can be omitted if nothing is needed.
|
|
*/
|
|
int (*rewrite)(struct ast_filestream *s, const char *comment);
|
|
/*! Write a frame to a channel */
|
|
int (*write)(struct ast_filestream *, struct ast_frame *);
|
|
/*! seek num samples into file, whence - like a normal seek but with offset in samples */
|
|
int (*seek)(struct ast_filestream *, off_t, int);
|
|
int (*trunc)(struct ast_filestream *fs); /*!< trunc file to current position */
|
|
off_t (*tell)(struct ast_filestream *fs); /*!< tell current position */
|
|
/*! Read the next frame from the filestream (if available) and report
|
|
* when to get next frame (in samples)
|
|
*/
|
|
struct ast_frame * (*read)(struct ast_filestream *, int *whennext);
|
|
/*! Do any closing actions, if any. The descriptor and structure are closed
|
|
* and destroyed by the generic routines, so they must not be done here. */
|
|
void (*close)(struct ast_filestream *);
|
|
char * (*getcomment)(struct ast_filestream *); /*!< Retrieve file comment */
|
|
|
|
AST_LIST_ENTRY(ast_format) list; /*!< Link */
|
|
|
|
/*!
|
|
* If the handler needs a buffer (for read, typically)
|
|
* and/or a private descriptor, put here the
|
|
* required size (in bytes) and the support routine will allocate them
|
|
* for you, pointed by s->buf and s->private, respectively.
|
|
* When allocating a buffer, remember to leave AST_FRIENDLY_OFFSET
|
|
* spare bytes at the bginning.
|
|
*/
|
|
int buf_size; /*!< size of frame buffer, if any, aligned to 8 bytes. */
|
|
int desc_size; /*!< size of private descriptor, if any */
|
|
|
|
struct ast_module *module;
|
|
};
|
|
|
|
/*!
|
|
* This structure is allocated by file.c in one chunk,
|
|
* together with buf_size and desc_size bytes of memory
|
|
* to be used for private purposes (e.g. buffers etc.)
|
|
*/
|
|
struct ast_filestream {
|
|
/*! Everybody reserves a block of AST_RESERVED_POINTERS pointers for us */
|
|
struct ast_format *fmt; /* need to write to the lock and usecnt */
|
|
int flags;
|
|
mode_t mode;
|
|
char *filename;
|
|
char *realfilename;
|
|
/*! Video file stream */
|
|
struct ast_filestream *vfs;
|
|
/*! Transparently translate from another format -- just once */
|
|
struct ast_trans_pvt *trans;
|
|
struct ast_tranlator_pvt *tr;
|
|
int lastwriteformat;
|
|
int lasttimeout;
|
|
struct ast_channel *owner;
|
|
const char *orig_chan_name;
|
|
FILE *f;
|
|
struct ast_frame fr; /*!< frame produced by read, typically */
|
|
char *buf; /*!< buffer pointed to by ast_frame; */
|
|
void *private; /*!< pointer to private buffer */
|
|
};
|
|
|
|
#define SEEK_FORCECUR 10
|
|
|
|
/*!
|
|
* \brief Register a new file format capability.
|
|
* Adds a format to Asterisk's format abilities.
|
|
* \retval 0 on success
|
|
* \retval -1 on failure
|
|
*/
|
|
int __ast_format_register(const struct ast_format *f, struct ast_module *mod);
|
|
#define ast_format_register(f) __ast_format_register(f, ast_module_info->self)
|
|
|
|
/*!
|
|
* \brief Unregisters a file format
|
|
* \param name the name of the format you wish to unregister
|
|
* Unregisters a format based on the name of the format.
|
|
* \retval 0 on success
|
|
* \retval -1 on failure to unregister
|
|
*/
|
|
int ast_format_unregister(const char *name);
|
|
|
|
/*!
|
|
* \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
|
|
* \return 0 regardless
|
|
*/
|
|
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. Returns
|
|
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);
|
|
|
|
/*!
|
|
* \brief Initialize file stuff
|
|
* Initializes all the various file stuff. Basically just registers the cli stuff
|
|
* \return 0 all the time
|
|
*/
|
|
int ast_file_init(void);
|
|
|
|
|
|
#define AST_RESERVED_POINTERS 20
|
|
|
|
#if defined(__cplusplus) || defined(c_plusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* _ASTERISK_FILE_H */
|