Mon Jun 27 16:50:47 2011

Asterisk developer's documentation


app_record.c

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2005, Digium, Inc.
00005  *
00006  * Matthew Fredrickson <creslin@digium.com>
00007  *
00008  * See http://www.asterisk.org for more information about
00009  * the Asterisk project. Please do not directly contact
00010  * any of the maintainers of this project for assistance;
00011  * the project provides a web site, mailing lists and IRC
00012  * channels for your use.
00013  *
00014  * This program is free software, distributed under the terms of
00015  * the GNU General Public License Version 2. See the LICENSE file
00016  * at the top of the source tree.
00017  */
00018 
00019 /*! \file
00020  *
00021  * \brief Trivial application to record a sound file
00022  *
00023  * \author Matthew Fredrickson <creslin@digium.com>
00024  *
00025  * \ingroup applications
00026  */
00027  
00028 #include "asterisk.h"
00029 
00030 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 251680 $")
00031 
00032 #include "asterisk/file.h"
00033 #include "asterisk/pbx.h"
00034 #include "asterisk/module.h"
00035 #include "asterisk/app.h"
00036 #include "asterisk/channel.h"
00037 #include "asterisk/dsp.h"  /* use dsp routines for silence detection */
00038 
00039 /*** DOCUMENTATION
00040    <application name="Record" language="en_US">
00041       <synopsis>
00042          Record to a file.
00043       </synopsis>
00044       <syntax>
00045          <parameter name="filename" required="true" argsep=".">
00046             <argument name="filename" required="true" />
00047             <argument name="format" required="true">
00048                <para>Is the format of the file type to be recorded (wav, gsm, etc).</para>
00049             </argument>
00050          </parameter>
00051          <parameter name="silence">
00052             <para>Is the number of seconds of silence to allow before returning.</para>
00053          </parameter>
00054          <parameter name="maxduration">
00055             <para>Is the maximum recording duration in seconds. If missing
00056             or 0 there is no maximum.</para>
00057          </parameter>
00058          <parameter name="options">
00059             <optionlist>
00060                <option name="a">
00061                   <para>Append to existing recording rather than replacing.</para>
00062                </option>
00063                <option name="n">
00064                   <para>Do not answer, but record anyway if line not yet answered.</para>
00065                </option>
00066                <option name="q">
00067                   <para>quiet (do not play a beep tone).</para>
00068                </option>
00069                <option name="s">
00070                   <para>skip recording if the line is not yet answered.</para>
00071                </option>
00072                <option name="t">
00073                   <para>use alternate '*' terminator key (DTMF) instead of default '#'</para>
00074                </option>
00075                <option name="x">
00076                   <para>Ignore all terminator keys (DTMF) and keep recording until hangup.</para>
00077                </option>
00078                <option name="k">
00079                        <para>Keep recorded file upon hangup.</para>
00080                </option>
00081                <option name="y">
00082                        <para>Terminate recording if *any* DTMF digit is received.</para>
00083                </option>
00084             </optionlist>
00085          </parameter>
00086       </syntax>
00087       <description>
00088          <para>If filename contains <literal>%d</literal>, these characters will be replaced with a number
00089          incremented by one each time the file is recorded.
00090          Use <astcli>core show file formats</astcli> to see the available formats on your system
00091          User can press <literal>#</literal> to terminate the recording and continue to the next priority.
00092          If the user hangs up during a recording, all data will be lost and the application will terminate.</para>
00093          <variablelist>
00094             <variable name="RECORDED_FILE">
00095                <para>Will be set to the final filename of the recording.</para>
00096             </variable>
00097             <variable name="RECORD_STATUS">
00098                <para>This is the final status of the command</para>
00099                <value name="DTMF">A terminating DTMF was received ('#' or '*', depending upon option 't')</value>
00100                <value name="SILENCE">The maximum silence occurred in the recording.</value>
00101                <value name="SKIP">The line was not yet answered and the 's' option was specified.</value>
00102                <value name="TIMEOUT">The maximum length was reached.</value>
00103                <value name="HANGUP">The channel was hung up.</value>
00104                <value name="ERROR">An unrecoverable error occurred, which resulted in a WARNING to the logs.</value>
00105             </variable>
00106          </variablelist>
00107       </description>
00108    </application>
00109 
00110  ***/
00111 
00112 static char *app = "Record";
00113 
00114 enum {
00115    OPTION_APPEND = (1 << 0),
00116    OPTION_NOANSWER = (1 << 1),
00117    OPTION_QUIET = (1 << 2),
00118    OPTION_SKIP = (1 << 3),
00119    OPTION_STAR_TERMINATE = (1 << 4),
00120    OPTION_IGNORE_TERMINATE = (1 << 5),
00121    OPTION_KEEP = (1 << 6),
00122    FLAG_HAS_PERCENT = (1 << 7),
00123    OPTION_ANY_TERMINATE = (1 << 8),
00124 };
00125 
00126 AST_APP_OPTIONS(app_opts,{
00127    AST_APP_OPTION('a', OPTION_APPEND),
00128    AST_APP_OPTION('k', OPTION_KEEP),   
00129    AST_APP_OPTION('n', OPTION_NOANSWER),
00130    AST_APP_OPTION('q', OPTION_QUIET),
00131    AST_APP_OPTION('s', OPTION_SKIP),
00132    AST_APP_OPTION('t', OPTION_STAR_TERMINATE),
00133    AST_APP_OPTION('y', OPTION_ANY_TERMINATE),
00134    AST_APP_OPTION('x', OPTION_IGNORE_TERMINATE),
00135 });
00136 
00137 static int record_exec(struct ast_channel *chan, const char *data)
00138 {
00139    int res = 0;
00140    int count = 0;
00141    char *ext = NULL, *opts[0];
00142    char *parse, *dir, *file;
00143    int i = 0;
00144    char tmp[256];
00145 
00146    struct ast_filestream *s = NULL;
00147    struct ast_frame *f = NULL;
00148    
00149    struct ast_dsp *sildet = NULL;      /* silence detector dsp */
00150    int totalsilence = 0;
00151    int dspsilence = 0;
00152    int silence = 0;     /* amount of silence to allow */
00153    int gotsilence = 0;     /* did we timeout for silence? */
00154    int maxduration = 0;    /* max duration of recording in milliseconds */
00155    int gottimeout = 0;     /* did we timeout for maxduration exceeded? */
00156    int terminator = '#';
00157    int rfmt = 0;
00158    int ioflags;
00159    int waitres;
00160    struct ast_silence_generator *silgen = NULL;
00161    struct ast_flags flags = { 0, };
00162    AST_DECLARE_APP_ARGS(args,
00163       AST_APP_ARG(filename);
00164       AST_APP_ARG(silence);
00165       AST_APP_ARG(maxduration);
00166       AST_APP_ARG(options);
00167    );
00168    
00169    /* The next few lines of code parse out the filename and header from the input string */
00170    if (ast_strlen_zero(data)) { /* no data implies no filename or anything is present */
00171       ast_log(LOG_WARNING, "Record requires an argument (filename)\n");
00172       pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
00173       return -1;
00174    }
00175 
00176    parse = ast_strdupa(data);
00177    AST_STANDARD_APP_ARGS(args, parse);
00178    if (args.argc == 4)
00179       ast_app_parse_options(app_opts, &flags, opts, args.options);
00180 
00181    if (!ast_strlen_zero(args.filename)) {
00182       if (strstr(args.filename, "%d"))
00183          ast_set_flag(&flags, FLAG_HAS_PERCENT);
00184       ext = strrchr(args.filename, '.'); /* to support filename with a . in the filename, not format */
00185       if (!ext)
00186          ext = strchr(args.filename, ':');
00187       if (ext) {
00188          *ext = '\0';
00189          ext++;
00190       }
00191    }
00192    if (!ext) {
00193       ast_log(LOG_WARNING, "No extension specified to filename!\n");
00194       pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
00195       return -1;
00196    }
00197    if (args.silence) {
00198       if ((sscanf(args.silence, "%30d", &i) == 1) && (i > -1)) {
00199          silence = i * 1000;
00200       } else if (!ast_strlen_zero(args.silence)) {
00201          ast_log(LOG_WARNING, "'%s' is not a valid silence duration\n", args.silence);
00202       }
00203    }
00204    
00205    if (args.maxduration) {
00206       if ((sscanf(args.maxduration, "%30d", &i) == 1) && (i > -1))
00207          /* Convert duration to milliseconds */
00208          maxduration = i * 1000;
00209       else if (!ast_strlen_zero(args.maxduration))
00210          ast_log(LOG_WARNING, "'%s' is not a valid maximum duration\n", args.maxduration);
00211    }
00212 
00213    if (ast_test_flag(&flags, OPTION_STAR_TERMINATE))
00214       terminator = '*';
00215    if (ast_test_flag(&flags, OPTION_IGNORE_TERMINATE))
00216       terminator = '\0';
00217 
00218    /* done parsing */
00219 
00220    /* these are to allow the use of the %d in the config file for a wild card of sort to
00221      create a new file with the inputed name scheme */
00222    if (ast_test_flag(&flags, FLAG_HAS_PERCENT)) {
00223       AST_DECLARE_APP_ARGS(fname,
00224          AST_APP_ARG(piece)[100];
00225       );
00226       char *tmp2 = ast_strdupa(args.filename);
00227       char countstring[15];
00228       int idx;
00229 
00230       /* Separate each piece out by the format specifier */
00231       AST_NONSTANDARD_APP_ARGS(fname, tmp2, '%');
00232       do {
00233          int tmplen;
00234          /* First piece has no leading percent, so it's copied verbatim */
00235          ast_copy_string(tmp, fname.piece[0], sizeof(tmp));
00236          tmplen = strlen(tmp);
00237          for (idx = 1; idx < fname.argc; idx++) {
00238             if (fname.piece[idx][0] == 'd') {
00239                /* Substitute the count */
00240                snprintf(countstring, sizeof(countstring), "%d", count);
00241                ast_copy_string(tmp + tmplen, countstring, sizeof(tmp) - tmplen);
00242                tmplen += strlen(countstring);
00243             } else if (tmplen + 2 < sizeof(tmp)) {
00244                /* Unknown format specifier - just copy it verbatim */
00245                tmp[tmplen++] = '%';
00246                tmp[tmplen++] = fname.piece[idx][0];
00247             }
00248             /* Copy the remaining portion of the piece */
00249             ast_copy_string(tmp + tmplen, &(fname.piece[idx][1]), sizeof(tmp) - tmplen);
00250          }
00251          count++;
00252       } while (ast_fileexists(tmp, ext, chan->language) > 0);
00253       pbx_builtin_setvar_helper(chan, "RECORDED_FILE", tmp);
00254    } else
00255       ast_copy_string(tmp, args.filename, sizeof(tmp));
00256    /* end of routine mentioned */
00257 
00258    if (chan->_state != AST_STATE_UP) {
00259       if (ast_test_flag(&flags, OPTION_SKIP)) {
00260          /* At the user's option, skip if the line is not up */
00261          pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "SKIP");
00262          return 0;
00263       } else if (!ast_test_flag(&flags, OPTION_NOANSWER)) {
00264          /* Otherwise answer unless we're supposed to record while on-hook */
00265          res = ast_answer(chan);
00266       }
00267    }
00268 
00269    if (res) {
00270       ast_log(LOG_WARNING, "Could not answer channel '%s'\n", chan->name);
00271       pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
00272       goto out;
00273    }
00274 
00275    if (!ast_test_flag(&flags, OPTION_QUIET)) {
00276       /* Some code to play a nice little beep to signify the start of the record operation */
00277       res = ast_streamfile(chan, "beep", chan->language);
00278       if (!res) {
00279          res = ast_waitstream(chan, "");
00280       } else {
00281          ast_log(LOG_WARNING, "ast_streamfile failed on %s\n", chan->name);
00282       }
00283       ast_stopstream(chan);
00284    }
00285 
00286    /* The end of beep code.  Now the recording starts */
00287 
00288    if (silence > 0) {
00289       rfmt = chan->readformat;
00290       res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
00291       if (res < 0) {
00292          ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
00293          pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
00294          return -1;
00295       }
00296       sildet = ast_dsp_new();
00297       if (!sildet) {
00298          ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
00299          pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
00300          return -1;
00301       }
00302       ast_dsp_set_threshold(sildet, ast_dsp_get_threshold_from_settings(THRESHOLD_SILENCE));
00303    } 
00304 
00305    /* Create the directory if it does not exist. */
00306    dir = ast_strdupa(tmp);
00307    if ((file = strrchr(dir, '/')))
00308       *file++ = '\0';
00309    ast_mkdir (dir, 0777);
00310 
00311    ioflags = ast_test_flag(&flags, OPTION_APPEND) ? O_CREAT|O_APPEND|O_WRONLY : O_CREAT|O_TRUNC|O_WRONLY;
00312    s = ast_writefile(tmp, ext, NULL, ioflags, 0, AST_FILE_MODE);
00313 
00314    if (!s) {
00315       ast_log(LOG_WARNING, "Could not create file %s\n", args.filename);
00316       pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
00317       goto out;
00318    }
00319 
00320    if (ast_opt_transmit_silence)
00321       silgen = ast_channel_start_silence_generator(chan);
00322 
00323    /* Request a video update */
00324    ast_indicate(chan, AST_CONTROL_VIDUPDATE);
00325 
00326    if (maxduration <= 0)
00327       maxduration = -1;
00328 
00329    while ((waitres = ast_waitfor(chan, maxduration)) > -1) {
00330       if (maxduration > 0) {
00331          if (waitres == 0) {
00332             gottimeout = 1;
00333             pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "TIMEOUT");
00334             break;
00335          }
00336          maxduration = waitres;
00337       }
00338 
00339       f = ast_read(chan);
00340       if (!f) {
00341          res = -1;
00342          break;
00343       }
00344       if (f->frametype == AST_FRAME_VOICE) {
00345          res = ast_writestream(s, f);
00346 
00347          if (res) {
00348             ast_log(LOG_WARNING, "Problem writing frame\n");
00349             ast_frfree(f);
00350             pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
00351             break;
00352          }
00353 
00354          if (silence > 0) {
00355             dspsilence = 0;
00356             ast_dsp_silence(sildet, f, &dspsilence);
00357             if (dspsilence) {
00358                totalsilence = dspsilence;
00359             } else {
00360                totalsilence = 0;
00361             }
00362             if (totalsilence > silence) {
00363                /* Ended happily with silence */
00364                ast_frfree(f);
00365                gotsilence = 1;
00366                pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "SILENCE");
00367                break;
00368             }
00369          }
00370       } else if (f->frametype == AST_FRAME_VIDEO) {
00371          res = ast_writestream(s, f);
00372 
00373          if (res) {
00374             ast_log(LOG_WARNING, "Problem writing frame\n");
00375             pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
00376             ast_frfree(f);
00377             break;
00378          }
00379       } else if ((f->frametype == AST_FRAME_DTMF) &&
00380             ((f->subclass.integer == terminator) ||
00381              (ast_test_flag(&flags, OPTION_ANY_TERMINATE)))) {
00382          ast_frfree(f);
00383          pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "DTMF");
00384          break;
00385       }
00386       ast_frfree(f);
00387    }
00388    if (!f) {
00389       ast_debug(1, "Got hangup\n");
00390       res = -1;
00391       pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "HANGUP");
00392       if (!ast_test_flag(&flags, OPTION_KEEP)) {
00393          ast_filedelete(args.filename, NULL);
00394       }
00395    }
00396 
00397    if (gotsilence) {
00398       ast_stream_rewind(s, silence - 1000);
00399       ast_truncstream(s);
00400    } else if (!gottimeout) {
00401       /* Strip off the last 1/4 second of it */
00402       ast_stream_rewind(s, 250);
00403       ast_truncstream(s);
00404    }
00405    ast_closestream(s);
00406 
00407    if (silgen)
00408       ast_channel_stop_silence_generator(chan, silgen);
00409 
00410 out:
00411    if ((silence > 0) && rfmt) {
00412       res = ast_set_read_format(chan, rfmt);
00413       if (res)
00414          ast_log(LOG_WARNING, "Unable to restore read format on '%s'\n", chan->name);
00415       if (sildet)
00416          ast_dsp_free(sildet);
00417    }
00418 
00419    return res;
00420 }
00421 
00422 static int unload_module(void)
00423 {
00424    return ast_unregister_application(app);
00425 }
00426 
00427 static int load_module(void)
00428 {
00429    return ast_register_application_xml(app, record_exec);
00430 }
00431 
00432 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Trivial Record Application");

Generated on Mon Jun 27 16:50:47 2011 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7