Merged revisions 90142 via svnmerge from
[asterisk/asterisk.git] / include / asterisk / file.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Generic File Format Support.
21  * Should be included by clients of the file handling routines.
22  * File service providers should instead include mod_format.h
23  */
24
25 #ifndef _ASTERISK_FILE_H
26 #define _ASTERISK_FILE_H
27
28 #ifdef HAVE_FCNTL_H
29 #include <fcntl.h>
30 #endif
31
32 #if defined(__cplusplus) || defined(c_plusplus)
33 extern "C" {
34 #endif
35
36 struct ast_filestream;
37 struct ast_format;
38
39 /*! Convenient for waiting */
40 #define AST_DIGIT_ANY "0123456789#*ABCD"
41 #define AST_DIGIT_ANYNUM "0123456789"
42
43 #define SEEK_FORCECUR   10
44         
45 /*! 
46  * \brief Streams a file 
47  * \param c channel to stream the file to
48  * \param filename the name of the file you wish to stream, minus the extension
49  * \param preflang the preferred language you wish to have the file streamed to you in
50  * Prepares a channel for the streaming of a file.  To start the stream, afterward do a ast_waitstream() on the channel
51  * Also, it will stop any existing streams on the channel.
52  * \retval 0 on success.
53  * \retval -1 on failure.
54  */
55 int ast_streamfile(struct ast_channel *c, const char *filename, const char *preflang);
56
57 /*!
58  * \brief stream file until digit
59  * If the file name is non-empty, try to play it.
60  * \note If digits == "" then we can simply check for non-zero.
61  * \return 0 if success.
62  * \retval -1 if error.
63  * \retval digit if interrupted by a digit.
64  */
65 int ast_stream_and_wait(struct ast_channel *chan, const char *file, const char *digits);
66
67 /*! 
68  * \brief Stops a stream 
69  *
70  * \param c The channel you wish to stop playback on
71  *
72  * Stop playback of a stream 
73  *
74  * \retval 0 always
75  *
76  * \note The channel does not need to be locked before calling this function.
77  */
78 int ast_stopstream(struct ast_channel *c);
79
80 /*! 
81  * \brief Checks for the existence of a given file 
82  * \param filename name of the file you wish to check, minus the extension
83  * \param fmt the format you wish to check (the extension)
84  * \param preflang (the preferred language you wisht to find the file in)
85  * See if a given file exists in a given format.  If fmt is NULL,  any format is accepted.
86  * \return -1 if file does not exist, non-zero positive otherwise.
87  */
88 int ast_fileexists(const char *filename, const char *fmt, const char *preflang);
89
90 /*! 
91  * \brief Renames a file 
92  * \param oldname the name of the file you wish to act upon (minus the extension)
93  * \param newname the name you wish to rename the file to (minus the extension)
94  * \param fmt the format of the file
95  * Rename a given file in a given format, or if fmt is NULL, then do so for all 
96  * \return -1 on failure
97  */
98 int ast_filerename(const char *oldname, const char *newname, const char *fmt);
99
100 /*!
101  * \brief  Deletes a file
102  * \param filename name of the file you wish to delete (minus the extension)
103  * \param fmt of the file
104  * Delete a given file in a given format, or if fmt is NULL, then do so for all 
105  */
106 int ast_filedelete(const char *filename, const char *fmt);
107
108 /*! 
109  * \brief Copies a file 
110  * \param oldname name of the file you wish to copy (minus extension)
111  * \param newname name you wish the file to be copied to (minus extension)
112  * \param fmt the format of the file
113  * Copy a given file in a given format, or if fmt is NULL, then do so for all 
114  */
115 int ast_filecopy(const char *oldname, const char *newname, const char *fmt);
116
117 /*! 
118  * \brief Waits for a stream to stop or digit to be pressed
119  * \param c channel to waitstream on
120  * \param breakon string of DTMF digits to break upon
121  * Begins playback of a stream...
122  * Wait for a stream to stop or for any one of a given digit to arrive,  
123  * \retval 0 if the stream finishes
124  * \retval the character if it was interrupted,
125  * \retval -1 on error 
126  */
127 int ast_waitstream(struct ast_channel *c, const char *breakon);
128
129 /*! 
130  * \brief Waits for a stream to stop or digit matching a valid one digit exten to be pressed 
131  * \param c channel to waitstream on
132  * \param context string of context to match digits to break upon
133  * Begins playback of a stream...
134  * Wait for a stream to stop or for any one of a valid extension digit to arrive,  
135  * \retval 0 if the stream finishes.
136  * \retval the character if it was interrupted.
137  * \retval -1 on error.
138  */
139 int ast_waitstream_exten(struct ast_channel *c, const char *context);
140
141 /*! 
142  * \brief Same as waitstream but allows stream to be forwarded or rewound 
143  * \param c channel to waitstream on
144  * \param breakon string of DTMF digits to break upon
145  * \param forward DTMF digit to fast forward upon
146  * \param rewind DTMF digit to rewind upon
147  * \param ms How many miliseconds to skip forward/back
148  * Begins playback of a stream...
149  * Wait for a stream to stop or for any one of a given digit to arrive,  
150  * \retval 0 if the stream finishes.
151  * \retval the character if it was interrupted.
152  * \retval -1 on error.
153  */
154 int ast_waitstream_fr(struct ast_channel *c, const char *breakon, const char *forward, const char *rewind, int ms);
155
156 /*!
157  * Same as waitstream, but with audio output to fd and monitored fd checking.  
158  *
159  * \return 1 if monfd is ready for reading 
160  */
161 int ast_waitstream_full(struct ast_channel *c, const char *breakon, int audiofd, int monfd);
162
163 /*! 
164  * \brief Starts reading from a file
165  * \param filename the name of the file to read from
166  * \param type format of file you wish to read from
167  * \param comment comment to go with
168  * \param flags file flags
169  * \param check (unimplemented, hence negligible)
170  * \param mode Open mode
171  * Open an incoming file stream.  flags are flags for the open() command, and 
172  * if check is non-zero, then it will not read a file if there are any files that 
173  * start with that name and have an extension
174  * Please note, this is a blocking function.  Program execution will not return until ast_waitstream completes it's execution.
175  * \retval a struct ast_filestream on success.
176  * \retval NULL on failure.
177  */
178 struct ast_filestream *ast_readfile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode);
179
180 /*! 
181  * \brief Starts writing a file 
182  * \param filename the name of the file to write to
183  * \param type format of file you wish to write out to
184  * \param comment comment to go with
185  * \param flags output file flags
186  * \param check (unimplemented, hence negligible)
187  * \param mode Open mode
188  * Create an outgoing file stream.  oflags are flags for the open() command, and 
189  * if check is non-zero, then it will not write a file if there are any files that 
190  * start with that name and have an extension
191  * Please note, this is a blocking function.  Program execution will not return until ast_waitstream completes it's execution.
192  * \retval a struct ast_filestream on success.
193  * \retval NULL on failure.
194  */
195 struct ast_filestream *ast_writefile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode);
196
197 /*! 
198  * \brief Writes a frame to a stream 
199  * \param fs filestream to write to
200  * \param f frame to write to the filestream
201  * Send a frame to a filestream -- note: does NOT free the frame, call ast_frfree manually
202  * \retval 0 on success.
203  * \retval -1 on failure.
204  */
205 int ast_writestream(struct ast_filestream *fs, struct ast_frame *f);
206
207 /*! 
208  * \brief Closes a stream 
209  * \param f filestream to close
210  * Close a playback or recording stream
211  * \retval 0 on success.
212  * \retval -1 on failure.
213  */
214 int ast_closestream(struct ast_filestream *f);
215
216 /*! 
217  * \brief Opens stream for use in seeking, playing 
218  * \param chan channel to work with
219  * \param filename to use
220  * \param preflang prefered language to use
221  * \retval a ast_filestream pointer if it opens the file.
222  * \retval NULL on error.
223  */
224 struct ast_filestream *ast_openstream(struct ast_channel *chan, const char *filename, const char *preflang);
225
226 /*! 
227  * \brief Opens stream for use in seeking, playing 
228  * \param chan channel to work with
229  * \param filename to use
230  * \param preflang prefered language to use
231  * \param asis if set, don't clear generators
232  * \retval a ast_filestream pointer if it opens the file.
233  * \retval NULL on error.
234  */
235 struct ast_filestream *ast_openstream_full(struct ast_channel *chan, const char *filename, const char *preflang, int asis);
236 /*! 
237  * \brief Opens stream for use in seeking, playing 
238  * \param chan channel to work with
239  * \param filename to use
240  * \param preflang prefered language to use
241  * \retval a ast_filestream pointer if it opens the file.
242  * \retval NULL on error.
243  */
244 struct ast_filestream *ast_openvstream(struct ast_channel *chan, const char *filename, const char *preflang);
245
246 /*! 
247  * \brief Applys a open stream to a channel. 
248  * \param chan channel to work
249  * \param s ast_filestream to apply
250  * \retval 0 on success.
251  * \retval -1 on failure.
252  */
253 int ast_applystream(struct ast_channel *chan, struct ast_filestream *s);
254
255 /*! 
256  * \brief Play a open stream on a channel. 
257  * \param s filestream to play
258  * \retval 0 on success.
259  * \retval -1 on failure.
260  */
261 int ast_playstream(struct ast_filestream *s);
262
263 /*! 
264  * \brief Seeks into stream 
265  * \param fs ast_filestream to perform seek on
266  * \param sample_offset numbers of samples to seek
267  * \param whence SEEK_SET, SEEK_CUR, SEEK_END 
268  * \retval 0 on success.
269  * \retval -1 on failure.
270  */
271 int ast_seekstream(struct ast_filestream *fs, off_t sample_offset, int whence);
272
273 /*! 
274  * \brief Trunc stream at current location 
275  * \param fs filestream to act on
276  * \retval 0 on success.
277  * \retval -1 on failure.
278  */
279 int ast_truncstream(struct ast_filestream *fs);
280
281 /*! 
282  * \brief Fast forward stream ms 
283  * \param fs filestream to act on
284  * \param ms milliseconds to move
285  * \retval 0 on success.
286  * \retval -1 on failure.
287  */
288 int ast_stream_fastforward(struct ast_filestream *fs, off_t ms);
289
290 /*! 
291  * \brief Rewind stream ms 
292  * \param fs filestream to act on
293  * \param ms milliseconds to move
294  * \retval 0 on success.
295  * \retval -1 on failure.
296  */
297 int ast_stream_rewind(struct ast_filestream *fs, off_t ms);
298
299 /*! 
300  * \brief Tell where we are in a stream 
301  * \param fs fs to act on
302  * \return a long as a sample offset into stream
303  */
304 off_t ast_tellstream(struct ast_filestream *fs);
305
306 /*! 
307  * \brief Read a frame from a filestream 
308  * \param s ast_filestream to act on
309  * \return a frame.
310  * \retval NULL if read failed.
311  */ 
312 struct ast_frame *ast_readframe(struct ast_filestream *s);
313
314 #if defined(__cplusplus) || defined(c_plusplus)
315 }
316 #endif
317
318 #endif /* _ASTERISK_FILE_H */