update MANY more files with proper copyright/license info (thanks Ian!)
[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 /*
20  *
21  * Trivial application to control playback a sound file
22  * 
23  */
24  
25 #include <string.h>
26 #include <stdlib.h>
27
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include "asterisk/lock.h"
33 #include "asterisk/file.h"
34 #include "asterisk/logger.h"
35 #include "asterisk/channel.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/app.h"
38 #include "asterisk/module.h"
39 #include "asterisk/translate.h"
40 #include "asterisk/utils.h"
41
42 static const char *tdesc = "Control Playback Application";
43
44 static const char *app = "ControlPlayback";
45
46 static const char *synopsis = "Play a file with fast forward and rewind";
47
48 static const char *descrip = 
49 "ControlPlayback(filename[|skipms[|ffchar[|rewchar[|stopchar[|pausechar[|restartchar]]]]]]):\n"
50 "  Plays  back  a  given  filename (do not put extension). Options may also\n"
51 "  be included following a pipe symbol.  You can use * and # to rewind and\n"
52 "  fast forward the playback specified. If 'stopchar' is added the file will\n"
53 "  terminate playback when 'stopchar' is pressed. If 'restartchar' is added, the file\n"
54 "  will restart when 'restartchar' is pressed. Returns -1 if the channel\n"
55 "  was hung up. if the file does not exist jumps to n+101 if it present.\n\n"
56 "  Example:  exten => 1234,1,ControlPlayback(file|4000|*|#|1|0|5)\n\n";
57
58 STANDARD_LOCAL_USER;
59
60 LOCAL_USER_DECL;
61
62 static int is_on_phonepad(char key)
63 {
64         return key == 35 || key == 42 || (key >= 48 && key <= 57);
65 }
66
67 static int controlplayback_exec(struct ast_channel *chan, void *data)
68 {
69         int res = 0;
70         int skipms = 0;
71         struct localuser *u;
72         char *tmp;
73         int argc;
74         char *argv[7];
75         enum arg_ids {
76                 arg_file = 0,
77                 arg_skip = 1,
78                 arg_fwd = 2,
79                 arg_rev = 3,
80                 arg_stop = 4,
81                 arg_pause = 5,
82                 arg_restart = 6,
83         };
84
85         if (!data || ast_strlen_zero((char *)data)) {
86                 ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
87                 return -1;
88         }
89
90         tmp = ast_strdupa(data);
91         memset(argv, 0, sizeof(argv));
92
93         argc = ast_separate_app_args(tmp, '|', argv, sizeof(argv) / sizeof(argv[0]));
94
95         if (argc < 1) {
96                 ast_log(LOG_WARNING, "ControlPlayback requires an argument (filename)\n");
97                 return -1;
98         }
99
100         skipms = argv[arg_skip] ? atoi(argv[arg_skip]) : 3000;
101         if (!skipms)
102                 skipms = 3000;
103
104         if (!argv[arg_fwd] || !is_on_phonepad(*argv[arg_fwd]))
105                 argv[arg_fwd] = "#";
106         if (!argv[arg_rev] || !is_on_phonepad(*argv[arg_rev]))
107                 argv[arg_rev] = "*";
108         if (argv[arg_stop] && !is_on_phonepad(*argv[arg_stop]))
109                 argv[arg_stop] = NULL;
110         if (argv[arg_pause] && !is_on_phonepad(*argv[arg_pause]))
111                 argv[arg_pause] = NULL;
112         if (argv[arg_restart] && !is_on_phonepad(*argv[arg_restart]))
113                 argv[arg_restart] = NULL;
114
115         LOCAL_USER_ADD(u);
116
117         res = ast_control_streamfile(chan, argv[arg_file], argv[arg_fwd], argv[arg_rev], argv[arg_stop], argv[arg_pause], argv[arg_restart], skipms);
118
119         LOCAL_USER_REMOVE(u);
120         
121         /* If we stopped on one of our stop keys, return 0  */
122         if (argv[arg_stop] && strchr(argv[arg_stop], res)) 
123                 res = 0;
124
125         if (res < 0) {
126                 if (ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101))
127                         res = 0;
128         }
129
130         return res;
131 }
132
133 int unload_module(void)
134 {
135         STANDARD_HANGUP_LOCALUSERS;
136
137         return ast_unregister_application(app);
138 }
139
140 int load_module(void)
141 {
142         return ast_register_application(app, controlplayback_exec, synopsis, descrip);
143 }
144
145 char *description(void)
146 {
147         return (char *) tdesc;
148 }
149
150 int usecount(void)
151 {
152         int res;
153
154         STANDARD_USECOUNT(res);
155         return res;
156 }
157
158 char *key()
159 {
160         return ASTERISK_GPL_KEY;
161 }