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