Update documentation for new compression presets
authorMartijn van Beurden <mvanb1@gmail.com>
Mon, 10 Nov 2014 16:35:35 +0000 (17:35 +0100)
committerErik de Castro Lopo <erikd@mega-nerd.com>
Tue, 11 Nov 2014 14:20:43 +0000 (06:20 -0800)
Signed-off-by: Erik de Castro Lopo <erikd@mega-nerd.com>
doc/html/documentation_tools_flac.html
include/FLAC/stream_encoder.h
src/flac/main.c

index 9f85a25..0964cd2 100644 (file)
                                        <span class="argument">-6</span>, <span class="argument">--compression-level-6</span>
                                </td>
                                <td>
-                                       Synonymous with <span class="argument">-l 8 -b 4096 -m -r 6</span>
+                                       Synonymous with <span class="argument">-l 8 -b 4096 -m -r 6 -A tukey(0.5);partial_tukey(2)</span>
                                </td>
                        </tr>
                        <tr>
                                        <span class="argument">-7</span>, <span class="argument">--compression-level-7</span>
                                </td>
                                <td>
-                                       Synonymous with <span class="argument">-l 8 -b 4096 -m -e -r 6</span>
+                                       Synonymous with <span class="argument">-l 12 -b 4096 -m -r 6 -A tukey(0.5);partial_tukey(2)</span>
                                </td>
                        </tr>
                        <tr>
                                        <span class="argument">-8</span>, <span class="argument">--compression-level-8</span>
                                </td>
                                <td>
-                                       Synonymous with <span class="argument">-l 12 -b 4096 -m -e -r 6</span>
+                                       Synonymous with <span class="argument">-l 12 -b 4096 -m -r 6 -A tukey(0.5);partial_tukey(2);punchout_tukey(3)</span>
                                </td>
                        </tr>
                        <tr>
index dbfee63..8a9b1b7 100644 (file)
@@ -830,28 +830,28 @@ FLAC_API FLAC__bool FLAC__stream_encoder_set_sample_rate(FLAC__StreamEncoder *en
  * The actual values set for each level are:
  * <table>
  * <tr>
- *  <td><b>level</b><td>
- *  <td>do mid-side stereo<td>
- *  <td>loose mid-side stereo<td>
- *  <td>apodization<td>
- *  <td>max lpc order<td>
- *  <td>qlp coeff precision<td>
- *  <td>qlp coeff prec search<td>
- *  <td>escape coding<td>
- *  <td>exhaustive model search<td>
- *  <td>min residual partition order<td>
- *  <td>max residual partition order<td>
- *  <td>rice parameter search dist<td>
+ *  <td><b>level</b></td>
+ *  <td>do mid-side stereo</td>
+ *  <td>loose mid-side stereo</td>
+ *  <td>apodization</td>
+ *  <td>max lpc order</td>
+ *  <td>qlp coeff precision</td>
+ *  <td>qlp coeff prec search</td>
+ *  <td>escape coding</td>
+ *  <td>exhaustive model search</td>
+ *  <td>min residual partition order</td>
+ *  <td>max residual partition order</td>
+ *  <td>rice parameter search dist</td>
  * </tr>
- * <tr>  <td><b>0</b><td>  <td>false<td>  <td>false<td>  <td>tukey(0.5)<td>  <td>0<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>false<td>  <td>0<td>  <td>3<td>  <td>0<td>  </tr>
- * <tr>  <td><b>1</b><td>  <td>true<td>   <td>true<td>   <td>tukey(0.5)<td>  <td>0<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>false<td>  <td>0<td>  <td>3<td>  <td>0<td>  </tr>
- * <tr>  <td><b>2</b><td>  <td>true<td>   <td>false<td>  <td>tukey(0.5)<td>  <td>0<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>false<td>  <td>0<td>  <td>3<td>  <td>0<td>  </tr>
- * <tr>  <td><b>3</b><td>  <td>false<td>  <td>false<td>  <td>tukey(0.5)<td>  <td>6<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>false<td>  <td>0<td>  <td>4<td>  <td>0<td>  </tr>
- * <tr>  <td><b>4</b><td>  <td>true<td>   <td>true<td>   <td>tukey(0.5)<td>  <td>8<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>false<td>  <td>0<td>  <td>4<td>  <td>0<td>  </tr>
- * <tr>  <td><b>5</b><td>  <td>true<td>   <td>false<td>  <td>tukey(0.5)<td>  <td>8<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>false<td>  <td>0<td>  <td>5<td>  <td>0<td>  </tr>
- * <tr>  <td><b>6</b><td>  <td>true<td>   <td>false<td>  <td>tukey(0.5)<td>  <td>8<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>false<td>  <td>0<td>  <td>6<td>  <td>0<td>  </tr>
- * <tr>  <td><b>7</b><td>  <td>true<td>   <td>false<td>  <td>tukey(0.5)<td>  <td>8<td>   <td>0<td>  <td>false<td>  <td>false<td>  <td>true<td>   <td>0<td>  <td>6<td>  <td>0<td>  </tr>
- * <tr>  <td><b>8</b><td>  <td>true<td>   <td>false<td>  <td>tukey(0.5)<td>  <td>12<td>  <td>0<td>  <td>false<td>  <td>false<td>  <td>true<td>   <td>0<td>  <td>6<td>  <td>0<td>  </tr>
+ * <tr>  <td><b>0</b></td> <td>false</td> <td>false</td> <td>tukey(0.5)<td>                                     <td>0</td>  <td>0</td> <td>false</td> <td>false</td> <td>false</td> <td>0</td> <td>3</td> <td>0</td> </tr>
+ * <tr>  <td><b>1</b></td> <td>true</td>  <td>true</td>  <td>tukey(0.5)<td>                                     <td>0</td>  <td>0</td> <td>false</td> <td>false</td> <td>false</td> <td>0</td> <td>3</td> <td>0</td> </tr>
+ * <tr>  <td><b>2</b></td> <td>true</td>  <td>false</td> <td>tukey(0.5)<td>                                     <td>0</td>  <td>0</td> <td>false</td> <td>false</td> <td>false</td> <td>0</td> <td>3</td> <td>0</td> </tr>
+ * <tr>  <td><b>3</b></td> <td>false</td> <td>false</td> <td>tukey(0.5)<td>                                     <td>6</td>  <td>0</td> <td>false</td> <td>false</td> <td>false</td> <td>0</td> <td>4</td> <td>0</td> </tr>
+ * <tr>  <td><b>4</b></td> <td>true</td>  <td>true</td>  <td>tukey(0.5)<td>                                     <td>8</td>  <td>0</td> <td>false</td> <td>false</td> <td>false</td> <td>0</td> <td>4</td> <td>0</td> </tr>
+ * <tr>  <td><b>5</b></td> <td>true</td>  <td>false</td> <td>tukey(0.5)<td>                                     <td>8</td>  <td>0</td> <td>false</td> <td>false</td> <td>false</td> <td>0</td> <td>5</td> <td>0</td> </tr>
+ * <tr>  <td><b>6</b></td> <td>true</td>  <td>false</td> <td>tukey(0.5);partial_tukey(2)<td>                    <td>8</td>  <td>0</td> <td>false</td> <td>false</td> <td>false</td> <td>0</td> <td>6</td> <td>0</td> </tr>
+ * <tr>  <td><b>7</b></td> <td>true</td>  <td>false</td> <td>tukey(0.5);partial_tukey(2)<td>                    <td>12</td> <td>0</td> <td>false</td> <td>false</td> <td>false</td> <td>0</td> <td>6</td> <td>0</td> </tr>
+ * <tr>  <td><b>8</b></td> <td>true</td>  <td>false</td> <td>tukey(0.5);partial_tukey(2);punchout_tukey(3)</td> <td>12</td> <td>0</td> <td>false</td> <td>false</td> <td>false</td> <td>0</td> <td>6</td> <td>0</td> </tr>
  * </table>
  *
  * \default \c 5
index 2eb8643..44894ac 100644 (file)
@@ -1274,8 +1274,8 @@ void show_help(void)
        printf("  -4, --compression-level-4          Synonymous with -l 8 -b 4096 -M -r 4\n");
        printf("  -5, --compression-level-5          Synonymous with -l 8 -b 4096 -m -r 5\n");
        printf("  -6, --compression-level-6          Synonymous with -l 8 -b 4096 -m -r 6\n");
-       printf("  -7, --compression-level-7          Synonymous with -l 8 -b 4096 -m -e -r 6\n");
-       printf("  -8, --compression-level-8, --best  Synonymous with -l 12 -b 4096 -m -e -r 6\n");
+       printf("  -7, --compression-level-7          Synonymous with -l 12 -b 4096 -m -r 6\n");
+       printf("  -8, --compression-level-8, --best  Synonymous with -l 12 -b 4096 -m -r 6\n");
        printf("  -b, --blocksize=#                  Specify blocksize in samples\n");
        printf("  -m, --mid-side                     Try mid-side coding for each frame\n");
        printf("  -M, --adaptive-mid-side            Adaptive mid-side coding for all frames\n");
@@ -1577,8 +1577,8 @@ void show_explain(void)
        printf("  -5, --compression-level-5          Synonymous with -l 8 -b 4096 -m -r 5\n");
        printf("                                     -5 is the default setting\n");
        printf("  -6, --compression-level-6          Synonymous with -l 8 -b 4096 -m -r 6\n");
-       printf("  -7, --compression-level-7          Synonymous with -l 8 -b 4096 -m -e -r 6\n");
-       printf("  -8, --compression-level-8, --best  Synonymous with -l 12 -b 4096 -m -e -r 6\n");
+       printf("  -7, --compression-level-7          Synonymous with -l 12 -b 4096 -m -r 6\n");
+       printf("  -8, --compression-level-8, --best  Synonymous with -l 12 -b 4096 -m -r 6\n");
        printf("  -m, --mid-side                     Try mid-side coding for each frame\n");
        printf("                                     (stereo only)\n");
        printf("  -M, --adaptive-mid-side            Adaptive mid-side coding for all frames\n");
@@ -1589,12 +1589,12 @@ void show_explain(void)
        printf("                                     blackman, blackman_harris_4term_92db,\n");
        printf("                                     connes, flattop, gauss(STDDEV), hamming,\n");
        printf("                                     hann, kaiser_bessel, nuttall, rectangle,\n");
-       printf("                                     triangle, tukey(P), welch.  More than one\n");
-       printf("                                     may be specified but encoding time is a\n");
-       printf("                                     multiple of the number of functions since\n");
-       printf("                                     they are each tried in turn.  The encoder\n");
-       printf("                                     chooses suitable defaults in the absence\n");
-       printf("                                     of any -A options.\n");
+       printf("                                     triangle, tukey(P), welch, partial_tukey(n),\n");
+       printf("                                     punchout_tukey(n). More than one may be\n");
+       printf("                                     specified but encoding time is a multiple of\n");
+       printf("                                     the number of functions since they are each\n");
+       printf("                                     tried in turn.  The encoder chooses suitable\n");
+       printf("                                     defaults in the absence of any -A options.\n");
        printf("  -l, --max-lpc-order=#              Max LPC order; 0 => only fixed predictors.\n");
        printf("                                     Must be <= 12 for Subset streams if sample\n");
        printf("                                     rate is <=48kHz.\n");