Mostly cleanup of documentation to substitute the pipe with the comma, but a few...
[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 "  o(#) - Start at # ms from the beginning of the file.\n"
65 "This application sets the following channel variables upon completion:\n"
66 "  CPLAYBACKSTATUS -  This variable contains the status of the attempt as a text\n"
67 "                     string, one of: SUCCESS | USERSTOPPED | ERROR\n"
68 "  CPLAYBACKOFFSET -  This contains the offset in ms into the file where\n"
69 "                     playback was at when it stopped.  -1 is end of file.\n";
70
71 enum {
72         OPT_OFFSET = (1 << 1),
73 };
74
75 enum {
76         OPT_ARG_OFFSET = 0,
77         /* must stay as the last entry ... */
78         OPT_ARG_ARRAY_LEN,
79 };
80
81 AST_APP_OPTIONS(cpb_opts, BEGIN_OPTIONS
82         AST_APP_OPTION_ARG('o', OPT_OFFSET, OPT_ARG_OFFSET),
83 END_OPTIONS );
84
85 static int is_on_phonepad(char key)
86 {
87         return key == 35 || key == 42 || (key >= 48 && key <= 57);
88 }
89
90 static int controlplayback_exec(struct ast_channel *chan, void *data)
91 {
92         int res = 0;
93         int skipms = 0;
94         long offsetms = 0;
95         char offsetbuf[20];
96         char *tmp;
97         struct ast_flags opts = { 0, };
98         char *opt_args[OPT_ARG_ARRAY_LEN];
99         AST_DECLARE_APP_ARGS(args,
100                 AST_APP_ARG(filename);
101                 AST_APP_ARG(skip);
102                 AST_APP_ARG(fwd);
103                 AST_APP_ARG(rev);
104                 AST_APP_ARG(stop);
105                 AST_APP_ARG(pause);
106                 AST_APP_ARG(restart);
107                 AST_APP_ARG(options);
108         );
109
110         if (ast_strlen_zero(data)) {
111                 ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
112                 return -1;
113         }
114         
115         tmp = ast_strdupa(data);
116         AST_STANDARD_APP_ARGS(args, tmp);
117
118         if (args.argc < 1) {
119                 ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
120                 return -1;
121         }
122
123         skipms = args.skip ? (atoi(args.skip) ? atoi(args.skip) : 3000) : 3000;
124
125         if (!args.fwd || !is_on_phonepad(*args.fwd))
126                 args.fwd = "#";
127         if (!args.rev || !is_on_phonepad(*args.rev))
128                 args.rev = "*";
129         if (args.stop && !is_on_phonepad(*args.stop))
130                 args.stop = NULL;
131         if (args.pause && !is_on_phonepad(*args.pause))
132                 args.pause = NULL;
133         if (args.restart && !is_on_phonepad(*args.restart))
134                 args.restart = NULL;
135
136         if (args.options) {
137                 ast_app_parse_options(cpb_opts, &opts, opt_args, args.options);         
138                 if (ast_test_flag(&opts, OPT_OFFSET))
139                         offsetms = atol(opt_args[OPT_ARG_OFFSET]);
140         }
141
142         res = ast_control_streamfile(chan, args.filename, args.fwd, args.rev, args.stop, args.pause, args.restart, skipms, &offsetms);
143
144         /* If we stopped on one of our stop keys, return 0  */
145         if (args.stop && strchr(args.stop, res)) {
146                 res = 0;
147                 pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "USERSTOPPED");
148         } else {
149                 if (res < 0) {
150                         res = 0;
151                         pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "ERROR");
152                 } else
153                         pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "SUCCESS");
154         }
155
156         snprintf(offsetbuf, sizeof(offsetbuf), "%ld", offsetms);
157         pbx_builtin_setvar_helper(chan, "CPLAYBACKOFFSET", offsetbuf);
158
159         return res;
160 }
161
162 static int unload_module(void)
163 {
164         int res;
165         res = ast_unregister_application(app);
166         return res;
167 }
168
169 static int load_module(void)
170 {
171         return ast_register_application(app, controlplayback_exec, synopsis, descrip);
172 }
173
174 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Control Playback Application");