Merged revisions 68922 via svnmerge from
[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 <stdlib.h>
33 #include <stdio.h>
34 #include <string.h>
35
36 #include "asterisk/lock.h"
37 #include "asterisk/file.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/channel.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/app.h"
42 #include "asterisk/module.h"
43 #include "asterisk/translate.h"
44 #include "asterisk/utils.h"
45 #include "asterisk/options.h"
46
47 static const char *app = "ControlPlayback";
48
49 static const char *synopsis = "Play a file with fast forward and rewind";
50
51 static const char *descrip = 
52 "  ControlPlayback(file[|skipms[|ff[|rew[|stop[|pause[|restart|options]]]]]]]):\n"
53 "This application will play back the given filename. By default, the '*' key\n"
54 "can be used to rewind, and the '#' key can be used to fast-forward.\n"
55 "Parameters:\n"
56 "  skipms  - This is number of milliseconds to skip when rewinding or\n"
57 "            fast-forwarding.\n"
58 "  ff      - Fast-forward when this DTMF digit is received.\n"
59 "  rew     - Rewind when this DTMF digit is received.\n"
60 "  stop    - Stop playback when this DTMF digit is received.\n"
61 "  pause   - Pause playback when this DTMF digit is received.\n"
62 "  restart - Restart playback when this DTMF digit is received.\n"
63 "Options:\n"
64 "  j    - Jump to priority n+101 if the requested file is not found.\n"
65 "  o(#) - Start at # ms from the beginning of the file.\n"
66 "This application sets the following channel variables upon completion:\n"
67 "  CPLAYBACKSTATUS -  This variable contains the status of the attempt as a text\n"
68 "                     string, one of: SUCCESS | USERSTOPPED | ERROR\n"
69 "  CPLAYBACKOFFSET -  This contains the offset in ms into the file where\n"
70 "                     playback was at when it stopped.  -1 is end of file.\n";
71
72 enum {
73         OPT_JUMP   = (1 << 0),
74         OPT_OFFSET = (1 << 1),
75 };
76
77 enum {
78         OPT_ARG_OFFSET = 0,
79         /* must stay as the last entry ... */
80         OPT_ARG_ARRAY_LEN,
81 };
82
83 AST_APP_OPTIONS(cpb_opts, BEGIN_OPTIONS
84         AST_APP_OPTION('j', OPT_JUMP),
85         AST_APP_OPTION_ARG('o', OPT_OFFSET, OPT_ARG_OFFSET),
86 END_OPTIONS );
87
88 static int is_on_phonepad(char key)
89 {
90         return key == 35 || key == 42 || (key >= 48 && key <= 57);
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         struct ast_module_user *u;
100         char *tmp;
101         int argc;
102         char *argv[8] = { NULL, };
103         enum arg_ids {
104                 arg_file = 0,
105                 arg_skip = 1,
106                 arg_fwd = 2,
107                 arg_rev = 3,
108                 arg_stop = 4,
109                 arg_pause = 5,
110                 arg_restart = 6,
111                 options = 7,
112         };
113         struct ast_flags opts = { 0, };
114         char *opt_args[OPT_ARG_ARRAY_LEN];
115
116         if (ast_strlen_zero(data)) {
117                 ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
118                 return -1;
119         }
120
121         u = ast_module_user_add(chan);
122         
123         tmp = ast_strdupa(data);
124
125         argc = ast_app_separate_args(tmp, '|', argv, sizeof(argv) / sizeof(argv[0]));
126
127         if (argc < 1) {
128                 ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
129                 ast_module_user_remove(u);
130                 return -1;
131         }
132
133         skipms = argv[arg_skip] ? atoi(argv[arg_skip]) : 3000;
134         if (!skipms)
135                 skipms = 3000;
136
137         if (!argv[arg_fwd] || !is_on_phonepad(*argv[arg_fwd]))
138                 argv[arg_fwd] = "#";
139         if (!argv[arg_rev] || !is_on_phonepad(*argv[arg_rev]))
140                 argv[arg_rev] = "*";
141         if (argv[arg_stop] && !is_on_phonepad(*argv[arg_stop]))
142                 argv[arg_stop] = NULL;
143         if (argv[arg_pause] && !is_on_phonepad(*argv[arg_pause]))
144                 argv[arg_pause] = NULL;
145         if (argv[arg_restart] && !is_on_phonepad(*argv[arg_restart]))
146                 argv[arg_restart] = NULL;
147
148         if (argv[options]) {
149                 ast_app_parse_options(cpb_opts, &opts, opt_args, argv[options]);                
150                 if (ast_test_flag(&opts, OPT_OFFSET))
151                         offsetms = atol(opt_args[OPT_ARG_OFFSET]);
152         }
153
154         res = ast_control_streamfile(chan, argv[arg_file], argv[arg_fwd], argv[arg_rev], argv[arg_stop], argv[arg_pause], argv[arg_restart], skipms, &offsetms);
155
156         /* If we stopped on one of our stop keys, return 0  */
157         if (argv[arg_stop] && strchr(argv[arg_stop], res)) {
158                 res = 0;
159                 pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "USERSTOPPED");
160         } else {
161                 if (res < 0) {
162                         if (ast_test_flag(&opts, OPT_JUMP) || ast_opt_priority_jumping) {
163                                 if (ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101)) {
164                                         ast_log(LOG_WARNING, "ControlPlayback tried to jump to priority n+101 as requested, but priority didn't exist\n");
165                                 }
166                         }
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         ast_module_user_remove(u);
177
178         return res;
179 }
180
181 static int unload_module(void)
182 {
183         int res;
184         res = ast_unregister_application(app);
185         return res;
186 }
187
188 static int load_module(void)
189 {
190         return ast_register_application(app, controlplayback_exec, synopsis, descrip);
191 }
192
193 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Control Playback Application");