commit 98431bb3f4d4148d6a4924d687c9bd650fae6909
author Vadim Yanitskiy <vyanitskiy@sysmocom.de> Wed May 24 01:21:46 2023 +0700
committer laforge <laforge@osmocom.org> Tue May 23 19:16:39 2023 +0000
tree b6b1e3b2c582513533d14d0d9d244ce3851cb4d5
parent 0e17d5749577eee6664804f459df1e344db42f4f

coding: fix API doc: TCH/H needs 6 bursts, not 8

Change-Id: Iea787ec4c3b15a74f59d45825eae03740c5d28fa

src/coding/gsm0503_coding.c

diff --git a/src/coding/gsm0503_coding.c b/src/coding/gsm0503_coding.c
index 6f76824..f27b13d 100644
--- a/src/coding/gsm0503_coding.c
+++ b/src/coding/gsm0503_coding.c
@@ -1976,7 +1976,7 @@
 
 /*! Perform channel decoding of a HR(v1) channel according TS 05.03
  *  \param[out] tch_data Codec frame in TS 101 318 canonical format
- *  \param[in] bursts buffer containing the symbols of 8 bursts
+ *  \param[in] bursts buffer containing the symbols of 6 bursts
  *  \param[in] odd Odd (1) or even (0) frame number
  *  \param[out] n_errors Number of detected bit errors
  *  \param[out] n_bits_total Total number of bits
@@ -2054,7 +2054,7 @@
 /*! Perform channel decoding of a HR(v1) channel according TS 05.03,
  *  deprecated legacy API.
  *  \param[out] tch_data Codec frame in pseudo-RFC5993 format
- *  \param[in] bursts buffer containing the symbols of 8 bursts
+ *  \param[in] bursts buffer containing the symbols of 6 bursts
  *  \param[in] odd Odd (1) or even (0) frame number
  *  \param[out] n_errors Number of detected bit errors
  *  \param[out] n_bits_total Total number of bits
@@ -2635,7 +2635,7 @@
 
 /*! Perform channel decoding of a TCH/AFS channel according TS 05.03
  *  \param[out] tch_data Codec frame in RTP payload format
- *  \param[in] bursts buffer containing the symbols of 8 bursts
+ *  \param[in] bursts buffer containing the symbols of 6 bursts
  *  \param[in] odd Is this an odd (1) or even (0) frame number?
  *  \param[in] codec_mode_req is this CMR (1) or CMC (0)
  *  \param[in] codec array of active codecs (active codec set)
@@ -2658,7 +2658,7 @@
 
 /*! Perform channel decoding of a TCH/AFS channel according TS 05.03
  *  \param[out] tch_data Codec frame in RTP payload format
- *  \param[in] bursts buffer containing the symbols of 8 bursts
+ *  \param[in] bursts buffer containing the symbols of 6 bursts
  *  \param[in] odd Is this an odd (1) or even (0) frame number?
  *  \param[in] codec_mode_req is this CMR (1) or CMC (0)
  *  \param[in] codec array of active codecs (active codec set)