convert a couple of applications to the new module style
[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 #define STATIC_MODULE
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include "asterisk/lock.h"
39 #include "asterisk/file.h"
40 #include "asterisk/logger.h"
41 #include "asterisk/channel.h"
42 #include "asterisk/pbx.h"
43 #include "asterisk/module.h"
44 #include "asterisk/translate.h"
45 #include "asterisk/dsp.h"
46 #include "asterisk/utils.h"
47 #include "asterisk/options.h"
48
49 static char *tdesc = "Trivial Record Application";
50
51 static char *app = "Record";
52
53 static char *synopsis = "Record to a file";
54
55 static char *descrip = 
56 "  Record(filename.format|silence[|maxduration][|options])\n\n"
57 "Records from the channel into a given filename. If the file exists it will\n"
58 "be overwritten.\n"
59 "- 'format' is the format of the file type to be recorded (wav, gsm, etc).\n"
60 "- 'silence' is the number of seconds of silence to allow before returning.\n"
61 "- 'maxduration' is the maximum recording duration in seconds. If missing\n"
62 "or 0 there is no maximum.\n"
63 "- 'options' may contain any of the following letters:\n"
64 "     'a' : append to existing recording rather than replacing\n"
65 "     'n' : do not answer, but record anyway if line not yet answered\n"
66 "     'q' : quiet (do not play a beep tone)\n"
67 "     's' : skip recording if the line is not yet answered\n"
68 "     't' : use alternate '*' terminator key instead of default '#'\n"
69 "\n"
70 "If filename contains '%d', these characters will be replaced with a number\n"
71 "incremented by one each time the file is recorded. \n\n"
72 "Use '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 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         if (!(vdata = ast_strdupa(data))) {
120                 LOCAL_USER_REMOVE(u);
121                 return -1;
122         }
123
124         p = vdata;
125         filename = strsep(&p, "|");
126         silstr = strsep(&p, "|");
127         maxstr = strsep(&p, "|");       
128         options = strsep(&p, "|");
129         
130         if (filename) {
131                 if (strstr(filename, "%d"))
132                         percentflag = 1;
133                 ext = strrchr(filename, '.'); /* to support filename with a . in the filename, not format */
134                 if (!ext)
135                         ext = strchr(filename, ':');
136                 if (ext) {
137                         *ext = '\0';
138                         ext++;
139                 }
140         }
141         if (!ext) {
142                 ast_log(LOG_WARNING, "No extension specified to filename!\n");
143                 LOCAL_USER_REMOVE(u);
144                 return -1;
145         }
146         if (silstr) {
147                 if ((sscanf(silstr, "%d", &i) == 1) && (i > -1)) {
148                         silence = i * 1000;
149                 } else if (!ast_strlen_zero(silstr)) {
150                         ast_log(LOG_WARNING, "'%s' is not a valid silence duration\n", silstr);
151                 }
152         }
153         
154         if (maxstr) {
155                 if ((sscanf(maxstr, "%d", &i) == 1) && (i > -1))
156                         /* Convert duration to milliseconds */
157                         maxduration = i * 1000;
158                 else if (!ast_strlen_zero(maxstr))
159                         ast_log(LOG_WARNING, "'%s' is not a valid maximum duration\n", maxstr);
160         }
161         if (options) {
162                 /* Retain backwards compatibility with old style options */
163                 if (!strcasecmp(options, "skip"))
164                         option_skip = 1;
165                 else if (!strcasecmp(options, "noanswer"))
166                         option_noanswer = 1;
167                 else {
168                         if (strchr(options, 's'))
169                                 option_skip = 1;
170                         if (strchr(options, 'n'))
171                                 option_noanswer = 1;
172                         if (strchr(options, 'a'))
173                                 option_append = 1;
174                         if (strchr(options, 't'))
175                                 terminator = '*';
176                         if (strchr(options, 'q'))
177                                 option_quiet = 1;
178                 }
179         }
180         
181         /* done parsing */
182         
183         /* these are to allow the use of the %d in the config file for a wild card of sort to
184           create a new file with the inputed name scheme */
185         if (percentflag) {
186                 do {
187                         snprintf(tmp, sizeof(tmp), filename, count);
188                         count++;
189                 } while ( ast_fileexists(tmp, ext, chan->language) != -1 );
190                 pbx_builtin_setvar_helper(chan, "RECORDED_FILE", tmp);
191         } else
192                 strncpy(tmp, filename, sizeof(tmp)-1);
193         /* end of routine mentioned */
194         
195         
196         
197         if (chan->_state != AST_STATE_UP) {
198                 if (option_skip) {
199                         /* At the user's option, skip if the line is not up */
200                         LOCAL_USER_REMOVE(u);
201                         return 0;
202                 } else if (!option_noanswer) {
203                         /* Otherwise answer unless we're supposed to record while on-hook */
204                         res = ast_answer(chan);
205                 }
206         }
207         
208         if (res) {
209                 ast_log(LOG_WARNING, "Could not answer channel '%s'\n", chan->name);
210                 goto out;
211         }
212         
213         if (!option_quiet) {
214                 /* Some code to play a nice little beep to signify the start of the record operation */
215                 res = ast_streamfile(chan, "beep", chan->language);
216                 if (!res) {
217                         res = ast_waitstream(chan, "");
218                 } else {
219                         ast_log(LOG_WARNING, "ast_streamfile failed on %s\n", chan->name);
220                 }
221                 ast_stopstream(chan);
222         }
223                 
224         /* The end of beep code.  Now the recording starts */
225                 
226         if (silence > 0) {
227                 rfmt = chan->readformat;
228                 res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
229                 if (res < 0) {
230                         ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
231                         LOCAL_USER_REMOVE(u);
232                         return -1;
233                 }
234                 sildet = ast_dsp_new();
235                 if (!sildet) {
236                         ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
237                         LOCAL_USER_REMOVE(u);
238                         return -1;
239                 }
240                 ast_dsp_set_threshold(sildet, 256);
241         } 
242                 
243                 
244         flags = option_append ? O_CREAT|O_APPEND|O_WRONLY : O_CREAT|O_TRUNC|O_WRONLY;
245         s = ast_writefile( tmp, ext, NULL, flags , 0, 0644);
246                 
247         if (!s) {
248                 ast_log(LOG_WARNING, "Could not create file %s\n", filename);
249                 goto out;
250         }
251
252         if (ast_opt_transmit_silence)
253                 silgen = ast_channel_start_silence_generator(chan);
254         
255         /* Request a video update */
256         ast_indicate(chan, AST_CONTROL_VIDUPDATE);
257         
258         if (maxduration <= 0)
259                 maxduration = -1;
260         
261         while ((waitres = ast_waitfor(chan, maxduration)) > -1) {
262                 if (maxduration > 0) {
263                         if (waitres == 0) {
264                                 gottimeout = 1;
265                                 break;
266                         }
267                         maxduration = waitres;
268                 }
269                 
270                 f = ast_read(chan);
271                 if (!f) {
272                         res = -1;
273                         break;
274                 }
275                 if (f->frametype == AST_FRAME_VOICE) {
276                         res = ast_writestream(s, f);
277                         
278                         if (res) {
279                                 ast_log(LOG_WARNING, "Problem writing frame\n");
280                                 ast_frfree(f);
281                                 break;
282                         }
283                         
284                         if (silence > 0) {
285                                 dspsilence = 0;
286                                 ast_dsp_silence(sildet, f, &dspsilence);
287                                 if (dspsilence) {
288                                         totalsilence = dspsilence;
289                                 } else {
290                                         totalsilence = 0;
291                                 }
292                                 if (totalsilence > silence) {
293                                         /* Ended happily with silence */
294                                         ast_frfree(f);
295                                         gotsilence = 1;
296                                         break;
297                                 }
298                         }
299                 } else if (f->frametype == AST_FRAME_VIDEO) {
300                         res = ast_writestream(s, f);
301                         
302                         if (res) {
303                                 ast_log(LOG_WARNING, "Problem writing frame\n");
304                                 ast_frfree(f);
305                                 break;
306                         }
307                 } else if ((f->frametype == AST_FRAME_DTMF) &&
308                     (f->subclass == terminator)) {
309                         ast_frfree(f);
310                         break;
311                 }
312                 ast_frfree(f);
313         }
314         if (!f) {
315                 ast_log(LOG_DEBUG, "Got hangup\n");
316                 res = -1;
317         }
318                         
319         if (gotsilence) {
320                 ast_stream_rewind(s, silence-1000);
321                 ast_truncstream(s);
322         } else if (!gottimeout) {
323                 /* Strip off the last 1/4 second of it */
324                 ast_stream_rewind(s, 250);
325                 ast_truncstream(s);
326         }
327         ast_closestream(s);
328
329         if (silgen)
330                 ast_channel_stop_silence_generator(chan, silgen);
331         
332  out:
333         if ((silence > 0) && rfmt) {
334                 res = ast_set_read_format(chan, rfmt);
335                 if (res)
336                         ast_log(LOG_WARNING, "Unable to restore read format on '%s'\n", chan->name);
337                 if (sildet)
338                         ast_dsp_free(sildet);
339         }
340
341         LOCAL_USER_REMOVE(u);
342
343         return res;
344 }
345
346 STATIC_MODULE int unload_module(void)
347 {
348         int res;
349
350         res = ast_unregister_application(app);
351         
352         STANDARD_HANGUP_LOCALUSERS;
353
354         return res;     
355 }
356
357 STATIC_MODULE int load_module(void)
358 {
359         return ast_register_application(app, record_exec, synopsis, descrip);
360 }
361
362 STATIC_MODULE char *description(void)
363 {
364         return tdesc;
365 }
366
367 STATIC_MODULE int usecount(void)
368 {
369         int res;
370         STANDARD_USECOUNT(res);
371         return res;
372 }
373
374 STATIC_MODULE char *key(void)
375 {
376         return ASTERISK_GPL_KEY;
377 }
378
379 STD_MOD(MOD_1, NULL, NULL, NULL);