CLI: Create ast_cli_completion_vector.
[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 Callback called for each file found when reading directories
142  * \param dir_name the name of the directory
143  * \param filename the name of the file
144  * \param obj user data object
145  * \return non-zero to stop reading, otherwise zero to continue
146  */
147 typedef int (*ast_file_on_file)(const char *dir_name, const char *filename, void *obj);
148
149 /*!
150  * \brief Recursively iterate through files and directories up to max_depth
151  * \param dir_name the name of the directory to search
152  * \param on_file callback called on each file
153  * \param obj user data object
154  * \param max_depth re-curse into sub-directories up to a given maximum (-1 = infinite)
155  * \return -1 or errno on failure, otherwise 0
156  */
157 int ast_file_read_dirs(const char *dir_name, ast_file_on_file on_file, void *obj, int max_depth);
158
159 /*!
160  * \brief Iterate over each file in a given directory
161  * \param dir_name the name of the directory to search
162  * \param on_file callback called on each file
163  * \param obj user data object
164  * \return -1 or errno on failure, otherwise 0
165  */
166 #define ast_file_read_dir(dir_name, on_file, obj) ast_file_read_dirs(dir_name, on_file, obj, 1)
167
168 /*!
169  * \brief Waits for a stream to stop or digit to be pressed
170  * \param c channel to waitstream on
171  * \param breakon string of DTMF digits to break upon
172  * Begins playback of a stream...
173  * Wait for a stream to stop or for any one of a given digit to arrive,
174  * \retval 0 if the stream finishes
175  * \retval the character if it was interrupted by the channel.
176  * \retval -1 on error
177  */
178 int ast_waitstream(struct ast_channel *c, const char *breakon);
179
180 /*!
181  * \brief Waits for a stream to stop or digit matching a valid one digit exten to be pressed
182  * \param c channel to waitstream on
183  * \param context string of context to match digits to break upon
184  * Begins playback of a stream...
185  * Wait for a stream to stop or for any one of a valid extension digit to arrive,
186  * \retval 0 if the stream finishes.
187  * \retval the character if it was interrupted.
188  * \retval -1 on error.
189  */
190 int ast_waitstream_exten(struct ast_channel *c, const char *context);
191
192 /*!
193  * \brief Same as waitstream but allows stream to be forwarded or rewound
194  * \param c channel to waitstream on
195  * \param breakon string of DTMF digits to break upon
196  * \param forward DTMF digit to fast forward upon
197  * \param rewind DTMF digit to rewind upon
198  * \param ms How many miliseconds to skip forward/back
199  * Begins playback of a stream...
200  * Wait for a stream to stop or for any one of a given digit to arrive,
201  * \retval 0 if the stream finishes.
202  * \retval the character if it was interrupted,
203  * \retval the value of the control frame if it was interrupted by some other party,
204  * \retval -1 on error.
205  */
206 int ast_waitstream_fr(struct ast_channel *c, const char *breakon, const char *forward, const char *rewind, int ms);
207
208 /*!
209  * \brief Same as waitstream_fr but allows a callback to be alerted when a user
210  * fastforwards or rewinds the file.
211  * \param c channel to waitstream on
212  * \param breakon string of DTMF digits to break upon
213  * \param forward DTMF digit to fast forward upon
214  * \param rewind DTMF digit to rewind upon
215  * \param ms How many milliseconds to skip forward/back
216  * \param cb to call when rewind or fastfoward occurs.
217  * Begins playback of a stream...
218  * Wait for a stream to stop or for any one of a given digit to arrive,
219  * \retval 0 if the stream finishes.
220  * \retval the character if it was interrupted,
221  * \retval the value of the control frame if it was interrupted by some other party,
222  * \retval -1 on error.
223  */
224 int ast_waitstream_fr_w_cb(struct ast_channel *c,
225         const char *breakon,
226         const char *forward,
227         const char *rewind,
228         int ms,
229         ast_waitstream_fr_cb cb);
230
231 /*!
232  * Same as waitstream, but with audio output to fd and monitored fd checking.  
233  *
234  * \return 1 if monfd is ready for reading 
235  */
236 int ast_waitstream_full(struct ast_channel *c, const char *breakon, int audiofd, int monfd);
237
238 /*! 
239  * \brief Starts reading from a file
240  * \param filename the name of the file to read from
241  * \param type format of file you wish to read from
242  * \param comment comment to go with
243  * \param flags file flags
244  * \param check (unimplemented, hence negligible)
245  * \param mode Open mode
246  * Open an incoming file stream.  flags are flags for the open() command, and 
247  * if check is non-zero, then it will not read a file if there are any files that 
248  * start with that name and have an extension
249  * Please note, this is a blocking function.  Program execution will not return until ast_waitstream completes it's execution.
250  * \retval a struct ast_filestream on success.
251  * \retval NULL on failure.
252  */
253 struct ast_filestream *ast_readfile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode);
254
255 /*! 
256  * \brief Starts writing a file 
257  * \param filename the name of the file to write to
258  * \param type format of file you wish to write out to
259  * \param comment comment to go with
260  * \param flags output file flags
261  * \param check (unimplemented, hence negligible)
262  * \param mode Open mode
263  * Create an outgoing file stream.  oflags are flags for the open() command, and 
264  * if check is non-zero, then it will not write a file if there are any files that 
265  * start with that name and have an extension
266  * Please note, this is a blocking function.  Program execution will not return until ast_waitstream completes it's execution.
267  * \retval a struct ast_filestream on success.
268  * \retval NULL on failure.
269  */
270 struct ast_filestream *ast_writefile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode);
271
272 /*! 
273  * \brief Writes a frame to a stream 
274  * \param fs filestream to write to
275  * \param f frame to write to the filestream
276  * Send a frame to a filestream -- note: does NOT free the frame, call ast_frfree manually
277  * \retval 0 on success.
278  * \retval -1 on failure.
279  */
280 int ast_writestream(struct ast_filestream *fs, struct ast_frame *f);
281
282 /*! 
283  * \brief Closes a stream 
284  * \param f filestream to close
285  * Close a playback or recording stream
286  * \retval 0 on success.
287  * \retval -1 on failure.
288  */
289 int ast_closestream(struct ast_filestream *f);
290
291 /*! 
292  * \brief Opens stream for use in seeking, playing 
293  * \param chan channel to work with
294  * \param filename to use
295  * \param preflang prefered language to use
296  * \retval a ast_filestream pointer if it opens the file.
297  * \retval NULL on error.
298  */
299 struct ast_filestream *ast_openstream(struct ast_channel *chan, const char *filename, const char *preflang);
300
301 /*! 
302  * \brief Opens stream for use in seeking, playing 
303  * \param chan channel to work with
304  * \param filename to use
305  * \param preflang prefered language to use
306  * \param asis if set, don't clear generators
307  * \retval a ast_filestream pointer if it opens the file.
308  * \retval NULL on error.
309  */
310 struct ast_filestream *ast_openstream_full(struct ast_channel *chan, const char *filename, const char *preflang, int asis);
311 /*! 
312  * \brief Opens stream for use in seeking, playing 
313  * \param chan channel to work with
314  * \param filename to use
315  * \param preflang prefered language to use
316  * \retval a ast_filestream pointer if it opens the file.
317  * \retval NULL on error.
318  */
319 struct ast_filestream *ast_openvstream(struct ast_channel *chan, const char *filename, const char *preflang);
320
321 /*! 
322  * \brief Applys a open stream to a channel. 
323  * \param chan channel to work
324  * \param s ast_filestream to apply
325  * \retval 0 on success.
326  * \retval -1 on failure.
327  */
328 int ast_applystream(struct ast_channel *chan, struct ast_filestream *s);
329
330 /*! 
331  * \brief Play a open stream on a channel. 
332  * \param s filestream to play
333  * \retval 0 on success.
334  * \retval -1 on failure.
335  */
336 int ast_playstream(struct ast_filestream *s);
337
338 /*! 
339  * \brief Seeks into stream 
340  * \param fs ast_filestream to perform seek on
341  * \param sample_offset numbers of samples to seek
342  * \param whence SEEK_SET, SEEK_CUR, SEEK_END 
343  * \retval 0 on success.
344  * \retval -1 on failure.
345  */
346 int ast_seekstream(struct ast_filestream *fs, off_t sample_offset, int whence);
347
348 /*! 
349  * \brief Trunc stream at current location 
350  * \param fs filestream to act on
351  * \retval 0 on success.
352  * \retval -1 on failure.
353  */
354 int ast_truncstream(struct ast_filestream *fs);
355
356 /*! 
357  * \brief Fast forward stream ms 
358  * \param fs filestream to act on
359  * \param ms milliseconds to move
360  * \retval 0 on success.
361  * \retval -1 on failure.
362  */
363 int ast_stream_fastforward(struct ast_filestream *fs, off_t ms);
364
365 /*! 
366  * \brief Rewind stream ms 
367  * \param fs filestream to act on
368  * \param ms milliseconds to move
369  * \retval 0 on success.
370  * \retval -1 on failure.
371  */
372 int ast_stream_rewind(struct ast_filestream *fs, off_t ms);
373
374 /*! 
375  * \brief Tell where we are in a stream 
376  * \param fs fs to act on
377  * \return a long as a sample offset into stream
378  */
379 off_t ast_tellstream(struct ast_filestream *fs);
380
381 /*!
382  * \brief Return the sample rate of the stream's format
383  * \param fs fs to act on
384  * \return sample rate in Hz
385  */
386 int ast_ratestream(struct ast_filestream *fs);
387
388 /*! 
389  * \brief Read a frame from a filestream 
390  * \param s ast_filestream to act on
391  * \return a frame.
392  * \retval NULL if read failed.
393  */ 
394 struct ast_frame *ast_readframe(struct ast_filestream *s);
395
396 /*! Initialize file stuff */
397 /*!
398  * Initializes all the various file stuff.  Basically just registers the cli stuff
399  * Returns 0 all the time
400  */
401 int ast_file_init(void);
402
403
404 #define AST_RESERVED_POINTERS 20
405
406 /*! Remove duplicate formats from a format string. */
407 /*!
408  * \param fmts a format string, this string will be modified
409  * \retval NULL error
410  * \return a pointer to the reduced format string, this is a pointer to fmts
411  */
412 char *ast_format_str_reduce(char *fmts);
413
414 /*!
415  * \brief Get the ast_format associated with the given file extension
416  * \since 12
417  *
418  * \param file_ext The file extension for which to find the format
419  *
420  * \retval NULL if not found
421  * \retval A pointer to the ast_format associated with this file extension
422  */
423 struct ast_format *ast_get_format_for_file_ext(const char *file_ext);
424
425 #if defined(__cplusplus) || defined(c_plusplus)
426 }
427 #endif
428
429 #endif /* _ASTERISK_FILE_H */