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