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