Whitespace changes only
[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 /*!
459  * \brief helper routine to locate a file with a given format
460  * and language preference.
461  * Try preflang, preflang with stripped '_' suffix, or NULL.
462  * In the standard asterisk, language goes just before the last component.
463  * In an alternative configuration, the language should be a prefix
464  * to the actual filename.
465  *
466  * The last parameter(s) point to a buffer of sufficient size,
467  * which on success is filled with the matching filename.
468  */
469 static int fileexists_core(const char *filename, const char *fmt, const char *preflang,
470                            char *buf, int buflen)
471 {
472         int res = -1;
473         int langlen;    /* length of language string */
474         const char *c = strrchr(filename, '/');
475         int offset = c ? c - filename + 1 : 0;  /* points right after the last '/' */
476
477         if (preflang == NULL) {
478                 preflang = "";
479         }
480         langlen = strlen(preflang);
481         
482         if (buflen < langlen + strlen(filename) + 4) {
483                 ast_log(LOG_WARNING, "buffer too small, allocating larger buffer\n");
484                 buf = alloca(langlen + strlen(filename) + 4);   /* room for everything */
485         }
486
487         if (buf == NULL) {
488                 return 0;
489         }
490
491         for (;;) {
492                 if (ast_language_is_prefix) { /* new layout */
493                         if (langlen) {
494                                 strcpy(buf, preflang);
495                                 buf[langlen] = '/';
496                                 strcpy(buf + langlen + 1, filename);
497                         } else {
498                                 strcpy(buf, "en/"); /* English - fallback if no file found in preferred language */
499                                 strcpy(buf + 3, filename);
500                         }
501                 } else { /* old layout */
502                         strcpy(buf, filename);  /* first copy the full string */
503                         if (langlen) {
504                                 /* insert the language and suffix if needed */
505                                 strcpy(buf + offset, preflang);
506                                 sprintf(buf + offset + langlen, "/%s", filename + offset);
507                         }
508                 }
509                 res = ast_filehelper(buf, NULL, fmt, ACTION_EXISTS);
510                 if (res > 0) {          /* found format */
511                         break;
512                 }
513                 if (langlen == 0) {     /* no more formats */
514                         break;
515                 }
516                 if (preflang[langlen] == '_') { /* we are on the local suffix */
517                         langlen = 0;    /* try again with no language */
518                 } else {
519                         langlen = (c = strchr(preflang, '_')) ? c - preflang : 0;
520                 }
521         }
522
523         return res;
524 }
525
526 struct ast_filestream *ast_openstream(struct ast_channel *chan, const char *filename, const char *preflang)
527 {
528         return ast_openstream_full(chan, filename, preflang, 0);
529 }
530
531 struct ast_filestream *ast_openstream_full(struct ast_channel *chan, const char *filename, const char *preflang, int asis)
532 {
533         /* 
534          * Use fileexists_core() to find a file in a compatible
535          * language and format, set up a suitable translator,
536          * and open the stream.
537          */
538         int fmts, res, buflen;
539         char *buf;
540
541         if (!asis) {
542                 /* do this first, otherwise we detect the wrong writeformat */
543                 ast_stopstream(chan);
544                 if (chan->generator)
545                         ast_deactivate_generator(chan);
546         }
547         if (preflang == NULL)
548                 preflang = "";
549         buflen = strlen(preflang) + strlen(filename) + 4;
550         buf = alloca(buflen);
551         if (buf == NULL)
552                 return NULL;
553         fmts = fileexists_core(filename, NULL, preflang, buf, buflen);
554         if (fmts > 0)
555                 fmts &= AST_FORMAT_AUDIO_MASK;
556         if (fmts < 1) {
557                 ast_log(LOG_WARNING, "File %s does not exist in any format\n", filename);
558                 return NULL;
559         }
560         chan->oldwriteformat = chan->writeformat;
561         /* Set the channel to a format we can work with */
562         res = ast_set_write_format(chan, fmts);
563         res = ast_filehelper(buf, chan, NULL, ACTION_OPEN);
564         if (res >= 0)
565                 return chan->stream;
566         return NULL;
567 }
568
569 struct ast_filestream *ast_openvstream(struct ast_channel *chan, const char *filename, const char *preflang)
570 {
571         /* As above, but for video. But here we don't have translators
572          * so we must enforce a format.
573          */
574         unsigned int format;
575         char *buf;
576         int buflen;
577
578         if (preflang == NULL)
579                 preflang = "";
580         buflen = strlen(preflang) + strlen(filename) + 4;
581         buf = alloca(buflen);
582         if (buf == NULL)
583                 return NULL;
584
585         for (format = AST_FORMAT_AUDIO_MASK + 1; format <= AST_FORMAT_VIDEO_MASK; format = format << 1) {
586                 int fd;
587                 const char *fmt;
588
589                 if (!(chan->nativeformats & format))
590                         continue;
591                 fmt = ast_getformatname(format);
592                 if ( fileexists_core(filename, fmt, preflang, buf, buflen) < 1) /* no valid format */
593                         continue;
594                 fd = ast_filehelper(buf, chan, fmt, ACTION_OPEN);
595                 if (fd >= 0)
596                         return chan->vstream;
597                 ast_log(LOG_WARNING, "File %s has video but couldn't be opened\n", filename);
598         }
599         return NULL;
600 }
601
602 struct ast_frame *ast_readframe(struct ast_filestream *s)
603 {
604         struct ast_frame *f = NULL;
605         int whennext = 0;       
606         if (s && s->fmt)
607                 f = s->fmt->read(s, &whennext);
608         return f;
609 }
610
611 enum fsread_res {
612         FSREAD_FAILURE,
613         FSREAD_SUCCESS_SCHED,
614         FSREAD_SUCCESS_NOSCHED,
615 };
616
617 static int ast_fsread_audio(const void *data);
618
619 static enum fsread_res ast_readaudio_callback(struct ast_filestream *s)
620 {
621         int whennext = 0;
622
623         while (!whennext) {
624                 struct ast_frame *fr;
625                 
626                 if (s->orig_chan_name && strcasecmp(s->owner->name, s->orig_chan_name))
627                         goto return_failure;
628                 
629                 fr = s->fmt->read(s, &whennext);
630                 if (!fr /* stream complete */ || ast_write(s->owner, fr) /* error writing */) {
631                         if (fr)
632                                 ast_log(LOG_WARNING, "Failed to write frame\n");
633                         goto return_failure;
634                 }
635         }
636         if (whennext != s->lasttimeout) {
637 #ifdef HAVE_ZAPTEL
638                 if (s->owner->timingfd > -1)
639                         ast_settimeout(s->owner, whennext, ast_fsread_audio, s);
640                 else
641 #endif          
642                         s->owner->streamid = ast_sched_add(s->owner->sched, whennext / 8, ast_fsread_audio, s);
643                 s->lasttimeout = whennext;
644                 return FSREAD_SUCCESS_NOSCHED;
645         }
646         return FSREAD_SUCCESS_SCHED;
647
648 return_failure:
649         s->owner->streamid = -1;
650 #ifdef HAVE_ZAPTEL
651         ast_settimeout(s->owner, 0, NULL, NULL);
652 #endif                  
653         return FSREAD_FAILURE;
654 }
655
656 static int ast_fsread_audio(const void *data)
657 {
658         struct ast_filestream *fs = (struct ast_filestream *)data;
659         enum fsread_res res;
660
661         res = ast_readaudio_callback(fs);
662
663         if (res == FSREAD_SUCCESS_SCHED)
664                 return 1;
665         
666         return 0;
667 }
668
669 static int ast_fsread_video(const void *data);
670
671 static enum fsread_res ast_readvideo_callback(struct ast_filestream *s)
672 {
673         int whennext = 0;
674
675         while (!whennext) {
676                 struct ast_frame *fr = s->fmt->read(s, &whennext);
677                 if (!fr || ast_write(s->owner, fr)) { /* no stream or error, as above */
678                         if (fr)
679                                 ast_log(LOG_WARNING, "Failed to write frame\n");
680                         s->owner->vstreamid = -1;
681                         return FSREAD_FAILURE;
682                 }
683         }
684
685         if (whennext != s->lasttimeout) {
686                 s->owner->vstreamid = ast_sched_add(s->owner->sched, whennext / 8, 
687                         ast_fsread_video, s);
688                 s->lasttimeout = whennext;
689                 return FSREAD_SUCCESS_NOSCHED;
690         }
691
692         return FSREAD_SUCCESS_SCHED;
693 }
694
695 static int ast_fsread_video(const void *data)
696 {
697         struct ast_filestream *fs = (struct ast_filestream *)data;
698         enum fsread_res res;
699
700         res = ast_readvideo_callback(fs);
701
702         if (res == FSREAD_SUCCESS_SCHED)
703                 return 1;
704         
705         return 0;
706 }
707
708 int ast_applystream(struct ast_channel *chan, struct ast_filestream *s)
709 {
710         s->owner = chan;
711         return 0;
712 }
713
714 int ast_playstream(struct ast_filestream *s)
715 {
716         enum fsread_res res;
717
718         if (s->fmt->format & AST_FORMAT_AUDIO_MASK)
719                 res = ast_readaudio_callback(s);
720         else
721                 res = ast_readvideo_callback(s);
722
723         return (res == FSREAD_FAILURE) ? -1 : 0;
724 }
725
726 int ast_seekstream(struct ast_filestream *fs, off_t sample_offset, int whence)
727 {
728         return fs->fmt->seek(fs, sample_offset, whence);
729 }
730
731 int ast_truncstream(struct ast_filestream *fs)
732 {
733         return fs->fmt->trunc(fs);
734 }
735
736 off_t ast_tellstream(struct ast_filestream *fs)
737 {
738         return fs->fmt->tell(fs);
739 }
740
741 int ast_stream_fastforward(struct ast_filestream *fs, off_t ms)
742 {
743         return ast_seekstream(fs, ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
744 }
745
746 int ast_stream_rewind(struct ast_filestream *fs, off_t ms)
747 {
748         return ast_seekstream(fs, -ms * DEFAULT_SAMPLES_PER_MS, SEEK_CUR);
749 }
750
751 int ast_closestream(struct ast_filestream *f)
752 {
753         char *cmd = NULL;
754         size_t size = 0;
755         /* Stop a running stream if there is one */
756         if (f->owner) {
757                 if (f->fmt->format & AST_FORMAT_AUDIO_MASK) {
758                         f->owner->stream = NULL;
759                         AST_SCHED_DEL(f->owner->sched, f->owner->streamid);
760 #ifdef HAVE_ZAPTEL
761                         ast_settimeout(f->owner, 0, NULL, NULL);
762 #endif                  
763                 } else {
764                         f->owner->vstream = NULL;
765                         AST_SCHED_DEL(f->owner->sched, f->owner->vstreamid);
766                 }
767         }
768         /* destroy the translator on exit */
769         if (f->trans)
770                 ast_translator_free_path(f->trans);
771
772         if (f->realfilename && f->filename) {
773                         size = strlen(f->filename) + strlen(f->realfilename) + 15;
774                         cmd = alloca(size);
775                         memset(cmd, 0, size);
776                         snprintf(cmd, size, "/bin/mv -f %s %s", f->filename, f->realfilename);
777                         ast_safe_system(cmd);
778         }
779
780         if (f->filename)
781                 ast_free(f->filename);
782         if (f->realfilename)
783                 ast_free(f->realfilename);
784         if (f->fmt->close)
785                 f->fmt->close(f);
786         fclose(f->f);
787         if (f->vfs)
788                 ast_closestream(f->vfs);
789         if (f->orig_chan_name)
790                 free((void *) f->orig_chan_name);
791         ast_module_unref(f->fmt->module);
792         ast_free(f);
793         return 0;
794 }
795
796
797 /*
798  * Look the various language-specific places where a file could exist.
799  */
800 int ast_fileexists(const char *filename, const char *fmt, const char *preflang)
801 {
802         char *buf;
803         int buflen;
804
805         if (preflang == NULL)
806                 preflang = "";
807         buflen = strlen(preflang) + strlen(filename) + 4;       /* room for everything */
808         buf = alloca(buflen);
809         if (buf == NULL)
810                 return 0;
811         return fileexists_core(filename, fmt, preflang, buf, buflen);
812 }
813
814 int ast_filedelete(const char *filename, const char *fmt)
815 {
816         return ast_filehelper(filename, NULL, fmt, ACTION_DELETE);
817 }
818
819 int ast_filerename(const char *filename, const char *filename2, const char *fmt)
820 {
821         return ast_filehelper(filename, filename2, fmt, ACTION_RENAME);
822 }
823
824 int ast_filecopy(const char *filename, const char *filename2, const char *fmt)
825 {
826         return ast_filehelper(filename, filename2, fmt, ACTION_COPY);
827 }
828
829 int ast_streamfile(struct ast_channel *chan, const char *filename, const char *preflang)
830 {
831         struct ast_filestream *fs;
832         struct ast_filestream *vfs=NULL;
833         char fmt[256];
834
835         fs = ast_openstream(chan, filename, preflang);
836         if (fs)
837                 vfs = ast_openvstream(chan, filename, preflang);
838         if (vfs) {
839                 ast_debug(1, "Ooh, found a video stream, too, format %s\n", ast_getformatname(vfs->fmt->format));
840         }
841         if (fs){
842                 int res;
843                 if (ast_test_flag(chan, AST_FLAG_MASQ_NOSTREAM))
844                         fs->orig_chan_name = ast_strdup(chan->name);
845                 if (ast_applystream(chan, fs))
846                         return -1;
847                 if (vfs && ast_applystream(chan, vfs))
848                         return -1;
849                 res = ast_playstream(fs);
850                 if (!res && vfs)
851                         res = ast_playstream(vfs);
852                 ast_verb(3, "<%s> Playing '%s.%s' (language '%s')\n", chan->name, filename, ast_getformatname(chan->writeformat), preflang ? preflang : "default");
853
854                 return res;
855         }
856         ast_log(LOG_WARNING, "Unable to open %s (format %s): %s\n", filename, ast_getformatname_multiple(fmt, sizeof(fmt), chan->nativeformats), strerror(errno));
857         return -1;
858 }
859
860 struct ast_filestream *ast_readfile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode)
861 {
862         FILE *bfile;
863         struct ast_format *f;
864         struct ast_filestream *fs = NULL;
865         char *fn;
866         int format_found = 0;   
867
868         AST_RWLIST_RDLOCK(&formats);
869
870         AST_RWLIST_TRAVERSE(&formats, f, list) {
871                 fs = NULL;
872                 if (!exts_compare(f->exts, type))
873                         continue;
874                 else 
875                         format_found = 1;
876
877                 fn = build_filename(filename, type);
878                 errno = 0;
879                 bfile = fopen(fn, "r");
880
881                 if (!bfile || (fs = get_filestream(f, bfile)) == NULL || open_wrapper(fs) ) {
882                         ast_log(LOG_WARNING, "Unable to open %s\n", fn);
883                         if (fs)
884                                 ast_free(fs);
885                         if (bfile)
886                                 fclose(bfile);
887                         ast_free(fn);
888                         break;                          
889                 }
890                 /* found it */
891                 fs->trans = NULL;
892                 fs->fmt = f;
893                 fs->flags = flags;
894                 fs->mode = mode;
895                 fs->filename = ast_strdup(filename);
896                 fs->vfs = NULL;
897                 break;
898         }
899
900         AST_RWLIST_UNLOCK(&formats);
901         if (!format_found)
902                 ast_log(LOG_WARNING, "No such format '%s'\n", type);
903
904         return fs;
905 }
906
907 struct ast_filestream *ast_writefile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode)
908 {
909         int fd, myflags = 0;
910         /* compiler claims this variable can be used before initialization... */
911         FILE *bfile = NULL;
912         struct ast_format *f;
913         struct ast_filestream *fs = NULL;
914         char *buf = NULL;
915         size_t size = 0;
916         int format_found = 0;
917
918         AST_RWLIST_RDLOCK(&formats);
919
920         /* set the O_TRUNC flag if and only if there is no O_APPEND specified */
921         /* We really can't use O_APPEND as it will break WAV header updates */
922         if (flags & O_APPEND) { 
923                 flags &= ~O_APPEND;
924         } else {
925                 myflags = O_TRUNC;
926         }
927         
928         myflags |= O_WRONLY | O_CREAT;
929
930         /* XXX need to fix this - we should just do the fopen,
931          * not open followed by fdopen()
932          */
933         AST_RWLIST_TRAVERSE(&formats, f, list) {
934                 char *fn, *orig_fn = NULL;
935                 if (fs)
936                         break;
937
938                 if (!exts_compare(f->exts, type))
939                         continue;
940                 else
941                         format_found = 1;
942
943                 fn = build_filename(filename, type);
944                 fd = open(fn, flags | myflags, mode);
945                 if (fd > -1) {
946                         /* fdopen() the resulting file stream */
947                         bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
948                         if (!bfile) {
949                                 ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
950                                 close(fd);
951                                 fd = -1;
952                         }
953                 }
954                 
955                 if (ast_opt_cache_record_files && (fd > -1)) {
956                         char *c;
957
958                         fclose(bfile);  /* this also closes fd */
959                         /*
960                           We touch orig_fn just as a place-holder so other things (like vmail) see the file is there.
961                           What we are really doing is writing to record_cache_dir until we are done then we will mv the file into place.
962                         */
963                         orig_fn = ast_strdupa(fn);
964                         for (c = fn; *c; c++)
965                                 if (*c == '/')
966                                         *c = '_';
967
968                         size = strlen(fn) + strlen(record_cache_dir) + 2;
969                         buf = alloca(size);
970                         strcpy(buf, record_cache_dir);
971                         strcat(buf, "/");
972                         strcat(buf, fn);
973                         ast_free(fn);
974                         fn = buf;
975                         fd = open(fn, flags | myflags, mode);
976                         if (fd > -1) {
977                                 /* fdopen() the resulting file stream */
978                                 bfile = fdopen(fd, ((flags | myflags) & O_RDWR) ? "w+" : "w");
979                                 if (!bfile) {
980                                         ast_log(LOG_WARNING, "Whoa, fdopen failed: %s!\n", strerror(errno));
981                                         close(fd);
982                                         fd = -1;
983                                 }
984                         }
985                 }
986                 if (fd > -1) {
987                         errno = 0;
988                         fs = get_filestream(f, bfile);
989                         if (!fs || rewrite_wrapper(fs, comment)) {
990                                 ast_log(LOG_WARNING, "Unable to rewrite %s\n", fn);
991                                 close(fd);
992                                 if (orig_fn) {
993                                         unlink(fn);
994                                         unlink(orig_fn);
995                                 }
996                                 if (fs)
997                                         ast_free(fs);
998                                 fs = NULL;
999                                 continue;
1000                         }
1001                         fs->trans = NULL;
1002                         fs->fmt = f;
1003                         fs->flags = flags;
1004                         fs->mode = mode;
1005                         if (orig_fn) {
1006                                 fs->realfilename = ast_strdup(orig_fn);
1007                                 fs->filename = ast_strdup(fn);
1008                         } else {
1009                                 fs->realfilename = NULL;
1010                                 fs->filename = ast_strdup(filename);
1011                         }
1012                         fs->vfs = NULL;
1013                         /* If truncated, we'll be at the beginning; if not truncated, then append */
1014                         f->seek(fs, 0, SEEK_END);
1015                 } else if (errno != EEXIST) {
1016                         ast_log(LOG_WARNING, "Unable to open file %s: %s\n", fn, strerror(errno));
1017                         if (orig_fn)
1018                                 unlink(orig_fn);
1019                 }
1020                 /* if buf != NULL then fn is already free and pointing to it */
1021                 if (!buf)
1022                         ast_free(fn);
1023         }
1024
1025         AST_RWLIST_UNLOCK(&formats);
1026
1027         if (!format_found)
1028                 ast_log(LOG_WARNING, "No such format '%s'\n", type);
1029
1030         return fs;
1031 }
1032
1033 /*!
1034  * \brief the core of all waitstream() functions
1035  */
1036 static int waitstream_core(struct ast_channel *c, const char *breakon,
1037         const char *forward, const char *rewind, int skip_ms,
1038         int audiofd, int cmdfd,  const char *context)
1039 {
1040         const char *orig_chan_name = NULL;
1041         int err = 0;
1042
1043         if (!breakon)
1044                 breakon = "";
1045         if (!forward)
1046                 forward = "";
1047         if (!rewind)
1048                 rewind = "";
1049
1050         /* Switch the channel to end DTMF frame only. waitstream_core doesn't care about the start of DTMF. */
1051         ast_set_flag(c, AST_FLAG_END_DTMF_ONLY);
1052
1053         if (ast_test_flag(c, AST_FLAG_MASQ_NOSTREAM))
1054                 orig_chan_name = ast_strdupa(c->name);
1055
1056         while (c->stream) {
1057                 int res;
1058                 int ms;
1059
1060                 if (orig_chan_name && strcasecmp(orig_chan_name, c->name)) {
1061                         ast_stopstream(c);
1062                         err = 1;
1063                         break;
1064                 }
1065
1066                 ms = ast_sched_wait(c->sched);
1067
1068                 if (ms < 0 && !c->timingfunc) {
1069                         ast_stopstream(c);
1070                         break;
1071                 }
1072                 if (ms < 0)
1073                         ms = 1000;
1074                 if (cmdfd < 0) {
1075                         res = ast_waitfor(c, ms);
1076                         if (res < 0) {
1077                                 ast_log(LOG_WARNING, "Select failed (%s)\n", strerror(errno));
1078                                 ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1079                                 return res;
1080                         }
1081                 } else {
1082                         int outfd;
1083                         struct ast_channel *rchan = ast_waitfor_nandfds(&c, 1, &cmdfd, (cmdfd > -1) ? 1 : 0, NULL, &outfd, &ms);
1084                         if (!rchan && (outfd < 0) && (ms)) {
1085                                 /* Continue */
1086                                 if (errno == EINTR)
1087                                         continue;
1088                                 ast_log(LOG_WARNING, "Wait failed (%s)\n", strerror(errno));
1089                                 ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1090                                 return -1;
1091                         } else if (outfd > -1) { /* this requires cmdfd set */
1092                                 /* The FD we were watching has something waiting */
1093                                 ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1094                                 return 1;
1095                         }
1096                         /* if rchan is set, it is 'c' */
1097                         res = rchan ? 1 : 0; /* map into 'res' values */
1098                 }
1099                 if (res > 0) {
1100                         struct ast_frame *fr = ast_read(c);
1101                         if (!fr) {
1102                                 ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1103                                 return -1;
1104                         }
1105                         switch (fr->frametype) {
1106                         case AST_FRAME_DTMF_END:
1107                                 if (context) {
1108                                         const char exten[2] = { fr->subclass, '\0' };
1109                                         if (ast_exists_extension(c, context, exten, 1, c->cid.cid_num)) {
1110                                                 res = fr->subclass;
1111                                                 ast_frfree(fr);
1112                                                 ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1113                                                 return res;
1114                                         }
1115                                 } else {
1116                                         res = fr->subclass;
1117                                         if (strchr(forward, res)) {
1118                                                 ast_stream_fastforward(c->stream, skip_ms);
1119                                         } else if (strchr(rewind, res)) {
1120                                                 ast_stream_rewind(c->stream, skip_ms);
1121                                         } else if (strchr(breakon, res)) {
1122                                                 ast_frfree(fr);
1123                                                 ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1124                                                 return res;
1125                                         }                                       
1126                                 }
1127                                 break;
1128                         case AST_FRAME_CONTROL:
1129                                 switch (fr->subclass) {
1130                                 case AST_CONTROL_HANGUP:
1131                                 case AST_CONTROL_BUSY:
1132                                 case AST_CONTROL_CONGESTION:
1133                                         ast_frfree(fr);
1134                                         ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1135                                         return -1;
1136                                 case AST_CONTROL_RINGING:
1137                                 case AST_CONTROL_ANSWER:
1138                                 case AST_CONTROL_VIDUPDATE:
1139                                 case AST_CONTROL_HOLD:
1140                                 case AST_CONTROL_UNHOLD:
1141                                         /* Unimportant */
1142                                         break;
1143                                 default:
1144                                         ast_log(LOG_WARNING, "Unexpected control subclass '%d'\n", fr->subclass);
1145                                 }
1146                                 break;
1147                         case AST_FRAME_VOICE:
1148                                 /* Write audio if appropriate */
1149                                 if (audiofd > -1)
1150                                         write(audiofd, fr->data, fr->datalen);
1151                         default:
1152                                 /* Ignore all others */
1153                                 break;
1154                         }
1155                         ast_frfree(fr);
1156                 }
1157                 ast_sched_runq(c->sched);
1158         }
1159
1160         ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
1161
1162         return (err || c->_softhangup) ? -1 : 0;
1163 }
1164
1165 int ast_waitstream_fr(struct ast_channel *c, const char *breakon, const char *forward, const char *rewind, int ms)
1166 {
1167         return waitstream_core(c, breakon, forward, rewind, ms,
1168                 -1 /* no audiofd */, -1 /* no cmdfd */, NULL /* no context */);
1169 }
1170
1171 int ast_waitstream(struct ast_channel *c, const char *breakon)
1172 {
1173         return waitstream_core(c, breakon, NULL, NULL, 0, -1, -1, NULL);
1174 }
1175
1176 int ast_waitstream_full(struct ast_channel *c, const char *breakon, int audiofd, int cmdfd)
1177 {
1178         return waitstream_core(c, breakon, NULL, NULL, 0,
1179                 audiofd, cmdfd, NULL /* no context */);
1180 }
1181
1182 int ast_waitstream_exten(struct ast_channel *c, const char *context)
1183 {
1184         /* Waitstream, with return in the case of a valid 1 digit extension */
1185         /* in the current or specified context being pressed */
1186
1187         if (!context)
1188                 context = c->context;
1189         return waitstream_core(c, NULL, NULL, NULL, 0,
1190                 -1, -1, context);
1191 }
1192
1193 /*
1194  * if the file name is non-empty, try to play it.
1195  * Return 0 if success, -1 if error, digit if interrupted by a digit.
1196  * If digits == "" then we can simply check for non-zero.
1197  */
1198 int ast_stream_and_wait(struct ast_channel *chan, const char *file, const char *digits)
1199 {
1200         int res = 0;
1201         if (!ast_strlen_zero(file)) {
1202                 res = ast_streamfile(chan, file, chan->language);
1203                 if (!res) {
1204                         res = ast_waitstream(chan, digits);
1205                 }
1206         }
1207         return res;
1208
1209
1210 static char *handle_cli_core_show_file_formats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1211 {
1212 #define FORMAT "%-10s %-10s %-20s\n"
1213 #define FORMAT2 "%-10s %-10s %-20s\n"
1214         struct ast_format *f;
1215         int count_fmt = 0;
1216
1217         switch (cmd) {
1218         case CLI_INIT:
1219                 e->command = "core show file formats";
1220                 e->usage =
1221                         "Usage: core show file formats\n"
1222                         "       Displays currently registered file formats (if any).\n";
1223                 return NULL;
1224         case CLI_GENERATE:
1225                 return NULL;
1226         }
1227
1228         if (a->argc != 4)
1229                 return CLI_SHOWUSAGE;
1230
1231         ast_cli(a->fd, FORMAT, "Format", "Name", "Extensions");
1232         ast_cli(a->fd, FORMAT, "------", "----", "----------");
1233
1234         AST_RWLIST_RDLOCK(&formats);
1235         AST_RWLIST_TRAVERSE(&formats, f, list) {
1236                 ast_cli(a->fd, FORMAT2, ast_getformatname(f->format), f->name, f->exts);
1237                 count_fmt++;
1238         }
1239         AST_RWLIST_UNLOCK(&formats);
1240         ast_cli(a->fd, "%d file formats registered.\n", count_fmt);
1241         return CLI_SUCCESS;
1242 #undef FORMAT
1243 #undef FORMAT2
1244 }
1245
1246 struct ast_cli_entry cli_file[] = {
1247         AST_CLI_DEFINE(handle_cli_core_show_file_formats, "Displays file formats")
1248 };
1249
1250 int ast_file_init(void)
1251 {
1252         ast_cli_register_multiple(cli_file, sizeof(cli_file) / sizeof(struct ast_cli_entry));
1253         return 0;
1254 }