Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 1 | module MGCP_Types { |
Harald Welte | 35bb716 | 2018-01-03 21:07:52 +0100 | [diff] [blame] | 2 | |
| 3 | /* Definition of abstract types for the MGCP protocol as specified in |
| 4 | * IETF RFC 3435. Uses the TITAN "TEXT" codec to auto-generate encoder/decoder |
| 5 | * functions, as well as the SDP type definitions and coder from Ericsson. |
| 6 | * |
| 7 | * (C) 2017 by Harald Welte <laforge@gnumonks.org> |
| 8 | * All rights reserved. |
| 9 | * |
| 10 | * Released under the terms of GNU General Public License, Version 2 or |
| 11 | * (at your option) any later version. |
| 12 | */ |
| 13 | |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 14 | import from SDP_Types all; |
| 15 | |
| 16 | type charstring MgcpVerb ("EPCF", "CRCX", "MDCX", "DLCX", "RQNT", "NTFY", |
| 17 | "AUEP", "AUCX", "RSIP") with { |
Harald Welte | 7dc5d37 | 2017-11-24 20:41:04 +0100 | [diff] [blame] | 18 | /* see https://www.eclipse.org/forums/index.php/t/1088893/ on why this |
| 19 | * match expression is needed here */ |
| 20 | variant "TEXT_CODING(,convert=upper_case,'((EPCF)|(CRCX)|(MDCX)|(DLCX)|(RQNT)|(NTFY)|(AUEP)|(AUCX)|(RSIP))',case_insensitive)" |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 21 | }; |
| 22 | type charstring MgcpTransId (pattern "\d#(1,9)"); |
| 23 | type charstring MgcpEndpoint (pattern "*@*"); |
Harald Welte | 3c6ebb9 | 2017-09-16 00:56:57 +0800 | [diff] [blame] | 24 | type hexstring MgcpCallId length(1..32); /* 3.2.2.2 */ |
| 25 | type hexstring MgcpConnectionId length(1..32); /* 3.2.2.5 */ |
| 26 | type hexstring MgcpRequestId length(1..32); /* 3.2.2.18 */ |
Pau Espin Pedrol | b2c6b38 | 2019-05-14 13:40:49 +0200 | [diff] [blame] | 27 | type integer MgcpOsmuxCID (-1 .. 255); |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 28 | type charstring MgcpResponseCode (pattern "\d#(3)"); |
| 29 | |
| 30 | type charstring MgcpInfoCode ("B", "C", "I", "N", "X", "L", "M", "R", |
| 31 | "S", "D", "O", "P", "E", "Z", "Q", "T", |
| 32 | "RC", "LC", "A", "ES", "RM", "RD", "PL", |
Pau Espin Pedrol | b2c6b38 | 2019-05-14 13:40:49 +0200 | [diff] [blame] | 33 | "MD", "X-OSMO-CP", "X-OSMUX") with { |
| 34 | variant "TEXT_CODING(,convert=upper_case,'([BCINXLMRSDOPEZQTA])|(RC)|(LC)|(ES)|(RM)|(RD)|(PL)|(MD)|(X-OSMO-CP)|(X-OSMUX)',case_insensitive)" |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 35 | }; |
| 36 | |
Harald Welte | 3c6ebb9 | 2017-09-16 00:56:57 +0800 | [diff] [blame] | 37 | /* 3.2.2.6 */ |
| 38 | type charstring MgcpConnectionMode ("sendonly", "recvonly", "sendrecv", "confrnce", |
| 39 | "inactive", "loopback", "conttest", "netwloop", |
| 40 | "netwtest"); |
| 41 | |
| 42 | /* 3.2.2.10 */ |
| 43 | type charstring MgcpLocalConnOptKeys ("a", "p", "b", "t", "e", "gc", "s", "r", "k", |
| 44 | "nt", "r"); |
| 45 | |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 46 | type charstring MgcpVersion (pattern "\d.\d") with { |
| 47 | variant "BEGIN('MGCP ')" |
| 48 | } |
| 49 | |
| 50 | type record MgcpCommandLine { |
| 51 | MgcpVerb verb, |
| 52 | MgcpTransId trans_id, |
| 53 | MgcpEndpoint ep, |
| 54 | MgcpVersion ver |
| 55 | } with { |
| 56 | variant "SEPARATOR(' ', '[\t ]+')" |
Neels Hofmeyr | f6e991c | 2019-09-18 19:43:28 +0200 | [diff] [blame] | 57 | variant "END('\r\n', '([\r\n])|(\r\n)')" |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 58 | } |
| 59 | |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 60 | type record MgcpParameter { |
| 61 | MgcpInfoCode code, |
| 62 | charstring val optional |
| 63 | } with { |
| 64 | variant "BEGIN('')" |
| 65 | variant "SEPARATOR(': ', ':[\t ]+')" |
Neels Hofmeyr | f6e991c | 2019-09-18 19:43:28 +0200 | [diff] [blame] | 66 | variant "END('\r\n', '([\r\n])|(\r\n)')" |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 67 | } |
| 68 | |
Harald Welte | e636afd | 2017-09-17 16:24:09 +0800 | [diff] [blame] | 69 | type set of MgcpParameter MgcpParameterList with { |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 70 | variant "BEGIN('')" |
| 71 | }; |
| 72 | |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 73 | type record MgcpCommand { |
| 74 | MgcpCommandLine line, |
| 75 | MgcpParameterList params optional, |
Harald Welte | 12000e2 | 2017-09-14 22:43:08 +0800 | [diff] [blame] | 76 | SDP_Message sdp optional |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 77 | } with { |
| 78 | variant "BEGIN('')" |
Neels Hofmeyr | f6e991c | 2019-09-18 19:43:28 +0200 | [diff] [blame] | 79 | variant (sdp) "BEGIN('\r\n','([\r\n])|(\r\n)')" |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 80 | } |
| 81 | |
| 82 | external function enc_MgcpCommand(in MgcpCommand id) return charstring |
| 83 | with { extension "prototype(convert) encode(TEXT)" }; |
| 84 | external function dec_MgcpCommand(in charstring id) return MgcpCommand |
| 85 | with { extension "prototype(convert) decode(TEXT)" }; |
| 86 | |
| 87 | type record MgcpResponseLine { |
| 88 | MgcpResponseCode code, |
| 89 | MgcpTransId trans_id, |
| 90 | charstring string optional |
| 91 | } with { |
| 92 | variant "SEPARATOR(' ', '[\t ]+')" |
Neels Hofmeyr | f6e991c | 2019-09-18 19:43:28 +0200 | [diff] [blame] | 93 | variant "END('\r\n', '([\r\n])|(\r\n)')" |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 94 | } |
| 95 | |
| 96 | type record MgcpResponse { |
| 97 | MgcpResponseLine line, |
| 98 | MgcpParameterList params optional, |
Harald Welte | 12000e2 | 2017-09-14 22:43:08 +0800 | [diff] [blame] | 99 | SDP_Message sdp optional |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 100 | } with { |
| 101 | variant "BEGIN('')" |
Neels Hofmeyr | f6e991c | 2019-09-18 19:43:28 +0200 | [diff] [blame] | 102 | variant (sdp) "BEGIN('\r\n','([\r\n])|(\r\n)')" |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 103 | } |
| 104 | |
| 105 | external function enc_MgcpResponse(in MgcpResponse id) return charstring |
| 106 | with { extension "prototype(convert) encode(TEXT)" }; |
| 107 | external function dec_MgcpResponse(in charstring id) return MgcpResponse |
| 108 | with { extension "prototype(convert) decode(TEXT)" }; |
| 109 | |
Harald Welte | 2c6dba1 | 2017-09-16 00:50:08 +0800 | [diff] [blame] | 110 | type union MgcpMessage { |
| 111 | MgcpCommand command, |
| 112 | MgcpResponse response |
| 113 | } with { |
| 114 | variant "BEGIN('')" |
| 115 | } |
| 116 | |
| 117 | external function enc_MgcpMessage(in MgcpMessage id) return charstring |
| 118 | with { extension "prototype(convert) encode(TEXT)" }; |
| 119 | external function dec_MgcpMessage(in charstring id) return MgcpMessage |
| 120 | with { extension "prototype(convert) decode(TEXT)" }; |
| 121 | |
Philipp Maier | 11a5894 | 2018-06-25 16:40:48 +0200 | [diff] [blame] | 122 | /* IANA / 3gpp assigned payload type numbers */ |
| 123 | type enumerated SDP_FIELD_PayloadType { |
| 124 | PT_PCMU(0), |
| 125 | PT_GSM(3), |
| 126 | PT_PCMA(8), |
| 127 | PT_G729(18), |
| 128 | PT_GSMEFR(110), |
| 129 | PT_GSMHR(111), |
| 130 | PT_AMR(112), |
| 131 | PT_AMRWB(113) |
| 132 | } |
Harald Welte | 00a067f | 2017-09-13 23:27:17 +0200 | [diff] [blame] | 133 | |
| 134 | } with { encode "TEXT" } |