Removing registrar_expire from basic-pbx config
[asterisk/asterisk.git] / res / res_remb_modifier.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2018, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@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  * \file
21  *
22  * \brief REMB Modifier Module
23  *
24  * \author Joshua Colp <jcolp@digium.com>
25  */
26
27 /*** MODULEINFO
28         <support_level>extended</support_level>
29         <defaultenabled>no</defaultenabled>
30  ***/
31
32 #include "asterisk.h"
33
34 #include "asterisk/module.h"
35 #include "asterisk/cli.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/framehook.h"
38 #include "asterisk/rtp_engine.h"
39
40 struct remb_values {
41         /*! \brief The amount of bitrate to use for REMB received from the channel */
42         unsigned int receive_bitrate;
43         /*! \brief The amount of bitrate to use for REMB sent to the channel */
44         unsigned int send_bitrate;
45 };
46
47 static void remb_values_free(void *data)
48 {
49         ast_free(data);
50 }
51
52 static const struct ast_datastore_info remb_info = {
53         .type = "REMB Values",
54         .destroy = remb_values_free,
55 };
56
57 static struct ast_frame *remb_hook_event_cb(struct ast_channel *chan, struct ast_frame *frame, enum ast_framehook_event event, void *data)
58 {
59         struct ast_rtp_rtcp_feedback *feedback;
60         struct ast_datastore *remb_store;
61         struct remb_values *remb_values;
62
63         if (!frame) {
64                 return NULL;
65         }
66
67         switch (event) {
68         case AST_FRAMEHOOK_EVENT_READ:
69         case AST_FRAMEHOOK_EVENT_WRITE:
70                 break;
71         case AST_FRAMEHOOK_EVENT_ATTACHED:
72         case AST_FRAMEHOOK_EVENT_DETACHED:
73                 return frame;
74         }
75
76         /* We only care about REMB frames, all others will be unmodified */
77         if (frame->subclass.integer != AST_RTP_RTCP_PSFB) {
78                 return frame;
79         }
80
81         feedback = frame->data.ptr;
82         if (feedback->fmt != AST_RTP_RTCP_FMT_REMB) {
83                 return frame;
84         }
85
86         remb_store = ast_channel_datastore_find(chan, &remb_info, NULL);
87         if (!remb_store) {
88                 return frame;
89         }
90         remb_values = remb_store->data;
91
92         /* If a bitrate override has been set apply it to the REMB Frame */
93         if (event == AST_FRAMEHOOK_EVENT_READ && remb_values->receive_bitrate) {
94                 feedback->remb.br_mantissa = remb_values->receive_bitrate;
95                 feedback->remb.br_exp = 0;
96         } else if (event == AST_FRAMEHOOK_EVENT_WRITE && remb_values->send_bitrate) {
97                 feedback->remb.br_mantissa = remb_values->send_bitrate;
98                 feedback->remb.br_exp = 0;
99         }
100
101         /* The mantissa only has 18 bits available, so while it exceeds them we bump
102          * up the exp.
103          */
104         while (feedback->remb.br_mantissa > 0x3ffff) {
105                 feedback->remb.br_mantissa = feedback->remb.br_mantissa >> 1;
106                 feedback->remb.br_exp++;
107         }
108
109         return frame;
110 }
111
112 static char *handle_remb_set(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
113 {
114         struct ast_channel *chan;
115         unsigned int bitrate;
116         struct ast_datastore *remb_store;
117         struct remb_values *remb_values;
118         struct ast_framehook_interface interface = {
119                 .version = AST_FRAMEHOOK_INTERFACE_VERSION,
120                 .event_cb = remb_hook_event_cb,
121         };
122
123         switch(cmd) {
124         case CLI_INIT:
125                 e->command = "remb set {send|receive}";
126                 e->usage =
127                         "Usage: remb set {send|receive} <channel> <bitrate in bits>\n"
128                         "       Set the REMB value which overwrites what we send or receive\n";
129                 return NULL;
130         case CLI_GENERATE:
131                 return ast_complete_channels(a->line, a->word, a->pos, a->n, 3);
132         }
133
134         if (a->argc != 5) {
135                 return CLI_SHOWUSAGE;
136         }
137
138         if (sscanf(a->argv[4], "%30d", &bitrate) != 1) {
139                 ast_cli(a->fd, "%s is not a valid bitrate in bits\n", a->argv[4]);
140                 return CLI_SUCCESS;
141         } else if (strcasecmp(a->argv[2], "send") && strcasecmp(a->argv[2], "receive")) {
142                 ast_cli(a->fd, "%s is not a valid direction for REMB\n", a->argv[2]);
143                 return CLI_SUCCESS;
144         }
145
146         chan = ast_channel_get_by_name(a->argv[3]);
147         if (!chan) {
148                 ast_cli(a->fd, "%s is not a known channel\n", a->argv[3]);
149                 return CLI_SUCCESS;
150         }
151
152         ast_channel_lock(chan);
153
154         remb_store = ast_channel_datastore_find(chan, &remb_info, NULL);
155         if (!remb_store) {
156                 int framehook_id;
157
158                 framehook_id = ast_framehook_attach(chan, &interface);
159                 if (framehook_id < 0) {
160                         ast_cli(a->fd, "Could not attach framehook for modifying REMB\n");
161                         ast_channel_unlock(chan);
162                         ast_channel_unref(chan);
163                         return CLI_SUCCESS;
164                 }
165
166                 remb_values = ast_calloc(1, sizeof(*remb_values));
167                 if (!remb_values) {
168                         ast_cli(a->fd, "Could not create a place to store provided REMB value\n");
169                         ast_framehook_detach(chan, framehook_id);
170                         ast_channel_unlock(chan);
171                         ast_channel_unref(chan);
172                         return CLI_SUCCESS;
173                 }
174
175                 remb_store = ast_datastore_alloc(&remb_info, NULL);
176                 if (!remb_store) {
177                         ast_cli(a->fd, "Could not create a place to store provided REMB value\n");
178                         ast_framehook_detach(chan, framehook_id);
179                         ast_channel_unlock(chan);
180                         ast_channel_unref(chan);
181                         ast_free(remb_values);
182                         return CLI_SUCCESS;
183                 }
184
185                 remb_store->data = remb_values;
186                 ast_channel_datastore_add(chan, remb_store);
187         } else {
188                 remb_values = remb_store->data;
189         }
190
191         if (!strcasecmp(a->argv[2], "send")) {
192                 remb_values->send_bitrate = bitrate;
193         } else if (!strcasecmp(a->argv[2], "receive")) {
194                 remb_values->receive_bitrate = bitrate;
195         }
196
197         ast_channel_unlock(chan);
198         ast_channel_unref(chan);
199
200         ast_cli(a->fd, "Set REMB %s override to a bitrate of %s on %s\n", a->argv[2], a->argv[3], a->argv[4]);
201
202         return CLI_SUCCESS;
203 }
204
205 static struct ast_cli_entry remb_cli[] = {
206         AST_CLI_DEFINE(handle_remb_set, "Set the REMB value which overwrites what is sent or received"),
207 };
208
209 static int load_module(void)
210 {
211         ast_cli_register_multiple(remb_cli, ARRAY_LEN(remb_cli));
212         return AST_MODULE_LOAD_SUCCESS;
213 }
214
215 static int unload_module(void)
216 {
217         ast_cli_unregister_multiple(remb_cli, ARRAY_LEN(remb_cli));
218         return 0;
219 }
220
221 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "REMB Modifier Module",
222         .support_level = AST_MODULE_SUPPORT_EXTENDED,
223         .load = load_module,
224         .unload = unload_module,
225 );