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