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