994b7b94355268191ed57b260a8bdcbe10dd15e3
[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  */
22
23 #ifndef _ASTERISK_FILE_H
24 #define _ASTERISK_FILE_H
25
26 #include "asterisk/channel.h"
27 #include "asterisk/frame.h"
28 #ifdef HAVE_FCNTL_H
29 #include <fcntl.h>
30 #endif
31
32 #if defined(__cplusplus) || defined(c_plusplus)
33 extern "C" {
34 #endif
35
36
37 /*! Convenient for waiting */
38 #define AST_DIGIT_ANY "0123456789#*ABCD"
39 #define AST_DIGIT_ANYNUM "0123456789"
40
41 /*! structure used for lock and refcount of format handlers.
42  * Should not be here, but this is a temporary workaround
43  * until we implement a more general mechanism.
44  * The format handler should include a pointer to
45  * this structure.
46  * As a trick, if usecnt is initialized with -1,
47  * ast_format_register will init the mutex for you.
48  */
49 struct ast_format_lock {
50         ast_mutex_t lock;
51         int usecnt;     /* number of active clients */
52 };
53
54 /*!
55  * Each supported file format is described by the following fields.
56  * Not all are necessary, the support routine implement default
57  * values for some of them.
58  * A handler typically fills a structure initializing the desired
59  * fields, and then calls ast_format_register() with the (readonly)
60  * structure as an argument.
61  */
62 struct ast_format {
63         char name[80];          /*!< Name of format */
64         char exts[80];          /*!< Extensions (separated by | if more than one) 
65                                 this format can read.  First is assumed for writing (e.g. .mp3) */
66         int format;             /*!< Format of frames it uses/provides (one only) */
67         /*! 
68          * \brief Prepare an input stream for playback. 
69          * \return 0 on success, -1 on error.
70          * The FILE is already open (in s->f) so this function only needs to perform
71          * any applicable validity checks on the file. If none is required, the
72          * function can be omitted.
73          */
74         int (*open)(struct ast_filestream *s);
75         /*! 
76          * \brief Prepare a stream for output, and comment it appropriately if applicable.
77          * \return 0 on success, -1 on error. 
78          * Same as the open, the FILE is already open so the function just needs to 
79          * prepare any header and other fields, if any. 
80          * The function can be omitted if nothing is needed.
81          */
82         int (*rewrite)(struct ast_filestream *s, const char *comment);
83         /*! Write a frame to a channel */
84         int (*write)(struct ast_filestream *, struct ast_frame *);
85         /*! seek num samples into file, whence - like a normal seek but with offset in samples */
86         int (*seek)(struct ast_filestream *, off_t, int);
87         int (*trunc)(struct ast_filestream *fs);        /*!< trunc file to current position */
88         off_t (*tell)(struct ast_filestream *fs);       /*!< tell current position */
89         /*! Read the next frame from the filestream (if available) and report
90          * when to get next frame (in samples)
91          */
92         struct ast_frame * (*read)(struct ast_filestream *, int *whennext);
93         /*! Do any closing actions, if any. The descriptor and structure are closed
94          * and destroyed by the generic routines, so they must not be done here. */
95         void (*close)(struct ast_filestream *);
96         char * (*getcomment)(struct ast_filestream *);          /*!< Retrieve file comment */
97
98         AST_LIST_ENTRY(ast_format) list;                        /*!< Link */
99
100         /*!
101          * If the handler needs a buffer (for read, typically)
102          * and/or a private descriptor, put here the
103          * required size (in bytes) and the support routine will allocate them
104          * for you, pointed by s->buf and s->private, respectively.
105          * When allocating a buffer, remember to leave AST_FRIENDLY_OFFSET
106          * spare bytes at the bginning.
107          */
108         int buf_size;                   /*!< size of frame buffer, if any, aligned to 8 bytes. */
109         int desc_size;                  /*!< size of private descriptor, if any */
110
111         struct ast_module *module;
112 };
113
114 /*!
115  * This structure is allocated by file.c in one chunk,
116  * together with buf_size and desc_size bytes of memory
117  * to be used for private purposes (e.g. buffers etc.)
118  */
119 struct ast_filestream {
120         /*! Everybody reserves a block of AST_RESERVED_POINTERS pointers for us */
121         struct ast_format *fmt; /* need to write to the lock and usecnt */
122         int flags;
123         mode_t mode;
124         char *filename;
125         char *realfilename;
126         /*! Video file stream */
127         struct ast_filestream *vfs;
128         /*! Transparently translate from another format -- just once */
129         struct ast_trans_pvt *trans;
130         struct ast_tranlator_pvt *tr;
131         int lastwriteformat;
132         int lasttimeout;
133         struct ast_channel *owner;
134         FILE *f;
135         struct ast_frame fr;    /*!< frame produced by read, typically */
136         char *buf;              /*!< buffer pointed to by ast_frame; */
137         void *private;  /*!< pointer to private buffer */
138         const char *orig_chan_name;
139 };
140
141 #define SEEK_FORCECUR   10
142         
143 /*! 
144  * \brief Register a new file format capability.
145  * Adds a format to Asterisk's format abilities.
146  * \retval 0 on success
147  * \retval -1 on failure
148  */
149 int __ast_format_register(const struct ast_format *f, struct ast_module *mod);
150 #define ast_format_register(f) __ast_format_register(f, ast_module_info->self)
151
152 /*! 
153  * \brief Unregisters a file format 
154  * \param name the name of the format you wish to unregister
155  * Unregisters a format based on the name of the format.
156  * \retval 0 on success
157  * \retval -1 on failure to unregister
158  */
159 int ast_format_unregister(const char *name);
160
161 /*! 
162  * \brief Streams a file 
163  * \param c channel to stream the file to
164  * \param filename the name of the file you wish to stream, minus the extension
165  * \param preflang the preferred language you wish to have the file streamed to you in
166  * Prepares a channel for the streaming of a file.  To start the stream, afterward do a ast_waitstream() on the channel
167  * Also, it will stop any existing streams on the channel.
168  * \retval 0 on success.
169  * \retval -1 on failure.
170  */
171 int ast_streamfile(struct ast_channel *c, const char *filename, const char *preflang);
172
173 /*!
174  * \brief stream file until digit
175  * If the file name is non-empty, try to play it.
176  * \note If digits == "" then we can simply check for non-zero.
177  * \return 0 if success.
178  * \retval -1 if error.
179  * \retval digit if interrupted by a digit.
180  */
181 int ast_stream_and_wait(struct ast_channel *chan, const char *file, const char *digits);
182
183 /*! 
184  * \brief Stops a stream 
185  * \param c The channel you wish to stop playback on
186  * Stop playback of a stream 
187  * \return 0 regardless
188  */
189 int ast_stopstream(struct ast_channel *c);
190
191 /*! 
192  * \brief Checks for the existence of a given file 
193  * \param filename name of the file you wish to check, minus the extension
194  * \param fmt the format you wish to check (the extension)
195  * \param preflang (the preferred language you wisht to find the file in)
196  * See if a given file exists in a given format.  If fmt is NULL,  any format is accepted.
197  * \return -1 if file does not exist, non-zero positive otherwise.
198  */
199 int ast_fileexists(const char *filename, const char *fmt, const char *preflang);
200
201 /*! 
202  * \brief Renames a file 
203  * \param oldname the name of the file you wish to act upon (minus the extension)
204  * \param newname the name you wish to rename the file to (minus the extension)
205  * \param fmt the format of the file
206  * Rename a given file in a given format, or if fmt is NULL, then do so for all 
207  * \return -1 on failure
208  */
209 int ast_filerename(const char *oldname, const char *newname, const char *fmt);
210
211 /*!
212  * \brief  Deletes a file
213  * \param filename name of the file you wish to delete (minus the extension)
214  * \param fmt of the file
215  * Delete a given file in a given format, or if fmt is NULL, then do so for all 
216  */
217 int ast_filedelete(const char *filename, const char *fmt);
218
219 /*! 
220  * \brief Copies a file 
221  * \param oldname name of the file you wish to copy (minus extension)
222  * \param newname name you wish the file to be copied to (minus extension)
223  * \param fmt the format of the file
224  * Copy a given file in a given format, or if fmt is NULL, then do so for all 
225  */
226 int ast_filecopy(const char *oldname, const char *newname, const char *fmt);
227
228 /*! 
229  * \brief Waits for a stream to stop or digit to be pressed
230  * \param c channel to waitstream on
231  * \param breakon string of DTMF digits to break upon
232  * Begins playback of a stream...
233  * Wait for a stream to stop or for any one of a given digit to arrive,  
234  * \retval 0 if the stream finishes
235  * \retval the character if it was interrupted,
236  * \retval -1 on error 
237  */
238 int ast_waitstream(struct ast_channel *c, const char *breakon);
239
240 /*! 
241  * \brief Waits for a stream to stop or digit matching a valid one digit exten to be pressed 
242  * \param c channel to waitstream on
243  * \param context string of context to match digits to break upon
244  * Begins playback of a stream...
245  * Wait for a stream to stop or for any one of a valid extension digit to arrive,  
246  * \retval 0 if the stream finishes.
247  * \retval the character if it was interrupted.
248  * \retval -1 on error.
249  */
250 int ast_waitstream_exten(struct ast_channel *c, const char *context);
251
252 /*! 
253  * \brief Same as waitstream but allows stream to be forwarded or rewound 
254  * \param c channel to waitstream on
255  * \param breakon string of DTMF digits to break upon
256  * \param forward DTMF digit to fast forward upon
257  * \param rewind DTMF digit to rewind upon
258  * \param ms How many miliseconds to skip forward/back
259  * Begins playback of a stream...
260  * Wait for a stream to stop or for any one of a given digit to arrive,  
261  * \retval 0 if the stream finishes.
262  * \retval the character if it was interrupted.
263  * \retval -1 on error.
264  */
265 int ast_waitstream_fr(struct ast_channel *c, const char *breakon, const char *forward, const char *rewind, int ms);
266
267 /*!
268  * Same as waitstream, but with audio output to fd and monitored fd checking.  
269  *
270  * \return 1 if monfd is ready for reading 
271  */
272 int ast_waitstream_full(struct ast_channel *c, const char *breakon, int audiofd, int monfd);
273
274 /*! 
275  * \brief Starts reading from a file
276  * \param filename the name of the file to read from
277  * \param type format of file you wish to read from
278  * \param comment comment to go with
279  * \param flags file flags
280  * \param check (unimplemented, hence negligible)
281  * \param mode Open mode
282  * Open an incoming file stream.  flags are flags for the open() command, and 
283  * if check is non-zero, then it will not read a file if there are any files that 
284  * start with that name and have an extension
285  * Please note, this is a blocking function.  Program execution will not return until ast_waitstream completes it's execution.
286  * \retval a struct ast_filestream on success.
287  * \retval NULL on failure.
288  */
289 struct ast_filestream *ast_readfile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode);
290
291 /*! 
292  * \brief Starts writing a file 
293  * \param filename the name of the file to write to
294  * \param type format of file you wish to write out to
295  * \param comment comment to go with
296  * \param flags output file flags
297  * \param check (unimplemented, hence negligible)
298  * \param mode Open mode
299  * Create an outgoing file stream.  oflags are flags for the open() command, and 
300  * if check is non-zero, then it will not write a file if there are any files that 
301  * start with that name and have an extension
302  * Please note, this is a blocking function.  Program execution will not return until ast_waitstream completes it's execution.
303  * \retval a struct ast_filestream on success.
304  * \retval NULL on failure.
305  */
306 struct ast_filestream *ast_writefile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode);
307
308 /*! 
309  * \brief Writes a frame to a stream 
310  * \param fs filestream to write to
311  * \param f frame to write to the filestream
312  * Send a frame to a filestream -- note: does NOT free the frame, call ast_frfree manually
313  * \retval 0 on success.
314  * \retval -1 on failure.
315  */
316 int ast_writestream(struct ast_filestream *fs, struct ast_frame *f);
317
318 /*! 
319  * \brief Closes a stream 
320  * \param f filestream to close
321  * Close a playback or recording stream
322  * \retval 0 on success.
323  * \retval -1 on failure.
324  */
325 int ast_closestream(struct ast_filestream *f);
326
327 /*! 
328  * \brief Opens stream for use in seeking, playing 
329  * \param chan channel to work with
330  * \param filename to use
331  * \param preflang prefered language to use
332  * \retval a ast_filestream pointer if it opens the file.
333  * \retval NULL on error.
334  */
335 struct ast_filestream *ast_openstream(struct ast_channel *chan, const char *filename, const char *preflang);
336
337 /*! 
338  * \brief Opens stream for use in seeking, playing 
339  * \param chan channel to work with
340  * \param filename to use
341  * \param preflang prefered language to use
342  * \param asis if set, don't clear generators
343  * \retval a ast_filestream pointer if it opens the file.
344  * \retval NULL on error.
345  */
346 struct ast_filestream *ast_openstream_full(struct ast_channel *chan, const char *filename, const char *preflang, int asis);
347 /*! 
348  * \brief Opens stream for use in seeking, playing 
349  * \param chan channel to work with
350  * \param filename to use
351  * \param preflang prefered language to use
352  * \retval a ast_filestream pointer if it opens the file.
353  * \retval NULL on error.
354  */
355 struct ast_filestream *ast_openvstream(struct ast_channel *chan, const char *filename, const char *preflang);
356
357 /*! 
358  * \brief Applys a open stream to a channel. 
359  * \param chan channel to work
360  * \param s ast_filestream to apply
361  * \retval 0 on success.
362  * \retval -1 on failure.
363  */
364 int ast_applystream(struct ast_channel *chan, struct ast_filestream *s);
365
366 /*! 
367  * \brief Play a open stream on a channel. 
368  * \param s filestream to play
369  * \retval 0 on success.
370  * \retval -1 on failure.
371  */
372 int ast_playstream(struct ast_filestream *s);
373
374 /*! 
375  * \brief Seeks into stream 
376  * \param fs ast_filestream to perform seek on
377  * \param sample_offset numbers of samples to seek
378  * \param whence SEEK_SET, SEEK_CUR, SEEK_END 
379  * \retval 0 on success.
380  * \retval -1 on failure.
381  */
382 int ast_seekstream(struct ast_filestream *fs, off_t sample_offset, int whence);
383
384 /*! 
385  * \brief Trunc stream at current location 
386  * \param fs filestream to act on
387  * \retval 0 on success.
388  * \retval -1 on failure.
389  */
390 int ast_truncstream(struct ast_filestream *fs);
391
392 /*! 
393  * \brief Fast forward stream ms 
394  * \param fs filestream to act on
395  * \param ms milliseconds to move
396  * \retval 0 on success.
397  * \retval -1 on failure.
398  */
399 int ast_stream_fastforward(struct ast_filestream *fs, off_t ms);
400
401 /*! 
402  * \brief Rewind stream ms 
403  * \param fs filestream to act on
404  * \param ms milliseconds to move
405  * \retval 0 on success.
406  * \retval -1 on failure.
407  */
408 int ast_stream_rewind(struct ast_filestream *fs, off_t ms);
409
410 /*! 
411  * \brief Tell where we are in a stream 
412  * \param fs fs to act on
413  * \return a long as a sample offset into stream
414  */
415 off_t ast_tellstream(struct ast_filestream *fs);
416
417 /*! 
418  * \brief Read a frame from a filestream 
419  * \param s ast_filestream to act on
420  * \return a frame.
421  * \retval NULL if read failed.
422  */ 
423 struct ast_frame *ast_readframe(struct ast_filestream *s);
424
425 /*! 
426  * \brief Initialize file stuff 
427  * Initializes all the various file stuff.  Basically just registers the cli stuff
428  * \return 0 all the time
429  */
430 int ast_file_init(void);
431
432
433 #define AST_RESERVED_POINTERS 20
434
435 #if defined(__cplusplus) || defined(c_plusplus)
436 }
437 #endif
438
439 #endif /* _ASTERISK_FILE_H */