- revert change to ast_queue_hangup and create ast_queue_hangup_with_cause
[asterisk/asterisk.git] / main / file.c
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  *
21  * \brief Generic File Format Support.
22  *
23  * \author Mark Spencer <markster@digium.com> 
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <dirent.h>
31 #include <sys/stat.h>
32
33 #include "asterisk/_private.h"  /* declare ast_file_init() */
34 #include "asterisk/paths.h"     /* use ast_config_AST_DATA_DIR */
35 #include "asterisk/mod_format.h"
36 #include "asterisk/cli.h"
37 #include "asterisk/channel.h"
38 #include "asterisk/sched.h"
39 #include "asterisk/translate.h"
40 #include "asterisk/utils.h"
41 #include "asterisk/lock.h"
42 #include "asterisk/app.h"
43 #include "asterisk/pbx.h"
44 #include "asterisk/linkedlists.h"
45 #include "asterisk/module.h"
46
47 /*
48  * The following variable controls the layout of localized sound files.
49  * If 0, use the historical layout with prefix just before the filename
50  * (i.e. digits/en/1.gsm , digits/it/1.gsm or default to digits/1.gsm),
51  * if 1 put the prefix at the beginning of the filename
52  * (i.e. en/digits/1.gsm, it/digits/1.gsm or default to digits/1.gsm).
53  * The latter permits a language to be entirely in one directory.
54  */
55 int ast_language_is_prefix = 1;
56
57 static AST_RWLIST_HEAD_STATIC(formats, ast_format);
58
59 int __ast_format_register(const struct ast_format *f, struct ast_module *mod)
60 {
61         struct ast_format *tmp;
62
63         AST_RWLIST_WRLOCK(&formats);
64         AST_RWLIST_TRAVERSE(&formats, tmp, list) {
65                 if (!strcasecmp(f->name, tmp->name)) {
66                         AST_RWLIST_UNLOCK(&formats);
67                         ast_log(LOG_WARNING, "Tried to register '%s' format, already registered\n", f->name);
68                         return -1;
69                 }
70         }
71         if (!(tmp = ast_calloc(1, sizeof(*tmp)))) {
72                 AST_RWLIST_UNLOCK(&formats);
73                 return -1;
74         }
75         *tmp = *f;
76         tmp->module = mod;
77         if (tmp->buf_size) {
78                 /*
79                  * Align buf_size properly, rounding up to the machine-specific
80                  * alignment for pointers.
81                  */
82                 struct _test_align { void *a, *b; } p;
83                 int align = (char *)&p.b - (char *)&p.a;
84                 tmp->buf_size = ((f->buf_size + align - 1) / align) * align;
85         }
86         
87         memset(&tmp->list, 0, sizeof(tmp->list));
88
89         AST_RWLIST_INSERT_HEAD(&formats, tmp, list);
90         AST_RWLIST_UNLOCK(&formats);
91         ast_verb(2, "Registered file format %s, extension(s) %s\n", f->name, f->exts);
92
93         return 0;
94 }
95
96 int ast_format_unregister(const char *name)
97 {
98         struct ast_format *tmp;
99         int res = -1;
100
101         AST_RWLIST_WRLOCK(&formats);
102         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&formats, tmp, list) {
103                 if (!strcasecmp(name, tmp->name)) {
104                         AST_RWLIST_REMOVE_CURRENT(list);
105                         ast_free(tmp);
106                         res = 0;
107                 }
108         }
109         AST_RWLIST_TRAVERSE_SAFE_END;
110         AST_RWLIST_UNLOCK(&formats);
111
112         if (!res)
113                 ast_verb(2, "Unregistered format %s\n", name);
114         else
115                 ast_log(LOG_WARNING, "Tried to unregister format %s, already unregistered\n", name);
116
117         return res;
118 }
119
120 int ast_stopstream(struct ast_channel *tmp)
121 {
122         ast_channel_lock(tmp);
123
124         /* Stop a running stream if there is one */
125         if (tmp->stream) {
126                 ast_closestream(tmp->stream);
127                 tmp->stream = NULL;
128                 if (tmp->oldwriteformat && ast_set_write_format(tmp, tmp->oldwriteformat))
129                         ast_log(LOG_WARNING, "Unable to restore format back to %d\n", tmp->oldwriteformat);
130         }
131         /* Stop the video stream too */
132         if (tmp->vstream != NULL) {
133                 ast_closestream(tmp->vstream);
134                 tmp->vstream = NULL;
135         }
136
137         ast_channel_unlock(tmp);
138
139         return 0;
140 }
141
142 int ast_writestream(struct ast_filestream *fs, struct ast_frame *f)
143 {
144         int res = -1;
145         int alt = 0;
146         if (f->frametype == AST_FRAME_VIDEO) {
147                 if (fs->fmt->format & AST_FORMAT_AUDIO_MASK) {
148                         /* This is the audio portion.  Call the video one... */
149                         if (!fs->vfs && fs->filename) {
150                                 const char *type = ast_getformatname(f->subclass & ~0x1);
151                                 fs->vfs = ast_writefile(fs->filename, type, NULL, fs->flags, 0, fs->mode);
152                                 ast_debug(1, "Opened video output file\n");
153                         }
154                         if (fs->vfs)
155                                 return ast_writestream(fs->vfs, f);
156                         /* else ignore */
157                         return 0;                               
158                 } else {
159                         /* Might / might not have mark set */
160                         alt = 1;
161                 }
162         } else if (f->frametype != AST_FRAME_VOICE) {
163                 ast_log(LOG_WARNING, "Tried to write non-voice frame\n");
164                 return -1;
165         }
166         if (((fs->fmt->format | alt) & f->subclass) == f->subclass) {
167                 res =  fs->fmt->write(fs, f);
168                 if (res < 0) 
169                         ast_log(LOG_WARNING, "Natural write failed\n");
170                 else if (res > 0)
171                         ast_log(LOG_WARNING, "Huh??\n");
172         } else {
173                 /* XXX If they try to send us a type of frame that isn't the normal frame, and isn't
174                        the one we've setup a translator for, we do the "wrong thing" XXX */
175                 if (fs->trans && f->subclass != fs->lastwriteformat) {
176                         ast_translator_free_path(fs->trans);
177                         fs->trans = NULL;
178                 }
179                 if (!fs->trans) 
180                         fs->trans = ast_translator_build_path(fs->fmt->format, f->subclass);
181                 if (!fs->trans)
182                         ast_log(LOG_WARNING, "Unable to translate to format %s, source format %s\n",
183                                 fs->fmt->name, ast_getformatname(f->subclass));
184                 else {
185                         struct ast_frame *trf;
186                         fs->lastwriteformat = f->subclass;
187                         /* Get the translated frame but don't consume the original in case they're using it on another stream */
188                         trf = ast_translate(fs->trans, f, 0);
189                         if (trf) {
190                                 res = fs->fmt->write(fs, trf);
191                                 ast_frfree(trf);
192                                 if (res) 
193                                         ast_log(LOG_WARNING, "Translated frame write failed\n");
194                         } else
195                                 res = 0;
196                 }
197         }
198         return res;
199 }
200
201 static int copy(const char *infile, const char *outfile)
202 {
203         int ifd, ofd, len;
204         char buf[4096]; /* XXX make it lerger. */
205
206         if ((ifd = open(infile, O_RDONLY)) < 0) {
207                 ast_log(LOG_WARNING, "Unable to open %s in read-only mode\n", infile);
208                 return -1;
209         }
210         if ((ofd = open(outfile, O_WRONLY | O_TRUNC | O_CREAT, AST_FILE_MODE)) < 0) {
211                 ast_log(LOG_WARNING, "Unable to open %s in write-only mode\n", outfile);
212                 close(ifd);
213                 return -1;
214         }
215         while ( (len = read(ifd, buf, sizeof(buf)) ) ) {
216                 int res;
217                 if (len < 0) {
218                         ast_log(LOG_WARNING, "Read failed on %s: %s\n", infile, strerror(errno));
219                         break;
220                 }
221                 /* XXX handle partial writes */
222                 res = write(ofd, buf, len);
223                 if (res != len) {
224                         ast_log(LOG_WARNING, "Write failed on %s (%d of %d): %s\n", outfile, res, len, strerror(errno));
225                         len = -1; /* error marker */
226                         break;
227                 }
228         }
229         close(ifd);
230         close(ofd);
231         if (len < 0) {
232                 unlink(outfile);
233                 return -1; /* error */
234         }
235         return 0;       /* success */
236 }
237
238 /*!
239  * \brief construct a filename. Absolute pathnames are preserved,
240  * relative names are prefixed by the sounds/ directory.
241  * The wav49 suffix is replaced by 'WAV'.
242  * Returns a malloc'ed string to be freed by the caller.
243  */
244 static char *build_filename(const char *filename, const char *ext)
245 {
246         char *fn = NULL;
247
248         if (!strcmp(ext, "wav49"))
249                 ext = "WAV";
250
251         if (filename[0] == '/')
252                 asprintf(&fn, "%s.%s", filename, ext);
253         else
254                 asprintf(&fn, "%s/sounds/%s.%s",
255                         ast_config_AST_DATA_DIR, filename, ext);
256         return fn;
257 }
258
259 /* compare type against the list 'exts' */
260 /* XXX need a better algorithm */
261 static int exts_compare(const char *exts, const char *type)
262 {
263         char tmp[256];
264         char *stringp = tmp, *ext;
265
266         ast_copy_string(tmp, exts, sizeof(tmp));
267         while ((ext = strsep(&stringp, "|"))) {
268                 if (!strcmp(ext, type))
269                         return 1;
270         }
271
272         return 0;
273 }
274
275 static struct ast_filestream *get_filestream(struct ast_format *fmt, FILE *bfile)
276 {
277         struct ast_filestream *s;
278
279         int l = sizeof(*s) + fmt->buf_size + fmt->desc_size;    /* total allocation size */
280         if ( (s = ast_calloc(1, l)) == NULL)
281                 return NULL;
282         s->fmt = fmt;
283         s->f = bfile;
284
285         if (fmt->desc_size)
286                 s->_private = ((char *)(s + 1)) + fmt->buf_size;
287         if (fmt->buf_size)
288                 s->buf = (char *)(s + 1);
289         s->fr.src = fmt->name;
290         return s;
291 }
292
293 /*
294  * Default implementations of open and rewrite.
295  * Only use them if you don't have expensive stuff to do.
296  */
297 enum wrap_fn { WRAP_OPEN, WRAP_REWRITE };
298
299 static int fn_wrapper(struct ast_filestream *s, const char *comment, enum wrap_fn mode)
300 {
301         struct ast_format *f = s->fmt;
302         int ret = -1;
303
304         if (mode == WRAP_OPEN && f->open && f->open(s))
305                 ast_log(LOG_WARNING, "Unable to open format %s\n", f->name);
306         else if (mode == WRAP_REWRITE && f->rewrite && f->rewrite(s, comment))
307                 ast_log(LOG_WARNING, "Unable to rewrite format %s\n", f->name);
308         else {
309                 /* preliminary checks succeed. update usecount */
310                 ast_module_ref(f->module);
311                 ret = 0;
312         }
313         return ret;
314 }
315
316 static int rewrite_wrapper(struct ast_filestream *s, const char *comment)
317 {
318         return fn_wrapper(s, comment, WRAP_REWRITE);
319 }
320
321 static int open_wrapper(struct ast_filestream *s)
322 {
323         return fn_wrapper(s, NULL, WRAP_OPEN);
324 }
325
326 enum file_action {
327         ACTION_EXISTS = 1, /* return matching format if file exists, 0 otherwise */
328         ACTION_DELETE,  /* delete file, return 0 on success, -1 on error */
329         ACTION_RENAME,  /* rename file. return 0 on success, -1 on error */
330         ACTION_OPEN,
331         ACTION_COPY     /* copy file. return 0 on success, -1 on error */
332 };
333
334 /*!
335  * \brief perform various actions on a file. Second argument
336  * arg2 depends on the command:
337  *      unused for EXISTS and DELETE
338  *      destination file name (const char *) for COPY and RENAME
339  *      struct ast_channel * for OPEN
340  * if fmt is NULL, OPEN will return the first matching entry,
341  * whereas other functions will run on all matching entries.
342  */
343 static int ast_filehelper(const char *filename, const void *arg2, const char *fmt, const enum file_action action)
344 {
345         struct ast_format *f;
346         int res = (action == ACTION_EXISTS) ? 0 : -1;
347
348         AST_RWLIST_RDLOCK(&formats);
349         /* Check for a specific format */
350         AST_RWLIST_TRAVERSE(&formats, f, list) {
351                 char *stringp, *ext = NULL;
352
353                 if (fmt && !exts_compare(f->exts, fmt))
354                         continue;
355
356                 /* Look for a file matching the supported extensions.
357                  * The file must exist, and for OPEN, must match
358                  * one of the formats supported by the channel.
359                  */
360                 stringp = ast_strdupa(f->exts); /* this is in the stack so does not need to be freed */
361                 while ( (ext = strsep(&stringp, "|")) ) {
362                         struct stat st;
363                         char *fn = build_filename(filename, ext);
364
365                         if (fn == NULL)
366                                 continue;
367
368                         if ( stat(fn, &st) ) { /* file not existent */
369                                 ast_free(fn);
370                                 continue;
371                         }
372                         /* for 'OPEN' we need to be sure that the format matches
373                          * what the channel can process
374                          */
375                         if (action == ACTION_OPEN) {
376                                 struct ast_channel *chan = (struct ast_channel *)arg2;
377                                 FILE *bfile;
378                                 struct ast_filestream *s;
379
380                                 if ( !(chan->writeformat & f->format) &&
381                                      !(f->format & AST_FORMAT_AUDIO_MASK && fmt)) {
382                                         ast_free(fn);
383                                         continue;       /* not a supported format */
384                                 }
385                                 if ( (bfile = fopen(fn, "r")) == NULL) {
386                                         ast_free(fn);
387                                         continue;       /* cannot open file */
388                                 }
389                                 s = get_filestream(f, bfile);
390                                 if (!s) {
391                                         fclose(bfile);
392                                         ast_free(fn);   /* cannot allocate descriptor */
393                                         continue;
394                                 }
395                                 if (open_wrapper(s)) {
396                                         fclose(bfile);
397                                         ast_free(fn);
398                                         ast_free(s);
399                                         continue;       /* cannot run open on file */
400                                 }
401                                 /* ok this is good for OPEN */
402                                 res = 1;        /* found */
403                                 s->lasttimeout = -1;
404                                 s->fmt = f;
405                                 s->trans = NULL;
406                                 s->filename = NULL;
407                                 if (s->fmt->format & AST_FORMAT_AUDIO_MASK) {
408                                         if (chan->stream)
409                                                 ast_closestream(chan->stream);
410                                         chan->stream = s;
411                                 } else {
412                                         if (chan->vstream)
413                                                 ast_closestream(chan->vstream);
414                                         chan->vstream = s;
415                                 }
416                                 ast_free(fn);
417                                 break;
418                         }
419                         switch (action) {
420                         case ACTION_OPEN:
421                                 break;  /* will never get here */
422
423                         case ACTION_EXISTS:     /* return the matching format */
424                                 res |= f->format;
425                                 break;
426
427                         case ACTION_DELETE:
428                                 if ( (res = unlink(fn)) )
429                                         ast_log(LOG_WARNING, "unlink(%s) failed: %s\n", fn, strerror(errno));
430                                 break;
431
432                         case ACTION_RENAME:
433                         case ACTION_COPY: {
434                                 char *nfn = build_filename((const char *)arg2, ext);
435                                 if (!nfn)
436                                         ast_log(LOG_WARNING, "Out of memory\n");
437                                 else {
438                                         res = action == ACTION_COPY ? copy(fn, nfn) : rename(fn, nfn);
439                                         if (res)
440                                                 ast_log(LOG_WARNING, "%s(%s,%s) failed: %s\n",
441                                                         action == ACTION_COPY ? "copy" : "rename",
442                                                          fn, nfn, strerror(errno));
443                                         ast_free(nfn);
444                                 }
445                             }
446                                 break;
447
448                         default:
449                                 ast_log(LOG_WARNING, "Unknown helper %d\n", action);
450                         }
451                         ast_free(fn);
452                 }
453         }
454         AST_RWLIST_UNLOCK(&formats);
455         return res;
456 }
457
458 static int is_absolute_path(const char *filename)
459 {
460         return filename[0] == '/';
461 }
462
463 static int fileexists_test(const char *filename, const char *fmt, const char *lang,
464                            char *buf, int buflen)
465 {
466         if (buf == NULL) {
467                 return -1;
468         }
469
470         if (ast_language_is_prefix && !is_absolute_path(filename)) { /* new layout */
471                 if (lang) {
472                         snprintf(buf, buflen, "%s/%s", lang, filename);
473                 } else {
474                         snprintf(buf, buflen, "%s", filename);
475                 }
476         } else { /* old layout */
477                 strcpy(buf, filename);  /* first copy the full string */
478                 if (lang) {
479                         /* insert the language and suffix if needed */
480                         const char *c = strrchr(filename, '/');
481                         int offset = c ? c - filename + 1 : 0;  /* points right after the last '/' */
482                         snprintf(buf + offset, buflen - offset, "%s/%s", lang, filename + offset);
483                 }
484         }
485
486         return ast_filehelper(buf, NULL, fmt, ACTION_EXISTS);
487 }
488
489 /*!
490  * \brief helper routine to locate a file with a given format
491  * and language preference.
492  * Try preflang, preflang with stripped '_' suffix, or NULL.
493  * In the standard asterisk, language goes just before the last component.
494  * In an alternative configuration, the language should be a prefix
495  * to the actual filename.
496  *
497  * The last parameter(s) point to a buffer of sufficient size,
498  * which on success is filled with the matching filename.
499  */
500 static int fileexists_core(const char *filename, const char *fmt, const char *preflang,
501                            char *buf, int buflen)
502 {
503         int res = -1;
504         char *lang = NULL;
505
506         if (buf == NULL) {
507                 return -1;
508         }
509
510         /* We try languages in the following order:
511          *    preflang (may include dialect)
512          *    lang (preflang without dialect - if any)
513          *    <none>
514          *    default (unless the same as preflang or lang without dialect)
515          */
516
517         /* Try preferred language */
518         if (!ast_strlen_zero(preflang)) {
519                 /* try the preflang exactly as it was requested */
520                 if ((res = fileexists_test(filename, fmt, preflang, buf, buflen)) > 0) {
521                         return res;
522                 } else {
523                         /* try without a dialect */
524                         char *postfix = NULL;
525                         postfix = lang = ast_strdupa(preflang);
526
527                         strsep(&postfix, "_");
528                         if (postfix) {
529                                 if ((res = fileexists_test(filename, fmt, lang, buf, buflen)) > 0) {
530                                         return res;
531                                 }
532                         }
533                 }
534         }
535
536         /* Try without any language */
537         if ((res = fileexists_test(filename, fmt, NULL, buf, buflen)) > 0) {
538                 return res;
539         }
540
541         /* Finally try the default language unless it was already tried before */
542         if ((ast_strlen_zero(preflang) || strcmp(preflang, DEFAULT_LANGUAGE)) && (ast_strlen_zero(lang) || strcmp(lang, DEFAULT_LANGUAGE))) {
543                 if ((res = fileexists_test(filename, fmt, DEFAULT_LANGUAGE, buf, buflen)) > 0) {
544                         return res;
545                 }
546         }
547
548         return 0;
549 }
550
551 struct ast_filestream *ast_openstream(struct ast_channel *chan, const char *filename, const char *preflang)
552 {
553         return ast_openstream_full(chan, filename, preflang, 0);
554 }
555
556 struct ast_filestream *ast_openstream_full(struct ast_channel *chan, const char *filename, const char *preflang, int asis)
557 {
558         /* 
559          * Use fileexists_core() to find a file in a compatible
560          * language and format, set up a suitable translator,
561          * and open the stream.
562          */
563         int fmts, res, buflen;
564         char *buf;
565
566         if (!asis) {
567                 /* do this first, otherwise we detect the wrong writeformat */
568                 ast_stopstream(chan);
569                 if (chan->generator)
570                         ast_deactivate_generator(chan);
571         }
572         if (preflang == NULL)
573                 preflang = "";
574         buflen = strlen(preflang) + strlen(filename) + 4;
575         buf = alloca(buflen);
576         if (buf == NULL)
577                 return NULL;
578         fmts = fileexists_core(filename, NULL, preflang, buf, buflen);
579         if (fmts > 0)
580                 fmts &= AST_FORMAT_AUDIO_MASK;
581         if (fmts < 1) {
582                 ast_log(LOG_WARNING, "File %s does not exist in any format\n", filename);
583                 return NULL;
584         }
585         chan->oldwriteformat = chan->writeformat;
586         /* Set the channel to a format we can work with */
587         res = ast_set_write_format(chan, fmts);
588         res = ast_filehelper(buf, chan, NULL, ACTION_OPEN);
589         if (res >= 0)
590                 return chan->stream;
591         return NULL;
592 }
593
594 struct ast_filestream *ast_openvstream(struct ast_channel *chan, const char *filename, const char *preflang)
595 {
596         /* As above, but for video. But here we don't have translators
597          * so we must enforce a format.
598          */
599         unsigned int format;
600         char *buf;
601         int buflen;
602
603         if (preflang == NULL)
604                 preflang = "";
605         buflen = strlen(preflang) + strlen(filename) + 4;
606         buf = alloca(buflen);
607         if (buf == NULL)
608                 return NULL;
609
610         for (format = AST_FORMAT_AUDIO_MASK + 1; format <= AST_FORMAT_VIDEO_MASK; format = format << 1) {
611                 int fd;
612                 const char *fmt;
613
614                 if (!(chan->nativeformats & format))
615                         continue;
616                 fmt = ast_getformatname(format);
617                 if ( fileexists_core(filename, fmt, preflang, buf, buflen) < 1) /* no valid format */
618                         continue;
619                 fd = ast_filehelper(buf, chan, fmt, ACTION_OPEN);
620                 if (fd >= 0)
621                         return chan->vstream;
622                 ast_log(LOG_WARNING, "File %s has video but couldn't be opened\n", filename);
623         }
624         return NULL;
625 }
626
627 struct ast_frame *ast_readframe(struct ast_filestream *s)
628 {
629         struct ast_frame *f = NULL;
630         int whennext = 0;       
631         if (s && s->fmt)
632                 f = s->fmt->read(s, &whennext);
633         return f;
634 }
635
636 enum fsread_res {
637         FSREAD_FAILURE,
638         FSREAD_SUCCESS_SCHED,
639         FSREAD_SUCCESS_NOSCHED,
640 };
641
642 static int ast_fsread_audio(const void *data);
643
644 static enum fsread_res ast_readaudio_callback(struct ast_filestream *s)
645 {
646         int whennext = 0;
647
648         while (!whennext) {
649                 struct ast_frame *fr;
650                 
651                 if (s->orig_chan_name && strcasecmp(s->owner->name, s->orig_chan_name))
652                         goto return_failure;
653                 
654                 fr = s->fmt->read(s, &whennext);
655                 if (!fr /* stream complete */ || ast_write(s->owner, fr) /* error writing */) {
656                         if (fr)
657                                 ast_log(LOG_WARNING, "Failed to write frame\n");
658                         goto return_failure;
659                 }
660         }
661         if (whennext != s->lasttimeout) {
662 #ifdef HAVE_ZAPTEL
663                 if (s->owner->timingfd > -1) {
664                         int zap_timer_samples = whennext;
665                         int rate;
666                         /* whennext is in samples, but zaptel timers operate in 8 kHz samples. */
667                         if ((rate = ast_format_rate(s->fmt->format)) != 8000) {
668                                 float factor;
669                                 factor = ((float) rate) / ((float) 8000.0); 
670                                 zap_timer_samples = (int) ( ((float) zap_timer_samples) / factor );
671                         }
672                         ast_settimeout(s->owner, zap_timer_samples, ast_fsread_audio, s);
673                 } else
674 #endif          
675                         s->owner->streamid = ast_sched_add(s->owner->sched, 
676                                 whennext / (ast_format_rate(s->fmt->format) / 1000), ast_fsread_audio, s);
677                 s->lasttimeout = whennext;
678                 return FSREAD_SUCCESS_NOSCHED;
679         }
680         return FSREAD_SUCCESS_SCHED;
681
682 return_failure:
683         s->owner->streamid = -1;
684 #ifdef HAVE_ZAPTEL
685         ast_settimeout(s->owner, 0, NULL, NULL);
686 #endif                  
687         return FSREAD_FAILURE;
688 }
689
690 static int ast_fsread_audio(const void *data)
691 {
692         struct ast_filestream *fs = (struct ast_filestream *)data;
693         enum fsread_res res;
694
695         res = ast_readaudio_callback(fs);
696
697         if (res == FSREAD_SUCCESS_SCHED)
698                 return 1;
699         
700         return 0;
701 }
702
703 static int ast_fsread_video(const void *data);
704
705 static enum fsread_res ast_readvideo_callback(struct ast_filestream *s)
706 {
707         int whennext = 0;
708
709         while (!whennext) {
710                 struct ast_frame *fr = s->fmt->read(s, &whennext);
711                 if (!fr || ast_write(s->owner, fr)) { /* no stream or error, as above */
712                         if (fr)
713                                 ast_log(LOG_WARNING, "Failed to write frame\n");
714                         s->owner->vstreamid = -1;
715                         return FSREAD_FAILURE;
716                 }
717         }
718
719         if (whennext != s->lasttimeout) {
720                 s->owner->vstreamid = ast_sched_add(s->owner->sched, 
721                         whennext / (ast_format_rate(s->fmt->format) / 1000), 
722                         ast_fsread_video, s);
723                 s->lasttimeout = whennext;
724                 return FSREAD_SUCCESS_NOSCHED;
725         }
726
727         return FSREAD_SUCCESS_SCHED;
728 }
729
730 static int ast_fsread_video(const void *data)
731 {
732         struct ast_filestream *fs = (struct ast_filestream *)data;
733         enum fsread_res res;
734
735         res = ast_readvideo_callback(fs);
736
737         if (res == FSREAD_SUCCESS_SCHED)
738                 return 1;
739         
740         return 0;
741 }
742
743 int ast_applystream(struct ast_channel *chan, struct ast_filestream *s)
744 {
745         s->owner = chan;
746         return 0;
747 }
748
749 int ast_playstream(struct ast_filestream *s)
750 {
751         enum fsread_res res;
752
753         if (s->fmt->format & AST_FORMAT_AUDIO_MASK)
754                 res = ast_readaudio_callback(s);
755         else
756                 res = ast_readvideo_callback(s);
757
758         return (res == FSREAD_FAILURE) ? -1 : 0;
759 }
760
761 int ast_seekstream(struct ast_filestream *fs, off_t sample_offset, int whence)
762 {
763         return fs->fmt->seek(fs, sample_offset, whence);
764 }
765
766 int ast_truncstream(struct ast_filestream *fs)
767 {
768         return fs->fmt->trunc(fs);
769 }
770
771 off_t ast_tellstream(struct ast_filestream *fs)
772 {
773         return fs->fmt->tell(fs);
774 }
775
776 int ast_stream_fastforward(struct ast_filestream *fs, off_t ms)
777 {
778         return ast_seekstream(fs, ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
779 }
780
781 int ast_stream_rewind(struct ast_filestream *fs, off_t ms)
782 {
783         return ast_seekstream(fs, -ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
784 }
785
786 int ast_closestream(struct ast_filestream *f)
787 {
788         char *cmd = NULL;
789         size_t size = 0;
790         /* Stop a running stream if there is one */
791         if (f->owner) {
792                 if (f->fmt->format & AST_FORMAT_AUDIO_MASK) {
793                         f->owner->stream = NULL;
794                         AST_SCHED_DEL(f->owner->sched, f->owner->streamid);
795 #ifdef HAVE_ZAPTEL
796                         ast_settimeout(f->owner, 0, NULL, NULL);
797 #endif                  
798                 } else {
799                         f->owner->vstream = NULL;
800                         AST_SCHED_DEL(f->owner->sched, f->owner->vstreamid);
801                 }
802         }
803         /* destroy the translator on exit */
804         if (f->trans)
805                 ast_translator_free_path(f->trans);
806
807         if (f->realfilename && f->filename) {
808                         size = strlen(f->filename) + strlen(f->realfilename) + 15;
809                         cmd = alloca(size);
810                         memset(cmd, 0, size);
811                         snprintf(cmd, size, "/bin/mv -f %s %s", f->filename, f->realfilename);
812                         ast_safe_system(cmd);
813         }
814
815         if (f->fmt->close) {
816                 f->fmt->close(f);
817         }
818         if (f->filename)
819                 ast_free(f->filename);
820         if (f->realfilename)
821                 ast_free(f->realfilename);
822         fclose(f->f);
823         if (f->vfs)
824                 ast_closestream(f->vfs);
825         if (f->orig_chan_name)
826                 free((void *) f->orig_chan_name);
827         if (f->write_buffer) {
828                 ast_free(f->write_buffer);
829         }
830
831         ast_module_unref(f->fmt->module);
832         ast_free(f);
833         return 0;
834 }
835
836
837 /*
838  * Look the various language-specific places where a file could exist.
839  */
840 int ast_fileexists(const char *filename, const char *fmt, const char *preflang)
841 {
842         char *buf;
843         int buflen;
844
845         if (preflang == NULL)
846                 preflang = "";
847         buflen = strlen(preflang) + strlen(filename) + 4;       /* room for everything */
848         buf = alloca(buflen);
849         if (buf == NULL)
850                 return 0;
851         return fileexists_core(filename, fmt, preflang, buf, buflen);
852 }
853
854 int ast_filedelete(const char *filename, const char *fmt)
855 {
856         return ast_filehelper(filename, NULL, fmt, ACTION_DELETE);
857 }
858
859 int ast_filerename(const char *filename, const char *filename2, const char *fmt)
860 {
861         return ast_filehelper(filename, filename2, fmt, ACTION_RENAME);
862 }
863
864 int ast_filecopy(const char *filename, const char *filename2, const char *fmt)
865 {
866         return ast_filehelper(filename, filename2, fmt, ACTION_COPY);
867 }
868
869 int ast_streamfile(struct ast_channel *chan, const char *filename, const char *preflang)
870 {
871         struct ast_filestream *fs;
872         struct ast_filestream *vfs=NULL;
873         char fmt[256];
874
875         fs = ast_openstream(chan, filename, preflang);
876         if (fs)
877                 vfs = ast_openvstream(chan, filename, preflang);
878         if (vfs) {
879                 ast_debug(1, "Ooh, found a video stream, too, format %s\n", ast_getformatname(vfs->fmt->format));
880         }
881         if (fs){
882                 int res;
883                 if (ast_test_flag(chan, AST_FLAG_MASQ_NOSTREAM))
884                         fs->orig_chan_name = ast_strdup(chan->name);
885                 if (ast_applystream(chan, fs))
886                         return -1;
887                 if (vfs && ast_applystream(chan, vfs))
888                         return -1;
889                 res = ast_playstream(fs);
890                 if (!res && vfs)
891                         res = ast_playstream(vfs);
892                 ast_verb(3, "<%s> Playing '%s.%s' (language '%s')\n", chan->name, filename, ast_getformatname(chan->writeformat), preflang ? preflang : "default");
893
894                 return res;
895         }
896         ast_log(LOG_WARNING, "Unable to open %s (format %s): %s\n", filename, ast_getformatname_multiple(fmt, sizeof(fmt), chan->nativeformats), strerror(errno));
897         return -1;
898 }
899
900 struct ast_filestream *ast_readfile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode)
901 {
902         FILE *bfile;
903         struct ast_format *f;
904         struct ast_filestream *fs = NULL;
905         char *fn;
906         int format_found = 0;   
907
908         AST_RWLIST_RDLOCK(&formats);
909
910         AST_RWLIST_TRAVERSE(&formats, f, list) {
911                 fs = NULL;
912                 if (!exts_compare(f->exts, type))
913                         continue;
914                 else 
915                         format_found = 1;
916
917                 fn = build_filename(filename, type);
918                 errno = 0;
919                 bfile = fopen(fn, "r");
920
921                 if (!bfile || (fs = get_filestream(f, bfile)) == NULL || open_wrapper(fs) ) {
922                         ast_log(LOG_WARNING, "Unable to open %s\n", fn);
923                         if (fs)
924                                 ast_free(fs);
925                         if (bfile)
926                                 fclose(bfile);
927                         ast_free(fn);
928                         break;                          
929                 }
930                 /* found it */
931                 fs->trans = NULL;
932                 fs->fmt = f;
933                 fs->flags = flags;
934                 fs->mode = mode;
935                 fs->filename = ast_strdup(filename);
936                 fs->vfs = NULL;
937                 break;
938         }
939
940         AST_RWLIST_UNLOCK(&formats);
941         if (!format_found)
942                 ast_log(LOG_WARNING, "No such format '%s'\n", type);
943
944         return fs;
945 }
946
947 struct ast_filestream *ast_writefile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode)
948 {
949         int fd, myflags = 0;
950         /* compiler claims this variable can be used before initialization... */
951         FILE *bfile = NULL;
952         struct ast_format *f;
953         struct ast_filestream *fs = NULL;
954         char *buf = NULL;
955         size_t size = 0;
956         int format_found = 0;
957
958         AST_RWLIST_RDLOCK(&formats);
959
960         /* set the O_TRUNC flag if and only if there is no O_APPEND specified */
961         /* We really can't use O_APPEND as it will break WAV header updates */
962         if (flags & O_APPEND) { 
963                 flags &= ~O_APPEND;
964         } else {
965                 myflags = O_TRUNC;
966         }
967         
968         myflags |= O_WRONLY | O_CREAT;
969
970         /* XXX need to fix this - we should just do the fopen,
971          * not open followed by fdopen()
972          */
973         AST_RWLIST_TRAVERSE(&formats, f, list) {
974                 char *fn, *orig_fn = NULL;
975                 if (fs)
976                         break;
977
978                 if (!exts_compare(f->exts, type))
979                         continue;
980                 else
981                         format_found = 1;
982
983                 fn = build_filename(filename, type);
984                 fd = open(fn, flags | myflags, mode);
985                 if (fd > -1) {
986                         /* fdopen() the resulting file stream */
987                         bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
988                         if (!bfile) {
989                                 ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
990                                 close(fd);
991                                 fd = -1;
992                         }
993                 }
994                 
995                 if (ast_opt_cache_record_files && (fd > -1)) {
996                         char *c;
997
998                         fclose(bfile);  /* this also closes fd */
999                         /*
1000                           We touch orig_fn just as a place-holder so other things (like vmail) see the file is there.
1001                           What we are really doing is writing to record_cache_dir until we are done then we will mv the file into place.
1002                         */
1003                         orig_fn = ast_strdupa(fn);
1004                         for (c = fn; *c; c++)
1005                                 if (*c == '/')
1006                                         *c = '_';
1007
1008                         size = strlen(fn) + strlen(record_cache_dir) + 2;
1009                         buf = alloca(size);
1010                         strcpy(buf, record_cache_dir);
1011                         strcat(buf, "/");
1012                         strcat(buf, fn);
1013                         ast_free(fn);
1014                         fn = buf;
1015                         fd = open(fn, flags | myflags, mode);
1016                         if (fd > -1) {
1017                                 /* fdopen() the resulting file stream */
1018                                 bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
1019                                 if (!bfile) {
1020                                         ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
1021                                         close(fd);
1022                                         fd = -1;
1023                                 }
1024                         }
1025                 }
1026                 if (fd > -1) {
1027                         errno = 0;
1028                         fs = get_filestream(f, bfile);
1029                         if (!fs || rewrite_wrapper(fs, comment)) {
1030                                 ast_log(LOG_WARNING, "Unable to rewrite %s\n", fn);
1031                                 close(fd);
1032                                 if (orig_fn) {
1033                                         unlink(fn);
1034                                         unlink(orig_fn);
1035                                 }
1036                                 if (fs)
1037                                         ast_free(fs);
1038                                 fs = NULL;
1039                                 continue;
1040                         }
1041                         fs->trans = NULL;
1042                         fs->fmt = f;
1043                         fs->flags = flags;
1044                         fs->mode = mode;
1045                         if (orig_fn) {
1046                                 fs->realfilename = ast_strdup(orig_fn);
1047                                 fs->filename = ast_strdup(fn);
1048                         } else {
1049                                 fs->realfilename = NULL;
1050                                 fs->filename = ast_strdup(filename);
1051                         }
1052                         fs->vfs = NULL;
1053                         /* If truncated, we'll be at the beginning; if not truncated, then append */
1054
1055                         if ((fs->write_buffer = ast_malloc(32768))){
1056                                 setvbuf(fs->f, fs->write_buffer, _IOFBF, 32768);
1057                         }
1058
1059                         f->seek(fs, 0, SEEK_END);
1060                 } else if (errno != EEXIST) {
1061                         ast_log(LOG_WARNING, "Unable to open file %s: %s\n", fn, strerror(errno));
1062                         if (orig_fn)
1063                                 unlink(orig_fn);
1064                 }
1065                 /* if buf != NULL then fn is already free and pointing to it */
1066                 if (!buf)
1067                         ast_free(fn);
1068         }
1069
1070         AST_RWLIST_UNLOCK(&formats);
1071
1072         if (!format_found)
1073                 ast_log(LOG_WARNING, "No such format '%s'\n", type);
1074
1075         return fs;
1076 }
1077
1078 /*!
1079  * \brief the core of all waitstream() functions
1080  */
1081 static int waitstream_core(struct ast_channel *c, const char *breakon,
1082         const char *forward, const char *rewind, int skip_ms,
1083         int audiofd, int cmdfd,  const char *context)
1084 {
1085         const char *orig_chan_name = NULL;
1086         int err = 0;
1087
1088         if (!breakon)
1089                 breakon = "";
1090         if (!forward)
1091                 forward = "";
1092         if (!rewind)
1093                 rewind = "";
1094
1095         /* Switch the channel to end DTMF frame only. waitstream_core doesn't care about the start of DTMF. */
1096         ast_set_flag(c, AST_FLAG_END_DTMF_ONLY);
1097
1098         if (ast_test_flag(c, AST_FLAG_MASQ_NOSTREAM))
1099                 orig_chan_name = ast_strdupa(c->name);
1100
1101         while (c->stream) {
1102                 int res;
1103                 int ms;
1104
1105                 if (orig_chan_name && strcasecmp(orig_chan_name, c->name)) {
1106                         ast_stopstream(c);
1107                         err = 1;
1108                         break;
1109                 }
1110
1111                 ms = ast_sched_wait(c->sched);
1112
1113                 if (ms < 0 && !c->timingfunc) {
1114                         ast_stopstream(c);
1115                         break;
1116                 }
1117                 if (ms < 0)
1118                         ms = 1000;
1119                 if (cmdfd < 0) {
1120                         res = ast_waitfor(c, ms);
1121                         if (res < 0) {
1122                                 ast_log(LOG_WARNING, "Select failed (%s)\n", strerror(errno));
1123                                 ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1124                                 return res;
1125                         }
1126                 } else {
1127                         int outfd;
1128                         struct ast_channel *rchan = ast_waitfor_nandfds(&c, 1, &cmdfd, (cmdfd > -1) ? 1 : 0, NULL, &outfd, &ms);
1129                         if (!rchan && (outfd < 0) && (ms)) {
1130                                 /* Continue */
1131                                 if (errno == EINTR)
1132                                         continue;
1133                                 ast_log(LOG_WARNING, "Wait failed (%s)\n", strerror(errno));
1134                                 ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1135                                 return -1;
1136                         } else if (outfd > -1) { /* this requires cmdfd set */
1137                                 /* The FD we were watching has something waiting */
1138                                 ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1139                                 return 1;
1140                         }
1141                         /* if rchan is set, it is 'c' */
1142                         res = rchan ? 1 : 0; /* map into 'res' values */
1143                 }
1144                 if (res > 0) {
1145                         struct ast_frame *fr = ast_read(c);
1146                         if (!fr) {
1147                                 ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1148                                 return -1;
1149                         }
1150                         switch (fr->frametype) {
1151                         case AST_FRAME_DTMF_END:
1152                                 if (context) {
1153                                         const char exten[2] = { fr->subclass, '\0' };
1154                                         if (ast_exists_extension(c, context, exten, 1, c->cid.cid_num)) {
1155                                                 res = fr->subclass;
1156                                                 ast_frfree(fr);
1157                                                 ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1158                                                 return res;
1159                                         }
1160                                 } else {
1161                                         res = fr->subclass;
1162                                         if (strchr(forward, res)) {
1163                                                 ast_stream_fastforward(c->stream, skip_ms);
1164                                         } else if (strchr(rewind, res)) {
1165                                                 ast_stream_rewind(c->stream, skip_ms);
1166                                         } else if (strchr(breakon, res)) {
1167                                                 ast_frfree(fr);
1168                                                 ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1169                                                 return res;
1170                                         }                                       
1171                                 }
1172                                 break;
1173                         case AST_FRAME_CONTROL:
1174                                 switch (fr->subclass) {
1175                                 case AST_CONTROL_HANGUP:
1176                                 case AST_CONTROL_BUSY:
1177                                 case AST_CONTROL_CONGESTION:
1178                                         ast_frfree(fr);
1179                                         ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1180                                         return -1;
1181                                 case AST_CONTROL_RINGING:
1182                                 case AST_CONTROL_ANSWER:
1183                                 case AST_CONTROL_VIDUPDATE:
1184                                 case AST_CONTROL_SRCUPDATE:
1185                                 case AST_CONTROL_HOLD:
1186                                 case AST_CONTROL_UNHOLD:
1187                                         /* Unimportant */
1188                                         break;
1189                                 default:
1190                                         ast_log(LOG_WARNING, "Unexpected control subclass '%d'\n", fr->subclass);
1191                                 }
1192                                 break;
1193                         case AST_FRAME_VOICE:
1194                                 /* Write audio if appropriate */
1195                                 if (audiofd > -1)
1196                                         write(audiofd, fr->data.ptr, fr->datalen);
1197                         default:
1198                                 /* Ignore all others */
1199                                 break;
1200                         }
1201                         ast_frfree(fr);
1202                 }
1203                 ast_sched_runq(c->sched);
1204         }
1205
1206         ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1207
1208         return (err || c->_softhangup) ? -1 : 0;
1209 }
1210
1211 int ast_waitstream_fr(struct ast_channel *c, const char *breakon, const char *forward, const char *rewind, int ms)
1212 {
1213         return waitstream_core(c, breakon, forward, rewind, ms,
1214                 -1 /* no audiofd */, -1 /* no cmdfd */, NULL /* no context */);
1215 }
1216
1217 int ast_waitstream(struct ast_channel *c, const char *breakon)
1218 {
1219         return waitstream_core(c, breakon, NULL, NULL, 0, -1, -1, NULL);
1220 }
1221
1222 int ast_waitstream_full(struct ast_channel *c, const char *breakon, int audiofd, int cmdfd)
1223 {
1224         return waitstream_core(c, breakon, NULL, NULL, 0,
1225                 audiofd, cmdfd, NULL /* no context */);
1226 }
1227
1228 int ast_waitstream_exten(struct ast_channel *c, const char *context)
1229 {
1230         /* Waitstream, with return in the case of a valid 1 digit extension */
1231         /* in the current or specified context being pressed */
1232
1233         if (!context)
1234                 context = c->context;
1235         return waitstream_core(c, NULL, NULL, NULL, 0,
1236                 -1, -1, context);
1237 }
1238
1239 /*
1240  * if the file name is non-empty, try to play it.
1241  * Return 0 if success, -1 if error, digit if interrupted by a digit.
1242  * If digits == "" then we can simply check for non-zero.
1243  */
1244 int ast_stream_and_wait(struct ast_channel *chan, const char *file, const char *digits)
1245 {
1246         int res = 0;
1247         if (!ast_strlen_zero(file)) {
1248                 res = ast_streamfile(chan, file, chan->language);
1249                 if (!res) {
1250                         res = ast_waitstream(chan, digits);
1251                 }
1252         }
1253         return res;
1254
1255
1256 static char *handle_cli_core_show_file_formats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1257 {
1258 #define FORMAT "%-10s %-10s %-20s\n"
1259 #define FORMAT2 "%-10s %-10s %-20s\n"
1260         struct ast_format *f;
1261         int count_fmt = 0;
1262
1263         switch (cmd) {
1264         case CLI_INIT:
1265                 e->command = "core show file formats";
1266                 e->usage =
1267                         "Usage: core show file formats\n"
1268                         "       Displays currently registered file formats (if any).\n";
1269                 return NULL;
1270         case CLI_GENERATE:
1271                 return NULL;
1272         }
1273
1274         if (a->argc != 4)
1275                 return CLI_SHOWUSAGE;
1276
1277         ast_cli(a->fd, FORMAT, "Format", "Name", "Extensions");
1278         ast_cli(a->fd, FORMAT, "------", "----", "----------");
1279
1280         AST_RWLIST_RDLOCK(&formats);
1281         AST_RWLIST_TRAVERSE(&formats, f, list) {
1282                 ast_cli(a->fd, FORMAT2, ast_getformatname(f->format), f->name, f->exts);
1283                 count_fmt++;
1284         }
1285         AST_RWLIST_UNLOCK(&formats);
1286         ast_cli(a->fd, "%d file formats registered.\n", count_fmt);
1287         return CLI_SUCCESS;
1288 #undef FORMAT
1289 #undef FORMAT2
1290 }
1291
1292 struct ast_cli_entry cli_file[] = {
1293         AST_CLI_DEFINE(handle_cli_core_show_file_formats, "Displays file formats")
1294 };
1295
1296 int ast_file_init(void)
1297 {
1298         ast_cli_register_multiple(cli_file, sizeof(cli_file) / sizeof(struct ast_cli_entry));
1299         return 0;
1300 }