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