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 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
202 \begin_layout Standard
206 \begin_layout Subsubsection
210 \begin_layout Standard
214 \begin_layout Subsubsection
218 \begin_layout Standard
219 Load <file> as movie or savestate file on startup.
222 \begin_layout Subsubsection
226 \begin_layout Standard
227 Instead of starting the emulator, only display the settings.
230 \begin_layout Subsubsection
234 \begin_layout Standard
235 Run this Lua file on startup
238 \begin_layout Subsection
239 dump options (lsnes-dumpavi only)
242 \begin_layout Subsubsection
246 \begin_layout Standard
251 \begin_layout Subsubsection
255 \begin_layout Standard
256 Load <filename> as movie or savestate file on startup.
260 \begin_layout Subsubsection
264 \begin_layout Standard
265 Set the dumper to use (required).
266 Use 'list' for listing of known dumpers.
269 \begin_layout Subsubsection
270 --firmware-path=<path>
273 \begin_layout Standard
274 Set path to look for firmware.
277 \begin_layout Subsubsection
281 \begin_layout Standard
282 Set the mode to use (required for dumpers with multiple modes, forbidden
284 Use 'list' for known modes.
287 \begin_layout Subsubsection
291 \begin_layout Standard
294 \begin_inset Quotes eld
298 \begin_inset Quotes erd
304 \begin_layout Subsubsection
305 --option=<name>=<value>
308 \begin_layout Standard
309 Set option <name> to value <value>.
312 \begin_layout Subsubsection
316 \begin_layout Standard
317 Set number of frames to dump.
321 \begin_layout Subsubsection
325 \begin_layout Standard
326 Run specified lua script (lsnes-dumpavi does not have initialization files).
329 \begin_layout Subsubsection
330 --load-library=<library>
333 \begin_layout Standard
334 Load the specified shared object / dynamic library / dynamic link library.
337 \begin_layout Subsection
338 lsnes settings directory
341 \begin_layout Standard
342 The lsnes settings directory is (in order of decreasing perference):
345 \begin_layout Itemize
348 lsnes (if %APPDATA% exists)
351 \begin_layout Itemize
352 Unix: $XDG_CONFIG_HOME/lsnes (if $XDG_CONFIG_HOME exists)
355 \begin_layout Itemize
356 Unix: $HOME/.config/lsnes (if $HOME exists)
359 \begin_layout Itemize
364 \begin_layout Standard
365 If leading directories do not exist, attempt to create them is made.
368 \begin_layout Section
372 \begin_layout Itemize
373 Commands beginning with '*' invoke the corresponding command without alias
377 \begin_layout Itemize
378 If command starts with '+' (after possible '*'), the command is executed
379 as-is when button is pressed, and when button is released, it is executed
380 with '+' replaced by '-'.
383 \begin_layout Itemize
384 Commands without '+' execute only on negative edge (release).
387 \begin_layout Subsection
391 \begin_layout Standard
392 Run <script> as if commands were entered on the command line.
395 \begin_layout Subsection
399 \begin_layout Standard
400 <address> may be decimal or hexadecimal (prefixed with '0x').
401 <value> can be hexadecimal (prefixed with '0x'), unsigned or signed (prefixed
405 \begin_layout Standard
406 The available element <sizes> are:
409 \begin_layout Itemize
413 \begin_layout Itemize
417 \begin_layout Itemize
421 \begin_layout Itemize
425 \begin_layout Standard
426 When reading RAM and ROM, multi-byte reads/writes are big-endian.
427 When dealing with DSP memory, multi-byte reads/writes are native-endian
428 (do not use operand sizes exceeding DSP bitness, except dword is OK for
432 \begin_layout Subsubsection
433 read-<size> <address>
436 \begin_layout Standard
437 Read the value of byte in <address>.
440 \begin_layout Subsubsection
441 read-s<size> <address>
444 \begin_layout Standard
445 Read the value of signed byte in <address>.
448 \begin_layout Subsubsection
449 write-<size> <address> <value>
452 \begin_layout Standard
453 Write <value> to byte in address <address>.
456 \begin_layout Subsection
460 \begin_layout Standard
461 These commands are not available in lsnesrc, but are available after ROM
465 \begin_layout Subsubsection
469 \begin_layout Standard
473 \begin_layout Subsubsection
477 \begin_layout Standard
478 Toggle paused/unpaused
481 \begin_layout Subsubsection
485 \begin_layout Standard
487 If the button is still held after configurable timeout expires, game unpauses
488 for the duration frame advance is held.
491 \begin_layout Subsubsection
495 \begin_layout Standard
497 If the button is still held after configurable timeout expires, game unpauses
498 for the duration frame advance is held.
501 \begin_layout Subsubsection
505 \begin_layout Standard
506 Skip to first poll in frame after current.
509 \begin_layout Subsubsection
513 \begin_layout Standard
514 Reset the SNES after this frame.
517 \begin_layout Subsubsection
521 \begin_layout Standard
522 Load savestate <filename> in current mode.
525 \begin_layout Subsubsection
526 load-state <filename>
529 \begin_layout Standard
530 Load savestate <filename> in readwrite mode.
533 \begin_layout Subsubsection
534 load-readonly <filename>
537 \begin_layout Standard
538 Load savestate <filename> in readonly mode.
541 \begin_layout Subsubsection
542 load-preserve <filename>
545 \begin_layout Standard
546 Load savestate <filename> in readonly mode, preserving current events.
549 \begin_layout Subsubsection
550 load-movie <filename>
553 \begin_layout Standard
554 Load savestate <filename>, ignoring save part in readonly mode.
557 \begin_layout Subsubsection
558 save-state <filename>
561 \begin_layout Standard
562 Save system state to <filename> as soon as possible.
565 \begin_layout Subsubsection
566 save-movie <filename>
569 \begin_layout Standard
570 Save movie to <filename>.
573 \begin_layout Subsubsection
577 \begin_layout Standard
581 \begin_layout Subsubsection
585 \begin_layout Standard
589 \begin_layout Subsubsection
593 \begin_layout Standard
594 Toggle between read-only and read-write modes.
597 \begin_layout Subsubsection
598 test-1, test-2, test-3
601 \begin_layout Standard
602 Internal test commands.
606 \begin_layout Subsubsection
607 take-screenshot <filename>
610 \begin_layout Standard
611 Save screenshot to <filename>.
614 \begin_layout Subsubsection
615 +controller <class>-<#>-<button>
618 \begin_layout Standard
619 Press button <button> on controller <num> of class <class>.
622 \begin_layout Itemize
623 Class 'gamepad': A, B, X, Y, L, R, select, start, up, down, left, right,
624 ext0, ext1, ext2, ext3
627 \begin_layout Itemize
631 \begin_layout Itemize
632 Class 'superscope': trigger, cursor, turbo, pause
635 \begin_layout Itemize
636 Class 'justifier': trigger, start
639 \begin_layout Itemize
640 Class 'gb': A, B, select, start, up, down, left, right
643 \begin_layout Subsubsection
644 hold-controller <class>-<#>-<button>
647 \begin_layout Standard
648 Hold/unhold button <button> on controller <num> of class <class>.
651 \begin_layout Subsubsection
652 type-controller <class>-<#>-<button>
655 \begin_layout Standard
656 Hold/unhold button <button> on controller <num> of class <class> for the
658 See +controller for button names.
661 \begin_layout Standard
662 Cauntion: Does not work properly if outside frame advance.
665 \begin_layout Subsubsection
666 +autofire-controller <class>-<#>-<button> [[<duty>] <cyclelen>]
669 \begin_layout Standard
671 If duty is not specified, defaults to 1.
672 If <cyclelen> is not specified, defaults to 2.
675 \begin_layout Subsubsection
676 -autofire-controller <class>-<#>-<button> [[<duty>] <cyclelen>]
679 \begin_layout Standard
683 \begin_layout Subsubsection
684 autofire-controller <class>-<#>-<button> [[<duty>] <cyclelen>]
687 \begin_layout Standard
689 If autofire is turned on, specified cycle is used.
692 \begin_layout Subsubsection
693 designate-position <class>-<#>-analog<n>
696 \begin_layout Standard
697 Designate position for analog pair.
698 <n> is only there if there are multiple axis pairs.
701 \begin_layout Subsubsection
705 \begin_layout Standard
709 \begin_layout Subsubsection
713 \begin_layout Standard
714 Toggle pause on end flag.
717 \begin_layout Subsubsection
721 \begin_layout Standard
722 Set pause on end flag.
725 \begin_layout Subsubsection
729 \begin_layout Standard
730 Clear pause on end flag.
733 \begin_layout Subsubsection
734 action <action> [<parameters>]
737 \begin_layout Standard
738 Run specified core action.
741 \begin_layout Subsection
745 \begin_layout Subsubsection
746 cycle-jukebox-backward
749 \begin_layout Standard
750 Cycle save jukebox backwards.
753 \begin_layout Subsubsection
754 cycle-jukebox-forward
757 \begin_layout Standard
758 Cycle save jukebox forwards
761 \begin_layout Subsubsection
765 \begin_layout Standard
766 Do load from jukebox (current mode).
769 \begin_layout Subsubsection
773 \begin_layout Standard
774 Do state save to jukebox.
777 \begin_layout Subsection
781 \begin_layout Subsubsection
782 evaluate-lua <luacode>
785 \begin_layout Standard
786 Run Lua code <luacode> using built-in Lua interpretter.
789 \begin_layout Subsubsection
793 \begin_layout Standard
794 Run specified lua file using built-in Lua interpretter.
797 \begin_layout Subsubsection
801 \begin_layout Standard
802 Clear the Lua VM state and restore to factory defaults.
805 \begin_layout Subsection
809 \begin_layout Subsubsection
810 add-watch <name> <expression>
813 \begin_layout Standard
814 Adds new watch (or modifies old one).
817 \begin_layout Subsubsection
821 \begin_layout Standard
825 \begin_layout Subsection
829 \begin_layout Subsubsection
830 enable-sound <on/off>
833 \begin_layout Standard
834 Enable/Disable sound.
837 \begin_layout Subsection
841 \begin_layout Subsubsection
845 \begin_layout Standard
846 Reloads the main ROM image from <file>.
849 \begin_layout Subsubsection
853 \begin_layout Standard
854 Tangent for recording voice for commentary track.
855 While pressed, record a stream.
858 \begin_layout Subsubsection
859 advance-subframe-timeout
862 \begin_layout Standard
863 Subframe advance timeout in milliseconds.
867 \begin_layout Section
871 \begin_layout Subsection
875 \begin_layout Subsection
879 \begin_layout Subsubsection
883 \begin_layout Standard
884 AVI dumper: Always dump at 512x448 or 512x478 regardless of what the console
888 \begin_layout Subsubsection
892 \begin_layout Standard
893 AVI dumper: Set the default left border thickness (unless lua overrides)
899 \begin_layout Subsubsection
903 \begin_layout Standard
904 AVI dumper: Set the default right border thickness (unless lua overrides)
910 \begin_layout Subsubsection
914 \begin_layout Standard
915 AVI dumper: Set the default top border thickness (unless lua overrides)
921 \begin_layout Subsubsection
925 \begin_layout Standard
926 AVI dumper: Set the default bottom border thickness (unless lua overrides)
932 \begin_layout Subsubsection
936 \begin_layout Standard
937 AVI dumper: Maximum number of frames per dump segment (0 => unlimited).
942 \begin_layout Subsubsection
946 \begin_layout Standard
947 AVI dumper: Compression level (0-18).
950 \begin_layout Itemize
951 Compression levels 10 and above are not compatible with stock CSCD codec.
954 \begin_layout Itemize
955 Recomended level is 7.
958 \begin_layout Subsubsection
962 \begin_layout Standard
963 AVI dumper: Set method of determining the sound rate.
966 \begin_layout Itemize
967 0: Pick nearest of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48, 64, 88.2, 96,
968 128, 176.4 and 192 kHz.
971 \begin_layout Itemize
972 1: Round down to nearest integer.
975 \begin_layout Itemize
976 2: Round up to nearest ingeter.
979 \begin_layout Itemize
980 3: Multiply by denominator.
983 \begin_layout Itemize
984 4: High quality 44.1kHz (SRC needed).
987 \begin_layout Itemize
988 5: High quality 48kHz (SRC needed).
991 \begin_layout Subsection
995 \begin_layout Subsubsection
999 \begin_layout Standard
1000 JMD dumper: Compression level (0-9).
1003 \begin_layout Section
1007 \begin_layout Subsection
1008 Core (in main table)
1011 \begin_layout Subsubsection
1015 \begin_layout Standard
1016 Print line to message console.
1019 \begin_layout Subsubsection
1020 exec(string command)
1023 \begin_layout Standard
1024 Run command as it was entered on the command line
1027 \begin_layout Subsubsection
1031 \begin_layout Standard
1033 First is time since some epoch in seconds, the second is microseconds mod
1034 10^6 since that epoch.
1037 \begin_layout Subsubsection
1041 \begin_layout Standard
1042 Returns true if emulator has finished booting, false if not (on_startup()
1043 will be issued later).
1046 \begin_layout Subsubsection
1047 set_idle_timeout(number timeout)
1050 \begin_layout Standard
1051 Set number of microseconds to block idle for.
1052 After this timeout has expired, on_idle() will be called once.
1055 \begin_layout Subsubsection
1056 set_timer_timeout(number timeout)
1059 \begin_layout Standard
1060 Set number of microseconds to block timer for.
1061 After this timeout has expired, on_timer() will be called once.
1064 \begin_layout Subsubsection
1065 bus_address(number snesaddr)
1068 \begin_layout Standard
1069 Returns virtual address corresponding to specified address on SNES bus.
1072 \begin_layout Subsubsection
1073 loopwrapper(function fun, ...)
1076 \begin_layout Standard
1077 Calls function fun with function and specified arguments.
1078 The function passed suspends execution until the function returned is called.
1079 Handy for linear flow control among multiple invocations of a hook.
1083 \begin_layout LyX-Code
1084 on_paint = loopwrapper(function(wait)
1088 \begin_layout LyX-Code
1093 \begin_layout LyX-Code
1095 \begin_inset Quotes eld
1099 \begin_inset Quotes erd
1105 \begin_layout LyX-Code
1110 \begin_layout LyX-Code
1115 \begin_layout LyX-Code
1119 \begin_layout Subsubsection
1120 list_bindings([string cmd])
1123 \begin_layout Standard
1124 Get table of all keybindings, indexed by keyspec (modifiers|mask/key).
1125 If command is specified, the table is limited to that command.
1126 Also searches for controller keys.
1129 \begin_layout Subsubsection
1130 get_alias(string aname)
1133 \begin_layout Standard
1134 Get expansion of given alias.
1137 \begin_layout Subsubsection
1138 set_alias(string aname, string value)
1141 \begin_layout Standard
1142 Set expansion of given alias.
1145 \begin_layout Subsubsection
1146 create_ibind(string name, string cmd)
1149 \begin_layout Standard
1150 Return object representing inverse binding with specified name and specified
1154 \begin_layout Itemize
1155 To create press/release commands, use aliases +foo and -foo .
1158 \begin_layout Itemize
1159 Keep the returned object around.
1162 \begin_layout Subsubsection
1163 create_command(string name, function a[, function b])
1166 \begin_layout Standard
1167 Return object representing a command (pair).
1170 \begin_layout Itemize
1171 If b is NIL, the command is level-sensitive, a is callback.
1174 \begin_layout Itemize
1175 If b is function, the function is edge-sensitive, a is positive edge callback
1176 and b is negative edge callback.
1179 \begin_layout Itemize
1180 All callbacks get single argument: The parameters passed.
1183 \begin_layout Itemize
1184 Keep the returned object around.
1187 \begin_layout Subsection
1191 \begin_layout Standard
1192 Bitwise logical functions and related.
1195 \begin_layout Subsubsection
1196 bit.none(number...) / bit.bnot(number...)
1199 \begin_layout Standard
1200 48-bit bitwise NOT / NONE function (set bits that are set in none of the
1204 \begin_layout Subsubsection
1205 bit.any(number...) / bit.bor(number...)
1208 \begin_layout Standard
1209 48-bit bitwise OR / ANY function (set bits that are set in any of the arguments).
1212 \begin_layout Subsubsection
1213 bit.all(number...) / bit.band(number...)
1216 \begin_layout Standard
1217 48-bit bitwise AND / ALL function (set bits that are set in all of the arguments
1221 \begin_layout Subsubsection
1222 bit.parity(number...) / bit.bxor(number...)
1225 \begin_layout Standard
1226 48-bit bitwise XOR / PARITY function (set bits that are set in odd number
1230 \begin_layout Subsubsection
1231 bit.lrotate(number base[, number amount[, number bits]])
1234 \begin_layout Standard
1235 Rotate bits-bit (max 48, default 48) number left by amount (default 1) places.
1238 \begin_layout Subsubsection
1239 bit.rrotate(number base[, number amount[, number bits]])
1242 \begin_layout Standard
1243 Rotate bits-bit (max 48, default 48) number right by amount (default 1)
1247 \begin_layout Subsubsection
1248 bit.lshift(number base[, number amount[, number bits]])
1251 \begin_layout Standard
1252 Shift bits-bit (max 48, default 48) number left by amount (default 1) places.
1253 The new bits are filled with zeroes.
1256 \begin_layout Subsubsection
1257 bit.lrshift(number base[, number amount[, number bits]])
1260 \begin_layout Standard
1261 Shift bits-bit (max 48, default 48) number logically right by amount (default
1263 The new bits are filled with zeroes.
1266 \begin_layout Subsubsection
1267 bit.arshift(number base[, number amount[, number bits]])
1270 \begin_layout Standard
1271 Shift bits-bit (max 48, default 48) number arithmetically right by amount
1273 The new bits are shifted in with copy of the high bit.
1276 \begin_layout Subsubsection
1277 bit.extract(number base[, number bit0[, number bit1,...]])
1280 \begin_layout Standard
1281 Returns number that has bit0-th bit as bit 0, bit1-th bit as 1 and so on.
1284 \begin_layout Standard
1288 \begin_layout Itemize
1289 Bit numbers up to 51 should work reliably (then things start falling apart
1290 due to double precision issues).
1293 \begin_layout Itemize
1294 There are two special bit positions, true and false, standing for always
1295 set bit and always clear bit.
1298 \begin_layout Subsubsection
1299 bit.value([number bit1[, number bit2,...]])
1302 \begin_layout Standard
1303 Returns bitwise OR of 1 left shifted by bit1 places, 1 left shifted by bit2
1305 As special value, nil argument is no-op.
1308 \begin_layout Subsubsection
1309 bit.test_any(number a, number b)
1312 \begin_layout Standard
1313 Returns true if bitwise and of a and b is nonzero, otherwise false.
1316 \begin_layout Subsubsection
1317 bit.test_all(number a, number b)
1320 \begin_layout Standard
1321 Returns true if bitwise and of a and b is equals b, otherwise false.
1324 \begin_layout Subsubsection
1325 bit.popcount(number a)
1328 \begin_layout Standard
1329 Returns number of set bits in a.
1332 \begin_layout Subsubsection
1333 bit.clshift(number a, number b, [number amount,[number bits]])
1336 \begin_layout Standard
1337 Does chained left shift on a, b by amount positions, assuming numbers to
1338 be of specified number of bits.
1341 \begin_layout Subsubsection
1342 bit.crshift(number a, number b, [number amount,[number bits]])
1345 \begin_layout Standard
1346 Does chained right shift on a, b by amount positions, assuming numbers to
1347 be of specified number of bits.
1350 \begin_layout Subsubsection
1351 bit.flagdecode(number a, number bits, [string on, [string off]])
1354 \begin_layout Standard
1355 Return string of length bits where ith character is ith character of on
1356 if bit i is on, otherwise ith character of off.
1357 Out of range reads give last character, or '*'/'-' if empty.
1360 \begin_layout Subsubsection
1361 bit.rflagdecode(number a, number bits, [string on, [string off]])
1364 \begin_layout Standard
1365 Like bit.flagdecode, but outputs the string in the opposite order (most significa
1369 \begin_layout Subsection
1373 \begin_layout Standard
1374 Most of these functions can only be called in on_paint and on_video callbacks.
1375 Exceptions are noted.
1378 \begin_layout Standard
1380 Bits 0-7 are the blue component, bits 8-15 are the green component, bits
1381 16-23 are the red component, bits 24-31 are alpha component (0 is fully
1382 opaque, 255 is almost transparent).
1383 -1 is the fully transparent color.
1384 Alpha values greater than 127 do work.
1387 \begin_layout Standard
1388 Origin of coordinates is at top left corner of game display area.
1389 Left and top gaps correspond to negative coordinates.
1392 \begin_layout Subsubsection
1396 \begin_layout Standard
1397 Returns 2-tuple (hresolution, vresolution).
1400 \begin_layout Subsubsection
1401 gui.<class>_gap(number gap)
1404 \begin_layout Standard
1405 Set the <class> (left, right, top, bottom) gap to specified value (max gap
1407 If successful, old gap is returned.
1410 \begin_layout Subsubsection
1411 gui.delta_<class>_gap(number gap)
1414 \begin_layout Standard
1415 Increase the <class> (left, right, top, bottom) gap by specified value (max
1416 gap is 8191) and return the old gap (returns nothing on error).
1419 \begin_layout Subsubsection
1420 gui.text(number x, number y, string text[, number fgc[, number bgc]])
1423 \begin_layout Standard
1424 Draw specified text on the GUI (each character cell is 8 or 16 wide and
1429 \begin_layout Itemize
1430 x: X-coordinate to start the drawing from (and x-coordinate at begining
1434 \begin_layout Itemize
1435 y: Y-coordinate to start the drawing from.
1438 \begin_layout Itemize
1439 text: The text to draw.
1442 \begin_layout Itemize
1443 fgc: Text color (default is 0xFFFFFF (white))
1446 \begin_layout Itemize
1447 bgc: Background color (default is -1 (transparent))
1450 \begin_layout Subsubsection
1451 gui.textH(number x, number y, string text[, number fgc[, number bgc]])
1454 \begin_layout Standard
1455 Like gui.text, but draw using double-width.
1458 \begin_layout Subsubsection
1459 gui.textV(number x, number y, string text[, number fgc[, number bgc]])
1462 \begin_layout Standard
1463 Like gui.text, but draw using double-height.
1466 \begin_layout Subsubsection
1467 gui.textHV(number x, number y, string text[, number fgc[, number bgc]])
1470 \begin_layout Standard
1471 Like gui.text, but draw using double-width/double-height.
1474 \begin_layout Subsubsection
1475 gui.rectangle(number x, number y, number width, number height[, number thickness[
1476 , number outline[, number fill]]])
1479 \begin_layout Standard
1480 Draw rectangle on the GUI.
1484 \begin_layout Itemize
1485 x: X-coordinate of left edge.
1488 \begin_layout Itemize
1489 y: Y-coordinate of upper edge.
1492 \begin_layout Itemize
1493 width: Width of rectangle.
1496 \begin_layout Itemize
1497 height: Height of rectangle.
1500 \begin_layout Itemize
1501 thickness: Thickness of outline (default is 1).
1504 \begin_layout Itemize
1505 outline: Color of outline (default is 0xFFFFFF (white))
1508 \begin_layout Itemize
1509 fill: Color of fill (default is -1 (transparent))
1512 \begin_layout Subsubsection
1513 gui.box(number x, number y, number width, number height[, number thickness[,
1514 number outline1[,number outline2[, number fill]]]])
1517 \begin_layout Standard
1518 Draw rectangle with 3D effect on the GUI.
1522 \begin_layout Itemize
1523 x: X-coordinate of left edge.
1526 \begin_layout Itemize
1527 y: Y-coordinate of upper edge.
1530 \begin_layout Itemize
1531 width: Width of rectangle.
1534 \begin_layout Itemize
1535 height: Height of rectangle.
1538 \begin_layout Itemize
1539 thickness: Thickness of outline (default is 1).
1542 \begin_layout Itemize
1543 outline1: First color of outline (default is 0xFFFFFF (white))
1546 \begin_layout Itemize
1547 outline2: First color of outline (default is 0x808080 (dark gray))
1550 \begin_layout Itemize
1551 fill: Color of fill (default is 0xC0C0C0 (light grayy))
1554 \begin_layout Subsubsection
1555 gui.pixel(number x, number y[, number color])
1558 \begin_layout Standard
1559 Draw one pixel on the GUI.
1563 \begin_layout Itemize
1564 x: X-coordinate of the pixel
1567 \begin_layout Itemize
1568 y: Y-coordinate of the pixel
1571 \begin_layout Itemize
1572 color: Color of the pixel (default is 0xFFFFFF (white))
1575 \begin_layout Subsubsection
1576 gui.crosshair(number x, number y[, number length[, number color]])
1579 \begin_layout Standard
1584 \begin_layout Itemize
1585 x: X-coordinate of the crosshair
1588 \begin_layout Itemize
1589 y: Y-coordinate of the crosshair
1592 \begin_layout Itemize
1593 length: Length of the crosshair lines (default 10).
1596 \begin_layout Itemize
1597 color: Color of the crosshair (default is 0xFFFFFF (white))
1600 \begin_layout Subsubsection
1601 gui.line(number x1, number y1, number x2, number y2[, number color])
1604 \begin_layout Standard
1609 \begin_layout Itemize
1610 x1: X-coordinate of one end.
1613 \begin_layout Itemize
1614 y1: Y-coordinate of one end.
1617 \begin_layout Itemize
1618 x2: X-coordinate of the other end.
1621 \begin_layout Itemize
1622 y2: Y-coordinate of the other end.
1625 \begin_layout Itemize
1626 color: Color of the line (default is 0xFFFFFF (white)).
1629 \begin_layout Subsubsection
1630 gui.circle(number x, number y, number r[, number thick[, number border[,
1634 \begin_layout Standard
1639 \begin_layout Itemize
1640 x: X-coordinate of the center
1643 \begin_layout Itemize
1644 y: Y-coordinate of the center
1647 \begin_layout Itemize
1648 r: The radius of the circle
1651 \begin_layout Itemize
1652 thick: Border thickness
1655 \begin_layout Itemize
1656 border: Border color (default is 0xFFFFFF (white))
1659 \begin_layout Itemize
1660 fill: Fill color (default is -1 (transparent)).
1663 \begin_layout Subsubsection
1664 gui.bitmap_draw(number x, number y, bitmap bitmap, palette palette)
1667 \begin_layout Standard
1668 Draw a bitmap on screen with specified palette.
1672 \begin_layout Itemize
1673 x: X-coordinate of left edge.
1676 \begin_layout Itemize
1677 y: Y-coordinate of top edge.
1680 \begin_layout Itemize
1681 bitmap: The bitmap to draw
1684 \begin_layout Itemize
1685 palette: The palette to draw the bitmap using.
1688 \begin_layout Subsubsection
1689 gui.bitmap_draw(number x, number y, dbitmap bitmap)
1692 \begin_layout Standard
1693 Draw a bitmap on screen.
1697 \begin_layout Itemize
1698 x: X-coordinate of left edge.
1701 \begin_layout Itemize
1702 y: Y-coordinate of top edge.
1705 \begin_layout Itemize
1706 bitmap: The bitmap to draw
1709 \begin_layout Subsubsection
1713 \begin_layout Standard
1714 Returns a new palette (initially all transparent).
1715 Can be used anywhere.
1718 \begin_layout Subsubsection
1719 gui.bitmap_new(number w, number h, boolean direct[, bool icolor])
1722 \begin_layout Standard
1723 Returns a new bitmap/dbitmap.
1724 Can be used anywhere.
1728 \begin_layout Itemize
1729 w: The width of new bitmap
1732 \begin_layout Itemize
1733 h: The height of new bitmap
1736 \begin_layout Itemize
1737 direct: If true, the returned bitmap is dbitmap, otherwise bitmap.
1740 \begin_layout Itemize
1741 icolor: Initital fill color (defaults to 0 on BITMAP, -1 on DBITMAP)
1744 \begin_layout Subsubsection
1745 gui.bitmap_load(string file)
1748 \begin_layout Standard
1749 Returns loaded bitmap/dbitmap (if bitmap, the second return value is palette
1751 Can be used anywhere.
1755 \begin_layout Itemize
1756 file: The name of file to load.
1759 \begin_layout Subsubsection
1760 gui.palette_set(palette palette, number index, number color)
1763 \begin_layout Standard
1764 Sets color in palette.
1765 Can be used anywhere.
1769 \begin_layout Itemize
1770 palette: The palette to manipulate
1773 \begin_layout Itemize
1774 index: Index of color (0-65535).
1777 \begin_layout Itemize
1778 color: The color value.
1781 \begin_layout Subsubsection
1782 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y, number color)
1785 \begin_layout Standard
1786 Sets specified pixel in bitmap.
1787 Can be used anywhere.
1791 \begin_layout Itemize
1792 bitmap: The bitmap to manipulate
1795 \begin_layout Itemize
1796 x: The x-coordinate of the pixel.
1799 \begin_layout Itemize
1800 y: The y-coordinate of the pixel.
1803 \begin_layout Itemize
1804 color: If bitmap is a bitmap, color index (0-65535).
1805 Otherwise color value.
1808 \begin_layout Subsubsection
1809 gui.bitmap_size(bitmap/dbitmap bitmap)
1812 \begin_layout Standard
1814 Can be used anywhere.
1818 \begin_layout Itemize
1819 bitmap: The bitmap to query.
1822 \begin_layout Standard
1823 The first return is the width, the second is the height.
1826 \begin_layout Subsubsection
1827 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy, bitmap/dbitmap
1828 src, number sx, number sy, number w, number h[, number ck])
1831 \begin_layout Standard
1832 Blit a part of bitmap to another.
1833 Can be used anywhere.
1837 \begin_layout Itemize
1838 dest: Destination to blit to.
1841 \begin_layout Itemize
1842 dx: left edge of target
1845 \begin_layout Itemize
1846 dy: Top edge of target
1849 \begin_layout Itemize
1850 src: The source to blit from.
1851 Must be of the same type as destination.
1854 \begin_layout Itemize
1855 sx: left edge of source
1858 \begin_layout Itemize
1859 sy: Top edge of source
1862 \begin_layout Itemize
1866 \begin_layout Itemize
1867 h: Height of region.
1870 \begin_layout Itemize
1872 Pixels of this color are not blitted.
1876 \begin_layout Itemize
1877 If bitmaps are bitmaps, this is color index of colorkey.
1878 Values outside range 0-65535 cause no key to be used as colorkey.
1881 \begin_layout Itemize
1882 If bitmaps are dbitmaps, this color value of colorkey.
1885 \begin_layout Itemize
1886 May be absent or nil for no colorkey blit.
1890 \begin_layout Subsubsection
1894 \begin_layout Standard
1895 Request on_repaint() to happen as soon as possible.
1896 Can be used anywhere.
1899 \begin_layout Subsubsection
1900 gui.subframe_update(boolean on)
1903 \begin_layout Standard
1904 Request subframe updates (calling on_paint() on subframes) to happen (on=true)
1905 or not happen (on=false).
1906 Can be used anywhere.
1909 \begin_layout Subsubsection
1910 gui.screenshot(string filename)
1913 \begin_layout Standard
1914 Write PNG screenshot of the current frame (no drawings) to specified file.
1915 Can be used anywhere.
1918 \begin_layout Subsubsection
1919 gui.color(number r, number g, number b[, number a])
1922 \begin_layout Standard
1923 Returns color (in notation Lua scripts use) corresponding to color (r,g,b),
1924 each component in scale 0-255.
1925 If a is specified, that is alpha (0 is fully transparent, 256(sic) is fully
1927 The default alpha is 256.
1930 \begin_layout Subsubsection
1931 gui.status(string name, string value)
1934 \begin_layout Standard
1936 \begin_inset Quotes eld
1940 \begin_inset Quotes erd
1943 to <value> in status area.
1944 Can be used anywhere.
1947 \begin_layout Subsubsection
1948 gui.rainbow(number step, number steps[, number color])
1951 \begin_layout Standard
1952 Perform hue rotation of color <color> (default bright red), by <step> steps.
1953 The number of steps per full rotation is given by absolute value of <steps>.
1956 \begin_layout Standard
1957 If <steps> is negative, the rotation will be counterclockwise.
1960 \begin_layout Subsubsection
1961 gui.screenshot(string filename)
1964 \begin_layout Standard
1965 Saves a screenshot into specified file.
1968 \begin_layout Subsubsection
1969 gui.renderq_new(number width, number height)
1972 \begin_layout Standard
1973 Create render queue with specified reported size and return it.
1976 \begin_layout Subsubsection
1977 gui.renderq_clear(RENDERQUEUE queue)
1980 \begin_layout Standard
1981 Clear specified render queue.
1984 \begin_layout Subsubsection
1985 gui.renderq_set(RENDERQUEUE queue)
1988 \begin_layout Standard
1989 Switch to specified render queue.
1990 Use nil as queue to switch to default queue.
1993 \begin_layout Itemize
1994 When switched to another queue, all drawing functions work and draw there,
1995 even outside on_video/on_paint.
1998 \begin_layout Subsubsection
1999 gui.renderq_run(RENDERQUEUE queue)
2002 \begin_layout Standard
2003 Run specified render queue, copying the objects to current render queue.
2007 \begin_layout Itemize
2008 Warning: Don't try to run the current render queue.
2011 \begin_layout Subsubsection
2012 gui.loadfont(string filename)
2015 \begin_layout Standard
2016 Loads font from specified file (CUSTOMFONT object).
2019 \begin_layout Subsubsection
2020 CUSTOMFONT(number x, number y, string text[, number fgc[, number bgc[, number
2024 \begin_layout Standard
2025 Draw string with custom font to screen.
2026 The parameters are the same as in gui.text, except hlc is the halo color
2027 (default is no halo).
2031 \begin_layout Subsection
2035 \begin_layout Standard
2037 Only available in on_input callback.
2040 \begin_layout Subsubsection
2041 input.get(number controller, number index)
2044 \begin_layout Standard
2045 Read the specified index (0-11) from specified controller (0-7).
2049 \begin_layout Itemize
2050 Uses physical controller numbering.
2051 Gamepad in port 2 is controller 4, not 1!
2054 \begin_layout Subsubsection
2055 input.set(number controller, number index, number value)
2058 \begin_layout Standard
2059 Write the specified index (0-11) from specified controller (0-7), storing
2064 \begin_layout Itemize
2065 Uses physical controller numbering.
2066 Gamepad in port 2 is controller 4, not 1!
2069 \begin_layout Subsubsection
2070 input.get2(number port, number controller, number index)
2073 \begin_layout Standard
2074 Read the specified input tuple.
2077 \begin_layout Itemize
2078 Port 0 is system port.
2081 \begin_layout Subsubsection
2082 input.set2(number port, number controller, number index, number value)
2085 \begin_layout Standard
2086 Write the specified input tuple.
2089 \begin_layout Itemize
2090 Port 0 is system port.
2093 \begin_layout Subsubsection
2094 input.lcid_to_pcid2(number lcid)
2097 \begin_layout Standard
2098 Look up physical pcid pair (port, controller) corresponding to specified
2099 logical controller (1-based).
2100 Returns nothing if controller does not exist.
2103 \begin_layout Subsubsection
2104 input.port_type(number port)
2107 \begin_layout Standard
2108 Return type of specified port.
2111 \begin_layout Subsubsection
2112 input.controller_info(number port, number controller)
2115 \begin_layout Standard
2116 Get controller info for specified controller.
2117 If controller does not exist, returns nil.
2118 Otherwise returns a table with following fields:
2121 \begin_layout Itemize
2122 type (string): Type of the controller.
2125 \begin_layout Itemize
2126 class (string): Class of the controller.
2129 \begin_layout Itemize
2130 classnum (number): Number of the controller within its class (1-based)
2133 \begin_layout Itemize
2134 lcid (number): Logical controller number of the controller.
2137 \begin_layout Itemize
2138 button_count (number): Number of buttons on controller
2141 \begin_layout Itemize
2142 buttons (array): Array of following info about each button:
2146 \begin_layout Itemize
2147 type (string): Type of button.
2149 \begin_inset Quotes eld
2153 \begin_inset Quotes erd
2157 \begin_inset Quotes eld
2161 \begin_inset Quotes erd
2165 \begin_inset Quotes eld
2169 \begin_inset Quotes erd
2173 \begin_inset Quotes eld
2177 \begin_inset Quotes erd
2183 \begin_layout Itemize
2184 name (string): Name of button.
2187 \begin_layout Itemize
2188 symbol (string): Symbol of button.
2189 Only present for type
2190 \begin_inset Quotes eld
2194 \begin_inset Quotes erd
2200 \begin_layout Itemize
2201 hidden (boolean): True if hidden button.
2206 \begin_layout Subsubsection
2210 \begin_layout Standard
2211 Signals that the button event should be vetoed.
2212 Only valid in on_button callback.
2215 \begin_layout Subsubsection
2216 input.geta(number controller)
2219 \begin_layout Standard
2220 Get input state for entiere controller.
2221 Returns 13 return values.
2224 \begin_layout Itemize
2225 1st return value: Bitmask: bit i is set if i:th index is nonzero
2228 \begin_layout Itemize
2229 2nd-13th return value: value of i:th index.
2232 \begin_layout Subsubsection
2233 input.seta(number controller, number bitmask, number args...)
2236 \begin_layout Standard
2237 Set state for entiere controller.
2238 args is up to 12 values for indices (overriding values in bitmask if specified).
2241 \begin_layout Subsubsection
2242 input.controllertype(number controller)
2245 \begin_layout Standard
2246 Get the type of controller as string.
2250 \begin_layout Itemize
2254 \begin_layout Itemize
2258 \begin_layout Itemize
2262 \begin_layout Itemize
2266 \begin_layout Subsubsection
2267 input.reset([number cycles])
2270 \begin_layout Standard
2272 If cycles is greater than zero, do delayed reset.
2273 0 (or no value) causes immediate reset.
2276 \begin_layout Itemize
2277 Only available with subframe flag false.
2280 \begin_layout Subsubsection
2284 \begin_layout Standard
2285 Returns table of tables of all available keys and axes.
2286 The first table is indexed by key name (platform-dependent!), and the inner
2287 table has the following fields:
2290 \begin_layout Itemize
2291 value: Last reported value for control
2295 \begin_layout Itemize
2296 For keys: 1 for pressed, 0 for released.
2299 \begin_layout Itemize
2300 For axes: -32767...32767.
2303 \begin_layout Itemize
2304 For presure-sensitive buttons: 0...32767.
2307 \begin_layout Itemize
2308 For hats: Bitmask: 1=>Up, 2=>Right, 4=>Down, 8=>Left.
2311 \begin_layout Itemize
2312 For mouse: Coordinates relative to game area.
2316 \begin_layout Itemize
2317 ktype: Type of key (disabled, key, mouse, axis, axis-inverse, hat, pressure-m0,
2318 pressure-mp, pressure-0m, pressure-0p, pressure-pm, pressure-p0).
2321 \begin_layout Subsubsection
2322 input.keyhook(string key, boolean state)
2325 \begin_layout Standard
2326 Requests that keyhook events to be sent for key (state=true) or not sent
2330 \begin_layout Subsubsection
2331 input.joyget(number controller)
2334 \begin_layout Standard
2335 Returns table for current controls for specified controller.
2336 The names of fields vary by controller type.
2339 \begin_layout Itemize
2340 The buttons have the same name as those are referred to in other contexts
2344 \begin_layout Itemize
2346 \begin_inset Quotes eld
2350 \begin_inset Quotes erd
2354 \begin_inset Quotes eld
2358 \begin_inset Quotes erd
2364 \begin_layout Subsubsection
2365 input.joyset(number controller, table controls)
2368 \begin_layout Standard
2369 Set the the state of specified controller to values specified in specified
2373 \begin_layout Subsubsection
2374 input.lcid_to_pcid(number controller)
2377 \begin_layout Standard
2378 Return the physical index, physical port and controller number in port for
2379 specified (1-based) logical controller.
2382 \begin_layout Subsection
2386 \begin_layout Standard
2387 Various keybinding-related functions
2390 \begin_layout Subsubsection
2391 keyboard.bind(string mod, string mask, string key, string cmd)
2394 \begin_layout Standard
2395 Bind specified key with specified modifers to specified command.
2398 \begin_layout Subsubsection
2399 keyboard.unbind(string mod, string mask, string key)
2402 \begin_layout Standard
2403 Unbind specified key with specified modifers.
2406 \begin_layout Itemize
2407 nil does not change value
2410 \begin_layout Itemize
2411 true/false (buttons) and integers (axes) force value.
2414 \begin_layout Itemize
2415 string (button) inverts the input.
2418 \begin_layout Subsubsection
2419 keyboard.alias(string alias, string expansion)
2422 \begin_layout Standard
2423 Set expansion of given command.
2426 \begin_layout Subsection
2430 \begin_layout Standard
2434 \begin_layout Subsubsection
2435 subtitle.byindex(number i)
2438 \begin_layout Standard
2439 Read the frame and length of ith subtitle.
2440 Returns nothing if not present.
2443 \begin_layout Subsubsection
2444 subtitle.set(number f, number l, string txt)
2447 \begin_layout Standard
2448 Set the text of subtitle.
2451 \begin_layout Subsubsection
2452 subtitle.get(number f, number l)
2455 \begin_layout Standard
2456 Get the text of subtitle.
2459 \begin_layout Subsubsection
2460 subtitle.delete(number f, number l)
2463 \begin_layout Standard
2464 Delete specified subtitle.
2467 \begin_layout Subsection
2471 \begin_layout Standard
2472 Host memory handling (extra memory saved to savestates).
2473 Host memory starts empty.
2476 \begin_layout Subsubsection
2477 hostmemory.read(number address)
2480 \begin_layout Standard
2481 Reads hostmemory slot address.
2482 Slot numbers out of range return false instead of numeric.
2485 \begin_layout Subsubsection
2486 hostmemory.write(number address, number value)
2489 \begin_layout Standard
2490 Writes hostmemory slot with 0-255.
2491 Slot numbers out of range cause extension of host memory slot space.
2494 \begin_layout Subsubsection
2495 hostmemory.readbyte(number address)
2498 \begin_layout Standard
2499 Read unsigned byte (1 element) from given address.
2500 Slots out of range return false.
2503 \begin_layout Subsubsection
2504 hostmemory.writebyte(number address, number value)
2507 \begin_layout Standard
2508 Write unsigned byte (1 element) to given slot.
2509 Slot numbers out of range cause extension.
2512 \begin_layout Subsubsection
2513 hostmemory.readsbyte(number address)
2516 \begin_layout Standard
2517 Read signed byte (1 element) from given address.
2518 Slots out of range return false.
2521 \begin_layout Subsubsection
2522 hostmemory.writesbyte(number address, number value)
2525 \begin_layout Standard
2526 Write signed byte (1 element) to given slot.
2527 Slot numbers out of range cause extension.
2530 \begin_layout Subsubsection
2531 hostmemory.readword(number address)
2534 \begin_layout Standard
2535 Read unsigned word (2 elements) from given address.
2536 Slots out of range return false.
2539 \begin_layout Subsubsection
2540 hostmemory.writeword(number address, number value)
2543 \begin_layout Standard
2544 Write unsigned word (2 elements) to given slot.
2545 Slot numbers out of range cause extension.
2548 \begin_layout Subsubsection
2549 hostmemory.readsword(number address)
2552 \begin_layout Standard
2553 Read signed word (2 elements) from given address.
2554 Slots out of range return false.
2557 \begin_layout Subsubsection
2558 hostmemory.writesword(number address, number value)
2561 \begin_layout Standard
2562 Write signed word (2 elements) to given slot.
2563 Slot numbers out of range cause extension.
2566 \begin_layout Subsubsection
2567 hostmemory.readdword(number address)
2570 \begin_layout Standard
2571 Read unsigned doubleword (4 elements) from given address.
2572 Slots out of range return false.
2575 \begin_layout Subsubsection
2576 hostmemory.writedword(number address, number value)
2579 \begin_layout Standard
2580 Write unsigned doubleword (4 elements) to given slot.
2581 Slot numbers out of range cause extension.
2584 \begin_layout Subsubsection
2585 hostmemory.readsdword(number address)
2588 \begin_layout Standard
2589 Read signed doubleword (4 elements) from given address.
2590 Slots out of range return false.
2593 \begin_layout Subsubsection
2594 hostmemory.writesdword(number address, number value)
2597 \begin_layout Standard
2598 Write signed doubleword (4 elements) to given slot.
2599 Slot numbers out of range cause extension.
2602 \begin_layout Subsubsection
2603 hostmemory.readqword(number address)
2606 \begin_layout Standard
2607 Read unsigned quadword (8 elements) from given address.
2608 Slots out of range return false.
2611 \begin_layout Subsubsection
2612 hostmemory.writeqword(number address, number value)
2615 \begin_layout Standard
2616 Write unsigned quadword (4 elements) to given slot.
2617 Slot numbers out of range cause extension.
2620 \begin_layout Subsubsection
2621 hostmemory.readsqword(number address)
2624 \begin_layout Standard
2625 Read signed quadword (8 elements) from given address.
2626 Slots out of range return false.
2629 \begin_layout Subsubsection
2630 hostmemory.writesqword(number address, number value)
2633 \begin_layout Standard
2634 Write signed quadword (8 elements) to given slot.
2635 Slot numbers out of range cause extension.
2638 \begin_layout Subsection
2642 \begin_layout Standard
2646 \begin_layout Subsubsection
2647 movie.currentframe()
2650 \begin_layout Standard
2651 Return number of current frame.
2654 \begin_layout Subsubsection
2658 \begin_layout Standard
2659 Return number of frames in movie.
2662 \begin_layout Subsubsection
2666 \begin_layout Standard
2667 Return true if in readonly mode, false if in readwrite.
2670 \begin_layout Subsubsection
2674 \begin_layout Standard
2675 Returns the current value of rerecord count.
2678 \begin_layout Subsubsection
2679 movie.set_readwrite()
2682 \begin_layout Standard
2683 Set readwrite mode (does not cause on_readwrite callback).
2686 \begin_layout Subsubsection
2687 movie.frame_subframes(number frame)
2690 \begin_layout Standard
2691 Count number of subframes in specified frame (frame numbers are 1-based)
2695 \begin_layout Subsubsection
2696 movie.read_subframes(number frame, number subframe)
2699 \begin_layout Standard
2700 Read specifed subframe in specified frame and return data as array (100
2701 elements, numbered 0-99 currently).
2704 \begin_layout Subsubsection
2708 \begin_layout Standard
2709 Returns the current value of the RTC as a pair (second, subsecond).
2712 \begin_layout Subsubsection
2713 movie.unsafe_rewind([UNSAFEREWIND state])
2716 \begin_layout Standard
2717 Start setting point for unsafe rewind or jump to point of unsafe rewind.
2720 \begin_layout Itemize
2721 If called without argument, causes emulator to start process of setting
2722 unsafe rewind point.
2723 When this has finished, callback on_set_rewind occurs, passing the rewind
2724 state to lua script.
2727 \begin_layout Itemize
2728 If called with argument, causes emulator rewind to passed rewind point as
2730 Readwrite mode is implicitly activated.
2733 \begin_layout Standard
2734 The following warnings apply to unsafe rewinding:
2737 \begin_layout Itemize
2738 There are no safety checks against misuse (that's what
2739 \begin_inset Quotes eld
2743 \begin_inset Quotes erd
2749 \begin_layout Itemize
2750 Only call rewind from timeline rewind point was set from.
2753 \begin_layout Itemize
2754 Only call rewind from after the rewind point was set.
2757 \begin_layout Subsection
2761 \begin_layout Standard
2762 Routines for settings manipulation
2765 \begin_layout Subsubsection
2766 settings.get(string name)
2769 \begin_layout Standard
2770 Get value of setting.
2771 If setting is blank, returns false.
2772 If setting value can't be obtained, returns (nil, error message).
2775 \begin_layout Subsubsection
2776 settings.set(string name, string value)
2779 \begin_layout Standard
2780 Set value of setting.
2781 If setting can't be set, returns (nil, error message).
2784 \begin_layout Subsubsection
2785 settings.is_set(string name)
2788 \begin_layout Standard
2789 Returns if setting is set.
2790 If setting does not exist, returns (nil, error message).
2793 \begin_layout Subsubsection
2794 settings.blank(string name)
2797 \begin_layout Standard
2798 Blanks a setting and returns true.
2799 If setting can't be blanked, returns (nil, error message).
2802 \begin_layout Subsection
2806 \begin_layout Standard
2807 Contains various functions for managing memory
2810 \begin_layout Subsubsection
2814 \begin_layout Standard
2815 Returns the number of VMAs
2818 \begin_layout Subsubsection
2819 memory.read_vma(number index)
2822 \begin_layout Standard
2823 Reads the specified VMA (indices start from zero).
2824 Trying to read invalid VMA gives nil.
2825 The read VMA is table with the following fields:
2828 \begin_layout Itemize
2829 region_name (string): The readable name of the VMA
2832 \begin_layout Itemize
2833 baseaddr (number): Base address of the VMA
2836 \begin_layout Itemize
2837 lastaddr (number): Last address in the VMA.
2840 \begin_layout Itemize
2841 size (number): The size of VMA in bytes.
2844 \begin_layout Itemize
2845 readonly (boolean): True of the VMA corresponds to ROM.
2848 \begin_layout Itemize
2849 iospace (boolean): True if the VMA is I/O space.
2852 \begin_layout Itemize
2853 native_endian (boolean): True if the VMA has native endian as opposed to
2857 \begin_layout Subsubsection
2858 memory.find_vma(number address)
2861 \begin_layout Standard
2862 Finds the VMA containing specified address.
2863 Returns table in the same format as read_vma or nil if not found.
2866 \begin_layout Subsubsection
2867 memory.readbyte([string vma, ]number address)
2870 \begin_layout Standard
2871 Reads the specified address as unsigned byte and returns the result.
2874 \begin_layout Subsubsection
2875 memory.readsbyte([string vma, ]number address)
2878 \begin_layout Standard
2879 Reads the specified address as signed byte and returns the result.
2882 \begin_layout Subsubsection
2883 memory.writebyte([string vma, ]number address, number value)
2886 \begin_layout Standard
2887 Writes the specified value (negative values undergo 2's complement) to specified
2888 address (as a byte).
2891 \begin_layout Subsubsection
2892 memory.readword([string vma, ]number address)
2895 \begin_layout Standard
2896 Reads the specified address as unsigned word and returns the result.
2899 \begin_layout Subsubsection
2900 memory.readsword([string vma, ]number address)
2903 \begin_layout Standard
2904 Reads the specified address as signed word and returns the result.
2907 \begin_layout Subsubsection
2908 memory.writeword([string vma, ]number address, number value)
2911 \begin_layout Standard
2912 Writes the specified value (negative values undergo 2's complement) to specified
2913 address (as a word).
2916 \begin_layout Subsubsection
2917 memory.readdword([string vma, ]number address)
2920 \begin_layout Standard
2921 Reads the specified address as unsigned doubleword and returns the result.
2924 \begin_layout Subsubsection
2925 memory.readsdword([string vma, ]number address)
2928 \begin_layout Standard
2929 Reads the specified address as signed doubleword and returns the result.
2932 \begin_layout Subsubsection
2933 memory.writedword([string vma, ]number address, number value)
2936 \begin_layout Standard
2937 Writes the specified value (negative values undergo 2's complement) to specified
2938 address (as a doubleword).
2941 \begin_layout Subsubsection
2942 memory.readqword([string vma, ]number address)
2945 \begin_layout Standard
2946 Reads the specified address as unsigned quadword and returns the result.
2949 \begin_layout Subsubsection
2950 memory.readsqword([string vma, ]number address)
2953 \begin_layout Standard
2954 Reads the specified address as signed quadword and returns the result.
2957 \begin_layout Subsubsection
2958 memory.writeqword([string vma, ]number address, number value)
2961 \begin_layout Standard
2962 Writes the specified value (negative values undergo 2's complement) to specified
2963 address (as a quadword).
2966 \begin_layout Subsubsection
2967 memory.hash_region([string vma, ]number base, number size)
2970 \begin_layout Standard
2971 Hash specified number of bytes starting from specified address and return
2975 \begin_layout Subsubsection
2979 \begin_layout Standard
2980 Hash the current system state.
2981 Mainly useful for debugging savestates.
2984 \begin_layout Subsubsection
2985 memory.readregion([string vma, ]number base, number size)
2988 \begin_layout Standard
2989 Read a region of memory.
2992 \begin_layout Itemize
2993 Warning: If the region crosses VMA boundary, the results are undefined.
2996 \begin_layout Subsubsection
2997 memory.map<type>([[string vma, ]number base, number size])
3000 \begin_layout Standard
3001 Returns a table mapping specified memory aperture for read/write.
3002 If parameters are omitted, entiere map space is the aperture.
3005 \begin_layout Itemize
3006 Type may be one of: byte, sbyte, word, sword, dword, sdword, qword or sqword.
3009 \begin_layout Subsubsection
3010 memory.writeregion([string vma, ]number base, number size, table data)
3013 \begin_layout Standard
3014 Write a region of memory.
3017 \begin_layout Itemize
3018 Warning: If the region crosses VMA boundary, the results are undefined.
3021 \begin_layout Subsubsection
3022 memory.map_structure()
3025 \begin_layout Standard
3026 Returns a new mapping structure (MMAP_STRUCT)
3029 \begin_layout Subsubsection
3030 MMAP_STRUCT(string key, [string vma, ]number address, string type)
3033 \begin_layout Standard
3034 Bind key in mmap structure to specified address with specified type.
3037 \begin_layout Itemize
3038 Type may be one of: byte, sbyte, word, sword, dword, sdword, qword or sqword.
3041 \begin_layout Subsubsection
3042 memory.read_expr(string expr)
3045 \begin_layout Standard
3046 Evaluate specified watch expression and return result
3049 \begin_layout Subsubsection
3050 memory.action(string action, [<params>])
3053 \begin_layout Standard
3055 The different models expect parameters as:
3058 \begin_layout Itemize
3062 \begin_layout Itemize
3066 \begin_layout Itemize
3070 \begin_layout Itemize
3074 \begin_layout Itemize
3078 \begin_layout Subsection
3082 \begin_layout Standard
3083 Contains newer memory functions.
3086 \begin_layout Subsubsection
3090 \begin_layout Standard
3091 Returns array of all valid VMA names.
3094 \begin_layout Subsubsection
3095 memory2.<vma>:info()
3098 \begin_layout Standard
3099 Return table describing given VMA.
3100 Includes fields address, size, last, readonly, special and endian.
3103 \begin_layout Subsubsection
3104 memory2.<vma>:<op>(number offset)
3107 \begin_layout Standard
3108 Read from given VMA at given offset (must be in-range).
3112 \begin_layout Itemize
3113 [i][s]<type>, where <type> is one of 'byte', 'word', 'dword', 'qword'.
3114 'i' signifies that the value is treated as opposite-to-normal endianess,
3115 's' signifies that value is treated as signed.
3118 \begin_layout Subsubsection
3119 memory2.<vma>:<op>(number offset, number value)
3122 \begin_layout Standard
3123 Write value to given VMA at given offset (must be in-range).
3124 See above for form of op.
3127 \begin_layout Subsection
3131 \begin_layout Standard
3132 Contains functions for manipulating subtitles.
3135 \begin_layout Subsubsection
3136 subtitle.byindex(number index)
3139 \begin_layout Standard
3140 Get (basetime, length) pair of specified subtitle index or nothing if index
3144 \begin_layout Subsubsection
3145 subtitle.get(number basetime, number length)
3148 \begin_layout Standard
3149 Read the specified subtitle.
3151 \begin_inset Quotes eld
3155 \begin_inset Quotes erd
3158 if the subtitle does not exist.
3161 \begin_layout Subsubsection
3162 subtitle.set(number basetime, number length, string content)
3165 \begin_layout Standard
3166 Set the specified subtitle.
3169 \begin_layout Subsubsection
3170 subtitle.deltete(number basetime, number length)
3173 \begin_layout Standard
3174 Delete the specified subtitle.
3177 \begin_layout Subsection
3181 \begin_layout Standard
3182 Contains copy of global variables from time of Lua initialization.
3186 \begin_layout Subsection
3190 \begin_layout Standard
3191 Various callbacks to Lua that can occur.
3194 \begin_layout Subsubsection
3195 Callback: on_paint(bool not_synth)
3198 \begin_layout Standard
3199 Called when screen is being painted.
3200 Any gui.* calls requiring graphic context draw on the screen.
3203 \begin_layout Standard
3204 not_synth is true if this hook is being called in response to received frame,
3208 \begin_layout Subsubsection
3209 Callback: on_video()
3212 \begin_layout Standard
3213 Called when video dump frame is being painted.
3214 Any gui.* calls requiring graphic context draw on the video.
3217 \begin_layout Subsubsection
3218 Callback: on_frame_emulated()
3221 \begin_layout Standard
3222 Called when emulating frame has completed and on_paint()/on_video() calls
3223 are about to be issued.
3226 \begin_layout Subsubsection
3227 Callback: on_frame()
3230 \begin_layout Standard
3231 Called on each starting whole frame.
3234 \begin_layout Subsubsection
3235 Callback: on_startup()
3238 \begin_layout Standard
3239 Called when the emulator is starting (lsnes.rc and --run files has been run).
3242 \begin_layout Subsubsection
3243 Callback: on_rewind()
3246 \begin_layout Standard
3247 Called when rewind movie to beginning has completed.
3250 \begin_layout Subsubsection
3251 Callback: on_pre_load(string name)
3254 \begin_layout Standard
3255 Called just before savestate/movie load occurs (note: loads are always delayed,
3256 so this occurs even when load was initiated by lua).
3259 \begin_layout Subsubsection
3260 Callback: on_err_load(string name)
3263 \begin_layout Standard
3264 Called if loadstate goes wrong.
3267 \begin_layout Subsubsection
3268 Callback: on_post_load(string name, boolean was_savestate)
3271 \begin_layout Standard
3272 Called on successful loadstate.
3273 was_savestate gives if this was a savestate or a movie.
3276 \begin_layout Subsubsection
3277 Callback: on_pre_save(string name, boolean is_savestate)
3280 \begin_layout Standard
3281 Called just before savestate save occurs (note: movie saves are synchronous
3282 and won't trigger these callbacks if called from Lua).
3285 \begin_layout Subsubsection
3286 Callback: on_err_save(string name)
3289 \begin_layout Standard
3290 Called if savestate goes wrong.
3293 \begin_layout Subsubsection
3294 Callback: on_post_save(string name, boolean is_savestate)
3297 \begin_layout Standard
3298 Called on successful savaestate.
3299 is_savestate gives if this was a savestate or a movie.
3302 \begin_layout Subsubsection
3306 \begin_layout Standard
3307 Called when emulator is shutting down.
3310 \begin_layout Subsubsection
3311 Callback: on_input(boolean subframe)
3314 \begin_layout Standard
3315 Called when emulator is just sending input to bsnes core.
3316 Warning: This is called even in readonly mode, but the results are ignored.
3319 \begin_layout Subsubsection
3320 Callback: on_reset()
3323 \begin_layout Standard
3324 Called when SNES is reset.
3327 \begin_layout Subsubsection
3328 Callback: on_readwrite()
3331 \begin_layout Standard
3332 Called when moving into readwrite mode as result of
3333 \begin_inset Quotes eld
3337 \begin_inset Quotes erd
3340 command (note: moving to rwmode by Lua won't trigger this, as per recursive
3344 \begin_layout Subsubsection
3345 Callback: on_snoop(number port, number controller, number index, number
3349 \begin_layout Standard
3350 Called each time bsnes asks for input.
3351 The value is the final value to be sent to bsnes core (readonly mode, autohold
3352 and autofire have been taken into account).
3353 Might be useful when translating movies to format suitable for console
3355 Note: There is no way to modify the value to be sent.
3358 \begin_layout Itemize
3359 Not called if callback on_snoop2 is defined.
3362 \begin_layout Subsubsection
3363 Callback: on_snoop2(number port, number controller, number index, number
3367 \begin_layout Standard
3368 Like on_snoop, but reserves port 0 for system, having first user port be
3372 \begin_layout Subsubsection
3373 Callback: on_keyhook(string keyname, table state)
3376 \begin_layout Standard
3377 Sent when key that has keyhook events requested changes state.
3378 Keyname is name of the key (group) and state is the state (same kind as
3379 table values in input.raw).
3382 \begin_layout Subsubsection
3386 \begin_layout Standard
3387 Called when requested by set_idle_timeout(), the timeout has expired and
3388 emulator is waiting.
3391 \begin_layout Subsubsection
3392 Callback: on_timer()
3395 \begin_layout Standard
3396 Called when requested by set_idle_timeout() and the timeout has expired
3397 (regardless if emulator is waiting).
3400 \begin_layout Subsubsection
3401 Callback: on_set_rewind(UNSAFEREWIND r)
3404 \begin_layout Standard
3405 Called when unsafe rewind object has been constructed.
3408 \begin_layout Subsubsection
3409 Callback: on_pre_rewind()
3412 \begin_layout Standard
3413 Called just before unsafe rewind is about to occur.
3416 \begin_layout Subsubsection
3417 Callback: on_post_rewind()
3420 \begin_layout Standard
3421 Called just after unsafe rewind has occured.
3424 \begin_layout Subsubsection
3425 Callback: on_button(number port, number controller, number index, string
3429 \begin_layout Standard
3430 Called on controller button press, with following parameters:
3433 \begin_layout Itemize
3434 port: Port number (0 is system)
3437 \begin_layout Itemize
3438 controller: Controller within port
3441 \begin_layout Itemize
3442 index: Index of button.
3445 \begin_layout Itemize
3446 type: Type of event, one of:
3450 \begin_layout Itemize
3451 \begin_inset Quotes eld
3455 \begin_inset Quotes erd
3458 : Button was pressed.
3461 \begin_layout Itemize
3462 \begin_inset Quotes eld
3466 \begin_inset Quotes erd
3469 : Button was released.
3472 \begin_layout Itemize
3473 \begin_inset Quotes eld
3477 \begin_inset Quotes erd
3483 \begin_layout Itemize
3484 \begin_inset Quotes eld
3488 \begin_inset Quotes erd
3491 : Released from hold.
3494 \begin_layout Itemize
3495 \begin_inset Quotes eld
3499 \begin_inset Quotes erd
3502 : Typing input on button.
3505 \begin_layout Itemize
3506 \begin_inset Quotes eld
3510 \begin_inset Quotes erd
3513 : Typing input undone.
3516 \begin_layout Itemize
3517 \begin_inset Quotes eld
3520 autofire <duty> <cycle>
3521 \begin_inset Quotes erd
3524 : Autofire with specifie duty and cycle.
3527 \begin_layout Itemize
3528 \begin_inset Quotes eld
3532 \begin_inset Quotes erd
3538 \begin_layout Itemize
3539 \begin_inset Quotes eld
3543 \begin_inset Quotes erd
3546 : Analog action on axis.
3550 \begin_layout Section
3554 \begin_layout Itemize
3555 The editor edits in-memory movie.
3558 \begin_layout Itemize
3559 Because past can't be edited and readwrite mode doesn't allow future, editing
3567 \begin_layout Itemize
3568 Keyboard triggers the normal hotkeys and bindings.
3571 \begin_layout Subsection
3575 \begin_layout Itemize
3576 Clicking on cell in future (indicated by lack of redish background) toggles
3577 it (if it is a button) or prompts for a value (if it is an axis)
3580 \begin_layout Itemize
3581 Dragging vertically toggles sequence of buttons or changes a sequence of
3585 \begin_layout Subsection
3586 Right button actions
3589 \begin_layout Standard
3590 The right mouse button pops up a context-sensitive menu:
3593 \begin_layout Itemize
3594 Toggle <something>: Toggle this button
3597 \begin_layout Itemize
3598 Change <something>: Change this axis value
3601 \begin_layout Itemize
3602 Insert frame after: Insert a frame after this frame
3605 \begin_layout Itemize
3606 Append frame: Append a frame to movie
3609 \begin_layout Itemize
3610 Append frames: Append specified number of frames to movie
3613 \begin_layout Itemize
3614 Delete frame: Delete this frame
3617 \begin_layout Itemize
3618 Delete subframe: Delete this subframe
3621 \begin_layout Itemize
3622 Truncate movie: Delete this subframe and everything after it.
3625 \begin_layout Itemize
3626 Scroll to frame: Prompt for a frame and scroll the display to that frame.
3629 \begin_layout Itemize
3630 Scroll to current frame: Scroll the display to current position
3633 \begin_layout Itemize
3634 Run to frame: Prompts for frame and runs the emulation to that frame.
3637 \begin_layout Itemize
3638 Change number of lines visible: Change the height of the movie display (1
3642 \begin_layout Itemize
3643 Lock scroll to playback: While playing back or rewinding movies, the display
3644 will follow if enabled.
3647 \begin_layout Section
3648 Memory watch expression syntax
3651 \begin_layout Standard
3652 Memory watch expressions are in RPN (Reverse Polish Notation).
3653 At the end of expression, the top entry on stack is taken as the final
3657 \begin_layout Standard
3661 \begin_layout Itemize
3662 Evaluation order is strictly left to right.
3665 \begin_layout Itemize
3666 a is the entry on top of stack
3669 \begin_layout Itemize
3670 b is the entry immediately below top of stack
3673 \begin_layout Itemize
3674 ; separates values to be pushed (no intermediate pop).
3677 \begin_layout Itemize
3678 After end of element, all used stack slots are popped and all results are
3682 \begin_layout Itemize
3683 When pushing multiple values, the pushes occur in order shown.
3686 \begin_layout Standard
3687 The following operators are available:
3690 \begin_layout Itemize
3694 \begin_layout Itemize
3698 \begin_layout Itemize
3702 \begin_layout Itemize
3706 \begin_layout Itemize
3710 \begin_layout Itemize
3714 \begin_layout Itemize
3715 b : read_signed_byte(a)
3718 \begin_layout Itemize
3722 \begin_layout Itemize
3723 d : read_signed_dword(a)
3726 \begin_layout Itemize
3730 \begin_layout Itemize
3732 \begin_inset Formula $\pi$
3738 \begin_layout Itemize
3739 q : read_signed_qword(a)
3742 \begin_layout Itemize
3746 \begin_layout Itemize
3750 \begin_layout Itemize
3754 \begin_layout Itemize
3758 \begin_layout Itemize
3759 w : read_signed_word(a)
3762 \begin_layout Itemize
3766 \begin_layout Itemize
3767 B : read_unsigned_byte(a)
3770 \begin_layout Itemize
3771 C<number>z : Push number <number> to stack.
3774 \begin_layout Itemize
3775 D : read_unsigned_dword(a)
3778 \begin_layout Itemize
3779 C0x<number>z : Push number <number> (hexadecimal) to stack.
3782 \begin_layout Itemize
3783 H<digit> : Set hexadecimal mode with specified number of digits (use A-G
3787 \begin_layout Itemize
3788 Q : read_unsigned_qword(a)
3791 \begin_layout Itemize
3792 R<digit> : round a to <digit> digits.
3795 \begin_layout Itemize
3796 W : read_unsigned_word(a)
3799 \begin_layout Subsection
3803 \begin_layout Standard
3804 C0x007e0878zWC0x007e002czW-
3807 \begin_layout Enumerate
3808 Push value 0x7e0878 on top of stack (C0x007e0878z).
3811 \begin_layout Enumerate
3812 Pop the value on top of stack (0x7e0878), read word value at that address
3813 and push the result,call it x1 (W).
3816 \begin_layout Enumerate
3817 Push value 0x7e002c on top of stack (C0x007e002cz).
3820 \begin_layout Enumerate
3821 Pop the value on top of stack (0x7e002c), read word value at that address
3822 and push the result,call it x2 (W).
3825 \begin_layout Enumerate
3826 Pop the two top numbers on stack, x1 and x2, substract x1 from x2 and push
3830 \begin_layout Enumerate
3831 Since the expression ends, the final memory watch result is the top one
3832 on stack, which is x2 - x1.
3835 \begin_layout Section
3836 Modifier and key names:
3839 \begin_layout Subsection
3843 \begin_layout Subsubsection
3847 \begin_layout Standard
3848 Following modifier names are known:
3851 \begin_layout Itemize
3855 \begin_layout Itemize
3859 \begin_layout Itemize
3863 \begin_layout Itemize
3867 \begin_layout Itemize
3871 \begin_layout Subsubsection
3875 \begin_layout Standard
3876 Following key names are known:
3879 \begin_layout Itemize
3880 back, tab, return, escape, space, exclaim, quotedbl, hash, dollar, percent,
3881 ampersand, quote, leftparen, rightparen, asterisk, plus, comma, minus,
3882 period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
3883 greater, question, at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3884 q, r, s, t, u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
3885 underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3886 q, r, s, t, u, v, w, x, y, z, leftcurly, pipe, rightcurly, tilde, delete,
3887 start, lbutton, rbutton, cancel, mbutton, clear, shift, alt, control, menu,
3888 pause, capital, end, home, lefT, up, right, down, select, print, execute,
3889 snapshot, insert, help, numpad0, numpad1, numpad2, numpad3, numpad4, numpad5,
3890 numpad6, numpad7, numpad8, numpad9, multiply, add, separator, subtract,
3891 decimal, divide, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13,
3892 f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, numlock, scroll,
3893 pageup, pagedown, numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
3894 numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up, numpad_right,
3895 numpad_down, numpad_pageup, numpad_pagedown, numpad_end, numpad_begin,
3896 numpad_insert, numpad_delete, numpad_equal, numpad_multiply, numpad_add,
3897 numpad_separator, numpad_subtract, numpad_decimal, numpad_divide, windows_left,
3898 windows_right, windows_menu, command, special1, special2, special3, special4,
3899 special5, special6, special7, special8, special9, special10, special11,
3900 special12, special13, special14, special15, special16, special17, special18,
3901 special19, special20
3904 \begin_layout Section
3908 \begin_layout Standard
3909 Movie file is .zip archive in itself, normal ZIP archive tools work on it
3910 (note: If you recompress it, do not use compression methods other than
3911 store and deflate and especially do not use encryption of any kind).
3914 \begin_layout Subsection
3915 Detecting clean start/SRAM/Savestate
3918 \begin_layout Itemize
3920 \begin_inset Quotes eld
3924 \begin_inset Quotes erd
3927 it is savestate, otherwise:
3930 \begin_layout Itemize
3931 If file has members with names starting
3932 \begin_inset Quotes eld
3936 \begin_inset Quotes erd
3939 it is movie starting from SRAM, otherwise:
3942 \begin_layout Itemize
3943 It is movie starting from clear state.
3946 \begin_layout Subsection
3950 \begin_layout Standard
3951 Type of game ROM and region (as one line).
3955 \begin_layout Standard
3956 \begin_inset Tabular
3957 <lyxtabular version="3" rows="8" columns="3">
3958 <features tabularvalignment="middle">
3959 <column alignment="center" valignment="top" width="0">
3960 <column alignment="center" valignment="top" width="0">
3961 <column alignment="center" valignment="top" width="0">
3963 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3966 \begin_layout Plain Layout
3972 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3975 \begin_layout Plain Layout
3981 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3984 \begin_layout Plain Layout
3992 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3995 \begin_layout Plain Layout
4001 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4004 \begin_layout Plain Layout
4010 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4013 \begin_layout Plain Layout
4021 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4024 \begin_layout Plain Layout
4030 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4033 \begin_layout Plain Layout
4039 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4042 \begin_layout Plain Layout
4050 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4053 \begin_layout Plain Layout
4059 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4062 \begin_layout Plain Layout
4068 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4071 \begin_layout Plain Layout
4079 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4082 \begin_layout Plain Layout
4088 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4091 \begin_layout Plain Layout
4097 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4100 \begin_layout Plain Layout
4108 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4111 \begin_layout Plain Layout
4117 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4120 \begin_layout Plain Layout
4126 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4129 \begin_layout Plain Layout
4137 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4140 \begin_layout Plain Layout
4146 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4149 \begin_layout Plain Layout
4155 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4158 \begin_layout Plain Layout
4166 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4169 \begin_layout Plain Layout
4175 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4178 \begin_layout Plain Layout
4184 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4187 \begin_layout Plain Layout
4201 \begin_layout Standard
4205 \begin_layout Standard
4206 \begin_inset Tabular
4207 <lyxtabular version="3" rows="3" columns="2">
4208 <features tabularvalignment="middle">
4209 <column alignment="center" valignment="top" width="0">
4210 <column alignment="center" valignment="top" width="0">
4212 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4215 \begin_layout Plain Layout
4221 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4224 \begin_layout Plain Layout
4232 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4235 \begin_layout Plain Layout
4241 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4244 \begin_layout Plain Layout
4252 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4255 \begin_layout Plain Layout
4261 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4264 \begin_layout Plain Layout
4278 \begin_layout Subsection
4282 \begin_layout Standard
4283 Contains type of port #1 (as one line).
4284 Valid values are 'none', 'gamepad', 'multitap' and 'mouse'.
4285 If not present, defaults to 'gamepad'.
4288 \begin_layout Subsection
4292 \begin_layout Standard
4293 Contains type of port #2 (as one line).
4294 Valid values are 'none', 'gamepad', 'multitap', 'mouse', 'superscope',
4295 'justifier' and 'justifiers'.
4296 If not present, defaults to 'none'.
4299 \begin_layout Subsection
4303 \begin_layout Standard
4304 Contains name of the game (as one line).
4307 \begin_layout Subsection
4311 \begin_layout Standard
4312 Contains authors, one per line.
4313 Part before '|' is the full name, part after is the nickname.
4316 \begin_layout Subsection
4320 \begin_layout Standard
4322 \begin_inset Quotes eld
4326 \begin_inset Quotes erd
4330 Used to reject other saves.
4333 \begin_layout Subsection
4334 Member: controlsversion
4337 \begin_layout Standard
4339 \begin_inset Quotes eld
4343 \begin_inset Quotes erd
4347 Used to identify what controls are there.
4350 \begin_layout Subsection
4352 \begin_inset Quotes eld
4356 \begin_inset Quotes erd
4362 \begin_layout Standard
4363 Contains bsnes core version number (as one line).
4366 \begin_layout Subsection
4370 \begin_layout Standard
4371 Contains project ID (as one line).
4372 Used to identify if two movies are part of the same project.
4375 \begin_layout Subsection
4376 Member: {rom,slota,slotb}{,xml}.sha256
4379 \begin_layout Standard
4380 Contains SHA-256 of said ROM or ROM mapping file (as one line).
4381 Absent if corresponding file is absent.
4384 \begin_layout Subsection
4385 Member: moviesram.<name>
4388 \begin_layout Standard
4389 Raw binary startup SRAM of kind <name>.
4390 Only present in savestates and movies starting from SRAM.
4393 \begin_layout Subsection
4397 \begin_layout Standard
4398 Contains frame number (as one line) of frame movie was saved on.
4399 Only present in savestates.
4402 \begin_layout Subsection
4406 \begin_layout Standard
4407 Current value of lag counter (as one line).
4408 Only present in savestates.
4411 \begin_layout Subsection
4412 Member: pollcounters
4415 \begin_layout Standard
4416 Contains poll counters (currently 100 of them), one per line.
4417 Each line is raw poll count if DRDY is set for it.
4418 Otherwise it is negative poll count minus one.
4419 Only present in savestates.
4422 \begin_layout Subsection
4426 \begin_layout Standard
4427 Raw binary dump of host memory.
4428 Only present in savestates.
4431 \begin_layout Subsection
4435 \begin_layout Standard
4436 The raw binary savestate itself.
4437 Savestate detection uses this file, only present in savestates.
4440 \begin_layout Subsection
4444 \begin_layout Standard
4445 Screenshot of current frame.
4446 Only present in savestates.
4447 First 2 bytes are big-endian width of image, rest are 24-bit RGB image
4449 Height of image is inferred from the width and size of data.
4452 \begin_layout Subsection
4456 \begin_layout Standard
4457 Raw binary SRAM of kind <name> at time of savestate.
4458 Only present in savestates.
4461 \begin_layout Subsection
4465 \begin_layout Standard
4466 The actual input track, one line per subframe (blank lines are skipped).
4469 \begin_layout Itemize
4470 If the first byte of each line is '.', ' ', <tab> or '|', then the line is
4471 part of same frame as previous, otherwise it starts a new frame.
4474 \begin_layout Itemize
4475 First subframe must start a new frame.
4478 \begin_layout Standard
4479 Length of movie in frames is number of lines in input file that start a
4483 \begin_layout Subsection
4487 \begin_layout Standard
4492 \begin_layout Itemize
4493 Each line is in form <firstframe> <numframes> <text>.
4496 \begin_layout Itemize
4497 Linefeed is encoded as
4499 n, backslash is encoded as
4506 \begin_layout Subsection
4510 \begin_layout Standard
4511 Contains textual base-10 rerecord count (as one line; emulator just writes
4512 this, it doesn't read it) + 1.
4515 \begin_layout Subsection
4519 \begin_layout Standard
4520 This member stores set of load IDs.
4521 There is one load ID per rerecord (plus one corresponding to start of project).
4524 \begin_layout Itemize
4525 This member constists of concatenation of records
4528 \begin_layout Itemize
4529 Each record is 2-36 bytes long and can represent 1-16,843,009 consequtive
4533 \begin_layout Itemize
4534 IDs are interpretted as 256-bit big-endian integers with warparound.
4537 \begin_layout Itemize
4538 Initial predicted ID is all zeroes.
4541 \begin_layout Standard
4542 Format of each record is:
4545 \begin_layout Itemize
4546 1 byte: Opcode byte.
4547 Bits 0-4 are prefix length (prefixlen), bits 5-6 are count length (countlen).
4551 \begin_layout Itemize
4552 32-prefixlen bytes of ID.
4555 \begin_layout Itemize
4556 countlen bytes of big-endian count (count).
4559 \begin_layout Standard
4560 Records are processed as follows:
4563 \begin_layout Itemize
4564 To form the first ID encoded by record, take the first prefixlen bytes predicted
4565 ID and append the read ID value to it.
4566 The result is the first ID encoded.
4569 \begin_layout Itemize
4570 If countlen is 0, record encodes 1 ID.
4573 \begin_layout Itemize
4574 If countlen is 1, record encodes 2+count IDs.
4577 \begin_layout Itemize
4578 If countlen is 2, record encodes 258+count IDs.
4581 \begin_layout Itemize
4582 If countlen is 3, record encodes 65794+count IDs.
4585 \begin_layout Itemize
4586 The new predicted ID is the next ID after last one encoded by the record.
4589 \begin_layout Standard
4590 The number of rerecords + 1 is equal to the sum of number of IDs encoded
4594 \begin_layout Subsection
4595 Member: starttime.second
4598 \begin_layout Standard
4599 Movie starting time, second part.
4600 Epoch is Unix epoch.
4601 Default is 1,000,000,000.
4604 \begin_layout Subsection
4605 Member: starttime.subsecond
4608 \begin_layout Standard
4609 Movie starting time, subsecond part.
4614 \begin_layout Subsection
4615 Member: savetime.second
4618 \begin_layout Standard
4619 Movie saving time, second part.
4620 Default is starttime.second.
4621 Only present in savestates.
4624 \begin_layout Subsection
4625 Member: savetime.subsecond
4628 \begin_layout Standard
4629 Movie saving time, subsecond part.
4630 Default is starttime.subsecond.
4631 Only present in savestates.
4634 \begin_layout Section
4635 lsvs file format (commentary tracks)
4638 \begin_layout Subsection
4642 \begin_layout Itemize
4643 Each cluster is 8kB (8192 bytes) in size.
4646 \begin_layout Itemize
4647 Cluster n starts at offset 8192*n in file.
4650 \begin_layout Itemize
4651 The following clusters are system special:
4655 \begin_layout Itemize
4656 Cluster 0 and all clusters with number multiple of 2048 (cluster tables)
4659 \begin_layout Itemize
4660 Cluster 1 (superblock)
4664 \begin_layout Subsection
4668 \begin_layout Itemize
4669 The cluster table describing cluster n is stored in cluster n & ~0x7FF (zero
4673 \begin_layout Itemize
4674 This cluster table consists of 2048 4-byte big-endian integers.
4677 \begin_layout Itemize
4678 Each entry describes a cluster in 16MB supercluster, in order.
4681 \begin_layout Itemize
4682 The valid values for entries are:
4686 \begin_layout Itemize
4687 0x00000000: Free cluster
4690 \begin_layout Itemize
4691 0x00000001: Last cluster in chain.
4694 \begin_layout Itemize
4695 0xFFFFFFFF: System cluster (cluster tables and superblock)
4698 \begin_layout Itemize
4699 (anything else): Number of next cluster in chain.
4700 Must not be multiple of 2048.
4704 \begin_layout Itemize
4705 Due to limitations of the format, there can be at most 2097052 superclusters,
4706 giving maximum file size of 16TB.
4709 \begin_layout Subsection
4713 \begin_layout Itemize
4714 The stream table chain always starts in cluster 2.
4717 \begin_layout Itemize
4718 Otherwise, it follows normal chaining.
4721 \begin_layout Itemize
4722 The stream table consists of 16-byte entries:
4726 \begin_layout Itemize
4727 The first 8 bytes of entry give big-endian beginning position of stream
4728 in units of 1/48000 s.
4731 \begin_layout Itemize
4732 The next 4 bytes of entry give big-endian beginning cluster for control
4734 0 here marks the entry as not present.
4737 \begin_layout Itemize
4738 The last 4 bytes of entry give big-endian beginning cluster for codec data.
4742 \begin_layout Itemize
4743 Stream table clusters are normal clusters, following normal chaining.
4746 \begin_layout Itemize
4747 The stream begnning position is not guarenteed unique.
4748 There can be multiple streams with the same starting position in the file.
4751 \begin_layout Subsection
4755 \begin_layout Itemize
4756 The stream control data consists of entries 4 bytes each:
4760 \begin_layout Itemize
4761 The first 2 bytes of entry gives big-endian length of packet
4764 \begin_layout Itemize
4765 The next byte of entry gives audio length of packet in units of 1/400 s.
4768 \begin_layout Itemize
4769 The last byte is control byte.
4773 \begin_layout Itemize
4774 0 means this entry is not present and the control data ends.
4777 \begin_layout Itemize
4778 1 is valid control entry.
4783 \begin_layout Itemize
4784 The stream control data can also end by running into end of the readable
4789 \begin_layout Itemize
4790 This happens if there happens to be exact multiple of 2048 packets in stream
4791 and number of packets is nonzero.
4795 \begin_layout Itemize
4796 These clusters follow normal chaining.
4799 \begin_layout Subsection
4803 \begin_layout Itemize
4804 Stream codec data consists of raw Opus data packets packed back to back
4805 with nothing in between.
4808 \begin_layout Itemize
4809 Warning: Due to internal limitations, this data must reside in the first
4810 65536 superclusters (that is, the first 1TB of the file).
4813 \begin_layout Subsection
4817 \begin_layout Itemize
4818 The superblock is stored in cluster 1.
4822 \begin_layout Itemize
4823 The first 11 bytes are
4824 \begin_inset Quotes eld
4828 \begin_inset Quotes erd
4834 \begin_layout Itemize
4835 The rest are unused.
4838 \begin_layout Itemize
4839 This cluster 1 is marked as system special.
4842 \begin_layout Section
4843 Known ROM extensions
4846 \begin_layout Itemize
4847 SNES cartridge ROMs: sfc, smc, swc, fig, ufo, sf2, gd3, gd7, dx2, mgd, mgh.
4850 \begin_layout Itemize
4851 DMG cartridge ROMs: dmg, gb.
4854 \begin_layout Itemize
4855 GBC cartridge ROMs: cgb, gbc.
4858 \begin_layout Section
4862 \begin_layout Itemize
4863 The first line must be:
4864 \begin_inset Quotes eld
4868 \begin_inset Quotes erd
4874 \begin_layout Itemize
4875 There is one needed line:
4876 \begin_inset Quotes eld
4880 \begin_inset Quotes erd
4884 This sets system type to <systype>.
4885 The following system types are valid:
4889 \begin_layout Itemize
4893 \begin_layout Itemize
4894 bsx (BS-X non-slotted)
4897 \begin_layout Itemize
4898 bsxslotted (BS-X slotted)
4901 \begin_layout Itemize
4902 sufamiturbo (Sufami Turbo)
4905 \begin_layout Itemize
4906 sgb (Super Game Boy)
4909 \begin_layout Itemize
4913 \begin_layout Itemize
4914 gbc (Game Boy Color)
4917 \begin_layout Itemize
4918 gbc_gba (Game Boy Color with GBA initial register values)
4922 \begin_layout Itemize
4923 Optionally a region can be specified:
4924 \begin_inset Quotes eld
4928 \begin_inset Quotes erd
4932 The following values are valid:
4936 \begin_layout Itemize
4937 autodetect (Autodetect region: snes and sgb only)
4940 \begin_layout Itemize
4941 ntsc (NTSC: snes, bsx, bsxslotted, sufamiturbo, sgb)
4944 \begin_layout Itemize
4945 pal (PAL: snes, sgb)
4948 \begin_layout Itemize
4949 world (World: dmg, gbc, gbc_gba)
4953 \begin_layout Itemize
4954 ROM images are loaded as:
4955 \begin_inset Quotes eld
4959 \begin_inset Quotes erd
4963 The following types are valid:
4967 \begin_layout Itemize
4968 rom (Cartridge ROM in snes, dmg, gbc, gbc_gba.
4969 BIOS in bsx, bsxslotted, sufamiturbo)
4972 \begin_layout Itemize
4973 bsx (Cartridge ROM in bsx, bsxslotted)
4976 \begin_layout Itemize
4977 slot-a (Cartridge ROM in sufamiturbo)
4980 \begin_layout Itemize
4981 slot-b (Cartridge ROM in sufamiturbo)
4985 \begin_layout Itemize
4986 ROM markup can be loaded as:
4987 \begin_inset Quotes eld
4991 \begin_inset Quotes erd
4995 The types valid are the same as for ROMs.
4998 \begin_layout Itemize
4999 Patches can be loaded as
5000 \begin_inset Quotes eld
5003 patch[<offset>] <type> <file>
5004 \begin_inset Quotes erd
5008 The types are the same as for ROMs.
5012 \begin_layout Itemize
5013 Offset is given in form [+-]<number>.
5014 Usually offset is either +0 or -512.
5017 \begin_layout Itemize
5018 Default offset is +0.
5022 \begin_layout Subsection
5026 \begin_layout LyX-Code
5030 \begin_layout LyX-Code
5034 \begin_layout LyX-Code
5035 rom rom speedygonzales.sfc
5038 \begin_layout LyX-Code
5039 patch-512 rom sonicthehedgehog.ips
5042 \begin_layout Subsection
5046 \begin_layout LyX-Code
5050 \begin_layout LyX-Code
5054 \begin_layout LyX-Code
5055 rom rom supergameboy.sfc
5058 \begin_layout LyX-Code
5059 rom dmg megamanV.dmg
5062 \begin_layout Section
5063 Quick'n'dirty encode guide
5066 \begin_layout Enumerate
5067 Start the emulator and load the ROM and movie file.
5070 \begin_layout Enumerate
5071 Set large AVI option 'set-setting avi-large on'
5074 \begin_layout Enumerate
5075 Enable dumping 'dump-avi tmpdump'
5078 \begin_layout Enumerate
5079 Unpause and let it run until you want to end dumping.
5082 \begin_layout Enumerate
5083 Close the emulator (closing the window is the easiest way).
5087 \begin_layout Enumerate
5088 For each tmpdump*.avi file created, on command prompt, do 'x264 --crf 10
5089 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
5092 \begin_layout Enumerate
5093 Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
5096 \begin_layout Enumerate
5097 Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv + tmpdump_0000001.mkv
5098 + tmpdump_0000002.mkv' (list every tmpdump_<numbers>.mkv, with + in between).
5101 \begin_layout Enumerate
5102 Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'.
5103 Now final.mkv contains quick'n'dirty encode.
5106 \begin_layout Section
5107 Axis configurations for some gamepad types:
5110 \begin_layout Subsection
5114 \begin_layout Standard
5115 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be set to pressure-+.
5118 \begin_layout LyX-Code
5119 set-axis joystick0axis2 pressure-+
5122 \begin_layout LyX-Code
5123 set-axis joystick0axis5 pressure-+
5126 \begin_layout Itemize
5127 This is needed for SDL only.
5128 EVDEV sets those types correctly.
5131 \begin_layout Subsection
5133 \begin_inset Quotes eld
5137 \begin_inset Quotes erd
5143 \begin_layout Standard
5144 Axes 8-19 should be disabled.
5147 \begin_layout LyX-Code
5148 set-axis joystick0axis8 disabled
5151 \begin_layout LyX-Code
5152 set-axis joystick0axis9 disabled
5155 \begin_layout LyX-Code
5156 set-axis joystick0axis10 disabled
5159 \begin_layout LyX-Code
5160 set-axis joystick0axis11 disabled
5163 \begin_layout LyX-Code
5164 set-axis joystick0axis12 disabled
5167 \begin_layout LyX-Code
5168 set-axis joystick0axis13 disabled
5171 \begin_layout LyX-Code
5172 set-axis joystick0axis14 disabled
5175 \begin_layout LyX-Code
5176 set-axis joystick0axis15 disabled
5179 \begin_layout LyX-Code
5180 set-axis joystick0axis16 disabled
5183 \begin_layout LyX-Code
5184 set-axis joystick0axis17 disabled
5187 \begin_layout LyX-Code
5188 set-axis joystick0axis18 disabled
5191 \begin_layout LyX-Code
5192 set-axis joystick0axis19 disabled
5195 \begin_layout Section
5199 \begin_layout Subsection
5200 Problems from BSNES core:
5203 \begin_layout Itemize
5204 The whole pending save stuff.
5207 \begin_layout Itemize
5208 Lack of layer hiding.
5211 \begin_layout Itemize
5212 It is slow (especially accuracy).
5215 \begin_layout Itemize
5216 Firmwares can't be loaded from ZIP archives.
5219 \begin_layout Subsection
5223 \begin_layout Itemize
5224 Modifiers don't work with pseudo-keys (SDL, EVDEV).
5227 \begin_layout Itemize
5228 Audio for last dumped frame is not itself dumped.
5231 \begin_layout Itemize
5232 Audio in UI is pretty bad in quality if game doesn't run at full speed.
5235 \begin_layout Itemize
5236 No menus, command based interface (SDL).
5239 \begin_layout Itemize
5240 Long commands don't scroll.
5243 \begin_layout Section
5247 \begin_layout Subsection
5251 \begin_layout Itemize
5255 \begin_layout Itemize
5256 Fix dumper video corruption with levels 10-18.
5259 \begin_layout Subsection
5263 \begin_layout Itemize
5267 \begin_layout Itemize
5268 Lots of code cleanups
5271 \begin_layout Itemize
5272 Lua interface to settings
5275 \begin_layout Itemize
5276 Allow specifying AVI borders without Lua
5279 \begin_layout Itemize
5280 Fix scaling if vscale > 1 and originx > 0 (left border exists)
5283 \begin_layout Itemize
5284 on_snoop lua callback
5287 \begin_layout Itemize
5288 Faster movie loading and saving.
5291 \begin_layout Subsection
5295 \begin_layout Itemize
5299 \begin_layout Subsection
5303 \begin_layout Itemize
5307 \begin_layout Itemize
5308 Save jukebox functionality.
5311 \begin_layout Subsection
5315 \begin_layout Itemize
5316 Try to fix some nasty failing movie load edge cases
5319 \begin_layout Itemize
5320 Allow specifying scripts to run on command line.
5323 \begin_layout Subsection
5327 \begin_layout Itemize
5328 Major source code reorganization.
5331 \begin_layout Itemize
5332 Backup savestates before overwriting.
5335 \begin_layout Itemize
5336 Don't crash if loading initial state fails.
5339 \begin_layout Subsection
5343 \begin_layout Itemize
5347 \begin_layout Itemize
5348 Fix author name parsing
5351 \begin_layout Itemize
5352 Fix rerecord counting
5355 \begin_layout Itemize
5356 (SDL) Print messages to console if SDL is uninitialized
5359 \begin_layout Itemize
5360 Add movieinfo program
5363 \begin_layout Itemize
5364 Fix loading movies starting from SRAM.
5367 \begin_layout Subsection
5371 \begin_layout Itemize
5372 Add support for unattended dumping
5375 \begin_layout Itemize
5376 Fix compiling for Win32
5379 \begin_layout Itemize
5380 Don't lock up if sound can't be initialized
5383 \begin_layout Itemize
5384 Strip trailing CR from commands
5387 \begin_layout Itemize
5388 Don't try to do dubious things in global ctors (fix crash on startup)
5391 \begin_layout Subsection
5395 \begin_layout Itemize
5396 Small documentation tweaking
5399 \begin_layout Itemize
5403 \begin_layout Itemize
5404 Fix major bug in modifier matching
5407 \begin_layout Subsection
5411 \begin_layout Itemize
5412 Lots of documentation fixes
5415 \begin_layout Itemize
5416 Use dedicated callbacks for event backcomm., not commands.
5419 \begin_layout Itemize
5420 Ensure that the watchdog is not hit when executing delayed reset.
5423 \begin_layout Itemize
5424 Remove errant tab from joystick message.
5427 \begin_layout Subsection
5431 \begin_layout Itemize
5432 Make autofire operate in absolute time, not linear time
5435 \begin_layout Itemize
5436 Reinitialize controls when resuming from loadstate
5439 \begin_layout Itemize
5440 Some more code cleanups
5443 \begin_layout Itemize
5444 If Lua allocator fails, call OOM_panic()
5447 \begin_layout Itemize
5448 Byte/word/dword/qword sized host memory write/read functions.
5451 \begin_layout Itemize
5452 Dump at correct framerate if dumping interlaced NTSC (height=448).
5455 \begin_layout Subsection
5459 \begin_layout Itemize
5460 Actually include the complete source code
5463 \begin_layout Itemize
5467 \begin_layout Subsection
5471 \begin_layout Itemize
5472 Document {save,start}time.{,sub}second.
5475 \begin_layout Itemize
5476 Intercept time() from bsnes core.
5479 \begin_layout Subsection
5483 \begin_layout Itemize
5484 Allow disabling time() interception (allow build on Mac OS X)
5487 \begin_layout Itemize
5488 Use SDLMain on Mac OS X (make SDL not crash)
5491 \begin_layout Itemize
5492 Disable delayed resets (just plain too buggy for now).
5495 \begin_layout Itemize
5499 \begin_layout Itemize
5500 Use 16-bit for graphics/video instead of 32-bit.
5503 \begin_layout Itemize
5504 gui.rectangle/gui.pixel
5507 \begin_layout Itemize
5511 \begin_layout Itemize
5512 New CSCD writer implementation.
5515 \begin_layout Subsection
5519 \begin_layout Itemize
5520 Fix interaction of * and +.
5523 \begin_layout Itemize
5527 \begin_layout Itemize
5528 Use gettimeofday()/usleep(), these seem portable enough.
5531 \begin_layout Itemize
5532 Move joystick axis manipulation to keymapper code.
5535 \begin_layout Itemize
5536 Changes to how read-only works.
5539 \begin_layout Itemize
5540 Refactor controller input code.
5543 \begin_layout Subsection
5547 \begin_layout Itemize
5548 Fix mouseclick scale compensation.
5551 \begin_layout Itemize
5552 Draw area boundaries correctly in SDL code.
5555 \begin_layout Itemize
5559 \begin_layout Itemize
5560 Fix CSCD output (buffer overrun and race condition).
5563 \begin_layout Subsection
5567 \begin_layout Itemize
5568 JMD dumping support.
5571 \begin_layout Itemize
5572 Allow unattended dumping to JMD.
5575 \begin_layout Itemize
5579 \begin_layout Itemize
5580 Switch back to 32-bit colors.
5583 \begin_layout Itemize
5584 Add Lua function gui.color.
5587 \begin_layout Itemize
5588 Use some new C++11 features in GCC 4.6.
5591 \begin_layout Itemize
5592 Be prepared for core frequency changes.
5595 \begin_layout Itemize
5596 Pass colors in one chunk from Lua.
5599 \begin_layout Subsection
5603 \begin_layout Itemize
5604 New lua functions gui.line(), gui.status() and gui.circle(), memory.vma_count(),
5605 memory.read_vma() and memory.find_vma().
5608 \begin_layout Itemize
5609 Numerious documentation fixups
5612 \begin_layout Itemize
5613 RTC time format changed
5616 \begin_layout Itemize
5617 Reformat flags display
5620 \begin_layout Itemize
5621 Allow lua package name to be overridden
5624 \begin_layout Itemize
5625 SDUMP (high-quality dumping).
5628 \begin_layout Itemize
5629 Split platform support to plugins.
5632 \begin_layout Itemize
5633 Make all sound plugins support basic sound commands
5636 \begin_layout Itemize
5637 Support portaudio for sound.
5640 \begin_layout Itemize
5641 Allow disable Lua/SDL searching.
5644 \begin_layout Itemize
5645 Upconvert colors when copying lcscreen to screen.
5648 \begin_layout Itemize
5649 Reorganize source tree.
5652 \begin_layout Itemize
5653 Evdev joystick support.
5656 \begin_layout Itemize
5657 Refactor more code into generic window code.
5660 \begin_layout Subsection
5664 \begin_layout Itemize
5665 Refactor message handling.
5668 \begin_layout Itemize
5672 \begin_layout Itemize
5676 \begin_layout Itemize
5677 Finish pending saves before load/quit.
5680 \begin_layout Itemize
5681 Wxwidgets graphics plugin.
5684 \begin_layout Subsection
5688 \begin_layout Itemize
5689 Get rid of win32-crap.[ch]pp.
5692 \begin_layout Itemize
5693 Move files around a lot.
5696 \begin_layout Itemize
5697 Get rid of need for host C++ compiler.
5700 \begin_layout Itemize
5704 \begin_layout Itemize
5705 Refactor inter-component communication.
5708 \begin_layout Itemize
5712 \begin_layout Itemize
5713 Fix crash on multiline aliases.
5716 \begin_layout Itemize
5717 Load/Save settings in wxwidgets gui.
5720 \begin_layout Subsection
5724 \begin_layout Itemize
5725 Patch problems in bsnes core
5728 \begin_layout Itemize
5729 SNES is little-endian, not big-endian!
5732 \begin_layout Itemize
5733 Fix memory corruption in lcscreen::load()
5736 \begin_layout Subsection
5740 \begin_layout Itemize
5741 Fix interpretting repeat counts in rrdata loading.
5744 \begin_layout Itemize
5745 New lua callback: on_frame()
5748 \begin_layout Itemize
5749 Remove calls to runtosave() that aren't supposed to be there
5752 \begin_layout Itemize
5753 Lua function: movie.read_rtc()
5756 \begin_layout Itemize
5757 Ignore src/fonts/font.cpp
5760 \begin_layout Itemize
5761 Fix more bsnes core problems
5764 \begin_layout Itemize
5765 Control bsnes random seeding
5768 \begin_layout Itemize
5772 \begin_layout Itemize
5773 Some bsnes core debugging features (state dump and state hash)
5776 \begin_layout Itemize
5777 Fix titlebar version number (no, the last version wasn't 'lsnes-0-beta21',
5778 it was 'lsnes rr0-beta21').
5781 \begin_layout Subsection
5785 \begin_layout Itemize
5786 Fix memory corruption due to macro/field mixup
5789 \begin_layout Itemize
5790 search-memory update
5793 \begin_layout Itemize
5794 Allow direct-mapped framebuffer
5797 \begin_layout Itemize
5798 SDL: Use SDL_ANYFORMAT if possible
5801 \begin_layout Itemize
5802 SDMP2SOX: 2s delay modes.
5805 \begin_layout Itemize
5809 \begin_layout Itemize
5810 Use sed -E, not sed -r.
5811 Fixes building on Mac OS X.
5814 \begin_layout Itemize
5815 Wxwidgets: Save jukebox on exit
5818 \begin_layout Itemize
5819 Fix RTC if using load-movie on savestate.
5822 \begin_layout Itemize
5823 Fix crash related to full console mode.
5826 \begin_layout Subsection
5830 \begin_layout Itemize
5831 Wxwidgets: Allow bringing application to foreground on Mac OS X.
5834 \begin_layout Itemize
5835 Wxwidgets: Allow compiling on Mac OS X.
5838 \begin_layout Itemize
5839 Use movie compare instead of movie hashing (faster save/load).
5842 \begin_layout Itemize
5846 \begin_layout Subsection
5850 \begin_layout Itemize
5851 sdmp2sox: Pad soundtrack if using -l or -L.
5854 \begin_layout Itemize
5855 sdmp2sox: Fix NTSC overscan.
5858 \begin_layout Itemize
5859 sdmp2sox: Add AR correction mode.
5862 \begin_layout Itemize
5863 call lua_close() when exiting.
5866 \begin_layout Itemize
5867 Fix zip_writer bug causing warnings from info-zip and error from advzip.
5870 \begin_layout Subsection
5874 \begin_layout Itemize
5875 Fix IPS patching code (use bsnes core IPS patcher).
5878 \begin_layout Itemize
5879 Implement BPS patching (using bsnes core IPS patcher).
5882 \begin_layout Itemize
5883 Add feature to load headered ROMs.
5886 \begin_layout Subsection
5890 \begin_layout Itemize
5891 Show command names when showing keybindings
5894 \begin_layout Subsection
5898 \begin_layout Itemize
5899 Fix pause-on-end to be actually controllable
5902 \begin_layout Itemize
5903 SDL: Poll all events in queue, not just first one (fixes slowness in command
5907 \begin_layout Itemize
5908 Wxwidgets: Fix ROM loading.
5911 \begin_layout Subsection
5915 \begin_layout Itemize
5916 Lua: Add gui.textH, gui.textV, gui.textHV
5919 \begin_layout Itemize
5920 Fix text colors on SDL on Mac OS X
5923 \begin_layout Itemize
5924 Mode 'F' for finished in readonly mode.
5927 \begin_layout Itemize
5931 \begin_layout Itemize
5932 Reliably pause after skip poll
5935 \begin_layout Itemize
5936 Split UI and core into their own threads
5939 \begin_layout Subsection
5943 \begin_layout Itemize
5944 Remove leftover dummy SRAM slot
5947 \begin_layout Itemize
5948 Fix controller numbers.
5951 \begin_layout Subsection
5955 \begin_layout Itemize
5956 Fix lsnes-dumpavi after interface change.
5959 \begin_layout Itemize
5960 Also give BSNES patches for v085.
5963 \begin_layout Itemize
5964 Pack movie data in memory.
5967 \begin_layout Subsection
5971 \begin_layout Itemize
5972 Fix framecount/length given when loading movies.
5975 \begin_layout Itemize
5976 Controller command memory leak fixes.
5979 \begin_layout Itemize
5980 Don't leak palette if freeing screen object.
5983 \begin_layout Subsection
5987 \begin_layout Itemize
5991 \begin_layout Itemize
5992 Wxwidgets: Allow controlling dumper from the menu.
5995 \begin_layout Subsection
5999 \begin_layout Itemize
6000 Rewrite parts of manual
6003 \begin_layout Itemize
6004 Lua: Make it work with Lua 5.2.
6007 \begin_layout Subsection
6011 \begin_layout Itemize
6012 Win32: Fix compile errors.
6015 \begin_layout Subsection
6019 \begin_layout Itemize
6020 Refactor controller input code.
6023 \begin_layout Itemize
6024 Fix crash when using command line on SDL / Mac OS X.
6027 \begin_layout Subsection
6031 \begin_layout Itemize
6032 Delete core/coroutine (obsolete)
6035 \begin_layout Itemize
6036 Lag input display by one frame.
6039 \begin_layout Itemize
6040 Rewind movie to beginning function.
6043 \begin_layout Itemize
6044 Fix wrong frame number reported to Lua when repainting after loadstate
6047 \begin_layout Itemize
6048 Support UI editing of jukebox
6051 \begin_layout Itemize
6052 Wxwidgets: Save settings on exit.
6055 \begin_layout Itemize
6056 Support ${project} for filenames
6059 \begin_layout Itemize
6060 SDL: Fix command history
6063 \begin_layout Subsection
6067 \begin_layout Itemize
6068 Fix some order-of-global-ctor bugs.
6071 \begin_layout Subsection
6075 \begin_layout Itemize
6076 Fix crashes when quitting on Win32.
6079 \begin_layout Subsection
6083 \begin_layout Itemize
6084 EVDEV: Queue keypresses from joystick, don't send directly
6087 \begin_layout Itemize
6088 Wxwidgets: Load-Preserve that actually works.
6091 \begin_layout Subsection
6095 \begin_layout Itemize
6096 Wxwidgets: GUI for memory search.
6099 \begin_layout Itemize
6100 Warn about using synchronous queue in UI callback.
6103 \begin_layout Subsection
6107 \begin_layout Itemize
6108 Remember last saved file for each ROM
6111 \begin_layout Itemize
6112 Support MT dumping via boost.
6115 \begin_layout Itemize
6119 \begin_layout Itemize
6123 \begin_layout Itemize
6124 Make mouse be ordinary input instead of special-casing
6127 \begin_layout Itemize
6128 SDL: Don't screw up commands with NUL codepoints.
6131 \begin_layout Subsection
6135 \begin_layout Itemize
6136 Merge status panel and main window
6139 \begin_layout Itemize
6140 True movie slot support (the rest of it)
6143 \begin_layout Itemize
6144 SDL: Fix compilation error
6147 \begin_layout Itemize
6148 Elminate cross calls in dump menu code.
6151 \begin_layout Subsection
6155 \begin_layout Itemize
6156 Cancel pending saves command
6159 \begin_layout Itemize
6160 Wxwidgets: Code refactoring
6163 \begin_layout Itemize
6164 Wxwidgets: Fix system -> reset
6167 \begin_layout Itemize
6168 Wxwidgets: Read watch expressions in the right thread
6171 \begin_layout Subsection
6175 \begin_layout Itemize
6176 Wxwidgets: Don't prompt for member when running Lua script (Lua doesn't
6180 \begin_layout Itemize
6181 Wxwidgets: 128 -> 1024 Autohold slots (in case more are needed).
6184 \begin_layout Itemize
6185 Don't append trailing '-' to prefix when saving movie.
6188 \begin_layout Itemize
6189 Fix ROM/savestate handling (don't let user mismatch ROM and savestates).
6192 \begin_layout Subsection
6196 \begin_layout Itemize
6197 Document memory watch syntax.
6200 \begin_layout Subsection
6204 \begin_layout Itemize
6205 Fix unattended dumping (lsnes-dumpavi)
6208 \begin_layout Itemize
6212 \begin_layout Itemize
6213 Use adv_dumper instead of the old interface in lsnes-dumpavi (changes syntax)
6216 \begin_layout Itemize
6217 Add option to control sample rate preturbation in AVI dumper
6220 \begin_layout Subsection
6224 \begin_layout Itemize
6225 Wxwidgets: Fix dumper submodes
6228 \begin_layout Itemize
6229 Set core controller types before loadstate
6232 \begin_layout Subsection
6236 \begin_layout Itemize
6237 Fix compiling with bsnes v086.
6240 \begin_layout Subsection
6244 \begin_layout Itemize
6245 Don't prompt before quitting
6248 \begin_layout Itemize
6249 Start unpaused, preserve pause/unpause over load.
6252 \begin_layout Itemize
6253 Try to autodetect if ROM is headered.
6256 \begin_layout Itemize
6257 Wxwidgets: Only bring up ROM patching screen if specifically requested.
6260 \begin_layout Itemize
6261 Allow configuring some hotkeys.
6264 \begin_layout Subsection
6268 \begin_layout Itemize
6269 Lots of code cleanups
6272 \begin_layout Itemize
6273 Fix JMD compression (JMD dumping was broken)
6276 \begin_layout Itemize
6277 Don't crash if Lua C function throws an exception.
6280 \begin_layout Itemize
6281 Support bitmap drawing in Lua.
6284 \begin_layout Itemize
6285 Fix bsnes v085/v086 patches.
6288 \begin_layout Itemize
6289 Improve stability on win32.
6292 \begin_layout Subsection
6296 \begin_layout Itemize
6297 Don't corrupt movie if movie length is integer multiple of frames per page.
6300 \begin_layout Subsection
6304 \begin_layout Itemize
6305 New Lua hooks: on_rewind, on_frame_emulated, on_idle, on_timer
6308 \begin_layout Itemize
6309 New Lua functions: emulator_ready(), utime(), set_idle_timeout(), set_timer_time
6310 out(), bit.extract(), bit.value(), input.geta(), input.seta() and input.controllertyp
6314 \begin_layout Itemize
6315 Wxwidgets: Fix internal focus lost (hotkeys stop working)
6318 \begin_layout Itemize
6319 Wxwidgets: Fix broken modifiers
6322 \begin_layout Itemize
6323 on_paint has parameter now.
6326 \begin_layout Itemize
6327 Optional initital fill for bitmaps
6330 \begin_layout Itemize
6331 Fix palette changing.
6334 \begin_layout Itemize
6335 Optimize rendering a bit.
6338 \begin_layout Itemize
6342 \begin_layout Subsection
6346 \begin_layout Itemize
6347 Movieinfo: Fix display of port #2 type.
6350 \begin_layout Itemize
6351 Call on_input() after loadstate.
6354 \begin_layout Subsection
6358 \begin_layout Itemize
6359 Fix writing port2 data to movie.
6362 \begin_layout Itemize
6363 Fix SRAM handling with Bsnes v087.
6366 \begin_layout Subsection
6370 \begin_layout Itemize
6371 Library loading support
6374 \begin_layout Itemize
6375 Built-in TSCC encoder
6378 \begin_layout Itemize
6379 Hi-color (256T colors) dumping.
6382 \begin_layout Itemize
6383 Dump over TCP/IP(v6)
6386 \begin_layout Itemize
6387 Hidable status panel
6390 \begin_layout Itemize
6394 \begin_layout Itemize
6395 Adjustable sound volume
6398 \begin_layout Itemize
6402 \begin_layout Itemize
6403 Allow DnD into filename boxes
6406 \begin_layout Itemize
6410 \begin_layout Itemize
6411 Portaudio: Fix speaker popping at start
6414 \begin_layout Itemize
6418 \begin_layout Itemize
6419 Speed adjustment menu
6422 \begin_layout Itemize
6423 Win32 joystick support
6426 \begin_layout Itemize
6427 Lua: gui.rainbow and gui.box
6430 \begin_layout Itemize
6431 Split key lists into classes (the key list was large!)
6434 \begin_layout Itemize
6435 More save slots support
6438 \begin_layout Itemize
6439 Wxwidgets (wxJoystick) joystick support
6442 \begin_layout Subsection
6446 \begin_layout Itemize
6447 Lots of internal joystick refactoring
6450 \begin_layout Itemize
6451 Evdev: Add mapping for BTN_TOOL_QUINTTAP
6454 \begin_layout Itemize
6455 Wxwidgets: Settings mode (open settings without ROM)
6458 \begin_layout Itemize
6459 Wxwidgets: Prompt key to use option
6462 \begin_layout Itemize
6463 Wxwidgets: Fix crash if key goes away underneath
6466 \begin_layout Itemize
6467 Wxwidgets: Fix mouse position in presence of scaling
6470 \begin_layout Itemize
6471 AVI dumper: Mode 4 (high-quality resampling to common rate using SRC)
6474 \begin_layout Itemize
6475 Wxwidgets: Redesign hotkeys dialog to avoid tree control (tree control doesn't
6476 seem to work well on WinXP)
6479 \begin_layout Itemize
6480 Start paused option.
6483 \begin_layout Subsection
6487 \begin_layout Itemize
6491 \begin_layout Itemize
6492 lsnes-dumpavi: Start Lua before starting dumper
6495 \begin_layout Itemize
6496 AVI: Fix secondary audio in mode 4.
6499 \begin_layout Subsection
6503 \begin_layout Itemize
6504 AVI: Refactor ZMBV a bit.
6507 \begin_layout Itemize
6508 Fix error reading analog values from movie file
6511 \begin_layout Subsection
6515 \begin_layout Itemize
6516 Delayed reset support
6519 \begin_layout Itemize
6520 Lua: memory.hash_region
6523 \begin_layout Subsection
6527 \begin_layout Itemize
6528 Rework the build system
6531 \begin_layout Itemize
6532 Typing input support
6535 \begin_layout Itemize
6536 Fix building with bsnes v086 and v087.
6539 \begin_layout Itemize
6540 SDL: Save settings on exit
6543 \begin_layout Itemize
6544 SDL: Command to enter command line mode with given command.
6547 \begin_layout Itemize
6548 SDL: More advanced command editing.
6551 \begin_layout Subsection
6555 \begin_layout Itemize
6557 \begin_inset Quotes eld
6560 arrow keys and enter don't work
6561 \begin_inset Quotes erd
6567 \begin_layout Itemize
6571 \begin_layout Itemize
6572 Show mode changes due to rewinding.
6575 \begin_layout Itemize
6576 Unsafe rewind support
6579 \begin_layout Itemize
6580 Fix directory transversal.
6583 \begin_layout Subsection
6587 \begin_layout Itemize
6588 AVI: Sound mode 5 (48kHz high-quality)
6591 \begin_layout Itemize
6595 \begin_layout Itemize
6596 Map the SNES bus into address space
6599 \begin_layout Itemize
6600 Fix loading memory watch files with CRLF line endings
6603 \begin_layout Subsection
6607 \begin_layout Itemize
6608 Map bsnes internal state into memory space
6611 \begin_layout Itemize
6613 \begin_inset Quotes eld
6616 click on panel wedges the emulator
6617 \begin_inset Quotes erd
6623 \begin_layout Itemize
6624 DnD movies/saves on the main window.
6627 \begin_layout Subsection
6631 \begin_layout Itemize
6632 Split core bindings into own module.
6635 \begin_layout Itemize
6636 Remember invalid settings
6639 \begin_layout Itemize
6640 Support for modified Gambatte core for GB/GBC emulation.
6643 \begin_layout Itemize
6644 Reload/swap ROM function
6647 \begin_layout Subsection
6651 \begin_layout Itemize
6652 Fix step poll function
6655 \begin_layout Subsection
6659 \begin_layout Itemize
6660 Non-insane savestate anchoring
6663 \begin_layout Subsection
6667 \begin_layout Itemize
6668 More Memory search methods
6671 \begin_layout Itemize
6672 Preserve movie if loading in RO mode.
6675 \begin_layout Itemize
6676 Fix a obscure case in timeline check
6679 \begin_layout Itemize
6680 Revamp the entiere ROM loading code
6683 \begin_layout Itemize
6687 \begin_layout Itemize
6691 \begin_layout Itemize
6692 Standalone hotkey config dialog
6695 \begin_layout Itemize
6696 Show bindings in more user-friendly format
6699 \begin_layout Subsection
6703 \begin_layout Itemize
6707 \begin_layout Itemize
6708 Fix uninitialized variables in bsnes v085
6711 \begin_layout Subsection
6715 \begin_layout Itemize
6716 Merge gambatte core into mainline (from its own branch)
6719 \begin_layout Itemize
6720 Wxwidgets: Show expected dump file formats
6723 \begin_layout Itemize
6724 Memory watch: Data typing
6727 \begin_layout Itemize
6728 lsnes internal MMIO area.
6731 \begin_layout Itemize
6732 Wxwidgets: New memory watch editor
6735 \begin_layout Itemize
6736 Hexadecimal memory watches
6739 \begin_layout Itemize
6740 Wxwidgets: Monospaced panel
6743 \begin_layout Itemize
6744 Wxwidgets: Split memory watches in panel
6747 \begin_layout Itemize
6748 Wxwidgets: Disable VMAs in memory search
6751 \begin_layout Itemize
6752 lsnes-dumpavi: Fix speed bug
6755 \begin_layout Itemize
6756 Movie subtitle support
6759 \begin_layout Itemize
6760 Fix rerecord count reporting
6763 \begin_layout Itemize
6764 Don't trash movie when loading in readonly mode.
6767 \begin_layout Subsection
6771 \begin_layout Itemize
6772 Wxwidgets: Fix crashes on closing settings dialogs on Mac OS X.
6775 \begin_layout Itemize
6776 Fix build on Mac OS X.
6779 \begin_layout Itemize
6783 \begin_layout Itemize
6784 Wxwidgets: Hidable messages window
6787 \begin_layout Itemize
6791 \begin_layout Itemize
6792 Bsnes: Support inconsistent saves
6795 \begin_layout Itemize
6796 Bsnes: Allow simulating saving every frame
6799 \begin_layout Itemize
6800 Fix desync if savestate is loaded in readonly mode in certain conditions.
6803 \begin_layout Itemize
6804 Wxwidgets: Fix save dialogs on Mac OS X.
6807 \begin_layout Itemize
6808 Wxwidgets: Fix insane status width on Win32.
6811 \begin_layout Itemize
6812 Wxwidgets: Fix autohold processing to be faster.
6815 \begin_layout Itemize
6816 Wxwidgets: Allow loading ROMs and movies from commandline.
6819 \begin_layout Subsection
6823 \begin_layout Itemize
6824 Be a bit smarter with --load
6827 \begin_layout Itemize
6828 Rewrote higher-level parts of audio system
6831 \begin_layout Itemize
6832 Tool to build commentary tracks
6835 \begin_layout Itemize
6839 \begin_layout Itemize
6840 Gambatte: Add support for SVN358
6843 \begin_layout Itemize
6844 Use builtin font when rendering status panel.
6847 \begin_layout Itemize
6848 Option to detach memory watch to its own window.
6851 \begin_layout Itemize
6852 Recent ROMs/Movies menu
6855 \begin_layout Itemize
6859 \begin_layout Itemize
6860 Useful lag counter for SNES games that autopoll
6863 \begin_layout Itemize
6864 Fix buffer overflow in gambatte sound output
6867 \begin_layout Subsection
6871 \begin_layout Itemize
6872 Don't blow up on wxGTK if the window is hidden somehow
6875 \begin_layout Itemize
6876 Support simultaneous drop of ROM and movie.
6879 \begin_layout Itemize
6880 Gambatte: Don't save spurious SRAMs.
6883 \begin_layout Itemize
6884 Make SGB ROMs actually usable.
6887 \begin_layout Itemize
6888 Fix so that saved movies appear in recent movies.
6891 \begin_layout Itemize
6892 Don't open multiple commentary editors at once.
6895 \begin_layout Subsection
6899 \begin_layout Itemize
6900 Lua: memory.readregion/memory.writeregion
6903 \begin_layout Itemize
6904 Lua: memory.map{,s}{byte,word,dword,qword}
6907 \begin_layout Itemize
6908 Lua: memory.map_structure
6911 \begin_layout Itemize
6912 Lua: Fix bus_address for gambatte
6915 \begin_layout Itemize
6916 Fix features dependent of bsnes debugger
6919 \begin_layout Itemize
6920 Cleanup bsnes debugger logic
6923 \begin_layout Itemize
6924 Fix resets in presence of save every frame
6927 \begin_layout Subsection
6931 \begin_layout Itemize
6932 Lua: input.lcid_to_pcid
6935 \begin_layout Itemize
6936 Fix off-by-one bug with slot hashes
6939 \begin_layout Itemize
6940 Fix crashes on certain memory watch expressions
6943 \begin_layout Itemize
6944 Lua: memory.read_expr
6947 \begin_layout Itemize
6948 Lua: Fix memory.read_expr on nil argument
6951 \begin_layout Itemize
6952 Fix the code to compile on G++ 4.7
6955 \begin_layout Itemize
6956 Change button_id to be a function pointer field, not a virtual method
6959 \begin_layout Itemize
6960 Add bsnes patches to fix libsnes to compile on GCC 4.7
6963 \begin_layout Itemize
6964 Gambatte: Always use legacy lag counting
6967 \begin_layout Itemize
6968 Memory commands: Memory addresses are up to 16 hex digits, not up to 8
6971 \begin_layout Itemize
6972 Fix analog controllers
6975 \begin_layout Itemize
6979 \begin_layout Itemize
6980 Fix button symbols in input display
6983 \begin_layout Itemize
6984 Compensate for nuts bsnes superscope/justifier handling
6987 \begin_layout Itemize
6988 Lua: Fix bit.extract boolean handling
6991 \begin_layout Subsection
6995 \begin_layout Itemize
6996 Split emulation cores more from the rest
6999 \begin_layout Itemize
7000 Support having multiple emulation cores compiled at once
7003 \begin_layout Itemize
7004 Support arbitrary number of ports (well, up to 31 anyway).
7007 \begin_layout Itemize
7008 SNES debugger support
7011 \begin_layout Itemize
7012 Support 16-button controllers
7015 \begin_layout Itemize
7016 Remove old SDL front end
7019 \begin_layout Itemize
7020 Data-driven controller buttons
7023 \begin_layout Itemize
7024 Generate the port code from defines
7027 \begin_layout Subsection
7031 \begin_layout Itemize
7032 Update libgambatte to SVN364
7035 \begin_layout Itemize
7036 Get rid of partial linking (building with MXE works)
7039 \begin_layout Itemize
7040 Load XML even without gamepack files
7043 \begin_layout Itemize
7044 Support screen rotate & flip
7047 \begin_layout Itemize
7048 Fix bug when changing controller key to another subkey of the same key
7051 \begin_layout Subsection
7055 \begin_layout Itemize
7056 Stop at movie end: Don't off-by-one
7059 \begin_layout Itemize
7060 Fix crash closing lsnes with voice playback active.
7063 \begin_layout Itemize
7064 Import/Export OggOpus for commentary tracks
7067 \begin_layout Itemize
7068 16-button controllers.
7071 \begin_layout Itemize
7072 Don't show nonexistent controllers in input display
7075 \begin_layout Itemize
7076 Set voice record/playback volume from UI
7079 \begin_layout Itemize
7080 Patches for gambatte SVN364.
7083 \begin_layout Itemize
7084 Load markup (if exists) even without gamepack file.
7087 \begin_layout Itemize
7088 Screen rotation & flipping
7091 \begin_layout Itemize
7092 Lua: Some new bit functions
7095 \begin_layout Itemize
7096 Auto-refresh voice streams on change.
7099 \begin_layout Itemize
7100 Auto-refresh subtitles on change & new subtitle editor.
7103 \begin_layout Itemize
7104 Fix music volume adjustment.
7107 \begin_layout Subsection
7111 \begin_layout Itemize
7112 Use system threads instead of platform threads
7115 \begin_layout Itemize
7116 Cleanup build by allowing dummy and real drivers to link together.
7119 \begin_layout Itemize
7120 Split duplex support
7123 \begin_layout Subsection
7127 \begin_layout Itemize
7128 Wxwidgets: Fix memory watch rendering.
7131 \begin_layout Itemize
7132 Wxwidgets: Allow setting voice stream gain.
7135 \begin_layout Itemize
7136 Wxwidgets: VU meters and volume adjustment.
7139 \begin_layout Itemize
7140 Lua: Custom fonts support.
7143 \begin_layout Itemize
7144 Lua: Fix methods stopping working when resetting Lua.
7147 \begin_layout Itemize
7148 Fix loading standard-format movies in preserve (readonly) mode.
7151 \begin_layout Subsection
7155 \begin_layout Itemize
7156 Primitive movie editor
7159 \begin_layout Itemize
7160 Fix VU meter with no sound device.
7163 \begin_layout Itemize
7164 Fix various undefined return values.
7167 \begin_layout Itemize
7168 Show rates in VU meter window.
7171 \begin_layout Subsection
7175 \begin_layout Itemize
7176 Lua: Render queues as objects
7179 \begin_layout Itemize
7180 Bsnes: support hard resets
7183 \begin_layout Itemize
7184 Dedicated sound devices dialog
7187 \begin_layout Itemize
7188 Change the default AVI sound mode to 2 or 5.
7191 \begin_layout Itemize
7192 Fix totally borked movie saving.
7195 \begin_layout Itemize
7196 Portaudio: Use split duplex with different devices.
7199 \begin_layout Itemize
7200 Fix controls with gambatte core.
7203 \begin_layout Itemize
7204 Modify save slot set handling.
7207 \begin_layout Itemize
7208 lsnes-dumpavi: --firmware-path.
7211 \begin_layout Itemize
7212 Fix lots of compiler warnings.
7215 \begin_layout Subsection
7219 \begin_layout Itemize
7220 Commentary tool: Set nominal bit rate and limit max bit rate.
7223 \begin_layout Itemize
7224 Lua: Unconditionally reload host memory on loadstate
7227 \begin_layout Itemize
7228 Lua: Query bindings, manipulate aliases, create inverse bindings
7231 \begin_layout Itemize
7232 Lua: Fix crashes with resetting VM while some types of paint requests are
7236 \begin_layout Itemize
7237 Lua: gui.text: Clip the text properly instead of corrupting memory in some
7241 \begin_layout Itemize
7242 Save screenshot header reliably
7245 \begin_layout Itemize
7246 Lua: Backport input.get2 and input.set2
7249 \begin_layout Itemize
7250 Lua: New controller info functions.
7253 \begin_layout Itemize
7254 Movie editor: Fix reset delay counters to be the right way around.
7257 \begin_layout Itemize
7261 \begin_layout Itemize
7262 Lua: on_button and input.veto_button.
7265 \begin_layout Subsection
7269 \begin_layout Itemize
7270 Revert memory leak fix breaking input
7273 \begin_layout Itemize
7274 Refactor Opus handling
7277 \begin_layout Itemize
7278 Restrict member picking only to .zip files
7281 \begin_layout Itemize
7282 Fix reading of host-endian VMAs.
7285 \begin_layout Itemize
7286 Fix rlow and rhigh to be the right way around.
7289 \begin_layout Itemize
7290 Lua: Don't wedge VM if callback fails with an exception
7293 \begin_layout Itemize
7294 Refactor Ogg handling.
7297 \begin_layout Subsection
7301 \begin_layout Itemize
7302 Fix saving PNG screenshots on Win32.
7305 \begin_layout Itemize
7306 Movie editor: Sweep axis.
7309 \begin_layout Itemize
7310 Load selected slot in ro/rw/preserve/movie mode.
7313 \begin_layout Itemize
7314 input.joyset: Preserve and invert user input.
7317 \begin_layout Itemize
7318 Allow immediate saving at point of save (transfer saves).
7321 \begin_layout Itemize
7322 Wxwidgets: Filter filenames in dialogs, autoappend extensions.
7325 \begin_layout Itemize
7326 data/verysmall.font: Add missing glyph 70 (
7327 \begin_inset Quotes eld
7331 \begin_inset Quotes erd
7337 \begin_layout Itemize
7338 Lua: Allow painting custom fonts with halo.
7341 \begin_layout Itemize
7342 Fix memory value search to work on byte types.
7345 \begin_layout Subsection
7349 \begin_layout Itemize
7350 Reject oggopus files with incomplete pregap
7353 \begin_layout Itemize
7354 Fix multistream and ogg demuxing
7357 \begin_layout Itemize
7358 Workaround bug with screen >1024 pixels wide.
7361 \begin_layout Itemize
7362 Allow on_input to force/veto system controls.
7365 \begin_layout Itemize
7366 Dedicated autohold/autofire window.
7369 \begin_layout Itemize
7370 Support per-button autofire.
7373 \begin_layout Itemize
7374 Fix crash on trying to frameadvance/exit with no ROM loaded.
7377 \begin_layout Itemize
7378 Fix nonexistent controller key warnings.
7381 \begin_layout Itemize
7382 Movie editor: Fix mouse editing (TYPE_RAXIS)
7385 \begin_layout Itemize
7389 \begin_layout Itemize
7393 \begin_layout Itemize
7394 Add throttle axes (TYPE_TAXIS).
7397 \begin_layout Itemize
7398 Fix movie reading with first port having multiple controllers.
7401 \begin_layout Itemize
7402 Move some info from status panel to statusbar.
7405 \begin_layout Subsection
7409 \begin_layout Itemize
7410 Fix status panel (and movie editor) flicker
7413 \begin_layout Itemize
7414 Show effects of Lua in input display
7417 \begin_layout Itemize
7418 Offer lsmv.backup as file filter too for load lsmv
7421 \begin_layout Itemize
7422 Allow slowing down subframe advance
7425 \begin_layout Itemize
7426 Display current save slot information
7429 \begin_layout Itemize
7433 \begin_layout Itemize
7434 Fix hotkeys stopping working after X-ing settings dialog
7437 \begin_layout Itemize
7438 Movie editor: Fix bug if extending finished movie
7441 \begin_layout Itemize
7442 Cap current_frame_first_subframe to movie size when recounting movie
7445 \begin_layout Itemize
7446 Movie editor: Interpret ctrl+click as right click
7449 \begin_layout Subsection
7453 \begin_layout Itemize
7454 Autofire: Fix false status indications
7457 \begin_layout Itemize
7458 Fix subframe counter
7461 \begin_layout Itemize
7462 Fix print() after Lua reset
7465 \begin_layout Itemize
7466 New settings framework
7469 \begin_layout Itemize
7470 Remove some unused leftover stuff
7473 \begin_layout Itemize
7474 Fix race condition causing possible crash on startup
7477 \begin_layout Itemize
7478 Fix compiling if uint64_t and size_t are not compatible
7481 \begin_layout Itemize
7482 Lua: Don't crash if input.[gs]et{,a} is called outside on_input
7485 \begin_layout Subsection
7489 \begin_layout Itemize
7490 Fix bug causing crash if triple has invalid button