Use backticks not vertical bars to denote variables in comments for /common_audio
Bug: webrtc:12338
Change-Id: I884db28e6d9a87d343be7c2616571a8bee28252c
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/226944
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Commit-Queue: Artem Titov <titovartem@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#34568}
diff --git a/common_audio/signal_processing/dot_product_with_scale.h b/common_audio/signal_processing/dot_product_with_scale.h
index bb892d4..9f0d922 100644
--- a/common_audio/signal_processing/dot_product_with_scale.h
+++ b/common_audio/signal_processing/dot_product_with_scale.h
@@ -26,7 +26,7 @@
// - vector_length : Number of samples used in the dot product
// - scaling : The number of right bit shifts to apply on each term
// during calculation to avoid overflow, i.e., the
-// output will be in Q(-|scaling|)
+// output will be in Q(-`scaling`)
//
// Return value : The dot product in Q(-scaling)
int32_t WebRtcSpl_DotProductWithScale(const int16_t* vector1,
diff --git a/common_audio/signal_processing/include/real_fft.h b/common_audio/signal_processing/include/real_fft.h
index 8445066..a0da509 100644
--- a/common_audio/signal_processing/include/real_fft.h
+++ b/common_audio/signal_processing/include/real_fft.h
@@ -81,7 +81,7 @@
// boundary.
//
// Return Value:
-// 0 or a positive number - a value that the elements in the |real_data_out|
+// 0 or a positive number - a value that the elements in the `real_data_out`
// should be shifted left with in order to get
// correct physical values.
// -1 - Error with bad arguments (null pointers).
diff --git a/common_audio/signal_processing/include/signal_processing_library.h b/common_audio/signal_processing/include/signal_processing_library.h
index 0c13071..48c9b30 100644
--- a/common_audio/signal_processing/include/signal_processing_library.h
+++ b/common_audio/signal_processing/include/signal_processing_library.h
@@ -166,7 +166,7 @@
// - vector : 16-bit input vector.
// - length : Number of samples in vector.
//
-// Return value : Maximum sample value in |vector|.
+// Return value : Maximum sample value in `vector`.
typedef int16_t (*MaxValueW16)(const int16_t* vector, size_t length);
extern const MaxValueW16 WebRtcSpl_MaxValueW16;
int16_t WebRtcSpl_MaxValueW16C(const int16_t* vector, size_t length);
@@ -183,7 +183,7 @@
// - vector : 32-bit input vector.
// - length : Number of samples in vector.
//
-// Return value : Maximum sample value in |vector|.
+// Return value : Maximum sample value in `vector`.
typedef int32_t (*MaxValueW32)(const int32_t* vector, size_t length);
extern const MaxValueW32 WebRtcSpl_MaxValueW32;
int32_t WebRtcSpl_MaxValueW32C(const int32_t* vector, size_t length);
@@ -200,7 +200,7 @@
// - vector : 16-bit input vector.
// - length : Number of samples in vector.
//
-// Return value : Minimum sample value in |vector|.
+// Return value : Minimum sample value in `vector`.
typedef int16_t (*MinValueW16)(const int16_t* vector, size_t length);
extern const MinValueW16 WebRtcSpl_MinValueW16;
int16_t WebRtcSpl_MinValueW16C(const int16_t* vector, size_t length);
@@ -217,7 +217,7 @@
// - vector : 32-bit input vector.
// - length : Number of samples in vector.
//
-// Return value : Minimum sample value in |vector|.
+// Return value : Minimum sample value in `vector`.
typedef int32_t (*MinValueW32)(const int32_t* vector, size_t length);
extern const MinValueW32 WebRtcSpl_MinValueW32;
int32_t WebRtcSpl_MinValueW32C(const int32_t* vector, size_t length);
@@ -234,8 +234,8 @@
// - vector : 16-bit input vector.
// - length : Number of samples in vector.
// Ouput:
-// - max_val : Maximum sample value in |vector|.
-// - min_val : Minimum sample value in |vector|.
+// - max_val : Maximum sample value in `vector`.
+// - min_val : Minimum sample value in `vector`.
void WebRtcSpl_MinMaxW16(const int16_t* vector,
size_t length,
int16_t* min_val,
@@ -426,7 +426,7 @@
//
// Input:
// - in_vector : Vector to calculate autocorrelation upon
-// - in_vector_length : Length (in samples) of |vector|
+// - in_vector_length : Length (in samples) of `vector`
// - order : The order up to which the autocorrelation should be
// calculated
//
@@ -438,7 +438,7 @@
// - scale : The number of left shifts required to obtain the
// auto-correlation in Q0
//
-// Return value : Number of samples in |result|, i.e. (order+1)
+// Return value : Number of samples in `result`, i.e. (order+1)
size_t WebRtcSpl_AutoCorrelation(const int16_t* in_vector,
size_t in_vector_length,
size_t order,
@@ -449,7 +449,7 @@
// does NOT use the 64 bit class
//
// Input:
-// - auto_corr : Vector with autocorrelation values of length >= |order|+1
+// - auto_corr : Vector with autocorrelation values of length >= `order`+1
// - order : The LPC filter order (support up to order 20)
//
// Output:
@@ -462,7 +462,7 @@
int16_t* refl_coef,
size_t order);
-// Converts reflection coefficients |refl_coef| to LPC coefficients |lpc_coef|.
+// Converts reflection coefficients `refl_coef` to LPC coefficients `lpc_coef`.
// This version is a 16 bit operation.
//
// NOTE: The 16 bit refl_coef -> lpc_coef conversion might result in a
@@ -472,7 +472,7 @@
// Input:
// - refl_coef : Reflection coefficients in Q15 that should be converted
// to LPC coefficients
-// - use_order : Number of coefficients in |refl_coef|
+// - use_order : Number of coefficients in `refl_coef`
//
// Output:
// - lpc_coef : LPC coefficients in Q12
@@ -480,14 +480,14 @@
int use_order,
int16_t* lpc_coef);
-// Converts LPC coefficients |lpc_coef| to reflection coefficients |refl_coef|.
+// Converts LPC coefficients `lpc_coef` to reflection coefficients `refl_coef`.
// This version is a 16 bit operation.
// The conversion is implemented by the step-down algorithm.
//
// Input:
// - lpc_coef : LPC coefficients in Q12, that should be converted to
// reflection coefficients
-// - use_order : Number of coefficients in |lpc_coef|
+// - use_order : Number of coefficients in `lpc_coef`
//
// Output:
// - refl_coef : Reflection coefficients in Q15.
@@ -508,24 +508,24 @@
int16_t* refl_coef);
// The functions (with related pointer) calculate the cross-correlation between
-// two sequences |seq1| and |seq2|.
-// |seq1| is fixed and |seq2| slides as the pointer is increased with the
-// amount |step_seq2|. Note the arguments should obey the relationship:
-// |dim_seq| - 1 + |step_seq2| * (|dim_cross_correlation| - 1) <
-// buffer size of |seq2|
+// two sequences `seq1` and `seq2`.
+// `seq1` is fixed and `seq2` slides as the pointer is increased with the
+// amount `step_seq2`. Note the arguments should obey the relationship:
+// `dim_seq` - 1 + `step_seq2` * (`dim_cross_correlation` - 1) <
+// buffer size of `seq2`
//
// Input:
// - seq1 : First sequence (fixed throughout the correlation)
-// - seq2 : Second sequence (slides |step_vector2| for each
+// - seq2 : Second sequence (slides `step_vector2` for each
// new correlation)
// - dim_seq : Number of samples to use in the cross-correlation
// - dim_cross_correlation : Number of cross-correlations to calculate (the
-// start position for |vector2| is updated for each
+// start position for `vector2` is updated for each
// new one)
// - right_shifts : Number of right bit shifts to use. This will
// become the output Q-domain.
// - step_seq2 : How many (positive or negative) steps the
-// |vector2| pointer should be updated for each new
+// `vector2` pointer should be updated for each new
// cross-correlation value.
//
// Output:
@@ -575,11 +575,11 @@
void WebRtcSpl_GetHanningWindow(int16_t* window, size_t size);
// Calculates y[k] = sqrt(1 - x[k]^2) for each element of the input vector
-// |in_vector|. Input and output values are in Q15.
+// `in_vector`. Input and output values are in Q15.
//
// Inputs:
// - in_vector : Values to calculate sqrt(1 - x^2) of
-// - vector_length : Length of vector |in_vector|
+// - vector_length : Length of vector `in_vector`
//
// Output:
// - out_vector : Output values in Q15
@@ -667,9 +667,9 @@
// Input:
// - data_in : Input samples (state in positions
// data_in[-order] .. data_in[-1])
-// - data_in_length : Number of samples in |data_in| to be filtered.
+// - data_in_length : Number of samples in `data_in` to be filtered.
// This must be at least
-// |delay| + |factor|*(|out_vector_length|-1) + 1)
+// `delay` + `factor`*(`out_vector_length`-1) + 1)
// - data_out_length : Number of down sampled samples desired
// - coefficients : Filter coefficients (in Q12)
// - coefficients_length: Number of coefficients (order+1)
@@ -677,7 +677,7 @@
// - delay : Delay of filter (compensated for in out_vector)
// Output:
// - data_out : Filtered samples
-// Return value : 0 if OK, -1 if |in_vector| is too short
+// Return value : 0 if OK, -1 if `in_vector` is too short
typedef int (*DownsampleFast)(const int16_t* data_in,
size_t data_in_length,
int16_t* data_out,
@@ -723,12 +723,12 @@
int WebRtcSpl_ComplexFFT(int16_t vector[], int stages, int mode);
int WebRtcSpl_ComplexIFFT(int16_t vector[], int stages, int mode);
-// Treat a 16-bit complex data buffer |complex_data| as an array of 32-bit
+// Treat a 16-bit complex data buffer `complex_data` as an array of 32-bit
// values, and swap elements whose indexes are bit-reverses of each other.
//
// Input:
-// - complex_data : Complex data buffer containing 2^|stages| real
-// elements interleaved with 2^|stages| imaginary
+// - complex_data : Complex data buffer containing 2^`stages` real
+// elements interleaved with 2^`stages` imaginary
// elements: [Re Im Re Im Re Im....]
// - stages : Number of FFT stages. Must be at least 3 and at most
// 10, since the table WebRtcSpl_kSinTable1024[] is 1024
@@ -938,7 +938,7 @@
// WebRtcSpl_AddSatW32(...)
//
// Returns the result of a saturated 16-bit, respectively 32-bit, addition of
-// the numbers specified by the |var1| and |var2| parameters.
+// the numbers specified by the `var1` and `var2` parameters.
//
// Input:
// - var1 : Input variable 1
@@ -952,7 +952,7 @@
// WebRtcSpl_SubSatW32(...)
//
// Returns the result of a saturated 16-bit, respectively 32-bit, subtraction
-// of the numbers specified by the |var1| and |var2| parameters.
+// of the numbers specified by the `var1` and `var2` parameters.
//
// Input:
// - var1 : Input variable 1
@@ -965,61 +965,61 @@
// WebRtcSpl_GetSizeInBits(...)
//
// Returns the # of bits that are needed at the most to represent the number
-// specified by the |value| parameter.
+// specified by the `value` parameter.
//
// Input:
// - value : Input value
//
-// Return value : Number of bits needed to represent |value|
+// Return value : Number of bits needed to represent `value`
//
//
// WebRtcSpl_NormW32(...)
//
// Norm returns the # of left shifts required to 32-bit normalize the 32-bit
-// signed number specified by the |value| parameter.
+// signed number specified by the `value` parameter.
//
// Input:
// - value : Input value
//
-// Return value : Number of bit shifts needed to 32-bit normalize |value|
+// Return value : Number of bit shifts needed to 32-bit normalize `value`
//
//
// WebRtcSpl_NormW16(...)
//
// Norm returns the # of left shifts required to 16-bit normalize the 16-bit
-// signed number specified by the |value| parameter.
+// signed number specified by the `value` parameter.
//
// Input:
// - value : Input value
//
-// Return value : Number of bit shifts needed to 32-bit normalize |value|
+// Return value : Number of bit shifts needed to 32-bit normalize `value`
//
//
// WebRtcSpl_NormU32(...)
//
// Norm returns the # of left shifts required to 32-bit normalize the unsigned
-// 32-bit number specified by the |value| parameter.
+// 32-bit number specified by the `value` parameter.
//
// Input:
// - value : Input value
//
-// Return value : Number of bit shifts needed to 32-bit normalize |value|
+// Return value : Number of bit shifts needed to 32-bit normalize `value`
//
//
// WebRtcSpl_GetScalingSquare(...)
//
// Returns the # of bits required to scale the samples specified in the
-// |in_vector| parameter so that, if the squares of the samples are added the
-// # of times specified by the |times| parameter, the 32-bit addition will not
+// `in_vector` parameter so that, if the squares of the samples are added the
+// # of times specified by the `times` parameter, the 32-bit addition will not
// overflow (result in int32_t).
//
// Input:
// - in_vector : Input vector to check scaling on
-// - in_vector_length : Samples in |in_vector|
+// - in_vector_length : Samples in `in_vector`
// - times : Number of additions to be performed
//
// Return value : Number of right bit shifts needed to avoid
@@ -1029,8 +1029,8 @@
//
// WebRtcSpl_MemSetW16(...)
//
-// Sets all the values in the int16_t vector |vector| of length
-// |vector_length| to the specified value |set_value|
+// Sets all the values in the int16_t vector `vector` of length
+// `vector_length` to the specified value `set_value`
//
// Input:
// - vector : Pointer to the int16_t vector
@@ -1041,8 +1041,8 @@
//
// WebRtcSpl_MemSetW32(...)
//
-// Sets all the values in the int32_t vector |vector| of length
-// |vector_length| to the specified value |set_value|
+// Sets all the values in the int32_t vector `vector` of length
+// `vector_length` to the specified value `set_value`
//
// Input:
// - vector : Pointer to the int16_t vector
@@ -1053,34 +1053,34 @@
//
// WebRtcSpl_MemCpyReversedOrder(...)
//
-// Copies all the values from the source int16_t vector |in_vector| to a
-// destination int16_t vector |out_vector|. It is done in reversed order,
-// meaning that the first sample of |in_vector| is copied to the last sample of
-// the |out_vector|. The procedure continues until the last sample of
-// |in_vector| has been copied to the first sample of |out_vector|. This
+// Copies all the values from the source int16_t vector `in_vector` to a
+// destination int16_t vector `out_vector`. It is done in reversed order,
+// meaning that the first sample of `in_vector` is copied to the last sample of
+// the `out_vector`. The procedure continues until the last sample of
+// `in_vector` has been copied to the first sample of `out_vector`. This
// creates a reversed vector. Used in e.g. prediction in iLBC.
//
// Input:
// - in_vector : Pointer to the first sample in a int16_t vector
-// of length |length|
+// of length `length`
// - vector_length : Number of elements to copy
//
// Output:
// - out_vector : Pointer to the last sample in a int16_t vector
-// of length |length|
+// of length `length`
//
//
// WebRtcSpl_CopyFromEndW16(...)
//
-// Copies the rightmost |samples| of |in_vector| (of length |in_vector_length|)
-// to the vector |out_vector|.
+// Copies the rightmost `samples` of `in_vector` (of length `in_vector_length`)
+// to the vector `out_vector`.
//
// Input:
// - in_vector : Input vector
-// - in_vector_length : Number of samples in |in_vector|
+// - in_vector_length : Number of samples in `in_vector`
// - samples : Number of samples to extract (from right side)
-// from |in_vector|
+// from `in_vector`
//
// Output:
// - out_vector : Vector with the requested samples
@@ -1115,7 +1115,7 @@
//
// Output:
// - out_vector : Pointer to the result vector (can be the same as
-// |in_vector|)
+// `in_vector`)
//
//
@@ -1133,7 +1133,7 @@
//
// Output:
// - out_vector : Pointer to the result vector (can be the same as
-// |in_vector|)
+// `in_vector`)
//
//
@@ -1145,11 +1145,11 @@
// Input:
// - in_vector : Input vector
// - gain : Scaling gain
-// - vector_length : Elements in the |in_vector|
+// - vector_length : Elements in the `in_vector`
// - right_shifts : Number of right bit shifts applied
//
// Output:
-// - out_vector : Output vector (can be the same as |in_vector|)
+// - out_vector : Output vector (can be the same as `in_vector`)
//
//
@@ -1161,11 +1161,11 @@
// Input:
// - in_vector : Input vector
// - gain : Scaling gain
-// - vector_length : Elements in the |in_vector|
+// - vector_length : Elements in the `in_vector`
// - right_shifts : Number of right bit shifts applied
//
// Output:
-// - out_vector : Output vector (can be the same as |in_vector|)
+// - out_vector : Output vector (can be the same as `in_vector`)
//
//
@@ -1200,10 +1200,10 @@
// should be set to the last value in the vector
// - right_shifts : Number of right bit shift to be applied after the
// multiplication
-// - vector_length : Number of elements in |in_vector|
+// - vector_length : Number of elements in `in_vector`
//
// Output:
-// - out_vector : Output vector (can be same as |in_vector|)
+// - out_vector : Output vector (can be same as `in_vector`)
//
//
@@ -1217,10 +1217,10 @@
// - window : Window vector.
// - right_shifts : Number of right bit shift to be applied after the
// multiplication
-// - vector_length : Number of elements in |in_vector|
+// - vector_length : Number of elements in `in_vector`
//
// Output:
-// - out_vector : Output vector (can be same as |in_vector|)
+// - out_vector : Output vector (can be same as `in_vector`)
//
//
@@ -1234,16 +1234,16 @@
// - in_vector2 : Input vector 2
// - right_shifts : Number of right bit shift to be applied after the
// multiplication
-// - vector_length : Number of elements in |in_vector1| and |in_vector2|
+// - vector_length : Number of elements in `in_vector1` and `in_vector2`
//
// Output:
-// - out_vector : Output vector (can be same as |in_vector1|)
+// - out_vector : Output vector (can be same as `in_vector1`)
//
//
// WebRtcSpl_AddAffineVectorToVector(...)
//
-// Adds an affine transformed vector to another vector |out_vector|, i.e,
+// Adds an affine transformed vector to another vector `out_vector`, i.e,
// performs
// out_vector[k] += (in_vector[k]*gain+add_constant)>>right_shifts
//
@@ -1253,7 +1253,7 @@
// - add_constant : Constant value to add (usually 1<<(right_shifts-1),
// but others can be used as well
// - right_shifts : Number of right bit shifts (0-16)
-// - vector_length : Number of samples in |in_vector| and |out_vector|
+// - vector_length : Number of samples in `in_vector` and `out_vector`
//
// Output:
// - out_vector : Vector with the output
@@ -1271,7 +1271,7 @@
// - add_constant : Constant value to add (usually 1<<(right_shifts-1),
// but others can be used as well
// - right_shifts : Number of right bit shifts (0-16)
-// - vector_length : Number of samples in |in_vector| and |out_vector|
+// - vector_length : Number of samples in `in_vector` and `out_vector`
//
// Output:
// - out_vector : Vector with the output
@@ -1334,15 +1334,15 @@
// - vector : Vector with the uniform values
// - seed : Updated seed value
//
-// Return value : Number of samples in vector, i.e., |vector_length|
+// Return value : Number of samples in vector, i.e., `vector_length`
//
//
// WebRtcSpl_Sqrt(...)
//
-// Returns the square root of the input value |value|. The precision of this
+// Returns the square root of the input value `value`. The precision of this
// function is integer precision, i.e., sqrt(8) gives 2 as answer.
-// If |value| is a negative number then 0 is returned.
+// If `value` is a negative number then 0 is returned.
//
// Algorithm:
//
@@ -1362,9 +1362,9 @@
//
// WebRtcSpl_DivU32U16(...)
//
-// Divides a uint32_t |num| by a uint16_t |den|.
+// Divides a uint32_t `num` by a uint16_t `den`.
//
-// If |den|==0, (uint32_t)0xFFFFFFFF is returned.
+// If `den`==0, (uint32_t)0xFFFFFFFF is returned.
//
// Input:
// - num : Numerator
@@ -1377,9 +1377,9 @@
//
// WebRtcSpl_DivW32W16(...)
//
-// Divides a int32_t |num| by a int16_t |den|.
+// Divides a int32_t `num` by a int16_t `den`.
//
-// If |den|==0, (int32_t)0x7FFFFFFF is returned.
+// If `den`==0, (int32_t)0x7FFFFFFF is returned.
//
// Input:
// - num : Numerator
@@ -1392,10 +1392,10 @@
//
// WebRtcSpl_DivW32W16ResW16(...)
//
-// Divides a int32_t |num| by a int16_t |den|, assuming that the
+// Divides a int32_t `num` by a int16_t `den`, assuming that the
// result is less than 32768, otherwise an unpredictable result will occur.
//
-// If |den|==0, (int16_t)0x7FFF is returned.
+// If `den`==0, (int16_t)0x7FFF is returned.
//
// Input:
// - num : Numerator
@@ -1408,7 +1408,7 @@
//
// WebRtcSpl_DivResultInQ31(...)
//
-// Divides a int32_t |num| by a int16_t |den|, assuming that the
+// Divides a int32_t `num` by a int16_t `den`, assuming that the
// absolute value of the denominator is larger than the numerator, otherwise
// an unpredictable result will occur.
//
@@ -1422,7 +1422,7 @@
//
// WebRtcSpl_DivW32HiLow(...)
//
-// Divides a int32_t |num| by a denominator in hi, low format. The
+// Divides a int32_t `num` by a denominator in hi, low format. The
// absolute value of the denominator has to be larger (or equal to) the
// numerator.
//
@@ -1447,7 +1447,7 @@
// - scale_factor : Number of left bit shifts needed to get the physical
// energy value, i.e, to get the Q0 value
//
-// Return value : Energy value in Q(-|scale_factor|)
+// Return value : Energy value in Q(-`scale_factor`)
//
//
@@ -1458,15 +1458,15 @@
// Input:
// - ar_coef : AR-coefficient vector (values in Q12),
// ar_coef[0] must be 4096.
-// - ar_coef_length : Number of coefficients in |ar_coef|.
+// - ar_coef_length : Number of coefficients in `ar_coef`.
// - in_vector : Vector to be filtered.
-// - in_vector_length : Number of samples in |in_vector|.
+// - in_vector_length : Number of samples in `in_vector`.
// - filter_state : Current state (higher part) of the filter.
-// - filter_state_length : Length (in samples) of |filter_state|.
+// - filter_state_length : Length (in samples) of `filter_state`.
// - filter_state_low : Current state (lower part) of the filter.
-// - filter_state_low_length : Length (in samples) of |filter_state_low|.
+// - filter_state_low_length : Length (in samples) of `filter_state_low`.
// - out_vector_low_length : Maximum length (in samples) of
-// |out_vector_low|.
+// `out_vector_low`.
//
// Output:
// - filter_state : Updated state (upper part) vector.
@@ -1476,7 +1476,7 @@
// - out_vector_low : Vector containing the lower part of the
// filtered values.
//
-// Return value : Number of samples in the |out_vector|.
+// Return value : Number of samples in the `out_vector`.
//
//
@@ -1484,11 +1484,11 @@
//
// Complex Inverse FFT
//
-// Computes an inverse complex 2^|stages|-point FFT on the input vector, which
+// Computes an inverse complex 2^`stages`-point FFT on the input vector, which
// is in bit-reversed order. The original content of the vector is destroyed in
// the process, since the input is overwritten by the output, normal-ordered,
// FFT vector. With X as the input complex vector, y as the output complex
-// vector and with M = 2^|stages|, the following is computed:
+// vector and with M = 2^`stages`, the following is computed:
//
// M-1
// y(k) = sum[X(i)*[cos(2*pi*i*k/M) + j*sin(2*pi*i*k/M)]]
@@ -1498,8 +1498,8 @@
// decimation-in-time algorithm with radix-2 butterfly technique.
//
// Input:
-// - vector : In pointer to complex vector containing 2^|stages|
-// real elements interleaved with 2^|stages| imaginary
+// - vector : In pointer to complex vector containing 2^`stages`
+// real elements interleaved with 2^`stages` imaginary
// elements.
// [ReImReImReIm....]
// The elements are in Q(-scale) domain, see more on Return
@@ -1518,10 +1518,10 @@
// - vector : Out pointer to the FFT vector (the same as input).
//
// Return Value : The scale value that tells the number of left bit shifts
-// that the elements in the |vector| should be shifted with
+// that the elements in the `vector` should be shifted with
// in order to get Q0 values, i.e. the physically correct
// values. The scale parameter is always 0 or positive,
-// except if N>1024 (|stages|>10), which returns a scale
+// except if N>1024 (`stages`>10), which returns a scale
// value of -1, indicating error.
//
@@ -1530,11 +1530,11 @@
//
// Complex FFT
//
-// Computes a complex 2^|stages|-point FFT on the input vector, which is in
+// Computes a complex 2^`stages`-point FFT on the input vector, which is in
// bit-reversed order. The original content of the vector is destroyed in
// the process, since the input is overwritten by the output, normal-ordered,
// FFT vector. With x as the input complex vector, Y as the output complex
-// vector and with M = 2^|stages|, the following is computed:
+// vector and with M = 2^`stages`, the following is computed:
//
// M-1
// Y(k) = 1/M * sum[x(i)*[cos(2*pi*i*k/M) + j*sin(2*pi*i*k/M)]]
@@ -1549,8 +1549,8 @@
// accuracy.
//
// Input:
-// - vector : In pointer to complex vector containing 2^|stages| real
-// elements interleaved with 2^|stages| imaginary elements.
+// - vector : In pointer to complex vector containing 2^`stages` real
+// elements interleaved with 2^`stages` imaginary elements.
// [ReImReImReIm....]
// The output is in the Q0 domain.
//
diff --git a/common_audio/signal_processing/signal_processing_unittest.cc b/common_audio/signal_processing/signal_processing_unittest.cc
index 9ec8590..80d605b 100644
--- a/common_audio/signal_processing/signal_processing_unittest.cc
+++ b/common_audio/signal_processing/signal_processing_unittest.cc
@@ -482,13 +482,13 @@
}
// MA filters.
- // Note that the input data has |kFilterOrder| states before the actual
+ // Note that the input data has `kFilterOrder` states before the actual
// data (one sample).
WebRtcSpl_FilterMAFastQ12(&data_in[kFilterOrder], data_out, B,
kFilterOrder + 1, 1);
EXPECT_EQ(0, data_out[0]);
// AR filters.
- // Note that the output data has |kFilterOrder| states before the actual
+ // Note that the output data has `kFilterOrder` states before the actual
// data (one sample).
WebRtcSpl_FilterARFastQ12(data_in, &data_out[kFilterOrder], A,
kFilterOrder + 1, 1);
@@ -639,11 +639,11 @@
32767, 32767, 32767, 32767, 32767, 32767, 32767, 32767,
32767, 32767, 32767, 32767, 32767, 32767, 32767};
- // All values in |out_vector| should be |kRefValue32kHz|.
+ // All values in `out_vector` should be `kRefValue32kHz`.
const int32_t kRefValue32kHz1 = -1077493760;
const int32_t kRefValue32kHz2 = 1077493645;
- // After bit shift with saturation, |out_vector_w16| is saturated.
+ // After bit shift with saturation, `out_vector_w16` is saturated.
const int16_t kRefValue16kHz1 = -32768;
const int16_t kRefValue16kHz2 = 32767;
diff --git a/common_audio/signal_processing/splitting_filter.c b/common_audio/signal_processing/splitting_filter.c
index b0d83f1..27a0a2a 100644
--- a/common_audio/signal_processing/splitting_filter.c
+++ b/common_audio/signal_processing/splitting_filter.c
@@ -41,7 +41,7 @@
//
// Output:
// - out_data : Output data sequence (Q10), length equal to
-// |data_length|
+// `data_length`
//
static void WebRtcSpl_AllPassQMF(int32_t* in_data,
@@ -50,28 +50,30 @@
const uint16_t* filter_coefficients,
int32_t* filter_state)
{
- // The procedure is to filter the input with three first order all pass filters
- // (cascade operations).
+ // The procedure is to filter the input with three first order all pass
+ // filters (cascade operations).
//
// a_3 + q^-1 a_2 + q^-1 a_1 + q^-1
// y[n] = ----------- ----------- ----------- x[n]
// 1 + a_3q^-1 1 + a_2q^-1 1 + a_1q^-1
//
- // The input vector |filter_coefficients| includes these three filter coefficients.
- // The filter state contains the in_data state, in_data[-1], followed by
- // the out_data state, out_data[-1]. This is repeated for each cascade.
- // The first cascade filter will filter the |in_data| and store the output in
- // |out_data|. The second will the take the |out_data| as input and make an
- // intermediate storage in |in_data|, to save memory. The third, and final, cascade
- // filter operation takes the |in_data| (which is the output from the previous cascade
- // filter) and store the output in |out_data|.
- // Note that the input vector values are changed during the process.
+ // The input vector `filter_coefficients` includes these three filter
+ // coefficients. The filter state contains the in_data state, in_data[-1],
+ // followed by the out_data state, out_data[-1]. This is repeated for each
+ // cascade. The first cascade filter will filter the `in_data` and store
+ // the output in `out_data`. The second will the take the `out_data` as
+ // input and make an intermediate storage in `in_data`, to save memory. The
+ // third, and final, cascade filter operation takes the `in_data` (which is
+ // the output from the previous cascade filter) and store the output in
+ // `out_data`. Note that the input vector values are changed during the
+ // process.
size_t k;
int32_t diff;
// First all-pass cascade; filter from in_data to out_data.
- // Let y_i[n] indicate the output of cascade filter i (with filter coefficient a_i) at
- // vector position n. Then the final output will be y[n] = y_3[n]
+ // Let y_i[n] indicate the output of cascade filter i (with filter
+ // coefficient a_i) at vector position n. Then the final output will be
+ // y[n] = y_3[n]
// First loop, use the states stored in memory.
// "diff" should be safe from wrap around since max values are 2^25