Permalink
Browse files

Added documentation for configuration options.

  • Loading branch information...
1 parent de26d95 commit c8f3e1f19a92b958fc786f2941d8b1b0dfd9f227 @Raptor399 Raptor399 committed Apr 25, 2012
Showing with 64 additions and 2 deletions.
  1. +19 −2 src/main/external-resources/PMS.conf
  2. +45 −0 src/main/java/net/pms/configuration/PmsConfiguration.java
@@ -465,12 +465,14 @@ mencoder_yadif = false
# GUI Option: Remux videos
#mencoder_mux_compatible = true
-# Codec specific paramters
+# Codec specific parameters
# --------------
# GUI Option : Use application default codec parms
mencoder_intelligent_sync = true
-# GUI Option: Codec specific paramters (text)
+# GUI Option: Codec specific parameters (text)
+# Sets additional codec specific configuration options for MEncoder. Default
+# value is "".
#codec_spec_script =
# ---< Specific options >-----------------------------------------------------
@@ -662,13 +664,28 @@ tsmuxer_forcefps = true
# ---< Active - but not settable in GUI >--------------------------------------
charsetencoding = 850
+
+# Set to "true" if PMS should pass the flag "convertfps=true" to AviSynth.
+# Default value is true.
avisynth_convertfps = true
+
+# The template for the AviSynth script. The script string may contain the
+# character "\u0001", which will be treated as newline character.
avisynth_script = #AviSynth script is now fully customisable !\u0001#You must use the following variables (\"clip\" being the avisynth variable of the movie):\u0001#<movie>: insert the complete DirectShowSource instruction [ clip=DirectShowSource(movie, convertfps) ]\u0001#<sub>: insert the complete TextSub/VobSub instruction if there's any detected srt/sub/idx/ass subtitle file\u0001#<moviefilename>: variable of the movie filename, if you want to do all this by yourself\u0001#Be careful, the custom script MUST return the clip object\u0001<movie>\u0001<sub>\u0001return clip
+
transcode_block_multiple_connections = false
#transcode_keep_first_connection =
#skiploopfilter = true
ffmpeg = -g 1 -qscale 1 -qmin 2
+# The maximum size (in MB) that PMS should use for buffering audio. Default
+# value is 100.
+maxaudiobuffer = 100
+
+# The minimum size (in MB) that PMS should use for the buffer used for
+# streaming media. Default value is 1.
+#minwebbuffer = 1
+
# ---< Explicitly deprecated >------------------------------------------------
turbomode = false
#tsmuxer_preremix_ac3 = false
@@ -1488,34 +1488,79 @@ public void setUseCache(boolean value) {
configuration.setProperty(KEY_USE_CACHE, value);
}
+ /**
+ * Set to true if PMS should pass the flag "convertfps=true" to AviSynth.
+ *
+ * @param value True if PMS should pass the flag.
+ */
public void setAvisynthConvertFps(boolean value) {
configuration.setProperty(KEY_AVISYNTH_CONVERT_FPS, value);
}
+ /**
+ * Returns true if PMS should pass the flag "convertfps=true" to AviSynth.
+ *
+ * @return True if PMS should pass the flag.
+ */
public boolean getAvisynthConvertFps() {
return getBoolean(KEY_AVISYNTH_CONVERT_FPS, true);
}
+ /**
+ * Returns the template for the AviSynth script. The script string can
+ * contain the character "\u0001", which should be treated as the newline
+ * separator character.
+ *
+ * @return The AviSynth script template.
+ */
public String getAvisynthScript() {
return getString(KEY_AVISYNTH_SCRIPT, DEFAULT_AVI_SYNTH_SCRIPT);
}
+ /**
+ * Sets the template for the AviSynth script. The script string may contain
+ * the character "\u0001", which will be treated as newline character.
+ *
+ * @param value The AviSynth script template.
+ */
public void setAvisynthScript(String value) {
configuration.setProperty(KEY_AVISYNTH_SCRIPT, value);
}
+ /**
+ * Returns additional codec specific configuration options for MEncoder.
+ *
+ * @return The configuration options.
+ */
public String getCodecSpecificConfig() {
return getString(KEY_CODEC_SPEC_SCRIPT, "");
}
+ /**
+ * Sets additional codec specific configuration options for MEncoder.
+ *
+ * @param value The additional configuration options.
+ */
public void setCodecSpecificConfig(String value) {
configuration.setProperty(KEY_CODEC_SPEC_SCRIPT, value);
}
+ /**
+ * Returns the maximum size (in MB) that PMS should use for buffering
+ * audio.
+ *
+ * @return The maximum buffer size.
+ */
public int getMaxAudioBuffer() {
return getInt(KEY_MAX_AUDIO_BUFFER, 100);
}
+ /**
+ * Returns the minimum size (in MB) that PMS should use for the buffer used
+ * for streaming media.
+ *
+ * @return The minimum buffer size.
+ */
public int getMinStreamBuffer() {
return getInt(KEY_MIN_STREAM_BUFFER, 1);
}

0 comments on commit c8f3e1f

Please sign in to comment.