From 35f8ba0b7fb36e38671b6c6fadc58cdf57ac68dc Mon Sep 17 00:00:00 2001 From: Sylvain Munaut Date: Wed, 15 May 2019 17:34:13 +0200 Subject: codec/ecu: Add a bit of precision about the actual frame format used Change-Id: I9620088e449c31e966ecb9ec5ddf283b949c5a4a Signed-off-by: Sylvain Munaut --- src/codec/ecu_fr.c | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'src') diff --git a/src/codec/ecu_fr.c b/src/codec/ecu_fr.c index 784a5b8e..20a0f89e 100644 --- a/src/codec/ecu_fr.c +++ b/src/codec/ecu_fr.c @@ -123,10 +123,12 @@ leave: return rc; } -/** +/*! * To be called when a good frame is received. * This function will then create a backup of the frame * and reset the internal state. + * \param[in] state The state object for the ECU + * \param[out] frame The valid frame (GSM_FR_BYTES bytes in RTP payload format) */ void osmo_ecu_fr_reset(struct osmo_ecu_fr_state *state, uint8_t *frame) { @@ -134,10 +136,13 @@ void osmo_ecu_fr_reset(struct osmo_ecu_fr_state *state, uint8_t *frame) memcpy(state->frame_backup, frame, GSM_FR_BYTES); } -/** +/*! * To be called when a bad frame is received. * This function will then generate a replacement frame * that can be used to conceal the dropout. + * \param[in] state The state object for the ECU + * \param[out] frame The buffer to fill with GSM_FR_BYTES of replacement frame + * \returns 0 if the frame was sucessfully filled */ int osmo_ecu_fr_conceal(struct osmo_ecu_fr_state *state, uint8_t *frame) { -- cgit v1.2.3