1 #LyX 2.0 created this file. For more info see http://www.lyx.org/
6 \use_default_options true
7 \maintain_unincluded_children false
9 \language_package default
14 \font_typewriter default
15 \font_default_family default
16 \use_non_tex_fonts false
23 \default_output_format default
25 \bibtex_command default
26 \index_command default
27 \paperfontsize default
38 \paperorientation portrait
47 \paragraph_separation indent
48 \paragraph_indentation default
49 \quotes_language english
52 \paperpagestyle default
53 \tracking_changes false
66 \begin_layout Standard
67 lsnes is SNES rerecording emulator based on bsnes core.
74 \begin_layout Enumerate
75 bsnes libsnes (for bsnes SNES core)
79 \begin_layout Enumerate
80 v084-v087 (v084 or v085 for delayreset support)
83 \begin_layout Enumerate
84 accuracy or compatiblity core with debugger enabled.
87 \begin_layout Enumerate
88 Patched version (using included 7 patches)
92 \begin_layout Enumerate
93 gambatte (for gambatte core)
97 \begin_layout Enumerate
101 \begin_layout Enumerate
102 Patched with included patches
106 \begin_layout Enumerate
110 \begin_layout Enumerate
114 \begin_layout Enumerate
118 \begin_layout Enumerate
119 boost_thread (if native std::thread is not available)
122 \begin_layout Enumerate
126 \begin_layout Enumerate
127 sdlmain (SDL only, part of SDL)
130 \begin_layout Enumerate
131 boost_conversion (this is header-only library)
134 \begin_layout Enumerate
135 libswscale (wxwidgets graphics only)
138 \begin_layout Enumerate
139 Portaudio (portaudio sound only)
142 \begin_layout Enumerate
143 libao (libao sound only)
146 \begin_layout Enumerate
147 Lua (if Lua support is needed).
151 \begin_layout Itemize
152 Version 5.1.X or 5.2X.
156 \begin_layout Enumerate
157 G++ 4.6 (bsnes doesn't seem to like 4.7, status for gambatte is unknown).
160 \begin_layout Section
164 \begin_layout Itemize
165 Copy bsnes sources (the bsnes subdirectory) to subdirectory 'bsnes' (for
169 \begin_layout Itemize
170 Copy gambatte sources to subdirectory 'gambatte' (for gambatte core).
173 \begin_layout Itemize
174 Patch the bsnes sources with included patches (directory 'bsnes-patches/<version
178 \begin_layout Itemize
179 Patch the gambatte sources with included patches (directory 'gambatte-patches/<v
180 ersion>', gambatte core)
183 \begin_layout Itemize
184 Edit options.build (or copy of that file)
187 \begin_layout Itemize
188 Run make (passing 'OPTIONS=<filename>' if using something else than options.build
192 \begin_layout Section
196 \begin_layout Subsection
200 \begin_layout Subsubsection
201 --rom=<file> (lsnes/SDL, lsnes/wxwidgets, lsnes-avidump)
204 \begin_layout Standard
208 \begin_layout Subsection
212 \begin_layout Subsubsection
216 \begin_layout Standard
220 \begin_layout Subsubsection
221 <filename> (lsnes/SDL, lsnes-avidump, movieinfo)
224 \begin_layout Standard
225 Load <filename> as movie or savestate file.
226 All other session options are ignored.
229 \begin_layout Subsubsection
230 --port1=<device> (lsnes/SDL, bsnes core only)
233 \begin_layout Standard
238 \begin_layout Itemize
239 none: No device connected
242 \begin_layout Itemize
243 gamepad: One gamepad (the default)
246 \begin_layout Itemize
247 multitap: Four gamepads (warning: makes most games refuse to start)
250 \begin_layout Itemize
254 \begin_layout Subsubsection
255 --port2=<type> (lsnes/SDL, bsnes core only)
258 \begin_layout Standard
263 \begin_layout Itemize
264 none: No device connected (the default)
267 \begin_layout Itemize
271 \begin_layout Itemize
272 multitap: Four gamepads.
275 \begin_layout Itemize
279 \begin_layout Itemize
280 superscope: Super Scope
283 \begin_layout Itemize
284 justifier: One justifier
287 \begin_layout Itemize
288 justifiers: Two justifiers
291 \begin_layout Subsubsection
292 --gamename=<name> (lsnes/SDL)
295 \begin_layout Standard
296 Set the name of game to <name>.
300 \begin_layout Subsubsection
301 --author=<name> (lsnes/SDL)
304 \begin_layout Standard
305 Add author with full name of <name> (no nickname).
308 \begin_layout Subsubsection
309 --author=|<name> (lsnes/SDL)
312 \begin_layout Standard
313 Add author with nickname of <name> (no full name).
316 \begin_layout Subsubsection
317 --author=<fullname>|<nickname> (lsnes/SDL)
320 \begin_layout Standard
321 Add author with full name of <fullname> and nickname of <nickname>.
324 \begin_layout Subsubsection
325 --rtc-second=<value> (lsnes/SDL)
328 \begin_layout Standard
329 Set RTC second (0 is 1st January 1970 00:00:00Z).
330 Default is 1,000,000,000.
333 \begin_layout Subsubsection
334 --rtc-subsecond=<value> (lsnes/SDL)
337 \begin_layout Standard
344 \begin_layout Subsubsection
345 --anchor-savestate=<file> (lsnes/SDL)
348 \begin_layout Standard
349 Set the anchor savestate file.
352 \begin_layout Subsubsection
353 --load=<file> (lsnes/wxwidgets)
356 \begin_layout Standard
357 After loading the ROM, load <file> as savestate/movie.
360 \begin_layout Subsection
365 \begin_layout Subsubsection
366 --run=<file> (lsnes/SDL)
369 \begin_layout Standard
370 After running main RC file, run this file.
371 If multiple are specified, these execute in order specified.
374 \begin_layout Subsection
375 dump options (lsnes-dumpavi only)
378 \begin_layout Subsubsection
382 \begin_layout Standard
383 Set the dumper to use (required).
384 Use 'list' for listing of known dumpers.
387 \begin_layout Subsubsection
391 \begin_layout Standard
392 Set the mode to use (required for dumpers with multiple modes, forbidden
394 Use 'list' for known modes.
397 \begin_layout Subsubsection
401 \begin_layout Standard
404 \begin_inset Quotes eld
408 \begin_inset Quotes erd
414 \begin_layout Subsubsection
415 --option=<name>=<value>
418 \begin_layout Standard
419 Set option <name> to value <value>.
422 \begin_layout Subsubsection
426 \begin_layout Standard
427 Set number of frames to dump.
431 \begin_layout Subsubsection
435 \begin_layout Standard
436 Run specified lua script (lsnes-dumpavi does not have initialization files).
439 \begin_layout Subsubsection
440 --load-library=<library>
443 \begin_layout Standard
444 Load the specified shared object / dynamic library / dynamic link library.
447 \begin_layout Section
448 Startup file lsnes.rc
451 \begin_layout Standard
452 Upon startup, lsnes (lsnes/SDL only) executes file lsnes.rc as commands.
453 This file is located in:
456 \begin_layout Itemize
461 lsnes.rc (if %APPDATA% exists)
464 \begin_layout Itemize
465 Unix: $XDG_CONFIG_HOME/lsnes/lsnes.rc (if $XDG_CONFIG_HOME exists)
468 \begin_layout Itemize
469 Unix: $HOME/.config/lsnes/lsnes.rc (if $HOME exists)
472 \begin_layout Itemize
473 All: ./lsnes.rc (fallback default).
476 \begin_layout Standard
477 If leading directories do not exist, attempt to create them is made.
480 \begin_layout Section
484 \begin_layout Itemize
485 Commands beginning with '*' invoke the corresponding command without alias
489 \begin_layout Itemize
490 If command starts with '+' (after possible '*'), the command is executed
491 as-is when button is pressed, and when button is released, it is executed
492 with '+' replaced by '-'.
495 \begin_layout Itemize
496 Commands without '+' execute only on negative edge (release).
499 \begin_layout Subsection
503 \begin_layout Standard
504 Settings control various aspects of emulator behaviour.
507 \begin_layout Subsubsection
508 set-setting <setting> <value>
511 \begin_layout Standard
512 Sets setting <setting> to value <value> (may be empty).
515 \begin_layout Subsubsection
516 unset-setting <setting>
519 \begin_layout Standard
520 Try to unset setting <setting> (not all settings can be unset).
523 \begin_layout Subsubsection
524 get-setting <setting>
527 \begin_layout Standard
528 Read value of setting <setting>
531 \begin_layout Subsubsection
535 \begin_layout Standard
536 Print names and values of all settings.
539 \begin_layout Subsection
543 \begin_layout Standard
544 Keybindings bind commands or aliases to keys (or pseudo-keys).
548 \begin_layout Standard
552 \begin_layout Itemize
553 Do not bind edge active (+/-) commands to keys with modifiers, that won't
557 \begin_layout Itemize
558 Names of keys and modifiers are platform-dependent.
561 \begin_layout Itemize
562 Be careful before binding pseudo-keys (such as joystick axes, buttons or
563 hats) with modifiers.
564 That may or may not work right.
567 \begin_layout Subsubsection
568 bind-key [<mod>/<modmask>] <key> <command>
571 \begin_layout Standard
572 Bind <command> to key <key> (activating if modifiers in <modmask> (comma-seperat
573 ed list) are set as <mod> (comma-seperated list).
576 \begin_layout Standard
577 The names of keys and modifiers are platform-dependent.
580 \begin_layout Subsubsection
581 unbind-key [<mod>/<modmask>] <key>
584 \begin_layout Standard
585 Unbind command from <key> (with specified <mod> and <modmask>).
588 \begin_layout Subsubsection
589 set-axis <axis> [disabled | axis | axis-inverse | pressure0- | pressure0+
590 | pressure-0 | pressure-+ | pressure+0 | pressure+-] [minus=<val>] [zero=<val>]
591 [plus=<val>] [tolerance=<val>]
594 \begin_layout Standard
595 Set axis parameters for axis <axis>.
598 \begin_layout Itemize
599 disabled: Disable axis
602 \begin_layout Itemize
606 \begin_layout Itemize
607 axis-inverse: Inverse axis
610 \begin_layout Itemize
611 pressure0-: Pressure sensitive.
612 Released at 0, pressed at -.
615 \begin_layout Itemize
616 pressure0+: Pressure sensitive.
617 Released at 0, pressed at +.
620 \begin_layout Itemize
621 pressure-0: Pressure sensitive.
622 Released at -, pressed at 0.
625 \begin_layout Itemize
626 pressure-+: Pressure sensitive.
627 Released at -, pressed at +.
630 \begin_layout Itemize
631 pressure+0: Pressure sensitive.
632 Released at +, pressed at 0.
635 \begin_layout Itemize
636 pressure+-: Pressure sensitive.
637 Released at +, pressed at -.
640 \begin_layout Itemize
641 minus=<val>: Calibration at extreme minus position (-32768-32767)
644 \begin_layout Itemize
645 zero=<val>: Calibration at neutral position (-32768-32767)
648 \begin_layout Itemize
649 plus=<val>: Calibration at extreme plus position (-32768-32767)
652 \begin_layout Itemize
653 tolerance=<value>: Center band tolerance (0<x<1).
654 The smaller the value, the more sensitive the control is.
657 \begin_layout Subsubsection
661 \begin_layout Standard
662 Print all key bindings in effect.
665 \begin_layout Subsection
669 \begin_layout Standard
670 Aliases bind command to sequence of commands.
671 After alias has been defined, it replaces the command it shadows.
674 \begin_layout Standard
678 \begin_layout Itemize
679 You can't alias command to itself.
682 \begin_layout Itemize
683 Aliases starting with +/- are edge active just like ordinary commands starting
687 \begin_layout Itemize
688 One command can be aliased to multiple commands.
691 \begin_layout Subsubsection
692 alias-command <command> <expansion>
695 \begin_layout Standard
696 Append <expansion> to alias <command>.
697 If alias does not already exist, it is created.
700 \begin_layout Subsubsection
701 unalias-command <command>
704 \begin_layout Standard
705 Clear alias expansion for <command>.
708 \begin_layout Subsubsection
712 \begin_layout Standard
713 Print all aliases and their expansions in effect.
716 \begin_layout Subsection
720 \begin_layout Standard
721 Run <script> as if commands were entered on the command line.
724 \begin_layout Subsection
728 \begin_layout Standard
729 Following commands control video dumping:
732 \begin_layout Subsubsection
733 start-dump <dumper> [<mode>] <prefix/filename>
736 \begin_layout Standard
737 Start dumping using dumper <dumper>.
738 If mode is present or not and if prefix or filename is present depends
739 on the dumper and dumper mode.
742 \begin_layout Standard
743 The following dumpers are available:
746 \begin_layout Itemize
747 INTERNAL-AVI-CSCD: Internal CSCD in .avi dumper.
751 \begin_layout Itemize
752 Mode: uncompressed/pcm: Uncompressed video, PCM audio.
756 \begin_layout Itemize
757 Mode: cscd/pcm: CSCD video, PCM audio.
762 \begin_layout Itemize
763 INTERNAL-JMD: Internal .jmd dumper.
767 \begin_layout Itemize
771 \begin_layout Itemize
776 \begin_layout Itemize
777 INTERNAL-RAW: Internal RAW dumper.
781 \begin_layout Itemize
785 \begin_layout Itemize
789 \begin_layout Itemize
790 Sound is big-endian signed 16-bit, usually at 32040.5Hz.
793 \begin_layout Itemize
794 Video is always upscaled to double resolution (512x448 / 512 x 478).
797 \begin_layout Itemize
798 Video framerate is usually 322445/6448 fps for PAL and 10738636/178683 fps
803 \begin_layout Itemize
804 INTERNAL-SDMP: Internal SDMP dumper.
808 \begin_layout Itemize
809 Mode 'ms': Multi-segment.
813 \begin_layout Itemize
814 Mode 'ss': Single-segment.
819 \begin_layout Subsubsection
823 \begin_layout Standard
824 End dumping using <dumper>
827 \begin_layout Subsubsection
828 show-dumpers [<dumper>]
831 \begin_layout Standard
832 Show the list of dumpers or list of modes for <dumper>
835 \begin_layout Subsection
839 \begin_layout Standard
840 <address> may be decimal or hexadecimal (prefixed with '0x').
841 <value> can be hexadecimal (prefixed with '0x'), unsigned or signed (prefixed
845 \begin_layout Standard
846 The available element <sizes> are:
849 \begin_layout Itemize
853 \begin_layout Itemize
857 \begin_layout Itemize
861 \begin_layout Itemize
865 \begin_layout Standard
866 When reading RAM and ROM, multi-byte reads/writes are big-endian.
867 When dealing with DSP memory, multi-byte reads/writes are native-endian
868 (do not use operand sizes exceeding DSP bitness, except dword is OK for
872 \begin_layout Subsubsection
873 read-<size> <address>
876 \begin_layout Standard
877 Read the value of byte in <address>.
880 \begin_layout Subsubsection
881 read-s<size> <address>
884 \begin_layout Standard
885 Read the value of signed byte in <address>.
888 \begin_layout Subsubsection
889 write-<size> <address> <value>
892 \begin_layout Standard
893 Write <value> to byte in address <address>.
896 \begin_layout Subsubsection
900 \begin_layout Standard
901 Reset the memory search
904 \begin_layout Subsubsection
908 \begin_layout Standard
909 Print number of candidates remaining
912 \begin_layout Subsubsection
916 \begin_layout Standard
917 Print all candidates remaining
920 \begin_layout Subsubsection
921 search-memory <usflag><sizeflag><op>
924 \begin_layout Standard
925 Searches memory for addresses satisfying criteria.
928 \begin_layout Standard
932 \begin_layout Itemize
936 \begin_layout Itemize
940 \begin_layout Standard
944 \begin_layout Itemize
948 \begin_layout Itemize
952 \begin_layout Itemize
956 \begin_layout Itemize
960 \begin_layout Standard
964 \begin_layout Itemize
965 lt: < previous value.
968 \begin_layout Itemize
969 le: <= previous value.
972 \begin_layout Itemize
973 eq: = previous value.
976 \begin_layout Itemize
977 ne: != previous value.
980 \begin_layout Itemize
981 ge: >= previous value.
984 \begin_layout Itemize
985 gt: > previous value.
988 \begin_layout Subsubsection
989 search-memory <sizeflag> <value>
992 \begin_layout Standard
993 Searches for addresses that currently have value <value>.
994 <sizeflag> is as in previous command.
997 \begin_layout Subsection
1001 \begin_layout Standard
1002 These commands are not available in lsnesrc, but are available after ROM
1006 \begin_layout Subsubsection
1010 \begin_layout Standard
1011 Quits the emulator (asking for confirmation).
1012 If /y is given, no confirmation is asked.
1015 \begin_layout Subsubsection
1019 \begin_layout Standard
1020 Toggle paused/unpaused
1023 \begin_layout Subsubsection
1027 \begin_layout Standard
1029 If the button is still held after configurable timeout expires, game unpauses
1030 for the duration frame advance is held.
1033 \begin_layout Subsubsection
1037 \begin_layout Standard
1039 If the button is still held after configurable timeout expires, game unpauses
1040 for the duration frame advance is held.
1043 \begin_layout Subsubsection
1047 \begin_layout Standard
1048 Skip to first poll in frame after current.
1051 \begin_layout Subsubsection
1055 \begin_layout Standard
1056 Reset the SNES after this frame.
1059 \begin_layout Subsubsection
1063 \begin_layout Standard
1064 Load savestate <filename> in current mode.
1067 \begin_layout Subsubsection
1068 load-state <filename>
1071 \begin_layout Standard
1072 Load savestate <filename> in readwrite mode.
1075 \begin_layout Subsubsection
1076 load-readonly <filename>
1079 \begin_layout Standard
1080 Load savestate <filename> in readonly mode.
1083 \begin_layout Subsubsection
1084 load-preserve <filename>
1087 \begin_layout Standard
1088 Load savestate <filename> in readonly mode, preserving current events.
1091 \begin_layout Subsubsection
1092 load-movie <filename>
1095 \begin_layout Standard
1096 Load savestate <filename>, ignoring save part in readonly mode.
1099 \begin_layout Subsubsection
1100 save-state <filename>
1103 \begin_layout Standard
1104 Save system state to <filename> as soon as possible.
1107 \begin_layout Subsubsection
1108 save-movie <filename>
1111 \begin_layout Standard
1112 Save movie to <filename>.
1115 \begin_layout Subsubsection
1119 \begin_layout Standard
1120 Set read-write mode.
1123 \begin_layout Subsubsection
1127 \begin_layout Standard
1131 \begin_layout Subsubsection
1135 \begin_layout Standard
1136 Toggle between read-only and read-write modes.
1139 \begin_layout Subsubsection
1143 \begin_layout Standard
1144 Set name of the game to <name>
1147 \begin_layout Subsubsection
1151 \begin_layout Standard
1152 Print the name of the game.
1155 \begin_layout Subsubsection
1159 \begin_layout Standard
1160 Adds new author <author>.
1161 If <author> does not contain '|' it is full name.
1162 If it contains '|', '|' splits the full name and nickname.
1165 \begin_layout Subsubsection
1166 edit-author <num> <author>
1169 \begin_layout Standard
1170 Edit the author in slot <num> (0-based) to be <author> (see add-author for
1174 \begin_layout Subsubsection
1178 \begin_layout Standard
1179 Remove author in slot <num>
1182 \begin_layout Subsubsection
1186 \begin_layout Standard
1190 \begin_layout Subsubsection
1191 test-1, test-2, test-3
1194 \begin_layout Standard
1195 Internal test commands.
1199 \begin_layout Subsubsection
1200 take-screenshot <filename>
1203 \begin_layout Standard
1204 Save screenshot to <filename>.
1207 \begin_layout Subsubsection
1208 +controller<num><button>
1211 \begin_layout Standard
1212 Press button <button> on controller <num> (1-8).
1213 The following button names are known:
1216 \begin_layout Itemize
1220 \begin_layout Itemize
1224 \begin_layout Itemize
1228 \begin_layout Itemize
1232 \begin_layout Itemize
1236 \begin_layout Itemize
1240 \begin_layout Itemize
1244 \begin_layout Itemize
1248 \begin_layout Itemize
1252 \begin_layout Itemize
1256 \begin_layout Itemize
1260 \begin_layout Itemize
1264 \begin_layout Itemize
1268 \begin_layout Itemize
1272 \begin_layout Itemize
1276 \begin_layout Itemize
1280 \begin_layout Subsubsection
1281 controllerh<num><button>
1284 \begin_layout Standard
1285 Hold/unhold button <button> on controller <num> (1-8).
1286 See +controller for button names.
1289 \begin_layout Subsubsection
1290 controllerf<num><button>
1293 \begin_layout Standard
1294 Hold/unhold button <button> on controller <num> (1-8) for the next frame.
1295 See +controller for button names.
1298 \begin_layout Standard
1299 Cauntion: Does not work properly if outside frame advance.
1302 \begin_layout Subsubsection
1303 autofire (<pattern>|-)...
1306 \begin_layout Standard
1307 Set autofire pattern.
1308 Each parameter is comma-separated list of button names (in form of 1start,
1309 1A, 2B, etc..) to hold on that frame.
1310 After reaching the end of pattern, the pattern restarts from the beginning.
1313 \begin_layout Subsubsection
1317 \begin_layout Standard
1321 \begin_layout Subsection
1325 \begin_layout Subsubsection
1326 cycle-jukebox-backward
1329 \begin_layout Standard
1330 Cycle save jukebox backwards.
1333 \begin_layout Subsubsection
1334 cycle-jukebox-forward
1337 \begin_layout Standard
1338 Cycle save jukebox forwards
1341 \begin_layout Subsubsection
1345 \begin_layout Standard
1346 Do load from jukebox (current mode).
1349 \begin_layout Subsubsection
1353 \begin_layout Standard
1354 Do state save to jukebox.
1357 \begin_layout Subsection
1361 \begin_layout Standard
1362 Only available if lua support is compiled in.
1365 \begin_layout Subsubsection
1366 evaluate-lua <luacode>
1369 \begin_layout Standard
1370 Run Lua code <luacode> using built-in Lua interpretter.
1373 \begin_layout Subsubsection
1377 \begin_layout Standard
1378 Run specified lua file using built-in Lua interpretter.
1381 \begin_layout Subsubsection
1385 \begin_layout Standard
1386 Clear the Lua VM state and restore to factory defaults.
1389 \begin_layout Subsection
1393 \begin_layout Subsubsection
1394 add-watch <name> <expression>
1397 \begin_layout Standard
1398 Adds new watch (or modifies old one).
1401 \begin_layout Subsubsection
1405 \begin_layout Standard
1409 \begin_layout Subsection
1413 \begin_layout Subsubsection
1414 enable-sound <on/off>
1417 \begin_layout Standard
1418 Enable/Disable sound.
1421 \begin_layout Subsubsection
1422 set-sound-device <device>
1425 \begin_layout Standard
1426 Set sound device to <device>
1429 \begin_layout Subsubsection
1433 \begin_layout Standard
1434 Show status of sound system.
1437 \begin_layout Subsubsection
1441 \begin_layout Standard
1442 Show all available devices.
1445 \begin_layout Subsubsection
1446 set-volume <multiplier>
1449 \begin_layout Standard
1450 Set the volume multiplier to <multiplier>.
1451 1 is normal volume, and higher numbers are louder.
1454 \begin_layout Subsubsection
1455 set-volume <multiplier>%
1458 \begin_layout Standard
1459 Set the volume multiplier to <multiplier> percent.
1460 100 is normal volume, and higher numbers are louder.
1463 \begin_layout Subsubsection
1464 set-volume <multiplier>dB
1467 \begin_layout Standard
1468 Set the volume multiplier to <multiplier> dB.
1469 0 is normal volume, and higher numbers are louder.
1470 The value may be negative.
1473 \begin_layout Subsection
1477 \begin_layout Subsubsection
1481 \begin_layout Standard
1482 Reloads the main ROM image from <file>.
1485 \begin_layout Subsubsection
1486 edit-subtitle <firstframe> <length> [<text>]
1489 \begin_layout Standard
1490 Edit or delete a subtitle.
1493 \begin_layout Subsubsection
1497 \begin_layout Standard
1501 \begin_layout Subsection
1505 \begin_layout Subsubsection
1509 \begin_layout Standard
1513 \begin_layout Subsubsection
1517 \begin_layout Standard
1521 \begin_layout Subsubsection
1525 \begin_layout Standard
1529 \begin_layout Subsubsection
1530 change-timebase <id> <newbase>
1533 \begin_layout Standard
1534 Change time base of <id> to <newbase>.
1535 The time base can be given as samples (integer) or second (postfix with
1539 \begin_layout Subsubsection
1540 import-stream-opus <timebase> <file>
1543 \begin_layout Standard
1544 Import opus stream from <file>, placing it at <timebase>.
1545 This operation is lossless.
1548 \begin_layout Subsubsection
1549 import-stream-pcm <timebase> <file>
1552 \begin_layout Standard
1553 Import PCM (.sox, 1ch@48kHz) stream from <file>, placing it at <timebase>.
1556 \begin_layout Subsubsection
1557 export-stream-opus <id> <file>
1560 \begin_layout Standard
1561 Export stream <id> as opus stream to <file>.
1562 This operation is lossless.
1565 \begin_layout Subsubsection
1566 export-stream-pcm <id> <file>
1569 \begin_layout Standard
1570 Export stream <id> as PCM (.sox) stream to <file>.
1574 \begin_layout Subsubsection
1575 export-superstream <file>
1578 \begin_layout Standard
1579 Export the entiere superstream as PCM (.sox) stream to <file>.
1582 \begin_layout Subsubsection
1583 load-collection <file>
1586 \begin_layout Standard
1587 Load collection (if there is existing collection, unload it) from <file>
1590 \begin_layout Subsubsection
1594 \begin_layout Standard
1598 \begin_layout Subsubsection
1602 \begin_layout Standard
1603 Tangent for recording voice for commentary track.
1604 While pressed, record a stream.
1607 \begin_layout Subsection
1608 SDL Platform commands
1611 \begin_layout Standard
1612 The following are valid on SDL platform.
1615 \begin_layout Subsubsection
1619 \begin_layout Standard
1620 Asks to press a key and then identifies that (pseudo-)key.
1623 \begin_layout Subsubsection
1627 \begin_layout Standard
1628 Toggle between windowed/fullscreen console.
1631 \begin_layout Subsubsection
1635 \begin_layout Standard
1636 Scroll messages window as far back as it goes.
1639 \begin_layout Subsubsection
1643 \begin_layout Standard
1644 Scroll messages window as far forward as it goes.
1647 \begin_layout Subsubsection
1651 \begin_layout Standard
1652 Scroll messages window back one screenful.
1655 \begin_layout Subsubsection
1659 \begin_layout Standard
1660 Scroll messages window forward one screenful.
1663 \begin_layout Subsubsection
1664 prompt-command <command>
1667 \begin_layout Standard
1668 Enter command prompt, with prompt prepopulated with specified command.
1671 \begin_layout Section
1675 \begin_layout Subsection
1679 \begin_layout Subsubsection
1683 \begin_layout Standard
1684 Set where bsnes looks for firmware files.
1686 \begin_inset Quotes eld
1690 \begin_inset Quotes erd
1696 \begin_layout Subsubsection
1700 \begin_layout Standard
1702 Numeric, range is 0.001 to
1703 \begin_inset Quotes eld
1707 \begin_inset Quotes erd
1711 Default is native framerate.
1714 \begin_layout Subsubsection
1718 \begin_layout Standard
1719 Set save compression level (integer 0-9).
1720 Default is 7 (0 is no compression).
1723 \begin_layout Subsubsection
1727 \begin_layout Standard
1728 Set the frame advance timeout in milliseconds.
1729 Numeric integer, range is 0-999999999.
1733 \begin_layout Subsubsection
1734 allow-inconsistent-saves (bsnes only)
1737 \begin_layout Standard
1738 If true, save without synchronization.
1739 Makes games seriously unstable.
1742 \begin_layout Subsubsection
1743 save-every-frame (bsnes only)
1746 \begin_layout Standard
1747 If true, simulate saving on each frame.
1748 Trades off emulation accuracy for sync stability.
1749 Also needed if the movie assumes saving on each frame for rewind.
1752 \begin_layout Subsection
1756 \begin_layout Subsubsection
1760 \begin_layout Standard
1761 AVI dumper: Always dump at 512x448 or 512x478 regardless of what the console
1765 \begin_layout Subsubsection
1769 \begin_layout Standard
1770 AVI dumper: Set the default left border thickness (unless lua overrides)
1776 \begin_layout Subsubsection
1780 \begin_layout Standard
1781 AVI dumper: Set the default right border thickness (unless lua overrides)
1787 \begin_layout Subsubsection
1791 \begin_layout Standard
1792 AVI dumper: Set the default top border thickness (unless lua overrides)
1798 \begin_layout Subsubsection
1802 \begin_layout Standard
1803 AVI dumper: Set the default bottom border thickness (unless lua overrides)
1809 \begin_layout Subsubsection
1813 \begin_layout Standard
1814 AVI dumper: Maximum number of frames per dump segment (0 => unlimited).
1819 \begin_layout Subsubsection
1823 \begin_layout Standard
1824 AVI dumper: Compression level (0-18).
1827 \begin_layout Itemize
1828 Compression levels 10 and above are not compatible with stock CSCD codec.
1831 \begin_layout Itemize
1832 Recomended level is 7.
1835 \begin_layout Subsubsection
1839 \begin_layout Standard
1840 AVI dumper: Set method of determining the sound rate.
1843 \begin_layout Itemize
1844 0: Pick nearest of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48, 64, 88.2, 96,
1845 128, 176.4 and 192 kHz.
1848 \begin_layout Itemize
1849 1: Round down to nearest integer.
1852 \begin_layout Itemize
1853 2: Round up to nearest ingeter.
1856 \begin_layout Subsection
1860 \begin_layout Subsubsection
1864 \begin_layout Standard
1865 JMD dumper: Compression level (0-9).
1868 \begin_layout Subsection
1869 SDL platform settings
1872 \begin_layout Subsubsection
1873 autorepeat-first-delay
1876 \begin_layout Standard
1877 Sets the delay for first character in typematic autorepeat.
1880 \begin_layout Subsubsection
1881 autorepeat-subsequent-delay
1884 \begin_layout Standard
1885 Sets the delay for subsequent characters in typematic autorepeat.
1888 \begin_layout Section
1892 \begin_layout Subsection
1893 Core (in main table)
1896 \begin_layout Subsubsection
1900 \begin_layout Standard
1901 Print line to message console.
1904 \begin_layout Subsubsection
1905 exec(string command)
1908 \begin_layout Standard
1909 Run command as it was entered on the command line
1912 \begin_layout Subsubsection
1916 \begin_layout Standard
1918 First is time since some epoch in seconds, the second is microseconds mod
1919 10^6 since that epoch.
1922 \begin_layout Subsubsection
1926 \begin_layout Standard
1927 Returns true if emulator has finished booting, false if not (on_startup()
1928 will be issued later).
1931 \begin_layout Subsubsection
1932 set_idle_timeout(number timeout)
1935 \begin_layout Standard
1936 Set number of microseconds to block idle for.
1937 After this timeout has expired, on_idle() will be called once.
1940 \begin_layout Subsubsection
1941 set_timer_timeout(number timeout)
1944 \begin_layout Standard
1945 Set number of microseconds to block timer for.
1946 After this timeout has expired, on_timer() will be called once.
1949 \begin_layout Subsubsection
1950 bus_address(number snesaddr)
1953 \begin_layout Standard
1954 Returns virtual address corresponding to specified address on SNES bus.
1957 \begin_layout Subsubsection
1958 loopwrapper(function fun, ...)
1961 \begin_layout Standard
1962 Calls function fun with function and specified arguments.
1963 The function passed suspends execution until the function returned is called.
1964 Handy for linear flow control among multiple invocations of a hook.
1968 \begin_layout LyX-Code
1969 on_paint = loopwrapper(function(wait)
1973 \begin_layout LyX-Code
1978 \begin_layout LyX-Code
1980 \begin_inset Quotes eld
1984 \begin_inset Quotes erd
1990 \begin_layout LyX-Code
1995 \begin_layout LyX-Code
2000 \begin_layout LyX-Code
2004 \begin_layout Subsection
2008 \begin_layout Standard
2009 Bitwise logical functions and related.
2012 \begin_layout Subsubsection
2013 bit.none(number...) / bit.bnot(number...)
2016 \begin_layout Standard
2017 48-bit bitwise NOT / NONE function (set bits that are set in none of the
2021 \begin_layout Subsubsection
2022 bit.any(number...) / bit.bor(number...)
2025 \begin_layout Standard
2026 48-bit bitwise OR / ANY function (set bits that are set in any of the arguments).
2029 \begin_layout Subsubsection
2030 bit.all(number...) / bit.band(number...)
2033 \begin_layout Standard
2034 48-bit bitwise AND / ALL function (set bits that are set in all of the arguments
2038 \begin_layout Subsubsection
2039 bit.parity(number...) / bit.bxor(number...)
2042 \begin_layout Standard
2043 48-bit bitwise XOR / PARITY function (set bits that are set in odd number
2047 \begin_layout Subsubsection
2048 bit.lrotate(number base[, number amount[, number bits]])
2051 \begin_layout Standard
2052 Rotate bits-bit (max 48, default 48) number left by amount (default 1) places.
2055 \begin_layout Subsubsection
2056 bit.rrotate(number base[, number amount[, number bits]])
2059 \begin_layout Standard
2060 Rotate bits-bit (max 48, default 48) number right by amount (default 1)
2064 \begin_layout Subsubsection
2065 bit.lshift(number base[, number amount[, number bits]])
2068 \begin_layout Standard
2069 Shift bits-bit (max 48, default 48) number left by amount (default 1) places.
2070 The new bits are filled with zeroes.
2073 \begin_layout Subsubsection
2074 bit.lrshift(number base[, number amount[, number bits]])
2077 \begin_layout Standard
2078 Shift bits-bit (max 48, default 48) number logically right by amount (default
2080 The new bits are filled with zeroes.
2083 \begin_layout Subsubsection
2084 bit.arshift(number base[, number amount[, number bits]])
2087 \begin_layout Standard
2088 Shift bits-bit (max 48, default 48) number arithmetically right by amount
2090 The new bits are shifted in with copy of the high bit.
2093 \begin_layout Subsubsection
2094 bit.extract(number base[, number bit0[, number bit1,...]])
2097 \begin_layout Standard
2098 Returns number that has bit0-th bit as bit 0, bit1-th bit as 1 and so on.
2101 \begin_layout Standard
2105 \begin_layout Itemize
2106 Bit numbers up to 51 should work reliably (then things start falling apart
2107 due to double precision issues).
2110 \begin_layout Itemize
2111 There are two special bit positions, true and false, standing for always
2112 set bit and always clear bit.
2115 \begin_layout Subsubsection
2116 bit.value([number bit1[, number bit2,...]])
2119 \begin_layout Standard
2120 Returns bitwise OR of 1 left shifted by bit1 places, 1 left shifted by bit2
2122 As special value, nil argument is no-op.
2125 \begin_layout Subsection
2129 \begin_layout Standard
2130 Most of these functions can only be called in on_paint and on_video callbacks.
2131 Exceptions are noted.
2134 \begin_layout Standard
2136 Bits 0-7 are the blue component, bits 8-15 are the green component, bits
2137 16-23 are the red component, bits 24-31 are alpha component (0 is fully
2138 opaque, 255 is almost transparent).
2139 -1 is the fully transparent color.
2140 Alpha values greater than 127 do work.
2143 \begin_layout Standard
2144 Origin of coordinates is at top left corner of game display area.
2145 Left and top gaps correspond to negative coordinates.
2148 \begin_layout Subsubsection
2152 \begin_layout Standard
2153 Returns 2-tuple (hresolution, vresolution).
2156 \begin_layout Subsubsection
2157 gui.<class>_gap(number gap)
2160 \begin_layout Standard
2161 Set the <class> (left, right, top, bottom) gap to specified value (max gap
2165 \begin_layout Subsubsection
2166 gui.text(number x, number y, string text[, number fgc[, number bgc]])
2169 \begin_layout Standard
2170 Draw specified text on the GUI (each character cell is 8 or 16 wide and
2175 \begin_layout Itemize
2176 x: X-coordinate to start the drawing from (and x-coordinate at begining
2180 \begin_layout Itemize
2181 y: Y-coordinate to start the drawing from.
2184 \begin_layout Itemize
2185 text: The text to draw.
2188 \begin_layout Itemize
2189 fgc: Text color (default is 0xFFFFFF (white))
2192 \begin_layout Itemize
2193 bgc: Background color (default is -1 (transparent))
2196 \begin_layout Subsubsection
2197 gui.textH(number x, number y, string text[, number fgc[, number bgc]])
2200 \begin_layout Standard
2201 Like gui.text, but draw using double-width.
2204 \begin_layout Subsubsection
2205 gui.textV(number x, number y, string text[, number fgc[, number bgc]])
2208 \begin_layout Standard
2209 Like gui.text, but draw using double-height.
2212 \begin_layout Subsubsection
2213 gui.textHV(number x, number y, string text[, number fgc[, number bgc]])
2216 \begin_layout Standard
2217 Like gui.text, but draw using double-width/double-height.
2220 \begin_layout Subsubsection
2221 gui.rectangle(number x, number y, number width, number height[, number thickness[
2222 , number outline[, number fill]]])
2225 \begin_layout Standard
2226 Draw rectangle on the GUI.
2230 \begin_layout Itemize
2231 x: X-coordinate of left edge.
2234 \begin_layout Itemize
2235 y: Y-coordinate of upper edge.
2238 \begin_layout Itemize
2239 width: Width of rectangle.
2242 \begin_layout Itemize
2243 height: Height of rectangle.
2246 \begin_layout Itemize
2247 thickness: Thickness of outline (default is 1).
2250 \begin_layout Itemize
2251 outline: Color of outline (default is 0xFFFFFF (white))
2254 \begin_layout Itemize
2255 fill: Color of fill (default is -1 (transparent))
2258 \begin_layout Subsubsection
2259 gui.box(number x, number y, number width, number height[, number thickness[,
2260 number outline1[,number outline2[, number fill]]]])
2263 \begin_layout Standard
2264 Draw rectangle with 3D effect on the GUI.
2268 \begin_layout Itemize
2269 x: X-coordinate of left edge.
2272 \begin_layout Itemize
2273 y: Y-coordinate of upper edge.
2276 \begin_layout Itemize
2277 width: Width of rectangle.
2280 \begin_layout Itemize
2281 height: Height of rectangle.
2284 \begin_layout Itemize
2285 thickness: Thickness of outline (default is 1).
2288 \begin_layout Itemize
2289 outline1: First color of outline (default is 0xFFFFFF (white))
2292 \begin_layout Itemize
2293 outline2: First color of outline (default is 0x808080 (dark gray))
2296 \begin_layout Itemize
2297 fill: Color of fill (default is 0xC0C0C0 (light grayy))
2300 \begin_layout Subsubsection
2301 gui.pixel(number x, number y[, number color])
2304 \begin_layout Standard
2305 Draw one pixel on the GUI.
2309 \begin_layout Itemize
2310 x: X-coordinate of the pixel
2313 \begin_layout Itemize
2314 y: Y-coordinate of the pixel
2317 \begin_layout Itemize
2318 color: Color of the pixel (default is 0xFFFFFF (white))
2321 \begin_layout Subsubsection
2322 gui.crosshair(number x, number y[, number length[, number color]])
2325 \begin_layout Standard
2330 \begin_layout Itemize
2331 x: X-coordinate of the crosshair
2334 \begin_layout Itemize
2335 y: Y-coordinate of the crosshair
2338 \begin_layout Itemize
2339 length: Length of the crosshair lines (default 10).
2342 \begin_layout Itemize
2343 color: Color of the crosshair (default is 0xFFFFFF (white))
2346 \begin_layout Subsubsection
2347 gui.line(number x1, number y1, number x2, number y2[, number color])
2350 \begin_layout Standard
2355 \begin_layout Itemize
2356 x1: X-coordinate of one end.
2359 \begin_layout Itemize
2360 y1: Y-coordinate of one end.
2363 \begin_layout Itemize
2364 x2: X-coordinate of the other end.
2367 \begin_layout Itemize
2368 y2: Y-coordinate of the other end.
2371 \begin_layout Itemize
2372 color: Color of the line (default is 0xFFFFFF (white)).
2375 \begin_layout Subsubsection
2376 gui.circle(number x, number y, number r[, number thick[, number border[,
2380 \begin_layout Standard
2385 \begin_layout Itemize
2386 x: X-coordinate of the center
2389 \begin_layout Itemize
2390 y: Y-coordinate of the center
2393 \begin_layout Itemize
2394 r: The radius of the circle
2397 \begin_layout Itemize
2398 thick: Border thickness
2401 \begin_layout Itemize
2402 border: Border color (default is 0xFFFFFF (white))
2405 \begin_layout Itemize
2406 fill: Fill color (default is -1 (transparent)).
2409 \begin_layout Subsubsection
2410 gui.bitmap_draw(number x, number y, bitmap bitmap, palette palette)
2413 \begin_layout Standard
2414 Draw a bitmap on screen with specified palette.
2418 \begin_layout Itemize
2419 x: X-coordinate of left edge.
2422 \begin_layout Itemize
2423 y: Y-coordinate of top edge.
2426 \begin_layout Itemize
2427 bitmap: The bitmap to draw
2430 \begin_layout Itemize
2431 palette: The palette to draw the bitmap using.
2434 \begin_layout Subsubsection
2435 gui.bitmap_draw(number x, number y, dbitmap bitmap)
2438 \begin_layout Standard
2439 Draw a bitmap on screen.
2443 \begin_layout Itemize
2444 x: X-coordinate of left edge.
2447 \begin_layout Itemize
2448 y: Y-coordinate of top edge.
2451 \begin_layout Itemize
2452 bitmap: The bitmap to draw
2455 \begin_layout Subsubsection
2459 \begin_layout Standard
2460 Returns a new palette (initially all transparent).
2461 Can be used anywhere.
2464 \begin_layout Subsubsection
2465 gui.bitmap_new(number w, number h, boolean direct[, bool icolor])
2468 \begin_layout Standard
2469 Returns a new bitmap/dbitmap.
2470 Can be used anywhere.
2474 \begin_layout Itemize
2475 w: The width of new bitmap
2478 \begin_layout Itemize
2479 h: The height of new bitmap
2482 \begin_layout Itemize
2483 direct: If true, the returned bitmap is dbitmap, otherwise bitmap.
2486 \begin_layout Itemize
2487 icolor: Initital fill color (defaults to 0 on BITMAP, -1 on DBITMAP)
2490 \begin_layout Subsubsection
2491 gui.bitmap_load(string file)
2494 \begin_layout Standard
2495 Returns loaded bitmap/dbitmap (if bitmap, the second return value is palette
2497 Can be used anywhere.
2501 \begin_layout Itemize
2502 file: The name of file to load.
2505 \begin_layout Subsubsection
2506 gui.palette_set(palette palette, number index, number color)
2509 \begin_layout Standard
2510 Sets color in palette.
2511 Can be used anywhere.
2515 \begin_layout Itemize
2516 palette: The palette to manipulate
2519 \begin_layout Itemize
2520 index: Index of color (0-65535).
2523 \begin_layout Itemize
2524 color: The color value.
2527 \begin_layout Subsubsection
2528 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y, number color)
2531 \begin_layout Standard
2532 Sets specified pixel in bitmap.
2533 Can be used anywhere.
2537 \begin_layout Itemize
2538 bitmap: The bitmap to manipulate
2541 \begin_layout Itemize
2542 x: The x-coordinate of the pixel.
2545 \begin_layout Itemize
2546 y: The y-coordinate of the pixel.
2549 \begin_layout Itemize
2550 color: If bitmap is a bitmap, color index (0-65535).
2551 Otherwise color value.
2554 \begin_layout Subsubsection
2555 gui.bitmap_size(bitmap/dbitmap bitmap)
2558 \begin_layout Standard
2560 Can be used anywhere.
2564 \begin_layout Itemize
2565 bitmap: The bitmap to query.
2568 \begin_layout Standard
2569 The first return is the width, the second is the height.
2572 \begin_layout Subsubsection
2573 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy, bitmap/dbitmap
2574 src, number sx, number sy, number w, number h[, number ck])
2577 \begin_layout Standard
2578 Blit a part of bitmap to another.
2579 Can be used anywhere.
2583 \begin_layout Itemize
2584 dest: Destination to blit to.
2587 \begin_layout Itemize
2588 dx: left edge of target
2591 \begin_layout Itemize
2592 dy: Top edge of target
2595 \begin_layout Itemize
2596 src: The source to blit from.
2597 Must be of the same type as destination.
2600 \begin_layout Itemize
2601 sx: left edge of source
2604 \begin_layout Itemize
2605 sy: Top edge of source
2608 \begin_layout Itemize
2612 \begin_layout Itemize
2613 h: Height of region.
2616 \begin_layout Itemize
2618 Pixels of this color are not blitted.
2622 \begin_layout Itemize
2623 If bitmaps are bitmaps, this is color index of colorkey.
2624 Values outside range 0-65535 cause no key to be used as colorkey.
2627 \begin_layout Itemize
2628 If bitmaps are dbitmaps, this color value of colorkey.
2631 \begin_layout Itemize
2632 May be absent or nil for no colorkey blit.
2636 \begin_layout Subsubsection
2640 \begin_layout Standard
2641 Request on_repaint() to happen as soon as possible.
2642 Can be used anywhere.
2645 \begin_layout Subsubsection
2646 gui.subframe_update(boolean on)
2649 \begin_layout Standard
2650 Request subframe updates (calling on_paint() on subframes) to happen (on=true)
2651 or not happen (on=false).
2652 Can be used anywhere.
2655 \begin_layout Subsubsection
2656 gui.screenshot(string filename)
2659 \begin_layout Standard
2660 Write PNG screenshot of the current frame (no drawings) to specified file.
2661 Can be used anywhere.
2664 \begin_layout Subsubsection
2665 gui.color(number r, number g, number b[, number a])
2668 \begin_layout Standard
2669 Returns color (in notation Lua scripts use) corresponding to color (r,g,b),
2670 each component in scale 0-255.
2671 If a is specified, that is alpha (0 is fully transparent, 256(sic) is fully
2673 The default alpha is 256.
2676 \begin_layout Subsubsection
2677 gui.status(string name, string value)
2680 \begin_layout Standard
2682 \begin_inset Quotes eld
2686 \begin_inset Quotes erd
2689 to <value> in status area.
2690 Can be used anywhere.
2693 \begin_layout Subsubsection
2694 gui.rainbow(number step, number steps[, number color])
2697 \begin_layout Standard
2698 Perform hue rotation of color <color> (default bright red), by <step> steps.
2699 The number of steps per full rotation is given by absolute value of <steps>.
2702 \begin_layout Standard
2703 If <steps> is negative, the rotation will be counterclockwise.
2706 \begin_layout Subsubsection
2707 gui.screenshot(string filename)
2710 \begin_layout Standard
2711 Saves a screenshot into specified file.
2714 \begin_layout Subsection
2718 \begin_layout Standard
2720 Only available in on_input callback.
2723 \begin_layout Subsubsection
2724 input.get(number controller, number index)
2727 \begin_layout Standard
2728 Read the specified index (0-11) from specified controller (0-7).
2732 \begin_layout Itemize
2733 Uses physical controller numbering.
2734 Gamepad in port 2 is controller 4, not 1!
2737 \begin_layout Subsubsection
2738 input.set(number controller, number index, number value)
2741 \begin_layout Standard
2742 Write the specified index (0-11) from specified controller (0-7), storing
2747 \begin_layout Itemize
2748 Uses physical controller numbering.
2749 Gamepad in port 2 is controller 4, not 1!
2752 \begin_layout Subsubsection
2753 input.geta(number controller)
2756 \begin_layout Standard
2757 Get input state for entiere controller.
2758 Returns 13 return values.
2761 \begin_layout Itemize
2762 1st return value: Bitmask: bit i is set if i:th index is nonzero
2765 \begin_layout Itemize
2766 2nd-13th return value: value of i:th index.
2769 \begin_layout Subsubsection
2770 input.seta(number controller, number bitmask, number args...)
2773 \begin_layout Standard
2774 Set state for entiere controller.
2775 args is up to 12 values for indices (overriding values in bitmask if specified).
2778 \begin_layout Subsubsection
2779 input.controllertype(number controller)
2782 \begin_layout Standard
2783 Get the type of controller as string.
2787 \begin_layout Itemize
2791 \begin_layout Itemize
2795 \begin_layout Itemize
2799 \begin_layout Itemize
2803 \begin_layout Subsubsection
2804 input.reset([number cycles])
2807 \begin_layout Standard
2809 If cycles is greater than zero, do delayed reset.
2810 0 (or no value) causes immediate reset.
2813 \begin_layout Itemize
2814 Only available with subframe flag false.
2817 \begin_layout Subsubsection
2821 \begin_layout Standard
2822 Returns table of tables of all available keys and axes.
2823 The first table is indexed by key name (platform-dependent!), and the inner
2824 table has the following fields:
2827 \begin_layout Itemize
2828 last_rawval: Last reported raw value for control.
2831 \begin_layout Itemize
2832 ktype: Type of key (disabled, key, mouse, axis, axis-inverse, hat, pressure-m0,
2833 pressure-mp, pressure-0m, pressure-0p, pressure-pm, pressure-p0).
2836 \begin_layout Itemize
2837 cal_left: Minimum calibration value.
2838 Only meaningful with axis and pressure types.
2841 \begin_layout Itemize
2842 cal_center: Center calibration value.
2843 Only meaningful with axis and pressure types.
2846 \begin_layout Itemize
2847 cal_right: Maximum calibration value.
2848 Only meaningful with axis and pressure types.
2851 \begin_layout Itemize
2852 cal_tolerance: Dead zone tolerance.
2853 Only meaningful with axis and pressure types.
2856 \begin_layout Subsubsection
2857 input.keyhook(string key, boolean state)
2860 \begin_layout Standard
2861 Requests that keyhook events to be sent for key (state=true) or not sent
2865 \begin_layout Subsubsection
2866 input.joyget(number controller)
2869 \begin_layout Standard
2870 Returns table for current controls for specified controller.
2871 The names of fields vary by controller type.
2874 \begin_layout Itemize
2875 The buttons have the same name as those are referred to in other contexts
2879 \begin_layout Itemize
2881 \begin_inset Quotes eld
2885 \begin_inset Quotes erd
2889 \begin_inset Quotes eld
2893 \begin_inset Quotes erd
2899 \begin_layout Subsubsection
2900 input.joyset(number controller, table controls)
2903 \begin_layout Standard
2904 Set the the state of specified controller to values specified in specified
2908 \begin_layout Subsubsection
2909 input.lcid_to_pcid(number controller)
2912 \begin_layout Standard
2913 Return the physical index, physical port and controller number in port for
2914 specified (1-based) logical controller.
2917 \begin_layout Subsection
2921 \begin_layout Standard
2925 \begin_layout Subsubsection
2926 subtitle.byindex(number i)
2929 \begin_layout Standard
2930 Read the frame and length of ith subtitle.
2931 Returns nothing if not present.
2934 \begin_layout Subsubsection
2935 subtitle.set(number f, number l, string txt)
2938 \begin_layout Standard
2939 Set the text of subtitle.
2942 \begin_layout Subsubsection
2943 subtitle.get(number f, number l)
2946 \begin_layout Standard
2947 Get the text of subtitle.
2950 \begin_layout Subsubsection
2951 subtitle.delete(number f, number l)
2954 \begin_layout Standard
2955 Delete specified subtitle.
2958 \begin_layout Subsection
2962 \begin_layout Standard
2963 Host memory handling (extra memory saved to savestates).
2964 Host memory starts empty.
2967 \begin_layout Subsubsection
2968 hostmemory.read(number address)
2971 \begin_layout Standard
2972 Reads hostmemory slot address.
2973 Slot numbers out of range return false instead of numeric.
2976 \begin_layout Subsubsection
2977 hostmemory.write(number address, number value)
2980 \begin_layout Standard
2981 Writes hostmemory slot with 0-255.
2982 Slot numbers out of range cause extension of host memory slot space.
2985 \begin_layout Subsubsection
2986 hostmemory.readbyte(number address)
2989 \begin_layout Standard
2990 Read unsigned byte (1 element) from given address.
2991 Slots out of range return false.
2994 \begin_layout Subsubsection
2995 hostmemory.writebyte(number address, number value)
2998 \begin_layout Standard
2999 Write unsigned byte (1 element) to given slot.
3000 Slot numbers out of range cause extension.
3003 \begin_layout Subsubsection
3004 hostmemory.readsbyte(number address)
3007 \begin_layout Standard
3008 Read signed byte (1 element) from given address.
3009 Slots out of range return false.
3012 \begin_layout Subsubsection
3013 hostmemory.writesbyte(number address, number value)
3016 \begin_layout Standard
3017 Write signed byte (1 element) to given slot.
3018 Slot numbers out of range cause extension.
3021 \begin_layout Subsubsection
3022 hostmemory.readword(number address)
3025 \begin_layout Standard
3026 Read unsigned word (2 elements) from given address.
3027 Slots out of range return false.
3030 \begin_layout Subsubsection
3031 hostmemory.writeword(number address, number value)
3034 \begin_layout Standard
3035 Write unsigned word (2 elements) to given slot.
3036 Slot numbers out of range cause extension.
3039 \begin_layout Subsubsection
3040 hostmemory.readsword(number address)
3043 \begin_layout Standard
3044 Read signed word (2 elements) from given address.
3045 Slots out of range return false.
3048 \begin_layout Subsubsection
3049 hostmemory.writesword(number address, number value)
3052 \begin_layout Standard
3053 Write signed word (2 elements) to given slot.
3054 Slot numbers out of range cause extension.
3057 \begin_layout Subsubsection
3058 hostmemory.readdword(number address)
3061 \begin_layout Standard
3062 Read unsigned doubleword (4 elements) from given address.
3063 Slots out of range return false.
3066 \begin_layout Subsubsection
3067 hostmemory.writedword(number address, number value)
3070 \begin_layout Standard
3071 Write unsigned doubleword (4 elements) to given slot.
3072 Slot numbers out of range cause extension.
3075 \begin_layout Subsubsection
3076 hostmemory.readsdword(number address)
3079 \begin_layout Standard
3080 Read signed doubleword (4 elements) from given address.
3081 Slots out of range return false.
3084 \begin_layout Subsubsection
3085 hostmemory.writesdword(number address, number value)
3088 \begin_layout Standard
3089 Write signed doubleword (4 elements) to given slot.
3090 Slot numbers out of range cause extension.
3093 \begin_layout Subsubsection
3094 hostmemory.readqword(number address)
3097 \begin_layout Standard
3098 Read unsigned quadword (8 elements) from given address.
3099 Slots out of range return false.
3102 \begin_layout Subsubsection
3103 hostmemory.writeqword(number address, number value)
3106 \begin_layout Standard
3107 Write unsigned quadword (4 elements) to given slot.
3108 Slot numbers out of range cause extension.
3111 \begin_layout Subsubsection
3112 hostmemory.readsqword(number address)
3115 \begin_layout Standard
3116 Read signed quadword (8 elements) from given address.
3117 Slots out of range return false.
3120 \begin_layout Subsubsection
3121 hostmemory.writesqword(number address, number value)
3124 \begin_layout Standard
3125 Write signed quadword (8 elements) to given slot.
3126 Slot numbers out of range cause extension.
3129 \begin_layout Subsection
3133 \begin_layout Standard
3137 \begin_layout Subsubsection
3138 movie.currentframe()
3141 \begin_layout Standard
3142 Return number of current frame.
3145 \begin_layout Subsubsection
3149 \begin_layout Standard
3150 Return number of frames in movie.
3153 \begin_layout Subsubsection
3157 \begin_layout Standard
3158 Return true if in readonly mode, false if in readwrite.
3161 \begin_layout Subsubsection
3165 \begin_layout Standard
3166 Returns the current value of rerecord count.
3169 \begin_layout Subsubsection
3170 movie.set_readwrite()
3173 \begin_layout Standard
3174 Set readwrite mode (does not cause on_readwrite callback).
3177 \begin_layout Subsubsection
3178 movie.frame_subframes(number frame)
3181 \begin_layout Standard
3182 Count number of subframes in specified frame (frame numbers are 1-based)
3186 \begin_layout Subsubsection
3187 movie.read_subframe(number frame, number subframe)
3190 \begin_layout Standard
3191 Read specifed subframe in specified frame and return data as array (100
3192 elements, numbered 0-99 currently).
3195 \begin_layout Subsubsection
3199 \begin_layout Standard
3200 Returns the current value of the RTC as a pair (second, subsecond).
3203 \begin_layout Subsubsection
3204 movie.unsafe_rewind([UNSAFEREWIND state])
3207 \begin_layout Standard
3208 Start setting point for unsafe rewind or jump to point of unsafe rewind.
3211 \begin_layout Itemize
3212 If called without argument, causes emulator to start process of setting
3213 unsafe rewind point.
3214 When this has finished, callback on_set_rewind occurs, passing the rewind
3215 state to lua script.
3218 \begin_layout Itemize
3219 If called with argument, causes emulator rewind to passed rewind point as
3221 Readwrite mode is implicitly activated.
3224 \begin_layout Standard
3225 The following warnings apply to unsafe rewinding:
3228 \begin_layout Itemize
3229 There are no safety checks against misuse (that's what
3230 \begin_inset Quotes eld
3234 \begin_inset Quotes erd
3240 \begin_layout Itemize
3241 Only call rewind from timeline rewind point was set from.
3244 \begin_layout Itemize
3245 Only call rewind from after the rewind point was set.
3248 \begin_layout Subsection
3252 \begin_layout Standard
3253 Routines for settings manipulation
3256 \begin_layout Subsubsection
3257 settings.get(string name)
3260 \begin_layout Standard
3261 Get value of setting.
3262 If setting is blank, returns false.
3263 If setting value can't be obtained, returns (nil, error message).
3266 \begin_layout Subsubsection
3267 settings.set(string name, string value)
3270 \begin_layout Standard
3271 Set value of setting.
3272 If setting can't be set, returns (nil, error message).
3275 \begin_layout Subsubsection
3276 settings.is_set(string name)
3279 \begin_layout Standard
3280 Returns if setting is set.
3281 If setting does not exist, returns (nil, error message).
3284 \begin_layout Subsubsection
3285 settings.blank(string name)
3288 \begin_layout Standard
3289 Blanks a setting and returns true.
3290 If setting can't be blanked, returns (nil, error message).
3293 \begin_layout Subsection
3297 \begin_layout Standard
3298 Contains various functions for managing memory
3301 \begin_layout Subsubsection
3305 \begin_layout Standard
3306 Returns the number of VMAs
3309 \begin_layout Subsubsection
3310 memory.read_vma(number index)
3313 \begin_layout Standard
3314 Reads the specified VMA (indices start from zero).
3315 Trying to read invalid VMA gives nil.
3316 The read VMA is table with the following fields:
3319 \begin_layout Itemize
3320 region_name (string): The readable name of the VMA
3323 \begin_layout Itemize
3324 baseaddr (number): Base address of the VMA
3327 \begin_layout Itemize
3328 lastaddr (number): Last address in the VMA.
3331 \begin_layout Itemize
3332 size (number): The size of VMA in bytes.
3335 \begin_layout Itemize
3336 readonly (boolean): True of the VMA corresponds to ROM.
3339 \begin_layout Itemize
3340 iospace (boolean): True if the VMA is I/O space.
3343 \begin_layout Itemize
3344 native_endian (boolean): True if the VMA has native endian as opposed to
3348 \begin_layout Subsubsection
3349 memory.find_vma(number address)
3352 \begin_layout Standard
3353 Finds the VMA containing specified address.
3354 Returns table in the same format as read_vma or nil if not found.
3357 \begin_layout Subsubsection
3358 memory.readbyte(number address)
3361 \begin_layout Standard
3362 Reads the specified address as unsigned byte and returns the result.
3365 \begin_layout Subsubsection
3366 memory.readsbyte(number address)
3369 \begin_layout Standard
3370 Reads the specified address as signed byte and returns the result.
3373 \begin_layout Subsubsection
3374 memory.writebyte(number address, number value)
3377 \begin_layout Standard
3378 Writes the specified value (negative values undergo 2's complement) to specified
3379 address (as a byte).
3382 \begin_layout Subsubsection
3383 memory.readword(number address)
3386 \begin_layout Standard
3387 Reads the specified address as unsigned word and returns the result.
3390 \begin_layout Subsubsection
3391 memory.readsword(number address)
3394 \begin_layout Standard
3395 Reads the specified address as signed word and returns the result.
3398 \begin_layout Subsubsection
3399 memory.writeword(number address, number value)
3402 \begin_layout Standard
3403 Writes the specified value (negative values undergo 2's complement) to specified
3404 address (as a word).
3407 \begin_layout Subsubsection
3408 memory.readdword(number address)
3411 \begin_layout Standard
3412 Reads the specified address as unsigned doubleword and returns the result.
3415 \begin_layout Subsubsection
3416 memory.readsdword(number address)
3419 \begin_layout Standard
3420 Reads the specified address as signed doubleword and returns the result.
3423 \begin_layout Subsubsection
3424 memory.writedword(number address, number value)
3427 \begin_layout Standard
3428 Writes the specified value (negative values undergo 2's complement) to specified
3429 address (as a doubleword).
3432 \begin_layout Subsubsection
3433 memory.readqword(number address)
3436 \begin_layout Standard
3437 Reads the specified address as unsigned quadword and returns the result.
3440 \begin_layout Subsubsection
3441 memory.readsqword(number address)
3444 \begin_layout Standard
3445 Reads the specified address as signed quadword and returns the result.
3448 \begin_layout Subsubsection
3449 memory.writeqword(number address, number value)
3452 \begin_layout Standard
3453 Writes the specified value (negative values undergo 2's complement) to specified
3454 address (as a quadword).
3457 \begin_layout Subsubsection
3458 memory.hash_region(number base, number size)
3461 \begin_layout Standard
3462 Hash specified number of bytes starting from specified address and return
3466 \begin_layout Subsubsection
3470 \begin_layout Standard
3471 Hash the current system state.
3472 Mainly useful for debugging savestates.
3475 \begin_layout Subsubsection
3476 memory.readregion(number base, number size)
3479 \begin_layout Standard
3480 Read a region of memory.
3483 \begin_layout Itemize
3484 Warning: If the region crosses VMA boundary, the results are undefined.
3487 \begin_layout Subsubsection
3488 memory.map<type>([number base, number size])
3491 \begin_layout Standard
3492 Returns a table mapping specified memory aperture for read/write.
3493 If parameters are omitted, entiere map space is the aperture.
3496 \begin_layout Itemize
3497 Type may be one of: byte, sbyte, word, sword, dword, sdword, qword or sqword.
3500 \begin_layout Subsubsection
3501 memory.writeregion(number base, number size, table data)
3504 \begin_layout Standard
3505 Write a region of memory.
3508 \begin_layout Itemize
3509 Warning: If the region crosses VMA boundary, the results are undefined.
3512 \begin_layout Subsubsection
3516 \begin_layout Standard
3517 Returns a new mapping structure (MMAP_STRUCT)
3520 \begin_layout Subsubsection
3521 MMAP_STRUCT(string key, number address, string type)
3524 \begin_layout Standard
3525 Bind key in mmap structure to specified address with specified type.
3528 \begin_layout Itemize
3529 Type may be one of: byte, sbyte, word, sword, dword, sdword, qword or sqword.
3532 \begin_layout Subsubsection
3533 memory.read_expr(string expr)
3536 \begin_layout Standard
3537 Evaluate specified watch expression and return result
3540 \begin_layout Subsection
3544 \begin_layout Standard
3545 Contains functions for manipulating subtitles.
3548 \begin_layout Subsubsection
3549 subtitle.byindex(number index)
3552 \begin_layout Standard
3553 Get (basetime, length) pair of specified subtitle index or nothing if index
3557 \begin_layout Subsubsection
3558 subtitle.get(number basetime, number length)
3561 \begin_layout Standard
3562 Read the specified subtitle.
3564 \begin_inset Quotes eld
3568 \begin_inset Quotes erd
3571 if the subtitle does not exist.
3574 \begin_layout Subsubsection
3575 subtitle.set(number basetime, number length, string content)
3578 \begin_layout Standard
3579 Set the specified subtitle.
3582 \begin_layout Subsubsection
3583 subtitle.deltete(number basetime, number length)
3586 \begin_layout Standard
3587 Delete the specified subtitle.
3590 \begin_layout Subsection
3594 \begin_layout Standard
3595 Contains copy of global variables from time of Lua initialization.
3599 \begin_layout Subsection
3603 \begin_layout Standard
3604 Various callbacks to Lua that can occur.
3607 \begin_layout Subsubsection
3608 Callback: on_paint(bool not_synth)
3611 \begin_layout Standard
3612 Called when screen is being painted.
3613 Any gui.* calls requiring graphic context draw on the screen.
3616 \begin_layout Standard
3617 not_synth is true if this hook is being called in response to received frame,
3621 \begin_layout Subsubsection
3622 Callback: on_video()
3625 \begin_layout Standard
3626 Called when video dump frame is being painted.
3627 Any gui.* calls requiring graphic context draw on the video.
3630 \begin_layout Subsubsection
3631 Callback: on_frame_emulated()
3634 \begin_layout Standard
3635 Called when emulating frame has completed and on_paint()/on_video() calls
3636 are about to be issued.
3639 \begin_layout Subsubsection
3640 Callback: on_frame()
3643 \begin_layout Standard
3644 Called on each starting whole frame.
3647 \begin_layout Subsubsection
3648 Callback: on_startup()
3651 \begin_layout Standard
3652 Called when the emulator is starting (lsnes.rc and --run files has been run).
3655 \begin_layout Subsubsection
3656 Callback: on_rewind()
3659 \begin_layout Standard
3660 Called when rewind movie to beginning has completed.
3663 \begin_layout Subsubsection
3664 Callback: on_pre_load(string name)
3667 \begin_layout Standard
3668 Called just before savestate/movie load occurs (note: loads are always delayed,
3669 so this occurs even when load was initiated by lua).
3672 \begin_layout Subsubsection
3673 Callback: on_err_load(string name)
3676 \begin_layout Standard
3677 Called if loadstate goes wrong.
3680 \begin_layout Subsubsection
3681 Callback: on_post_load(string name, boolean was_savestate)
3684 \begin_layout Standard
3685 Called on successful loadstate.
3686 was_savestate gives if this was a savestate or a movie.
3689 \begin_layout Subsubsection
3690 Callback: on_pre_save(string name, boolean is_savestate)
3693 \begin_layout Standard
3694 Called just before savestate save occurs (note: movie saves are synchronous
3695 and won't trigger these callbacks if called from Lua).
3698 \begin_layout Subsubsection
3699 Callback: on_err_save(string name)
3702 \begin_layout Standard
3703 Called if savestate goes wrong.
3706 \begin_layout Subsubsection
3707 Callback: on_post_save(string name, boolean is_savestate)
3710 \begin_layout Standard
3711 Called on successful savaestate.
3712 is_savestate gives if this was a savestate or a movie.
3715 \begin_layout Subsubsection
3719 \begin_layout Standard
3720 Called when emulator is shutting down.
3723 \begin_layout Subsubsection
3724 Callback: on_input(boolean subframe)
3727 \begin_layout Standard
3728 Called when emulator is just sending input to bsnes core.
3729 Warning: This is called even in readonly mode, but the results are ignored.
3732 \begin_layout Subsubsection
3733 Callback: on_reset()
3736 \begin_layout Standard
3737 Called when SNES is reset.
3740 \begin_layout Subsubsection
3741 Callback: on_readwrite()
3744 \begin_layout Standard
3745 Called when moving into readwrite mode as result of
3746 \begin_inset Quotes eld
3750 \begin_inset Quotes erd
3753 command (note: moving to rwmode by Lua won't trigger this, as per recursive
3757 \begin_layout Subsubsection
3758 Callback: on_snoop(number port, number controller, number index, number
3762 \begin_layout Standard
3763 Called each time bsnes asks for input.
3764 The value is the final value to be sent to bsnes core (readonly mode, autohold
3765 and autofire have been taken into account).
3766 Might be useful when translating movies to format suitable for console
3768 Note: There is no way to modify the value to be sent.
3771 \begin_layout Subsubsection
3772 Callback: on_keyhook(string keyname, table state)
3775 \begin_layout Standard
3776 Sent when key that has keyhook events requested changes state.
3777 Keyname is name of the key (group) and state is the state (same kind as
3778 table values in input.raw).
3781 \begin_layout Subsubsection
3785 \begin_layout Standard
3786 Called when requested by set_idle_timeout(), the timeout has expired and
3787 emulator is waiting.
3790 \begin_layout Subsubsection
3791 Callback: on_timer()
3794 \begin_layout Standard
3795 Called when requested by set_idle_timeout() and the timeout has expired
3796 (regardless if emulator is waiting).
3799 \begin_layout Subsubsection
3800 Callback: on_set_rewind(UNSAFEREWIND r)
3803 \begin_layout Standard
3804 Called when unsafe rewind object has been constructed.
3807 \begin_layout Subsubsection
3808 Callback: on_pre_rewind()
3811 \begin_layout Standard
3812 Called just before unsafe rewind is about to occur.
3815 \begin_layout Subsubsection
3816 Callback: on_post_rewind()
3819 \begin_layout Standard
3820 Called just after unsafe rewind has occured.
3823 \begin_layout Section
3824 Memory watch expression syntax
3827 \begin_layout Standard
3828 Memory watch expressions are in RPN (Reverse Polish Notation).
3829 At the end of expression, the top entry on stack is taken as the final
3833 \begin_layout Standard
3837 \begin_layout Itemize
3838 Evaluation order is strictly left to right.
3841 \begin_layout Itemize
3842 a is the entry on top of stack
3845 \begin_layout Itemize
3846 b is the entry immediately below top of stack
3849 \begin_layout Itemize
3850 ; separates values to be pushed (no intermediate pop).
3853 \begin_layout Itemize
3854 After end of element, all used stack slots are popped and all results are
3858 \begin_layout Itemize
3859 When pushing multiple values, the pushes occur in order shown.
3862 \begin_layout Standard
3863 The following operators are available:
3866 \begin_layout Itemize
3870 \begin_layout Itemize
3874 \begin_layout Itemize
3878 \begin_layout Itemize
3882 \begin_layout Itemize
3886 \begin_layout Itemize
3890 \begin_layout Itemize
3891 b : read_signed_byte(a)
3894 \begin_layout Itemize
3898 \begin_layout Itemize
3899 d : read_signed_dword(a)
3902 \begin_layout Itemize
3906 \begin_layout Itemize
3908 \begin_inset Formula $\pi$
3914 \begin_layout Itemize
3915 q : read_signed_qword(a)
3918 \begin_layout Itemize
3922 \begin_layout Itemize
3926 \begin_layout Itemize
3930 \begin_layout Itemize
3934 \begin_layout Itemize
3935 w : read_signed_word(a)
3938 \begin_layout Itemize
3942 \begin_layout Itemize
3943 B : read_unsigned_byte(a)
3946 \begin_layout Itemize
3947 C<number>z : Push number <number> to stack.
3950 \begin_layout Itemize
3951 D : read_unsigned_dword(a)
3954 \begin_layout Itemize
3955 C0x<number>z : Push number <number> (hexadecimal) to stack.
3958 \begin_layout Itemize
3959 Q : read_unsigned_qword(a)
3962 \begin_layout Itemize
3963 R<digit> : round a to <digit> digits.
3966 \begin_layout Itemize
3967 W : read_unsigned_word(a)
3970 \begin_layout Subsection
3974 \begin_layout Standard
3975 C0x007e0878zWC0x007e002czW-
3978 \begin_layout Enumerate
3979 Push value 0x7e0878 on top of stack (C0x007e0878z).
3982 \begin_layout Enumerate
3983 Pop the value on top of stack (0x7e0878), read word value at that address
3984 and push the result,call it x1 (W).
3987 \begin_layout Enumerate
3988 Push value 0x7e002c on top of stack (C0x007e002cz).
3991 \begin_layout Enumerate
3992 Pop the value on top of stack (0x7e002c), read word value at that address
3993 and push the result,call it x2 (W).
3996 \begin_layout Enumerate
3997 Pop the two top numbers on stack, x1 and x2, substract x1 from x2 and push
4001 \begin_layout Enumerate
4002 Since the expression ends, the final memory watch result is the top one
4003 on stack, which is x2 - x1.
4006 \begin_layout Section
4007 Modifier and key names:
4010 \begin_layout Subsection
4014 \begin_layout Subsubsection
4018 \begin_layout Standard
4019 Following modifier names are known:
4022 \begin_layout Itemize
4023 ctrl, lctrl, rctrl: Control keys
4026 \begin_layout Itemize
4027 alt, lalt, ralt: ALT keys.
4030 \begin_layout Itemize
4031 shift, lshift, rshift: Shift keys.
4034 \begin_layout Itemize
4035 meta, lmeta, rmeta: Meta keys.
4038 \begin_layout Itemize
4039 num, caps: Numlock/Capslock (these are sticky!)
4042 \begin_layout Itemize
4046 \begin_layout Subsubsection
4050 \begin_layout Standard
4051 Following key names are known:
4054 \begin_layout Itemize
4055 backspace, tab, clear, return, pause, escape, space, exclaim, quotedbl,
4056 hash, dollar, ampersand, quote, leftparen, rightparen, asterisk, plus,
4057 comma, minus, period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon,
4058 less, equals, greater, question, at, leftbracket, backslash, rightbracket,
4059 caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n,
4060 o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0, world_1, world_2,
4061 world_3, world_4, world_5, world_6, world_7, world_8, world_9, world_10,
4062 world_11, world_12, world_13, world_14, world_15, world_16, world_17, world_18,
4063 world_19, world_20, world_21, world_22, world_23, world_24, world_25, world_26,
4064 world_27, world_28, world_29, world_30, world_31, world_32, world_33, world_34,
4065 world_35, world_36, world_37, world_38, world_39, world_40, world_41, world_42,
4066 world_43, world_44, world_45, world_46, world_47, world_48, world_49, world_50,
4067 world_51, world_52, world_53, world_54, world_55, world_56, world_57, world_58,
4068 world_59, world_60, world_61, world_62, world_63, world_64, world_65, world_66,
4069 world_67, world_68, world_69, world_70, world_71, world_72, world_73, world_74,
4070 world_75, world_76, world_77, world_78, world_79, world_80, world_81, world_82,
4071 world_83, world_84, world_85, world_86, world_87, world_88, world_89, world_90,
4072 world_91, world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3, kp4,
4073 kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide, kp_multiply, kp_minus, kp_plus,
4074 kp_enter, kp_equals, up, down, right, left, insert, home, end, pageup,
4075 pagedown, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14,
4076 f15, numlock, capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt,
4077 lalt, rmeta, lmeta, lsuper, rsuper, mode, compose, help, print, sysreq,
4078 break, menu, power, euro, undo
4081 \begin_layout Itemize
4082 Names of form 'key<n>' where <n> is 0-255 are interpretted as key having
4083 hardware-dependent scan code of <n> (useful to bind those keys that don't
4084 have symbolic names).
4087 \begin_layout Subsubsection
4088 Joystick pseudo-keys:
4091 \begin_layout Itemize
4092 joystick<num>button<button>: Joystick <num> (0-based) button <button> (0-based).
4095 \begin_layout Itemize
4096 joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat> (0-based) up.
4099 \begin_layout Itemize
4100 joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat> (0-based) left.
4103 \begin_layout Itemize
4104 joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat> (0-based) down.
4107 \begin_layout Itemize
4108 joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat> (0-based) right.
4111 \begin_layout Itemize
4112 joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis> negative
4113 position (axis modes axis and axis_inverse).
4116 \begin_layout Itemize
4117 joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis> positive
4118 position (axis modes axis and axis_inverse).
4121 \begin_layout Itemize
4122 joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis> pressure (axis
4126 \begin_layout Subsubsection
4130 \begin_layout Itemize
4131 Escape: Enter/Exit Command mode, cancel modal dialogs.
4134 \begin_layout Itemize
4135 Return (also KPEnter): Execute command, ok modal dialog.
4138 \begin_layout Itemize
4139 Pgup/Up (also KP8/9 if no num lock, CTRL+P; command mode): Previous command
4143 \begin_layout Itemize
4144 Pgdn/Down(also KP2/3 if no num lock, CTRL+N; command mode): Next command
4148 \begin_layout Itemize
4149 Home (also KP7 if no num lock, CTRL+A; command mode): Beginning of command.
4152 \begin_layout Itemize
4153 End (also KP1 if no num lock, CTRL+E; command mode): End of command.
4156 \begin_layout Itemize
4157 Left (also KP4 if no num lock, CTRL+B; command mode): Move cursor left.
4160 \begin_layout Itemize
4161 Right (also KP6 if no num lock, CTRL+F; command mode): Move cursor right.
4164 \begin_layout Itemize
4166 if no num lock; command mode): Delete character to right of cursor.
4169 \begin_layout Itemize
4170 Insert (also KP0 if no num lock; command mode): Toggle between insert /
4174 \begin_layout Itemize
4175 Backspace (command mode): Delete character to left of cursor.
4178 \begin_layout Itemize
4179 CTRL+LEFT (also ALT+B; command mode): Previous word.
4182 \begin_layout Itemize
4183 CTRL+RIGHT (also ALT+F; command mode): Next word.
4186 \begin_layout Itemize
4187 ALT+D (also CTRL+W; command mode): Delete word.
4190 \begin_layout Itemize
4191 LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump corrupted!).
4194 \begin_layout Subsection
4198 \begin_layout Subsubsection
4202 \begin_layout Standard
4203 Following modifier names are known:
4206 \begin_layout Itemize
4210 \begin_layout Itemize
4214 \begin_layout Itemize
4218 \begin_layout Itemize
4222 \begin_layout Itemize
4226 \begin_layout Subsubsection
4230 \begin_layout Standard
4231 Following key names are known:
4234 \begin_layout Itemize
4235 back, tab, return, escape, space, exclaim, quotedbl, hash, dollar, percent,
4236 ampersand, quote, leftparen, rightparen, asterisk, plus, comma, minus,
4237 period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
4238 greater, question, at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
4239 q, r, s, t, u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
4240 underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
4241 q, r, s, t, u, v, w, x, y, z, leftcurly, pipe, rightcurly, tilde, delete,
4242 start, lbutton, rbutton, cancel, mbutton, clear, shift, alt, control, menu,
4243 pause, capital, end, home, lefT, up, right, down, select, print, execute,
4244 snapshot, insert, help, numpad0, numpad1, numpad2, numpad3, numpad4, numpad5,
4245 numpad6, numpad7, numpad8, numpad9, multiply, add, separator, subtract,
4246 decimal, divide, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13,
4247 f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, numlock, scroll,
4248 pageup, pagedown, numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
4249 numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up, numpad_right,
4250 numpad_down, numpad_pageup, numpad_pagedown, numpad_end, numpad_begin,
4251 numpad_insert, numpad_delete, numpad_equal, numpad_multiply, numpad_add,
4252 numpad_separator, numpad_subtract, numpad_decimal, numpad_divide, windows_left,
4253 windows_right, windows_menu, command, special1, special2, special3, special4,
4254 special5, special6, special7, special8, special9, special10, special11,
4255 special12, special13, special14, special15, special16, special17, special18,
4256 special19, special20
4259 \begin_layout Section
4263 \begin_layout Standard
4264 Movie file is .zip archive in itself, normal ZIP archive tools work on it
4265 (note: If you recompress it, do not use compression methods other than
4266 store and deflate and especially do not use encryption of any kind).
4269 \begin_layout Subsection
4270 Detecting clean start/SRAM/Savestate
4273 \begin_layout Itemize
4275 \begin_inset Quotes eld
4279 \begin_inset Quotes erd
4282 it is savestate, otherwise:
4285 \begin_layout Itemize
4286 If file has members with names starting
4287 \begin_inset Quotes eld
4291 \begin_inset Quotes erd
4294 it is movie starting from SRAM, otherwise:
4297 \begin_layout Itemize
4298 It is movie starting from clear state.
4301 \begin_layout Subsection
4305 \begin_layout Standard
4306 Type of game ROM and region (as one line).
4310 \begin_layout Standard
4311 \begin_inset Tabular
4312 <lyxtabular version="3" rows="8" columns="3">
4313 <features tabularvalignment="middle">
4314 <column alignment="center" valignment="top" width="0">
4315 <column alignment="center" valignment="top" width="0">
4316 <column alignment="center" valignment="top" width="0">
4318 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4321 \begin_layout Plain Layout
4327 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4330 \begin_layout Plain Layout
4336 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4339 \begin_layout Plain Layout
4347 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4350 \begin_layout Plain Layout
4356 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4359 \begin_layout Plain Layout
4365 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4368 \begin_layout Plain Layout
4376 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4379 \begin_layout Plain Layout
4385 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4388 \begin_layout Plain Layout
4394 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4397 \begin_layout Plain Layout
4405 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4408 \begin_layout Plain Layout
4414 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4417 \begin_layout Plain Layout
4423 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4426 \begin_layout Plain Layout
4434 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4437 \begin_layout Plain Layout
4443 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4446 \begin_layout Plain Layout
4452 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4455 \begin_layout Plain Layout
4463 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4466 \begin_layout Plain Layout
4472 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4475 \begin_layout Plain Layout
4481 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4484 \begin_layout Plain Layout
4492 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4495 \begin_layout Plain Layout
4501 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4504 \begin_layout Plain Layout
4510 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4513 \begin_layout Plain Layout
4521 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4524 \begin_layout Plain Layout
4530 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4533 \begin_layout Plain Layout
4539 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4542 \begin_layout Plain Layout
4556 \begin_layout Standard
4560 \begin_layout Standard
4561 \begin_inset Tabular
4562 <lyxtabular version="3" rows="3" columns="2">
4563 <features tabularvalignment="middle">
4564 <column alignment="center" valignment="top" width="0">
4565 <column alignment="center" valignment="top" width="0">
4567 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4570 \begin_layout Plain Layout
4576 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4579 \begin_layout Plain Layout
4587 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4590 \begin_layout Plain Layout
4596 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4599 \begin_layout Plain Layout
4607 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4610 \begin_layout Plain Layout
4616 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4619 \begin_layout Plain Layout
4633 \begin_layout Subsection
4637 \begin_layout Standard
4638 Contains type of port #1 (as one line).
4639 Valid values are 'none', 'gamepad', 'multitap' and 'mouse'.
4640 If not present, defaults to 'gamepad'.
4643 \begin_layout Subsection
4647 \begin_layout Standard
4648 Contains type of port #2 (as one line).
4649 Valid values are 'none', 'gamepad', 'multitap', 'mouse', 'superscope',
4650 'justifier' and 'justifiers'.
4651 If not present, defaults to 'none'.
4654 \begin_layout Subsection
4658 \begin_layout Standard
4659 Contains name of the game (as one line).
4662 \begin_layout Subsection
4666 \begin_layout Standard
4667 Contains authors, one per line.
4668 Part before '|' is the full name, part after is the nickname.
4671 \begin_layout Subsection
4675 \begin_layout Standard
4677 \begin_inset Quotes eld
4681 \begin_inset Quotes erd
4685 Used to reject other saves.
4688 \begin_layout Subsection
4689 Member: controlsversion
4692 \begin_layout Standard
4694 \begin_inset Quotes eld
4698 \begin_inset Quotes erd
4702 Used to identify what controls are there.
4705 \begin_layout Subsection
4707 \begin_inset Quotes eld
4711 \begin_inset Quotes erd
4717 \begin_layout Standard
4718 Contains bsnes core version number (as one line).
4721 \begin_layout Subsection
4725 \begin_layout Standard
4726 Contains project ID (as one line).
4727 Used to identify if two movies are part of the same project.
4730 \begin_layout Subsection
4731 Member: {rom,slota,slotb}{,xml}.sha256
4734 \begin_layout Standard
4735 Contains SHA-256 of said ROM or ROM mapping file (as one line).
4736 Absent if corresponding file is absent.
4739 \begin_layout Subsection
4740 Member: moviesram.<name>
4743 \begin_layout Standard
4744 Raw binary startup SRAM of kind <name>.
4745 Only present in savestates and movies starting from SRAM.
4748 \begin_layout Subsection
4752 \begin_layout Standard
4753 Contains frame number (as one line) of frame movie was saved on.
4754 Only present in savestates.
4757 \begin_layout Subsection
4761 \begin_layout Standard
4762 Current value of lag counter (as one line).
4763 Only present in savestates.
4766 \begin_layout Subsection
4767 Member: pollcounters
4770 \begin_layout Standard
4771 Contains poll counters (currently 100 of them), one per line.
4772 Each line is raw poll count if DRDY is set for it.
4773 Otherwise it is negative poll count minus one.
4774 Only present in savestates.
4777 \begin_layout Subsection
4781 \begin_layout Standard
4782 Raw binary dump of host memory.
4783 Only present in savestates.
4786 \begin_layout Subsection
4790 \begin_layout Standard
4791 The raw binary savestate itself.
4792 Savestate detection uses this file, only present in savestates.
4795 \begin_layout Subsection
4799 \begin_layout Standard
4800 Screenshot of current frame.
4801 Only present in savestates.
4802 First 2 bytes are big-endian width of image, rest are 24-bit RGB image
4804 Height of image is inferred from the width and size of data.
4807 \begin_layout Subsection
4811 \begin_layout Standard
4812 Raw binary SRAM of kind <name> at time of savestate.
4813 Only present in savestates.
4816 \begin_layout Subsection
4820 \begin_layout Standard
4821 The actual input track, one line per subframe (blank lines are skipped).
4824 \begin_layout Itemize
4825 If the first byte of each line is '.', ' ', <tab> or '|', then the line is
4826 part of same frame as previous, otherwise it starts a new frame.
4829 \begin_layout Itemize
4830 First subframe must start a new frame.
4833 \begin_layout Standard
4834 Length of movie in frames is number of lines in input file that start a
4838 \begin_layout Subsection
4842 \begin_layout Standard
4847 \begin_layout Itemize
4848 Each line is in form <firstframe> <numframes> <text>.
4851 \begin_layout Itemize
4852 Linefeed is encoded as
4854 n, backslash is encoded as
4861 \begin_layout Subsection
4865 \begin_layout Standard
4866 Contains textual base-10 rerecord count (as one line; emulator just writes
4867 this, it doesn't read it) + 1.
4870 \begin_layout Subsection
4874 \begin_layout Standard
4875 This member stores set of load IDs.
4876 There is one load ID per rerecord (plus one corresponding to start of project).
4879 \begin_layout Itemize
4880 This member constists of concatenation of records
4883 \begin_layout Itemize
4884 Each record is 2-36 bytes long and can represent 1-16,843,009 consequtive
4888 \begin_layout Itemize
4889 IDs are interpretted as 256-bit big-endian integers with warparound.
4892 \begin_layout Itemize
4893 Initial predicted ID is all zeroes.
4896 \begin_layout Standard
4897 Format of each record is:
4900 \begin_layout Itemize
4901 1 byte: Opcode byte.
4902 Bits 0-4 are prefix length (prefixlen), bits 5-6 are count length (countlen).
4906 \begin_layout Itemize
4907 32-prefixlen bytes of ID.
4910 \begin_layout Itemize
4911 countlen bytes of big-endian count (count).
4914 \begin_layout Standard
4915 Records are processed as follows:
4918 \begin_layout Itemize
4919 To form the first ID encoded by record, take the first prefixlen bytes predicted
4920 ID and append the read ID value to it.
4921 The result is the first ID encoded.
4924 \begin_layout Itemize
4925 If countlen is 0, record encodes 1 ID.
4928 \begin_layout Itemize
4929 If countlen is 1, record encodes 2+count IDs.
4932 \begin_layout Itemize
4933 If countlen is 2, record encodes 258+count IDs.
4936 \begin_layout Itemize
4937 If countlen is 3, record encodes 65794+count IDs.
4940 \begin_layout Itemize
4941 The new predicted ID is the next ID after last one encoded by the record.
4944 \begin_layout Standard
4945 The number of rerecords + 1 is equal to the sum of number of IDs encoded
4949 \begin_layout Subsection
4950 Member: starttime.second
4953 \begin_layout Standard
4954 Movie starting time, second part.
4955 Epoch is Unix epoch.
4956 Default is 1,000,000,000.
4959 \begin_layout Subsection
4960 Member: starttime.subsecond
4963 \begin_layout Standard
4964 Movie starting time, subsecond part.
4969 \begin_layout Subsection
4970 Member: savetime.second
4973 \begin_layout Standard
4974 Movie saving time, second part.
4975 Default is starttime.second.
4976 Only present in savestates.
4979 \begin_layout Subsection
4980 Member: savetime.subsecond
4983 \begin_layout Standard
4984 Movie saving time, subsecond part.
4985 Default is starttime.subsecond.
4986 Only present in savestates.
4989 \begin_layout Section
4990 lsvs file format (commentary tracks)
4993 \begin_layout Subsection
4997 \begin_layout Itemize
4998 Each cluster is 8kB (8192 bytes) in size.
5001 \begin_layout Itemize
5002 Cluster n starts at offset 8192*n in file.
5005 \begin_layout Itemize
5006 The following clusters are system special:
5010 \begin_layout Itemize
5011 Cluster 0 and all clusters with number multiple of 2048 (cluster tables)
5014 \begin_layout Itemize
5015 Cluster 1 (superblock)
5019 \begin_layout Subsection
5023 \begin_layout Itemize
5024 The cluster table describing cluster n is stored in cluster n & ~0x7FF (zero
5028 \begin_layout Itemize
5029 This cluster table consists of 2048 4-byte big-endian integers.
5032 \begin_layout Itemize
5033 Each entry describes a cluster in 16MB supercluster, in order.
5036 \begin_layout Itemize
5037 The valid values for entries are:
5041 \begin_layout Itemize
5042 0x00000000: Free cluster
5045 \begin_layout Itemize
5046 0x00000001: Last cluster in chain.
5049 \begin_layout Itemize
5050 0xFFFFFFFF: System cluster (cluster tables and superblock)
5053 \begin_layout Itemize
5054 (anything else): Number of next cluster in chain.
5055 Must not be multiple of 2048.
5059 \begin_layout Itemize
5060 Due to limitations of the format, there can be at most 2097052 superclusters,
5061 giving maximum file size of 16TB.
5064 \begin_layout Subsection
5068 \begin_layout Itemize
5069 The stream table chain always starts in cluster 2.
5072 \begin_layout Itemize
5073 Otherwise, it follows normal chaining.
5076 \begin_layout Itemize
5077 The stream table consists of 16-byte entries:
5081 \begin_layout Itemize
5082 The first 8 bytes of entry give big-endian beginning position of stream
5083 in units of 1/48000 s.
5086 \begin_layout Itemize
5087 The next 4 bytes of entry give big-endian beginning cluster for control
5089 0 here marks the entry as not present.
5092 \begin_layout Itemize
5093 The last 4 bytes of entry give big-endian beginning cluster for codec data.
5097 \begin_layout Itemize
5098 Stream table clusters are normal clusters, following normal chaining.
5101 \begin_layout Itemize
5102 The stream begnning position is not guarenteed unique.
5103 There can be multiple streams with the same starting position in the file.
5106 \begin_layout Subsection
5110 \begin_layout Itemize
5111 The stream control data consists of entries 4 bytes each:
5115 \begin_layout Itemize
5116 The first 2 bytes of entry gives big-endian length of packet
5119 \begin_layout Itemize
5120 The next byte of entry gives audio length of packet in units of 1/400 s.
5123 \begin_layout Itemize
5124 The last byte is control byte.
5128 \begin_layout Itemize
5129 0 means this entry is not present and the control data ends.
5132 \begin_layout Itemize
5133 1 is valid control entry.
5138 \begin_layout Itemize
5139 The stream control data can also end by running into end of the readable
5144 \begin_layout Itemize
5145 This happens if there happens to be exact multiple of 2048 packets in stream
5146 and number of packets is nonzero.
5150 \begin_layout Itemize
5151 These clusters follow normal chaining.
5154 \begin_layout Subsection
5158 \begin_layout Itemize
5159 Stream codec data consists of raw Opus data packets packed back to back
5160 with nothing in between.
5163 \begin_layout Itemize
5164 Warning: Due to internal limitations, this data must reside in the first
5165 65536 superclusters (that is, the first 1TB of the file).
5168 \begin_layout Subsection
5172 \begin_layout Itemize
5173 The superblock is stored in cluster 1.
5177 \begin_layout Itemize
5178 The first 11 bytes are
5179 \begin_inset Quotes eld
5183 \begin_inset Quotes erd
5189 \begin_layout Itemize
5190 The rest are unused.
5193 \begin_layout Itemize
5194 This cluster 1 is marked as system special.
5197 \begin_layout Section
5198 Known ROM extensions
5201 \begin_layout Itemize
5202 SNES cartridge ROMs: sfc, smc, swc, fig, ufo, sf2, gd3, gd7, dx2, mgd, mgh.
5205 \begin_layout Itemize
5206 DMG cartridge ROMs: dmg, gb.
5209 \begin_layout Itemize
5210 GBC cartridge ROMs: cgb, gbc.
5213 \begin_layout Section
5217 \begin_layout Itemize
5218 The first line must be:
5219 \begin_inset Quotes eld
5223 \begin_inset Quotes erd
5229 \begin_layout Itemize
5230 There is one needed line:
5231 \begin_inset Quotes eld
5235 \begin_inset Quotes erd
5239 This sets system type to <systype>.
5240 The following system types are valid:
5244 \begin_layout Itemize
5248 \begin_layout Itemize
5249 bsx (BS-X non-slotted)
5252 \begin_layout Itemize
5253 bsxslotted (BS-X slotted)
5256 \begin_layout Itemize
5257 sufamiturbo (Sufami Turbo)
5260 \begin_layout Itemize
5261 sgb (Super Game Boy)
5264 \begin_layout Itemize
5268 \begin_layout Itemize
5269 gbc (Game Boy Color)
5272 \begin_layout Itemize
5273 gbc_gba (Game Boy Color with GBA initial register values)
5277 \begin_layout Itemize
5278 Optionally a region can be specified:
5279 \begin_inset Quotes eld
5283 \begin_inset Quotes erd
5287 The following values are valid:
5291 \begin_layout Itemize
5292 autodetect (Autodetect region: snes and sgb only)
5295 \begin_layout Itemize
5296 ntsc (NTSC: snes, bsx, bsxslotted, sufamiturbo, sgb)
5299 \begin_layout Itemize
5300 pal (PAL: snes, sgb)
5303 \begin_layout Itemize
5304 world (World: dmg, gbc, gbc_gba)
5308 \begin_layout Itemize
5309 ROM images are loaded as:
5310 \begin_inset Quotes eld
5314 \begin_inset Quotes erd
5318 The following types are valid:
5322 \begin_layout Itemize
5323 rom (Cartridge ROM in snes, dmg, gbc, gbc_gba.
5324 BIOS in bsx, bsxslotted, sufamiturbo)
5327 \begin_layout Itemize
5328 bsx (Cartridge ROM in bsx, bsxslotted)
5331 \begin_layout Itemize
5332 slot-a (Cartridge ROM in sufamiturbo)
5335 \begin_layout Itemize
5336 slot-b (Cartridge ROM in sufamiturbo)
5340 \begin_layout Itemize
5341 ROM markup can be loaded as:
5342 \begin_inset Quotes eld
5346 \begin_inset Quotes erd
5350 The types valid are the same as for ROMs.
5353 \begin_layout Itemize
5354 Patches can be loaded as
5355 \begin_inset Quotes eld
5358 patch[<offset>] <type> <file>
5359 \begin_inset Quotes erd
5363 The types are the same as for ROMs.
5367 \begin_layout Itemize
5368 Offset is given in form [+-]<number>.
5369 Usually offset is either +0 or -512.
5372 \begin_layout Itemize
5373 Default offset is +0.
5377 \begin_layout Subsection
5381 \begin_layout LyX-Code
5385 \begin_layout LyX-Code
5389 \begin_layout LyX-Code
5390 rom rom speedygonzales.sfc
5393 \begin_layout LyX-Code
5394 patch-512 rom sonicthehedgehog.ips
5397 \begin_layout Subsection
5401 \begin_layout LyX-Code
5405 \begin_layout LyX-Code
5409 \begin_layout LyX-Code
5410 rom rom supergameboy.sfc
5413 \begin_layout LyX-Code
5414 rom dmg megamanV.dmg
5417 \begin_layout Section
5418 Quick'n'dirty encode guide
5421 \begin_layout Enumerate
5422 Start the emulator and load the ROM and movie file.
5425 \begin_layout Enumerate
5426 Set large AVI option 'set-setting avi-large on'
5429 \begin_layout Enumerate
5430 Enable dumping 'dump-avi tmpdump'
5433 \begin_layout Enumerate
5434 Unpause and let it run until you want to end dumping.
5437 \begin_layout Enumerate
5438 Close the emulator (closing the window is the easiest way).
5442 \begin_layout Enumerate
5443 For each tmpdump*.avi file created, on command prompt, do 'x264 --crf 10
5444 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
5447 \begin_layout Enumerate
5448 Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
5451 \begin_layout Enumerate
5452 Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv + tmpdump_0000001.mkv
5453 + tmpdump_0000002.mkv' (list every tmpdump_<numbers>.mkv, with + in between).
5456 \begin_layout Enumerate
5457 Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'.
5458 Now final.mkv contains quick'n'dirty encode.
5461 \begin_layout Section
5462 Axis configurations for some gamepad types:
5465 \begin_layout Subsection
5469 \begin_layout Standard
5470 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be set to pressure-+.
5473 \begin_layout LyX-Code
5474 set-axis joystick0axis2 pressure-+
5477 \begin_layout LyX-Code
5478 set-axis joystick0axis5 pressure-+
5481 \begin_layout Itemize
5482 This is needed for SDL only.
5483 EVDEV sets those types correctly.
5486 \begin_layout Subsection
5488 \begin_inset Quotes eld
5492 \begin_inset Quotes erd
5498 \begin_layout Standard
5499 Axes 8-19 should be disabled.
5502 \begin_layout LyX-Code
5503 set-axis joystick0axis8 disabled
5506 \begin_layout LyX-Code
5507 set-axis joystick0axis9 disabled
5510 \begin_layout LyX-Code
5511 set-axis joystick0axis10 disabled
5514 \begin_layout LyX-Code
5515 set-axis joystick0axis11 disabled
5518 \begin_layout LyX-Code
5519 set-axis joystick0axis12 disabled
5522 \begin_layout LyX-Code
5523 set-axis joystick0axis13 disabled
5526 \begin_layout LyX-Code
5527 set-axis joystick0axis14 disabled
5530 \begin_layout LyX-Code
5531 set-axis joystick0axis15 disabled
5534 \begin_layout LyX-Code
5535 set-axis joystick0axis16 disabled
5538 \begin_layout LyX-Code
5539 set-axis joystick0axis17 disabled
5542 \begin_layout LyX-Code
5543 set-axis joystick0axis18 disabled
5546 \begin_layout LyX-Code
5547 set-axis joystick0axis19 disabled
5550 \begin_layout Section
5554 \begin_layout Subsection
5555 Problems from BSNES core:
5558 \begin_layout Itemize
5559 The whole pending save stuff.
5562 \begin_layout Itemize
5563 Lack of layer hiding.
5566 \begin_layout Itemize
5567 It is slow (especially accuracy).
5570 \begin_layout Itemize
5571 Firmwares can't be loaded from ZIP archives.
5574 \begin_layout Subsection
5578 \begin_layout Itemize
5579 Modifiers don't work with pseudo-keys (SDL, EVDEV).
5582 \begin_layout Itemize
5583 Audio for last dumped frame is not itself dumped.
5586 \begin_layout Itemize
5587 Audio in UI is pretty bad in quality if game doesn't run at full speed.
5590 \begin_layout Itemize
5591 No menus, command based interface (SDL).
5594 \begin_layout Itemize
5595 Long commands don't scroll.
5598 \begin_layout Section
5602 \begin_layout Subsection
5606 \begin_layout Itemize
5610 \begin_layout Itemize
5611 Fix dumper video corruption with levels 10-18.
5614 \begin_layout Subsection
5618 \begin_layout Itemize
5622 \begin_layout Itemize
5623 Lots of code cleanups
5626 \begin_layout Itemize
5627 Lua interface to settings
5630 \begin_layout Itemize
5631 Allow specifying AVI borders without Lua
5634 \begin_layout Itemize
5635 Fix scaling if vscale > 1 and originx > 0 (left border exists)
5638 \begin_layout Itemize
5639 on_snoop lua callback
5642 \begin_layout Itemize
5643 Faster movie loading and saving.
5646 \begin_layout Subsection
5650 \begin_layout Itemize
5654 \begin_layout Subsection
5658 \begin_layout Itemize
5662 \begin_layout Itemize
5663 Save jukebox functionality.
5666 \begin_layout Subsection
5670 \begin_layout Itemize
5671 Try to fix some nasty failing movie load edge cases
5674 \begin_layout Itemize
5675 Allow specifying scripts to run on command line.
5678 \begin_layout Subsection
5682 \begin_layout Itemize
5683 Major source code reorganization.
5686 \begin_layout Itemize
5687 Backup savestates before overwriting.
5690 \begin_layout Itemize
5691 Don't crash if loading initial state fails.
5694 \begin_layout Subsection
5698 \begin_layout Itemize
5702 \begin_layout Itemize
5703 Fix author name parsing
5706 \begin_layout Itemize
5707 Fix rerecord counting
5710 \begin_layout Itemize
5711 (SDL) Print messages to console if SDL is uninitialized
5714 \begin_layout Itemize
5715 Add movieinfo program
5718 \begin_layout Itemize
5719 Fix loading movies starting from SRAM.
5722 \begin_layout Subsection
5726 \begin_layout Itemize
5727 Add support for unattended dumping
5730 \begin_layout Itemize
5731 Fix compiling for Win32
5734 \begin_layout Itemize
5735 Don't lock up if sound can't be initialized
5738 \begin_layout Itemize
5739 Strip trailing CR from commands
5742 \begin_layout Itemize
5743 Don't try to do dubious things in global ctors (fix crash on startup)
5746 \begin_layout Subsection
5750 \begin_layout Itemize
5751 Small documentation tweaking
5754 \begin_layout Itemize
5758 \begin_layout Itemize
5759 Fix major bug in modifier matching
5762 \begin_layout Subsection
5766 \begin_layout Itemize
5767 Lots of documentation fixes
5770 \begin_layout Itemize
5771 Use dedicated callbacks for event backcomm., not commands.
5774 \begin_layout Itemize
5775 Ensure that the watchdog is not hit when executing delayed reset.
5778 \begin_layout Itemize
5779 Remove errant tab from joystick message.
5782 \begin_layout Subsection
5786 \begin_layout Itemize
5787 Make autofire operate in absolute time, not linear time
5790 \begin_layout Itemize
5791 Reinitialize controls when resuming from loadstate
5794 \begin_layout Itemize
5795 Some more code cleanups
5798 \begin_layout Itemize
5799 If Lua allocator fails, call OOM_panic()
5802 \begin_layout Itemize
5803 Byte/word/dword/qword sized host memory write/read functions.
5806 \begin_layout Itemize
5807 Dump at correct framerate if dumping interlaced NTSC (height=448).
5810 \begin_layout Subsection
5814 \begin_layout Itemize
5815 Actually include the complete source code
5818 \begin_layout Itemize
5822 \begin_layout Subsection
5826 \begin_layout Itemize
5827 Document {save,start}time.{,sub}second.
5830 \begin_layout Itemize
5831 Intercept time() from bsnes core.
5834 \begin_layout Subsection
5838 \begin_layout Itemize
5839 Allow disabling time() interception (allow build on Mac OS X)
5842 \begin_layout Itemize
5843 Use SDLMain on Mac OS X (make SDL not crash)
5846 \begin_layout Itemize
5847 Disable delayed resets (just plain too buggy for now).
5850 \begin_layout Itemize
5854 \begin_layout Itemize
5855 Use 16-bit for graphics/video instead of 32-bit.
5858 \begin_layout Itemize
5859 gui.rectangle/gui.pixel
5862 \begin_layout Itemize
5866 \begin_layout Itemize
5867 New CSCD writer implementation.
5870 \begin_layout Subsection
5874 \begin_layout Itemize
5875 Fix interaction of * and +.
5878 \begin_layout Itemize
5882 \begin_layout Itemize
5883 Use gettimeofday()/usleep(), these seem portable enough.
5886 \begin_layout Itemize
5887 Move joystick axis manipulation to keymapper code.
5890 \begin_layout Itemize
5891 Changes to how read-only works.
5894 \begin_layout Itemize
5895 Refactor controller input code.
5898 \begin_layout Subsection
5902 \begin_layout Itemize
5903 Fix mouseclick scale compensation.
5906 \begin_layout Itemize
5907 Draw area boundaries correctly in SDL code.
5910 \begin_layout Itemize
5914 \begin_layout Itemize
5915 Fix CSCD output (buffer overrun and race condition).
5918 \begin_layout Subsection
5922 \begin_layout Itemize
5923 JMD dumping support.
5926 \begin_layout Itemize
5927 Allow unattended dumping to JMD.
5930 \begin_layout Itemize
5934 \begin_layout Itemize
5935 Switch back to 32-bit colors.
5938 \begin_layout Itemize
5939 Add Lua function gui.color.
5942 \begin_layout Itemize
5943 Use some new C++11 features in GCC 4.6.
5946 \begin_layout Itemize
5947 Be prepared for core frequency changes.
5950 \begin_layout Itemize
5951 Pass colors in one chunk from Lua.
5954 \begin_layout Subsection
5958 \begin_layout Itemize
5959 New lua functions gui.line(), gui.status() and gui.circle(), memory.vma_count(),
5960 memory.read_vma() and memory.find_vma().
5963 \begin_layout Itemize
5964 Numerious documentation fixups
5967 \begin_layout Itemize
5968 RTC time format changed
5971 \begin_layout Itemize
5972 Reformat flags display
5975 \begin_layout Itemize
5976 Allow lua package name to be overridden
5979 \begin_layout Itemize
5980 SDUMP (high-quality dumping).
5983 \begin_layout Itemize
5984 Split platform support to plugins.
5987 \begin_layout Itemize
5988 Make all sound plugins support basic sound commands
5991 \begin_layout Itemize
5992 Support portaudio for sound.
5995 \begin_layout Itemize
5996 Allow disable Lua/SDL searching.
5999 \begin_layout Itemize
6000 Upconvert colors when copying lcscreen to screen.
6003 \begin_layout Itemize
6004 Reorganize source tree.
6007 \begin_layout Itemize
6008 Evdev joystick support.
6011 \begin_layout Itemize
6012 Refactor more code into generic window code.
6015 \begin_layout Subsection
6019 \begin_layout Itemize
6020 Refactor message handling.
6023 \begin_layout Itemize
6027 \begin_layout Itemize
6031 \begin_layout Itemize
6032 Finish pending saves before load/quit.
6035 \begin_layout Itemize
6036 Wxwidgets graphics plugin.
6039 \begin_layout Subsection
6043 \begin_layout Itemize
6044 Get rid of win32-crap.[ch]pp.
6047 \begin_layout Itemize
6048 Move files around a lot.
6051 \begin_layout Itemize
6052 Get rid of need for host C++ compiler.
6055 \begin_layout Itemize
6059 \begin_layout Itemize
6060 Refactor inter-component communication.
6063 \begin_layout Itemize
6067 \begin_layout Itemize
6068 Fix crash on multiline aliases.
6071 \begin_layout Itemize
6072 Load/Save settings in wxwidgets gui.
6075 \begin_layout Subsection
6079 \begin_layout Itemize
6080 Patch problems in bsnes core
6083 \begin_layout Itemize
6084 SNES is little-endian, not big-endian!
6087 \begin_layout Itemize
6088 Fix memory corruption in lcscreen::load()
6091 \begin_layout Subsection
6095 \begin_layout Itemize
6096 Fix interpretting repeat counts in rrdata loading.
6099 \begin_layout Itemize
6100 New lua callback: on_frame()
6103 \begin_layout Itemize
6104 Remove calls to runtosave() that aren't supposed to be there
6107 \begin_layout Itemize
6108 Lua function: movie.read_rtc()
6111 \begin_layout Itemize
6112 Ignore src/fonts/font.cpp
6115 \begin_layout Itemize
6116 Fix more bsnes core problems
6119 \begin_layout Itemize
6120 Control bsnes random seeding
6123 \begin_layout Itemize
6127 \begin_layout Itemize
6128 Some bsnes core debugging features (state dump and state hash)
6131 \begin_layout Itemize
6132 Fix titlebar version number (no, the last version wasn't 'lsnes-0-beta21',
6133 it was 'lsnes rr0-beta21').
6136 \begin_layout Subsection
6140 \begin_layout Itemize
6141 Fix memory corruption due to macro/field mixup
6144 \begin_layout Itemize
6145 search-memory update
6148 \begin_layout Itemize
6149 Allow direct-mapped framebuffer
6152 \begin_layout Itemize
6153 SDL: Use SDL_ANYFORMAT if possible
6156 \begin_layout Itemize
6157 SDMP2SOX: 2s delay modes.
6160 \begin_layout Itemize
6164 \begin_layout Itemize
6165 Use sed -E, not sed -r.
6166 Fixes building on Mac OS X.
6169 \begin_layout Itemize
6170 Wxwidgets: Save jukebox on exit
6173 \begin_layout Itemize
6174 Fix RTC if using load-movie on savestate.
6177 \begin_layout Itemize
6178 Fix crash related to full console mode.
6181 \begin_layout Subsection
6185 \begin_layout Itemize
6186 Wxwidgets: Allow bringing application to foreground on Mac OS X.
6189 \begin_layout Itemize
6190 Wxwidgets: Allow compiling on Mac OS X.
6193 \begin_layout Itemize
6194 Use movie compare instead of movie hashing (faster save/load).
6197 \begin_layout Itemize
6201 \begin_layout Subsection
6205 \begin_layout Itemize
6206 sdmp2sox: Pad soundtrack if using -l or -L.
6209 \begin_layout Itemize
6210 sdmp2sox: Fix NTSC overscan.
6213 \begin_layout Itemize
6214 sdmp2sox: Add AR correction mode.
6217 \begin_layout Itemize
6218 call lua_close() when exiting.
6221 \begin_layout Itemize
6222 Fix zip_writer bug causing warnings from info-zip and error from advzip.
6225 \begin_layout Subsection
6229 \begin_layout Itemize
6230 Fix IPS patching code (use bsnes core IPS patcher).
6233 \begin_layout Itemize
6234 Implement BPS patching (using bsnes core IPS patcher).
6237 \begin_layout Itemize
6238 Add feature to load headered ROMs.
6241 \begin_layout Subsection
6245 \begin_layout Itemize
6246 Show command names when showing keybindings
6249 \begin_layout Subsection
6253 \begin_layout Itemize
6254 Fix pause-on-end to be actually controllable
6257 \begin_layout Itemize
6258 SDL: Poll all events in queue, not just first one (fixes slowness in command
6262 \begin_layout Itemize
6263 Wxwidgets: Fix ROM loading.
6266 \begin_layout Subsection
6270 \begin_layout Itemize
6271 Lua: Add gui.textH, gui.textV, gui.textHV
6274 \begin_layout Itemize
6275 Fix text colors on SDL on Mac OS X
6278 \begin_layout Itemize
6279 Mode 'F' for finished in readonly mode.
6282 \begin_layout Itemize
6286 \begin_layout Itemize
6287 Reliably pause after skip poll
6290 \begin_layout Itemize
6291 Split UI and core into their own threads
6294 \begin_layout Subsection
6298 \begin_layout Itemize
6299 Remove leftover dummy SRAM slot
6302 \begin_layout Itemize
6303 Fix controller numbers.
6306 \begin_layout Subsection
6310 \begin_layout Itemize
6311 Fix lsnes-dumpavi after interface change.
6314 \begin_layout Itemize
6315 Also give BSNES patches for v085.
6318 \begin_layout Itemize
6319 Pack movie data in memory.
6322 \begin_layout Subsection
6326 \begin_layout Itemize
6327 Fix framecount/length given when loading movies.
6330 \begin_layout Itemize
6331 Controller command memory leak fixes.
6334 \begin_layout Itemize
6335 Don't leak palette if freeing screen object.
6338 \begin_layout Subsection
6342 \begin_layout Itemize
6346 \begin_layout Itemize
6347 Wxwidgets: Allow controlling dumper from the menu.
6350 \begin_layout Subsection
6354 \begin_layout Itemize
6355 Rewrite parts of manual
6358 \begin_layout Itemize
6359 Lua: Make it work with Lua 5.2.
6362 \begin_layout Subsection
6366 \begin_layout Itemize
6367 Win32: Fix compile errors.
6370 \begin_layout Subsection
6374 \begin_layout Itemize
6375 Refactor controller input code.
6378 \begin_layout Itemize
6379 Fix crash when using command line on SDL / Mac OS X.
6382 \begin_layout Subsection
6386 \begin_layout Itemize
6387 Delete core/coroutine (obsolete)
6390 \begin_layout Itemize
6391 Lag input display by one frame.
6394 \begin_layout Itemize
6395 Rewind movie to beginning function.
6398 \begin_layout Itemize
6399 Fix wrong frame number reported to Lua when repainting after loadstate
6402 \begin_layout Itemize
6403 Support UI editing of jukebox
6406 \begin_layout Itemize
6407 Wxwidgets: Save settings on exit.
6410 \begin_layout Itemize
6411 Support ${project} for filenames
6414 \begin_layout Itemize
6415 SDL: Fix command history
6418 \begin_layout Subsection
6422 \begin_layout Itemize
6423 Fix some order-of-global-ctor bugs.
6426 \begin_layout Subsection
6430 \begin_layout Itemize
6431 Fix crashes when quitting on Win32.
6434 \begin_layout Subsection
6438 \begin_layout Itemize
6439 EVDEV: Queue keypresses from joystick, don't send directly
6442 \begin_layout Itemize
6443 Wxwidgets: Load-Preserve that actually works.
6446 \begin_layout Subsection
6450 \begin_layout Itemize
6451 Wxwidgets: GUI for memory search.
6454 \begin_layout Itemize
6455 Warn about using synchronous queue in UI callback.
6458 \begin_layout Subsection
6462 \begin_layout Itemize
6463 Remember last saved file for each ROM
6466 \begin_layout Itemize
6467 Support MT dumping via boost.
6470 \begin_layout Itemize
6474 \begin_layout Itemize
6478 \begin_layout Itemize
6479 Make mouse be ordinary input instead of special-casing
6482 \begin_layout Itemize
6483 SDL: Don't screw up commands with NUL codepoints.
6486 \begin_layout Subsection
6490 \begin_layout Itemize
6491 Merge status panel and main window
6494 \begin_layout Itemize
6495 True movie slot support (the rest of it)
6498 \begin_layout Itemize
6499 SDL: Fix compilation error
6502 \begin_layout Itemize
6503 Elminate cross calls in dump menu code.
6506 \begin_layout Subsection
6510 \begin_layout Itemize
6511 Cancel pending saves command
6514 \begin_layout Itemize
6515 Wxwidgets: Code refactoring
6518 \begin_layout Itemize
6519 Wxwidgets: Fix system -> reset
6522 \begin_layout Itemize
6523 Wxwidgets: Read watch expressions in the right thread
6526 \begin_layout Subsection
6530 \begin_layout Itemize
6531 Wxwidgets: Don't prompt for member when running Lua script (Lua doesn't
6535 \begin_layout Itemize
6536 Wxwidgets: 128 -> 1024 Autohold slots (in case more are needed).
6539 \begin_layout Itemize
6540 Don't append trailing '-' to prefix when saving movie.
6543 \begin_layout Itemize
6544 Fix ROM/savestate handling (don't let user mismatch ROM and savestates).
6547 \begin_layout Subsection
6551 \begin_layout Itemize
6552 Document memory watch syntax.
6555 \begin_layout Subsection
6559 \begin_layout Itemize
6560 Fix unattended dumping (lsnes-dumpavi)
6563 \begin_layout Itemize
6567 \begin_layout Itemize
6568 Use adv_dumper instead of the old interface in lsnes-dumpavi (changes syntax)
6571 \begin_layout Itemize
6572 Add option to control sample rate preturbation in AVI dumper
6575 \begin_layout Subsection
6579 \begin_layout Itemize
6580 Wxwidgets: Fix dumper submodes
6583 \begin_layout Itemize
6584 Set core controller types before loadstate
6587 \begin_layout Subsection
6591 \begin_layout Itemize
6592 Fix compiling with bsnes v086.
6595 \begin_layout Subsection
6599 \begin_layout Itemize
6600 Don't prompt before quitting
6603 \begin_layout Itemize
6604 Start unpaused, preserve pause/unpause over load.
6607 \begin_layout Itemize
6608 Try to autodetect if ROM is headered.
6611 \begin_layout Itemize
6612 Wxwidgets: Only bring up ROM patching screen if specifically requested.
6615 \begin_layout Itemize
6616 Allow configuring some hotkeys.
6619 \begin_layout Subsection
6623 \begin_layout Itemize
6624 Lots of code cleanups
6627 \begin_layout Itemize
6628 Fix JMD compression (JMD dumping was broken)
6631 \begin_layout Itemize
6632 Don't crash if Lua C function throws an exception.
6635 \begin_layout Itemize
6636 Support bitmap drawing in Lua.
6639 \begin_layout Itemize
6640 Fix bsnes v085/v086 patches.
6643 \begin_layout Itemize
6644 Improve stability on win32.
6647 \begin_layout Subsection
6651 \begin_layout Itemize
6652 Don't corrupt movie if movie length is integer multiple of frames per page.
6655 \begin_layout Subsection
6659 \begin_layout Itemize
6660 New Lua hooks: on_rewind, on_frame_emulated, on_idle, on_timer
6663 \begin_layout Itemize
6664 New Lua functions: emulator_ready(), utime(), set_idle_timeout(), set_timer_time
6665 out(), bit.extract(), bit.value(), input.geta(), input.seta() and input.controllertyp
6669 \begin_layout Itemize
6670 Wxwidgets: Fix internal focus lost (hotkeys stop working)
6673 \begin_layout Itemize
6674 Wxwidgets: Fix broken modifiers
6677 \begin_layout Itemize
6678 on_paint has parameter now.
6681 \begin_layout Itemize
6682 Optional initital fill for bitmaps
6685 \begin_layout Itemize
6686 Fix palette changing.
6689 \begin_layout Itemize
6690 Optimize rendering a bit.
6693 \begin_layout Itemize
6697 \begin_layout Subsection
6701 \begin_layout Itemize
6702 Movieinfo: Fix display of port #2 type.
6705 \begin_layout Itemize
6706 Call on_input() after loadstate.
6709 \begin_layout Subsection
6713 \begin_layout Itemize
6714 Fix writing port2 data to movie.
6717 \begin_layout Itemize
6718 Fix SRAM handling with Bsnes v087.
6721 \begin_layout Subsection
6725 \begin_layout Itemize
6726 Library loading support
6729 \begin_layout Itemize
6730 Built-in TSCC encoder
6733 \begin_layout Itemize
6734 Hi-color (256T colors) dumping.
6737 \begin_layout Itemize
6738 Dump over TCP/IP(v6)
6741 \begin_layout Itemize
6742 Hidable status panel
6745 \begin_layout Itemize
6749 \begin_layout Itemize
6750 Adjustable sound volume
6753 \begin_layout Itemize
6757 \begin_layout Itemize
6758 Allow DnD into filename boxes
6761 \begin_layout Itemize
6765 \begin_layout Itemize
6766 Portaudio: Fix speaker popping at start
6769 \begin_layout Itemize
6773 \begin_layout Itemize
6774 Speed adjustment menu
6777 \begin_layout Itemize
6778 Win32 joystick support
6781 \begin_layout Itemize
6782 Lua: gui.rainbow and gui.box
6785 \begin_layout Itemize
6786 Split key lists into classes (the key list was large!)
6789 \begin_layout Itemize
6790 More save slots support
6793 \begin_layout Itemize
6794 Wxwidgets (wxJoystick) joystick support
6797 \begin_layout Subsection
6801 \begin_layout Itemize
6802 Lots of internal joystick refactoring
6805 \begin_layout Itemize
6806 Evdev: Add mapping for BTN_TOOL_QUINTTAP
6809 \begin_layout Itemize
6810 Wxwidgets: Settings mode (open settings without ROM)
6813 \begin_layout Itemize
6814 Wxwidgets: Prompt key to use option
6817 \begin_layout Itemize
6818 Wxwidgets: Fix crash if key goes away underneath
6821 \begin_layout Itemize
6822 Wxwidgets: Fix mouse position in presence of scaling
6825 \begin_layout Itemize
6826 AVI dumper: Mode 4 (high-quality resampling to common rate using SRC)
6829 \begin_layout Itemize
6830 Wxwidgets: Redesign hotkeys dialog to avoid tree control (tree control doesn't
6831 seem to work well on WinXP)
6834 \begin_layout Itemize
6835 Start paused option.
6838 \begin_layout Subsection
6842 \begin_layout Itemize
6846 \begin_layout Itemize
6847 lsnes-dumpavi: Start Lua before starting dumper
6850 \begin_layout Itemize
6851 AVI: Fix secondary audio in mode 4.
6854 \begin_layout Subsection
6858 \begin_layout Itemize
6859 AVI: Refactor ZMBV a bit.
6862 \begin_layout Itemize
6863 Fix error reading analog values from movie file
6866 \begin_layout Subsection
6870 \begin_layout Itemize
6871 Delayed reset support
6874 \begin_layout Itemize
6875 Lua: memory.hash_region
6878 \begin_layout Subsection
6882 \begin_layout Itemize
6883 Rework the build system
6886 \begin_layout Itemize
6887 Typing input support
6890 \begin_layout Itemize
6891 Fix building with bsnes v086 and v087.
6894 \begin_layout Itemize
6895 SDL: Save settings on exit
6898 \begin_layout Itemize
6899 SDL: Command to enter command line mode with given command.
6902 \begin_layout Itemize
6903 SDL: More advanced command editing.
6906 \begin_layout Subsection
6910 \begin_layout Itemize
6912 \begin_inset Quotes eld
6915 arrow keys and enter don't work
6916 \begin_inset Quotes erd
6922 \begin_layout Itemize
6926 \begin_layout Itemize
6927 Show mode changes due to rewinding.
6930 \begin_layout Itemize
6931 Unsafe rewind support
6934 \begin_layout Itemize
6935 Fix directory transversal.
6938 \begin_layout Subsection
6942 \begin_layout Itemize
6943 AVI: Sound mode 5 (48kHz high-quality)
6946 \begin_layout Itemize
6950 \begin_layout Itemize
6951 Map the SNES bus into address space
6954 \begin_layout Itemize
6955 Fix loading memory watch files with CRLF line endings
6958 \begin_layout Subsection
6962 \begin_layout Itemize
6963 Map bsnes internal state into memory space
6966 \begin_layout Itemize
6968 \begin_inset Quotes eld
6971 click on panel wedges the emulator
6972 \begin_inset Quotes erd
6978 \begin_layout Itemize
6979 DnD movies/saves on the main window.
6982 \begin_layout Subsection
6986 \begin_layout Itemize
6987 Split core bindings into own module.
6990 \begin_layout Itemize
6991 Remember invalid settings
6994 \begin_layout Itemize
6995 Support for modified Gambatte core for GB/GBC emulation.
6998 \begin_layout Itemize
6999 Reload/swap ROM function
7002 \begin_layout Subsection
7006 \begin_layout Itemize
7007 Fix step poll function
7010 \begin_layout Subsection
7014 \begin_layout Itemize
7015 Non-insane savestate anchoring
7018 \begin_layout Subsection
7022 \begin_layout Itemize
7023 More Memory search methods
7026 \begin_layout Itemize
7027 Preserve movie if loading in RO mode.
7030 \begin_layout Itemize
7031 Fix a obscure case in timeline check
7034 \begin_layout Itemize
7035 Revamp the entiere ROM loading code
7038 \begin_layout Itemize
7042 \begin_layout Itemize
7046 \begin_layout Itemize
7047 Standalone hotkey config dialog
7050 \begin_layout Itemize
7051 Show bindings in more user-friendly format
7054 \begin_layout Subsection
7058 \begin_layout Itemize
7062 \begin_layout Itemize
7063 Fix uninitialized variables in bsnes v085
7066 \begin_layout Subsection
7070 \begin_layout Itemize
7071 Merge gambatte core into mainline (from its own branch)
7074 \begin_layout Itemize
7075 Wxwidgets: Show expected dump file formats
7078 \begin_layout Itemize
7079 Memory watch: Data typing
7082 \begin_layout Itemize
7083 lsnes internal MMIO area.
7086 \begin_layout Itemize
7087 Wxwidgets: New memory watch editor
7090 \begin_layout Itemize
7091 Hexadecimal memory watches
7094 \begin_layout Itemize
7095 Wxwidgets: Monospaced panel
7098 \begin_layout Itemize
7099 Wxwidgets: Split memory watches in panel
7102 \begin_layout Itemize
7103 Wxwidgets: Disable VMAs in memory search
7106 \begin_layout Itemize
7107 lsnes-dumpavi: Fix speed bug
7110 \begin_layout Itemize
7111 Movie subtitle support
7114 \begin_layout Itemize
7115 Fix rerecord count reporting
7118 \begin_layout Itemize
7119 Don't trash movie when loading in readonly mode.
7122 \begin_layout Subsection
7126 \begin_layout Itemize
7127 Wxwidgets: Fix crashes on closing settings dialogs on Mac OS X.
7130 \begin_layout Itemize
7131 Fix build on Mac OS X.
7134 \begin_layout Itemize
7138 \begin_layout Itemize
7139 Wxwidgets: Hidable messages window
7142 \begin_layout Itemize
7146 \begin_layout Itemize
7147 Bsnes: Support inconsistent saves
7150 \begin_layout Itemize
7151 Bsnes: Allow simulating saving every frame
7154 \begin_layout Itemize
7155 Fix desync if savestate is loaded in readonly mode in certain conditions.
7158 \begin_layout Itemize
7159 Wxwidgets: Fix save dialogs on Mac OS X.
7162 \begin_layout Itemize
7163 Wxwidgets: Fix insane status width on Win32.
7166 \begin_layout Itemize
7167 Wxwidgets: Fix autohold processing to be faster.
7170 \begin_layout Itemize
7171 Wxwidgets: Allow loading ROMs and movies from commandline.
7174 \begin_layout Subsection
7178 \begin_layout Itemize
7179 Be a bit smarter with --load
7182 \begin_layout Itemize
7183 Rewrote higher-level parts of audio system
7186 \begin_layout Itemize
7187 Tool to build commentary tracks
7190 \begin_layout Itemize
7194 \begin_layout Itemize
7195 Gambatte: Add support for SVN358
7198 \begin_layout Itemize
7199 Use builtin font when rendering status panel.
7202 \begin_layout Itemize
7203 Option to detach memory watch to its own window.
7206 \begin_layout Itemize
7207 Recent ROMs/Movies menu
7210 \begin_layout Itemize
7214 \begin_layout Itemize
7215 Useful lag counter for SNES games that autopoll
7218 \begin_layout Itemize
7219 Fix buffer overflow in gambatte sound output
7222 \begin_layout Subsection
7226 \begin_layout Itemize
7227 Don't blow up on wxGTK if the window is hidden somehow
7230 \begin_layout Itemize
7231 Support simultaneous drop of ROM and movie.
7234 \begin_layout Itemize
7235 Gambatte: Don't save spurious SRAMs.
7238 \begin_layout Itemize
7239 Make SGB ROMs actually usable.
7242 \begin_layout Itemize
7243 Fix so that saved movies appear in recent movies.
7246 \begin_layout Itemize
7247 Don't open multiple commentary editors at once.
7250 \begin_layout Subsection
7254 \begin_layout Itemize
7255 Lua: memory.readregion/memory.writeregion
7258 \begin_layout Itemize
7259 Lua: memory.map{,s}{byte,word,dword,qword}
7262 \begin_layout Itemize
7263 Lua: memory.map_structure
7266 \begin_layout Itemize
7267 Lua: Fix bus_address for gambatte
7270 \begin_layout Itemize
7271 Fix features dependent of bsnes debugger
7274 \begin_layout Itemize
7275 Cleanup bsnes debugger logic
7278 \begin_layout Itemize
7279 Fix resets in presence of save every frame