revert my pass through the tree to remove checks of the result of ast_strdupa
[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 static char *tdesc = "Trivial Record Application";
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 instead of default '#'\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 STANDARD_LOCAL_USER;
76
77 LOCAL_USER_DECL;
78
79 static int record_exec(struct ast_channel *chan, void *data)
80 {
81         int res = 0;
82         int count = 0;
83         int percentflag = 0;
84         char *filename, *ext = NULL, *silstr, *maxstr, *options;
85         char *vdata, *p;
86         int i = 0;
87         char tmp[256];
88
89         struct ast_filestream *s = '\0';
90         struct localuser *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         LOCAL_USER_ADD(u);
117
118         /* Yay for strsep being easy */
119         vdata = ast_strdupa(data);
120         if (!vdata) {
121                 ast_log(LOG_ERROR, "Out of memory\n");
122                 LOCAL_USER_REMOVE(u);
123                 return -1;
124         }
125
126         p = vdata;
127         filename = strsep(&p, "|");
128         silstr = strsep(&p, "|");
129         maxstr = strsep(&p, "|");       
130         options = strsep(&p, "|");
131         
132         if (filename) {
133                 if (strstr(filename, "%d"))
134                         percentflag = 1;
135                 ext = strrchr(filename, '.'); /* to support filename with a . in the filename, not format */
136                 if (!ext)
137                         ext = strchr(filename, ':');
138                 if (ext) {
139                         *ext = '\0';
140                         ext++;
141                 }
142         }
143         if (!ext) {
144                 ast_log(LOG_WARNING, "No extension specified to filename!\n");
145                 LOCAL_USER_REMOVE(u);
146                 return -1;
147         }
148         if (silstr) {
149                 if ((sscanf(silstr, "%d", &i) == 1) && (i > -1)) {
150                         silence = i * 1000;
151                 } else if (!ast_strlen_zero(silstr)) {
152                         ast_log(LOG_WARNING, "'%s' is not a valid silence duration\n", silstr);
153                 }
154         }
155         
156         if (maxstr) {
157                 if ((sscanf(maxstr, "%d", &i) == 1) && (i > -1))
158                         /* Convert duration to milliseconds */
159                         maxduration = i * 1000;
160                 else if (!ast_strlen_zero(maxstr))
161                         ast_log(LOG_WARNING, "'%s' is not a valid maximum duration\n", maxstr);
162         }
163         if (options) {
164                 /* Retain backwards compatibility with old style options */
165                 if (!strcasecmp(options, "skip"))
166                         option_skip = 1;
167                 else if (!strcasecmp(options, "noanswer"))
168                         option_noanswer = 1;
169                 else {
170                         if (strchr(options, 's'))
171                                 option_skip = 1;
172                         if (strchr(options, 'n'))
173                                 option_noanswer = 1;
174                         if (strchr(options, 'a'))
175                                 option_append = 1;
176                         if (strchr(options, 't'))
177                                 terminator = '*';
178                         if (strchr(options, 'q'))
179                                 option_quiet = 1;
180                 }
181         }
182         
183         /* done parsing */
184         
185         /* these are to allow the use of the %d in the config file for a wild card of sort to
186           create a new file with the inputed name scheme */
187         if (percentflag) {
188                 do {
189                         snprintf(tmp, sizeof(tmp), filename, count);
190                         count++;
191                 } while ( ast_fileexists(tmp, ext, chan->language) != -1 );
192                 pbx_builtin_setvar_helper(chan, "RECORDED_FILE", tmp);
193         } else
194                 strncpy(tmp, filename, sizeof(tmp)-1);
195         /* end of routine mentioned */
196         
197         
198         
199         if (chan->_state != AST_STATE_UP) {
200                 if (option_skip) {
201                         /* At the user's option, skip if the line is not up */
202                         LOCAL_USER_REMOVE(u);
203                         return 0;
204                 } else if (!option_noanswer) {
205                         /* Otherwise answer unless we're supposed to record while on-hook */
206                         res = ast_answer(chan);
207                 }
208         }
209         
210         if (res) {
211                 ast_log(LOG_WARNING, "Could not answer channel '%s'\n", chan->name);
212                 goto out;
213         }
214         
215         if (!option_quiet) {
216                 /* Some code to play a nice little beep to signify the start of the record operation */
217                 res = ast_streamfile(chan, "beep", chan->language);
218                 if (!res) {
219                         res = ast_waitstream(chan, "");
220                 } else {
221                         ast_log(LOG_WARNING, "ast_streamfile failed on %s\n", chan->name);
222                 }
223                 ast_stopstream(chan);
224         }
225                 
226         /* The end of beep code.  Now the recording starts */
227                 
228         if (silence > 0) {
229                 rfmt = chan->readformat;
230                 res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
231                 if (res < 0) {
232                         ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
233                         LOCAL_USER_REMOVE(u);
234                         return -1;
235                 }
236                 sildet = ast_dsp_new();
237                 if (!sildet) {
238                         ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
239                         LOCAL_USER_REMOVE(u);
240                         return -1;
241                 }
242                 ast_dsp_set_threshold(sildet, 256);
243         } 
244                 
245                 
246         flags = option_append ? O_CREAT|O_APPEND|O_WRONLY : O_CREAT|O_TRUNC|O_WRONLY;
247         s = ast_writefile( tmp, ext, NULL, flags , 0, 0644);
248                 
249         if (!s) {
250                 ast_log(LOG_WARNING, "Could not create file %s\n", filename);
251                 goto out;
252         }
253
254         if (ast_opt_transmit_silence)
255                 silgen = ast_channel_start_silence_generator(chan);
256         
257         /* Request a video update */
258         ast_indicate(chan, AST_CONTROL_VIDUPDATE);
259         
260         if (maxduration <= 0)
261                 maxduration = -1;
262         
263         while ((waitres = ast_waitfor(chan, maxduration)) > -1) {
264                 if (maxduration > 0) {
265                         if (waitres == 0) {
266                                 gottimeout = 1;
267                                 break;
268                         }
269                         maxduration = waitres;
270                 }
271                 
272                 f = ast_read(chan);
273                 if (!f) {
274                         res = -1;
275                         break;
276                 }
277                 if (f->frametype == AST_FRAME_VOICE) {
278                         res = ast_writestream(s, f);
279                         
280                         if (res) {
281                                 ast_log(LOG_WARNING, "Problem writing frame\n");
282                                 ast_frfree(f);
283                                 break;
284                         }
285                         
286                         if (silence > 0) {
287                                 dspsilence = 0;
288                                 ast_dsp_silence(sildet, f, &dspsilence);
289                                 if (dspsilence) {
290                                         totalsilence = dspsilence;
291                                 } else {
292                                         totalsilence = 0;
293                                 }
294                                 if (totalsilence > silence) {
295                                         /* Ended happily with silence */
296                                         ast_frfree(f);
297                                         gotsilence = 1;
298                                         break;
299                                 }
300                         }
301                 } else if (f->frametype == AST_FRAME_VIDEO) {
302                         res = ast_writestream(s, f);
303                         
304                         if (res) {
305                                 ast_log(LOG_WARNING, "Problem writing frame\n");
306                                 ast_frfree(f);
307                                 break;
308                         }
309                 } else if ((f->frametype == AST_FRAME_DTMF) &&
310                     (f->subclass == terminator)) {
311                         ast_frfree(f);
312                         break;
313                 }
314                 ast_frfree(f);
315         }
316         if (!f) {
317                 ast_log(LOG_DEBUG, "Got hangup\n");
318                 res = -1;
319         }
320                         
321         if (gotsilence) {
322                 ast_stream_rewind(s, silence-1000);
323                 ast_truncstream(s);
324         } else if (!gottimeout) {
325                 /* Strip off the last 1/4 second of it */
326                 ast_stream_rewind(s, 250);
327                 ast_truncstream(s);
328         }
329         ast_closestream(s);
330
331         if (silgen)
332                 ast_channel_stop_silence_generator(chan, silgen);
333         
334  out:
335         if ((silence > 0) && rfmt) {
336                 res = ast_set_read_format(chan, rfmt);
337                 if (res)
338                         ast_log(LOG_WARNING, "Unable to restore read format on '%s'\n", chan->name);
339                 if (sildet)
340                         ast_dsp_free(sildet);
341         }
342
343         LOCAL_USER_REMOVE(u);
344
345         return res;
346 }
347
348 int unload_module(void)
349 {
350         int res;
351
352         res = ast_unregister_application(app);
353         
354         STANDARD_HANGUP_LOCALUSERS;
355
356         return res;     
357 }
358
359 int load_module(void)
360 {
361         return ast_register_application(app, record_exec, synopsis, descrip);
362 }
363
364 char *description(void)
365 {
366         return tdesc;
367 }
368
369 int usecount(void)
370 {
371         int res;
372         STANDARD_USECOUNT(res);
373         return res;
374 }
375
376 char *key()
377 {
378         return ASTERISK_GPL_KEY;
379 }