apps/app_controlplayback.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 1999 - 2005, Digium, Inc.
   5  *
   6  * Mark Spencer <markster@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 control playback of a sound file
  22  *
  23  * \author Mark Spencer <markster@digium.com>
  24  *
  25  * \ingroup applications
  26  */
  27
  28 #include "asterisk.h"
  29
  30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  31
  32 #include "asterisk/pbx.h"
  33 #include "asterisk/app.h"
  34 #include "asterisk/module.h"
  35
  36 static const char *app = "ControlPlayback";
  37
  38 static const char *synopsis = "Play a file with fast forward and rewind";
  39
  40 static const char *descrip =
  41 "  ControlPlayback(file[,skipms[,ff[,rew[,stop[,pause[,restart,options]]]]]]]):\n"
  42 "This application will play back the given filename. By default, the '*' key\n"
  43 "can be used to rewind, and the '#' key can be used to fast-forward.\n"
  44 "Parameters:\n"
  45 "  skipms  - This is number of milliseconds to skip when rewinding or\n"
  46 "            fast-forwarding.\n"
  47 "  ff      - Fast-forward when this DTMF digit is received.\n"
  48 "  rew     - Rewind when this DTMF digit is received.\n"
  49 "  stop    - Stop playback when this DTMF digit is received.\n"
  50 "  pause   - Pause playback when this DTMF digit is received.\n"
  51 "  restart - Restart playback when this DTMF digit is received.\n"
  52 "Options:\n"
  53 "  o(#) - Start at # ms from the beginning of the file.\n"
  54 "This application sets the following channel variables upon completion:\n"
  55 "  CPLAYBACKSTATUS -  This variable contains the status of the attempt as a text\n"
  56 "                     string, one of: SUCCESS | USERSTOPPED | ERROR\n"
  57 "  CPLAYBACKOFFSET -  This contains the offset in ms into the file where\n"
  58 "                     playback was at when it stopped.  -1 is end of file.\n"
  59 "  CPLAYBACKSTOPKEY - If the playback is stopped by the user this variable contains\n"
  60 "                     the key that was pressed.\n";
  61
  62 enum {
  63         OPT_OFFSET = (1 << 1),
  64 };
  65
  66 enum {
  67         OPT_ARG_OFFSET = 0,
  68         /* must stay as the last entry ... */
  69         OPT_ARG_ARRAY_LEN,
  70 };
  71
  72 AST_APP_OPTIONS(cpb_opts, BEGIN_OPTIONS
  73         AST_APP_OPTION_ARG('o', OPT_OFFSET, OPT_ARG_OFFSET),
  74         END_OPTIONS
  75 );
  76
  77 static int is_on_phonepad(char key)
  78 {
  79         return key == 35 || key == 42 || (key >= 48 && key <= 57);
  80 }
  81
  82 static int is_argument(const char *haystack, int needle)
  83 {
  84         if (ast_strlen_zero(haystack))
  85                 return 0;
  86
  87         if (strchr(haystack, needle))
  88                 return -1;
  89
  90         return 0;
  91 }
  92
  93 static int controlplayback_exec(struct ast_channel *chan, void *data)
  94 {
  95         int res = 0;
  96         int skipms = 0;
  97         long offsetms = 0;
  98         char offsetbuf[20];
  99         char stopkeybuf[2];
 100         char *tmp;
 101         struct ast_flags opts = { 0, };
 102         char *opt_args[OPT_ARG_ARRAY_LEN];
 103         AST_DECLARE_APP_ARGS(args,
 104                 AST_APP_ARG(filename);
 105                 AST_APP_ARG(skip);
 106                 AST_APP_ARG(fwd);
 107                 AST_APP_ARG(rev);
 108                 AST_APP_ARG(stop);
 109                 AST_APP_ARG(pause);
 110                 AST_APP_ARG(restart);
 111                 AST_APP_ARG(options);
 112         );
 113
 114         if (ast_strlen_zero(data)) {
 115                 ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
 116                 return -1;
 117         }
 118
 119         tmp = ast_strdupa(data);
 120         AST_STANDARD_APP_ARGS(args, tmp);
 121
 122         if (args.argc < 1) {
 123                 ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
 124                 return -1;
 125         }
 126
 127         skipms = args.skip ? (atoi(args.skip) ? atoi(args.skip) : 3000) : 3000;
 128
 129         if (!args.fwd || !is_on_phonepad(*args.fwd)) {
 130                 char *digit = "#";
 131                 if (!is_argument(args.rev, *digit) && !is_argument(args.stop, *digit) && !is_argument(args.pause, *digit) && !is_argument(args.restart, *digit))
 132                         args.fwd = digit;
 133                 else
 134                         args.fwd = NULL;
 135         }
 136         if (!args.rev || !is_on_phonepad(*args.rev)) {
 137                 char *digit = "*";
 138                 if (!is_argument(args.fwd, *digit) && !is_argument(args.stop, *digit) && !is_argument(args.pause, *digit) && !is_argument(args.restart, *digit))
 139                         args.rev = digit;
 140                 else
 141                         args.rev = NULL;
 142         }
 143         ast_log(LOG_WARNING, "args.fwd = %s, args.rew = %s\n", args.fwd, args.rev);
 144         if (args.stop && !is_on_phonepad(*args.stop))
 145                 args.stop = NULL;
 146         if (args.pause && !is_on_phonepad(*args.pause))
 147                 args.pause = NULL;
 148         if (args.restart && !is_on_phonepad(*args.restart))
 149                 args.restart = NULL;
 150
 151         if (args.options) {
 152                 ast_app_parse_options(cpb_opts, &opts, opt_args, args.options);
 153                 if (ast_test_flag(&opts, OPT_OFFSET))
 154                         offsetms = atol(opt_args[OPT_ARG_OFFSET]);
 155         }
 156
 157         res = ast_control_streamfile(chan, args.filename, args.fwd, args.rev, args.stop, args.pause, args.restart, skipms, &offsetms);
 158
 159         /* If we stopped on one of our stop keys, return 0  */
 160         if (res > 0 && args.stop && strchr(args.stop, res)) {
 161                 pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "USERSTOPPED");
 162                 snprintf(stopkeybuf, sizeof(stopkeybuf), "%c", res);
 163                 pbx_builtin_setvar_helper(chan, "CPLAYBACKSTOPKEY", stopkeybuf);
 164                 res = 0;
 165         } else {
 166                 if (res < 0) {
 167                         res = 0;
 168                         pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "ERROR");
 169                 } else
 170                         pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "SUCCESS");
 171         }
 172
 173         snprintf(offsetbuf, sizeof(offsetbuf), "%ld", offsetms);
 174         pbx_builtin_setvar_helper(chan, "CPLAYBACKOFFSET", offsetbuf);
 175
 176         return res;
 177 }
 178
 179 static int unload_module(void)
 180 {
 181         int res;
 182         res = ast_unregister_application(app);
 183         return res;
 184 }
 185
 186 static int load_module(void)
 187 {
 188         return ast_register_application(app, controlplayback_exec, synopsis, descrip);
 189 }
 190
 191 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Control Playback Application");