[Gridflow-cvs] [svn] commit: r4367 - in /trunk/doc: flow_classes/#in-help.pd flow_classes/#out-help.pd format.xml

gridflow-cvs at artengine.ca gridflow-cvs at artengine.ca
Sat Oct 24 20:15:47 EDT 2009


Author: matju
Date: Sat Oct 24 20:15:46 2009
New Revision: 4367

Log:
[#in] [#out]

Modified:
    trunk/doc/flow_classes/#in-help.pd
    trunk/doc/flow_classes/#out-help.pd
    trunk/doc/format.xml

Modified: trunk/doc/flow_classes/#in-help.pd
==============================================================================
--- trunk/doc/flow_classes/#in-help.pd (original)
+++ trunk/doc/flow_classes/#in-help.pd Sat Oct 24 20:15:46 2009
@@ -1,4 +1,4 @@
-#N canvas 172 0 554 702 10;
+#N canvas 680 0 554 717 10;
 #X obj 354 172 #out window;
 #X text 13 34 This object imports a grid \, usually an image \, video
 or live stream.;
@@ -6,23 +6,15 @@
 #X obj 354 106 bng 15 250 50 0 empty empty empty 0 -6 0 8 -24198 -1
 -1;
 #X text 55 181 <--click here;
-#X text 79 449 A bang sends a grid to [#out]. Since frames from videos
-and live streams are read as a series of individual grids \, successive
-bangs advance through the frames.;
-#X text 77 536 "set" - followed by a number will select the corresponding
-video frame. A bang must be sent to [#in] in order to display the frame.
-;
-#X text 77 582 "close" - Closes the video input device. Only necessary
+#X text 192 683 "close" - Closes the video input device. Only necessary
 when you are using a live capture device.;
-#X text 76 616 "rewind" - Will rewind video to the beginning.;
-#X text 76 670 "loop 0" - turns off the loop option. The video stops
+#X text 185 819 "rewind" - Will rewind video to the beginning.;
+#X text 182 876 "loop 0" - turns off the loop option. The video stops
 once it reaches the end.;
-#X text 81 932 Signals the end of a file and when a file is unreadable.
-;
-#X text 82 884 Displays the resulting grid when connected to [#out
+#X text 185 1050 Signals the end of a file and when a file is unreadable.
+;
+#X text 185 1017 Displays the resulting grid when connected to [#out
 window];
-#X text 81 962 Displays the frame number of the frame currently being
-viewed. Applies to formats that have frame numbers \, i.e. video.;
 #N canvas 82 93 663 454 quicktime 0;
 #X text 9 9 The following messages can be used to set parameters for
 video (.mov) files.;
@@ -70,7 +62,7 @@
 #X connect 11 0 9 0;
 #X connect 25 0 9 0;
 #X connect 26 0 9 0;
-#X restore 145 758 pd quicktime file messages;
+#X restore 251 964 pd quicktime file messages;
 #X obj 354 150 #in;
 #X floatatom 202 195 5 0 0 0 - - -;
 #X msg 202 151 set 2;
@@ -89,8 +81,8 @@
 #X obj 356 280 #out window;
 #X obj 356 258 #in sewing.jpg;
 #X text 378 234 <--click here;
-#X text 77 741 For info about messages specifically for quickTime files
-\, click on:;
+#X text 183 947 For info about messages specifically for quickTime
+files \, click on:;
 #N canvas 150 0 874 560 more 0;
 #X msg 191 388 open videodev \$1 \, get;
 #X msg 52 147 brightness 1000;
@@ -146,15 +138,9 @@
 #X connect 11 0 14 0;
 #X connect 12 0 14 0;
 #X connect 13 0 14 0;
-#X restore 145 719 pd more info about video devices;
-#X text 77 702 For info about messages specifically for video devices
+#X restore 251 925 pd more info about video devices;
+#X text 183 908 For info about messages specifically for video devices
 \, click on:;
-#X text 8 883 GRID;
-#X text 10 933 BANG;
-#X text 9 960 INTEGER;
-#X text 9 451 GRID;
-#X text 9 503 MESSAGE;
-#X text 8 797 INTEGER;
 #X text 169 213 (and turn off the metro);
 #X text 244 195 <-- vary this;
 #X text 352 74 IMAGE FILES:;
@@ -165,41 +151,71 @@
 #X text 68 265 <-- sends a bang upon reaching;
 #X text 97 278 the end of the file;
 #X obj 17 305 #out window \, title video;
-#X text 180 352 Including the file name of a grid into the [#in] object
-eliminates the need for an "open" message but limits the action to
-one specified grid.;
-#X text 77 502 "open" - followed by the filename \, sends it as a resource
-to [#out]. For example: "open sewing.jpg".;
-#X text 77 797 Outputs the frame that corresponds to the value. Applies
+#X text 184 767 Outputs the frame that corresponds to the value. Applies
 to formats that have frame numbers \, i.e. video.;
-#X text 76 636 "loop 1" - Restarts a video each time it reaches the
+#X text 182 842 "loop 1" - Restarts a video each time it reaches the
 end (default setting).;
 #X obj 41 248 route bang;
 #X msg 24 147 open violoncelle.mov;
 #X obj 0 0 doc_h;
-#X obj 3 331 doc_c 1;
-#X text 97 352 FILENAME;
-#X obj 3 401 doc_i 1;
-#X obj 3 834 doc_o 2;
-#X obj 14 425 doc_ii 0;
-#X obj 14 858 doc_oo 0;
-#X obj 14 911 doc_oo 1;
-#X obj 14 355 doc_cc 0;
-#X connect 2 0 14 0;
-#X connect 3 0 14 0;
-#X connect 14 0 0 0;
-#X connect 15 0 22 0;
-#X connect 16 0 22 0;
-#X connect 17 0 22 0;
-#X connect 18 0 22 0;
-#X connect 20 0 22 0;
-#X connect 22 0 47 0;
-#X connect 22 1 19 0;
-#X connect 22 1 52 0;
-#X connect 24 0 25 0;
-#X connect 25 0 22 0;
-#X connect 26 0 28 0;
-#X connect 28 0 27 0;
-#X connect 43 0 22 0;
-#X connect 52 0 21 0;
-#X connect 53 0 22 0;
+#X obj 3 471 doc_i 1;
+#X obj 3 994 doc_o 2;
+#X obj 14 495 doc_ii 0;
+#X obj 14 1018 doc_oo 0;
+#X obj 14 1051 doc_oo 1;
+#X obj 3 332 doc_c 1..2;
+#X text 164 389 auto-open with auto-detect of the format-handler;
+#X text 207 409 auto-open with manual choice of the format-handler
+;
+#X obj 100 659 doc_m i0 open;
+#X obj 100 719 doc_m i0 set;
+#X obj 100 689 doc_m i0 close;
+#X obj 100 819 doc_m i0 rewind;
+#X obj 100 849 doc_m i0 loop;
+#X obj 100 769 doc_m i0 float int;
+#X obj 100 1018 doc_m o0 grid;
+#X obj 100 1051 doc_m o1 bang;
+#X obj 3 1164 doc_also;
+#X obj 103 1163 #out;
+#X obj 32 370 #in;
+#X obj 33 391 #in filename.suffix;
+#X obj 34 411 #in handler filename.suffix;
+#X text 64 369 nothing opened \, you have to open by yourself;
+#X text 186 659 \$1=filename. sends it as a resource to [#in]. For
+example: "open sewing.jpg".;
+#X obj 100 495 doc_m i0 bang;
+#X text 185 716 "set" - followed by a number will select the corresponding
+video frame. A bang must be sent to [#in] in order to display the frame.
+this only works with video file formats.;
+#X obj 100 1071 doc_m o1 float int;
+#X text 194 1074 frame number of the frame currently being viewed.
+Applies to formats that have frame numbers \, i.e. video.;
+#X text 188 495 A bang reads a frame and sends it through the outlet.
+Since frames from videos and live streams are read as a series of individual
+grids \, successive bangs advance through the frames. A bang reads
+a frame and sends it through the outlet. Since frames from videos and
+live streams are read as a series of individual grids \, successive
+bangs advance through the frames. this is format-specific. most formats
+produce grids that have dimensions (rows columns rgb). In formats that
+read from a file \, reading another picture will continue if there
+are several pictures in the same file \, but if the end of file is
+reached instead \, it will rewind and send the first picture again.
+;
+#X connect 2 0 11 0;
+#X connect 3 0 11 0;
+#X connect 11 0 0 0;
+#X connect 12 0 19 0;
+#X connect 13 0 19 0;
+#X connect 14 0 19 0;
+#X connect 15 0 19 0;
+#X connect 17 0 19 0;
+#X connect 19 0 38 0;
+#X connect 19 1 16 0;
+#X connect 19 1 41 0;
+#X connect 21 0 22 0;
+#X connect 22 0 19 0;
+#X connect 23 0 25 0;
+#X connect 25 0 24 0;
+#X connect 34 0 19 0;
+#X connect 41 0 18 0;
+#X connect 42 0 19 0;

Modified: trunk/doc/flow_classes/#out-help.pd
==============================================================================
--- trunk/doc/flow_classes/#out-help.pd (original)
+++ trunk/doc/flow_classes/#out-help.pd Sat Oct 24 20:15:46 2009
@@ -1,32 +1,21 @@
-#N canvas 512 0 560 717 10;
+#N canvas 674 0 560 717 10;
 #X obj 15 325 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
 -1;
 #X text 10 71 Displaying a grid:;
 #X text 342 73 Saving a grid:;
-#X text 6 526 MESSAGE;
-#X text 8 494 GRID;
-#X text 7 563 MESSAGE;
-#X text 8 639 MESSAGE;
-#X text 75 639 "rewind" rewinds to the beginning of a video file. Will
-overwrite previous data.;
-#X text 79 676 "timelog 1" will display (in the console) the current
-time and the time since the last frame. Message "timelog 0" will hide
-this information. The default is "timelog 0".;
-#X text 8 673 MESSAGE;
-#X text 81 394 window [#out window] opens a window in which the grid
-will be displayed.;
-#X text 7 802 BANG;
+#X text 189 653 "rewind" rewinds to the beginning of a video file.
+Will overwrite previous data.;
+#X text 7 932 BANG;
 #X msg 45 150 open working.jpg;
 #X obj 15 100 bng 15 250 50 0 empty empty empty 0 -6 0 8 -24198 -1
 -1;
 #X obj 15 221 #in;
 #X msg 66 229 open window;
 #X msg 65 252 close;
-#X text 75 563 "close" closes the file and hides the display \, must
+#X text 189 577 "close" closes the file and hides the display \, must
 be accompanied by message "open window" to reopen the display.;
-#X text 75 802 A bang notifies when a complete grid has been received.
+#X text 75 932 A bang notifies when a complete grid has been received.
 ;
-#X text 77 496 Receives a grid.;
 #X text 12 32 Displays or saves an incoming grid (usually an image
 or a video).;
 #X obj 15 302 #out window \, title example;
@@ -35,9 +24,9 @@
 #X obj 177 121 t b b;
 #X obj 177 97 bng 15 250 50 0 empty empty empty 0 -6 0 8 -24198 -1
 -1;
-#X obj 101 841 #record;
+#X obj 138 972 #record;
 #X msg 366 228 open somefile.jpg;
-#X text 73 521 "open filename.format" (ex: "open somefile.jpg") sets
+#X text 187 535 "open filename.format" (ex: "open somefile.jpg") sets
 the filename to write to.;
 #X msg 381 144 open sewing.jpg;
 #X obj 351 120 t b b;
@@ -47,12 +36,11 @@
 #X obj 351 266 #out;
 #X msg 127 262 hidecursor;
 #X text 205 261 <-- linux only;
-#X text 7 603 MESSAGE;
-#X text 75 603 "hidecursor" (linux only) hides the mouse cursor.;
+#X text 189 617 "hidecursor" (linux only) hides the mouse cursor.;
 #X obj 0 0 doc_h;
 #X obj 3 369 doc_c n;
-#X obj 3 842 doc_also;
-#X obj 3 735 doc_o 1;
+#X obj 3 972 doc_also;
+#X obj 3 865 doc_o 1;
 #N canvas 140 137 570 631 More 0;
 #X obj 35 266 tgl 15 0 empty empty empty 0 -6 0 8 -233017 -1 -1 0 1
 ;
@@ -118,25 +106,39 @@
 #X connect 29 0 19 0;
 #X connect 30 0 23 0;
 #X restore 140 334 pd More info about this object class;
-#X obj 3 445 doc_i 1;
-#X obj 14 469 doc_ii 0;
-#X obj 14 759 doc_oo 0;
-#X connect 12 0 14 0;
-#X connect 13 0 23 0;
-#X connect 14 0 21 0;
-#X connect 15 0 21 0;
-#X connect 16 0 21 0;
-#X connect 21 0 0 0;
-#X connect 22 0 14 0;
-#X connect 23 0 14 0;
-#X connect 23 1 12 0;
-#X connect 24 0 14 0;
-#X connect 24 1 22 0;
-#X connect 25 0 24 0;
-#X connect 27 0 33 0;
-#X connect 29 0 32 0;
-#X connect 30 0 32 0;
-#X connect 30 1 29 0;
-#X connect 31 0 30 0;
-#X connect 32 0 33 0;
-#X connect 34 0 21 0;
+#X obj 3 485 doc_i 1;
+#X obj 14 509 doc_ii 0;
+#X obj 14 889 doc_oo 0;
+#X obj 100 509 doc_m i0 grid;
+#X obj 100 539 doc_m i0 open;
+#X obj 100 579 doc_m i0 close;
+#X obj 100 619 doc_m i0 hidecursor;
+#X obj 100 659 doc_m i0 rewind;
+#X obj 103 971 #in;
+#X text 188 426 auto-open with auto-detect of the format-handler;
+#X text 231 447 auto-open with manual choice of the format-handler
+;
+#X text 88 406 nothing opened \, you have to open by yourself;
+#X obj 46 407 #out;
+#X obj 46 428 #out filename.suffix;
+#X obj 46 449 #out handler filename.suffix;
+#X obj 100 700 doc_m i0 autoclose;
+#X connect 5 0 7 0;
+#X connect 6 0 15 0;
+#X connect 7 0 13 0;
+#X connect 8 0 13 0;
+#X connect 9 0 13 0;
+#X connect 13 0 0 0;
+#X connect 14 0 7 0;
+#X connect 15 0 7 0;
+#X connect 15 1 5 0;
+#X connect 16 0 7 0;
+#X connect 16 1 14 0;
+#X connect 17 0 16 0;
+#X connect 19 0 25 0;
+#X connect 21 0 24 0;
+#X connect 22 0 24 0;
+#X connect 22 1 21 0;
+#X connect 23 0 22 0;
+#X connect 24 0 25 0;
+#X connect 26 0 13 0;

Modified: trunk/doc/format.xml
==============================================================================
--- trunk/doc/format.xml (original)
+++ trunk/doc/format.xml Sat Oct 24 20:15:46 2009
@@ -1,176 +1,3 @@
-<documentation title="Reference Manual: Format Classes">
-<section name="Objects for Input/Output">
-	<class name="#in">
-		<method name="init" min="0">
-				<arg name="format"/>
-				<rest name="format_specific_part"/>
-
-			If no arguments given, creates an input object for an unspecified
-			format. You then need to use the "open" command to link
-			a format handler to it.
-
-			If arguments given, the "open" command is immediately called
-			with those arguments.
-
-			Remember that most formats produce Dim[rows,columns,3] grids with
-			0-255 values. (Most.)
-		</method>
-
-		<inlet id="0">
-			<method name="open" min="1">
-				<arg name="format"/>
-				<rest name="format_specific_part"/>
-				This is the command that gives a particular resource
-				to a [#out] object. This is done through a "format"
-				(there is a list of formats in this manual). The other
-				arguments depend on the chosen format. The format may
-				be a file format or a protocol or a hardware device, etc.
-				
-				The format called "file" is a special shortcut that autodetects the
-				type of file (by name suffix) and picks up the appropriate handler.
-			</method>
-			<method name="open">
-				<arg name="filename"/>
-				This is a shortcut for "open file" followed by a filename.
-				The filename must contain a dot, else it will be seen as a handler name.
-			</method>
-			<method name="close">
-				close may be necessary if you operate on "/dev/video",
-				which can only be read by one at a time. otherwise it's
-				usually not necessary.
-			</method>
-			<method name="int">
-				<arg name="frame_number"/>
-				selects one picture from a multi-picture format
-				and then does the same as a bang.
-			</method>
-			<method name="set">
-				<arg name="frame_number"/>
-				selects one picture from a multi-picture format,
-				to be displayed by the next bang.
-			</method>
-			<method name="bang">
-				sends a grid through the outlet. the grid may be the
-				result of reading from a file, acquiring from a device,
-				capturing from the screen etc.
-
-				this is format-specific. most formats
-				produce grid(rows columns {red green blue}).
-
-				In formats that read from a file, reading another picture
-				will continue if there are several pictures in the
-				same file, but if the end of file is reached instead,
-				it will rewind and send the first picture again.
-
-				see section "External Picture Formats".
-
-			</method>
-			<method name="option">
-				<arg name="selector" type="symbol"/>
-				<rest name="stuff"/>
-				Obsolete. the word "option" is optional now.
-			</method>
-			<method name="rewind">
-				rewinds to beginning of file if applicable.
-			</method>
-			<method name="loop">
-				<arg name="flag" type="bool"/>
-				controls the automatic looping of movies.
-			</method>
-			
-		</inlet>
-
-		<outlet id="1">
-			<method name="int">
-				frame number of frame just sent,
-				for formats that have frame numbers.
-			</method>
-			
-			<method name="bang">
-				tried to read a frame that does not exist
-				(signals end of file)
-			</method>
-		</outlet>
-	</class>
-	<class name="#out">
-		<method name="init" min="0">
-				<arg name="format"/>
-				<rest name="format_specific_part"/>
-
-			If no arguments given, creates an output object for an unspecified
-			format. You then need to use the "open" command to link
-			a format handler to it.
-
-			If arguments given, the "open" command is immediately called
-			with those arguments.
-
-			Remember that most formats expect dim(rows,columns,3) grids with
-			0-255 values. (Most.)
-		</method>
-		<method name="init">
-			<arg name="rows" type="integer"/>
-			<arg name="columns" type="integer"/>
-
-			This alternate way to create an [#out] automatically calls
-			"open window" and "out_size <i>rows columns</i>".
-		</method>
-		<inlet id="0">
-			<method name="open" min="1">
-				<arg name="format"/>
-				<rest name="format_specific_part"/>
-				This is the command that gives a particular resource
-				to a [#out] object. This is done through a "format"
-				(there is a list of formats in this manual). The other
-				arguments depend on the chosen format. The format may
-				be a file format or a protocol or a hardware device, etc.
-			</method>
-			<method name="open file">
-				The format called "file" is a special shortcut that autodetects the
-				type of file (by name suffix) and picks up the appropriate handler.
-			</method>
-			<method name="open">
-				<arg name="filename"/>
-				This is a shortcut for "open file" followed by a filename.
-				The filename must contain a dot, else it will be seen as a handler name.
-			</method>
-			<method name="grid"><arg name="grid" type="grid"/>
-				this is format-specific. most formats
-				expect grid(rows columns {red green blue}).
-
-				In formats that write to a file, sending a 2nd picture
-				overwrites the first.
-
-				see section "External Picture Formats".
-			</method>
-			<method name="close">
-				closes the file. usually not necessary.
-			</method>
-			<method name="option">
-				<arg name="selector" type="symbol"/>
-				<rest name="stuff"/>
-				Obsolete. Omit the word "option" now.
-			</method>
-			<method name="timelog">
-				<arg name="status" type="0,1"/>
-				when status=1, current time (unix clock) and time since last
-				frame-end are printed in the console. when status=0, it is off.
-				default is 0.
-			</method>
-			<method name="rewind">
-				rewinds to beginning of file if applicable.
-				will overwrite the previous data.
-			</method>
-			<method name="autoclose">
-				...
-			</method>
-		</inlet>
-		<outlet id="0">
-			<method name="bang">
-				sent when a complete grid has been received.
-			</method>
-		</outlet>
-	</class>
-
 	<class name="#mouse">
 		This will process the "position" messages emitted by [#out] or [#peephole] in
 		useful ways.
@@ -443,12 +270,8 @@
 			<arg name="attr" type="int"/>
 			<arg name="text" type="symbol"/>
 		</method>
-		<method name="autodraw">
-			like X11's autodraw.
-		</method>
-		<method name="draw">
-			like X11's draw.
-		</method>
+		<method name="autodraw"></method>
+		<method name="draw"></method>
 		<method name="dump">
 			produces a Dim[y,x,2] grid whose two channels are
 			ascii character codes and character attributes.
@@ -463,5 +286,3 @@
 		</method>
 	</class>
 </section>
-
-</documentation>



More information about the Gridflow-cvs mailing list