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