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