Asterisk data retrieval API.
[asterisk/asterisk.git] / apps / app_echo.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 Echo application -- play back what you hear to evaluate latency
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/file.h"
33 #include "asterisk/module.h"
34 #include "asterisk/channel.h"
35
36 /*** DOCUMENTATION
37         <application name="Echo" language="en_US">
38                 <synopsis>
39                         Echo audio, video, DTMF back to the calling party
40                 </synopsis>
41                 <syntax />
42                 <description>
43                         <para>Echos back any audio, video or DTMF frames read from the calling 
44                         channel back to itself. Note: If '#' detected application exits</para>
45                 </description>
46         </application>
47  ***/
48
49 static const char app[] = "Echo";
50
51 static int echo_exec(struct ast_channel *chan, const char *data)
52 {
53         int res = -1;
54         format_t format;
55
56         format = ast_best_codec(chan->nativeformats);
57         ast_set_write_format(chan, format);
58         ast_set_read_format(chan, format);
59
60         while (ast_waitfor(chan, -1) > -1) {
61                 struct ast_frame *f = ast_read(chan);
62                 if (!f) {
63                         break;
64                 }
65                 f->delivery.tv_sec = 0;
66                 f->delivery.tv_usec = 0;
67                 if (ast_write(chan, f)) {
68                         ast_frfree(f);
69                         goto end;
70                 }
71                 if ((f->frametype == AST_FRAME_DTMF) && (f->subclass.integer == '#')) {
72                         res = 0;
73                         ast_frfree(f);
74                         goto end;
75                 }
76                 ast_frfree(f);
77         }
78 end:
79         return res;
80 }
81
82 static int unload_module(void)
83 {
84         return ast_unregister_application(app);
85 }
86
87 static int load_module(void)
88 {
89         return ast_register_application_xml(app, echo_exec);
90 }
91
92 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Simple Echo Application");