Tue Aug 20 16:34:22 2013

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

Generated on 20 Aug 2013 for Asterisk - The Open Source Telephony Project by  doxygen 1.6.1