8475791e38e0f42d324742033f72100b5d705ef8
[asterisk/asterisk.git] / apps / app_record.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Matthew Fredrickson <creslin@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 Trivial application to record a sound file
22  *
23  * \author Matthew Fredrickson <creslin@digium.com>
24  *
25  * \ingroup applications
26  */
27  
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include <stdlib.h>
33 #include <stdio.h>
34 #include <string.h>
35
36 #include "asterisk/lock.h"
37 #include "asterisk/file.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/channel.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/module.h"
42 #include "asterisk/translate.h"
43 #include "asterisk/dsp.h"
44 #include "asterisk/utils.h"
45 #include "asterisk/options.h"
46 #include "asterisk/app.h"
47
48
49 static char *app = "Record";
50
51 static char *synopsis = "Record to a file";
52
53 static char *descrip = 
54 "  Record(filename.format|silence[|maxduration][|options])\n\n"
55 "Records from the channel into a given filename. If the file exists it will\n"
56 "be overwritten.\n"
57 "- 'format' is the format of the file type to be recorded (wav, gsm, etc).\n"
58 "- 'silence' is the number of seconds of silence to allow before returning.\n"
59 "- 'maxduration' is the maximum recording duration in seconds. If missing\n"
60 "or 0 there is no maximum.\n"
61 "- 'options' may contain any of the following letters:\n"
62 "     'a' : append to existing recording rather than replacing\n"
63 "     'n' : do not answer, but record anyway if line not yet answered\n"
64 "     'q' : quiet (do not play a beep tone)\n"
65 "     's' : skip recording if the line is not yet answered\n"
66 "     't' : use alternate '*' terminator key (DTMF) instead of default '#'\n"
67 "     'x' : ignore all terminator keys (DTMF) and keep recording until hangup\n"
68 "\n"
69 "If filename contains '%d', these characters will be replaced with a number\n"
70 "incremented by one each time the file is recorded. A channel variable\n"
71 "named RECORDED_FILE will also be set, which contains the final filemname.\n\n"
72 "Use 'core show file formats' to see the available formats on your system\n\n"
73 "User can press '#' to terminate the recording and continue to the next priority.\n\n"
74 "If the user should hangup during a recording, all data will be lost and the\n"
75 "application will teminate. \n";
76
77
78 static int record_exec(struct ast_channel *chan, void *data)
79 {
80         int res = 0;
81         int count = 0;
82         int percentflag = 0;
83         char *filename, *ext = NULL, *silstr, *maxstr, *options;
84         char *file, *dir;
85         char *vdata, *p;
86         int i = 0;
87         char tmp[256];
88
89         struct ast_filestream *s = '\0';
90         struct ast_module_user *u;
91         struct ast_frame *f = NULL;
92         
93         struct ast_dsp *sildet = NULL;          /* silence detector dsp */
94         int totalsilence = 0;
95         int dspsilence = 0;
96         int silence = 0;                /* amount of silence to allow */
97         int gotsilence = 0;             /* did we timeout for silence? */
98         int maxduration = 0;            /* max duration of recording in milliseconds */
99         int gottimeout = 0;             /* did we timeout for maxduration exceeded? */
100         int option_skip = 0;
101         int option_noanswer = 0;
102         int option_append = 0;
103         int terminator = '#';
104         int option_quiet = 0;
105         int rfmt = 0;
106         int flags;
107         int waitres;
108         struct ast_silence_generator *silgen = NULL;
109         
110         /* The next few lines of code parse out the filename and header from the input string */
111         if (ast_strlen_zero(data)) { /* no data implies no filename or anything is present */
112                 ast_log(LOG_WARNING, "Record requires an argument (filename)\n");
113                 return -1;
114         }
115
116         u = ast_module_user_add(chan);
117
118         /* Yay for strsep being easy */
119         vdata = ast_strdupa(data);
120
121         p = vdata;
122         filename = strsep(&p, "|");
123         silstr = strsep(&p, "|");
124         maxstr = strsep(&p, "|");       
125         options = strsep(&p, "|");
126         
127         if (filename) {
128                 if (strstr(filename, "%d"))
129                         percentflag = 1;
130                 ext = strrchr(filename, '.'); /* to support filename with a . in the filename, not format */
131                 if (!ext)
132                         ext = strchr(filename, ':');
133                 if (ext) {
134                         *ext = '\0';
135                         ext++;
136                 }
137         }
138         if (!ext) {
139                 ast_log(LOG_WARNING, "No extension specified to filename!\n");
140                 ast_module_user_remove(u);
141                 return -1;
142         }
143         if (silstr) {
144                 if ((sscanf(silstr, "%d", &i) == 1) && (i > -1)) {
145                         silence = i * 1000;
146                 } else if (!ast_strlen_zero(silstr)) {
147                         ast_log(LOG_WARNING, "'%s' is not a valid silence duration\n", silstr);
148                 }
149         }
150         
151         if (maxstr) {
152                 if ((sscanf(maxstr, "%d", &i) == 1) && (i > -1))
153                         /* Convert duration to milliseconds */
154                         maxduration = i * 1000;
155                 else if (!ast_strlen_zero(maxstr))
156                         ast_log(LOG_WARNING, "'%s' is not a valid maximum duration\n", maxstr);
157         }
158         if (options) {
159                 /* Retain backwards compatibility with old style options */
160                 if (!strcasecmp(options, "skip"))
161                         option_skip = 1;
162                 else if (!strcasecmp(options, "noanswer"))
163                         option_noanswer = 1;
164                 else {
165                         if (strchr(options, 's'))
166                                 option_skip = 1;
167                         if (strchr(options, 'n'))
168                                 option_noanswer = 1;
169                         if (strchr(options, 'a'))
170                                 option_append = 1;
171                         if (strchr(options, 't'))
172                                 terminator = '*';
173                         if (strchr(options, 'x'))
174                                 terminator = 0;
175                         if (strchr(options, 'q'))
176                                 option_quiet = 1;
177                 }
178         }
179         
180         /* done parsing */
181         
182         /* these are to allow the use of the %d in the config file for a wild card of sort to
183           create a new file with the inputed name scheme */
184         if (percentflag) {
185                 AST_DECLARE_APP_ARGS(fname,
186                         AST_APP_ARG(piece)[100];
187                 );
188                 char *tmp2 = ast_strdupa(filename);
189                 char countstring[15];
190                 int i;
191
192                 /* Separate each piece out by the format specifier */
193                 AST_NONSTANDARD_APP_ARGS(fname, tmp2, '%');
194                 do {
195                         int tmplen;
196                         /* First piece has no leading percent, so it's copied verbatim */
197                         ast_copy_string(tmp, fname.piece[0], sizeof(tmp));
198                         tmplen = strlen(tmp);
199                         for (i = 1; i < fname.argc; i++) {
200                                 if (fname.piece[i][0] == 'd') {
201                                         /* Substitute the count */
202                                         snprintf(countstring, sizeof(countstring), "%d", count);
203                                         ast_copy_string(tmp + tmplen, countstring, sizeof(tmp) - tmplen);
204                                         tmplen += strlen(countstring);
205                                 } else if (tmplen + 2 < sizeof(tmp)) {
206                                         /* Unknown format specifier - just copy it verbatim */
207                                         tmp[tmplen++] = '%';
208                                         tmp[tmplen++] = fname.piece[i][0];
209                                 }
210                                 /* Copy the remaining portion of the piece */
211                                 ast_copy_string(tmp + tmplen, &(fname.piece[i][1]), sizeof(tmp) - tmplen);
212                         }
213                         count++;
214                 } while (ast_fileexists(tmp, ext, chan->language) > 0);
215                 pbx_builtin_setvar_helper(chan, "RECORDED_FILE", tmp);
216         } else
217                 ast_copy_string(tmp, filename, sizeof(tmp));
218         /* end of routine mentioned */
219         
220         
221         
222         if (chan->_state != AST_STATE_UP) {
223                 if (option_skip) {
224                         /* At the user's option, skip if the line is not up */
225                         ast_module_user_remove(u);
226                         return 0;
227                 } else if (!option_noanswer) {
228                         /* Otherwise answer unless we're supposed to record while on-hook */
229                         res = ast_answer(chan);
230                 }
231         }
232         
233         if (res) {
234                 ast_log(LOG_WARNING, "Could not answer channel '%s'\n", chan->name);
235                 goto out;
236         }
237         
238         if (!option_quiet) {
239                 /* Some code to play a nice little beep to signify the start of the record operation */
240                 res = ast_streamfile(chan, "beep", chan->language);
241                 if (!res) {
242                         res = ast_waitstream(chan, "");
243                 } else {
244                         ast_log(LOG_WARNING, "ast_streamfile failed on %s\n", chan->name);
245                 }
246                 ast_stopstream(chan);
247         }
248                 
249         /* The end of beep code.  Now the recording starts */
250                 
251         if (silence > 0) {
252                 rfmt = chan->readformat;
253                 res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
254                 if (res < 0) {
255                         ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
256                         ast_module_user_remove(u);
257                         return -1;
258                 }
259                 sildet = ast_dsp_new();
260                 if (!sildet) {
261                         ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
262                         ast_module_user_remove(u);
263                         return -1;
264                 }
265                 ast_dsp_set_threshold(sildet, 256);
266         } 
267
268         /* Create the directory if it does not exist. */
269         dir = ast_strdupa(tmp);
270         if ((file = strrchr(dir, '/')))
271                 *file++ = '\0';
272         ast_mkdir (dir, 0777);
273
274         flags = option_append ? O_CREAT|O_APPEND|O_WRONLY : O_CREAT|O_TRUNC|O_WRONLY;
275         s = ast_writefile( tmp, ext, NULL, flags , 0, AST_FILE_MODE);
276                 
277         if (!s) {
278                 ast_log(LOG_WARNING, "Could not create file %s\n", filename);
279                 goto out;
280         }
281
282         if (ast_opt_transmit_silence)
283                 silgen = ast_channel_start_silence_generator(chan);
284         
285         /* Request a video update */
286         ast_indicate(chan, AST_CONTROL_VIDUPDATE);
287         
288         if (maxduration <= 0)
289                 maxduration = -1;
290         
291         while ((waitres = ast_waitfor(chan, maxduration)) > -1) {
292                 if (maxduration > 0) {
293                         if (waitres == 0) {
294                                 gottimeout = 1;
295                                 break;
296                         }
297                         maxduration = waitres;
298                 }
299                 
300                 f = ast_read(chan);
301                 if (!f) {
302                         res = -1;
303                         break;
304                 }
305                 if (f->frametype == AST_FRAME_VOICE) {
306                         res = ast_writestream(s, f);
307                         
308                         if (res) {
309                                 ast_log(LOG_WARNING, "Problem writing frame\n");
310                                 ast_frfree(f);
311                                 break;
312                         }
313                         
314                         if (silence > 0) {
315                                 dspsilence = 0;
316                                 ast_dsp_silence(sildet, f, &dspsilence);
317                                 if (dspsilence) {
318                                         totalsilence = dspsilence;
319                                 } else {
320                                         totalsilence = 0;
321                                 }
322                                 if (totalsilence > silence) {
323                                         /* Ended happily with silence */
324                                         ast_frfree(f);
325                                         gotsilence = 1;
326                                         break;
327                                 }
328                         }
329                 } else if (f->frametype == AST_FRAME_VIDEO) {
330                         res = ast_writestream(s, f);
331                         
332                         if (res) {
333                                 ast_log(LOG_WARNING, "Problem writing frame\n");
334                                 ast_frfree(f);
335                                 break;
336                         }
337                 } else if ((f->frametype == AST_FRAME_DTMF) &&
338                     (f->subclass == terminator)) {
339                         ast_frfree(f);
340                         break;
341                 }
342                 ast_frfree(f);
343         }
344         if (!f) {
345                 ast_debug(1, "Got hangup\n");
346                 res = -1;
347         }
348                         
349         if (gotsilence) {
350                 ast_stream_rewind(s, silence-1000);
351                 ast_truncstream(s);
352         } else if (!gottimeout) {
353                 /* Strip off the last 1/4 second of it */
354                 ast_stream_rewind(s, 250);
355                 ast_truncstream(s);
356         }
357         ast_closestream(s);
358
359         if (silgen)
360                 ast_channel_stop_silence_generator(chan, silgen);
361         
362  out:
363         if ((silence > 0) && rfmt) {
364                 res = ast_set_read_format(chan, rfmt);
365                 if (res)
366                         ast_log(LOG_WARNING, "Unable to restore read format on '%s'\n", chan->name);
367                 if (sildet)
368                         ast_dsp_free(sildet);
369         }
370
371         ast_module_user_remove(u);
372
373         return res;
374 }
375
376 static int unload_module(void)
377 {
378         return ast_unregister_application(app);
379 }
380
381 static int load_module(void)
382 {
383         return ast_register_application(app, record_exec, synopsis, descrip);
384 }
385
386 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Trivial Record Application");