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