1 #LyX 1.6.5 created this file. For more info see http://www.lyx.org/
6 \use_default_options true
11 \font_typewriter default
12 \font_default_family default
19 \paperfontsize default
28 \paperorientation portrait
38 \paragraph_separation indent
40 \quotes_language english
43 \paperpagestyle default
44 \tracking_changes false
60 \begin_layout Standard
61 JPC-RR is licenced under GNU GPL v2.
63 \begin_inset Quotes eld
67 \begin_inset Quotes erd
77 \begin_layout Subsection
81 \begin_layout Standard
82 To get started, you need BIOS image, VGABIOS image and DOS boot floppy and
83 JDK for Java 6 standard edition (later versions should they appear should
85 Note: JRE is not enough.
89 \begin_layout Standard
90 Note that to play back recorded movies, you need exact same version of BIOS
91 image, VGABIOS image and DOS boot floppy as was used when making the movie
92 (in addition to exact same versions of other needed media).
95 \begin_layout Subsection
99 \begin_layout Standard
100 See compile.sh or compile.bat.
101 The streamtools stuff is only needed for dumping videos.
104 \begin_layout Subsection
108 \begin_layout Standard
109 First you need to get and make some important images.
110 Obtain BIOS image, VGABIOS image and DOS boot floppy from somewhere.
111 After starting the emulator, use Drives -> Import Image to import the images
112 (ignore the error about no BIOS images being found).
115 \begin_layout Subsection
119 \begin_layout Standard
120 There is premade autoexec script called assemble.jpcrrinit that has fairly
125 \begin_layout LyX-Code
126 java JPCApplication -library library -autoexec assemble.jpcrrinit
129 \begin_layout Standard
131 \begin_inset Quotes eld
135 \begin_inset Quotes erd
138 specifies that contents of directory 'library' are to be used as library.
139 The script pops up settings for new emulated PC (if you want to load savestate,
141 Select BIOS and VGABIOS for BIOS and VGABIOS image (they should be already
142 selected), DOSfloppy for fda (boot device should be set to fda) and game
143 image as some HD drive
146 \begin_layout Subsection
150 \begin_layout Itemize
151 Putting the game as hdd (the fourth hard disk slot) causes boot to be bit
155 \begin_layout Itemize
156 Some BIOS versions have
157 \begin_inset Quotes eld
160 press F12 to select boot device
161 \begin_inset Quotes erd
165 Hit <enter> from emulated keyboard and that prompt will go away in about
166 half emulated second (it stays several emulated seconds otherwise).
170 \begin_layout Itemize
171 If game doesn't need lots of memory, hitting F5 to skip intialization files
173 If it does need more memory, run config.sys commands but not autoexec.bat.
177 \begin_layout Itemize
178 Some DOS disks have DOSIDLE with them, don't use it as it messes badly with
182 \begin_layout Section
183 Making JPC-RR format images from raw images
186 \begin_layout Standard
187 Due to various factors, JPC-RR can't use raw image files directly but requires
188 its own image format.
192 \begin_layout Subsection
193 Importing images from GUI:
196 \begin_layout Standard
197 Use Drives -> Import Image to import existing directories or image files.
198 Dialog prompting parameters will be displayed.
199 When importing floppy images, check
200 \begin_inset Quotes eld
204 \begin_inset Quotes erd
207 if possible, that enables geometry autodetection, which is reasonable virtually
208 all of the time it is offered.
211 \begin_layout Subsection
215 \begin_layout Itemize
216 If making image from directory, the names of the files must conform to FAT
217 naming restrictions (8+3 character names, no spaces, etc).
218 Avoid filenames with non-ASCII characters.
222 \begin_layout Itemize
223 The DOS limit of 112 or 224 files for floppies does not apply to images
224 created from directory trees.
225 The minimum limit value used is 512.
226 If even that isn't enough, the limit is automatically increased to fit
227 all the needed directory entries.
230 \begin_layout Itemize
231 Making boot disks from tree does NOT work.
232 Even if you got system boot files there, it still won't work.
235 \begin_layout Itemize
236 Only floppy disks and hard drives can be made from directory trees.
237 BIOS images and CDROM images require image file.
240 \begin_layout Itemize
241 Avoid floppies with custom geometry (floppy geometry does affect disk ID).
242 Disks with over 63 sectors per track don't work with DOS.
243 Wheither disks with over 127 tracks per side work with DOS is unknown.
244 Also avoid 1024-tracks per side HDDs.
247 \begin_layout Itemize
248 The geometry limits are: 2-1024 tracks per side for HDD, 1-256 tracks per
250 1-63 sectors per track for HDD, 1-255 sectors per track for floppy.
251 1-16 sides for HDD, 1 or 2 sides for floppy.
252 This gives size limit of 65280KiB for floppy disks (but note the DOS limit!)
253 and 516096KiB for HDDs.
256 \begin_layout Itemize
257 There are multiple image file contents that represent the same image.
258 The one with smallest size is picked when creating image.
261 \begin_layout Itemize
262 Note: Although the IDs are 128 bits long, they are not MD5 hashes.
266 \begin_layout Subsection
267 Importing from command line
270 \begin_layout Standard
271 There is tool called ImageMaker that can make JPC-RR images from raw images.
272 Each image has format, ID an name.
273 Format and name are specified when making image.
274 ID is automatically calculated from format and contents.
275 Name does not affect the ID but is purely for convience so one doesn't
276 have to specify long image IDs manually.
279 \begin_layout Subsubsection
283 \begin_layout Standard
284 The syntax for ImageMaker when making images is:
287 \begin_layout LyX-Code
288 $ java ImageMaker <format> [<options>...] <destination> <source> <name>
291 \begin_layout Standard
292 <destination> is file name for JPC-RR format image to write.
293 <source> is either name of regular file (raw image file) or name of directory
294 tree with files (supported for making floppy or hard disk images only).
295 In case of directory tree, the files are layout deterministically to disk,
296 so the ID will always be the same for given geometry and type.
297 <name> is name to give to disk.
301 \begin_layout LyX-Code
302 --BIOS BIOS image (note: VGABIOS is also of this type).
305 \begin_layout LyX-Code
306 --CDROM CD-ROM image.
309 \begin_layout LyX-Code
310 --HDD=cylinders,sectors,heads Hard disk with specified geometry.
313 \begin_layout LyX-Code
314 --floppy=tracks,sectors,sides Floppy disk with specified geometry.
317 \begin_layout LyX-Code
318 --floppy160 160KiB floppy (40 tracks, 8 sectors, Single sided).
321 \begin_layout LyX-Code
322 --floppy180 180KiB floppy (40 tracks, 9 sectors, Single sided).
325 \begin_layout LyX-Code
326 --floppy320 320KiB floppy (40 tracks, 8 sectors, Double sided).
329 \begin_layout LyX-Code
330 --floppy360 360KiB floppy (40 tracks, 9 sectors, Double sided).
333 \begin_layout LyX-Code
334 --floppy410 410KiB floppy (41 tracks, 10 sectors, Double sided).
337 \begin_layout LyX-Code
338 --floppy420 420KiB floppy (42 tracks, 10 sectors, Double sided).
341 \begin_layout LyX-Code
342 --floppy720 720KiB floppy (80 tracks, 9 sectors, Double sided).
345 \begin_layout LyX-Code
346 --floppy800 800KiB floppy (80 tracks, 10 sectors, Double sided).
349 \begin_layout LyX-Code
350 --floppy820 820KiB floppy (82 tracks, 10 sectors, Double sided).
353 \begin_layout LyX-Code
354 --floppy830 830KiB floppy (83 tracks, 10 sectors, Double sided).
357 \begin_layout LyX-Code
358 --floppy880 880KiB floppy (80 tracks, 11 sectors, Double sided).
361 \begin_layout LyX-Code
362 --floppy1040 1040KiB floppy (80 tracks, 13 sectors, Double sided).
365 \begin_layout LyX-Code
366 --floppy1120 1120KiB floppy (80 tracks, 14 sectors, Double sided).
369 \begin_layout LyX-Code
370 --floppy1200 1200KiB floppy (80 tracks, 15 sectors, Double sided).
373 \begin_layout LyX-Code
374 --floppy1440 1440KiB floppy (80 tracks, 18 sectors, Double sided).
377 \begin_layout LyX-Code
378 --floppy1476 1476KiB floppy (82 tracks, 18 sectors, Double sided).
381 \begin_layout LyX-Code
382 --floppy1494 1494KiB floppy (83 tracks, 18 sectors, Double sided).
385 \begin_layout LyX-Code
386 --floppy1600 1600KiB floppy (80 tracks, 20 sectors, Double sided).
389 \begin_layout LyX-Code
390 --floppy1680 1680KiB floppy (80 tracks, 21 sectors, Double sided).
393 \begin_layout LyX-Code
394 --floppy1722 1722KiB floppy (82 tracks, 21 sectors, Double sided).
397 \begin_layout LyX-Code
398 --floppy1743 1743KiB floppy (83 tracks, 21 sectors, Double sided).
401 \begin_layout LyX-Code
402 --floppy1760 1760KiB floppy (80 tracks, 22 sectors, Double sided).
405 \begin_layout LyX-Code
406 --floppy1840 1840KiB floppy (80 tracks, 23 sectors, Double sided).
409 \begin_layout LyX-Code
410 --floppy1920 1920KiB floppy (80 tracks, 24 sectors, Double sided).
413 \begin_layout LyX-Code
414 --floppy2880 2880KiB floppy (80 tracks, 36 sectors, Double sided).
417 \begin_layout LyX-Code
418 --floppy3120 3120KiB floppy (80 tracks, 39 sectors, Double sided).
421 \begin_layout LyX-Code
422 --floppy3200 3200KiB floppy (80 tracks, 40 sectors, Double sided).
425 \begin_layout LyX-Code
426 --floppy3520 3520KiB floppy (80 tracks, 44 sectors, Double sided).
429 \begin_layout LyX-Code
430 --floppy3840 3840KiB floppy (80 tracks, 48 sectors, Double sided).
433 \begin_layout Subsubsection
437 \begin_layout LyX-Code
438 --volumelabel=label Give specified volume label (affects ID).
439 Only meaningful when making image out of directory tree.
440 Default is no volume label.
443 \begin_layout LyX-Code
444 --timestamp=YYYYMMDDHHMMSS Give specified timestamp for files (affects ID).
445 Only meaningful when making image out of directory tree.
446 The default timestamp is 19900101T000000Z.
449 \begin_layout Subsubsection
453 \begin_layout Standard
457 \begin_layout LyX-Code
458 $ java ImageMaker <imagefile>
461 \begin_layout Standard
462 Variety of information about image is displayed (especially for floppies/HDDs).
463 Two important fields are calculated and claimed disk ID.
464 They should be the same.
465 If they are not, then the image file is corrupt (sadly, imagemaker has
466 bugs and bugs that cause it to write corrupt images have been seen).
469 \begin_layout Subsection
470 Advanced: The disk ID algorithm
473 \begin_layout Standard
474 The disk ID is calculated as:
477 \begin_layout LyX-Code
478 Skein-256-128-deprecated(<typecode>|<geometry>|<image>)
481 \begin_layout Standard
482 Where Skein-256-128-deprecated is Skein hash function with 256-bit internal
483 state and 128-bit output using the deprecated rotation constants (as specified
484 in Skein hash function reference documentation versions 1.0 and 1.1).
485 The <image> is the whole image, including parts not stored in image file.
486 The reason for keeping using the deprecated constants are:
489 \begin_layout Itemize
490 Changing the constants would change the IDs, which would invalidate existing
494 \begin_layout Itemize
495 This is not about cryptographic security
498 \begin_layout Itemize
499 The new constants don't improve security that much anyway.
502 \begin_layout Subsubsection
506 \begin_layout Standard
507 Floppies have <typecode> value 0 (single byte) and HDDs have 1 (single byte).
508 <geometry> is as follows (this is exactly the same form as it appears in
512 \begin_layout LyX-Code
513 Byte 0 bits 0-1: Bits 8-9 of track count per side - 1.
516 \begin_layout LyX-Code
517 Byte 0 bits 2-5: Head count - 1.
520 \begin_layout LyX-Code
521 Byte 0 bits 6-7: Reserved, must be 0.
524 \begin_layout LyX-Code
525 Byte 1: Bits 0-7 of track count per side - 1.
528 \begin_layout LyX-Code
529 Byte 2: Sector count per track - 1.
532 \begin_layout Subsubsection
533 CD-ROM and BIOS images
536 \begin_layout Standard
537 CD-ROMs have <typecode> value 2 (single byte) and BIOS images have 3 (single
542 \begin_layout Subsection
543 Advanced: Disk Image format
546 \begin_layout Standard
547 The disk image consists of following parts, concatenated in this order without
551 \begin_layout Itemize
555 \begin_layout Itemize
559 \begin_layout Itemize
563 \begin_layout Itemize
567 \begin_layout Itemize
571 \begin_layout Itemize
572 type-specific geometry/size data
575 \begin_layout Itemize
579 \begin_layout Itemize
583 \begin_layout Subsubsection
587 \begin_layout Standard
588 Magic in disk image files is following 5 bytes:
589 \begin_inset Quotes eld
593 \begin_inset Quotes erd
599 \begin_layout Subsubsection
603 \begin_layout Standard
604 Disk ID is given as 16 bytes, encoding the 128-bit disk ID.
607 \begin_layout Subsubsection
611 \begin_layout Standard
612 Type code is single byte.
613 0 for floppies, 1 for HDDs, 2 for CD-ROMs and 3 for BIOS images.
614 Other values are reserved.
617 \begin_layout Subsubsection
621 \begin_layout Standard
623 Disk name length is given as two-byte big-endian value.
624 New images should have 0 here.
627 \begin_layout Subsubsection
631 \begin_layout Standard
633 Name field is there for backward compatiblity.
634 Disk name length gives length of this field in bytes.
637 \begin_layout Subsubsection
638 Type-specific geometry/size data (floppies and HDDs)
641 \begin_layout Standard
642 Floppies and HDDs have 3-byte geometry data:
645 \begin_layout LyX-Code
646 Byte 0 bits 0-1: Bits 8-9 of track count per side - 1.
649 \begin_layout LyX-Code
650 Byte 0 bits 2-5: Head count - 1.
653 \begin_layout LyX-Code
654 Byte 0 bits 6-7: Reserved, must be 0.
657 \begin_layout LyX-Code
658 Byte 1: Bits 0-7 of track count per side - 1.
661 \begin_layout LyX-Code
662 Byte 2: Sector count per track - 1.
665 \begin_layout Subsubsection
666 Type specific-geometry/size data (CD-ROMs)
669 \begin_layout Standard
670 CD-ROMs have 4-byte big-endian sector (512 bytes!) count.
673 \begin_layout Subsubsection
674 Type specific-geometry/size data (BIOS images)
677 \begin_layout Standard
678 BIOS images have 4-byte big-endian byte (not sector or block) count.
681 \begin_layout Subsubsection
682 Actual image data (floppy/HDD)
685 \begin_layout Standard
686 Floppy or HDD imagedata consists of following subparts:
689 \begin_layout Itemize
693 \begin_layout Itemize
697 \begin_layout Itemize
701 \begin_layout Itemize
705 \begin_layout Standard
706 Storage method is single byte.
707 Sectors present gives number of last nonzero sector + 1 (zero if image
711 \begin_layout Subsubsection
712 Floppy/HDD storage method 0: Raw storage
715 \begin_layout Standard
716 This storage method has empty header.
717 Image data is raw dump of first sectors present sectors.
720 \begin_layout Subsubsection
721 Floppy/HDD storage method 1: Sectormap
724 \begin_layout Standard
725 Image data header contains bitfield with just enough bytes to have one bit
727 The order of bits is such that number of bit corresponding to each sector
728 in byte is sector number modulo 8 and byte number is floor of sector number
729 divided by 8 when sector numbers are counted from zero.
730 If bit corresponding to sector is set, then the sector is present in image
731 data, otherwise it is absent and assumed to be all-zeroes.
734 \begin_layout Standard
735 Image data contains dumps of all present sectors in order of increasing
739 \begin_layout Subsubsection
740 Floppy/HDD storage method 2: Extent first sector zero
743 \begin_layout Standard
744 Image data is empty as storage-specific data is mangled with image data.
745 The image data alternates between blocks encoding zero sectors and blocks
746 encoding nonzero sectors.
747 The first block encodes zero sectors.
751 \begin_layout Standard
752 Block encoding zero sectors consist of single 1-4 byte little-endian value
753 encoding number of sectors in block - 1.
754 Number of bytes is determined by sectors present value.
755 It is 1 for 1-256 sectors, 2 for 257-65536, 3 for 65537-16777216 and 4
756 for more than 16777216.
757 All sectors in block are filled with zeroes and are not stored.
760 \begin_layout Standard
761 Block encoding nonzero sectors has same block count as zero sector block
762 but is followed by the sectors stored raw.
765 \begin_layout Subsubsection
766 Floppy/HDD storage method 3: Extent first sector nonzero
769 \begin_layout Standard
770 Same as storage method 2 but first block is nonzero sector block.
773 \begin_layout Subsubsection
774 Actual image data (CD-ROMs and BIOS images)
777 \begin_layout Standard
778 These store image data raw.
779 The amount of data is specified by sector/byte count.
782 \begin_layout Subsubsection
786 \begin_layout Standard
787 Comments are given as list of strings, with UTF-8 encoded strings following
788 2-octet big-endian length.
789 Comment list is terminated by entry with length 0 (0x00 0x00).
790 Comments are optional and may be absent.
793 \begin_layout Section
797 \begin_layout Standard
798 The actual emulator is invoked as:
801 \begin_layout LyX-Code
802 $ java JPCApplication <options>...
805 \begin_layout Standard
806 The valid options are:
809 \begin_layout LyX-Code
810 -library <library> Use the specified directory when searching for images
811 (can only be specified once).
814 \begin_layout LyX-Code
815 -autoexec <script> Execute contents of specified file as commands when starting
819 \begin_layout LyX-Code
820 -norenames Copy&Delete files instead of renaming.
821 Mainly meant for debugging copy&delte code.
824 \begin_layout Subsection
828 \begin_layout Standard
829 When emulator is started, command line comes up.
830 Following commands are known:
833 \begin_layout Itemize
834 'exit': exit immediately
837 \begin_layout Itemize
838 'load <plugin>': Load plugin (no arguments)
841 \begin_layout Itemize
842 'load <plugin>(<arguments>)': load plugin with arguments.
845 \begin_layout Itemize
846 'command <command> [<arguments>...]': Invoke command via external command interface.
849 \begin_layout Itemize
850 'call<command> [<arguments>...]': Invoke command via external command interface
851 and print return values.
854 \begin_layout Standard
855 When one gets command line, its useful to load some plugins.
856 See section about plugins.
857 Note: Load runner plugin (PCControl/PCRunner and so) last, as some runners
858 like to start PC immediately.
861 \begin_layout Subsection
862 PC settings dialog notes
865 \begin_layout Itemize
866 CPU divider base frequency before division is 1GHz.
869 \begin_layout Itemize
870 Images can be specified by name or by ID.
871 Name is relative to library directory.
872 If the image is in subdirectory of image directory, the directory separator
873 is is '/' regardless of what the host OS uses.
876 \begin_layout Itemize
877 CD-ROM and hdc are mutually exclusive
880 \begin_layout Itemize
881 Modules is comma-seperated list of modules to load.
882 To pass arguments to some modules, enclose the arguments in ().
883 Same module can be specified twice only if parameters differ.
886 \begin_layout Itemize
887 Setting boot device doesn't work with some BIOS versions.
888 Those versions prompt the boot device anyway.
891 \begin_layout Subsection
892 Audio output channels
895 \begin_layout Standard
896 PC can have one or more audio output channels.
897 The name of audio output associated with PC speaker is: 'org.jpc.emulator.peripher
899 Modules that have audio outputs get channel names of form <classname>-<sequenti
900 al>, where <classname> is name of main module class and sequential is number
902 Note that same module can have multiple output channels.
903 If multiple modules of same class request audio outputs, the <sequential>
904 values of subsequent module start where previous left off.
907 \begin_layout Subsection
911 \begin_layout Standard
912 Plugins actually execute the tasks of the emulator.
913 They can be loaded using
914 \begin_inset Quotes eld
918 \begin_inset Quotes erd
921 or 'load <plugin>(<arguments>)
922 \begin_inset Quotes erd
928 \begin_layout Standard
929 Different Plugins using the same output (like running PCMonitor and RAWVideoDump
930 er) should not conflict because connector output hold locking is desinged
931 to handle multiple readers.
934 \begin_layout Standard
935 If no plugin used requires GUI, then the emulator can be run without having
939 \begin_layout Subsubsection
940 plugin: org.jpc.plugins.PCControl
943 \begin_layout Standard
944 Takes optionally 'extramenu=<file>' and 'uncompressedsave=1', requires and
948 \begin_layout Standard
949 Runs the PC emulator core.
950 Has capability to start/stop emulation, breakpoint after certain time or
951 start/end of VGA vertical retrace.
952 Also can create, savestate and loadstate PC emulation.
953 Memory dumping is supported.
957 \begin_layout Standard
958 'extramenu=<file>' causes Plugin to load extra menu entries from <file>.
959 'uncompressedsave=1' causes savestates to be written uncompressed (useful
960 if they are stored in VCS supporting delta compression).
963 \begin_layout Subsubsection
964 plugin: org.jpc.plugins.PCRunner
967 \begin_layout Standard
968 Takes 'movie=<file>' as argument and optionally 'stoptime=<time>' Does not
972 \begin_layout Standard
973 Loads PC from savestate and just runs it.
975 Also automatically quits once stoptime is reached.
978 \begin_layout Subsubsection
979 plugin: org.jpc.plugins.PCMonitor
982 \begin_layout Standard
983 No arguments, requires and uses GUI.
986 \begin_layout Standard
987 VGA monitor for emulated PC.
990 \begin_layout Subsubsection
991 plugin: org.jpc.plugins.VirtualKeyboard
994 \begin_layout Standard
995 No arguments, requires and uses GUI.
998 \begin_layout Standard
999 On-screen keyboard for emulated PC.
1002 \begin_layout Subsubsection
1003 plugin: org.jpc.plugins.PCStartStopTest
1006 \begin_layout Standard
1007 No arguments, requires and uses GUI.
1010 \begin_layout Standard
1011 Small plugin testing remote PC start/stop.
1012 Also supports sending some common keypresses.
1015 \begin_layout Subsubsection
1016 plugin: org.jpc.plugins.RAWVideoDumper
1019 \begin_layout Standard
1020 Takes 'rawoutput=<file>' as argument.
1021 Does not require nor use GUI.
1024 \begin_layout Standard
1025 Dumps all generated frames to RAW file <file>.
1026 Rawoutput is required.
1027 The raw file consists of concatenation of zlib streams.
1028 The uncompressed stream is concatenation of time skips (FFh FFh FFh FFh),
1029 each acting as time offset of 2^32-1 nanoseconds and saved frames.
1030 The saved frame has time offset in nanoseconds (big endian) as first four
1031 bytes (must be at most 2^32-2, as 2^32-1 is reserved for time skip).
1032 The next two bytes are big-endian width, next two big-endian height.
1033 Finally frame has 4 * width * height bytes of data that encodes pixels
1034 using 4 bytes per pixel, in left-to-right, up-to-down order.
1035 Byte 0 of each pixel is reserved, byte 1 is the red channel, byte 2 is
1036 green channel and byte 3 is blue channel.
1039 \begin_layout Standard
1040 Dumping to pipe is supported.
1043 \begin_layout Subsubsection
1044 plugin: org.jpc.plugins.RAWAudioDumper
1047 \begin_layout Standard
1048 Takes 'src=<name of audio output channel>', 'file=<output-filename>' and
1049 'offset=<offset>' as arguments, separated by ','.
1050 Does not require nor use GUI.
1053 \begin_layout Standard
1054 Dumps output from specified audio output channel (src, mandatory) to RAW-format
1055 file (file, mandatory).
1056 The resulting file consists of records, 4 or 8 bytes each.
1057 4 byte record consists of 0xFF 0xFF 0xFF 0xFF and means to increase next
1059 \begin_inset Formula $2^{32}-1$
1063 Otherwise record is 8 bytes.
1064 Each 8 byte record has three fields.
1065 First 4 byte unsinged big endian timedelta value (in nanoseconds, must
1067 \begin_inset Formula $2^{32}-1$
1070 ), then 2 byte signed big endian new left channel volume, then 2 byte signed
1071 big endian new right channel volume.
1072 Optionally 'offset' can be set to positive value (in nanoseconds) to delay
1076 \begin_layout Subsubsection
1077 plugin: org.jpc.plugins.LuaPlugin
1080 \begin_layout Standard
1081 Takes 'kernel=<name of lua kernel file>', other parameters are passed to
1082 kernel, requires and uses GUI.
1085 \begin_layout Standard
1086 Lua VM for executing scripts.
1089 \begin_layout Subsubsection
1090 plugin: org.jpc.plugins.JoystickInput
1093 \begin_layout Standard
1095 Displays window for sending joystick input.
1098 \begin_layout Section
1102 \begin_layout Subsection
1103 org.jpc.modules.Joystick:
1106 \begin_layout Itemize
1110 \begin_layout Itemize
1111 Resources: I/O port 0x201
1114 \begin_layout Standard
1115 Emulates joystick game port.
1118 \begin_layout Subsection
1119 org.jpc.modules.SoundCard
1122 \begin_layout Itemize
1123 Arguments: Optional resources specification
1126 \begin_layout Itemize
1127 Resources (defaults): I/O port 0x220-0x22F, IRQ 5, DMA 1, DMA 5
1130 \begin_layout Standard
1131 Emulates Sound card.
1134 \begin_layout Subsection
1135 org.jpc.modules.FMCard
1138 \begin_layout Itemize
1139 Arguments: Optional resources specification
1142 \begin_layout Itemize
1143 Resources (defaults): I/O port 0x338-0x33B
1146 \begin_layout Standard
1150 \begin_layout Subsection
1151 org.jpc.modules.BasicFPU:
1154 \begin_layout Itemize
1158 \begin_layout Itemize
1162 \begin_layout Standard
1163 Crude FPU (x87) emulator.
1166 \begin_layout Section
1170 \begin_layout Standard
1171 Hacks are saved to savestates but not movies.
1174 \begin_layout Subsection
1178 \begin_layout Standard
1179 Force bit 1 of physical address 0x0410 to zero, signaling that the system
1181 BIOS assumes system has FPU but some games use that bit to detect FPU,
1182 trying to use it if it is
1183 \begin_inset Quotes eld
1187 \begin_inset Quotes erd
1191 Try this if game startup hangs with lots of trying to use FPU but not present
1193 Don't use if there is FPU present.
1194 Needed to get games like Blake Stone / Wolfenstein 3-D to work (FPU emulator
1195 allows it to start but causes graphical glitches).
1198 \begin_layout Subsection
1202 \begin_layout Standard
1203 Update basic VGA parameters before vretrace, not after it.
1205 Commander Keen 4) don't like if this isn't done and some games (e.g.
1206 Mario & Luigi) don't like if it is done.
1207 Wrong value manifests as jerky scrolling (scrolling back and forth and
1208 fixed statusbars move).
1211 \begin_layout Section
1212 Some error messages and explanations
1215 \begin_layout Itemize
1216 <filename> is Not a valid image file
1219 \begin_layout Itemize
1220 <filename> is not image file
1223 \begin_layout Itemize
1224 <filename> claims to be floppy with illegal geometry: <x> tracks, <y> sides
1228 \begin_layout Itemize
1229 <filename> claims to be HDD with illegal geometry: <x> tracks, <y> sides
1233 \begin_layout Itemize
1234 Can't read disk image sector map.
1237 \begin_layout Itemize
1238 Can't read disk image extent.
1241 \begin_layout Standard
1242 Code expects <filename> to be valid JPC-RR format image, but it isn't JPC-RR
1243 image at all or its corrupt.
1246 \begin_layout Itemize
1247 <filename> is image of unknown type.
1250 \begin_layout Itemize
1251 <filename> has unrecognized geometry <x> <y> <z>
1254 \begin_layout Standard
1255 Possibly corrupt image, not JPC-RR image, or JPC-RR image from future version
1256 containing something current version can't comprehend.
1259 \begin_layout Itemize
1260 Invalid format specifier <something>.
1263 \begin_layout Itemize
1264 Invalid syntax of --floppy= or --HDD= option.
1267 \begin_layout Itemize
1268 Invalid format specifier/option <something>.
1271 \begin_layout Standard
1272 Invalid option or format specifier was given.
1276 \begin_layout Itemize
1277 java ImageMaker [<options>...] <format> <destination> <source> <diskname>
1280 \begin_layout Standard
1281 Check syntax of command.
1282 Especially that diskname is present!
1285 \begin_layout Itemize
1286 The image has <nnn> sectors while it should have <yyy> according to selected
1290 \begin_layout Itemize
1291 Raw image file length not divisible by 512.
1294 \begin_layout Itemize
1295 Trying to read sector out of range.
1298 \begin_layout Standard
1299 The selected geometry is wrong or raw image is incomplete.
1302 \begin_layout Itemize
1303 Invalid disk name (Should not happen!).
1306 \begin_layout Itemize
1307 Invalid geometry to be written.
1310 \begin_layout Standard
1311 This is a very likely a bug in program.
1314 \begin_layout Itemize
1315 What the heck <filename> is? It's not regular file nor directory.
1318 \begin_layout Standard
1319 That sort of file can't be used as input for image making, or the file just
1323 \begin_layout Itemize
1324 BIOS images can only be made out of regular files.
1327 \begin_layout Itemize
1328 CD images can only be made out of regular files.
1331 \begin_layout Standard
1332 Source image specified is not regular file, but image of that type can't
1333 be made of anything else.
1336 \begin_layout Itemize
1337 Can't read raw bios image file.
1340 \begin_layout Itemize
1341 Can't read sector <nnn> from image.
1344 \begin_layout Standard
1345 Reading the raw image file failed for some reason.
1348 \begin_layout Itemize
1349 Bad library line: "<something>".
1353 \begin_layout Standard
1354 Syntax error in image library.
1357 \begin_layout Itemize
1358 Removing image <something> a.k.a.
1359 "<something>" as it no longer exists.
1362 \begin_layout Standard
1363 The image file no longer exists so it gets removed from library.
1366 \begin_layout Itemize
1367 Removing image <something> a.k.a.
1368 "<something>" due to <some> conflict.
1371 \begin_layout Standard
1372 Image library code killed some image from library due to some kind of conflict
1373 with image being added.
1376 \begin_layout Itemize
1377 Too much data to fit into given space.
1380 \begin_layout Standard
1381 The tree you gave contains takes just too much space to fit into disk of
1385 \begin_layout Section
1386 Advanced: Savestate/movie format
1389 \begin_layout Subsection
1390 Special character classes
1393 \begin_layout Subsubsection
1397 \begin_layout Standard
1398 Following Unicode codepoints (encoded as UTF-8) are interpretted as space
1402 \begin_layout Itemize
1403 Codepoints 0x20, and 0x09.
1406 \begin_layout Itemize
1407 Codepoints 0x1680, 0x180E, 0x2028, 0x205F and 0x3000
1410 \begin_layout Itemize
1411 Codepoints 0x2000-0x200A.
1414 \begin_layout Subsubsection
1418 \begin_layout Standard
1419 Following byte sequences are interpretted as linefeeds (line change):
1422 \begin_layout Itemize
1423 Byte 0x0A (UTF-8 encoded codepoint 0x0A)
1426 \begin_layout Itemize
1427 Byte 0x0D (UTF-8 encoded codepoint 0x0D)
1430 \begin_layout Itemize
1431 Byte 0x1C (UTF-8 encoded codepoint 0x1C)
1434 \begin_layout Itemize
1435 Byte 0x1D (UTF-8 encoded codepoint 0x1D)
1438 \begin_layout Itemize
1439 Byte 0x1E (UTF-8 encoded codepoint 0x1E)
1442 \begin_layout Itemize
1443 Bytes 0xC2 0x85 (UTF-8 for unicode control character NL, codepoint 0x85)
1446 \begin_layout Itemize
1447 Bytes 0xE2 0x80 0xA9 (UTF-8 encoded codepoint 0x2029)
1450 \begin_layout Subsection
1454 \begin_layout Standard
1455 JRSR archive format packs multiple text archive members to text archive.
1456 It does not support binary members.
1457 JRSR archives have first five or six bytes form the magic.
1459 \begin_inset Quotes eld
1463 \begin_inset Quotes erd
1466 followed by LINEFEED character There are four kinds of lines after that
1467 (lines are terminated by LINEFEED byte/bytes):
1470 \begin_layout Itemize
1474 \begin_layout Itemize
1478 \begin_layout Itemize
1482 \begin_layout Itemize
1486 \begin_layout Standard
1487 Sequencing rules are as follows: Start member is allowed anywhere (after
1489 Member line is allowed only inside member (member started but not ended).
1490 End member is only allowed inside member.
1491 End of file is only allowed outside member.
1492 Blank line is allowed anywhere after magic.
1495 \begin_layout Subsubsection
1499 \begin_layout Standard
1500 Start member line is given as
1501 \begin_inset Quotes eld
1505 \begin_inset Quotes erd
1508 <SPACE>+ <membername> <LINEFEED>.
1509 <SPACE>+ any number of SPACE characters at least one and <LINEFEED> is
1511 The member name is UTF-8 encoded and maximum allowed line length is 2048
1512 bytes (including LINEFEED, which means name is limited to 509-2040 codepoints
1513 depending on characters used).
1514 Starting member inside another implicitly ends the previous member.
1517 \begin_layout Subsubsection
1521 \begin_layout Standard
1522 Member line is given as
1523 \begin_inset Quotes eld
1527 \begin_inset Quotes erd
1530 <content><LINEFEED>.
1531 It gives another line for member contents.
1532 <content> is passed raw to layers above (followed by line termination)
1535 \begin_layout Subsubsection
1539 \begin_layout Standard
1540 End member line is given as
1541 \begin_inset Quotes eld
1545 \begin_inset Quotes erd
1549 It ends the current member.
1550 The following line can only be start member line or file may end.
1553 \begin_layout Subsubsection
1557 \begin_layout Standard
1558 Blank line is given as <LINEFEED>.
1559 Lines like that are ignored.
1562 \begin_layout Subsection
1563 Four-to-Five encoding
1566 \begin_layout Standard
1567 Binary members are encoded into text by so-called four-to-five encoding.
1568 This encoding can encode single byte to two, two bytes to three, three
1569 bytes to four and four bytes to five.
1570 Four-to-five encoding has five kinds of blocks.
1571 All SPACE and LINEFEED characters are completely ignored, even in middle
1575 \begin_layout Subsubsection
1579 \begin_layout Standard
1580 End stream block is encoded as '!'.
1581 It ends the stream instantly.
1582 There is also implicit end of stream at end of input to decoding.
1585 \begin_layout Subsubsection
1586 Other four block types
1589 \begin_layout Standard
1590 Other four block types take the value to be encoded, read it as big-endian
1592 Then they write it as base-93 big-endian value.
1593 Then length specific constants are added to digits of that number to yield
1594 ASCII values for characters (those are stored in order):
1597 \begin_layout Standard
1598 \begin_inset Tabular
1599 <lyxtabular version="3" rows="5" columns="6">
1601 <column alignment="center" valignment="top" width="0">
1602 <column alignment="center" valignment="top" width="0">
1603 <column alignment="center" valignment="top" width="0">
1604 <column alignment="center" valignment="top" width="0">
1605 <column alignment="center" valignment="top" width="0">
1606 <column alignment="center" valignment="top" width="0">
1608 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1611 \begin_layout Plain Layout
1617 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1620 \begin_layout Plain Layout
1626 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1629 \begin_layout Plain Layout
1635 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1638 \begin_layout Plain Layout
1644 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1647 \begin_layout Plain Layout
1653 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1656 \begin_layout Plain Layout
1664 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1667 \begin_layout Plain Layout
1673 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1676 \begin_layout Plain Layout
1682 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1685 \begin_layout Plain Layout
1691 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1694 \begin_layout Plain Layout
1700 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1703 \begin_layout Plain Layout
1709 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1712 \begin_layout Plain Layout
1720 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1723 \begin_layout Plain Layout
1729 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1732 \begin_layout Plain Layout
1738 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1741 \begin_layout Plain Layout
1747 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1750 \begin_layout Plain Layout
1756 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1759 \begin_layout Plain Layout
1765 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1768 \begin_layout Plain Layout
1776 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1779 \begin_layout Plain Layout
1785 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1788 \begin_layout Plain Layout
1794 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1797 \begin_layout Plain Layout
1803 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1806 \begin_layout Plain Layout
1812 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
1815 \begin_layout Plain Layout
1821 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
1824 \begin_layout Plain Layout
1832 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1835 \begin_layout Plain Layout
1841 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1844 \begin_layout Plain Layout
1850 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1853 \begin_layout Plain Layout
1859 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1862 \begin_layout Plain Layout
1868 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
1871 \begin_layout Plain Layout
1877 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
1880 \begin_layout Plain Layout
1894 \begin_layout Standard
1895 Blocks which encode values greater than what is possible for value of that
1896 length are fatal errors.
1900 \begin_layout Subsection
1901 Line component encoing
1904 \begin_layout Standard
1905 Line component encoding sits on top of UTF-8 encoding.
1906 Line component encoding encodes non-empty 1-D array of non-empty strings
1907 into line, and thus array of those into member.
1908 Empty lines or lines that don't contain any components are ignored.
1909 Line starts with depth value of 0 and must end with depth value of zero.
1912 \begin_layout Standard
1913 Components are seperated by component separators.
1914 Empty components are ignored.
1915 Following codepoints are separators on depth 0 if not escaped:
1918 \begin_layout Itemize
1920 The depth is read pre-increment.
1923 \begin_layout Itemize
1925 The depth is read post-decrement.
1928 \begin_layout Itemize
1932 \begin_layout Standard
1933 The following characters are special:
1936 \begin_layout Itemize
1938 Increments depth by 1 if not escaped (and appears in component).
1941 \begin_layout Itemize
1943 Decrements depth by 1 if not escaped (and appears in component).
1944 Depth going negative is an error.
1947 \begin_layout Itemize
1951 Next character is interpretted as literal.
1952 Error if at end of line.
1955 \begin_layout Standard
1956 Otherwise, characters are interpretted as literals and appear in components.
1957 Depth must be zero at end of line.
1960 \begin_layout Subsection
1964 \begin_layout Standard
1965 Header section is in archive member "header".
1966 It uses line component encoding.
1967 The first component of each line is name of header, and subsequent ones
1969 How many parameters are expected is dependent on what header it is:
1972 \begin_layout Subsubsection
1976 \begin_layout Itemize
1977 Header name: "PROJECTID"
1980 \begin_layout Itemize
1984 \begin_layout Itemize
1985 Argument #1: <project-id-string>
1988 \begin_layout Itemize
1992 \begin_layout Standard
1994 Project ID is generated when PC is assembled and is then preserved in save
1996 It is used for computing rerecord counts.
1997 Emulator treats it as opaque string, the IDs it generates are formed by
1998 48 random hexadecimal digits.
2001 \begin_layout Subsubsection
2005 \begin_layout Itemize
2006 Header name: "SAVESTATEID"
2009 \begin_layout Itemize
2013 \begin_layout Itemize
2014 Argument #1: <savestate-id-string>
2017 \begin_layout Itemize
2021 \begin_layout Standard
2022 Gives save state ID.
2023 Each save state has its own save state ID.
2024 Treated as opaque string, but generated as 48 random hexadecimal digits.
2025 The presence of this header signals whether there is save state to be loaded.
2026 If this header is present, save state load will be attempted.
2027 If absent, save state is not to be loaded even if present (and correct
2028 savestate load would be technically impossible anyway).
2031 \begin_layout Standard
2032 The value is used to prevent loading incompatible save states in preserve
2033 event stream mode and also to find the point in event stream where one
2037 \begin_layout Subsubsection
2041 \begin_layout Itemize
2042 Header name: "RERECORDS"
2045 \begin_layout Itemize
2049 \begin_layout Itemize
2050 Argument #1: <rerecords>
2053 \begin_layout Itemize
2057 \begin_layout Standard
2058 Gives rerecord count.
2059 PC assembly (except when loading save state) initializes current rerecord
2061 Must be non-negative and decimal number using ASCII digit characters.
2064 \begin_layout LyX-Code
2065 On loading save state:
2068 \begin_layout LyX-Code
2069 1) If project ID matches with previous:
2072 \begin_layout LyX-Code
2073 1a) If loaded rerecord count is larger or equal to current rerecord count:
2076 \begin_layout LyX-Code
2077 1a-a) Current rerecord count is loaded rerecord count + 1.
2080 \begin_layout LyX-Code
2084 \begin_layout LyX-Code
2085 1b-a) Current rerecord count increments by 1.
2088 \begin_layout LyX-Code
2092 \begin_layout LyX-Code
2093 2a) Current rerecord count is loaded rerecord count + 1.
2096 \begin_layout Standard
2097 The current rerecord count at time of save is saved to save state.
2100 \begin_layout Subsubsection
2104 \begin_layout Itemize
2105 Header name: "AUTHORS"
2108 \begin_layout Itemize
2109 Components: 2 or more
2112 \begin_layout Itemize
2113 Arguments: free form
2116 \begin_layout Itemize
2120 \begin_layout Standard
2121 Gives authors of run.
2122 Each argument gives one author.
2123 May be present multiple times.
2126 \begin_layout Subsubsection
2130 \begin_layout Itemize
2131 Header name: "COMMENT"
2134 \begin_layout Itemize
2135 Components: 2 or more
2138 \begin_layout Itemize
2139 Arguments: free form
2142 \begin_layout Itemize
2146 \begin_layout Standard
2147 Various kinds of free form data.
2148 Not parsed further by emulator.
2151 \begin_layout Subsection
2152 Initialization segment:
2155 \begin_layout Standard
2156 If SAVESTATEID header isn't present (not a save state), member "initialization"
2157 gives PC initialization parameters for assembling the PC.
2158 It is present anyway even if SAVESTATEID is present (savestate).
2161 \begin_layout Standard
2162 Following parameters are used (space separates components):
2165 \begin_layout LyX-Code
2169 \begin_layout Standard
2170 Gives Image ID of main system BIOS (mandatory)
2173 \begin_layout LyX-Code
2177 \begin_layout Standard
2178 Gives Image ID of VGA BIOS (mandatory).
2181 \begin_layout LyX-Code
2185 \begin_layout Standard
2186 Gives Image ID of hda.
2187 Present only if system has hard disk hda.
2190 \begin_layout LyX-Code
2194 \begin_layout Standard
2195 Gives Image ID of hdb.
2196 Present only if system has hard disk hdb.
2199 \begin_layout LyX-Code
2203 \begin_layout Standard
2204 Gives Image ID of hdc.
2205 Present only if system has hard disk hdc.
2208 \begin_layout LyX-Code
2212 \begin_layout Standard
2213 Gives Image ID of hdd.
2214 Present only if system has hard disk hdd.
2217 \begin_layout LyX-Code
2221 \begin_layout Standard
2222 Gives Image ID of disk in slot <num>.
2223 Slot number must be non-negative.
2226 \begin_layout LyX-Code
2227 \begin_inset Quotes eld
2231 \begin_inset Quotes erd
2237 \begin_layout Standard
2238 kGives image name of disk in slot <num>.
2239 Slot number must be non-negative.
2240 The slot must be previously declared using
2241 \begin_inset Quotes eld
2245 \begin_inset Quotes erd
2251 \begin_layout LyX-Code
2255 \begin_layout Standard
2256 Gives Image slot to initially put into floppy drive fda.
2257 Disk must be of floppy type.
2258 If none present, no disk is initially put there.
2261 \begin_layout LyX-Code
2265 \begin_layout Standard
2266 Gives Image slot to initially put into floppy drive fdb.
2267 Disk must be of floppy type.
2268 If none present, no disk is initially put there.
2271 \begin_layout LyX-Code
2275 \begin_layout Standard
2276 Gives Image slot to initially put into CD-ROM drive hdc.
2277 Not allowed if hard disk hdc is present.
2278 Disk must be of CD-ROM type.
2279 If none present no disk is initially put there.
2282 \begin_layout LyX-Code
2283 "INITIALTIME" <time>
2286 \begin_layout Standard
2287 Number of milliseconds since Unix epoch to system start up time.
2291 \begin_layout Standard
2296 \begin_layout LyX-Code
2297 "CPUDIVIDER" <divider>
2300 \begin_layout Standard
2301 Set CPU frequency divider (dividing the 1GHz master clock).
2302 Allowed range is 1-256.
2306 \begin_layout LyX-Code
2307 "MEMORYSIZE" <pages>
2310 \begin_layout Standard
2311 Number of 4KiB pages of RAM memory.
2312 Allowed range 256-262144.
2316 \begin_layout LyX-Code
2320 \begin_layout Standard
2322 Valid devices are "FLOPPY" (boot from fda), "HDD" (boot from hda) and "CDROM"
2326 \begin_layout LyX-Code
2327 "LOADMODULEA" <module> <parameters>
2330 \begin_layout Standard
2331 Load module <module> with parameters <parameters>.
2334 \begin_layout LyX-Code
2335 "LOADMODULE" <module>
2338 \begin_layout Standard
2339 Load module <module> with no parameters
2342 \begin_layout LyX-Code
2343 \begin_inset Quotes eld
2347 \begin_inset Quotes erd
2353 \begin_layout Standard
2354 Use class <fpu> as FPU emulator.
2357 \begin_layout LyX-Code
2358 \begin_inset Quotes eld
2362 \begin_inset Quotes erd
2368 \begin_layout Standard
2369 Use I/O port delay emulation (each I/O port read/write takes 666ns).
2372 \begin_layout LyX-Code
2373 \begin_inset Quotes eld
2377 \begin_inset Quotes erd
2383 \begin_layout Standard
2384 Emulate VGA horizontal retrace.
2387 \begin_layout Subsection
2388 Event record format:
2391 \begin_layout Standard
2392 Event record is in archive member "events".
2393 It uses line component encoding.
2394 Each line gives an event.
2395 First component of each line gives time stamp.
2396 These timestamps MUST be in increasing order and all MUST be non-negative.
2397 Time stamp time unit is exactly 1 nanosecond of emulated time.
2400 \begin_layout Standard
2401 The second component of each line is name of class to dispatch to.
2402 Further components are passed as-is to event handlers.
2403 Classes with names consisting only of uppercase A-Z and 0-9 are special
2405 It is error to encounter unknown such special class.
2408 \begin_layout Subsubsection
2412 \begin_layout Itemize
2413 Dispatch to: SAVESTATE
2416 \begin_layout Itemize
2417 Argument #1: Savestate id
2420 \begin_layout Itemize
2421 Argument #2 (optional): Rerecord count at time of saving savestate
2424 \begin_layout Standard
2425 Signals that savestate has occured here.
2426 The save state IDs MUST be unique in entire event stream.
2427 The second argument to savestate (if present) is rerecord count at time
2428 of saving that savestate (useful for calulating rerecord count of movie
2429 starting from savestate).
2430 No time restrictions
2433 \begin_layout Subsubsection
2437 \begin_layout Itemize
2441 \begin_layout Itemize
2443 \begin_inset Quotes eld
2447 \begin_inset Quotes erd
2451 \begin_inset Quotes eld
2455 \begin_inset Quotes erd
2461 \begin_layout Standard
2462 Controls various options.
2464 \begin_inset Quotes eld
2468 \begin_inset Quotes erd
2471 turns on absolute mode (default) where event timestamps are absolute.
2473 \begin_inset Quotes eld
2477 \begin_inset Quotes erd
2480 turns on relative mode where event timestamps are relative to last event
2482 The OPTION event itself is not affected by timing change.
2483 No time restrictions.
2484 Unknown arguments are errors.
2487 \begin_layout Subsubsection
2488 Keyboard keypress/keyrelease event:
2491 \begin_layout Itemize
2492 Dispatch to: org.jpc.emulator.peripheral.Keyboard
2495 \begin_layout Itemize
2496 Argument #1: Fixed: "KEYEDGE"
2499 \begin_layout Itemize
2500 Argument #2: Key number.
2501 Valid values are 1-83, 85-95, 129-197 and 199-223
2504 \begin_layout Standard
2505 Send key press or key release.
2506 Keys work in toggle button manner.
2507 The event time must be multiple of 66 666, and must not be less than 60
2508 * 66 666 TUs after last PAUSE event, 20 * 66 666 TUs after last KEYEDGE
2509 on key >128 and 10 * 66 666 TUs after last KEYEDGE on key <128.
2512 \begin_layout Subsubsection
2516 \begin_layout Itemize
2517 Dispatch to: org.jpc.emulator.peripheral.Keyboard
2520 \begin_layout Itemize
2521 Argument #1: Fixed: "PAUSE"
2524 \begin_layout Standard
2525 Send pause key event.
2526 The time restrictions are identical to KEYEDGE event.
2529 \begin_layout Subsubsection
2533 \begin_layout Itemize
2534 Dispatch to: org.jpc.emulator.peripheral.Keyboard
2537 \begin_layout Itemize
2538 Argument #1: Fixed: "MOUSEBUTTON"
2541 \begin_layout Itemize
2542 Argument #2: Number of button to release or press (0-4)
2545 \begin_layout Standard
2546 Presses or releases the designated mouse button.
2549 \begin_layout Subsubsection
2550 X mouse motion event:
2553 \begin_layout Itemize
2554 Dispatch to: org.jpc.emulator.peripheral.Keyboard
2557 \begin_layout Itemize
2558 Argument #1: Fixed: "XMOUSEMOTION"
2561 \begin_layout Itemize
2562 Argument #2: Number of units to move (-255 - 255)
2565 \begin_layout Standard
2566 Move the mouse in X direction by specified amount.
2570 \begin_layout Subsubsection
2571 Y mouse motion event:
2574 \begin_layout Itemize
2575 Dispatch to: org.jpc.emulator.peripheral.Keyboard
2578 \begin_layout Itemize
2579 Argument #1: Fixed: "YMOUSEMOTION"
2582 \begin_layout Itemize
2583 Argument #2: Number of units to move (-255 - 255)
2586 \begin_layout Standard
2587 Move the mouse in Y direction by specified amount.
2591 \begin_layout Subsubsection
2592 Z mouse motion event:
2595 \begin_layout Itemize
2596 Dispatch to: org.jpc.emulator.peripheral.Keyboard
2599 \begin_layout Itemize
2600 Argument #1: Fixed: "ZMOUSEMOTION"
2603 \begin_layout Itemize
2604 Argument #2: Number of units to move (-7 - 7)
2607 \begin_layout Standard
2608 Move the mouse in Z direction (scrollwheel) by specified amount.
2611 \begin_layout Subsubsection
2612 Joystick button event:
2615 \begin_layout Itemize
2616 Dispatch to: org.jpc.modules.Joystick
2619 \begin_layout Itemize
2621 \begin_inset Quotes eld
2625 \begin_inset Quotes erd
2629 \begin_inset Quotes eld
2633 \begin_inset Quotes erd
2637 \begin_inset Quotes eld
2641 \begin_inset Quotes erd
2645 \begin_inset Quotes eld
2649 \begin_inset Quotes erd
2655 \begin_layout Itemize
2657 \begin_inset Quotes eld
2661 \begin_inset Quotes erd
2665 \begin_inset Quotes eld
2669 \begin_inset Quotes erd
2675 \begin_layout Standard
2676 Send button down/up event.
2677 No time restrictions.
2680 \begin_layout Subsubsection
2681 Joystick axis event:
2684 \begin_layout Itemize
2685 Dispatch to: org.jpc.modules.Joystick
2688 \begin_layout Itemize
2690 \begin_inset Quotes eld
2694 \begin_inset Quotes erd
2698 \begin_inset Quotes eld
2702 \begin_inset Quotes erd
2706 \begin_inset Quotes eld
2710 \begin_inset Quotes erd
2714 \begin_inset Quotes eld
2718 \begin_inset Quotes erd
2724 \begin_layout Itemize
2725 Argument #2: Multivibrator unstable state length in ns.
2728 \begin_layout Standard
2729 Set amount of time multivibrator remains in unstable state.
2730 No time restrictions.
2733 \begin_layout Subsubsection
2737 \begin_layout Itemize
2738 Dispatch to: org.jpc.emulator.PC$ResetButton
2741 \begin_layout Itemize
2745 \begin_layout Standard
2749 \begin_layout Subsubsection
2753 \begin_layout Itemize
2754 Dispatch to: org.jpc.emulator.PC$DiskChanger
2757 \begin_layout Itemize
2758 Argument #1: Fixed: "FDA"
2761 \begin_layout Itemize
2762 Argument #2: Number of image slot to put there.
2766 \begin_layout Standard
2767 The disk number MUST be -1 or valid disk number.
2768 -1 MUST NOT be used if there is no disk in floppy drive A.
2769 This event causes specified disk to be placed to FDA or FDA disk to be
2770 ejected with no replacement if disk number is -1.
2771 The specified disk if not -1 must be of floppy type.
2772 The specified disk if valid must not be in any other drive.
2775 \begin_layout Subsubsection
2779 \begin_layout Itemize
2780 Dispatch to: org.jpc.emulator.PC$DiskChanger
2783 \begin_layout Itemize
2784 Argument #1: Fixed: "FDB"
2787 \begin_layout Itemize
2788 Argument #2: Number of image slot to put there.
2792 \begin_layout Standard
2793 The disk number MUST be -1 or valid disk number.
2794 -1 MUST NOT be used if there is no disk in floppy drive B.
2795 This event causes specified disk to be placed to FDB or FDB disk to be
2796 ejected with no replacement if disk number is -1.
2797 The specified disk if not -1 must be of floppy type.
2798 The specified disk if valid must not be in any other drive.
2801 \begin_layout Subsubsection
2805 \begin_layout Itemize
2806 Dispatch to: org.jpc.emulator.PC$DiskChanger
2809 \begin_layout Itemize
2810 Argument #1: Fixed: "CDROM"
2813 \begin_layout Itemize
2814 Argument #2: Number of image slot to put there.
2818 \begin_layout Standard
2819 The disk number MUST be -1 or valid disk number.
2820 -1 MUST NOT be used if there is no disk in CD-ROM.
2821 This event causes specified disk to be placed to CD-ROM or CD-ROM disk
2822 to be ejected with no replacement if disk number is -1.
2823 The specified disk if not -1 must be of CD-ROM type.
2826 \begin_layout Standard
2827 This event has no effect if CD-ROM is locked.
2830 \begin_layout Subsubsection
2831 Write protect floppy:
2834 \begin_layout Itemize
2835 Dispatch to: org.jpc.emulator.PC$DiskChanger
2838 \begin_layout Itemize
2839 Argument #1: Fixed: "WRITEPROTECT"
2842 \begin_layout Itemize
2843 Argument #2: Number of image slot to manipulate
2846 \begin_layout Standard
2847 Write protects specified disk.
2848 The disk MUST NOT be in any drive and MUST be valid floppy-type disk.
2851 \begin_layout Subsubsection
2852 Write unprotect floppy:
2855 \begin_layout Itemize
2856 Dispatch to: org.jpc.emulator.PC$DiskChanger
2859 \begin_layout Itemize
2860 Argument #1: Fixed: "WRITEUNPROTECT"
2863 \begin_layout Itemize
2864 Argument #2: Number of image slot to manipulate
2867 \begin_layout Standard
2868 Disables write protection specified disk.
2869 The disk MUST NOT be in any drive and MUST be valid floppy-type disk.
2872 \begin_layout Subsection
2876 \begin_layout Standard
2877 Diskinfo sections are named
2878 \begin_inset Quotes eld
2882 \begin_inset Quotes erd
2886 They use line component encoding, fieldtype being first component on each
2887 line (value being the second).
2888 Following fields are defined:
2891 \begin_layout Subsubsection
2895 \begin_layout Standard
2896 Gives type of image.
2900 \begin_layout Itemize
2901 \begin_inset Quotes eld
2905 \begin_inset Quotes erd
2911 \begin_layout Itemize
2912 \begin_inset Quotes eld
2916 \begin_inset Quotes erd
2922 \begin_layout Itemize
2923 \begin_inset Quotes eld
2927 \begin_inset Quotes erd
2933 \begin_layout Itemize
2934 \begin_inset Quotes eld
2938 \begin_inset Quotes erd
2941 (BIOS/VGABIOS image)
2944 \begin_layout Itemize
2945 \begin_inset Quotes eld
2949 \begin_inset Quotes erd
2952 (what the heck is this???)
2955 \begin_layout Subsubsection
2959 \begin_layout Standard
2963 \begin_layout Subsubsection
2967 \begin_layout Standard
2968 (BIOS images only) Gives length of BIOS image
2971 \begin_layout Subsubsection
2975 \begin_layout Standard
2976 MD5 of raw disk/BIOS image without any headers or trailers.
2979 \begin_layout Subsubsection
2983 \begin_layout Standard
2984 (FLOPPY/HDD/CDROM images only) Number of total sectors on disk.
2987 \begin_layout Subsubsection
2991 \begin_layout Standard
2992 (FLOPPY/HDD images only) Number of tracks on disk per side (1-256 for floppy,
2996 \begin_layout Subsubsection
3000 \begin_layout Standard
3001 (FLOPPY/HDD images only) Number of sides on disk (1 or 2 for floppy, 1-16
3005 \begin_layout Subsubsection
3009 \begin_layout Standard
3010 (FLOPPY/HDD images only) Number of sectors per track (1-255 for floppy,
3014 \begin_layout Subsubsection
3018 \begin_layout Standard
3019 Line from image comment block.
3020 Usually give data about files image has.
3021 May or may not be present (multiple times)
3024 \begin_layout Subsection
3028 \begin_layout Standard
3029 Output info is stored in section
3030 \begin_inset Quotes eld
3034 \begin_inset Quotes erd
3038 Its relatively new, so it might not be present (then the contents have
3039 to be guessed based on modules present).
3040 Each line gives information about one output, first field being the type
3044 \begin_layout Subsubsection
3048 \begin_layout Standard
3049 For video output, there are no parameters so line is just
3050 \begin_inset Quotes eld
3054 \begin_inset Quotes erd
3060 \begin_layout Subsubsection
3064 \begin_layout Standard
3065 For audio output, the only parameter is name of output, so first component
3067 \begin_inset Quotes eld
3071 \begin_inset Quotes erd
3074 and second component is name of audio output.
3077 \begin_layout Subsection
3081 \begin_layout Standard
3082 Actual savestate format is not documented here.
3083 It is close to impossible to comprehend without access to emulator source
3087 \begin_layout Section
3088 Advanced: Making class dumpable
3091 \begin_layout Standard
3092 Class is made dumpable by implementing interface org.jpc.emulator.SRDumpable
3093 and implementing method dumpSRPartial(org.jpc.emulator.SRDumper) and constructor
3094 <init>(org.jpc.emulator.SRLoader).
3095 Non-static inner classes can not be dumpable (make them static using tricks
3096 similar to what javac uses).
3099 \begin_layout Standard
3100 If dumped class has dumpable superclass, the first thing dumping function
3101 needs to do is to call dumper function of superclass and first thing loading
3102 constructor needs to do is to call loading constructor of superclass.
3103 If class has no dumpable superclass, dumper doesn't need to do anything
3104 special, while loader needs to call objectCreated(this) on SRLoader object
3105 passed as parameter.
3109 \begin_layout Standard
3110 Following these fixed parts, dump all members that are part of mutable state
3114 \begin_layout Subsection
3115 Member dumping/loading functions
3118 \begin_layout Standard
3119 There is dumping/loading function for following (all functions dumping/loading
3120 reference types can handle null):
3123 \begin_layout Itemize
3124 boolean: SRDumper.dumpBoolean, SRLoader.loadBoolean
3127 \begin_layout Itemize
3128 byte: SRDumper.dumpByte, SRLoader.loadByte
3131 \begin_layout Itemize
3132 short: SRDumper.dumpShort, SRLoader.loadShort
3135 \begin_layout Itemize
3136 int: SRDumper.dumpInt, SRLoader.loadInt
3139 \begin_layout Itemize
3140 long: SRDumper.dumpLong, SRLoader.loadLong
3143 \begin_layout Itemize
3144 String: SRDumper.dumpString, SRLoader.loadString
3147 \begin_layout Itemize
3148 boolean[]: SRDumper.dumpArray, SRLoader.loadArrayBoolean
3151 \begin_layout Itemize
3152 byte[]: SRDumper.dumpArray, SRLoader.loadArrayByte
3155 \begin_layout Itemize
3156 short[]: SRDumper.dumpArray, SRLoader.loadArrayShort
3159 \begin_layout Itemize
3160 int[]: SRDumper.dumpArray, SRLoader.loadArrayInt
3163 \begin_layout Itemize
3164 long[]: SRDumper.dumpArray, SRLoader.loadArrayLong
3167 \begin_layout Itemize
3168 double[]: SRDumper.dumpArray, SRLoader.loadArrayDouble
3171 \begin_layout Itemize
3172 <dumpable type>: SRDumper.dumpObject, SRLoader.loadObject
3175 \begin_layout Itemize
3176 special object: SRDumper.specialObject, SRLoader.specialObject
3179 \begin_layout Subsubsection
3183 \begin_layout Itemize
3184 Dumpable objects come out as type of org.jpc.emulator.SRDumpable.
3187 \begin_layout Itemize
3188 Special objects are various static objects that don't need to be stored
3189 because they don't have mutable fields.
3192 \begin_layout Itemize
3193 Don't dump fields related to event state feedback.
3196 \begin_layout Itemize
3197 Don't dump temporary flags that are only used while PC is running.
3198 Savestate when PC is running isn't possible anyway.
3201 \begin_layout Itemize
3202 Some connectors dump fields related to connector output, some don't.
3205 \begin_layout Section
3206 Advanced: Making output connectors
3209 \begin_layout Standard
3210 Implementing interface org.jpc.emulator.DisplayController signals that this
3211 is display controller, inhibiting loading of the standard VGA display controlle
3212 r if loaded as module.
3216 \begin_layout Subsection
3217 Interface org.jpc.emulator.OutputConnector
3220 \begin_layout Standard
3221 Class is made to be output connector by implementing this interface.
3222 This interface specifies the methods used for output hold locking.
3223 Class org.jpc.emulator.OutputConnectorLocking has implementations of these
3224 that are suitable for calling.
3228 \begin_layout Subsubsection
3229 Method subscribeOutput(Object)
3232 \begin_layout Standard
3233 Subscribes the output, with specified object as handle.
3236 \begin_layout Subsubsection
3237 Method unsubscribeOutput(Object)
3240 \begin_layout Standard
3241 Unsubscribe the specified handle object from output.
3244 \begin_layout Subsubsection
3245 Method waitOutput(Object)
3248 \begin_layout Standard
3249 Wait for output on specified connector using specified handle object.
3250 Returns true on success, false if wait was interrupted by thread interrupt.
3254 \begin_layout Subsubsection
3255 Method releaseOutput(Object)
3258 \begin_layout Standard
3259 Release connector from p.o.v.
3264 \begin_layout Subsubsection
3268 \begin_layout Standard
3269 Release threads waiting on waitOutput() and block until all subscribers
3270 have returned from waitOutput() and enteired releaseOutput().
3273 \begin_layout Subsubsection
3274 Method releaseOutputWaitAll(object)
3277 \begin_layout Standard
3278 Like releaseOutput(), but waits until all handles have released their output.
3281 \begin_layout Subsection
3282 Class org.jpc.emulator.VGADigtalOut
3285 \begin_layout Standard
3286 Class org.jpc.emulator.VGADigtalOut (already implements OutputConnector) implements
3287 VGA output connector.
3288 If module provodes output connector, it needs to implement org.jpc.emulator.Displa
3292 \begin_layout Subsubsection
3296 \begin_layout Standard
3297 Get width of display (watch out, can return 0).
3300 \begin_layout Subsubsection
3304 \begin_layout Standard
3305 Get height of display (watch out, can return 0).
3308 \begin_layout Subsubsection
3309 Methods getDirtyXMin(), getDirtyXMax(), getDirtyYMin(), getDirtyYMax()
3312 \begin_layout Standard
3313 Returns the dirty region (region modified since last output).
3316 \begin_layout Subsubsection
3320 \begin_layout Standard
3321 Get buffer of ints, at least width * height elements (left-to-right, top-down,
3322 one value per pixel) giving pixel data.
3323 Value for each pixel is 65536 * <red-component> + 256 * <green-component>
3327 \begin_layout Subsubsection
3328 Method resizeDisplay(int _width, int _height)
3331 \begin_layout Standard
3332 Resize the display to be of specified size.
3335 \begin_layout Subsubsection
3336 Method dirtyDisplayRegion(int x, int y, int w, int h)
3339 \begin_layout Standard
3340 Mark the specified region as dirty.
3343 \begin_layout Subsubsection
3344 Method resetDirtyRegion()
3347 \begin_layout Standard
3348 Resets the dirty region to be empty.
3351 \begin_layout Subsection
3352 Class org.jpc.emulator.PC method getVideoOutput()
3355 \begin_layout Standard
3356 Get VGA output connector for PC.
3359 \begin_layout Subsection
3360 Interface org.jpc.emulator.DisplayController.
3363 \begin_layout Standard
3364 Implementing this class signals that module is VGA controller.
3365 There can be only one such module active at time and presence of such module
3366 prevents loading builtin VGA controller emulation code.
3369 \begin_layout Subsubsection
3370 Method getOutputDevice()
3373 \begin_layout Standard
3374 Get VGA output connector for this VGA device.
3377 \begin_layout Subsection
3378 Class org.jpc.emulator.SoundDigitalOut
3381 \begin_layout Standard
3382 Class org.jpc.emulator.SoundDigitalOut provodes output connector for sound.
3383 Each connector can transfer stereo signal at arbitiary sampling rate.
3384 Modules that have audio connectors need to implement interface org.jpc.emulator.So
3385 undOutputDevice, as this signals that output connectors should be created.
3388 \begin_layout Subsubsection
3389 Method addSample(long, short, short)
3392 \begin_layout Standard
3393 Add stereo sample at time given by first argument.
3394 The second and third arguments give volume on left and right channels.
3397 \begin_layout Subsubsection
3398 Method addSample(long, short)
3401 \begin_layout Standard
3402 Add mono sample at time given by first argument.
3403 The second argument give volume on both channels.
3406 \begin_layout Subsubsection
3407 Method readBlock(Block)
3410 \begin_layout Standard
3411 Reads block of output (atomic versus addSample).
3412 Block structure has following fields which are filled:
3415 \begin_layout Itemize
3416 timeBase: Time base for block.
3419 \begin_layout Itemize
3420 baseLeft: Left volume at time base.
3423 \begin_layout Itemize
3424 baseRight: Right volume at time base
3427 \begin_layout Itemize
3428 blockNo: Sequence number of block filled.
3431 \begin_layout Itemize
3432 samples: Number of samples in block
3435 \begin_layout Itemize
3436 sampleTiming: Number of nanoseconds since last sample
3439 \begin_layout Itemize
3440 sampleLeft: Left channel samples
3443 \begin_layout Itemize
3444 sampleRight: Right channel samples
3447 \begin_layout Subsection
3448 Interface org.jpc.emulator.SoundOutputDevice
3451 \begin_layout Standard
3452 Implementing this interface signals that module has audio output channels.
3455 \begin_layout Subsubsection
3456 Method org.jpc.emulator.SoundOutputDevice.requestedSoundChannels()
3459 \begin_layout Standard
3460 Return the number of sound channels module has.
3463 \begin_layout Subsubsection
3464 Method org.jpc.emulator.SoundOutputDevice.soundChannelCallback(SoundDigitalOut)
3467 \begin_layout Standard
3468 This is called once per sound channel requested giving precreated sound
3472 \begin_layout Subsection
3473 Class org.jpc.emulator.PC method getSoundOut(String)
3476 \begin_layout Standard
3477 Get sound output with specified name.
3480 \begin_layout Section
3481 Advanced: Writing event targets
3484 \begin_layout Standard
3485 Whereas output connectors are the way output is dispatched, input is dispatched
3487 Event targets need to implement interface org.jpc.emulator.EventDispatchTarget.
3490 \begin_layout Standard
3491 Event targets also provode methods which then encode events and dispatch
3492 them forward (without doing anything else) to event recorder.
3493 Also, event targets may have methods for obtaining state.
3496 \begin_layout Subsection
3497 Interface org.jpc.emulator.EventDispatchTarget
3500 \begin_layout Standard
3501 Interface that marks class capable of receiving events.
3504 \begin_layout Subsubsection
3505 Method setEventRecorder(EventRecorder)
3508 \begin_layout Standard
3509 Set the event recorder input events are sent to.
3512 \begin_layout Subsubsection
3513 Method startEventCheck()
3516 \begin_layout Standard
3517 Signals target to reset all state related to event checking and state feedback.
3518 This may be called at any time in order to reinitialialize event checking/feedb
3522 \begin_layout Subsubsection
3523 Method doEvent(long, String[], int) throws IOException
3526 \begin_layout Standard
3527 Event dispatch handler.
3528 The first argument is event time, second is parameters and third is what
3530 If target doesn't like the event, throw IOException.
3531 Following types (the integer parameter) are used:
3534 \begin_layout LyX-Code
3535 0 (EventRecorder.EVENT_TIMED): Time has been assigned for event.
3538 \begin_layout LyX-Code
3539 1 (EventRecorder.EVENT_STATE_EFFECT_FUTURE): Future event in event replay
3540 for reinitialization
3543 \begin_layout LyX-Code
3544 2 (EventRecorder.EVENT_STATE_EFFECT): Past event in event replay reinitialization
3547 \begin_layout LyX-Code
3548 3 (EventRecorder.EVENT_EXECUTE): This event occurs now.
3552 \begin_layout Subsubsection
3553 Method endEventCheock()
3556 \begin_layout Standard
3557 End event reinitialization.
3561 \begin_layout Subsubsection
3562 Method getEventTimeLowBound(long, String[]) throws IOException
3565 \begin_layout Standard
3566 Return the time value that's the earliest possiblity for this event to occur.
3567 Returning any time in past (including -1) causes event to fire as soon
3569 The long parameter gives the current scheduled time for event.
3572 \begin_layout Section
3576 \begin_layout Standard
3577 Modules are various extensions that run inside emulator core.
3578 As such, they affect sync.
3579 Modules must implement interface org.jpc.emulator.HardwareComponent (they
3580 are hardware components) and must be dumpable.
3581 Additionally, they need either constructor <init>() or <init>(String).
3582 The first is if no parameters are passed, the second is for case where
3583 parameters are passed.
3586 \begin_layout Standard
3587 Aside of the constructors, modules need to obey the ordinary conventions
3588 for hardware components.
3589 No code outside modules needs to know that module exists.
3592 \begin_layout Section
3596 \begin_layout Standard
3597 Plugins handle various UI tasks.
3598 They need to implement interface org.jpc.Plugin.
3601 \begin_layout Subsection
3602 Interface org.jpc.pluginsbase.Plugin
3605 \begin_layout Subsubsection
3606 Method systemShutdown()
3609 \begin_layout Standard
3610 Called when emulator shuts down.
3611 Either called in dedicated thread or in thread that called emulatorShutdown().
3612 These handlers should do the bare minimum to get files on disk to consistent
3614 After these calls from all plugins have finished, emulator exits.
3615 Do not try to manipulate UI from these methods, as doing that easily leads
3619 \begin_layout Subsubsection
3620 Method reconnect(PC)
3623 \begin_layout Standard
3624 Gives new PC to connect to.
3625 Null is passed if plugin should disconnect.
3628 \begin_layout Subsubsection
3632 \begin_layout Standard
3633 Called in dedicated thread after plugin is initialized.
3636 \begin_layout Subsubsection
3640 \begin_layout Standard
3641 Called after PC has stopped.
3644 \begin_layout Subsubsection
3648 \begin_layout Standard
3649 Called before PC starts.
3652 \begin_layout Subsubsection
3653 Method notifyArguments(String[])
3656 \begin_layout Standard
3657 Pass arguments from command line.
3660 \begin_layout Subsubsection
3661 Constructor <init>(Plugins)
3664 \begin_layout Standard
3665 This constructor is used to initialize plugins that don't take parameters.
3668 \begin_layout Subsubsection
3669 Constructor <init>(Plugins, String)
3672 \begin_layout Standard
3673 This constructor is used to initialize plugins that take parameters.
3676 \begin_layout Subsection
3677 Class org.jpc.pluginsbase.Plugins
3680 \begin_layout Standard
3681 This class provodes various methods for manipulating plugins.
3684 \begin_layout Subsubsection
3685 Method isShuttingDown()
3688 \begin_layout Standard
3689 Returns true if Plugins.shutdownEmulator() has been called somehow, either
3690 via VM exit, CTRL+C or explicitly.
3691 Useful to skip cleanups involving GUI, as these are too deadlock-prone.
3694 \begin_layout Subsubsection
3695 Method shutdownEmulator()
3698 \begin_layout Standard
3699 Shut down and exit the emulator.
3700 All plugin shutdown functions are called in this thread.
3703 \begin_layout Subsubsection
3704 Method reconnectPC(PC)
3707 \begin_layout Standard
3708 Signal reconnectPC event to all plugins.
3711 \begin_layout Subsubsection
3715 \begin_layout Standard
3716 Signal pcStarting() event to all plugins.
3719 \begin_layout Subsubsection
3723 \begin_layout Standard
3724 Signal pcStopping() event to all plugins.
3727 \begin_layout Section
3728 Inter-plugin communication
3731 \begin_layout Subsection
3732 Receiving communications
3735 \begin_layout Standard
3736 To receive invocation/call by name 'foo-bar', declare public method named
3738 Arguments to this method can currently be String, Integer (int) or Long
3740 Last argument may be array over these types to get variable number of arguments.
3741 On call, each argument gets value from call.
3742 If last argument is array, it gets all overflowing arguments.
3743 If return type is void or method returns boolean false, call is assumed
3745 If return value is boolean true, it is assumed that there is more processing.
3748 \begin_layout Subsection
3749 void org.jpc.pluginsbase.Plugins.invokeExternalCommand(String cmd, Object[]
3753 \begin_layout Standard
3754 Invoke command asynchronously, broadcasting to all plugins.
3755 Does not wait for slow commands to complete.
3756 cmd is the name to send and args are the arguments to pass.
3759 \begin_layout Subsection
3760 void org.jpc.pluginsbase.Plugins.invokeExternalCommandSynchronous(String cmd,
3764 \begin_layout Standard
3765 Same as invokeExternalCommand, but waits for slow commands to complete.
3768 \begin_layout Subsection
3769 Object[] org.jpc.pluginsbase.Plugins.invokeExternalCommandReturn(String cmd,
3773 \begin_layout Standard
3774 Similar to invokeExternalCommandSynchornous, but:
3777 \begin_layout Itemize
3778 Quits calling more plugins when it gets successful reply.
3781 \begin_layout Itemize
3785 \begin_layout Subsection
3786 void org.jpc.pluginsbase.Plugins.returnValue(Object...
3790 \begin_layout Standard
3791 Gives return value to return from call and signals that command has completed.
3794 \begin_layout Subsection
3795 void org.jpc.pluginsbase.Plugins.signalCommandCompletion()
3798 \begin_layout Standard
3799 Signals that command has completed.
3800 Only needed if there is no return value and eci_ method returned false
3804 \begin_layout Section
3805 Lua kernel programming
3808 \begin_layout Standard
3809 At startup, kernel gets its arguments in 'args' table and the script name
3810 to run in 'scriptname' string.
3811 It should enter the named script in protected mode.
3814 \begin_layout Standard
3815 The Lua VM exports numerious callbacks to kernel.
3816 The kernel can then choose to omit, wrap or re-export these to Lua scripts.
3819 \begin_layout Itemize
3820 Always grab any functions used into local variables so nobody can mess with
3824 \begin_layout Itemize
3825 Don't use global variables in kernel (except for those passed).