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
98 SVN r320, r358 or r364
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) version 5.1.X or 5.2.X
150 \begin_layout Enumerate
154 \begin_layout Enumerate
155 libopus (optional, for commentary track tool)
158 \begin_layout Section
162 \begin_layout Itemize
163 Copy bsnes sources (the bsnes subdirectory) to subdirectory 'bsnes' (for
167 \begin_layout Itemize
168 Copy gambatte sources to subdirectory 'gambatte' (for gambatte core).
171 \begin_layout Itemize
172 Patch the bsnes sources with included patches (directory 'bsnes-patches/<version
176 \begin_layout Itemize
177 Patch the gambatte sources with included patches (directory 'gambatte-patches/<v
178 ersion>', gambatte core)
181 \begin_layout Itemize
182 Edit options.build (or copy of that file)
185 \begin_layout Itemize
186 Run make (passing 'OPTIONS=<filename>' if using something else than options.build
190 \begin_layout Section
194 \begin_layout Subsection
198 \begin_layout Subsubsection
199 --rom=<file> (lsnes/SDL, lsnes/wxwidgets, lsnes-avidump)
202 \begin_layout Standard
206 \begin_layout Subsubsection
207 <file> (lsnes/wxwidgets)
210 \begin_layout Standard
214 \begin_layout Subsection
218 \begin_layout Subsubsection
222 \begin_layout Standard
226 \begin_layout Subsubsection
227 <filename> (lsnes/SDL, lsnes-avidump, movieinfo)
230 \begin_layout Standard
231 Load <filename> as movie or savestate file.
232 All other session options are ignored.
235 \begin_layout Subsubsection
236 --port1=<device> (lsnes/SDL, bsnes core only)
239 \begin_layout Standard
244 \begin_layout Itemize
245 none: No device connected
248 \begin_layout Itemize
249 gamepad: One gamepad (the default)
252 \begin_layout Itemize
253 multitap: Four gamepads (warning: makes most games refuse to start)
256 \begin_layout Itemize
260 \begin_layout Subsubsection
261 --port2=<type> (lsnes/SDL, bsnes core only)
264 \begin_layout Standard
269 \begin_layout Itemize
270 none: No device connected (the default)
273 \begin_layout Itemize
277 \begin_layout Itemize
278 multitap: Four gamepads.
281 \begin_layout Itemize
285 \begin_layout Itemize
286 superscope: Super Scope
289 \begin_layout Itemize
290 justifier: One justifier
293 \begin_layout Itemize
294 justifiers: Two justifiers
297 \begin_layout Subsubsection
298 --gamename=<name> (lsnes/SDL)
301 \begin_layout Standard
302 Set the name of game to <name>.
306 \begin_layout Subsubsection
307 --author=<name> (lsnes/SDL)
310 \begin_layout Standard
311 Add author with full name of <name> (no nickname).
314 \begin_layout Subsubsection
315 --author=|<name> (lsnes/SDL)
318 \begin_layout Standard
319 Add author with nickname of <name> (no full name).
322 \begin_layout Subsubsection
323 --author=<fullname>|<nickname> (lsnes/SDL)
326 \begin_layout Standard
327 Add author with full name of <fullname> and nickname of <nickname>.
330 \begin_layout Subsubsection
331 --rtc-second=<value> (lsnes/SDL)
334 \begin_layout Standard
335 Set RTC second (0 is 1st January 1970 00:00:00Z).
336 Default is 1,000,000,000.
339 \begin_layout Subsubsection
340 --rtc-subsecond=<value> (lsnes/SDL)
343 \begin_layout Standard
350 \begin_layout Subsubsection
351 --anchor-savestate=<file> (lsnes/SDL)
354 \begin_layout Standard
355 Set the anchor savestate file.
358 \begin_layout Subsubsection
359 --load=<file> (lsnes/wxwidgets)
362 \begin_layout Standard
363 After loading the ROM, load <file> as savestate/movie.
366 \begin_layout Subsection
371 \begin_layout Subsubsection
372 --run=<file> (lsnes/SDL)
375 \begin_layout Standard
376 After running main RC file, run this file.
377 If multiple are specified, these execute in order specified.
380 \begin_layout Subsubsection
381 --lua=<file> (lsnes/wxwidgets)
384 \begin_layout Standard
385 Run this Lua file on startup
388 \begin_layout Subsection
389 dump options (lsnes-dumpavi only)
392 \begin_layout Subsubsection
396 \begin_layout Standard
397 Set the dumper to use (required).
398 Use 'list' for listing of known dumpers.
401 \begin_layout Subsubsection
405 \begin_layout Standard
406 Set the mode to use (required for dumpers with multiple modes, forbidden
408 Use 'list' for known modes.
411 \begin_layout Subsubsection
415 \begin_layout Standard
418 \begin_inset Quotes eld
422 \begin_inset Quotes erd
428 \begin_layout Subsubsection
429 --option=<name>=<value>
432 \begin_layout Standard
433 Set option <name> to value <value>.
436 \begin_layout Subsubsection
440 \begin_layout Standard
441 Set number of frames to dump.
445 \begin_layout Subsubsection
449 \begin_layout Standard
450 Run specified lua script (lsnes-dumpavi does not have initialization files).
453 \begin_layout Subsubsection
454 --load-library=<library>
457 \begin_layout Standard
458 Load the specified shared object / dynamic library / dynamic link library.
461 \begin_layout Section
462 Startup file lsnes.rc
465 \begin_layout Standard
466 Upon startup, lsnes (lsnes/SDL only) executes file lsnes.rc as commands.
467 This file is located in:
470 \begin_layout Itemize
475 lsnes.rc (if %APPDATA% exists)
478 \begin_layout Itemize
479 Unix: $XDG_CONFIG_HOME/lsnes/lsnes.rc (if $XDG_CONFIG_HOME exists)
482 \begin_layout Itemize
483 Unix: $HOME/.config/lsnes/lsnes.rc (if $HOME exists)
486 \begin_layout Itemize
487 All: ./lsnes.rc (fallback default).
490 \begin_layout Standard
491 If leading directories do not exist, attempt to create them is made.
494 \begin_layout Section
498 \begin_layout Itemize
499 Commands beginning with '*' invoke the corresponding command without alias
503 \begin_layout Itemize
504 If command starts with '+' (after possible '*'), the command is executed
505 as-is when button is pressed, and when button is released, it is executed
506 with '+' replaced by '-'.
509 \begin_layout Itemize
510 Commands without '+' execute only on negative edge (release).
513 \begin_layout Subsection
517 \begin_layout Standard
518 Settings control various aspects of emulator behaviour.
521 \begin_layout Subsubsection
522 set-setting <setting> <value>
525 \begin_layout Standard
526 Sets setting <setting> to value <value> (may be empty).
529 \begin_layout Subsubsection
530 unset-setting <setting>
533 \begin_layout Standard
534 Try to unset setting <setting> (not all settings can be unset).
537 \begin_layout Subsubsection
538 get-setting <setting>
541 \begin_layout Standard
542 Read value of setting <setting>
545 \begin_layout Subsubsection
549 \begin_layout Standard
550 Print names and values of all settings.
553 \begin_layout Subsection
557 \begin_layout Standard
558 Keybindings bind commands or aliases to keys (or pseudo-keys).
562 \begin_layout Standard
566 \begin_layout Itemize
567 Do not bind edge active (+/-) commands to keys with modifiers, that won't
571 \begin_layout Itemize
572 Names of keys and modifiers are platform-dependent.
575 \begin_layout Itemize
576 Be careful before binding pseudo-keys (such as joystick axes, buttons or
577 hats) with modifiers.
578 That may or may not work right.
581 \begin_layout Subsubsection
582 bind-key [<mod>/<modmask>] <key> <command>
585 \begin_layout Standard
586 Bind <command> to key <key> (activating if modifiers in <modmask> (comma-seperat
587 ed list) are set as <mod> (comma-seperated list).
590 \begin_layout Standard
591 The names of keys and modifiers are platform-dependent.
594 \begin_layout Subsubsection
595 unbind-key [<mod>/<modmask>] <key>
598 \begin_layout Standard
599 Unbind command from <key> (with specified <mod> and <modmask>).
602 \begin_layout Subsubsection
603 set-axis <axis> [disabled | axis | axis-inverse | pressure0- | pressure0+
604 | pressure-0 | pressure-+ | pressure+0 | pressure+-] [minus=<val>] [zero=<val>]
605 [plus=<val>] [tolerance=<val>]
608 \begin_layout Standard
609 Set axis parameters for axis <axis>.
612 \begin_layout Itemize
613 disabled: Disable axis
616 \begin_layout Itemize
620 \begin_layout Itemize
621 axis-inverse: Inverse axis
624 \begin_layout Itemize
625 pressure0-: Pressure sensitive.
626 Released at 0, pressed at -.
629 \begin_layout Itemize
630 pressure0+: Pressure sensitive.
631 Released at 0, pressed at +.
634 \begin_layout Itemize
635 pressure-0: Pressure sensitive.
636 Released at -, pressed at 0.
639 \begin_layout Itemize
640 pressure-+: Pressure sensitive.
641 Released at -, pressed at +.
644 \begin_layout Itemize
645 pressure+0: Pressure sensitive.
646 Released at +, pressed at 0.
649 \begin_layout Itemize
650 pressure+-: Pressure sensitive.
651 Released at +, pressed at -.
654 \begin_layout Itemize
655 minus=<val>: Calibration at extreme minus position (-32768-32767)
658 \begin_layout Itemize
659 zero=<val>: Calibration at neutral position (-32768-32767)
662 \begin_layout Itemize
663 plus=<val>: Calibration at extreme plus position (-32768-32767)
666 \begin_layout Itemize
667 tolerance=<value>: Center band tolerance (0<x<1).
668 The smaller the value, the more sensitive the control is.
671 \begin_layout Subsubsection
675 \begin_layout Standard
676 Print all key bindings in effect.
679 \begin_layout Subsection
683 \begin_layout Standard
684 Aliases bind command to sequence of commands.
685 After alias has been defined, it replaces the command it shadows.
688 \begin_layout Standard
692 \begin_layout Itemize
693 You can't alias command to itself.
696 \begin_layout Itemize
697 Aliases starting with +/- are edge active just like ordinary commands starting
701 \begin_layout Itemize
702 One command can be aliased to multiple commands.
705 \begin_layout Subsubsection
706 alias-command <command> <expansion>
709 \begin_layout Standard
710 Append <expansion> to alias <command>.
711 If alias does not already exist, it is created.
714 \begin_layout Subsubsection
715 unalias-command <command>
718 \begin_layout Standard
719 Clear alias expansion for <command>.
722 \begin_layout Subsubsection
726 \begin_layout Standard
727 Print all aliases and their expansions in effect.
730 \begin_layout Subsection
734 \begin_layout Standard
735 Run <script> as if commands were entered on the command line.
738 \begin_layout Subsection
742 \begin_layout Standard
743 Following commands control video dumping:
746 \begin_layout Subsubsection
747 start-dump <dumper> [<mode>] <prefix/filename>
750 \begin_layout Standard
751 Start dumping using dumper <dumper>.
752 If mode is present or not and if prefix or filename is present depends
753 on the dumper and dumper mode.
756 \begin_layout Standard
757 The following dumpers are available:
760 \begin_layout Itemize
761 INTERNAL-AVI-CSCD: Internal CSCD in .avi dumper.
765 \begin_layout Itemize
766 Mode: uncompressed/pcm: Uncompressed video, PCM audio.
770 \begin_layout Itemize
771 Mode: cscd/pcm: CSCD video, PCM audio.
776 \begin_layout Itemize
777 INTERNAL-JMD: Internal .jmd dumper.
781 \begin_layout Itemize
785 \begin_layout Itemize
790 \begin_layout Itemize
791 INTERNAL-RAW: Internal RAW dumper.
795 \begin_layout Itemize
799 \begin_layout Itemize
803 \begin_layout Itemize
804 Sound is big-endian signed 16-bit, usually at 32040.5Hz.
807 \begin_layout Itemize
808 Video is always upscaled to double resolution (512x448 / 512 x 478).
811 \begin_layout Itemize
812 Video framerate is usually 322445/6448 fps for PAL and 10738636/178683 fps
817 \begin_layout Itemize
818 INTERNAL-SDMP: Internal SDMP dumper.
822 \begin_layout Itemize
823 Mode 'ms': Multi-segment.
827 \begin_layout Itemize
828 Mode 'ss': Single-segment.
833 \begin_layout Subsubsection
837 \begin_layout Standard
838 End dumping using <dumper>
841 \begin_layout Subsubsection
842 show-dumpers [<dumper>]
845 \begin_layout Standard
846 Show the list of dumpers or list of modes for <dumper>
849 \begin_layout Subsection
853 \begin_layout Standard
854 <address> may be decimal or hexadecimal (prefixed with '0x').
855 <value> can be hexadecimal (prefixed with '0x'), unsigned or signed (prefixed
859 \begin_layout Standard
860 The available element <sizes> are:
863 \begin_layout Itemize
867 \begin_layout Itemize
871 \begin_layout Itemize
875 \begin_layout Itemize
879 \begin_layout Standard
880 When reading RAM and ROM, multi-byte reads/writes are big-endian.
881 When dealing with DSP memory, multi-byte reads/writes are native-endian
882 (do not use operand sizes exceeding DSP bitness, except dword is OK for
886 \begin_layout Subsubsection
887 read-<size> <address>
890 \begin_layout Standard
891 Read the value of byte in <address>.
894 \begin_layout Subsubsection
895 read-s<size> <address>
898 \begin_layout Standard
899 Read the value of signed byte in <address>.
902 \begin_layout Subsubsection
903 write-<size> <address> <value>
906 \begin_layout Standard
907 Write <value> to byte in address <address>.
910 \begin_layout Subsubsection
914 \begin_layout Standard
915 Reset the memory search
918 \begin_layout Subsubsection
922 \begin_layout Standard
923 Print number of candidates remaining
926 \begin_layout Subsubsection
930 \begin_layout Standard
931 Print all candidates remaining
934 \begin_layout Subsubsection
935 search-memory <usflag><sizeflag><op>
938 \begin_layout Standard
939 Searches memory for addresses satisfying criteria.
942 \begin_layout Standard
946 \begin_layout Itemize
950 \begin_layout Itemize
954 \begin_layout Standard
958 \begin_layout Itemize
962 \begin_layout Itemize
966 \begin_layout Itemize
970 \begin_layout Itemize
974 \begin_layout Standard
978 \begin_layout Itemize
979 lt: < previous value.
982 \begin_layout Itemize
983 le: <= previous value.
986 \begin_layout Itemize
987 eq: = previous value.
990 \begin_layout Itemize
991 ne: != previous value.
994 \begin_layout Itemize
995 ge: >= previous value.
998 \begin_layout Itemize
999 gt: > previous value.
1002 \begin_layout Subsubsection
1003 search-memory <sizeflag> <value>
1006 \begin_layout Standard
1007 Searches for addresses that currently have value <value>.
1008 <sizeflag> is as in previous command.
1011 \begin_layout Subsection
1015 \begin_layout Standard
1016 These commands are not available in lsnesrc, but are available after ROM
1020 \begin_layout Subsubsection
1024 \begin_layout Standard
1025 Quits the emulator (asking for confirmation).
1026 If /y is given, no confirmation is asked.
1029 \begin_layout Subsubsection
1033 \begin_layout Standard
1034 Toggle paused/unpaused
1037 \begin_layout Subsubsection
1041 \begin_layout Standard
1043 If the button is still held after configurable timeout expires, game unpauses
1044 for the duration frame advance is held.
1047 \begin_layout Subsubsection
1051 \begin_layout Standard
1053 If the button is still held after configurable timeout expires, game unpauses
1054 for the duration frame advance is held.
1057 \begin_layout Subsubsection
1061 \begin_layout Standard
1062 Skip to first poll in frame after current.
1065 \begin_layout Subsubsection
1069 \begin_layout Standard
1070 Reset the SNES after this frame.
1073 \begin_layout Subsubsection
1077 \begin_layout Standard
1078 Load savestate <filename> in current mode.
1081 \begin_layout Subsubsection
1082 load-state <filename>
1085 \begin_layout Standard
1086 Load savestate <filename> in readwrite mode.
1089 \begin_layout Subsubsection
1090 load-readonly <filename>
1093 \begin_layout Standard
1094 Load savestate <filename> in readonly mode.
1097 \begin_layout Subsubsection
1098 load-preserve <filename>
1101 \begin_layout Standard
1102 Load savestate <filename> in readonly mode, preserving current events.
1105 \begin_layout Subsubsection
1106 load-movie <filename>
1109 \begin_layout Standard
1110 Load savestate <filename>, ignoring save part in readonly mode.
1113 \begin_layout Subsubsection
1114 save-state <filename>
1117 \begin_layout Standard
1118 Save system state to <filename> as soon as possible.
1121 \begin_layout Subsubsection
1122 save-movie <filename>
1125 \begin_layout Standard
1126 Save movie to <filename>.
1129 \begin_layout Subsubsection
1133 \begin_layout Standard
1134 Set read-write mode.
1137 \begin_layout Subsubsection
1141 \begin_layout Standard
1145 \begin_layout Subsubsection
1149 \begin_layout Standard
1150 Toggle between read-only and read-write modes.
1153 \begin_layout Subsubsection
1157 \begin_layout Standard
1158 Set name of the game to <name>
1161 \begin_layout Subsubsection
1165 \begin_layout Standard
1166 Print the name of the game.
1169 \begin_layout Subsubsection
1173 \begin_layout Standard
1174 Adds new author <author>.
1175 If <author> does not contain '|' it is full name.
1176 If it contains '|', '|' splits the full name and nickname.
1179 \begin_layout Subsubsection
1180 edit-author <num> <author>
1183 \begin_layout Standard
1184 Edit the author in slot <num> (0-based) to be <author> (see add-author for
1188 \begin_layout Subsubsection
1192 \begin_layout Standard
1193 Remove author in slot <num>
1196 \begin_layout Subsubsection
1200 \begin_layout Standard
1204 \begin_layout Subsubsection
1205 test-1, test-2, test-3
1208 \begin_layout Standard
1209 Internal test commands.
1213 \begin_layout Subsubsection
1214 take-screenshot <filename>
1217 \begin_layout Standard
1218 Save screenshot to <filename>.
1221 \begin_layout Subsubsection
1222 +controller<num><button>
1225 \begin_layout Standard
1226 Press button <button> on controller <num> (1-8).
1227 The following button names are known:
1230 \begin_layout Itemize
1234 \begin_layout Itemize
1238 \begin_layout Itemize
1242 \begin_layout Itemize
1246 \begin_layout Itemize
1250 \begin_layout Itemize
1254 \begin_layout Itemize
1258 \begin_layout Itemize
1262 \begin_layout Itemize
1266 \begin_layout Itemize
1270 \begin_layout Itemize
1274 \begin_layout Itemize
1278 \begin_layout Itemize
1282 \begin_layout Itemize
1286 \begin_layout Itemize
1290 \begin_layout Itemize
1294 \begin_layout Subsubsection
1295 controllerh<num><button>
1298 \begin_layout Standard
1299 Hold/unhold button <button> on controller <num> (1-8).
1300 See +controller for button names.
1303 \begin_layout Subsubsection
1304 controllerf<num><button>
1307 \begin_layout Standard
1308 Hold/unhold button <button> on controller <num> (1-8) for the next frame.
1309 See +controller for button names.
1312 \begin_layout Standard
1313 Cauntion: Does not work properly if outside frame advance.
1316 \begin_layout Subsubsection
1317 autofire (<pattern>|-)...
1320 \begin_layout Standard
1321 Set autofire pattern.
1322 Each parameter is comma-separated list of button names (in form of 1start,
1323 1A, 2B, etc..) to hold on that frame.
1324 After reaching the end of pattern, the pattern restarts from the beginning.
1327 \begin_layout Subsubsection
1331 \begin_layout Standard
1335 \begin_layout Subsection
1339 \begin_layout Subsubsection
1340 cycle-jukebox-backward
1343 \begin_layout Standard
1344 Cycle save jukebox backwards.
1347 \begin_layout Subsubsection
1348 cycle-jukebox-forward
1351 \begin_layout Standard
1352 Cycle save jukebox forwards
1355 \begin_layout Subsubsection
1359 \begin_layout Standard
1360 Do load from jukebox (current mode).
1363 \begin_layout Subsubsection
1367 \begin_layout Standard
1368 Do state save to jukebox.
1371 \begin_layout Subsection
1375 \begin_layout Standard
1376 Only available if lua support is compiled in.
1379 \begin_layout Subsubsection
1380 evaluate-lua <luacode>
1383 \begin_layout Standard
1384 Run Lua code <luacode> using built-in Lua interpretter.
1387 \begin_layout Subsubsection
1391 \begin_layout Standard
1392 Run specified lua file using built-in Lua interpretter.
1395 \begin_layout Subsubsection
1399 \begin_layout Standard
1400 Clear the Lua VM state and restore to factory defaults.
1403 \begin_layout Subsection
1407 \begin_layout Subsubsection
1408 add-watch <name> <expression>
1411 \begin_layout Standard
1412 Adds new watch (or modifies old one).
1415 \begin_layout Subsubsection
1419 \begin_layout Standard
1423 \begin_layout Subsection
1427 \begin_layout Subsubsection
1428 enable-sound <on/off>
1431 \begin_layout Standard
1432 Enable/Disable sound.
1435 \begin_layout Subsubsection
1436 set-sound-device <device>
1439 \begin_layout Standard
1440 Set sound device to <device>
1443 \begin_layout Subsubsection
1447 \begin_layout Standard
1448 Show status of sound system.
1451 \begin_layout Subsubsection
1455 \begin_layout Standard
1456 Show all available devices.
1459 \begin_layout Subsubsection
1460 set-volume <multiplier>
1463 \begin_layout Standard
1464 Set the volume multiplier to <multiplier>.
1465 1 is normal volume, and higher numbers are louder.
1468 \begin_layout Subsubsection
1469 set-volume <multiplier>%
1472 \begin_layout Standard
1473 Set the volume multiplier to <multiplier> percent.
1474 100 is normal volume, and higher numbers are louder.
1477 \begin_layout Subsubsection
1478 set-volume <multiplier>dB
1481 \begin_layout Standard
1482 Set the volume multiplier to <multiplier> dB.
1483 0 is normal volume, and higher numbers are louder.
1484 The value may be negative.
1487 \begin_layout Subsection
1491 \begin_layout Subsubsection
1495 \begin_layout Standard
1496 Reloads the main ROM image from <file>.
1499 \begin_layout Subsubsection
1500 edit-subtitle <firstframe> <length> [<text>]
1503 \begin_layout Standard
1504 Edit or delete a subtitle.
1507 \begin_layout Subsubsection
1511 \begin_layout Standard
1515 \begin_layout Subsection
1519 \begin_layout Subsubsection
1523 \begin_layout Standard
1527 \begin_layout Subsubsection
1531 \begin_layout Standard
1535 \begin_layout Subsubsection
1539 \begin_layout Standard
1543 \begin_layout Subsubsection
1544 change-timebase <id> <newbase>
1547 \begin_layout Standard
1548 Change time base of <id> to <newbase>.
1549 The time base can be given as samples (integer) or second (postfix with
1553 \begin_layout Subsubsection
1554 import-stream-opus <timebase> <file>
1557 \begin_layout Standard
1558 Import opus stream from <file>, placing it at <timebase>.
1559 This operation is lossless.
1562 \begin_layout Subsubsection
1563 import-stream-pcm <timebase> <file>
1566 \begin_layout Standard
1567 Import PCM (.sox, 1ch@48kHz) stream from <file>, placing it at <timebase>.
1570 \begin_layout Subsubsection
1571 export-stream-opus <id> <file>
1574 \begin_layout Standard
1575 Export stream <id> as opus stream to <file>.
1576 This operation is lossless.
1579 \begin_layout Subsubsection
1580 export-stream-pcm <id> <file>
1583 \begin_layout Standard
1584 Export stream <id> as PCM (.sox) stream to <file>.
1588 \begin_layout Subsubsection
1589 export-superstream <file>
1592 \begin_layout Standard
1593 Export the entiere superstream as PCM (.sox) stream to <file>.
1596 \begin_layout Subsubsection
1597 load-collection <file>
1600 \begin_layout Standard
1601 Load collection (if there is existing collection, unload it) from <file>
1604 \begin_layout Subsubsection
1608 \begin_layout Standard
1612 \begin_layout Subsubsection
1616 \begin_layout Standard
1617 Tangent for recording voice for commentary track.
1618 While pressed, record a stream.
1621 \begin_layout Subsection
1622 SDL Platform commands
1625 \begin_layout Standard
1626 The following are valid on SDL platform.
1629 \begin_layout Subsubsection
1633 \begin_layout Standard
1634 Asks to press a key and then identifies that (pseudo-)key.
1637 \begin_layout Subsubsection
1641 \begin_layout Standard
1642 Toggle between windowed/fullscreen console.
1645 \begin_layout Subsubsection
1649 \begin_layout Standard
1650 Scroll messages window as far back as it goes.
1653 \begin_layout Subsubsection
1657 \begin_layout Standard
1658 Scroll messages window as far forward as it goes.
1661 \begin_layout Subsubsection
1665 \begin_layout Standard
1666 Scroll messages window back one screenful.
1669 \begin_layout Subsubsection
1673 \begin_layout Standard
1674 Scroll messages window forward one screenful.
1677 \begin_layout Subsubsection
1678 prompt-command <command>
1681 \begin_layout Standard
1682 Enter command prompt, with prompt prepopulated with specified command.
1685 \begin_layout Section
1689 \begin_layout Subsection
1693 \begin_layout Subsubsection
1697 \begin_layout Standard
1698 Set where bsnes looks for firmware files.
1700 \begin_inset Quotes eld
1704 \begin_inset Quotes erd
1710 \begin_layout Subsubsection
1714 \begin_layout Standard
1716 Numeric, range is 0.001 to
1717 \begin_inset Quotes eld
1721 \begin_inset Quotes erd
1725 Default is native framerate.
1728 \begin_layout Subsubsection
1732 \begin_layout Standard
1733 Set save compression level (integer 0-9).
1734 Default is 7 (0 is no compression).
1737 \begin_layout Subsubsection
1741 \begin_layout Standard
1742 Set the frame advance timeout in milliseconds.
1743 Numeric integer, range is 0-999999999.
1747 \begin_layout Subsubsection
1748 allow-inconsistent-saves (bsnes only)
1751 \begin_layout Standard
1752 If true, save without synchronization.
1753 Makes games seriously unstable.
1756 \begin_layout Subsubsection
1757 save-every-frame (bsnes only)
1760 \begin_layout Standard
1761 If true, simulate saving on each frame.
1762 Trades off emulation accuracy for sync stability.
1763 Also needed if the movie assumes saving on each frame for rewind.
1766 \begin_layout Subsection
1770 \begin_layout Subsubsection
1774 \begin_layout Standard
1775 AVI dumper: Always dump at 512x448 or 512x478 regardless of what the console
1779 \begin_layout Subsubsection
1783 \begin_layout Standard
1784 AVI dumper: Set the default left border thickness (unless lua overrides)
1790 \begin_layout Subsubsection
1794 \begin_layout Standard
1795 AVI dumper: Set the default right border thickness (unless lua overrides)
1801 \begin_layout Subsubsection
1805 \begin_layout Standard
1806 AVI dumper: Set the default top border thickness (unless lua overrides)
1812 \begin_layout Subsubsection
1816 \begin_layout Standard
1817 AVI dumper: Set the default bottom border thickness (unless lua overrides)
1823 \begin_layout Subsubsection
1827 \begin_layout Standard
1828 AVI dumper: Maximum number of frames per dump segment (0 => unlimited).
1833 \begin_layout Subsubsection
1837 \begin_layout Standard
1838 AVI dumper: Compression level (0-18).
1841 \begin_layout Itemize
1842 Compression levels 10 and above are not compatible with stock CSCD codec.
1845 \begin_layout Itemize
1846 Recomended level is 7.
1849 \begin_layout Subsubsection
1853 \begin_layout Standard
1854 AVI dumper: Set method of determining the sound rate.
1857 \begin_layout Itemize
1858 0: Pick nearest of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48, 64, 88.2, 96,
1859 128, 176.4 and 192 kHz.
1862 \begin_layout Itemize
1863 1: Round down to nearest integer.
1866 \begin_layout Itemize
1867 2: Round up to nearest ingeter.
1870 \begin_layout Subsection
1874 \begin_layout Subsubsection
1878 \begin_layout Standard
1879 JMD dumper: Compression level (0-9).
1882 \begin_layout Subsection
1883 SDL platform settings
1886 \begin_layout Subsubsection
1887 autorepeat-first-delay
1890 \begin_layout Standard
1891 Sets the delay for first character in typematic autorepeat.
1894 \begin_layout Subsubsection
1895 autorepeat-subsequent-delay
1898 \begin_layout Standard
1899 Sets the delay for subsequent characters in typematic autorepeat.
1902 \begin_layout Section
1906 \begin_layout Subsection
1907 Core (in main table)
1910 \begin_layout Subsubsection
1914 \begin_layout Standard
1915 Print line to message console.
1918 \begin_layout Subsubsection
1919 exec(string command)
1922 \begin_layout Standard
1923 Run command as it was entered on the command line
1926 \begin_layout Subsubsection
1930 \begin_layout Standard
1932 First is time since some epoch in seconds, the second is microseconds mod
1933 10^6 since that epoch.
1936 \begin_layout Subsubsection
1940 \begin_layout Standard
1941 Returns true if emulator has finished booting, false if not (on_startup()
1942 will be issued later).
1945 \begin_layout Subsubsection
1946 set_idle_timeout(number timeout)
1949 \begin_layout Standard
1950 Set number of microseconds to block idle for.
1951 After this timeout has expired, on_idle() will be called once.
1954 \begin_layout Subsubsection
1955 set_timer_timeout(number timeout)
1958 \begin_layout Standard
1959 Set number of microseconds to block timer for.
1960 After this timeout has expired, on_timer() will be called once.
1963 \begin_layout Subsubsection
1964 bus_address(number snesaddr)
1967 \begin_layout Standard
1968 Returns virtual address corresponding to specified address on SNES bus.
1971 \begin_layout Subsubsection
1972 loopwrapper(function fun, ...)
1975 \begin_layout Standard
1976 Calls function fun with function and specified arguments.
1977 The function passed suspends execution until the function returned is called.
1978 Handy for linear flow control among multiple invocations of a hook.
1982 \begin_layout LyX-Code
1983 on_paint = loopwrapper(function(wait)
1987 \begin_layout LyX-Code
1992 \begin_layout LyX-Code
1994 \begin_inset Quotes eld
1998 \begin_inset Quotes erd
2004 \begin_layout LyX-Code
2009 \begin_layout LyX-Code
2014 \begin_layout LyX-Code
2018 \begin_layout Subsubsection
2019 list_bindings([string cmd])
2022 \begin_layout Standard
2023 Get table of all keybindings, indexed by keyspec (modifiers|mask/key).
2024 If command is specified, the table is limited to that command.
2027 \begin_layout Subsubsection
2028 get_alias(string aname)
2031 \begin_layout Standard
2032 Get expansion of given alias.
2035 \begin_layout Subsubsection
2036 set_alias(string aname, string value)
2039 \begin_layout Standard
2040 Set expansion of given alias.
2043 \begin_layout Subsubsection
2044 create_ibind(string name, string cmd)
2047 \begin_layout Standard
2048 Return object representing inverse binding with specified name and specified
2052 \begin_layout Itemize
2053 To create press/release commands, use aliases +foo and -foo .
2056 \begin_layout Itemize
2057 Keep the returned object around.
2060 \begin_layout Subsection
2064 \begin_layout Standard
2065 Bitwise logical functions and related.
2068 \begin_layout Subsubsection
2069 bit.none(number...) / bit.bnot(number...)
2072 \begin_layout Standard
2073 48-bit bitwise NOT / NONE function (set bits that are set in none of the
2077 \begin_layout Subsubsection
2078 bit.any(number...) / bit.bor(number...)
2081 \begin_layout Standard
2082 48-bit bitwise OR / ANY function (set bits that are set in any of the arguments).
2085 \begin_layout Subsubsection
2086 bit.all(number...) / bit.band(number...)
2089 \begin_layout Standard
2090 48-bit bitwise AND / ALL function (set bits that are set in all of the arguments
2094 \begin_layout Subsubsection
2095 bit.parity(number...) / bit.bxor(number...)
2098 \begin_layout Standard
2099 48-bit bitwise XOR / PARITY function (set bits that are set in odd number
2103 \begin_layout Subsubsection
2104 bit.lrotate(number base[, number amount[, number bits]])
2107 \begin_layout Standard
2108 Rotate bits-bit (max 48, default 48) number left by amount (default 1) places.
2111 \begin_layout Subsubsection
2112 bit.rrotate(number base[, number amount[, number bits]])
2115 \begin_layout Standard
2116 Rotate bits-bit (max 48, default 48) number right by amount (default 1)
2120 \begin_layout Subsubsection
2121 bit.lshift(number base[, number amount[, number bits]])
2124 \begin_layout Standard
2125 Shift bits-bit (max 48, default 48) number left by amount (default 1) places.
2126 The new bits are filled with zeroes.
2129 \begin_layout Subsubsection
2130 bit.lrshift(number base[, number amount[, number bits]])
2133 \begin_layout Standard
2134 Shift bits-bit (max 48, default 48) number logically right by amount (default
2136 The new bits are filled with zeroes.
2139 \begin_layout Subsubsection
2140 bit.arshift(number base[, number amount[, number bits]])
2143 \begin_layout Standard
2144 Shift bits-bit (max 48, default 48) number arithmetically right by amount
2146 The new bits are shifted in with copy of the high bit.
2149 \begin_layout Subsubsection
2150 bit.extract(number base[, number bit0[, number bit1,...]])
2153 \begin_layout Standard
2154 Returns number that has bit0-th bit as bit 0, bit1-th bit as 1 and so on.
2157 \begin_layout Standard
2161 \begin_layout Itemize
2162 Bit numbers up to 51 should work reliably (then things start falling apart
2163 due to double precision issues).
2166 \begin_layout Itemize
2167 There are two special bit positions, true and false, standing for always
2168 set bit and always clear bit.
2171 \begin_layout Subsubsection
2172 bit.value([number bit1[, number bit2,...]])
2175 \begin_layout Standard
2176 Returns bitwise OR of 1 left shifted by bit1 places, 1 left shifted by bit2
2178 As special value, nil argument is no-op.
2181 \begin_layout Subsubsection
2182 bit.test_any(number a, number b)
2185 \begin_layout Standard
2186 Is there a common set bit in a and b?
2189 \begin_layout Subsubsection
2190 bit.test_all(number a, number b)
2193 \begin_layout Standard
2194 Are all set bits in b also set in a?
2197 \begin_layout Subsubsection
2198 bit.popcount(number a)
2201 \begin_layout Standard
2202 Population count of a.
2205 \begin_layout Subsubsection
2206 bit.clshift(number a, number b, [number amount,[number bits]])
2209 \begin_layout Standard
2210 Does chained left shift on a, b by amount positions, assuming numbers to
2211 be of specified number of bits.
2214 \begin_layout Subsubsection
2215 bit.crshift(number a, number b, [number amount,[number bits]])
2218 \begin_layout Standard
2219 Does chained right shift on a, b by amount positions, assuming numbers to
2220 be of specified number of bits.
2223 \begin_layout Subsubsection
2224 bit.flagdecode(number a, number bits, [string on, [string off]])
2227 \begin_layout Standard
2228 Return string of length bits where ith character is ith character of on
2229 if bit i is on, otherwise ith character of off.
2230 Out of range reads give last character, or '*'/'-' if empty.
2233 \begin_layout Subsubsection
2234 bit.rflagdecode(number a, number bits, [string on, [string off]])
2237 \begin_layout Standard
2238 Like bit.flagdecode, but outputs the string in the opposite order (most significa
2242 \begin_layout Subsection
2246 \begin_layout Standard
2247 Most of these functions can only be called in on_paint and on_video callbacks.
2248 Exceptions are noted.
2251 \begin_layout Standard
2253 Bits 0-7 are the blue component, bits 8-15 are the green component, bits
2254 16-23 are the red component, bits 24-31 are alpha component (0 is fully
2255 opaque, 255 is almost transparent).
2256 -1 is the fully transparent color.
2257 Alpha values greater than 127 do work.
2260 \begin_layout Standard
2261 Origin of coordinates is at top left corner of game display area.
2262 Left and top gaps correspond to negative coordinates.
2265 \begin_layout Subsubsection
2269 \begin_layout Standard
2270 Returns 2-tuple (hresolution, vresolution).
2273 \begin_layout Subsubsection
2274 gui.<class>_gap(number gap)
2277 \begin_layout Standard
2278 Set the <class> (left, right, top, bottom) gap to specified value (max gap
2282 \begin_layout Subsubsection
2283 gui.text(number x, number y, string text[, number fgc[, number bgc]])
2286 \begin_layout Standard
2287 Draw specified text on the GUI (each character cell is 8 or 16 wide and
2292 \begin_layout Itemize
2293 x: X-coordinate to start the drawing from (and x-coordinate at begining
2297 \begin_layout Itemize
2298 y: Y-coordinate to start the drawing from.
2301 \begin_layout Itemize
2302 text: The text to draw.
2305 \begin_layout Itemize
2306 fgc: Text color (default is 0xFFFFFF (white))
2309 \begin_layout Itemize
2310 bgc: Background color (default is -1 (transparent))
2313 \begin_layout Subsubsection
2314 gui.textH(number x, number y, string text[, number fgc[, number bgc]])
2317 \begin_layout Standard
2318 Like gui.text, but draw using double-width.
2321 \begin_layout Subsubsection
2322 gui.textV(number x, number y, string text[, number fgc[, number bgc]])
2325 \begin_layout Standard
2326 Like gui.text, but draw using double-height.
2329 \begin_layout Subsubsection
2330 gui.textHV(number x, number y, string text[, number fgc[, number bgc]])
2333 \begin_layout Standard
2334 Like gui.text, but draw using double-width/double-height.
2337 \begin_layout Subsubsection
2338 gui.rectangle(number x, number y, number width, number height[, number thickness[
2339 , number outline[, number fill]]])
2342 \begin_layout Standard
2343 Draw rectangle on the GUI.
2347 \begin_layout Itemize
2348 x: X-coordinate of left edge.
2351 \begin_layout Itemize
2352 y: Y-coordinate of upper edge.
2355 \begin_layout Itemize
2356 width: Width of rectangle.
2359 \begin_layout Itemize
2360 height: Height of rectangle.
2363 \begin_layout Itemize
2364 thickness: Thickness of outline (default is 1).
2367 \begin_layout Itemize
2368 outline: Color of outline (default is 0xFFFFFF (white))
2371 \begin_layout Itemize
2372 fill: Color of fill (default is -1 (transparent))
2375 \begin_layout Subsubsection
2376 gui.box(number x, number y, number width, number height[, number thickness[,
2377 number outline1[,number outline2[, number fill]]]])
2380 \begin_layout Standard
2381 Draw rectangle with 3D effect on the GUI.
2385 \begin_layout Itemize
2386 x: X-coordinate of left edge.
2389 \begin_layout Itemize
2390 y: Y-coordinate of upper edge.
2393 \begin_layout Itemize
2394 width: Width of rectangle.
2397 \begin_layout Itemize
2398 height: Height of rectangle.
2401 \begin_layout Itemize
2402 thickness: Thickness of outline (default is 1).
2405 \begin_layout Itemize
2406 outline1: First color of outline (default is 0xFFFFFF (white))
2409 \begin_layout Itemize
2410 outline2: First color of outline (default is 0x808080 (dark gray))
2413 \begin_layout Itemize
2414 fill: Color of fill (default is 0xC0C0C0 (light grayy))
2417 \begin_layout Subsubsection
2418 gui.pixel(number x, number y[, number color])
2421 \begin_layout Standard
2422 Draw one pixel on the GUI.
2426 \begin_layout Itemize
2427 x: X-coordinate of the pixel
2430 \begin_layout Itemize
2431 y: Y-coordinate of the pixel
2434 \begin_layout Itemize
2435 color: Color of the pixel (default is 0xFFFFFF (white))
2438 \begin_layout Subsubsection
2439 gui.crosshair(number x, number y[, number length[, number color]])
2442 \begin_layout Standard
2447 \begin_layout Itemize
2448 x: X-coordinate of the crosshair
2451 \begin_layout Itemize
2452 y: Y-coordinate of the crosshair
2455 \begin_layout Itemize
2456 length: Length of the crosshair lines (default 10).
2459 \begin_layout Itemize
2460 color: Color of the crosshair (default is 0xFFFFFF (white))
2463 \begin_layout Subsubsection
2464 gui.line(number x1, number y1, number x2, number y2[, number color])
2467 \begin_layout Standard
2472 \begin_layout Itemize
2473 x1: X-coordinate of one end.
2476 \begin_layout Itemize
2477 y1: Y-coordinate of one end.
2480 \begin_layout Itemize
2481 x2: X-coordinate of the other end.
2484 \begin_layout Itemize
2485 y2: Y-coordinate of the other end.
2488 \begin_layout Itemize
2489 color: Color of the line (default is 0xFFFFFF (white)).
2492 \begin_layout Subsubsection
2493 gui.circle(number x, number y, number r[, number thick[, number border[,
2497 \begin_layout Standard
2502 \begin_layout Itemize
2503 x: X-coordinate of the center
2506 \begin_layout Itemize
2507 y: Y-coordinate of the center
2510 \begin_layout Itemize
2511 r: The radius of the circle
2514 \begin_layout Itemize
2515 thick: Border thickness
2518 \begin_layout Itemize
2519 border: Border color (default is 0xFFFFFF (white))
2522 \begin_layout Itemize
2523 fill: Fill color (default is -1 (transparent)).
2526 \begin_layout Subsubsection
2527 gui.bitmap_draw(number x, number y, bitmap bitmap, palette palette)
2530 \begin_layout Standard
2531 Draw a bitmap on screen with specified palette.
2535 \begin_layout Itemize
2536 x: X-coordinate of left edge.
2539 \begin_layout Itemize
2540 y: Y-coordinate of top edge.
2543 \begin_layout Itemize
2544 bitmap: The bitmap to draw
2547 \begin_layout Itemize
2548 palette: The palette to draw the bitmap using.
2551 \begin_layout Subsubsection
2552 gui.bitmap_draw(number x, number y, dbitmap bitmap)
2555 \begin_layout Standard
2556 Draw a bitmap on screen.
2560 \begin_layout Itemize
2561 x: X-coordinate of left edge.
2564 \begin_layout Itemize
2565 y: Y-coordinate of top edge.
2568 \begin_layout Itemize
2569 bitmap: The bitmap to draw
2572 \begin_layout Subsubsection
2576 \begin_layout Standard
2577 Returns a new palette (initially all transparent).
2578 Can be used anywhere.
2581 \begin_layout Subsubsection
2582 gui.bitmap_new(number w, number h, boolean direct[, bool icolor])
2585 \begin_layout Standard
2586 Returns a new bitmap/dbitmap.
2587 Can be used anywhere.
2591 \begin_layout Itemize
2592 w: The width of new bitmap
2595 \begin_layout Itemize
2596 h: The height of new bitmap
2599 \begin_layout Itemize
2600 direct: If true, the returned bitmap is dbitmap, otherwise bitmap.
2603 \begin_layout Itemize
2604 icolor: Initital fill color (defaults to 0 on BITMAP, -1 on DBITMAP)
2607 \begin_layout Subsubsection
2608 gui.bitmap_load(string file)
2611 \begin_layout Standard
2612 Returns loaded bitmap/dbitmap (if bitmap, the second return value is palette
2614 Can be used anywhere.
2618 \begin_layout Itemize
2619 file: The name of file to load.
2622 \begin_layout Subsubsection
2623 gui.palette_set(palette palette, number index, number color)
2626 \begin_layout Standard
2627 Sets color in palette.
2628 Can be used anywhere.
2632 \begin_layout Itemize
2633 palette: The palette to manipulate
2636 \begin_layout Itemize
2637 index: Index of color (0-65535).
2640 \begin_layout Itemize
2641 color: The color value.
2644 \begin_layout Subsubsection
2645 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y, number color)
2648 \begin_layout Standard
2649 Sets specified pixel in bitmap.
2650 Can be used anywhere.
2654 \begin_layout Itemize
2655 bitmap: The bitmap to manipulate
2658 \begin_layout Itemize
2659 x: The x-coordinate of the pixel.
2662 \begin_layout Itemize
2663 y: The y-coordinate of the pixel.
2666 \begin_layout Itemize
2667 color: If bitmap is a bitmap, color index (0-65535).
2668 Otherwise color value.
2671 \begin_layout Subsubsection
2672 gui.bitmap_size(bitmap/dbitmap bitmap)
2675 \begin_layout Standard
2677 Can be used anywhere.
2681 \begin_layout Itemize
2682 bitmap: The bitmap to query.
2685 \begin_layout Standard
2686 The first return is the width, the second is the height.
2689 \begin_layout Subsubsection
2690 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy, bitmap/dbitmap
2691 src, number sx, number sy, number w, number h[, number ck])
2694 \begin_layout Standard
2695 Blit a part of bitmap to another.
2696 Can be used anywhere.
2700 \begin_layout Itemize
2701 dest: Destination to blit to.
2704 \begin_layout Itemize
2705 dx: left edge of target
2708 \begin_layout Itemize
2709 dy: Top edge of target
2712 \begin_layout Itemize
2713 src: The source to blit from.
2714 Must be of the same type as destination.
2717 \begin_layout Itemize
2718 sx: left edge of source
2721 \begin_layout Itemize
2722 sy: Top edge of source
2725 \begin_layout Itemize
2729 \begin_layout Itemize
2730 h: Height of region.
2733 \begin_layout Itemize
2735 Pixels of this color are not blitted.
2739 \begin_layout Itemize
2740 If bitmaps are bitmaps, this is color index of colorkey.
2741 Values outside range 0-65535 cause no key to be used as colorkey.
2744 \begin_layout Itemize
2745 If bitmaps are dbitmaps, this color value of colorkey.
2748 \begin_layout Itemize
2749 May be absent or nil for no colorkey blit.
2753 \begin_layout Subsubsection
2757 \begin_layout Standard
2758 Request on_repaint() to happen as soon as possible.
2759 Can be used anywhere.
2762 \begin_layout Subsubsection
2763 gui.subframe_update(boolean on)
2766 \begin_layout Standard
2767 Request subframe updates (calling on_paint() on subframes) to happen (on=true)
2768 or not happen (on=false).
2769 Can be used anywhere.
2772 \begin_layout Subsubsection
2773 gui.screenshot(string filename)
2776 \begin_layout Standard
2777 Write PNG screenshot of the current frame (no drawings) to specified file.
2778 Can be used anywhere.
2781 \begin_layout Subsubsection
2782 gui.color(number r, number g, number b[, number a])
2785 \begin_layout Standard
2786 Returns color (in notation Lua scripts use) corresponding to color (r,g,b),
2787 each component in scale 0-255.
2788 If a is specified, that is alpha (0 is fully transparent, 256(sic) is fully
2790 The default alpha is 256.
2793 \begin_layout Subsubsection
2794 gui.status(string name, string value)
2797 \begin_layout Standard
2799 \begin_inset Quotes eld
2803 \begin_inset Quotes erd
2806 to <value> in status area.
2807 Can be used anywhere.
2810 \begin_layout Subsubsection
2811 gui.rainbow(number step, number steps[, number color])
2814 \begin_layout Standard
2815 Perform hue rotation of color <color> (default bright red), by <step> steps.
2816 The number of steps per full rotation is given by absolute value of <steps>.
2819 \begin_layout Standard
2820 If <steps> is negative, the rotation will be counterclockwise.
2823 \begin_layout Subsubsection
2824 gui.screenshot(string filename)
2827 \begin_layout Standard
2828 Saves a screenshot into specified file.
2831 \begin_layout Subsubsection
2832 gui.loadfont(string filename)
2835 \begin_layout Standard
2836 Loads font from specified file (CUSTOMFONT object).
2839 \begin_layout Subsubsection
2840 CUSTOMFONT(number x, number y, string text[, number fgc[, number bgc]])
2843 \begin_layout Standard
2844 Draw string with custom font to screen.
2845 The parameters are the same as in gui.text.
2848 \begin_layout Subsection
2852 \begin_layout Standard
2854 Only available in on_input callback.
2857 \begin_layout Subsubsection
2858 input.get(number controller, number index)
2861 \begin_layout Standard
2862 Read the specified index (0-11) from specified controller (0-7).
2866 \begin_layout Itemize
2867 Uses physical controller numbering.
2868 Gamepad in port 2 is controller 4, not 1!
2871 \begin_layout Subsubsection
2872 input.set(number controller, number index, number value)
2875 \begin_layout Standard
2876 Write the specified index (0-11) from specified controller (0-7), storing
2881 \begin_layout Itemize
2882 Uses physical controller numbering.
2883 Gamepad in port 2 is controller 4, not 1!
2886 \begin_layout Subsubsection
2887 input.get2(number port, number controller, number index)
2890 \begin_layout Standard
2891 Read the specified input tuple.
2894 \begin_layout Itemize
2895 Port 0 is system port.
2898 \begin_layout Subsubsection
2899 input.set2(number port, number controller, number index, number value)
2902 \begin_layout Standard
2903 Write the specified input tuple.
2906 \begin_layout Itemize
2907 Port 0 is system port.
2910 \begin_layout Subsubsection
2911 input.lcid_to_pcid2(number lcid)
2914 \begin_layout Standard
2915 Look up physical pcid pair (port, controller) corresponding to specified
2916 logical controller (1-based).
2917 Returns nothing if controller does not exist.
2920 \begin_layout Subsubsection
2921 input.port_type(number port)
2924 \begin_layout Standard
2925 Return type of specified port.
2928 \begin_layout Subsubsection
2929 input.controller_info(number port, number controller)
2932 \begin_layout Standard
2933 Get controller info for specified controller.
2934 If controller does not exist, returns nil.
2935 Otherwise returns a table with following fields:
2938 \begin_layout Itemize
2939 type (string): Type of the controller.
2942 \begin_layout Itemize
2943 class (string): Class of the controller.
2946 \begin_layout Itemize
2947 classnum (number): Number of the controller within its class (1-based)
2950 \begin_layout Itemize
2951 lcid (number): Logical controller number of the controller.
2954 \begin_layout Itemize
2955 button_count (number): Number of buttons on controller
2958 \begin_layout Itemize
2959 buttons (array): Array of following info about each button:
2963 \begin_layout Itemize
2964 type (string): Type of button.
2966 \begin_inset Quotes eld
2970 \begin_inset Quotes erd
2974 \begin_inset Quotes eld
2978 \begin_inset Quotes erd
2982 \begin_inset Quotes eld
2986 \begin_inset Quotes erd
2990 \begin_inset Quotes eld
2994 \begin_inset Quotes erd
3000 \begin_layout Itemize
3001 name (string): Name of button.
3004 \begin_layout Itemize
3005 symbol (string): Symbol of button.
3006 Only present for type
3007 \begin_inset Quotes eld
3011 \begin_inset Quotes erd
3017 \begin_layout Itemize
3018 hidden (boolean): True if hidden button.
3023 \begin_layout Subsubsection
3024 input.geta(number controller)
3027 \begin_layout Standard
3028 Get input state for entiere controller.
3029 Returns 13 return values.
3032 \begin_layout Itemize
3033 1st return value: Bitmask: bit i is set if i:th index is nonzero
3036 \begin_layout Itemize
3037 2nd-13th return value: value of i:th index.
3040 \begin_layout Subsubsection
3041 input.seta(number controller, number bitmask, number args...)
3044 \begin_layout Standard
3045 Set state for entiere controller.
3046 args is up to 12 values for indices (overriding values in bitmask if specified).
3049 \begin_layout Subsubsection
3050 input.controllertype(number controller)
3053 \begin_layout Standard
3054 Get the type of controller as string.
3058 \begin_layout Itemize
3062 \begin_layout Itemize
3066 \begin_layout Itemize
3070 \begin_layout Itemize
3074 \begin_layout Subsubsection
3075 input.reset([number cycles])
3078 \begin_layout Standard
3080 If cycles is greater than zero, do delayed reset.
3081 0 (or no value) causes immediate reset.
3084 \begin_layout Itemize
3085 Only available with subframe flag false.
3088 \begin_layout Subsubsection
3092 \begin_layout Standard
3093 Returns table of tables of all available keys and axes.
3094 The first table is indexed by key name (platform-dependent!), and the inner
3095 table has the following fields:
3098 \begin_layout Itemize
3099 last_rawval: Last reported raw value for control.
3102 \begin_layout Itemize
3103 ktype: Type of key (disabled, key, mouse, axis, axis-inverse, hat, pressure-m0,
3104 pressure-mp, pressure-0m, pressure-0p, pressure-pm, pressure-p0).
3107 \begin_layout Itemize
3108 cal_left: Minimum calibration value.
3109 Only meaningful with axis and pressure types.
3112 \begin_layout Itemize
3113 cal_center: Center calibration value.
3114 Only meaningful with axis and pressure types.
3117 \begin_layout Itemize
3118 cal_right: Maximum calibration value.
3119 Only meaningful with axis and pressure types.
3122 \begin_layout Itemize
3123 cal_tolerance: Dead zone tolerance.
3124 Only meaningful with axis and pressure types.
3127 \begin_layout Subsubsection
3128 input.keyhook(string key, boolean state)
3131 \begin_layout Standard
3132 Requests that keyhook events to be sent for key (state=true) or not sent
3136 \begin_layout Subsubsection
3137 input.joyget(number controller)
3140 \begin_layout Standard
3141 Returns table for current controls for specified controller.
3142 The names of fields vary by controller type.
3145 \begin_layout Itemize
3146 The buttons have the same name as those are referred to in other contexts
3150 \begin_layout Itemize
3152 \begin_inset Quotes eld
3156 \begin_inset Quotes erd
3160 \begin_inset Quotes eld
3164 \begin_inset Quotes erd
3170 \begin_layout Subsubsection
3171 input.joyset(number controller, table controls)
3174 \begin_layout Standard
3175 Set the the state of specified controller to values specified in specified
3179 \begin_layout Subsubsection
3180 input.lcid_to_pcid(number controller)
3183 \begin_layout Standard
3184 Return the physical index, physical port and controller number in port for
3185 specified (1-based) logical controller.
3188 \begin_layout Subsection
3192 \begin_layout Standard
3196 \begin_layout Subsubsection
3197 subtitle.byindex(number i)
3200 \begin_layout Standard
3201 Read the frame and length of ith subtitle.
3202 Returns nothing if not present.
3205 \begin_layout Subsubsection
3206 subtitle.set(number f, number l, string txt)
3209 \begin_layout Standard
3210 Set the text of subtitle.
3213 \begin_layout Subsubsection
3214 subtitle.get(number f, number l)
3217 \begin_layout Standard
3218 Get the text of subtitle.
3221 \begin_layout Subsubsection
3222 subtitle.delete(number f, number l)
3225 \begin_layout Standard
3226 Delete specified subtitle.
3229 \begin_layout Subsection
3233 \begin_layout Standard
3234 Host memory handling (extra memory saved to savestates).
3235 Host memory starts empty.
3238 \begin_layout Subsubsection
3239 hostmemory.read(number address)
3242 \begin_layout Standard
3243 Reads hostmemory slot address.
3244 Slot numbers out of range return false instead of numeric.
3247 \begin_layout Subsubsection
3248 hostmemory.write(number address, number value)
3251 \begin_layout Standard
3252 Writes hostmemory slot with 0-255.
3253 Slot numbers out of range cause extension of host memory slot space.
3256 \begin_layout Subsubsection
3257 hostmemory.readbyte(number address)
3260 \begin_layout Standard
3261 Read unsigned byte (1 element) from given address.
3262 Slots out of range return false.
3265 \begin_layout Subsubsection
3266 hostmemory.writebyte(number address, number value)
3269 \begin_layout Standard
3270 Write unsigned byte (1 element) to given slot.
3271 Slot numbers out of range cause extension.
3274 \begin_layout Subsubsection
3275 hostmemory.readsbyte(number address)
3278 \begin_layout Standard
3279 Read signed byte (1 element) from given address.
3280 Slots out of range return false.
3283 \begin_layout Subsubsection
3284 hostmemory.writesbyte(number address, number value)
3287 \begin_layout Standard
3288 Write signed byte (1 element) to given slot.
3289 Slot numbers out of range cause extension.
3292 \begin_layout Subsubsection
3293 hostmemory.readword(number address)
3296 \begin_layout Standard
3297 Read unsigned word (2 elements) from given address.
3298 Slots out of range return false.
3301 \begin_layout Subsubsection
3302 hostmemory.writeword(number address, number value)
3305 \begin_layout Standard
3306 Write unsigned word (2 elements) to given slot.
3307 Slot numbers out of range cause extension.
3310 \begin_layout Subsubsection
3311 hostmemory.readsword(number address)
3314 \begin_layout Standard
3315 Read signed word (2 elements) from given address.
3316 Slots out of range return false.
3319 \begin_layout Subsubsection
3320 hostmemory.writesword(number address, number value)
3323 \begin_layout Standard
3324 Write signed word (2 elements) to given slot.
3325 Slot numbers out of range cause extension.
3328 \begin_layout Subsubsection
3329 hostmemory.readdword(number address)
3332 \begin_layout Standard
3333 Read unsigned doubleword (4 elements) from given address.
3334 Slots out of range return false.
3337 \begin_layout Subsubsection
3338 hostmemory.writedword(number address, number value)
3341 \begin_layout Standard
3342 Write unsigned doubleword (4 elements) to given slot.
3343 Slot numbers out of range cause extension.
3346 \begin_layout Subsubsection
3347 hostmemory.readsdword(number address)
3350 \begin_layout Standard
3351 Read signed doubleword (4 elements) from given address.
3352 Slots out of range return false.
3355 \begin_layout Subsubsection
3356 hostmemory.writesdword(number address, number value)
3359 \begin_layout Standard
3360 Write signed doubleword (4 elements) to given slot.
3361 Slot numbers out of range cause extension.
3364 \begin_layout Subsubsection
3365 hostmemory.readqword(number address)
3368 \begin_layout Standard
3369 Read unsigned quadword (8 elements) from given address.
3370 Slots out of range return false.
3373 \begin_layout Subsubsection
3374 hostmemory.writeqword(number address, number value)
3377 \begin_layout Standard
3378 Write unsigned quadword (4 elements) to given slot.
3379 Slot numbers out of range cause extension.
3382 \begin_layout Subsubsection
3383 hostmemory.readsqword(number address)
3386 \begin_layout Standard
3387 Read signed quadword (8 elements) from given address.
3388 Slots out of range return false.
3391 \begin_layout Subsubsection
3392 hostmemory.writesqword(number address, number value)
3395 \begin_layout Standard
3396 Write signed quadword (8 elements) to given slot.
3397 Slot numbers out of range cause extension.
3400 \begin_layout Subsection
3404 \begin_layout Standard
3408 \begin_layout Subsubsection
3409 movie.currentframe()
3412 \begin_layout Standard
3413 Return number of current frame.
3416 \begin_layout Subsubsection
3420 \begin_layout Standard
3421 Return number of frames in movie.
3424 \begin_layout Subsubsection
3428 \begin_layout Standard
3429 Return true if in readonly mode, false if in readwrite.
3432 \begin_layout Subsubsection
3436 \begin_layout Standard
3437 Returns the current value of rerecord count.
3440 \begin_layout Subsubsection
3441 movie.set_readwrite()
3444 \begin_layout Standard
3445 Set readwrite mode (does not cause on_readwrite callback).
3448 \begin_layout Subsubsection
3449 movie.frame_subframes(number frame)
3452 \begin_layout Standard
3453 Count number of subframes in specified frame (frame numbers are 1-based)
3457 \begin_layout Subsubsection
3458 movie.read_subframe(number frame, number subframe)
3461 \begin_layout Standard
3462 Read specifed subframe in specified frame and return data as array (100
3463 elements, numbered 0-99 currently).
3466 \begin_layout Subsubsection
3470 \begin_layout Standard
3471 Returns the current value of the RTC as a pair (second, subsecond).
3474 \begin_layout Subsubsection
3475 movie.unsafe_rewind([UNSAFEREWIND state])
3478 \begin_layout Standard
3479 Start setting point for unsafe rewind or jump to point of unsafe rewind.
3482 \begin_layout Itemize
3483 If called without argument, causes emulator to start process of setting
3484 unsafe rewind point.
3485 When this has finished, callback on_set_rewind occurs, passing the rewind
3486 state to lua script.
3489 \begin_layout Itemize
3490 If called with argument, causes emulator rewind to passed rewind point as
3492 Readwrite mode is implicitly activated.
3495 \begin_layout Standard
3496 The following warnings apply to unsafe rewinding:
3499 \begin_layout Itemize
3500 There are no safety checks against misuse (that's what
3501 \begin_inset Quotes eld
3505 \begin_inset Quotes erd
3511 \begin_layout Itemize
3512 Only call rewind from timeline rewind point was set from.
3515 \begin_layout Itemize
3516 Only call rewind from after the rewind point was set.
3519 \begin_layout Subsection
3523 \begin_layout Standard
3524 Routines for settings manipulation
3527 \begin_layout Subsubsection
3528 settings.get(string name)
3531 \begin_layout Standard
3532 Get value of setting.
3533 If setting is blank, returns false.
3534 If setting value can't be obtained, returns (nil, error message).
3537 \begin_layout Subsubsection
3538 settings.set(string name, string value)
3541 \begin_layout Standard
3542 Set value of setting.
3543 If setting can't be set, returns (nil, error message).
3546 \begin_layout Subsubsection
3547 settings.is_set(string name)
3550 \begin_layout Standard
3551 Returns if setting is set.
3552 If setting does not exist, returns (nil, error message).
3555 \begin_layout Subsubsection
3556 settings.blank(string name)
3559 \begin_layout Standard
3560 Blanks a setting and returns true.
3561 If setting can't be blanked, returns (nil, error message).
3564 \begin_layout Subsection
3568 \begin_layout Standard
3569 Contains various functions for managing memory
3572 \begin_layout Subsubsection
3576 \begin_layout Standard
3577 Returns the number of VMAs
3580 \begin_layout Subsubsection
3581 memory.read_vma(number index)
3584 \begin_layout Standard
3585 Reads the specified VMA (indices start from zero).
3586 Trying to read invalid VMA gives nil.
3587 The read VMA is table with the following fields:
3590 \begin_layout Itemize
3591 region_name (string): The readable name of the VMA
3594 \begin_layout Itemize
3595 baseaddr (number): Base address of the VMA
3598 \begin_layout Itemize
3599 lastaddr (number): Last address in the VMA.
3602 \begin_layout Itemize
3603 size (number): The size of VMA in bytes.
3606 \begin_layout Itemize
3607 readonly (boolean): True of the VMA corresponds to ROM.
3610 \begin_layout Itemize
3611 iospace (boolean): True if the VMA is I/O space.
3614 \begin_layout Itemize
3615 native_endian (boolean): True if the VMA has native endian as opposed to
3619 \begin_layout Subsubsection
3620 memory.find_vma(number address)
3623 \begin_layout Standard
3624 Finds the VMA containing specified address.
3625 Returns table in the same format as read_vma or nil if not found.
3628 \begin_layout Subsubsection
3629 memory.readbyte(number address)
3632 \begin_layout Standard
3633 Reads the specified address as unsigned byte and returns the result.
3636 \begin_layout Subsubsection
3637 memory.readsbyte(number address)
3640 \begin_layout Standard
3641 Reads the specified address as signed byte and returns the result.
3644 \begin_layout Subsubsection
3645 memory.writebyte(number address, number value)
3648 \begin_layout Standard
3649 Writes the specified value (negative values undergo 2's complement) to specified
3650 address (as a byte).
3653 \begin_layout Subsubsection
3654 memory.readword(number address)
3657 \begin_layout Standard
3658 Reads the specified address as unsigned word and returns the result.
3661 \begin_layout Subsubsection
3662 memory.readsword(number address)
3665 \begin_layout Standard
3666 Reads the specified address as signed word and returns the result.
3669 \begin_layout Subsubsection
3670 memory.writeword(number address, number value)
3673 \begin_layout Standard
3674 Writes the specified value (negative values undergo 2's complement) to specified
3675 address (as a word).
3678 \begin_layout Subsubsection
3679 memory.readdword(number address)
3682 \begin_layout Standard
3683 Reads the specified address as unsigned doubleword and returns the result.
3686 \begin_layout Subsubsection
3687 memory.readsdword(number address)
3690 \begin_layout Standard
3691 Reads the specified address as signed doubleword and returns the result.
3694 \begin_layout Subsubsection
3695 memory.writedword(number address, number value)
3698 \begin_layout Standard
3699 Writes the specified value (negative values undergo 2's complement) to specified
3700 address (as a doubleword).
3703 \begin_layout Subsubsection
3704 memory.readqword(number address)
3707 \begin_layout Standard
3708 Reads the specified address as unsigned quadword and returns the result.
3711 \begin_layout Subsubsection
3712 memory.readsqword(number address)
3715 \begin_layout Standard
3716 Reads the specified address as signed quadword and returns the result.
3719 \begin_layout Subsubsection
3720 memory.writeqword(number address, number value)
3723 \begin_layout Standard
3724 Writes the specified value (negative values undergo 2's complement) to specified
3725 address (as a quadword).
3728 \begin_layout Subsubsection
3729 memory.hash_region(number base, number size)
3732 \begin_layout Standard
3733 Hash specified number of bytes starting from specified address and return
3737 \begin_layout Subsubsection
3741 \begin_layout Standard
3742 Hash the current system state.
3743 Mainly useful for debugging savestates.
3746 \begin_layout Subsubsection
3747 memory.readregion(number base, number size)
3750 \begin_layout Standard
3751 Read a region of memory.
3754 \begin_layout Itemize
3755 Warning: If the region crosses VMA boundary, the results are undefined.
3758 \begin_layout Subsubsection
3759 memory.map<type>([number base, number size])
3762 \begin_layout Standard
3763 Returns a table mapping specified memory aperture for read/write.
3764 If parameters are omitted, entiere map space is the aperture.
3767 \begin_layout Itemize
3768 Type may be one of: byte, sbyte, word, sword, dword, sdword, qword or sqword.
3771 \begin_layout Subsubsection
3772 memory.writeregion(number base, number size, table data)
3775 \begin_layout Standard
3776 Write a region of memory.
3779 \begin_layout Itemize
3780 Warning: If the region crosses VMA boundary, the results are undefined.
3783 \begin_layout Subsubsection
3784 memory.map_structure()
3787 \begin_layout Standard
3788 Returns a new mapping structure (MMAP_STRUCT)
3791 \begin_layout Subsubsection
3792 MMAP_STRUCT(string key, number address, string type)
3795 \begin_layout Standard
3796 Bind key in mmap structure to specified address with specified type.
3799 \begin_layout Itemize
3800 Type may be one of: byte, sbyte, word, sword, dword, sdword, qword or sqword.
3803 \begin_layout Subsubsection
3804 memory.read_expr(string expr)
3807 \begin_layout Standard
3808 Evaluate specified watch expression and return result
3811 \begin_layout Subsection
3815 \begin_layout Standard
3816 Contains functions for manipulating subtitles.
3819 \begin_layout Subsubsection
3820 subtitle.byindex(number index)
3823 \begin_layout Standard
3824 Get (basetime, length) pair of specified subtitle index or nothing if index
3828 \begin_layout Subsubsection
3829 subtitle.get(number basetime, number length)
3832 \begin_layout Standard
3833 Read the specified subtitle.
3835 \begin_inset Quotes eld
3839 \begin_inset Quotes erd
3842 if the subtitle does not exist.
3845 \begin_layout Subsubsection
3846 subtitle.set(number basetime, number length, string content)
3849 \begin_layout Standard
3850 Set the specified subtitle.
3853 \begin_layout Subsubsection
3854 subtitle.deltete(number basetime, number length)
3857 \begin_layout Standard
3858 Delete the specified subtitle.
3861 \begin_layout Subsection
3865 \begin_layout Standard
3866 Contains copy of global variables from time of Lua initialization.
3870 \begin_layout Subsection
3874 \begin_layout Standard
3875 Various callbacks to Lua that can occur.
3878 \begin_layout Subsubsection
3879 Callback: on_paint(bool not_synth)
3882 \begin_layout Standard
3883 Called when screen is being painted.
3884 Any gui.* calls requiring graphic context draw on the screen.
3887 \begin_layout Standard
3888 not_synth is true if this hook is being called in response to received frame,
3892 \begin_layout Subsubsection
3893 Callback: on_video()
3896 \begin_layout Standard
3897 Called when video dump frame is being painted.
3898 Any gui.* calls requiring graphic context draw on the video.
3901 \begin_layout Subsubsection
3902 Callback: on_frame_emulated()
3905 \begin_layout Standard
3906 Called when emulating frame has completed and on_paint()/on_video() calls
3907 are about to be issued.
3910 \begin_layout Subsubsection
3911 Callback: on_frame()
3914 \begin_layout Standard
3915 Called on each starting whole frame.
3918 \begin_layout Subsubsection
3919 Callback: on_startup()
3922 \begin_layout Standard
3923 Called when the emulator is starting (lsnes.rc and --run files has been run).
3926 \begin_layout Subsubsection
3927 Callback: on_rewind()
3930 \begin_layout Standard
3931 Called when rewind movie to beginning has completed.
3934 \begin_layout Subsubsection
3935 Callback: on_pre_load(string name)
3938 \begin_layout Standard
3939 Called just before savestate/movie load occurs (note: loads are always delayed,
3940 so this occurs even when load was initiated by lua).
3943 \begin_layout Subsubsection
3944 Callback: on_err_load(string name)
3947 \begin_layout Standard
3948 Called if loadstate goes wrong.
3951 \begin_layout Subsubsection
3952 Callback: on_post_load(string name, boolean was_savestate)
3955 \begin_layout Standard
3956 Called on successful loadstate.
3957 was_savestate gives if this was a savestate or a movie.
3960 \begin_layout Subsubsection
3961 Callback: on_pre_save(string name, boolean is_savestate)
3964 \begin_layout Standard
3965 Called just before savestate save occurs (note: movie saves are synchronous
3966 and won't trigger these callbacks if called from Lua).
3969 \begin_layout Subsubsection
3970 Callback: on_err_save(string name)
3973 \begin_layout Standard
3974 Called if savestate goes wrong.
3977 \begin_layout Subsubsection
3978 Callback: on_post_save(string name, boolean is_savestate)
3981 \begin_layout Standard
3982 Called on successful savaestate.
3983 is_savestate gives if this was a savestate or a movie.
3986 \begin_layout Subsubsection
3990 \begin_layout Standard
3991 Called when emulator is shutting down.
3994 \begin_layout Subsubsection
3995 Callback: on_input(boolean subframe)
3998 \begin_layout Standard
3999 Called when emulator is just sending input to bsnes core.
4000 Warning: This is called even in readonly mode, but the results are ignored.
4003 \begin_layout Subsubsection
4004 Callback: on_reset()
4007 \begin_layout Standard
4008 Called when SNES is reset.
4011 \begin_layout Subsubsection
4012 Callback: on_readwrite()
4015 \begin_layout Standard
4016 Called when moving into readwrite mode as result of
4017 \begin_inset Quotes eld
4021 \begin_inset Quotes erd
4024 command (note: moving to rwmode by Lua won't trigger this, as per recursive
4028 \begin_layout Subsubsection
4029 Callback: on_snoop(number port, number controller, number index, number
4033 \begin_layout Standard
4034 Called each time bsnes asks for input.
4035 The value is the final value to be sent to bsnes core (readonly mode, autohold
4036 and autofire have been taken into account).
4037 Might be useful when translating movies to format suitable for console
4039 Note: There is no way to modify the value to be sent.
4042 \begin_layout Subsubsection
4043 Callback: on_keyhook(string keyname, table state)
4046 \begin_layout Standard
4047 Sent when key that has keyhook events requested changes state.
4048 Keyname is name of the key (group) and state is the state (same kind as
4049 table values in input.raw).
4052 \begin_layout Subsubsection
4056 \begin_layout Standard
4057 Called when requested by set_idle_timeout(), the timeout has expired and
4058 emulator is waiting.
4061 \begin_layout Subsubsection
4062 Callback: on_timer()
4065 \begin_layout Standard
4066 Called when requested by set_idle_timeout() and the timeout has expired
4067 (regardless if emulator is waiting).
4070 \begin_layout Subsubsection
4071 Callback: on_set_rewind(UNSAFEREWIND r)
4074 \begin_layout Standard
4075 Called when unsafe rewind object has been constructed.
4078 \begin_layout Subsubsection
4079 Callback: on_pre_rewind()
4082 \begin_layout Standard
4083 Called just before unsafe rewind is about to occur.
4086 \begin_layout Subsubsection
4087 Callback: on_post_rewind()
4090 \begin_layout Standard
4091 Called just after unsafe rewind has occured.
4094 \begin_layout Section
4098 \begin_layout Itemize
4099 The editor edits in-memory movie.
4102 \begin_layout Itemize
4103 Because past can't be edited and readwrite mode doesn't allow future, editing
4111 \begin_layout Itemize
4112 Keyboard triggers the normal hotkeys and bindings.
4115 \begin_layout Subsection
4119 \begin_layout Itemize
4120 Clicking on cell in future (indicated by lack of redish background) toggles
4121 it (if it is a button) or prompts for a value (if it is an axis)
4124 \begin_layout Itemize
4125 Dragging vertically toggles sequence of buttons or changes a sequence of
4129 \begin_layout Subsection
4130 Right button actions
4133 \begin_layout Standard
4134 The right mouse button pops up a context-sensitive menu:
4137 \begin_layout Itemize
4138 Toggle <something>: Toggle this button
4141 \begin_layout Itemize
4142 Change <something>: Change this axis value
4145 \begin_layout Itemize
4146 Insert frame after: Insert a frame after this frame
4149 \begin_layout Itemize
4150 Append frame: Append a frame to movie
4153 \begin_layout Itemize
4154 Append frames: Append specified number of frames to movie
4157 \begin_layout Itemize
4158 Delete frame: Delete this frame
4161 \begin_layout Itemize
4162 Delete subframe: Delete this subframe
4165 \begin_layout Itemize
4166 Truncate movie: Delete this subframe and everything after it.
4169 \begin_layout Itemize
4170 Scroll to frame: Prompt for a frame and scroll the display to that frame.
4173 \begin_layout Itemize
4174 Scroll to current frame: Scroll the display to current position
4177 \begin_layout Itemize
4178 Run to frame: Prompts for frame and runs the emulation to that frame.
4181 \begin_layout Itemize
4182 Change number of lines visible: Change the height of the movie display (1
4186 \begin_layout Itemize
4187 Lock scroll to playback: While playing back or rewinding movies, the display
4188 will follow if enabled.
4191 \begin_layout Section
4192 Memory watch expression syntax
4195 \begin_layout Standard
4196 Memory watch expressions are in RPN (Reverse Polish Notation).
4197 At the end of expression, the top entry on stack is taken as the final
4201 \begin_layout Standard
4205 \begin_layout Itemize
4206 Evaluation order is strictly left to right.
4209 \begin_layout Itemize
4210 a is the entry on top of stack
4213 \begin_layout Itemize
4214 b is the entry immediately below top of stack
4217 \begin_layout Itemize
4218 ; separates values to be pushed (no intermediate pop).
4221 \begin_layout Itemize
4222 After end of element, all used stack slots are popped and all results are
4226 \begin_layout Itemize
4227 When pushing multiple values, the pushes occur in order shown.
4230 \begin_layout Standard
4231 The following operators are available:
4234 \begin_layout Itemize
4238 \begin_layout Itemize
4242 \begin_layout Itemize
4246 \begin_layout Itemize
4250 \begin_layout Itemize
4254 \begin_layout Itemize
4258 \begin_layout Itemize
4259 b : read_signed_byte(a)
4262 \begin_layout Itemize
4266 \begin_layout Itemize
4267 d : read_signed_dword(a)
4270 \begin_layout Itemize
4274 \begin_layout Itemize
4276 \begin_inset Formula $\pi$
4282 \begin_layout Itemize
4283 q : read_signed_qword(a)
4286 \begin_layout Itemize
4290 \begin_layout Itemize
4294 \begin_layout Itemize
4298 \begin_layout Itemize
4302 \begin_layout Itemize
4303 w : read_signed_word(a)
4306 \begin_layout Itemize
4310 \begin_layout Itemize
4311 B : read_unsigned_byte(a)
4314 \begin_layout Itemize
4315 C<number>z : Push number <number> to stack.
4318 \begin_layout Itemize
4319 D : read_unsigned_dword(a)
4322 \begin_layout Itemize
4323 C0x<number>z : Push number <number> (hexadecimal) to stack.
4326 \begin_layout Itemize
4327 H<digit> : Set hexadecimal mode with specified number of digits (use A-G
4331 \begin_layout Itemize
4332 Q : read_unsigned_qword(a)
4335 \begin_layout Itemize
4336 R<digit> : round a to <digit> digits.
4339 \begin_layout Itemize
4340 W : read_unsigned_word(a)
4343 \begin_layout Subsection
4347 \begin_layout Standard
4348 C0x007e0878zWC0x007e002czW-
4351 \begin_layout Enumerate
4352 Push value 0x7e0878 on top of stack (C0x007e0878z).
4355 \begin_layout Enumerate
4356 Pop the value on top of stack (0x7e0878), read word value at that address
4357 and push the result,call it x1 (W).
4360 \begin_layout Enumerate
4361 Push value 0x7e002c on top of stack (C0x007e002cz).
4364 \begin_layout Enumerate
4365 Pop the value on top of stack (0x7e002c), read word value at that address
4366 and push the result,call it x2 (W).
4369 \begin_layout Enumerate
4370 Pop the two top numbers on stack, x1 and x2, substract x1 from x2 and push
4374 \begin_layout Enumerate
4375 Since the expression ends, the final memory watch result is the top one
4376 on stack, which is x2 - x1.
4379 \begin_layout Section
4380 Modifier and key names:
4383 \begin_layout Subsection
4387 \begin_layout Subsubsection
4391 \begin_layout Standard
4392 Following modifier names are known:
4395 \begin_layout Itemize
4396 ctrl, lctrl, rctrl: Control keys
4399 \begin_layout Itemize
4400 alt, lalt, ralt: ALT keys.
4403 \begin_layout Itemize
4404 shift, lshift, rshift: Shift keys.
4407 \begin_layout Itemize
4408 meta, lmeta, rmeta: Meta keys.
4411 \begin_layout Itemize
4412 num, caps: Numlock/Capslock (these are sticky!)
4415 \begin_layout Itemize
4419 \begin_layout Subsubsection
4423 \begin_layout Standard
4424 Following key names are known:
4427 \begin_layout Itemize
4428 backspace, tab, clear, return, pause, escape, space, exclaim, quotedbl,
4429 hash, dollar, ampersand, quote, leftparen, rightparen, asterisk, plus,
4430 comma, minus, period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon,
4431 less, equals, greater, question, at, leftbracket, backslash, rightbracket,
4432 caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n,
4433 o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0, world_1, world_2,
4434 world_3, world_4, world_5, world_6, world_7, world_8, world_9, world_10,
4435 world_11, world_12, world_13, world_14, world_15, world_16, world_17, world_18,
4436 world_19, world_20, world_21, world_22, world_23, world_24, world_25, world_26,
4437 world_27, world_28, world_29, world_30, world_31, world_32, world_33, world_34,
4438 world_35, world_36, world_37, world_38, world_39, world_40, world_41, world_42,
4439 world_43, world_44, world_45, world_46, world_47, world_48, world_49, world_50,
4440 world_51, world_52, world_53, world_54, world_55, world_56, world_57, world_58,
4441 world_59, world_60, world_61, world_62, world_63, world_64, world_65, world_66,
4442 world_67, world_68, world_69, world_70, world_71, world_72, world_73, world_74,
4443 world_75, world_76, world_77, world_78, world_79, world_80, world_81, world_82,
4444 world_83, world_84, world_85, world_86, world_87, world_88, world_89, world_90,
4445 world_91, world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3, kp4,
4446 kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide, kp_multiply, kp_minus, kp_plus,
4447 kp_enter, kp_equals, up, down, right, left, insert, home, end, pageup,
4448 pagedown, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14,
4449 f15, numlock, capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt,
4450 lalt, rmeta, lmeta, lsuper, rsuper, mode, compose, help, print, sysreq,
4451 break, menu, power, euro, undo
4454 \begin_layout Itemize
4455 Names of form 'key<n>' where <n> is 0-255 are interpretted as key having
4456 hardware-dependent scan code of <n> (useful to bind those keys that don't
4457 have symbolic names).
4460 \begin_layout Subsubsection
4461 Joystick pseudo-keys:
4464 \begin_layout Itemize
4465 joystick<num>button<button>: Joystick <num> (0-based) button <button> (0-based).
4468 \begin_layout Itemize
4469 joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat> (0-based) up.
4472 \begin_layout Itemize
4473 joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat> (0-based) left.
4476 \begin_layout Itemize
4477 joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat> (0-based) down.
4480 \begin_layout Itemize
4481 joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat> (0-based) right.
4484 \begin_layout Itemize
4485 joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis> negative
4486 position (axis modes axis and axis_inverse).
4489 \begin_layout Itemize
4490 joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis> positive
4491 position (axis modes axis and axis_inverse).
4494 \begin_layout Itemize
4495 joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis> pressure (axis
4499 \begin_layout Subsubsection
4503 \begin_layout Itemize
4504 Escape: Enter/Exit Command mode, cancel modal dialogs.
4507 \begin_layout Itemize
4508 Return (also KPEnter): Execute command, ok modal dialog.
4511 \begin_layout Itemize
4512 Pgup/Up (also KP8/9 if no num lock, CTRL+P; command mode): Previous command
4516 \begin_layout Itemize
4517 Pgdn/Down(also KP2/3 if no num lock, CTRL+N; command mode): Next command
4521 \begin_layout Itemize
4522 Home (also KP7 if no num lock, CTRL+A; command mode): Beginning of command.
4525 \begin_layout Itemize
4526 End (also KP1 if no num lock, CTRL+E; command mode): End of command.
4529 \begin_layout Itemize
4530 Left (also KP4 if no num lock, CTRL+B; command mode): Move cursor left.
4533 \begin_layout Itemize
4534 Right (also KP6 if no num lock, CTRL+F; command mode): Move cursor right.
4537 \begin_layout Itemize
4539 if no num lock; command mode): Delete character to right of cursor.
4542 \begin_layout Itemize
4543 Insert (also KP0 if no num lock; command mode): Toggle between insert /
4547 \begin_layout Itemize
4548 Backspace (command mode): Delete character to left of cursor.
4551 \begin_layout Itemize
4552 CTRL+LEFT (also ALT+B; command mode): Previous word.
4555 \begin_layout Itemize
4556 CTRL+RIGHT (also ALT+F; command mode): Next word.
4559 \begin_layout Itemize
4560 ALT+D (also CTRL+W; command mode): Delete word.
4563 \begin_layout Itemize
4564 LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump corrupted!).
4567 \begin_layout Subsection
4571 \begin_layout Subsubsection
4575 \begin_layout Standard
4576 Following modifier names are known:
4579 \begin_layout Itemize
4583 \begin_layout Itemize
4587 \begin_layout Itemize
4591 \begin_layout Itemize
4595 \begin_layout Itemize
4599 \begin_layout Subsubsection
4603 \begin_layout Standard
4604 Following key names are known:
4607 \begin_layout Itemize
4608 back, tab, return, escape, space, exclaim, quotedbl, hash, dollar, percent,
4609 ampersand, quote, leftparen, rightparen, asterisk, plus, comma, minus,
4610 period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
4611 greater, question, at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
4612 q, r, s, t, u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
4613 underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
4614 q, r, s, t, u, v, w, x, y, z, leftcurly, pipe, rightcurly, tilde, delete,
4615 start, lbutton, rbutton, cancel, mbutton, clear, shift, alt, control, menu,
4616 pause, capital, end, home, lefT, up, right, down, select, print, execute,
4617 snapshot, insert, help, numpad0, numpad1, numpad2, numpad3, numpad4, numpad5,
4618 numpad6, numpad7, numpad8, numpad9, multiply, add, separator, subtract,
4619 decimal, divide, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13,
4620 f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, numlock, scroll,
4621 pageup, pagedown, numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
4622 numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up, numpad_right,
4623 numpad_down, numpad_pageup, numpad_pagedown, numpad_end, numpad_begin,
4624 numpad_insert, numpad_delete, numpad_equal, numpad_multiply, numpad_add,
4625 numpad_separator, numpad_subtract, numpad_decimal, numpad_divide, windows_left,
4626 windows_right, windows_menu, command, special1, special2, special3, special4,
4627 special5, special6, special7, special8, special9, special10, special11,
4628 special12, special13, special14, special15, special16, special17, special18,
4629 special19, special20
4632 \begin_layout Section
4636 \begin_layout Standard
4637 Movie file is .zip archive in itself, normal ZIP archive tools work on it
4638 (note: If you recompress it, do not use compression methods other than
4639 store and deflate and especially do not use encryption of any kind).
4642 \begin_layout Subsection
4643 Detecting clean start/SRAM/Savestate
4646 \begin_layout Itemize
4648 \begin_inset Quotes eld
4652 \begin_inset Quotes erd
4655 it is savestate, otherwise:
4658 \begin_layout Itemize
4659 If file has members with names starting
4660 \begin_inset Quotes eld
4664 \begin_inset Quotes erd
4667 it is movie starting from SRAM, otherwise:
4670 \begin_layout Itemize
4671 It is movie starting from clear state.
4674 \begin_layout Subsection
4678 \begin_layout Standard
4679 Type of game ROM and region (as one line).
4683 \begin_layout Standard
4684 \begin_inset Tabular
4685 <lyxtabular version="3" rows="8" columns="3">
4686 <features tabularvalignment="middle">
4687 <column alignment="center" valignment="top" width="0">
4688 <column alignment="center" valignment="top" width="0">
4689 <column alignment="center" valignment="top" width="0">
4691 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4694 \begin_layout Plain Layout
4700 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4703 \begin_layout Plain Layout
4709 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4712 \begin_layout Plain Layout
4720 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4723 \begin_layout Plain Layout
4729 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4732 \begin_layout Plain Layout
4738 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4741 \begin_layout Plain Layout
4749 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4752 \begin_layout Plain Layout
4758 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4761 \begin_layout Plain Layout
4767 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4770 \begin_layout Plain Layout
4778 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4781 \begin_layout Plain Layout
4787 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4790 \begin_layout Plain Layout
4796 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4799 \begin_layout Plain Layout
4807 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4810 \begin_layout Plain Layout
4816 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4819 \begin_layout Plain Layout
4825 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4828 \begin_layout Plain Layout
4836 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4839 \begin_layout Plain Layout
4845 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4848 \begin_layout Plain Layout
4854 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4857 \begin_layout Plain Layout
4865 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4868 \begin_layout Plain Layout
4874 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4877 \begin_layout Plain Layout
4883 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4886 \begin_layout Plain Layout
4894 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4897 \begin_layout Plain Layout
4903 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4906 \begin_layout Plain Layout
4912 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4915 \begin_layout Plain Layout
4929 \begin_layout Standard
4933 \begin_layout Standard
4934 \begin_inset Tabular
4935 <lyxtabular version="3" rows="3" columns="2">
4936 <features tabularvalignment="middle">
4937 <column alignment="center" valignment="top" width="0">
4938 <column alignment="center" valignment="top" width="0">
4940 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4943 \begin_layout Plain Layout
4949 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4952 \begin_layout Plain Layout
4960 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4963 \begin_layout Plain Layout
4969 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4972 \begin_layout Plain Layout
4980 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4983 \begin_layout Plain Layout
4989 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4992 \begin_layout Plain Layout
5006 \begin_layout Subsection
5010 \begin_layout Standard
5011 Contains type of port #1 (as one line).
5012 Valid values are 'none', 'gamepad', 'multitap' and 'mouse'.
5013 If not present, defaults to 'gamepad'.
5016 \begin_layout Subsection
5020 \begin_layout Standard
5021 Contains type of port #2 (as one line).
5022 Valid values are 'none', 'gamepad', 'multitap', 'mouse', 'superscope',
5023 'justifier' and 'justifiers'.
5024 If not present, defaults to 'none'.
5027 \begin_layout Subsection
5031 \begin_layout Standard
5032 Contains name of the game (as one line).
5035 \begin_layout Subsection
5039 \begin_layout Standard
5040 Contains authors, one per line.
5041 Part before '|' is the full name, part after is the nickname.
5044 \begin_layout Subsection
5048 \begin_layout Standard
5050 \begin_inset Quotes eld
5054 \begin_inset Quotes erd
5058 Used to reject other saves.
5061 \begin_layout Subsection
5062 Member: controlsversion
5065 \begin_layout Standard
5067 \begin_inset Quotes eld
5071 \begin_inset Quotes erd
5075 Used to identify what controls are there.
5078 \begin_layout Subsection
5080 \begin_inset Quotes eld
5084 \begin_inset Quotes erd
5090 \begin_layout Standard
5091 Contains bsnes core version number (as one line).
5094 \begin_layout Subsection
5098 \begin_layout Standard
5099 Contains project ID (as one line).
5100 Used to identify if two movies are part of the same project.
5103 \begin_layout Subsection
5104 Member: {rom,slota,slotb}{,xml}.sha256
5107 \begin_layout Standard
5108 Contains SHA-256 of said ROM or ROM mapping file (as one line).
5109 Absent if corresponding file is absent.
5112 \begin_layout Subsection
5113 Member: moviesram.<name>
5116 \begin_layout Standard
5117 Raw binary startup SRAM of kind <name>.
5118 Only present in savestates and movies starting from SRAM.
5121 \begin_layout Subsection
5125 \begin_layout Standard
5126 Contains frame number (as one line) of frame movie was saved on.
5127 Only present in savestates.
5130 \begin_layout Subsection
5134 \begin_layout Standard
5135 Current value of lag counter (as one line).
5136 Only present in savestates.
5139 \begin_layout Subsection
5140 Member: pollcounters
5143 \begin_layout Standard
5144 Contains poll counters (currently 100 of them), one per line.
5145 Each line is raw poll count if DRDY is set for it.
5146 Otherwise it is negative poll count minus one.
5147 Only present in savestates.
5150 \begin_layout Subsection
5154 \begin_layout Standard
5155 Raw binary dump of host memory.
5156 Only present in savestates.
5159 \begin_layout Subsection
5163 \begin_layout Standard
5164 The raw binary savestate itself.
5165 Savestate detection uses this file, only present in savestates.
5168 \begin_layout Subsection
5172 \begin_layout Standard
5173 Screenshot of current frame.
5174 Only present in savestates.
5175 First 2 bytes are big-endian width of image, rest are 24-bit RGB image
5177 Height of image is inferred from the width and size of data.
5180 \begin_layout Subsection
5184 \begin_layout Standard
5185 Raw binary SRAM of kind <name> at time of savestate.
5186 Only present in savestates.
5189 \begin_layout Subsection
5193 \begin_layout Standard
5194 The actual input track, one line per subframe (blank lines are skipped).
5197 \begin_layout Itemize
5198 If the first byte of each line is '.', ' ', <tab> or '|', then the line is
5199 part of same frame as previous, otherwise it starts a new frame.
5202 \begin_layout Itemize
5203 First subframe must start a new frame.
5206 \begin_layout Standard
5207 Length of movie in frames is number of lines in input file that start a
5211 \begin_layout Subsection
5215 \begin_layout Standard
5220 \begin_layout Itemize
5221 Each line is in form <firstframe> <numframes> <text>.
5224 \begin_layout Itemize
5225 Linefeed is encoded as
5227 n, backslash is encoded as
5234 \begin_layout Subsection
5238 \begin_layout Standard
5239 Contains textual base-10 rerecord count (as one line; emulator just writes
5240 this, it doesn't read it) + 1.
5243 \begin_layout Subsection
5247 \begin_layout Standard
5248 This member stores set of load IDs.
5249 There is one load ID per rerecord (plus one corresponding to start of project).
5252 \begin_layout Itemize
5253 This member constists of concatenation of records
5256 \begin_layout Itemize
5257 Each record is 2-36 bytes long and can represent 1-16,843,009 consequtive
5261 \begin_layout Itemize
5262 IDs are interpretted as 256-bit big-endian integers with warparound.
5265 \begin_layout Itemize
5266 Initial predicted ID is all zeroes.
5269 \begin_layout Standard
5270 Format of each record is:
5273 \begin_layout Itemize
5274 1 byte: Opcode byte.
5275 Bits 0-4 are prefix length (prefixlen), bits 5-6 are count length (countlen).
5279 \begin_layout Itemize
5280 32-prefixlen bytes of ID.
5283 \begin_layout Itemize
5284 countlen bytes of big-endian count (count).
5287 \begin_layout Standard
5288 Records are processed as follows:
5291 \begin_layout Itemize
5292 To form the first ID encoded by record, take the first prefixlen bytes predicted
5293 ID and append the read ID value to it.
5294 The result is the first ID encoded.
5297 \begin_layout Itemize
5298 If countlen is 0, record encodes 1 ID.
5301 \begin_layout Itemize
5302 If countlen is 1, record encodes 2+count IDs.
5305 \begin_layout Itemize
5306 If countlen is 2, record encodes 258+count IDs.
5309 \begin_layout Itemize
5310 If countlen is 3, record encodes 65794+count IDs.
5313 \begin_layout Itemize
5314 The new predicted ID is the next ID after last one encoded by the record.
5317 \begin_layout Standard
5318 The number of rerecords + 1 is equal to the sum of number of IDs encoded
5322 \begin_layout Subsection
5323 Member: starttime.second
5326 \begin_layout Standard
5327 Movie starting time, second part.
5328 Epoch is Unix epoch.
5329 Default is 1,000,000,000.
5332 \begin_layout Subsection
5333 Member: starttime.subsecond
5336 \begin_layout Standard
5337 Movie starting time, subsecond part.
5342 \begin_layout Subsection
5343 Member: savetime.second
5346 \begin_layout Standard
5347 Movie saving time, second part.
5348 Default is starttime.second.
5349 Only present in savestates.
5352 \begin_layout Subsection
5353 Member: savetime.subsecond
5356 \begin_layout Standard
5357 Movie saving time, subsecond part.
5358 Default is starttime.subsecond.
5359 Only present in savestates.
5362 \begin_layout Section
5363 lsvs file format (commentary tracks)
5366 \begin_layout Subsection
5370 \begin_layout Itemize
5371 Each cluster is 8kB (8192 bytes) in size.
5374 \begin_layout Itemize
5375 Cluster n starts at offset 8192*n in file.
5378 \begin_layout Itemize
5379 The following clusters are system special:
5383 \begin_layout Itemize
5384 Cluster 0 and all clusters with number multiple of 2048 (cluster tables)
5387 \begin_layout Itemize
5388 Cluster 1 (superblock)
5392 \begin_layout Subsection
5396 \begin_layout Itemize
5397 The cluster table describing cluster n is stored in cluster n & ~0x7FF (zero
5401 \begin_layout Itemize
5402 This cluster table consists of 2048 4-byte big-endian integers.
5405 \begin_layout Itemize
5406 Each entry describes a cluster in 16MB supercluster, in order.
5409 \begin_layout Itemize
5410 The valid values for entries are:
5414 \begin_layout Itemize
5415 0x00000000: Free cluster
5418 \begin_layout Itemize
5419 0x00000001: Last cluster in chain.
5422 \begin_layout Itemize
5423 0xFFFFFFFF: System cluster (cluster tables and superblock)
5426 \begin_layout Itemize
5427 (anything else): Number of next cluster in chain.
5428 Must not be multiple of 2048.
5432 \begin_layout Itemize
5433 Due to limitations of the format, there can be at most 2097052 superclusters,
5434 giving maximum file size of 16TB.
5437 \begin_layout Subsection
5441 \begin_layout Itemize
5442 The stream table chain always starts in cluster 2.
5445 \begin_layout Itemize
5446 Otherwise, it follows normal chaining.
5449 \begin_layout Itemize
5450 The stream table consists of 16-byte entries:
5454 \begin_layout Itemize
5455 The first 8 bytes of entry give big-endian beginning position of stream
5456 in units of 1/48000 s.
5459 \begin_layout Itemize
5460 The next 4 bytes of entry give big-endian beginning cluster for control
5462 0 here marks the entry as not present.
5465 \begin_layout Itemize
5466 The last 4 bytes of entry give big-endian beginning cluster for codec data.
5470 \begin_layout Itemize
5471 Stream table clusters are normal clusters, following normal chaining.
5474 \begin_layout Itemize
5475 The stream begnning position is not guarenteed unique.
5476 There can be multiple streams with the same starting position in the file.
5479 \begin_layout Subsection
5483 \begin_layout Itemize
5484 The stream control data consists of entries 4 bytes each:
5488 \begin_layout Itemize
5489 The first 2 bytes of entry gives big-endian length of packet
5492 \begin_layout Itemize
5493 The next byte of entry gives audio length of packet in units of 1/400 s.
5496 \begin_layout Itemize
5497 The last byte is control byte.
5501 \begin_layout Itemize
5502 0 means this entry is not present and the control data ends.
5505 \begin_layout Itemize
5506 1 is valid control entry.
5511 \begin_layout Itemize
5512 The stream control data can also end by running into end of the readable
5517 \begin_layout Itemize
5518 This happens if there happens to be exact multiple of 2048 packets in stream
5519 and number of packets is nonzero.
5523 \begin_layout Itemize
5524 These clusters follow normal chaining.
5527 \begin_layout Subsection
5531 \begin_layout Itemize
5532 Stream codec data consists of raw Opus data packets packed back to back
5533 with nothing in between.
5536 \begin_layout Itemize
5537 Warning: Due to internal limitations, this data must reside in the first
5538 65536 superclusters (that is, the first 1TB of the file).
5541 \begin_layout Subsection
5545 \begin_layout Itemize
5546 The superblock is stored in cluster 1.
5550 \begin_layout Itemize
5551 The first 11 bytes are
5552 \begin_inset Quotes eld
5556 \begin_inset Quotes erd
5562 \begin_layout Itemize
5563 The rest are unused.
5566 \begin_layout Itemize
5567 This cluster 1 is marked as system special.
5570 \begin_layout Section
5571 Known ROM extensions
5574 \begin_layout Itemize
5575 SNES cartridge ROMs: sfc, smc, swc, fig, ufo, sf2, gd3, gd7, dx2, mgd, mgh.
5578 \begin_layout Itemize
5579 DMG cartridge ROMs: dmg, gb.
5582 \begin_layout Itemize
5583 GBC cartridge ROMs: cgb, gbc.
5586 \begin_layout Section
5590 \begin_layout Itemize
5591 The first line must be:
5592 \begin_inset Quotes eld
5596 \begin_inset Quotes erd
5602 \begin_layout Itemize
5603 There is one needed line:
5604 \begin_inset Quotes eld
5608 \begin_inset Quotes erd
5612 This sets system type to <systype>.
5613 The following system types are valid:
5617 \begin_layout Itemize
5621 \begin_layout Itemize
5622 bsx (BS-X non-slotted)
5625 \begin_layout Itemize
5626 bsxslotted (BS-X slotted)
5629 \begin_layout Itemize
5630 sufamiturbo (Sufami Turbo)
5633 \begin_layout Itemize
5634 sgb (Super Game Boy)
5637 \begin_layout Itemize
5641 \begin_layout Itemize
5642 gbc (Game Boy Color)
5645 \begin_layout Itemize
5646 gbc_gba (Game Boy Color with GBA initial register values)
5650 \begin_layout Itemize
5651 Optionally a region can be specified:
5652 \begin_inset Quotes eld
5656 \begin_inset Quotes erd
5660 The following values are valid:
5664 \begin_layout Itemize
5665 autodetect (Autodetect region: snes and sgb only)
5668 \begin_layout Itemize
5669 ntsc (NTSC: snes, bsx, bsxslotted, sufamiturbo, sgb)
5672 \begin_layout Itemize
5673 pal (PAL: snes, sgb)
5676 \begin_layout Itemize
5677 world (World: dmg, gbc, gbc_gba)
5681 \begin_layout Itemize
5682 ROM images are loaded as:
5683 \begin_inset Quotes eld
5687 \begin_inset Quotes erd
5691 The following types are valid:
5695 \begin_layout Itemize
5696 rom (Cartridge ROM in snes, dmg, gbc, gbc_gba.
5697 BIOS in bsx, bsxslotted, sufamiturbo)
5700 \begin_layout Itemize
5701 bsx (Cartridge ROM in bsx, bsxslotted)
5704 \begin_layout Itemize
5705 slot-a (Cartridge ROM in sufamiturbo)
5708 \begin_layout Itemize
5709 slot-b (Cartridge ROM in sufamiturbo)
5713 \begin_layout Itemize
5714 ROM markup can be loaded as:
5715 \begin_inset Quotes eld
5719 \begin_inset Quotes erd
5723 The types valid are the same as for ROMs.
5726 \begin_layout Itemize
5727 Patches can be loaded as
5728 \begin_inset Quotes eld
5731 patch[<offset>] <type> <file>
5732 \begin_inset Quotes erd
5736 The types are the same as for ROMs.
5740 \begin_layout Itemize
5741 Offset is given in form [+-]<number>.
5742 Usually offset is either +0 or -512.
5745 \begin_layout Itemize
5746 Default offset is +0.
5750 \begin_layout Subsection
5754 \begin_layout LyX-Code
5758 \begin_layout LyX-Code
5762 \begin_layout LyX-Code
5763 rom rom speedygonzales.sfc
5766 \begin_layout LyX-Code
5767 patch-512 rom sonicthehedgehog.ips
5770 \begin_layout Subsection
5774 \begin_layout LyX-Code
5778 \begin_layout LyX-Code
5782 \begin_layout LyX-Code
5783 rom rom supergameboy.sfc
5786 \begin_layout LyX-Code
5787 rom dmg megamanV.dmg
5790 \begin_layout Section
5791 Quick'n'dirty encode guide
5794 \begin_layout Enumerate
5795 Start the emulator and load the ROM and movie file.
5798 \begin_layout Enumerate
5799 Set large AVI option 'set-setting avi-large on'
5802 \begin_layout Enumerate
5803 Enable dumping 'dump-avi tmpdump'
5806 \begin_layout Enumerate
5807 Unpause and let it run until you want to end dumping.
5810 \begin_layout Enumerate
5811 Close the emulator (closing the window is the easiest way).
5815 \begin_layout Enumerate
5816 For each tmpdump*.avi file created, on command prompt, do 'x264 --crf 10
5817 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
5820 \begin_layout Enumerate
5821 Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
5824 \begin_layout Enumerate
5825 Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv + tmpdump_0000001.mkv
5826 + tmpdump_0000002.mkv' (list every tmpdump_<numbers>.mkv, with + in between).
5829 \begin_layout Enumerate
5830 Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'.
5831 Now final.mkv contains quick'n'dirty encode.
5834 \begin_layout Section
5835 Axis configurations for some gamepad types:
5838 \begin_layout Subsection
5842 \begin_layout Standard
5843 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be set to pressure-+.
5846 \begin_layout LyX-Code
5847 set-axis joystick0axis2 pressure-+
5850 \begin_layout LyX-Code
5851 set-axis joystick0axis5 pressure-+
5854 \begin_layout Itemize
5855 This is needed for SDL only.
5856 EVDEV sets those types correctly.
5859 \begin_layout Subsection
5861 \begin_inset Quotes eld
5865 \begin_inset Quotes erd
5871 \begin_layout Standard
5872 Axes 8-19 should be disabled.
5875 \begin_layout LyX-Code
5876 set-axis joystick0axis8 disabled
5879 \begin_layout LyX-Code
5880 set-axis joystick0axis9 disabled
5883 \begin_layout LyX-Code
5884 set-axis joystick0axis10 disabled
5887 \begin_layout LyX-Code
5888 set-axis joystick0axis11 disabled
5891 \begin_layout LyX-Code
5892 set-axis joystick0axis12 disabled
5895 \begin_layout LyX-Code
5896 set-axis joystick0axis13 disabled
5899 \begin_layout LyX-Code
5900 set-axis joystick0axis14 disabled
5903 \begin_layout LyX-Code
5904 set-axis joystick0axis15 disabled
5907 \begin_layout LyX-Code
5908 set-axis joystick0axis16 disabled
5911 \begin_layout LyX-Code
5912 set-axis joystick0axis17 disabled
5915 \begin_layout LyX-Code
5916 set-axis joystick0axis18 disabled
5919 \begin_layout LyX-Code
5920 set-axis joystick0axis19 disabled
5923 \begin_layout Section
5927 \begin_layout Subsection
5928 Problems from BSNES core:
5931 \begin_layout Itemize
5932 The whole pending save stuff.
5935 \begin_layout Itemize
5936 Lack of layer hiding.
5939 \begin_layout Itemize
5940 It is slow (especially accuracy).
5943 \begin_layout Itemize
5944 Firmwares can't be loaded from ZIP archives.
5947 \begin_layout Subsection
5951 \begin_layout Itemize
5952 Modifiers don't work with pseudo-keys (SDL, EVDEV).
5955 \begin_layout Itemize
5956 Audio for last dumped frame is not itself dumped.
5959 \begin_layout Itemize
5960 Audio in UI is pretty bad in quality if game doesn't run at full speed.
5963 \begin_layout Itemize
5964 No menus, command based interface (SDL).
5967 \begin_layout Itemize
5968 Long commands don't scroll.
5971 \begin_layout Section
5975 \begin_layout Subsection
5979 \begin_layout Itemize
5983 \begin_layout Itemize
5984 Fix dumper video corruption with levels 10-18.
5987 \begin_layout Subsection
5991 \begin_layout Itemize
5995 \begin_layout Itemize
5996 Lots of code cleanups
5999 \begin_layout Itemize
6000 Lua interface to settings
6003 \begin_layout Itemize
6004 Allow specifying AVI borders without Lua
6007 \begin_layout Itemize
6008 Fix scaling if vscale > 1 and originx > 0 (left border exists)
6011 \begin_layout Itemize
6012 on_snoop lua callback
6015 \begin_layout Itemize
6016 Faster movie loading and saving.
6019 \begin_layout Subsection
6023 \begin_layout Itemize
6027 \begin_layout Subsection
6031 \begin_layout Itemize
6035 \begin_layout Itemize
6036 Save jukebox functionality.
6039 \begin_layout Subsection
6043 \begin_layout Itemize
6044 Try to fix some nasty failing movie load edge cases
6047 \begin_layout Itemize
6048 Allow specifying scripts to run on command line.
6051 \begin_layout Subsection
6055 \begin_layout Itemize
6056 Major source code reorganization.
6059 \begin_layout Itemize
6060 Backup savestates before overwriting.
6063 \begin_layout Itemize
6064 Don't crash if loading initial state fails.
6067 \begin_layout Subsection
6071 \begin_layout Itemize
6075 \begin_layout Itemize
6076 Fix author name parsing
6079 \begin_layout Itemize
6080 Fix rerecord counting
6083 \begin_layout Itemize
6084 (SDL) Print messages to console if SDL is uninitialized
6087 \begin_layout Itemize
6088 Add movieinfo program
6091 \begin_layout Itemize
6092 Fix loading movies starting from SRAM.
6095 \begin_layout Subsection
6099 \begin_layout Itemize
6100 Add support for unattended dumping
6103 \begin_layout Itemize
6104 Fix compiling for Win32
6107 \begin_layout Itemize
6108 Don't lock up if sound can't be initialized
6111 \begin_layout Itemize
6112 Strip trailing CR from commands
6115 \begin_layout Itemize
6116 Don't try to do dubious things in global ctors (fix crash on startup)
6119 \begin_layout Subsection
6123 \begin_layout Itemize
6124 Small documentation tweaking
6127 \begin_layout Itemize
6131 \begin_layout Itemize
6132 Fix major bug in modifier matching
6135 \begin_layout Subsection
6139 \begin_layout Itemize
6140 Lots of documentation fixes
6143 \begin_layout Itemize
6144 Use dedicated callbacks for event backcomm., not commands.
6147 \begin_layout Itemize
6148 Ensure that the watchdog is not hit when executing delayed reset.
6151 \begin_layout Itemize
6152 Remove errant tab from joystick message.
6155 \begin_layout Subsection
6159 \begin_layout Itemize
6160 Make autofire operate in absolute time, not linear time
6163 \begin_layout Itemize
6164 Reinitialize controls when resuming from loadstate
6167 \begin_layout Itemize
6168 Some more code cleanups
6171 \begin_layout Itemize
6172 If Lua allocator fails, call OOM_panic()
6175 \begin_layout Itemize
6176 Byte/word/dword/qword sized host memory write/read functions.
6179 \begin_layout Itemize
6180 Dump at correct framerate if dumping interlaced NTSC (height=448).
6183 \begin_layout Subsection
6187 \begin_layout Itemize
6188 Actually include the complete source code
6191 \begin_layout Itemize
6195 \begin_layout Subsection
6199 \begin_layout Itemize
6200 Document {save,start}time.{,sub}second.
6203 \begin_layout Itemize
6204 Intercept time() from bsnes core.
6207 \begin_layout Subsection
6211 \begin_layout Itemize
6212 Allow disabling time() interception (allow build on Mac OS X)
6215 \begin_layout Itemize
6216 Use SDLMain on Mac OS X (make SDL not crash)
6219 \begin_layout Itemize
6220 Disable delayed resets (just plain too buggy for now).
6223 \begin_layout Itemize
6227 \begin_layout Itemize
6228 Use 16-bit for graphics/video instead of 32-bit.
6231 \begin_layout Itemize
6232 gui.rectangle/gui.pixel
6235 \begin_layout Itemize
6239 \begin_layout Itemize
6240 New CSCD writer implementation.
6243 \begin_layout Subsection
6247 \begin_layout Itemize
6248 Fix interaction of * and +.
6251 \begin_layout Itemize
6255 \begin_layout Itemize
6256 Use gettimeofday()/usleep(), these seem portable enough.
6259 \begin_layout Itemize
6260 Move joystick axis manipulation to keymapper code.
6263 \begin_layout Itemize
6264 Changes to how read-only works.
6267 \begin_layout Itemize
6268 Refactor controller input code.
6271 \begin_layout Subsection
6275 \begin_layout Itemize
6276 Fix mouseclick scale compensation.
6279 \begin_layout Itemize
6280 Draw area boundaries correctly in SDL code.
6283 \begin_layout Itemize
6287 \begin_layout Itemize
6288 Fix CSCD output (buffer overrun and race condition).
6291 \begin_layout Subsection
6295 \begin_layout Itemize
6296 JMD dumping support.
6299 \begin_layout Itemize
6300 Allow unattended dumping to JMD.
6303 \begin_layout Itemize
6307 \begin_layout Itemize
6308 Switch back to 32-bit colors.
6311 \begin_layout Itemize
6312 Add Lua function gui.color.
6315 \begin_layout Itemize
6316 Use some new C++11 features in GCC 4.6.
6319 \begin_layout Itemize
6320 Be prepared for core frequency changes.
6323 \begin_layout Itemize
6324 Pass colors in one chunk from Lua.
6327 \begin_layout Subsection
6331 \begin_layout Itemize
6332 New lua functions gui.line(), gui.status() and gui.circle(), memory.vma_count(),
6333 memory.read_vma() and memory.find_vma().
6336 \begin_layout Itemize
6337 Numerious documentation fixups
6340 \begin_layout Itemize
6341 RTC time format changed
6344 \begin_layout Itemize
6345 Reformat flags display
6348 \begin_layout Itemize
6349 Allow lua package name to be overridden
6352 \begin_layout Itemize
6353 SDUMP (high-quality dumping).
6356 \begin_layout Itemize
6357 Split platform support to plugins.
6360 \begin_layout Itemize
6361 Make all sound plugins support basic sound commands
6364 \begin_layout Itemize
6365 Support portaudio for sound.
6368 \begin_layout Itemize
6369 Allow disable Lua/SDL searching.
6372 \begin_layout Itemize
6373 Upconvert colors when copying lcscreen to screen.
6376 \begin_layout Itemize
6377 Reorganize source tree.
6380 \begin_layout Itemize
6381 Evdev joystick support.
6384 \begin_layout Itemize
6385 Refactor more code into generic window code.
6388 \begin_layout Subsection
6392 \begin_layout Itemize
6393 Refactor message handling.
6396 \begin_layout Itemize
6400 \begin_layout Itemize
6404 \begin_layout Itemize
6405 Finish pending saves before load/quit.
6408 \begin_layout Itemize
6409 Wxwidgets graphics plugin.
6412 \begin_layout Subsection
6416 \begin_layout Itemize
6417 Get rid of win32-crap.[ch]pp.
6420 \begin_layout Itemize
6421 Move files around a lot.
6424 \begin_layout Itemize
6425 Get rid of need for host C++ compiler.
6428 \begin_layout Itemize
6432 \begin_layout Itemize
6433 Refactor inter-component communication.
6436 \begin_layout Itemize
6440 \begin_layout Itemize
6441 Fix crash on multiline aliases.
6444 \begin_layout Itemize
6445 Load/Save settings in wxwidgets gui.
6448 \begin_layout Subsection
6452 \begin_layout Itemize
6453 Patch problems in bsnes core
6456 \begin_layout Itemize
6457 SNES is little-endian, not big-endian!
6460 \begin_layout Itemize
6461 Fix memory corruption in lcscreen::load()
6464 \begin_layout Subsection
6468 \begin_layout Itemize
6469 Fix interpretting repeat counts in rrdata loading.
6472 \begin_layout Itemize
6473 New lua callback: on_frame()
6476 \begin_layout Itemize
6477 Remove calls to runtosave() that aren't supposed to be there
6480 \begin_layout Itemize
6481 Lua function: movie.read_rtc()
6484 \begin_layout Itemize
6485 Ignore src/fonts/font.cpp
6488 \begin_layout Itemize
6489 Fix more bsnes core problems
6492 \begin_layout Itemize
6493 Control bsnes random seeding
6496 \begin_layout Itemize
6500 \begin_layout Itemize
6501 Some bsnes core debugging features (state dump and state hash)
6504 \begin_layout Itemize
6505 Fix titlebar version number (no, the last version wasn't 'lsnes-0-beta21',
6506 it was 'lsnes rr0-beta21').
6509 \begin_layout Subsection
6513 \begin_layout Itemize
6514 Fix memory corruption due to macro/field mixup
6517 \begin_layout Itemize
6518 search-memory update
6521 \begin_layout Itemize
6522 Allow direct-mapped framebuffer
6525 \begin_layout Itemize
6526 SDL: Use SDL_ANYFORMAT if possible
6529 \begin_layout Itemize
6530 SDMP2SOX: 2s delay modes.
6533 \begin_layout Itemize
6537 \begin_layout Itemize
6538 Use sed -E, not sed -r.
6539 Fixes building on Mac OS X.
6542 \begin_layout Itemize
6543 Wxwidgets: Save jukebox on exit
6546 \begin_layout Itemize
6547 Fix RTC if using load-movie on savestate.
6550 \begin_layout Itemize
6551 Fix crash related to full console mode.
6554 \begin_layout Subsection
6558 \begin_layout Itemize
6559 Wxwidgets: Allow bringing application to foreground on Mac OS X.
6562 \begin_layout Itemize
6563 Wxwidgets: Allow compiling on Mac OS X.
6566 \begin_layout Itemize
6567 Use movie compare instead of movie hashing (faster save/load).
6570 \begin_layout Itemize
6574 \begin_layout Subsection
6578 \begin_layout Itemize
6579 sdmp2sox: Pad soundtrack if using -l or -L.
6582 \begin_layout Itemize
6583 sdmp2sox: Fix NTSC overscan.
6586 \begin_layout Itemize
6587 sdmp2sox: Add AR correction mode.
6590 \begin_layout Itemize
6591 call lua_close() when exiting.
6594 \begin_layout Itemize
6595 Fix zip_writer bug causing warnings from info-zip and error from advzip.
6598 \begin_layout Subsection
6602 \begin_layout Itemize
6603 Fix IPS patching code (use bsnes core IPS patcher).
6606 \begin_layout Itemize
6607 Implement BPS patching (using bsnes core IPS patcher).
6610 \begin_layout Itemize
6611 Add feature to load headered ROMs.
6614 \begin_layout Subsection
6618 \begin_layout Itemize
6619 Show command names when showing keybindings
6622 \begin_layout Subsection
6626 \begin_layout Itemize
6627 Fix pause-on-end to be actually controllable
6630 \begin_layout Itemize
6631 SDL: Poll all events in queue, not just first one (fixes slowness in command
6635 \begin_layout Itemize
6636 Wxwidgets: Fix ROM loading.
6639 \begin_layout Subsection
6643 \begin_layout Itemize
6644 Lua: Add gui.textH, gui.textV, gui.textHV
6647 \begin_layout Itemize
6648 Fix text colors on SDL on Mac OS X
6651 \begin_layout Itemize
6652 Mode 'F' for finished in readonly mode.
6655 \begin_layout Itemize
6659 \begin_layout Itemize
6660 Reliably pause after skip poll
6663 \begin_layout Itemize
6664 Split UI and core into their own threads
6667 \begin_layout Subsection
6671 \begin_layout Itemize
6672 Remove leftover dummy SRAM slot
6675 \begin_layout Itemize
6676 Fix controller numbers.
6679 \begin_layout Subsection
6683 \begin_layout Itemize
6684 Fix lsnes-dumpavi after interface change.
6687 \begin_layout Itemize
6688 Also give BSNES patches for v085.
6691 \begin_layout Itemize
6692 Pack movie data in memory.
6695 \begin_layout Subsection
6699 \begin_layout Itemize
6700 Fix framecount/length given when loading movies.
6703 \begin_layout Itemize
6704 Controller command memory leak fixes.
6707 \begin_layout Itemize
6708 Don't leak palette if freeing screen object.
6711 \begin_layout Subsection
6715 \begin_layout Itemize
6719 \begin_layout Itemize
6720 Wxwidgets: Allow controlling dumper from the menu.
6723 \begin_layout Subsection
6727 \begin_layout Itemize
6728 Rewrite parts of manual
6731 \begin_layout Itemize
6732 Lua: Make it work with Lua 5.2.
6735 \begin_layout Subsection
6739 \begin_layout Itemize
6740 Win32: Fix compile errors.
6743 \begin_layout Subsection
6747 \begin_layout Itemize
6748 Refactor controller input code.
6751 \begin_layout Itemize
6752 Fix crash when using command line on SDL / Mac OS X.
6755 \begin_layout Subsection
6759 \begin_layout Itemize
6760 Delete core/coroutine (obsolete)
6763 \begin_layout Itemize
6764 Lag input display by one frame.
6767 \begin_layout Itemize
6768 Rewind movie to beginning function.
6771 \begin_layout Itemize
6772 Fix wrong frame number reported to Lua when repainting after loadstate
6775 \begin_layout Itemize
6776 Support UI editing of jukebox
6779 \begin_layout Itemize
6780 Wxwidgets: Save settings on exit.
6783 \begin_layout Itemize
6784 Support ${project} for filenames
6787 \begin_layout Itemize
6788 SDL: Fix command history
6791 \begin_layout Subsection
6795 \begin_layout Itemize
6796 Fix some order-of-global-ctor bugs.
6799 \begin_layout Subsection
6803 \begin_layout Itemize
6804 Fix crashes when quitting on Win32.
6807 \begin_layout Subsection
6811 \begin_layout Itemize
6812 EVDEV: Queue keypresses from joystick, don't send directly
6815 \begin_layout Itemize
6816 Wxwidgets: Load-Preserve that actually works.
6819 \begin_layout Subsection
6823 \begin_layout Itemize
6824 Wxwidgets: GUI for memory search.
6827 \begin_layout Itemize
6828 Warn about using synchronous queue in UI callback.
6831 \begin_layout Subsection
6835 \begin_layout Itemize
6836 Remember last saved file for each ROM
6839 \begin_layout Itemize
6840 Support MT dumping via boost.
6843 \begin_layout Itemize
6847 \begin_layout Itemize
6851 \begin_layout Itemize
6852 Make mouse be ordinary input instead of special-casing
6855 \begin_layout Itemize
6856 SDL: Don't screw up commands with NUL codepoints.
6859 \begin_layout Subsection
6863 \begin_layout Itemize
6864 Merge status panel and main window
6867 \begin_layout Itemize
6868 True movie slot support (the rest of it)
6871 \begin_layout Itemize
6872 SDL: Fix compilation error
6875 \begin_layout Itemize
6876 Elminate cross calls in dump menu code.
6879 \begin_layout Subsection
6883 \begin_layout Itemize
6884 Cancel pending saves command
6887 \begin_layout Itemize
6888 Wxwidgets: Code refactoring
6891 \begin_layout Itemize
6892 Wxwidgets: Fix system -> reset
6895 \begin_layout Itemize
6896 Wxwidgets: Read watch expressions in the right thread
6899 \begin_layout Subsection
6903 \begin_layout Itemize
6904 Wxwidgets: Don't prompt for member when running Lua script (Lua doesn't
6908 \begin_layout Itemize
6909 Wxwidgets: 128 -> 1024 Autohold slots (in case more are needed).
6912 \begin_layout Itemize
6913 Don't append trailing '-' to prefix when saving movie.
6916 \begin_layout Itemize
6917 Fix ROM/savestate handling (don't let user mismatch ROM and savestates).
6920 \begin_layout Subsection
6924 \begin_layout Itemize
6925 Document memory watch syntax.
6928 \begin_layout Subsection
6932 \begin_layout Itemize
6933 Fix unattended dumping (lsnes-dumpavi)
6936 \begin_layout Itemize
6940 \begin_layout Itemize
6941 Use adv_dumper instead of the old interface in lsnes-dumpavi (changes syntax)
6944 \begin_layout Itemize
6945 Add option to control sample rate preturbation in AVI dumper
6948 \begin_layout Subsection
6952 \begin_layout Itemize
6953 Wxwidgets: Fix dumper submodes
6956 \begin_layout Itemize
6957 Set core controller types before loadstate
6960 \begin_layout Subsection
6964 \begin_layout Itemize
6965 Fix compiling with bsnes v086.
6968 \begin_layout Subsection
6972 \begin_layout Itemize
6973 Don't prompt before quitting
6976 \begin_layout Itemize
6977 Start unpaused, preserve pause/unpause over load.
6980 \begin_layout Itemize
6981 Try to autodetect if ROM is headered.
6984 \begin_layout Itemize
6985 Wxwidgets: Only bring up ROM patching screen if specifically requested.
6988 \begin_layout Itemize
6989 Allow configuring some hotkeys.
6992 \begin_layout Subsection
6996 \begin_layout Itemize
6997 Lots of code cleanups
7000 \begin_layout Itemize
7001 Fix JMD compression (JMD dumping was broken)
7004 \begin_layout Itemize
7005 Don't crash if Lua C function throws an exception.
7008 \begin_layout Itemize
7009 Support bitmap drawing in Lua.
7012 \begin_layout Itemize
7013 Fix bsnes v085/v086 patches.
7016 \begin_layout Itemize
7017 Improve stability on win32.
7020 \begin_layout Subsection
7024 \begin_layout Itemize
7025 Don't corrupt movie if movie length is integer multiple of frames per page.
7028 \begin_layout Subsection
7032 \begin_layout Itemize
7033 New Lua hooks: on_rewind, on_frame_emulated, on_idle, on_timer
7036 \begin_layout Itemize
7037 New Lua functions: emulator_ready(), utime(), set_idle_timeout(), set_timer_time
7038 out(), bit.extract(), bit.value(), input.geta(), input.seta() and input.controllertyp
7042 \begin_layout Itemize
7043 Wxwidgets: Fix internal focus lost (hotkeys stop working)
7046 \begin_layout Itemize
7047 Wxwidgets: Fix broken modifiers
7050 \begin_layout Itemize
7051 on_paint has parameter now.
7054 \begin_layout Itemize
7055 Optional initital fill for bitmaps
7058 \begin_layout Itemize
7059 Fix palette changing.
7062 \begin_layout Itemize
7063 Optimize rendering a bit.
7066 \begin_layout Itemize
7070 \begin_layout Subsection
7074 \begin_layout Itemize
7075 Movieinfo: Fix display of port #2 type.
7078 \begin_layout Itemize
7079 Call on_input() after loadstate.
7082 \begin_layout Subsection
7086 \begin_layout Itemize
7087 Fix writing port2 data to movie.
7090 \begin_layout Itemize
7091 Fix SRAM handling with Bsnes v087.
7094 \begin_layout Subsection
7098 \begin_layout Itemize
7099 Library loading support
7102 \begin_layout Itemize
7103 Built-in TSCC encoder
7106 \begin_layout Itemize
7107 Hi-color (256T colors) dumping.
7110 \begin_layout Itemize
7111 Dump over TCP/IP(v6)
7114 \begin_layout Itemize
7115 Hidable status panel
7118 \begin_layout Itemize
7122 \begin_layout Itemize
7123 Adjustable sound volume
7126 \begin_layout Itemize
7130 \begin_layout Itemize
7131 Allow DnD into filename boxes
7134 \begin_layout Itemize
7138 \begin_layout Itemize
7139 Portaudio: Fix speaker popping at start
7142 \begin_layout Itemize
7146 \begin_layout Itemize
7147 Speed adjustment menu
7150 \begin_layout Itemize
7151 Win32 joystick support
7154 \begin_layout Itemize
7155 Lua: gui.rainbow and gui.box
7158 \begin_layout Itemize
7159 Split key lists into classes (the key list was large!)
7162 \begin_layout Itemize
7163 More save slots support
7166 \begin_layout Itemize
7167 Wxwidgets (wxJoystick) joystick support
7170 \begin_layout Subsection
7174 \begin_layout Itemize
7175 Lots of internal joystick refactoring
7178 \begin_layout Itemize
7179 Evdev: Add mapping for BTN_TOOL_QUINTTAP
7182 \begin_layout Itemize
7183 Wxwidgets: Settings mode (open settings without ROM)
7186 \begin_layout Itemize
7187 Wxwidgets: Prompt key to use option
7190 \begin_layout Itemize
7191 Wxwidgets: Fix crash if key goes away underneath
7194 \begin_layout Itemize
7195 Wxwidgets: Fix mouse position in presence of scaling
7198 \begin_layout Itemize
7199 AVI dumper: Mode 4 (high-quality resampling to common rate using SRC)
7202 \begin_layout Itemize
7203 Wxwidgets: Redesign hotkeys dialog to avoid tree control (tree control doesn't
7204 seem to work well on WinXP)
7207 \begin_layout Itemize
7208 Start paused option.
7211 \begin_layout Subsection
7215 \begin_layout Itemize
7219 \begin_layout Itemize
7220 lsnes-dumpavi: Start Lua before starting dumper
7223 \begin_layout Itemize
7224 AVI: Fix secondary audio in mode 4.
7227 \begin_layout Subsection
7231 \begin_layout Itemize
7232 AVI: Refactor ZMBV a bit.
7235 \begin_layout Itemize
7236 Fix error reading analog values from movie file
7239 \begin_layout Subsection
7243 \begin_layout Itemize
7244 Delayed reset support
7247 \begin_layout Itemize
7248 Lua: memory.hash_region
7251 \begin_layout Subsection
7255 \begin_layout Itemize
7256 Rework the build system
7259 \begin_layout Itemize
7260 Typing input support
7263 \begin_layout Itemize
7264 Fix building with bsnes v086 and v087.
7267 \begin_layout Itemize
7268 SDL: Save settings on exit
7271 \begin_layout Itemize
7272 SDL: Command to enter command line mode with given command.
7275 \begin_layout Itemize
7276 SDL: More advanced command editing.
7279 \begin_layout Subsection
7283 \begin_layout Itemize
7285 \begin_inset Quotes eld
7288 arrow keys and enter don't work
7289 \begin_inset Quotes erd
7295 \begin_layout Itemize
7299 \begin_layout Itemize
7300 Show mode changes due to rewinding.
7303 \begin_layout Itemize
7304 Unsafe rewind support
7307 \begin_layout Itemize
7308 Fix directory transversal.
7311 \begin_layout Subsection
7315 \begin_layout Itemize
7316 AVI: Sound mode 5 (48kHz high-quality)
7319 \begin_layout Itemize
7323 \begin_layout Itemize
7324 Map the SNES bus into address space
7327 \begin_layout Itemize
7328 Fix loading memory watch files with CRLF line endings
7331 \begin_layout Subsection
7335 \begin_layout Itemize
7336 Map bsnes internal state into memory space
7339 \begin_layout Itemize
7341 \begin_inset Quotes eld
7344 click on panel wedges the emulator
7345 \begin_inset Quotes erd
7351 \begin_layout Itemize
7352 DnD movies/saves on the main window.
7355 \begin_layout Subsection
7359 \begin_layout Itemize
7360 Split core bindings into own module.
7363 \begin_layout Itemize
7364 Remember invalid settings
7367 \begin_layout Itemize
7368 Support for modified Gambatte core for GB/GBC emulation.
7371 \begin_layout Itemize
7372 Reload/swap ROM function
7375 \begin_layout Subsection
7379 \begin_layout Itemize
7380 Fix step poll function
7383 \begin_layout Subsection
7387 \begin_layout Itemize
7388 Non-insane savestate anchoring
7391 \begin_layout Subsection
7395 \begin_layout Itemize
7396 More Memory search methods
7399 \begin_layout Itemize
7400 Preserve movie if loading in RO mode.
7403 \begin_layout Itemize
7404 Fix a obscure case in timeline check
7407 \begin_layout Itemize
7408 Revamp the entiere ROM loading code
7411 \begin_layout Itemize
7415 \begin_layout Itemize
7419 \begin_layout Itemize
7420 Standalone hotkey config dialog
7423 \begin_layout Itemize
7424 Show bindings in more user-friendly format
7427 \begin_layout Subsection
7431 \begin_layout Itemize
7435 \begin_layout Itemize
7436 Fix uninitialized variables in bsnes v085
7439 \begin_layout Subsection
7443 \begin_layout Itemize
7444 Merge gambatte core into mainline (from its own branch)
7447 \begin_layout Itemize
7448 Wxwidgets: Show expected dump file formats
7451 \begin_layout Itemize
7452 Memory watch: Data typing
7455 \begin_layout Itemize
7456 lsnes internal MMIO area.
7459 \begin_layout Itemize
7460 Wxwidgets: New memory watch editor
7463 \begin_layout Itemize
7464 Hexadecimal memory watches
7467 \begin_layout Itemize
7468 Wxwidgets: Monospaced panel
7471 \begin_layout Itemize
7472 Wxwidgets: Split memory watches in panel
7475 \begin_layout Itemize
7476 Wxwidgets: Disable VMAs in memory search
7479 \begin_layout Itemize
7480 lsnes-dumpavi: Fix speed bug
7483 \begin_layout Itemize
7484 Movie subtitle support
7487 \begin_layout Itemize
7488 Fix rerecord count reporting
7491 \begin_layout Itemize
7492 Don't trash movie when loading in readonly mode.
7495 \begin_layout Subsection
7499 \begin_layout Itemize
7500 Wxwidgets: Fix crashes on closing settings dialogs on Mac OS X.
7503 \begin_layout Itemize
7504 Fix build on Mac OS X.
7507 \begin_layout Itemize
7511 \begin_layout Itemize
7512 Wxwidgets: Hidable messages window
7515 \begin_layout Itemize
7519 \begin_layout Itemize
7520 Bsnes: Support inconsistent saves
7523 \begin_layout Itemize
7524 Bsnes: Allow simulating saving every frame
7527 \begin_layout Itemize
7528 Fix desync if savestate is loaded in readonly mode in certain conditions.
7531 \begin_layout Itemize
7532 Wxwidgets: Fix save dialogs on Mac OS X.
7535 \begin_layout Itemize
7536 Wxwidgets: Fix insane status width on Win32.
7539 \begin_layout Itemize
7540 Wxwidgets: Fix autohold processing to be faster.
7543 \begin_layout Itemize
7544 Wxwidgets: Allow loading ROMs and movies from commandline.
7547 \begin_layout Subsection
7551 \begin_layout Itemize
7552 Be a bit smarter with --load
7555 \begin_layout Itemize
7556 Rewrote higher-level parts of audio system
7559 \begin_layout Itemize
7560 Tool to build commentary tracks
7563 \begin_layout Itemize
7567 \begin_layout Itemize
7568 Gambatte: Add support for SVN358
7571 \begin_layout Itemize
7572 Use builtin font when rendering status panel.
7575 \begin_layout Itemize
7576 Option to detach memory watch to its own window.
7579 \begin_layout Itemize
7580 Recent ROMs/Movies menu
7583 \begin_layout Itemize
7587 \begin_layout Itemize
7588 Useful lag counter for SNES games that autopoll
7591 \begin_layout Itemize
7592 Fix buffer overflow in gambatte sound output
7595 \begin_layout Subsection
7599 \begin_layout Itemize
7600 Don't blow up on wxGTK if the window is hidden somehow
7603 \begin_layout Itemize
7604 Support simultaneous drop of ROM and movie.
7607 \begin_layout Itemize
7608 Gambatte: Don't save spurious SRAMs.
7611 \begin_layout Itemize
7612 Make SGB ROMs actually usable.
7615 \begin_layout Itemize
7616 Fix so that saved movies appear in recent movies.
7619 \begin_layout Itemize
7620 Don't open multiple commentary editors at once.
7623 \begin_layout Subsection
7627 \begin_layout Itemize
7628 Lua: memory.readregion/memory.writeregion
7631 \begin_layout Itemize
7632 Lua: memory.map{,s}{byte,word,dword,qword}
7635 \begin_layout Itemize
7636 Lua: memory.map_structure
7639 \begin_layout Itemize
7640 Lua: Fix bus_address for gambatte
7643 \begin_layout Itemize
7644 Fix features dependent of bsnes debugger
7647 \begin_layout Itemize
7648 Cleanup bsnes debugger logic
7651 \begin_layout Itemize
7652 Fix resets in presence of save every frame
7655 \begin_layout Subsection
7659 \begin_layout Itemize
7660 Lua: input.lcid_to_pcid
7663 \begin_layout Itemize
7664 Fix off-by-one bug with slot hashes
7667 \begin_layout Itemize
7668 Fix crashes on certain memory watch expressions
7671 \begin_layout Itemize
7672 Lua: memory.read_expr
7675 \begin_layout Itemize
7676 Lua: Fix memory.read_expr on nil argument
7679 \begin_layout Itemize
7680 Fix the code to compile on G++ 4.7
7683 \begin_layout Itemize
7684 Change button_id to be a function pointer field, not a virtual method
7687 \begin_layout Itemize
7688 Add bsnes patches to fix libsnes to compile on GCC 4.7
7691 \begin_layout Itemize
7692 Gambatte: Always use legacy lag counting
7695 \begin_layout Itemize
7696 Memory commands: Memory addresses are up to 16 hex digits, not up to 8
7699 \begin_layout Itemize
7700 Fix analog controllers
7703 \begin_layout Itemize
7707 \begin_layout Itemize
7708 Fix button symbols in input display
7711 \begin_layout Itemize
7712 Compensate for nuts bsnes superscope/justifier handling
7715 \begin_layout Itemize
7716 Lua: Fix bit.extract boolean handling
7719 \begin_layout Subsection
7723 \begin_layout Itemize
7724 Stop at movie end: Don't off-by-one
7727 \begin_layout Itemize
7728 Fix crash closing lsnes with voice playback active.
7731 \begin_layout Itemize
7732 Import/Export OggOpus for commentary tracks
7735 \begin_layout Itemize
7736 16-button controllers.
7739 \begin_layout Itemize
7740 Don't show nonexistent controllers in input display
7743 \begin_layout Itemize
7744 Set voice record/playback volume from UI
7747 \begin_layout Itemize
7748 Patches for gambatte SVN364.
7751 \begin_layout Itemize
7752 Load markup (if exists) even without gamepack file.
7755 \begin_layout Itemize
7756 Screen rotation & flipping
7759 \begin_layout Itemize
7760 Lua: Some new bit functions
7763 \begin_layout Itemize
7764 Auto-refresh voice streams on change.
7767 \begin_layout Itemize
7768 Auto-refresh subtitles on change & new subtitle editor.
7771 \begin_layout Itemize
7772 Fix music volume adjustment.
7775 \begin_layout Subsection
7779 \begin_layout Itemize
7780 Wxwidgets: Fix memory watch rendering.
7783 \begin_layout Itemize
7784 Wxwidgets: Allow setting voice stream gain.
7787 \begin_layout Itemize
7788 Wxwidgets: VU meters and volume adjustment.
7791 \begin_layout Itemize
7792 Lua: Custom fonts support.
7795 \begin_layout Itemize
7796 Lua: Fix methods stopping working when resetting Lua.
7799 \begin_layout Itemize
7800 Fix loading standard-format movies in preserve (readonly) mode.
7803 \begin_layout Subsection
7807 \begin_layout Itemize
7808 Primitive movie editor
7811 \begin_layout Itemize
7812 Fix VU meter with no sound device.
7815 \begin_layout Itemize
7816 Fix various undefined return values.
7819 \begin_layout Itemize
7820 Show rates in VU meter window.