aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSylvain Munaut <tnt@246tNt.com>2019-05-15 17:34:13 +0200
committerSylvain Munaut <tnt@246tNt.com>2019-05-15 17:34:13 +0200
commit35f8ba0b7fb36e38671b6c6fadc58cdf57ac68dc (patch)
treec743a37a3a19e34d51e1c1e372270a125153b22e
parentcdac620579b5bf44970b5f4bb11734fdfdf5bf59 (diff)
codec/ecu: Add a bit of precision about the actual frame format used
Change-Id: I9620088e449c31e966ecb9ec5ddf283b949c5a4a Signed-off-by: Sylvain Munaut <tnt@246tNt.com>
-rw-r--r--src/codec/ecu_fr.c9
1 files changed, 7 insertions, 2 deletions
diff --git a/src/codec/ecu_fr.c b/src/codec/ecu_fr.c
index 784a5b8..20a0f89 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)
{