Add variable to show which key was pressed to stop playback.
[asterisk/asterisk.git] / 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 static int is_on_phonepad(char key)
77 {
78         return key == 35 || key == 42 || (key >= 48 && key <= 57);
79 }
80
81 static int controlplayback_exec(struct ast_channel *chan, void *data)
82 {
83         int res = 0;
84         int skipms = 0;
85         long offsetms = 0;
86         char offsetbuf[20];
87         char stopkeybuf[2];
88         char *tmp;
89         struct ast_flags opts = { 0, };
90         char *opt_args[OPT_ARG_ARRAY_LEN];
91         AST_DECLARE_APP_ARGS(args,
92                 AST_APP_ARG(filename);
93                 AST_APP_ARG(skip);
94                 AST_APP_ARG(fwd);
95                 AST_APP_ARG(rev);
96                 AST_APP_ARG(stop);
97                 AST_APP_ARG(pause);
98                 AST_APP_ARG(restart);
99                 AST_APP_ARG(options);
100         );
101
102         if (ast_strlen_zero(data)) {
103                 ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
104                 return -1;
105         }
106         
107         tmp = ast_strdupa(data);
108         AST_STANDARD_APP_ARGS(args, tmp);
109
110         if (args.argc < 1) {
111                 ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
112                 return -1;
113         }
114
115         skipms = args.skip ? (atoi(args.skip) ? atoi(args.skip) : 3000) : 3000;
116
117         if (!args.fwd || !is_on_phonepad(*args.fwd))
118                 args.fwd = "#";
119         if (!args.rev || !is_on_phonepad(*args.rev))
120                 args.rev = "*";
121         if (args.stop && !is_on_phonepad(*args.stop))
122                 args.stop = NULL;
123         if (args.pause && !is_on_phonepad(*args.pause))
124                 args.pause = NULL;
125         if (args.restart && !is_on_phonepad(*args.restart))
126                 args.restart = NULL;
127
128         if (args.options) {
129                 ast_app_parse_options(cpb_opts, &opts, opt_args, args.options);         
130                 if (ast_test_flag(&opts, OPT_OFFSET))
131                         offsetms = atol(opt_args[OPT_ARG_OFFSET]);
132         }
133
134         res = ast_control_streamfile(chan, args.filename, args.fwd, args.rev, args.stop, args.pause, args.restart, skipms, &offsetms);
135
136         /* If we stopped on one of our stop keys, return 0  */
137         if (res > 0 && args.stop && strchr(args.stop, res)) {
138                 pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "USERSTOPPED");
139                 snprintf(stopkeybuf, sizeof(stopkeybuf), "%c", res);
140                 pbx_builtin_setvar_helper(chan, "CPLAYBACKSTOPKEY", stopkeybuf);
141                 res = 0;
142         } else {
143                 if (res < 0) {
144                         res = 0;
145                         pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "ERROR");
146                 } else
147                         pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "SUCCESS");
148         }
149
150         snprintf(offsetbuf, sizeof(offsetbuf), "%ld", offsetms);
151         pbx_builtin_setvar_helper(chan, "CPLAYBACKOFFSET", offsetbuf);
152
153         return res;
154 }
155
156 static int unload_module(void)
157 {
158         int res;
159         res = ast_unregister_application(app);
160         return res;
161 }
162
163 static int load_module(void)
164 {
165         return ast_register_application(app, controlplayback_exec, synopsis, descrip);
166 }
167
168 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Control Playback Application");