falconia has uploaded this change for review. ( https://gerrit.osmocom.org/c/libosmo-abis/+/41743?usp=email )
Change subject: trau cosmetic: update osmo_trau2rtp API comments ......................................................................
trau cosmetic: update osmo_trau2rtp API comments
Since the writing of Doxygen API comments for osmo_trau2rtp() and osmo_trau2rtp_ufe(), these APIs gained the ability to convert CSD TRAU frames to TW-TS-007 in addition to CLEARMODE - document this addition. Also update comments regarding AMR, which is now supported via AMR TRAU frame interworking facility with its own API.
Change-Id: Id287474c5824ab334da244701700051f9f014e66 --- M src/trau/trau_rtp_conv.c 1 file changed, 10 insertions(+), 6 deletions(-)
git pull ssh://gerrit.osmocom.org:29418/libosmo-abis refs/changes/43/41743/1
diff --git a/src/trau/trau_rtp_conv.c b/src/trau/trau_rtp_conv.c index 9d23065..9b1dc58 100644 --- a/src/trau/trau_rtp_conv.c +++ b/src/trau/trau_rtp_conv.c @@ -1719,9 +1719,10 @@ * * In the case of FR/EFR speech, the output format is either RFC 3551 or * TW-TS-001; in the case of HRv1 speech, the output format is either RFC 5993 - * or TW-TS-002. st->rtp_extensions field selects the use or non-use of - * Themyscira RTP extensions; the structure passed in \ref st currently - * has no other uses in the TRAU->RTP direction. + * or TW-TS-002. In the case of CSD, the output format is either 160-octet + * CLEARMODE or compressed TW-TS-007. st->rtp_extensions field selects the use + * or non-use of Themyscira RTP extensions; the structure passed in \ref st + * currently has no other uses in the TRAU->RTP direction. * * The following TRAU frame types are _not_ supported: * @@ -1734,7 +1735,9 @@ * - D144 sync frames: these special frames are not convertible to RTP; * their synchronization function needs to be handled by the application. * - * - AMR speech frames: not currently implemented. + * - AMR speech frames are not supported by this API; AMR TRAU frame + * interworking facility of <osmocom/trau/amr_trau.h> needs to be used + * instead. */ int osmo_trau2rtp(uint8_t *out, size_t out_len, const struct osmo_trau_frame *tf, struct osmo_trau2rtp_state *st) @@ -1767,8 +1770,9 @@ * * - UFE checks exist only for HRv1 and EFR speech frames; for all other frame * types, this function never writes to *ufe. (AMR is another frame type - * for which TRAU-UL decoding would include a UFE check, but we currently - * don't support AMR at all.) + * for which high-level decoding can produce UFE and DFE results, but those + * frames need to be decoded with osmo_amrt_decode_trau_frame() and not the + * present API.) */ int osmo_trau2rtp_ufe(uint8_t *out, size_t out_len, const struct osmo_trau_frame *tf, struct osmo_trau2rtp_state *st, bool *ufe)