Change in libosmocore[master]: codec/ecu: Add a bit of precision about the actual frame format used

[tnt]

tnt has uploaded this change for review. ( https://gerrit.osmocom.org/14051


Change subject: codec/ecu: Add a bit of precision about the actual frame format used
......................................................................

codec/ecu: Add a bit of precision about the actual frame format used

Change-Id: I9620088e449c31e966ecb9ec5ddf283b949c5a4a
Signed-off-by: Sylvain Munaut <tnt at 246tNt.com>
---
M src/codec/ecu_fr.c
1 file changed, 7 insertions(+), 2 deletions(-)



  git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/51/14051/1

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 @@
 	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 @@
 	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)
 {

-- 
To view, visit https://gerrit.osmocom.org/14051
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-MessageType: newchange
Gerrit-Change-Id: I9620088e449c31e966ecb9ec5ddf283b949c5a4a
Gerrit-Change-Number: 14051
Gerrit-PatchSet: 1
Gerrit-Owner: tnt <tnt at 246tNt.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20190515/f9ec6ed7/attachment.htm>