Totally redo file formats
[asterisk/asterisk.git] / include / asterisk / file.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Generic File Format Support.
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #ifndef _ASTERISK_FILE_H
15 #define _ASTERISK_FILE_H
16
17 #include <asterisk/channel.h>
18 #include <asterisk/frame.h>
19 #include <fcntl.h>
20
21
22 #if defined(__cplusplus) || defined(c_plusplus)
23 extern "C" {
24 #endif
25
26
27 //! Convenient for waiting
28 #define AST_DIGIT_ANY "0123456789#*"
29
30 /* Defined by individual formats.  First item MUST be a
31    pointer for use by the stream manager */
32 struct ast_filestream;
33
34 //! Registers a new file format
35 /*! Register a new file format capability
36  * 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.
37  * returns 0 on success, -1 on failure
38  */
39 int ast_format_register(char *name, char *exts, int format,
40                                                 struct ast_filestream * (*open)(int fd),
41                                                 struct ast_filestream * (*rewrite)(int fd, char *comment),
42                                                 int (*write)(struct ast_filestream *, struct ast_frame *),
43                                                 int (*seek)(struct ast_filestream *, long offset, int whence),
44                                                 int (*trunc)(struct ast_filestream *),
45                                                 long (*tell)(struct ast_filestream *),
46                                                 struct ast_frame * (*read)(struct ast_filestream *, int *timetonext),
47                                                 void (*close)(struct ast_filestream *),
48                                                 char * (*getcomment)(struct ast_filestream *));
49         
50 //! Unregisters a file format
51 /*!
52  * \param name the name of the format you wish to unregister
53  * Unregisters a format based on the name of the format.
54  * Returns 0 on success, -1 on failure to unregister
55  */
56 int ast_format_unregister(char *name);
57
58 //! Streams a file
59 /*!
60  * \param c channel to stream the file to
61  * \param filename the name of the file you wish to stream, minus the extension
62  * \param preflang the preferred language you wish to have the file streamed to you in
63  * Prepares a channel for the streaming of a file.  To start the stream, afterward do a ast_waitstream() on the channel
64  * Also, it will stop any existing streams on the channel.
65  * Returns 0 on success, or -1 on failure.
66  */
67 int ast_streamfile(struct ast_channel *c, char *filename, char *preflang);
68
69 //! Stops a stream
70 /*!
71  * \param c The channel you wish to stop playback on
72  * Stop playback of a stream 
73  * Returns 0 regardless
74  */
75 int ast_stopstream(struct ast_channel *c);
76
77 //! Checks for the existence of a given file
78 /*!
79  * \param filename name of the file you wish to check, minus the extension
80  * \param fmt the format you wish to check (the extension)
81  * \param preflang (the preferred language you wisht to find the file in)
82  * See if a given file exists in a given format.  If fmt is NULL,  any format is accepted.
83  * Returns -1 if file does not exist, non-zero positive otherwise.
84  */
85 int ast_fileexists(char *filename, char *fmt, char *preflang);
86
87 //! Renames a file
88 /*! 
89  * \param oldname the name of the file you wish to act upon (minus the extension)
90  * \param newname the name you wish to rename the file to (minus the extension)
91  * \param fmt the format of the file
92  * Rename a given file in a given format, or if fmt is NULL, then do so for all 
93  * Returns -1 on failure
94  */
95 int ast_filerename(char *oldname, char *newname, char *fmt);
96
97 //! Deletes a file
98 /*! 
99  * \param filename name of the file you wish to delete (minus the extension)
100  * \param format of the file
101  * Delete a given file in a given format, or if fmt is NULL, then do so for all 
102  */
103 int ast_filedelete(char *filename, char *fmt);
104
105 //! Copies a file
106 /*!
107  * \param oldname name of the file you wish to copy (minus extension)
108  * \param newname name you wish the file to be copied to (minus extension)
109  * \param fmt the format of the file
110  * Copy a given file in a given format, or if fmt is NULL, then do so for all 
111  */
112 int ast_filecopy(char *oldname, char *newname, char *fmt);
113
114 //! Waits for a stream to stop or digit to be pressed
115 /*!
116  * \param c channel to waitstram on
117  * \param breakon string of DTMF digits to break upon
118  * Begins playback of a stream...
119  * Wait for a stream to stop or for any one of a given digit to arrive,  Returns 0 
120  * if the stream finishes, the character if it was interrupted, and -1 on error 
121  */
122 char ast_waitstream(struct ast_channel *c, char *breakon);
123
124 //! Same as waitstream but allows stream to be forwarded or rewound
125 /*!
126  * \param c channel to waitstram on
127  * \param breakon string of DTMF digits to break upon
128  * \param forward DTMF digit to fast forward upon
129  * \param rewind DTMF digit to rewind upon
130  * \param ms How many miliseconds to skip forward/back
131  * Begins playback of a stream...
132  * Wait for a stream to stop or for any one of a given digit to arrive,  Returns 0 
133  * if the stream finishes, the character if it was interrupted, and -1 on error 
134  */
135 char ast_waitstream_fr(struct ast_channel *c, char *breakon, char *forward, char *rewind, int ms);
136
137 /* Same as waitstream, but with audio output to fd and monitored fd checking.  Returns
138    1 if monfd is ready for reading */
139 char ast_waitstream_full(struct ast_channel *c, char *breakon, int audiofd, int monfd);
140
141 //! Starts writing a file
142 /*!
143  * \param filename the name of the file to write to
144  * \param type format of file you wish to write out to
145  * \param comment comment to go with
146  * \param oflags output file flags
147  * \param check (unimplemented, hence negligible)
148  * \param mode Open mode
149  * Create an outgoing file stream.  oflags are flags for the open() command, and 
150  * if check is non-zero, then it will not write a file if there are any files that 
151  * start with that name and have an extension
152  * Please note, this is a blocking function.  Program execution will not return until ast_waitstream completes it's execution.
153  * Returns a struct ast_filestream on success, NULL on failure
154  */
155 struct ast_filestream *ast_writefile(char *filename, char *type, char *comment, int oflags, int check, mode_t mode);
156
157 //! Writes a frame to a stream
158 /*! 
159  * \param fs filestream to write to
160  * \param f frame to write to the filestream
161  * Send a frame to a filestream -- note: does NOT free the frame, call ast_frfree manually
162  * Returns 0 on success, -1 on failure.
163  */
164 int ast_writestream(struct ast_filestream *fs, struct ast_frame *f);
165
166 //! Closes a stream
167 /*!
168  * \param f filestream to close
169  * Close a playback or recording stream
170  * Returns 0 on success, -1 on failure
171  */
172 int ast_closestream(struct ast_filestream *f);
173
174 //! Opens stream for use in seeking, playing, and writing
175 /*!
176  * \param chan channel to work with
177  * \param filename to use
178  * \param preflang prefered language to use
179  * Returns a ast_filestream pointer if it opens the file, NULL on error
180  */
181 struct ast_filestream *ast_openstream(struct ast_channel *chan, char *filename, char *preflang);
182
183 //! Applys a open stream to a channel.
184 /*!
185  * \param chan channel to work
186  * \param ast_filestream s to apply
187  * Returns 0 for success, -1 on failure
188  */
189 int ast_applystream(struct ast_channel *chan, struct ast_filestream *s);
190
191 //! play a open stream on a channel.
192 /*!
193  * \param ast_filestream s to play
194  * Returns 0 for success, -1 on failure
195  */
196 int ast_playstream(struct ast_filestream *s);
197
198 //! Seeks into stream
199 /*!
200  * \param ast_filestream to perform seek on
201  * \param sample_offset numbers of samples to seek
202  * \param whence SEEK_SET, SEEK_CUR, SEEK_END 
203  * Returns 0 for success, or -1 for error
204  */
205 int ast_seekstream(struct ast_filestream *fs, long sample_offset, int whence);
206
207 //! Trunc stream at current location
208 /*!
209  * \param ast_filestream fs 
210  * Returns 0 for success, or -1 for error
211  */
212 int ast_truncstream(struct ast_filestream *fs);
213
214 //! Fast forward stream ms
215 /*!
216  * \param ast_filestream fs filestream to act on
217  * \param ms milliseconds to move
218  * Returns 0 for success, or -1 for error
219  */
220 int ast_stream_fastforward(struct ast_filestream *fs, long ms);
221
222 //! Rewind stream ms
223 /*!
224  * \param ast_filestream fs filestream to act on
225  * \param ms milliseconds to move
226  * Returns 0 for success, or -1 for error
227  */
228 int ast_stream_rewind(struct ast_filestream *fs, long ms);
229
230 //! Fast forward stream ms
231 /*!
232  * \param ast_filestream fs filestream to act on
233  * \param ms milliseconds to move
234  * Returns 0 for success, or -1 for error
235  */
236 int ast_stream_fastforward(struct ast_filestream *fs, long ms);
237
238 //! Rewind stream ms
239 /*!
240  * \param ast_filestream fs filestream to act on
241  * \param ms milliseconds to move
242  * Returns 0 for success, or -1 for error
243  */
244 int ast_stream_rewind(struct ast_filestream *fs, long ms);
245
246 //! Tell where we are in a stream
247 /*!
248  * \param ast_filestream fs to act on
249  * Returns a long as a sample offset into stream
250  */
251 long ast_tellstream(struct ast_filestream *fs);
252
253 #define AST_RESERVED_POINTERS 12
254
255 #if defined(__cplusplus) || defined(c_plusplus)
256 }
257 #endif
258
259
260
261 #endif