Mon Jun 27 16:50:46 2011

Asterisk developer's documentation


app_controlplayback.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  * Mark Spencer <markster@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 control playback of a sound file
00022  *
00023  * \author Mark Spencer <markster@digium.com>
00024  *
00025  * \ingroup applications
00026  */
00027 
00028 #include "asterisk.h"
00029 
00030 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 227368 $")
00031 
00032 #include "asterisk/pbx.h"
00033 #include "asterisk/app.h"
00034 #include "asterisk/module.h"
00035 
00036 /*** DOCUMENTATION
00037    <application name="ControlPlayback" language="en_US">
00038       <synopsis>
00039          Play a file with fast forward and rewind.
00040       </synopsis>
00041       <syntax>
00042          <parameter name="filename" required="true" />
00043          <parameter name="skipms">
00044             <para>This is number of milliseconds to skip when rewinding or
00045             fast-forwarding.</para>
00046          </parameter>
00047          <parameter name="ff">
00048             <para>Fast-forward when this DTMF digit is received. (defaults to <literal>#</literal>)</para>
00049          </parameter>
00050          <parameter name="rew">
00051             <para>Rewind when this DTMF digit is received. (defaults to <literal>*</literal>)</para>
00052          </parameter>
00053          <parameter name="stop">
00054             <para>Stop playback when this DTMF digit is received.</para>
00055          </parameter>
00056          <parameter name="pause">
00057             <para>Pause playback when this DTMF digit is received.</para>
00058          </parameter>
00059          <parameter name="restart">
00060             <para>Restart playback when this DTMF digit is received.</para>
00061          </parameter>
00062          <parameter name="options">
00063             <optionlist>
00064                <option name="o">
00065                   <argument name="time" required="true">
00066                      <para>Start at <replaceable>time</replaceable> ms from the
00067                      beginning of the file.</para>
00068                   </argument>
00069                </option>
00070             </optionlist>
00071          </parameter>
00072       </syntax>
00073       <description>
00074          <para>This application will play back the given <replaceable>filename</replaceable>.</para>
00075          <para>It sets the following channel variables upon completion:</para>
00076          <variablelist>
00077             <variable name="CPLAYBACKSTATUS">
00078                <para>Contains the status of the attempt as a text string</para>
00079                <value name="SUCCESS" />
00080                <value name="USERSTOPPED" />
00081                <value name="ERROR" />
00082             </variable>
00083             <variable name="CPLAYBACKOFFSET">
00084                <para>Contains the offset in ms into the file where playback
00085                was at when it stopped. <literal>-1</literal> is end of file.</para>
00086             </variable>
00087             <variable name="CPLAYBACKSTOPKEY">
00088                <para>If the playback is stopped by the user this variable contains
00089                the key that was pressed.</para>
00090             </variable>
00091          </variablelist>
00092       </description>
00093    </application>
00094  ***/
00095 static const char app[] = "ControlPlayback";
00096 
00097 enum {
00098    OPT_OFFSET = (1 << 1),
00099 };
00100 
00101 enum {
00102    OPT_ARG_OFFSET = 0,
00103    /* must stay as the last entry ... */
00104    OPT_ARG_ARRAY_LEN,
00105 };
00106 
00107 AST_APP_OPTIONS(cpb_opts, BEGIN_OPTIONS
00108    AST_APP_OPTION_ARG('o', OPT_OFFSET, OPT_ARG_OFFSET),
00109    END_OPTIONS
00110 );
00111 
00112 static int is_on_phonepad(char key)
00113 {
00114    return key == 35 || key == 42 || (key >= 48 && key <= 57);
00115 }
00116 
00117 static int is_argument(const char *haystack, int needle)
00118 {
00119    if (ast_strlen_zero(haystack))
00120       return 0;
00121 
00122    if (strchr(haystack, needle))
00123       return -1;
00124 
00125    return 0;
00126 }
00127 
00128 static int controlplayback_exec(struct ast_channel *chan, const char *data)
00129 {
00130    int res = 0;
00131    int skipms = 0;
00132    long offsetms = 0;
00133    char offsetbuf[20];
00134    char stopkeybuf[2];
00135    char *tmp;
00136    struct ast_flags opts = { 0, };
00137    char *opt_args[OPT_ARG_ARRAY_LEN];
00138    AST_DECLARE_APP_ARGS(args,
00139       AST_APP_ARG(filename);
00140       AST_APP_ARG(skip);
00141       AST_APP_ARG(fwd);
00142       AST_APP_ARG(rev);
00143       AST_APP_ARG(stop);
00144       AST_APP_ARG(pause);
00145       AST_APP_ARG(restart);
00146       AST_APP_ARG(options);
00147    );
00148 
00149    if (ast_strlen_zero(data)) {
00150       ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
00151       return -1;
00152    }
00153    
00154    tmp = ast_strdupa(data);
00155    AST_STANDARD_APP_ARGS(args, tmp);
00156 
00157    if (args.argc < 1) {
00158       ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
00159       return -1;
00160    }
00161 
00162    skipms = args.skip ? (atoi(args.skip) ? atoi(args.skip) : 3000) : 3000;
00163 
00164    if (!args.fwd || !is_on_phonepad(*args.fwd)) {
00165       char *digit = "#";
00166       if (!is_argument(args.rev, *digit) && !is_argument(args.stop, *digit) && !is_argument(args.pause, *digit) && !is_argument(args.restart, *digit))
00167          args.fwd = digit;
00168       else
00169          args.fwd = NULL;
00170    }
00171    if (!args.rev || !is_on_phonepad(*args.rev)) {
00172       char *digit = "*";
00173       if (!is_argument(args.fwd, *digit) && !is_argument(args.stop, *digit) && !is_argument(args.pause, *digit) && !is_argument(args.restart, *digit))
00174          args.rev = digit;
00175       else
00176          args.rev = NULL;
00177    }
00178    ast_debug(1, "Forward key = %s, Rewind key = %s\n", args.fwd, args.rev);
00179    if (args.stop && !is_on_phonepad(*args.stop))
00180       args.stop = NULL;
00181    if (args.pause && !is_on_phonepad(*args.pause))
00182       args.pause = NULL;
00183    if (args.restart && !is_on_phonepad(*args.restart))
00184       args.restart = NULL;
00185 
00186    if (args.options) {
00187       ast_app_parse_options(cpb_opts, &opts, opt_args, args.options);
00188       if (ast_test_flag(&opts, OPT_OFFSET))
00189          offsetms = atol(opt_args[OPT_ARG_OFFSET]);
00190    }
00191 
00192    res = ast_control_streamfile(chan, args.filename, args.fwd, args.rev, args.stop, args.pause, args.restart, skipms, &offsetms);
00193 
00194    /* If we stopped on one of our stop keys, return 0  */
00195    if (res > 0 && args.stop && strchr(args.stop, res)) {
00196       pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "USERSTOPPED");
00197       snprintf(stopkeybuf, sizeof(stopkeybuf), "%c", res);
00198       pbx_builtin_setvar_helper(chan, "CPLAYBACKSTOPKEY", stopkeybuf);
00199       res = 0;
00200    } else {
00201       if (res < 0) {
00202          res = 0;
00203          pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "ERROR");
00204       } else
00205          pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "SUCCESS");
00206    }
00207 
00208    snprintf(offsetbuf, sizeof(offsetbuf), "%ld", offsetms);
00209    pbx_builtin_setvar_helper(chan, "CPLAYBACKOFFSET", offsetbuf);
00210 
00211    return res;
00212 }
00213 
00214 static int unload_module(void)
00215 {
00216    int res;
00217    res = ast_unregister_application(app);
00218    return res;
00219 }
00220 
00221 static int load_module(void)
00222 {
00223    return ast_register_application_xml(app, controlplayback_exec);
00224 }
00225 
00226 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Control Playback Application");

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