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