]> git.sesse.net Git - ffmpeg/blobdiff - libavcodec/acelp_pitch_delay.h
psymodel: extend API to include PE and bit allocation.
[ffmpeg] / libavcodec / acelp_pitch_delay.h
index 42307d2bbab4e4cab344a337d4c35afd064f328b..6d182bb7ad437044b90862efbed58e09d501b321 100644 (file)
@@ -3,20 +3,20 @@
  *
  * Copyright (c) 2008 Vladimir Voroshilov
  *
- * This file is part of FFmpeg.
+ * This file is part of Libav.
  *
- * FFmpeg is free software; you can redistribute it and/or
+ * Libav is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
- * FFmpeg is distributed in the hope that it will be useful,
+ * Libav is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
- * License along with FFmpeg; if not, write to the Free Software
+ * License along with Libav; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
@@ -54,8 +54,8 @@ int ff_acelp_decode_8bit_to_1st_delay3(int ac_index);
  * Pitch delay is coded:
  *    with 1/3 resolution, -6 < pitch_delay - int(prev_pitch_delay) < 5
  *
- * \remark The routine is used in G.729 @8k, AMR @10.2k, AMR @7.95k,
- *         AMR @7.4k for the second subframe.
+ * \remark The routine is used in G.729 @@8k, AMR @@10.2k, AMR @@7.95k,
+ *         AMR @@7.4k for the second subframe.
  */
 int ff_acelp_decode_5_6_bit_to_2nd_delay3(
         int ac_index,
@@ -74,8 +74,8 @@ int ff_acelp_decode_5_6_bit_to_2nd_delay3(
  *    with 1/3 resolution,    -2  < pitch_delay - int(prev_pitch_delay) <  1
  *    integers only,           1 <= pitch_delay - int(prev_pitch_delay) <  5
  *
- * \remark The routine is used in G.729 @6.4k, AMR @6.7k, AMR @5.9k,
- *         AMR @5.15k, AMR @4.75k for the second subframe.
+ * \remark The routine is used in G.729 @@6.4k, AMR @@6.7k, AMR @@5.9k,
+ *         AMR @@5.15k, AMR @@4.75k for the second subframe.
  */
 int ff_acelp_decode_4bit_to_2nd_delay3(
         int ac_index,
@@ -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
@@ -234,4 +231,22 @@ float ff_amr_set_fixed_gain(float fixed_gain_factor, float fixed_mean_energy,
                             float *prediction_error, float energy_mean,
                             const float *pred_table);
 
+
+/**
+ * Decode the adaptive codebook index to the integer and fractional parts
+ * of the pitch lag for one subframe at 1/3 fractional precision.
+ *
+ * The choice of pitch lag is described in 3GPP TS 26.090 section 5.6.1.
+ *
+ * @param lag_int             integer part of pitch lag of the current subframe
+ * @param lag_frac            fractional part of pitch lag of the current subframe
+ * @param pitch_index         parsed adaptive codebook (pitch) index
+ * @param prev_lag_int        integer part of pitch lag for the previous subframe
+ * @param subframe            current subframe number
+ * @param third_as_first      treat the third frame the same way as the first
+ */
+void ff_decode_pitch_lag(int *lag_int, int *lag_frac, int pitch_index,
+                         const int prev_lag_int, const int subframe,
+                         int third_as_first, int resolution);
+
 #endif /* AVCODEC_ACELP_PITCH_DELAY_H */