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