Document shine encoder, rename it to %shine and leave %mp3.fxp

for backward compat.
savonet · Jul 21, 2013 · 6c281a1 · 6c281a1
1 parent 50a336b
commit 6c281a1
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 6 deletions.
diff --git a/doc/content/encoding_formats.txt b/doc/content/encoding_formats.txt
@@ -92,6 +92,15 @@ Examples:
 Optionally, liquidsoap can insert a message within mp3 data. You can set its value using the @msg@ parameter.
 Setting it to @""@ disables this feature. This is its default value.
 
+h3. SHINE
+
+Shine is the fixed-point mp3 encoder. It is useful on architectures without a FPU, such as ARM. 
+It is named @%shine@ or @%mp3.fxp@ and its parameters are:
+
+%%
+%shine(channels=2,samplerate=44100,bitrate=128)
+%%
+
 h4. WAV
 
 %%

diff --git a/src/encoder/encoder.ml b/src/encoder/encoder.ml
@@ -306,7 +306,7 @@ struct
   }
 
   let to_string m =
-    Printf.sprintf "%%mp3.fxp(channels=%d,samplerate=%d,bitrate=%d)"
+    Printf.sprintf "%%shine(channels=%d,samplerate=%d,bitrate=%d)"
       m.channels
       m.samplerate
       m.bitrate

diff --git a/src/lang/lang_lexer.mll b/src/lang/lang_lexer.mll
@@ -149,7 +149,8 @@ rule token = parse
   | "%mp3.cbr" { MP3 }
   | "%mp3.abr" { MP3_ABR }
   | "%mp3.vbr" { MP3_VBR }
-  | "%mp3.fxp" { MP3_FXP }
+  | "%mp3.fxp" { SHINE }
+  | "%shine"   { SHINE }
   | "%aac+" { AACPLUS }
   | "%aacplus" { AACPLUS }
   | "%aac" { VOAACENC }

diff --git a/src/lang/lang_parser.mly b/src/lang/lang_parser.mly
@@ -160,7 +160,7 @@
 %token <int option list> TIME
 %token <int option list * int option list> INTERVAL
 %token OGG FLAC OPUS VORBIS VORBIS_CBR VORBIS_ABR THEORA DIRAC SPEEX GSTREAMER
-%token WAV FDKAAC VOAACENC AACPLUS MP3 MP3_VBR MP3_ABR MP3_FXP EXTERNAL
+%token WAV FDKAAC VOAACENC AACPLUS MP3 MP3_VBR MP3_ABR SHINE EXTERNAL
 %token EOF
 %token BEGIN END GETS TILD QUESTION
 %token <Doc.item * (string*string) list> DEF
@@ -284,7 +284,7 @@ expr:
   | MP3 app_opt                      { mk_mp3_cbr $2 }
   | MP3_VBR app_opt                  { mk_mp3_vbr $2 }
   | MP3_ABR app_opt                  { mk_mp3_abr $2 }
-  | MP3_FXP app_opt                  { mk_shine $2 }
+  | SHINE app_opt                  { mk_shine $2 }
   | AACPLUS app_opt                  { mk_aacplus $2 }
   | VOAACENC app_opt                 { mk_voaacenc $2 }
   | FDKAAC app_opt                   { mk_fdkaac $2 }
@@ -380,7 +380,7 @@ cexpr:
   | MP3 app_opt                      { mk_mp3_cbr $2 }
   | MP3_VBR app_opt                  { mk_mp3_vbr $2 }
   | MP3_ABR app_opt                  { mk_mp3_abr $2 }
-  | MP3_FXP app_opt                  { mk_shine $2 }
+  | SHINE app_opt                    { mk_shine $2 }
   | FLAC app_opt                     { mk_flac $2 }
   | AACPLUS app_opt                  { mk_aacplus $2 }
   | VOAACENC app_opt                 { mk_voaacenc $2 }

diff --git a/src/lang/lang_pp.ml b/src/lang/lang_pp.ml
@@ -41,7 +41,7 @@ let get_encoder_format tokenizer lexbuf =
     | Lang_parser.MP3 -> Lang_encoders.mk_mp3_cbr []
     | Lang_parser.MP3_VBR -> Lang_encoders.mk_mp3_vbr []
     | Lang_parser.MP3_ABR -> Lang_encoders.mk_mp3_vbr []
-    | Lang_parser.MP3_FXP -> Lang_encoders.mk_shine []
+    | Lang_parser.SHINE   -> Lang_encoders.mk_shine []
     | Lang_parser.AACPLUS -> Lang_encoders.mk_aacplus []
     | Lang_parser.VOAACENC -> Lang_encoders.mk_voaacenc []
     | Lang_parser.FDKAAC -> Lang_encoders.mk_fdkaac []