79febcb4814d293023078f5392b4ca9e0c253f91
[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 (*apply)(struct ast_channel *, struct ast_filestream *),
43                                                 int (*play)(struct ast_filestream *),
44                                                 int (*write)(struct ast_filestream *, struct ast_frame *),
45                                                 int (*seek)(struct ast_filestream *, long offset, int whence),
46                                                 int (*trunc)(struct ast_filestream *),
47                                                 long (*tell)(struct ast_filestream *),
48                                                 struct ast_frame * (*read)(struct ast_filestream *),
49                                                 void (*close)(struct ast_filestream *),
50                                                 char * (*getcomment)(struct ast_filestream *));
51         
52 //! Unregisters a file format
53 /*!
54  * \param name the name of the format you wish to unregister
55  * Unregisters a format based on the name of the format.
56  * Returns 0 on success, -1 on failure to unregister
57  */
58 int ast_format_unregister(char *name);
59
60 //! Streams a file
61 /*!
62  * \param c channel to stream the file to
63  * \param filename the name of the file you wish to stream, minus the extension
64  * \param preflang the preferred language you wish to have the file streamed to you in
65  * Prepares a channel for the streaming of a file.  To start the stream, afterward do a ast_waitstream() on the channel
66  * Also, it will stop any existing streams on the channel.
67  * Returns 0 on success, or -1 on failure.
68  */
69 int ast_streamfile(struct ast_channel *c, char *filename, char *preflang);
70
71 //! Stops a stream
72 /*!
73  * \param c The channel you wish to stop playback on
74  * Stop playback of a stream 
75  * Returns 0 regardless
76  */
77 int ast_stopstream(struct ast_channel *c);
78
79 //! Checks for the existence of a given file
80 /*!
81  * \param filename name of the file you wish to check, minus the extension
82  * \param fmt the format you wish to check (the extension)
83  * \param preflang (the preferred language you wisht to find the file in)
84  * See if a given file exists in a given format.  If fmt is NULL,  any format is accepted.
85  * Returns -1 if file does not exist, non-zero positive otherwise.
86  */
87 int ast_fileexists(char *filename, char *fmt, char *preflang);
88
89 //! Renames a file
90 /*! 
91  * \param oldname the name of the file you wish to act upon (minus the extension)
92  * \param newname the name you wish to rename the file to (minus the extension)
93  * \param fmt the format of the file
94  * Rename a given file in a given format, or if fmt is NULL, then do so for all 
95  * Returns -1 on failure
96  */
97 int ast_filerename(char *oldname, char *newname, char *fmt);
98
99 //! Deletes a file
100 /*! 
101  * \param filename name of the file you wish to delete (minus the extension)
102  * \param format of the file
103  * Delete a given file in a given format, or if fmt is NULL, then do so for all 
104  */
105 int ast_filedelete(char *filename, char *fmt);
106
107 //! Copies a file
108 /*!
109  * \param oldname name of the file you wish to copy (minus extension)
110  * \param newname name you wish the file to be copied to (minus extension)
111  * \param fmt the format of the file
112  * Copy a given file in a given format, or if fmt is NULL, then do so for all 
113  */
114 int ast_filecopy(char *oldname, char *newname, char *fmt);
115
116 //! Waits for a stream to stop or digit to be pressed
117 /*!
118  * \param c channel to waitstram on
119  * \param breakon string of DTMF digits to break upon
120  * Begins playback of a stream...
121  * Wait for a stream to stop or for any one of a given digit to arrive,  Returns 0 
122  * if the stream finishes, the character if it was interrupted, and -1 on error 
123  */
124 char ast_waitstream(struct ast_channel *c, char *breakon);
125
126 //! Starts writing a file
127 /*!
128  * \param filename the name of the file to write to
129  * \param type format of file you wish to write out to
130  * \param comment comment to go with
131  * \param oflags output file flags
132  * \param check (unimplemented, hence negligible)
133  * \param mode Open mode
134  * Create an outgoing file stream.  oflags are flags for the open() command, and 
135  * if check is non-zero, then it will not write a file if there are any files that 
136  * start with that name and have an extension
137  * Please note, this is a blocking function.  Program execution will not return until ast_waitstream completes it's execution.
138  * Returns a struct ast_filestream on success, NULL on failure
139  */
140 struct ast_filestream *ast_writefile(char *filename, char *type, char *comment, int oflags, int check, mode_t mode);
141
142 //! Writes a frame to a stream
143 /*! 
144  * \param fs filestream to write to
145  * \param f frame to write to the filestream
146  * Send a frame to a filestream -- note: does NOT free the frame, call ast_frfree manually
147  * Returns 0 on success, -1 on failure.
148  */
149 int ast_writestream(struct ast_filestream *fs, struct ast_frame *f);
150
151 //! Closes a stream
152 /*!
153  * \param f filestream to close
154  * Close a playback or recording stream
155  * Returns 0 on success, -1 on failure
156  */
157 int ast_closestream(struct ast_filestream *f);
158
159 //! Opens stream for use in seeking, playing, and writing
160 /*!
161  * \param chan channel to work with
162  * \param filename to use
163  * \param preflang prefered language to use
164  * Returns a ast_filestream pointer if it opens the file, NULL on error
165  */
166 struct ast_filestream *ast_openstream(struct ast_channel *chan, char *filename, char *preflang);
167
168 //! Applys a open stream to a channel.
169 /*!
170  * \param chan channel to work
171  * \param ast_filestream s to apply
172  * Returns 0 for success, -1 on failure
173  */
174 int ast_applystream(struct ast_channel *chan, struct ast_filestream *s);
175
176 //! play a open stream on a channel.
177 /*!
178  * \param ast_filestream s to play
179  * Returns 0 for success, -1 on failure
180  */
181 int ast_playstream(struct ast_filestream *s);
182
183 //! Seeks into stream
184 /*!
185  * \param ast_filestream to perform seek on
186  * \param sample_offset numbers of samples to seek
187  * \param whence SEEK_SET, SEEK_CUR, SEEK_END 
188  * Returns 0 for success, or -1 for error
189  */
190 int ast_seekstream(struct ast_filestream *fs, long sample_offset, int whence);
191
192 //! Trunc stream at current location
193 /*!
194  * \param ast_filestream fs 
195  * Returns 0 for success, or -1 for error
196  */
197 int ast_truncstream(struct ast_filestream *fs);
198
199 //! Fast forward stream ms
200 /*!
201  * \param ast_filestream fs filestream to act on
202  * \param ms milliseconds to move
203  * Returns 0 for success, or -1 for error
204  */
205 int ast_stream_fastforward(struct ast_filestream *fs, long ms);
206
207 //! Rewind stream ms
208 /*!
209  * \param ast_filestream fs filestream to act on
210  * \param ms milliseconds to move
211  * Returns 0 for success, or -1 for error
212  */
213 int ast_stream_rewind(struct ast_filestream *fs, long ms);
214
215 //! Fast forward stream ms
216 /*!
217  * \param ast_filestream fs filestream to act on
218  * \param ms milliseconds to move
219  * Returns 0 for success, or -1 for error
220  */
221 int ast_stream_fastforward(struct ast_filestream *fs, long ms);
222
223 //! Rewind stream ms
224 /*!
225  * \param ast_filestream fs filestream to act on
226  * \param ms milliseconds to move
227  * Returns 0 for success, or -1 for error
228  */
229 int ast_stream_rewind(struct ast_filestream *fs, long ms);
230
231 //! Tell where we are in a stream
232 /*!
233  * \param ast_filestream fs to act on
234  * Returns a long as a sample offset into stream
235  */
236 long ast_tellstream(struct ast_filestream *fs);
237
238 #define AST_RESERVED_POINTERS 4
239
240 #if defined(__cplusplus) || defined(c_plusplus)
241 }
242 #endif
243
244
245
246 #endif