Make the targa encoder return sane error values rather than -1.
[ffmpeg.git] / libavcodec / acelp_pitch_delay.h
index d833dba..ce06bc2 100644 (file)
@@ -85,8 +85,6 @@ int ff_acelp_decode_4bit_to_2nd_delay3(
  * \brief Decode pitch delay of the first subframe encoded by 9 bits
  *        with 1/6 precision.
  * \param ac_index adaptive codebook index (9 bits)
- * \param pitch_delay_min lower bound (integer) of pitch delay interval for
- *                      second subframe
  *
  * \return pitch delay in 1/6 units
  *
@@ -94,7 +92,7 @@ int ff_acelp_decode_4bit_to_2nd_delay3(
  *    with 1/6 resolution,  17  < pitch_delay <  95
  *    integers only,        95 <= pitch_delay <= 143
  *
- * \remark The routine is used in AMR @12.2k for the first and third subframes.
+ * \remark The routine is used in AMR @@12.2k for the first and third subframes.
  */
 int ff_acelp_decode_9bit_to_1st_delay6(int ac_index);
 
@@ -110,7 +108,7 @@ int ff_acelp_decode_9bit_to_1st_delay6(int ac_index);
  * Pitch delay is coded:
  *    with 1/6 resolution, -6 < pitch_delay - int(prev_pitch_delay) < 5
  *
- * \remark The routine is used in AMR @12.2k for the second and fourth subframes.
+ * \remark The routine is used in AMR @@12.2k for the second and fourth subframes.
  */
 int ff_acelp_decode_6bit_to_2nd_delay6(
         int ac_index,
@@ -118,7 +116,7 @@ int ff_acelp_decode_6bit_to_2nd_delay6(
 
 /**
  * \brief Update past quantized energies
- * \param quant_energy [in/out] past quantized energies (5.10)
+ * \param[in,out]  quant_energy  past quantized energies (5.10)
  * \param gain_corr_factor gain correction factor
  * \param log2_ma_pred_order log2() of MA prediction order
  * \param erasure frame erasure flag
@@ -145,9 +143,8 @@ void ff_acelp_update_past_gain(
  * \param gain_corr_factor gain correction factor (2.13)
  * \param fc_v fixed-codebook vector (2.13)
  * \param mr_energy mean innovation energy and fixed-point correction (7.13)
- * \param quant_energy [in/out] past quantized energies (5.10)
+ * \param[in,out]  quant_energy  past quantized energies (5.10)
  * \param subframe_size length of subframe
- * \param ma_pred_order MA prediction order
  *
  * \return quantized fixed-codebook gain (14.1)
  *
@@ -224,7 +221,7 @@ int16_t ff_acelp_decode_gain_code(
  * Calculate fixed gain (part of section 6.1.3 of AMR spec)
  *
  * @param fixed_gain_factor gain correction factor
- * @param fixed_energy decoded algebraic codebook vector energy
+ * @param fixed_mean_energy mean decoded algebraic codebook vector energy
  * @param prediction_error vector of the quantified predictor errors of
  *        the four previous subframes. It is updated by this function.
  * @param energy_mean desired mean innovation energy