blob: 3cecb8f7633e61a5caf970e713802f928eba46f6 [file] [log] [blame]
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +02001#pragma once
2
3#include <stdint.h>
Philipp Maier1dc6be62017-10-05 18:25:37 +02004#include <arpa/inet.h>
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +02005
Neels Hofmeyrd95ab1e2017-09-22 00:52:54 +02006#include <osmocom/mgcp_client/mgcp_common.h>
7
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +02008#define MGCP_CLIENT_LOCAL_ADDR_DEFAULT "0.0.0.0"
9#define MGCP_CLIENT_LOCAL_PORT_DEFAULT 0
10#define MGCP_CLIENT_REMOTE_ADDR_DEFAULT "127.0.0.1"
11#define MGCP_CLIENT_REMOTE_PORT_DEFAULT 2427
12
13struct msgb;
14struct vty;
15struct mgcp_client;
16
17struct mgcp_client_conf {
18 const char *local_addr;
19 int local_port;
20 const char *remote_addr;
21 int remote_port;
22 uint16_t first_endpoint;
23 uint16_t last_endpoint;
Neels Hofmeyrc0dcc3c2017-12-02 18:31:34 +000024 uint16_t bts_base;
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +020025};
26
27typedef unsigned int mgcp_trans_id_t;
28
Philipp Maier704c4f02018-06-07 18:51:31 +020029/*! Enumeration of the codec types that mgcp_client is able to handle. */
30enum mgcp_codecs {
31 CODEC_PCMU_8000_1 = 0,
32 CODEC_GSM_8000_1 = 3,
33 CODEC_PCMA_8000_1 = 8,
34 CODEC_G729_8000_1 = 18,
35 CODEC_GSMEFR_8000_1 = 110,
36 CODEC_GSMHR_8000_1 = 111,
37 CODEC_AMR_8000_1 = 112,
38 CODEC_AMRWB_16000_1 = 113,
39};
40/* Note: when new codec types are added, the corresponding value strings
41 * in mgcp_client.c (codec_table) must be updated as well. Enumerations
42 * in enum mgcp_codecs must correspond to a valid payload type. However,
43 * this is an internal assumption that is made to avoid lookup tables.
44 * The API-User should not rely on this coincidence! */
45
46/*! Structure to build a payload type map to allow the defiition custom payload
47 * types. */
48struct ptmap {
49 /*!< codec for which a payload type number should be defined */
50 enum mgcp_codecs codec;
51
52 /*!< payload type number (96-127) */
53 unsigned int pt;
54};
55
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +020056struct mgcp_response_head {
Philipp Maieread2f602017-11-27 12:06:29 +010057 int response_code;
58 mgcp_trans_id_t trans_id;
Philipp Maierabe8c892018-01-20 00:15:12 +010059 char comment[MGCP_COMMENT_MAXLEN];
Philipp Maier01d24a32017-11-21 17:26:09 +010060 char conn_id[MGCP_CONN_ID_LENGTH];
Philipp Maier55295f72018-01-15 14:00:28 +010061 char endpoint[MGCP_ENDPOINT_MAXLEN];
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +020062};
63
64struct mgcp_response {
65 char *body;
66 struct mgcp_response_head head;
67 uint16_t audio_port;
Philipp Maier06da85e2017-10-05 18:49:24 +020068 char audio_ip[INET_ADDRSTRLEN];
Philipp Maier704c4f02018-06-07 18:51:31 +020069 unsigned int ptime;
70 enum mgcp_codecs codecs[MGCP_MAX_CODECS];
71 unsigned int codecs_len;
72 struct ptmap ptmap[MGCP_MAX_CODECS];
73 unsigned int ptmap_len;
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +020074};
75
Philipp Maier1dc6be62017-10-05 18:25:37 +020076enum mgcp_verb {
77 MGCP_VERB_CRCX,
78 MGCP_VERB_MDCX,
79 MGCP_VERB_DLCX,
80 MGCP_VERB_AUEP,
81 MGCP_VERB_RSIP,
82};
83
84#define MGCP_MSG_PRESENCE_ENDPOINT 0x0001
85#define MGCP_MSG_PRESENCE_CALL_ID 0x0002
86#define MGCP_MSG_PRESENCE_CONN_ID 0x0004
87#define MGCP_MSG_PRESENCE_AUDIO_IP 0x0008
88#define MGCP_MSG_PRESENCE_AUDIO_PORT 0x0010
89#define MGCP_MSG_PRESENCE_CONN_MODE 0x0020
90
Philipp Maier1dc6be62017-10-05 18:25:37 +020091struct mgcp_msg {
92 enum mgcp_verb verb;
93 /* See MGCP_MSG_PRESENCE_* constants */
94 uint32_t presence;
95 char endpoint[MGCP_ENDPOINT_MAXLEN];
96 unsigned int call_id;
Philipp Maier01d24a32017-11-21 17:26:09 +010097 char *conn_id;
Harald Welte9bf7c532017-11-17 14:14:31 +010098 uint16_t audio_port;
99 char *audio_ip;
Philipp Maier1dc6be62017-10-05 18:25:37 +0200100 enum mgcp_connection_mode conn_mode;
Philipp Maier704c4f02018-06-07 18:51:31 +0200101 unsigned int ptime;
102 enum mgcp_codecs codecs[MGCP_MAX_CODECS];
103 unsigned int codecs_len;
104 struct ptmap ptmap[MGCP_MAX_CODECS];
105 unsigned int ptmap_len;
Philipp Maier1dc6be62017-10-05 18:25:37 +0200106};
107
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200108void mgcp_client_conf_init(struct mgcp_client_conf *conf);
109void mgcp_client_vty_init(void *talloc_ctx, int node, struct mgcp_client_conf *conf);
110int mgcp_client_config_write(struct vty *vty, const char *indent);
111struct mgcp_client_conf *mgcp_client_conf_actual(struct mgcp_client *mgcp);
112
113struct mgcp_client *mgcp_client_init(void *ctx,
114 struct mgcp_client_conf *conf);
115int mgcp_client_connect(struct mgcp_client *mgcp);
116
117const char *mgcp_client_remote_addr_str(struct mgcp_client *mgcp);
118uint16_t mgcp_client_remote_port(struct mgcp_client *mgcp);
119uint32_t mgcp_client_remote_addr_n(struct mgcp_client *mgcp);
120
121int mgcp_client_next_endpoint(struct mgcp_client *client);
122void mgcp_client_release_endpoint(uint16_t id, struct mgcp_client *client);
123
124/* Invoked when an MGCP response is received or sending failed. When the
125 * response is passed as NULL, this indicates failure during transmission. */
126typedef void (* mgcp_response_cb_t )(struct mgcp_response *response, void *priv);
127int mgcp_response_parse_params(struct mgcp_response *r);
128
129int mgcp_client_tx(struct mgcp_client *mgcp, struct msgb *msg,
130 mgcp_response_cb_t response_cb, void *priv);
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +0100131int mgcp_client_cancel(struct mgcp_client *mgcp, mgcp_trans_id_t trans_id);
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200132
133enum mgcp_connection_mode;
134
135struct msgb *mgcp_msg_crcx(struct mgcp_client *mgcp,
136 uint16_t rtp_endpoint, unsigned int call_id,
Philipp Maier1dc6be62017-10-05 18:25:37 +0200137 enum mgcp_connection_mode mode)
138OSMO_DEPRECATED("Use mgcp_msg_gen() instead");
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200139
140struct msgb *mgcp_msg_mdcx(struct mgcp_client *mgcp,
141 uint16_t rtp_endpoint, const char *rtp_conn_addr,
Philipp Maier1dc6be62017-10-05 18:25:37 +0200142 uint16_t rtp_port, enum mgcp_connection_mode mode)
143OSMO_DEPRECATED("Use mgcp_msg_gen() instead");
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200144
145struct msgb *mgcp_msg_dlcx(struct mgcp_client *mgcp, uint16_t rtp_endpoint,
Philipp Maier1dc6be62017-10-05 18:25:37 +0200146 unsigned int call_id)
147OSMO_DEPRECATED("Use mgcp_msg_gen() instead");
148
149struct msgb *mgcp_msg_gen(struct mgcp_client *mgcp, struct mgcp_msg *mgcp_msg);
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +0100150mgcp_trans_id_t mgcp_msg_trans_id(struct msgb *msg);
Neels Hofmeyrd95ab1e2017-09-22 00:52:54 +0200151
152extern const struct value_string mgcp_client_connection_mode_strs[];
153static inline const char *mgcp_client_cmode_name(enum mgcp_connection_mode mode)
154{
155 return get_value_string(mgcp_client_connection_mode_strs, mode);
156}
Philipp Maier704c4f02018-06-07 18:51:31 +0200157
158enum mgcp_codecs map_str_to_codec(const char *str);
159unsigned int map_codec_to_pt(struct ptmap *ptmap, unsigned int ptmap_len,
160 enum mgcp_codecs codec);
161enum mgcp_codecs map_pt_to_codec(struct ptmap *ptmap, unsigned int ptmap_len,
162 unsigned int pt);