X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=docs%2Fservices.txt;h=27864d3d79c4ed879af01daf5724e5f359c8163b;hb=42bd0aedb6d3d65bedb98479adcdbaeb326dfee9;hp=390d05d6d8f1e0fa8f3b519215faebb776ef0c94;hpb=2487d58b3968e381a542c688a55a29a5f0c9f5a5;p=melted

diff --git a/docs/services.txt b/docs/services.txt
index 390d05d..27864d3 100644
--- a/docs/services.txt
+++ b/docs/services.txt
@@ -43,8 +43,6 @@ Producers
 			Audio sync discrepancy with some content.
 			Not all libavformat supported formats are seekable.
 			ogg is currently broken.
-			Multiple mp3 uses in a single instance causes crash (patch
-			available on request - submitted to ffmpeg mailing list).
 			mpeg seeking is inaccurate - doesn't seek to i-frames so you may
 			get junk for a few frames.
 
@@ -280,7 +278,7 @@ Producers
 
 		Dependencies
 
-			libgdk_pixbuf-2.0, libglib-2.0,	libgobject-2.0, libgmodule-2.0
+			libgdk_pixbuf-2.0, libglib-2.0, libgobject-2.0, libgmodule-2.0
 
 		Known Bugs
 
@@ -313,6 +311,56 @@ Producers
 
 			Since it uses pipes, it is not compatible with bluefish.
 
+	westley
+
+		Description
+
+			Construct a service network from an XML description.
+
+		Constructor Argument
+
+			file - an XML text file containing westley XML (schema pending)
+
+		Read Only Properties
+
+			string resource - file location
+
+		Dependencies
+
+			libxml2
+
+		Known Bugs
+
+			Non-referenced producers and playlists are not destroyed.
+			A referenced producer or playlist must appear before the reference.
+
+	vorbis
+
+		Description
+
+			OGG Vorbis file reader.
+
+		Constructor Argument
+
+			'file' - file to use (only .ogg supported at the moment)
+
+		Initialisation Properties
+
+			int in - in point
+			int out - out point
+
+		Read Only Properties
+
+			double fps - this is fixed at 25 for PAL currently
+
+		Dependencies
+
+			libvorbisfile
+
+		Known Bugs
+
+			Fixed frame size (PAL audio chunks).
+			Doesn't cover ogg files with multiple, differing sections.
 
 Filters
 -------
@@ -428,6 +476,35 @@ Filters
 
 			none
 		
+	obscure
+	
+		Description
+
+			Obscuring filter.
+			
+		Constructor Argument
+
+			none
+			
+		Initialisation Properties
+		
+			string start - in the format X,Y:WxH[:PWxPY]
+			string end - in the format X,Y:WxH[:PWxPY]
+			int in - in point
+			int out - out point
+
+		Read Only Properties
+
+			none
+			
+		Dependencies
+
+			none
+
+		Known Bugs
+
+			none
+
 	resize
 	
 		Description
@@ -464,16 +541,35 @@ Filters
 			
 		Constructor Argument
 
-			volume - a floating point value of the factor
+			gain - a string containing one of:
+				 - a floating point value of the gain adjustment
+				 - a numeric value with the suffix "dB" to adjust in terms of decibels
+				 - "normalise" to normalise the volume to the target amplitude -12dBFS
 			
 		Initialisation Properties
 		
 			int in - in point
 			int out - out point
+			int window - the number of video frames over which to smooth normalisation.
+			             defaults to 75.
 
 		Mutable Properties
 
-			double volume - the factor applied to each sample
+			string gain - same as constructor argument above
+
+			string normalise - normalise the volume to the amplitude:
+				- a numeric value with the suffix "dB" to set amplitude in decibels
+				- a floating point value of the relative volume
+				- an unspecified value uses the default -12dBFS
+
+			string limiter - limit all samples above:
+				- a numeric value with the suffix "dB"
+				- a floating point value ( dB = 20 * log10(x) )
+				- an unspecified value uses the default -6dBFS
+
+			double max_gain - a floating point or decibel value of the maximum gain that
+				can be applied during normalisation.
+				- an unspecified value uses the default 20dB
 			
 		Dependencies
 
@@ -510,6 +606,37 @@ Filters
 
 			none
 
+	rescale
+
+		Description
+
+			Scale the producer video frame size to match the consumer.
+
+		Constructor Argument
+
+			interpolation - the rescaling method, one of:
+				nearest (lowest quality, fastest),
+				tiles,
+				bilinear (good quality, moderate speed),
+				hyper (best quality, slowest)
+
+		Initialisation Properties
+
+			int in - in point
+			int out - out point
+
+		Mutable Properties
+
+			string interpolation - see constructor argument above
+
+		Dependencies
+
+			libgdk_pixbuf-2.0, libglib-2.0, libgobject-2.0, libgmodule-2.0
+
+		Known Bugs
+
+			none
+
 Transitions
 -----------
 
@@ -561,7 +688,7 @@ Transitions
 		
 		Constructor Argument
 
-			string file - the luma map file name. If not supplied, a dissolve.
+			string resource - the luma map file name. If not supplied, a dissolve.
 
 		Initialisation Properties
 		
@@ -570,7 +697,7 @@ Transitions
 
 		Mutable Properties
 
-			string filename - same as above
+			string resource - same as above
 			double softness - only when using a luma map, how soft to make the
 			                  edges between A and B. 0.0 = no softness. 1.0 =
 			                  too soft.
@@ -709,3 +836,28 @@ Consumers
 			NTSC handling needs tightening up - sdl:NTSC is the only valid
 			constructor for NTSC playback at the moment.
 
+	westley
+
+		Description
+
+			Serialise the service network to XML.
+			
+		Constructor Argument
+
+			resource - the name of a file in which to store the XML.
+				stdout is used if not supplied.
+			
+		Initialisation Properties
+
+			string resource - same as above.
+			
+		Dependencies
+		
+			libxml2
+			
+		Known Bugs
+
+			Untested arbitrary nesting of multitracks and playlists.
+			Property "id" is generated as service type followed by number if
+			no property named "id" exists, but it fails to guarantee uniqueness.
+