Asterisk - The Open Source Telephony Project  GIT-master-0190e70
app_milliwatt.c
Go to the documentation of this file.
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 Digital Milliwatt Test
22  *
23  * \author Mark Spencer <markster@digium.com>
24  *
25  * \ingroup applications
26  */
27 
28 /*** MODULEINFO
29  <support_level>core</support_level>
30  ***/
31 
32 #include "asterisk.h"
33 
34 #include "asterisk/module.h"
35 #include "asterisk/channel.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/indications.h"
38 #include "asterisk/format_cache.h"
39 
40 /*** DOCUMENTATION
41  <application name="Milliwatt" language="en_US">
42  <synopsis>
43  Generate a Constant 1004Hz tone at 0dbm (mu-law).
44  </synopsis>
45  <syntax>
46  <parameter name="options">
47  <optionlist>
48  <option name="o">
49  <para>Generate the tone at 1000Hz like previous version.</para>
50  </option>
51  </optionlist>
52  </parameter>
53  </syntax>
54  <description>
55  <para>Previous versions of this application generated the tone at 1000Hz. If for
56  some reason you would prefer that behavior, supply the <literal>o</literal> option to get the
57  old behavior.</para>
58  </description>
59  </application>
60  ***/
61 
62 static const char app[] = "Milliwatt";
63 
64 static const char digital_milliwatt[] = {0x1e,0x0b,0x0b,0x1e,0x9e,0x8b,0x8b,0x9e} ;
65 
66 static void *milliwatt_alloc(struct ast_channel *chan, void *params)
67 {
68  return ast_calloc(1, sizeof(int));
69 }
70 
71 static void milliwatt_release(struct ast_channel *chan, void *data)
72 {
73  ast_free(data);
74  return;
75 }
76 
77 static int milliwatt_generate(struct ast_channel *chan, void *data, int len, int samples)
78 {
79  unsigned char buf[AST_FRIENDLY_OFFSET + 640];
80  const int maxsamples = ARRAY_LEN(buf) - (AST_FRIENDLY_OFFSET / sizeof(buf[0]));
81  int i, *indexp = (int *) data, res;
82  struct ast_frame wf = {
84  .offset = AST_FRIENDLY_OFFSET,
85  .src = __FUNCTION__,
86  };
87 
89  wf.data.ptr = buf + AST_FRIENDLY_OFFSET;
90 
91  /* Instead of len, use samples, because channel.c generator_force
92  * generate(chan, tmp, 0, 160) ignores len. In any case, len is
93  * a multiple of samples, given by number of samples times bytes per
94  * sample. In the case of ulaw, len = samples. for signed linear
95  * len = 2 * samples */
96  if (samples > maxsamples) {
97  ast_log(LOG_WARNING, "Only doing %d samples (%d requested)\n", maxsamples, samples);
98  samples = maxsamples;
99  }
100 
101  len = samples * sizeof (buf[0]);
102  wf.datalen = len;
103  wf.samples = samples;
104 
105  /* create a buffer containing the digital milliwatt pattern */
106  for (i = 0; i < len; i++) {
107  buf[AST_FRIENDLY_OFFSET + i] = digital_milliwatt[(*indexp)++];
108  *indexp &= 7;
109  }
110 
111  res = ast_write(chan, &wf);
112  ast_frfree(&wf);
113 
114  if (res < 0) {
115  ast_log(LOG_WARNING,"Failed to write frame to '%s': %s\n",ast_channel_name(chan),strerror(errno));
116  return -1;
117  }
118 
119  return 0;
120 }
121 
122 static struct ast_generator milliwattgen = {
124  .release = milliwatt_release,
125  .generate = milliwatt_generate,
126 };
127 
128 static int old_milliwatt_exec(struct ast_channel *chan)
129 {
132 
133  if (ast_channel_state(chan) != AST_STATE_UP) {
134  ast_answer(chan);
135  }
136 
137  if (ast_activate_generator(chan,&milliwattgen,"milliwatt") < 0) {
138  ast_log(LOG_WARNING,"Failed to activate generator on '%s'\n",ast_channel_name(chan));
139  return -1;
140  }
141 
142  while (!ast_safe_sleep(chan, 10000))
143  ;
144 
146 
147  return -1;
148 }
149 
150 static int milliwatt_exec(struct ast_channel *chan, const char *data)
151 {
152  const char *options = data;
153  int res = -1;
154 
155  if (!ast_strlen_zero(options) && strchr(options, 'o')) {
156  return old_milliwatt_exec(chan);
157  }
158 
159  res = ast_playtones_start(chan, 23255, "1004/1000", 0);
160 
161  while (!res) {
162  res = ast_safe_sleep(chan, 10000);
163  }
164 
165  return res;
166 }
167 
168 static int unload_module(void)
169 {
171 }
172 
173 static int load_module(void)
174 {
176 }
177 
178 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Digital Milliwatt (mu-law) Test Application");
int ast_safe_sleep(struct ast_channel *chan, int ms)
Wait for a specified amount of time, looking for hangups.
Definition: channel.c:1565
Tone Indication Support.
Main Channel structure associated with a channel.
#define AST_MODULE_INFO_STANDARD(keystr, desc)
Definition: module.h:567
Asterisk main include file. File version handling, generic pbx functions.
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
static int unload_module(void)
void *(* alloc)(struct ast_channel *chan, void *params)
Definition: channel.h:227
int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params)
Definition: channel.c:2946
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
struct ast_format * ast_format_ulaw
Built-in cached ulaw format.
Definition: format_cache.c:86
#define LOG_WARNING
Definition: logger.h:274
union ast_frame::@257 data
ast_channel_state
ast_channel states
Definition: channelstate.h:35
int ast_unregister_application(const char *app)
Unregister an application.
Definition: pbx_app.c:392
struct ast_frame_subclass subclass
#define ast_log
Definition: astobj2.c:42
General Asterisk PBX channel definitions.
#define AST_FRIENDLY_OFFSET
Offset into a frame&#39;s data buffer.
int ast_set_read_format(struct ast_channel *chan, struct ast_format *format)
Sets read format on channel chan.
Definition: channel.c:5748
static int load_module(void)
static int milliwatt_generate(struct ast_channel *chan, void *data, int len, int samples)
Definition: app_milliwatt.c:77
int ast_set_write_format(struct ast_channel *chan, struct ast_format *format)
Sets write format on channel chan.
Definition: channel.c:5789
static void * milliwatt_alloc(struct ast_channel *chan, void *params)
Definition: app_milliwatt.c:66
Core PBX routines and definitions.
static void milliwatt_release(struct ast_channel *chan, void *data)
Definition: app_milliwatt.c:71
static const char digital_milliwatt[]
Definition: app_milliwatt.c:64
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
int errno
#define ast_strlen_zero(a)
Definition: muted.c:73
#define ast_free(a)
Definition: astmm.h:182
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:204
int ast_write(struct ast_channel *chan, struct ast_frame *frame)
Write a frame to a channel This function writes the given frame to the indicated channel.
Definition: channel.c:5088
static struct ast_generator milliwattgen
static int milliwatt_exec(struct ast_channel *chan, const char *data)
void ast_deactivate_generator(struct ast_channel *chan)
Definition: channel.c:2888
const char * ast_channel_name(const struct ast_channel *chan)
#define ast_frfree(fr)
int ast_answer(struct ast_channel *chan)
Answer a channel.
Definition: channel.c:2800
Data structure associated with a single frame of data.
int ast_playtones_start(struct ast_channel *chan, int vol, const char *tonelist, int interruptible)
Start playing a list of tones on a channel.
Definition: indications.c:302
enum ast_frame_type frametype
static struct test_options options
struct ast_format * format
#define ASTERISK_GPL_KEY
The text the key() function should return.
Definition: module.h:46
Asterisk module definitions.
static const char app[]
Definition: app_milliwatt.c:62
static int old_milliwatt_exec(struct ast_channel *chan)
#define ast_register_application_xml(app, execute)
Register an application using XML documentation.
Definition: module.h:626
Media Format Cache API.