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 Subsection
737 \begin_layout Subsubsection
738 cycle-jukebox-backward
741 \begin_layout Standard
742 Cycle save jukebox backwards.
745 \begin_layout Subsubsection
746 cycle-jukebox-forward
749 \begin_layout Standard
750 Cycle save jukebox forwards
753 \begin_layout Subsubsection
757 \begin_layout Standard
758 Do load from jukebox (current mode).
761 \begin_layout Subsubsection
765 \begin_layout Standard
766 Do state save to jukebox.
769 \begin_layout Subsection
773 \begin_layout Standard
774 Only available if lua support is compiled in.
777 \begin_layout Subsubsection
778 evaluate-lua <luacode>
781 \begin_layout Standard
782 Run Lua code <luacode> using built-in Lua interpretter.
785 \begin_layout Subsubsection
789 \begin_layout Standard
790 Run specified lua file using built-in Lua interpretter.
793 \begin_layout Subsubsection
797 \begin_layout Standard
798 Clear the Lua VM state and restore to factory defaults.
801 \begin_layout Subsection
805 \begin_layout Subsubsection
806 add-watch <name> <expression>
809 \begin_layout Standard
810 Adds new watch (or modifies old one).
813 \begin_layout Subsubsection
817 \begin_layout Standard
821 \begin_layout Subsection
825 \begin_layout Subsubsection
826 enable-sound <on/off>
829 \begin_layout Standard
830 Enable/Disable sound.
833 \begin_layout Subsection
837 \begin_layout Subsubsection
841 \begin_layout Standard
842 Reloads the main ROM image from <file>.
845 \begin_layout Subsubsection
849 \begin_layout Standard
850 Tangent for recording voice for commentary track.
851 While pressed, record a stream.
854 \begin_layout Subsubsection
855 advance-subframe-timeout
858 \begin_layout Standard
859 Subframe advance timeout in milliseconds.
863 \begin_layout Section
867 \begin_layout Subsection
871 \begin_layout Subsection
875 \begin_layout Subsubsection
879 \begin_layout Standard
880 AVI dumper: Always dump at 512x448 or 512x478 regardless of what the console
884 \begin_layout Subsubsection
888 \begin_layout Standard
889 AVI dumper: Set the default left border thickness (unless lua overrides)
895 \begin_layout Subsubsection
899 \begin_layout Standard
900 AVI dumper: Set the default right border thickness (unless lua overrides)
906 \begin_layout Subsubsection
910 \begin_layout Standard
911 AVI dumper: Set the default top border thickness (unless lua overrides)
917 \begin_layout Subsubsection
921 \begin_layout Standard
922 AVI dumper: Set the default bottom border thickness (unless lua overrides)
928 \begin_layout Subsubsection
932 \begin_layout Standard
933 AVI dumper: Maximum number of frames per dump segment (0 => unlimited).
938 \begin_layout Subsubsection
942 \begin_layout Standard
943 AVI dumper: Compression level (0-18).
946 \begin_layout Itemize
947 Compression levels 10 and above are not compatible with stock CSCD codec.
950 \begin_layout Itemize
951 Recomended level is 7.
954 \begin_layout Subsubsection
958 \begin_layout Standard
959 AVI dumper: Set method of determining the sound rate.
962 \begin_layout Itemize
963 0: Pick nearest of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48, 64, 88.2, 96,
964 128, 176.4 and 192 kHz.
967 \begin_layout Itemize
968 1: Round down to nearest integer.
971 \begin_layout Itemize
972 2: Round up to nearest ingeter.
975 \begin_layout Itemize
976 3: Multiply by denominator.
979 \begin_layout Itemize
980 4: High quality 44.1kHz (SRC needed).
983 \begin_layout Itemize
984 5: High quality 48kHz (SRC needed).
987 \begin_layout Subsection
991 \begin_layout Subsubsection
995 \begin_layout Standard
996 JMD dumper: Compression level (0-9).
999 \begin_layout Section
1003 \begin_layout Subsection
1004 Core (in main table)
1007 \begin_layout Subsubsection
1011 \begin_layout Standard
1012 Print line to message console.
1015 \begin_layout Subsubsection
1016 exec(string command)
1019 \begin_layout Standard
1020 Run command as it was entered on the command line
1023 \begin_layout Subsubsection
1027 \begin_layout Standard
1029 First is time since some epoch in seconds, the second is microseconds mod
1030 10^6 since that epoch.
1033 \begin_layout Subsubsection
1037 \begin_layout Standard
1038 Returns true if emulator has finished booting, false if not (on_startup()
1039 will be issued later).
1042 \begin_layout Subsubsection
1043 set_idle_timeout(number timeout)
1046 \begin_layout Standard
1047 Set number of microseconds to block idle for.
1048 After this timeout has expired, on_idle() will be called once.
1051 \begin_layout Subsubsection
1052 set_timer_timeout(number timeout)
1055 \begin_layout Standard
1056 Set number of microseconds to block timer for.
1057 After this timeout has expired, on_timer() will be called once.
1060 \begin_layout Subsubsection
1061 bus_address(number snesaddr)
1064 \begin_layout Standard
1065 Returns virtual address corresponding to specified address on SNES bus.
1068 \begin_layout Subsubsection
1069 loopwrapper(function fun, ...)
1072 \begin_layout Standard
1073 Calls function fun with function and specified arguments.
1074 The function passed suspends execution until the function returned is called.
1075 Handy for linear flow control among multiple invocations of a hook.
1079 \begin_layout LyX-Code
1080 on_paint = loopwrapper(function(wait)
1084 \begin_layout LyX-Code
1089 \begin_layout LyX-Code
1091 \begin_inset Quotes eld
1095 \begin_inset Quotes erd
1101 \begin_layout LyX-Code
1106 \begin_layout LyX-Code
1111 \begin_layout LyX-Code
1115 \begin_layout Subsubsection
1116 list_bindings([string cmd])
1119 \begin_layout Standard
1120 Get table of all keybindings, indexed by keyspec (modifiers|mask/key).
1121 If command is specified, the table is limited to that command.
1122 Also searches for controller keys.
1125 \begin_layout Subsubsection
1126 get_alias(string aname)
1129 \begin_layout Standard
1130 Get expansion of given alias.
1133 \begin_layout Subsubsection
1134 set_alias(string aname, string value)
1137 \begin_layout Standard
1138 Set expansion of given alias.
1141 \begin_layout Subsubsection
1142 create_ibind(string name, string cmd)
1145 \begin_layout Standard
1146 Return object representing inverse binding with specified name and specified
1150 \begin_layout Itemize
1151 To create press/release commands, use aliases +foo and -foo .
1154 \begin_layout Itemize
1155 Keep the returned object around.
1158 \begin_layout Subsection
1162 \begin_layout Standard
1163 Bitwise logical functions and related.
1166 \begin_layout Subsubsection
1167 bit.none(number...) / bit.bnot(number...)
1170 \begin_layout Standard
1171 48-bit bitwise NOT / NONE function (set bits that are set in none of the
1175 \begin_layout Subsubsection
1176 bit.any(number...) / bit.bor(number...)
1179 \begin_layout Standard
1180 48-bit bitwise OR / ANY function (set bits that are set in any of the arguments).
1183 \begin_layout Subsubsection
1184 bit.all(number...) / bit.band(number...)
1187 \begin_layout Standard
1188 48-bit bitwise AND / ALL function (set bits that are set in all of the arguments
1192 \begin_layout Subsubsection
1193 bit.parity(number...) / bit.bxor(number...)
1196 \begin_layout Standard
1197 48-bit bitwise XOR / PARITY function (set bits that are set in odd number
1201 \begin_layout Subsubsection
1202 bit.lrotate(number base[, number amount[, number bits]])
1205 \begin_layout Standard
1206 Rotate bits-bit (max 48, default 48) number left by amount (default 1) places.
1209 \begin_layout Subsubsection
1210 bit.rrotate(number base[, number amount[, number bits]])
1213 \begin_layout Standard
1214 Rotate bits-bit (max 48, default 48) number right by amount (default 1)
1218 \begin_layout Subsubsection
1219 bit.lshift(number base[, number amount[, number bits]])
1222 \begin_layout Standard
1223 Shift bits-bit (max 48, default 48) number left by amount (default 1) places.
1224 The new bits are filled with zeroes.
1227 \begin_layout Subsubsection
1228 bit.lrshift(number base[, number amount[, number bits]])
1231 \begin_layout Standard
1232 Shift bits-bit (max 48, default 48) number logically right by amount (default
1234 The new bits are filled with zeroes.
1237 \begin_layout Subsubsection
1238 bit.arshift(number base[, number amount[, number bits]])
1241 \begin_layout Standard
1242 Shift bits-bit (max 48, default 48) number arithmetically right by amount
1244 The new bits are shifted in with copy of the high bit.
1247 \begin_layout Subsubsection
1248 bit.extract(number base[, number bit0[, number bit1,...]])
1251 \begin_layout Standard
1252 Returns number that has bit0-th bit as bit 0, bit1-th bit as 1 and so on.
1255 \begin_layout Standard
1259 \begin_layout Itemize
1260 Bit numbers up to 51 should work reliably (then things start falling apart
1261 due to double precision issues).
1264 \begin_layout Itemize
1265 There are two special bit positions, true and false, standing for always
1266 set bit and always clear bit.
1269 \begin_layout Subsubsection
1270 bit.value([number bit1[, number bit2,...]])
1273 \begin_layout Standard
1274 Returns bitwise OR of 1 left shifted by bit1 places, 1 left shifted by bit2
1276 As special value, nil argument is no-op.
1279 \begin_layout Subsubsection
1280 bit.test_any(number a, number b)
1283 \begin_layout Standard
1284 Returns true if bitwise and of a and b is nonzero, otherwise false.
1287 \begin_layout Subsubsection
1288 bit.test_all(number a, number b)
1291 \begin_layout Standard
1292 Returns true if bitwise and of a and b is equals b, otherwise false.
1295 \begin_layout Subsubsection
1296 bit.popcount(number a)
1299 \begin_layout Standard
1300 Returns number of set bits in a.
1303 \begin_layout Subsubsection
1304 bit.clshift(number a, number b, [number amount,[number bits]])
1307 \begin_layout Standard
1308 Does chained left shift on a, b by amount positions, assuming numbers to
1309 be of specified number of bits.
1312 \begin_layout Subsubsection
1313 bit.crshift(number a, number b, [number amount,[number bits]])
1316 \begin_layout Standard
1317 Does chained right shift on a, b by amount positions, assuming numbers to
1318 be of specified number of bits.
1321 \begin_layout Subsubsection
1322 bit.flagdecode(number a, number bits, [string on, [string off]])
1325 \begin_layout Standard
1326 Return string of length bits where ith character is ith character of on
1327 if bit i is on, otherwise ith character of off.
1328 Out of range reads give last character, or '*'/'-' if empty.
1331 \begin_layout Subsubsection
1332 bit.rflagdecode(number a, number bits, [string on, [string off]])
1335 \begin_layout Standard
1336 Like bit.flagdecode, but outputs the string in the opposite order (most significa
1340 \begin_layout Subsection
1344 \begin_layout Standard
1345 Most of these functions can only be called in on_paint and on_video callbacks.
1346 Exceptions are noted.
1349 \begin_layout Standard
1351 Bits 0-7 are the blue component, bits 8-15 are the green component, bits
1352 16-23 are the red component, bits 24-31 are alpha component (0 is fully
1353 opaque, 255 is almost transparent).
1354 -1 is the fully transparent color.
1355 Alpha values greater than 127 do work.
1358 \begin_layout Standard
1359 Origin of coordinates is at top left corner of game display area.
1360 Left and top gaps correspond to negative coordinates.
1363 \begin_layout Subsubsection
1367 \begin_layout Standard
1368 Returns 2-tuple (hresolution, vresolution).
1371 \begin_layout Subsubsection
1372 gui.<class>_gap(number gap)
1375 \begin_layout Standard
1376 Set the <class> (left, right, top, bottom) gap to specified value (max gap
1380 \begin_layout Subsubsection
1381 gui.text(number x, number y, string text[, number fgc[, number bgc]])
1384 \begin_layout Standard
1385 Draw specified text on the GUI (each character cell is 8 or 16 wide and
1390 \begin_layout Itemize
1391 x: X-coordinate to start the drawing from (and x-coordinate at begining
1395 \begin_layout Itemize
1396 y: Y-coordinate to start the drawing from.
1399 \begin_layout Itemize
1400 text: The text to draw.
1403 \begin_layout Itemize
1404 fgc: Text color (default is 0xFFFFFF (white))
1407 \begin_layout Itemize
1408 bgc: Background color (default is -1 (transparent))
1411 \begin_layout Subsubsection
1412 gui.textH(number x, number y, string text[, number fgc[, number bgc]])
1415 \begin_layout Standard
1416 Like gui.text, but draw using double-width.
1419 \begin_layout Subsubsection
1420 gui.textV(number x, number y, string text[, number fgc[, number bgc]])
1423 \begin_layout Standard
1424 Like gui.text, but draw using double-height.
1427 \begin_layout Subsubsection
1428 gui.textHV(number x, number y, string text[, number fgc[, number bgc]])
1431 \begin_layout Standard
1432 Like gui.text, but draw using double-width/double-height.
1435 \begin_layout Subsubsection
1436 gui.rectangle(number x, number y, number width, number height[, number thickness[
1437 , number outline[, number fill]]])
1440 \begin_layout Standard
1441 Draw rectangle on the GUI.
1445 \begin_layout Itemize
1446 x: X-coordinate of left edge.
1449 \begin_layout Itemize
1450 y: Y-coordinate of upper edge.
1453 \begin_layout Itemize
1454 width: Width of rectangle.
1457 \begin_layout Itemize
1458 height: Height of rectangle.
1461 \begin_layout Itemize
1462 thickness: Thickness of outline (default is 1).
1465 \begin_layout Itemize
1466 outline: Color of outline (default is 0xFFFFFF (white))
1469 \begin_layout Itemize
1470 fill: Color of fill (default is -1 (transparent))
1473 \begin_layout Subsubsection
1474 gui.box(number x, number y, number width, number height[, number thickness[,
1475 number outline1[,number outline2[, number fill]]]])
1478 \begin_layout Standard
1479 Draw rectangle with 3D effect on the GUI.
1483 \begin_layout Itemize
1484 x: X-coordinate of left edge.
1487 \begin_layout Itemize
1488 y: Y-coordinate of upper edge.
1491 \begin_layout Itemize
1492 width: Width of rectangle.
1495 \begin_layout Itemize
1496 height: Height of rectangle.
1499 \begin_layout Itemize
1500 thickness: Thickness of outline (default is 1).
1503 \begin_layout Itemize
1504 outline1: First color of outline (default is 0xFFFFFF (white))
1507 \begin_layout Itemize
1508 outline2: First color of outline (default is 0x808080 (dark gray))
1511 \begin_layout Itemize
1512 fill: Color of fill (default is 0xC0C0C0 (light grayy))
1515 \begin_layout Subsubsection
1516 gui.pixel(number x, number y[, number color])
1519 \begin_layout Standard
1520 Draw one pixel on the GUI.
1524 \begin_layout Itemize
1525 x: X-coordinate of the pixel
1528 \begin_layout Itemize
1529 y: Y-coordinate of the pixel
1532 \begin_layout Itemize
1533 color: Color of the pixel (default is 0xFFFFFF (white))
1536 \begin_layout Subsubsection
1537 gui.crosshair(number x, number y[, number length[, number color]])
1540 \begin_layout Standard
1545 \begin_layout Itemize
1546 x: X-coordinate of the crosshair
1549 \begin_layout Itemize
1550 y: Y-coordinate of the crosshair
1553 \begin_layout Itemize
1554 length: Length of the crosshair lines (default 10).
1557 \begin_layout Itemize
1558 color: Color of the crosshair (default is 0xFFFFFF (white))
1561 \begin_layout Subsubsection
1562 gui.line(number x1, number y1, number x2, number y2[, number color])
1565 \begin_layout Standard
1570 \begin_layout Itemize
1571 x1: X-coordinate of one end.
1574 \begin_layout Itemize
1575 y1: Y-coordinate of one end.
1578 \begin_layout Itemize
1579 x2: X-coordinate of the other end.
1582 \begin_layout Itemize
1583 y2: Y-coordinate of the other end.
1586 \begin_layout Itemize
1587 color: Color of the line (default is 0xFFFFFF (white)).
1590 \begin_layout Subsubsection
1591 gui.circle(number x, number y, number r[, number thick[, number border[,
1595 \begin_layout Standard
1600 \begin_layout Itemize
1601 x: X-coordinate of the center
1604 \begin_layout Itemize
1605 y: Y-coordinate of the center
1608 \begin_layout Itemize
1609 r: The radius of the circle
1612 \begin_layout Itemize
1613 thick: Border thickness
1616 \begin_layout Itemize
1617 border: Border color (default is 0xFFFFFF (white))
1620 \begin_layout Itemize
1621 fill: Fill color (default is -1 (transparent)).
1624 \begin_layout Subsubsection
1625 gui.bitmap_draw(number x, number y, bitmap bitmap, palette palette)
1628 \begin_layout Standard
1629 Draw a bitmap on screen with specified palette.
1633 \begin_layout Itemize
1634 x: X-coordinate of left edge.
1637 \begin_layout Itemize
1638 y: Y-coordinate of top edge.
1641 \begin_layout Itemize
1642 bitmap: The bitmap to draw
1645 \begin_layout Itemize
1646 palette: The palette to draw the bitmap using.
1649 \begin_layout Subsubsection
1650 gui.bitmap_draw(number x, number y, dbitmap bitmap)
1653 \begin_layout Standard
1654 Draw a bitmap on screen.
1658 \begin_layout Itemize
1659 x: X-coordinate of left edge.
1662 \begin_layout Itemize
1663 y: Y-coordinate of top edge.
1666 \begin_layout Itemize
1667 bitmap: The bitmap to draw
1670 \begin_layout Subsubsection
1674 \begin_layout Standard
1675 Returns a new palette (initially all transparent).
1676 Can be used anywhere.
1679 \begin_layout Subsubsection
1680 gui.bitmap_new(number w, number h, boolean direct[, bool icolor])
1683 \begin_layout Standard
1684 Returns a new bitmap/dbitmap.
1685 Can be used anywhere.
1689 \begin_layout Itemize
1690 w: The width of new bitmap
1693 \begin_layout Itemize
1694 h: The height of new bitmap
1697 \begin_layout Itemize
1698 direct: If true, the returned bitmap is dbitmap, otherwise bitmap.
1701 \begin_layout Itemize
1702 icolor: Initital fill color (defaults to 0 on BITMAP, -1 on DBITMAP)
1705 \begin_layout Subsubsection
1706 gui.bitmap_load(string file)
1709 \begin_layout Standard
1710 Returns loaded bitmap/dbitmap (if bitmap, the second return value is palette
1712 Can be used anywhere.
1716 \begin_layout Itemize
1717 file: The name of file to load.
1720 \begin_layout Subsubsection
1721 gui.palette_set(palette palette, number index, number color)
1724 \begin_layout Standard
1725 Sets color in palette.
1726 Can be used anywhere.
1730 \begin_layout Itemize
1731 palette: The palette to manipulate
1734 \begin_layout Itemize
1735 index: Index of color (0-65535).
1738 \begin_layout Itemize
1739 color: The color value.
1742 \begin_layout Subsubsection
1743 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y, number color)
1746 \begin_layout Standard
1747 Sets specified pixel in bitmap.
1748 Can be used anywhere.
1752 \begin_layout Itemize
1753 bitmap: The bitmap to manipulate
1756 \begin_layout Itemize
1757 x: The x-coordinate of the pixel.
1760 \begin_layout Itemize
1761 y: The y-coordinate of the pixel.
1764 \begin_layout Itemize
1765 color: If bitmap is a bitmap, color index (0-65535).
1766 Otherwise color value.
1769 \begin_layout Subsubsection
1770 gui.bitmap_size(bitmap/dbitmap bitmap)
1773 \begin_layout Standard
1775 Can be used anywhere.
1779 \begin_layout Itemize
1780 bitmap: The bitmap to query.
1783 \begin_layout Standard
1784 The first return is the width, the second is the height.
1787 \begin_layout Subsubsection
1788 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy, bitmap/dbitmap
1789 src, number sx, number sy, number w, number h[, number ck])
1792 \begin_layout Standard
1793 Blit a part of bitmap to another.
1794 Can be used anywhere.
1798 \begin_layout Itemize
1799 dest: Destination to blit to.
1802 \begin_layout Itemize
1803 dx: left edge of target
1806 \begin_layout Itemize
1807 dy: Top edge of target
1810 \begin_layout Itemize
1811 src: The source to blit from.
1812 Must be of the same type as destination.
1815 \begin_layout Itemize
1816 sx: left edge of source
1819 \begin_layout Itemize
1820 sy: Top edge of source
1823 \begin_layout Itemize
1827 \begin_layout Itemize
1828 h: Height of region.
1831 \begin_layout Itemize
1833 Pixels of this color are not blitted.
1837 \begin_layout Itemize
1838 If bitmaps are bitmaps, this is color index of colorkey.
1839 Values outside range 0-65535 cause no key to be used as colorkey.
1842 \begin_layout Itemize
1843 If bitmaps are dbitmaps, this color value of colorkey.
1846 \begin_layout Itemize
1847 May be absent or nil for no colorkey blit.
1851 \begin_layout Subsubsection
1855 \begin_layout Standard
1856 Request on_repaint() to happen as soon as possible.
1857 Can be used anywhere.
1860 \begin_layout Subsubsection
1861 gui.subframe_update(boolean on)
1864 \begin_layout Standard
1865 Request subframe updates (calling on_paint() on subframes) to happen (on=true)
1866 or not happen (on=false).
1867 Can be used anywhere.
1870 \begin_layout Subsubsection
1871 gui.screenshot(string filename)
1874 \begin_layout Standard
1875 Write PNG screenshot of the current frame (no drawings) to specified file.
1876 Can be used anywhere.
1879 \begin_layout Subsubsection
1880 gui.color(number r, number g, number b[, number a])
1883 \begin_layout Standard
1884 Returns color (in notation Lua scripts use) corresponding to color (r,g,b),
1885 each component in scale 0-255.
1886 If a is specified, that is alpha (0 is fully transparent, 256(sic) is fully
1888 The default alpha is 256.
1891 \begin_layout Subsubsection
1892 gui.status(string name, string value)
1895 \begin_layout Standard
1897 \begin_inset Quotes eld
1901 \begin_inset Quotes erd
1904 to <value> in status area.
1905 Can be used anywhere.
1908 \begin_layout Subsubsection
1909 gui.rainbow(number step, number steps[, number color])
1912 \begin_layout Standard
1913 Perform hue rotation of color <color> (default bright red), by <step> steps.
1914 The number of steps per full rotation is given by absolute value of <steps>.
1917 \begin_layout Standard
1918 If <steps> is negative, the rotation will be counterclockwise.
1921 \begin_layout Subsubsection
1922 gui.screenshot(string filename)
1925 \begin_layout Standard
1926 Saves a screenshot into specified file.
1929 \begin_layout Subsubsection
1930 gui.renderq_new(number width, number height)
1933 \begin_layout Standard
1934 Create render queue with specified reported size and return it.
1937 \begin_layout Subsubsection
1938 gui.renderq_clear(RENDERQUEUE queue)
1941 \begin_layout Standard
1942 Clear specified render queue.
1945 \begin_layout Subsubsection
1946 gui.renderq_set(RENDERQUEUE queue)
1949 \begin_layout Standard
1950 Switch to specified render queue.
1951 Use nil as queue to switch to default queue.
1954 \begin_layout Itemize
1955 When switched to another queue, all drawing functions work and draw there,
1956 even outside on_video/on_paint.
1959 \begin_layout Subsubsection
1960 gui.renderq_run(RENDERQUEUE queue)
1963 \begin_layout Standard
1964 Run specified render queue, copying the objects to current render queue.
1968 \begin_layout Itemize
1969 Warning: Don't try to run the current render queue.
1972 \begin_layout Subsubsection
1973 gui.loadfont(string filename)
1976 \begin_layout Standard
1977 Loads font from specified file (CUSTOMFONT object).
1980 \begin_layout Subsubsection
1981 CUSTOMFONT(number x, number y, string text[, number fgc[, number bgc[, number
1985 \begin_layout Standard
1986 Draw string with custom font to screen.
1987 The parameters are the same as in gui.text, except hlc is the halo color
1988 (default is no halo).
1992 \begin_layout Subsection
1996 \begin_layout Standard
1998 Only available in on_input callback.
2001 \begin_layout Subsubsection
2002 input.get(number controller, number index)
2005 \begin_layout Standard
2006 Read the specified index (0-11) from specified controller (0-7).
2010 \begin_layout Itemize
2011 Uses physical controller numbering.
2012 Gamepad in port 2 is controller 4, not 1!
2015 \begin_layout Subsubsection
2016 input.set(number controller, number index, number value)
2019 \begin_layout Standard
2020 Write the specified index (0-11) from specified controller (0-7), storing
2025 \begin_layout Itemize
2026 Uses physical controller numbering.
2027 Gamepad in port 2 is controller 4, not 1!
2030 \begin_layout Subsubsection
2031 input.get2(number port, number controller, number index)
2034 \begin_layout Standard
2035 Read the specified input tuple.
2038 \begin_layout Itemize
2039 Port 0 is system port.
2042 \begin_layout Subsubsection
2043 input.set2(number port, number controller, number index, number value)
2046 \begin_layout Standard
2047 Write the specified input tuple.
2050 \begin_layout Itemize
2051 Port 0 is system port.
2054 \begin_layout Subsubsection
2055 input.lcid_to_pcid2(number lcid)
2058 \begin_layout Standard
2059 Look up physical pcid pair (port, controller) corresponding to specified
2060 logical controller (1-based).
2061 Returns nothing if controller does not exist.
2064 \begin_layout Subsubsection
2065 input.port_type(number port)
2068 \begin_layout Standard
2069 Return type of specified port.
2072 \begin_layout Subsubsection
2073 input.controller_info(number port, number controller)
2076 \begin_layout Standard
2077 Get controller info for specified controller.
2078 If controller does not exist, returns nil.
2079 Otherwise returns a table with following fields:
2082 \begin_layout Itemize
2083 type (string): Type of the controller.
2086 \begin_layout Itemize
2087 class (string): Class of the controller.
2090 \begin_layout Itemize
2091 classnum (number): Number of the controller within its class (1-based)
2094 \begin_layout Itemize
2095 lcid (number): Logical controller number of the controller.
2098 \begin_layout Itemize
2099 button_count (number): Number of buttons on controller
2102 \begin_layout Itemize
2103 buttons (array): Array of following info about each button:
2107 \begin_layout Itemize
2108 type (string): Type of button.
2110 \begin_inset Quotes eld
2114 \begin_inset Quotes erd
2118 \begin_inset Quotes eld
2122 \begin_inset Quotes erd
2126 \begin_inset Quotes eld
2130 \begin_inset Quotes erd
2134 \begin_inset Quotes eld
2138 \begin_inset Quotes erd
2144 \begin_layout Itemize
2145 name (string): Name of button.
2148 \begin_layout Itemize
2149 symbol (string): Symbol of button.
2150 Only present for type
2151 \begin_inset Quotes eld
2155 \begin_inset Quotes erd
2161 \begin_layout Itemize
2162 hidden (boolean): True if hidden button.
2167 \begin_layout Subsubsection
2171 \begin_layout Standard
2172 Signals that the button event should be vetoed.
2173 Only valid in on_button callback.
2176 \begin_layout Subsubsection
2177 input.geta(number controller)
2180 \begin_layout Standard
2181 Get input state for entiere controller.
2182 Returns 13 return values.
2185 \begin_layout Itemize
2186 1st return value: Bitmask: bit i is set if i:th index is nonzero
2189 \begin_layout Itemize
2190 2nd-13th return value: value of i:th index.
2193 \begin_layout Subsubsection
2194 input.seta(number controller, number bitmask, number args...)
2197 \begin_layout Standard
2198 Set state for entiere controller.
2199 args is up to 12 values for indices (overriding values in bitmask if specified).
2202 \begin_layout Subsubsection
2203 input.controllertype(number controller)
2206 \begin_layout Standard
2207 Get the type of controller as string.
2211 \begin_layout Itemize
2215 \begin_layout Itemize
2219 \begin_layout Itemize
2223 \begin_layout Itemize
2227 \begin_layout Subsubsection
2228 input.reset([number cycles])
2231 \begin_layout Standard
2233 If cycles is greater than zero, do delayed reset.
2234 0 (or no value) causes immediate reset.
2237 \begin_layout Itemize
2238 Only available with subframe flag false.
2241 \begin_layout Subsubsection
2245 \begin_layout Standard
2246 Returns table of tables of all available keys and axes.
2247 The first table is indexed by key name (platform-dependent!), and the inner
2248 table has the following fields:
2251 \begin_layout Itemize
2252 value: Last reported value for control
2256 \begin_layout Itemize
2257 For keys: 1 for pressed, 0 for released.
2260 \begin_layout Itemize
2261 For axes: -32767...32767.
2264 \begin_layout Itemize
2265 For presure-sensitive buttons: 0...32767.
2268 \begin_layout Itemize
2269 For hats: Bitmask: 1=>Up, 2=>Right, 4=>Down, 8=>Left.
2272 \begin_layout Itemize
2273 For mouse: Coordinates relative to game area.
2277 \begin_layout Itemize
2278 ktype: Type of key (disabled, key, mouse, axis, axis-inverse, hat, pressure-m0,
2279 pressure-mp, pressure-0m, pressure-0p, pressure-pm, pressure-p0).
2282 \begin_layout Subsubsection
2283 input.keyhook(string key, boolean state)
2286 \begin_layout Standard
2287 Requests that keyhook events to be sent for key (state=true) or not sent
2291 \begin_layout Subsubsection
2292 input.joyget(number controller)
2295 \begin_layout Standard
2296 Returns table for current controls for specified controller.
2297 The names of fields vary by controller type.
2300 \begin_layout Itemize
2301 The buttons have the same name as those are referred to in other contexts
2305 \begin_layout Itemize
2307 \begin_inset Quotes eld
2311 \begin_inset Quotes erd
2315 \begin_inset Quotes eld
2319 \begin_inset Quotes erd
2325 \begin_layout Subsubsection
2326 input.joyset(number controller, table controls)
2329 \begin_layout Standard
2330 Set the the state of specified controller to values specified in specified
2334 \begin_layout Subsubsection
2335 input.lcid_to_pcid(number controller)
2338 \begin_layout Standard
2339 Return the physical index, physical port and controller number in port for
2340 specified (1-based) logical controller.
2343 \begin_layout Subsection
2347 \begin_layout Standard
2348 Various keybinding-related functions
2351 \begin_layout Subsubsection
2352 keyboard.bind(string mod, string mask, string key, string cmd)
2355 \begin_layout Standard
2356 Bind specified key with specified modifers to specified command.
2359 \begin_layout Subsubsection
2360 keyboard.unbind(string mod, string mask, string key)
2363 \begin_layout Standard
2364 Unbind specified key with specified modifers.
2367 \begin_layout Itemize
2368 nil does not change value
2371 \begin_layout Itemize
2372 true/false (buttons) and integers (axes) force value.
2375 \begin_layout Itemize
2376 string (button) inverts the input.
2379 \begin_layout Subsubsection
2380 keyboard.alias(string alias, string expansion)
2383 \begin_layout Standard
2384 Set expansion of given command.
2387 \begin_layout Subsection
2391 \begin_layout Standard
2395 \begin_layout Subsubsection
2396 subtitle.byindex(number i)
2399 \begin_layout Standard
2400 Read the frame and length of ith subtitle.
2401 Returns nothing if not present.
2404 \begin_layout Subsubsection
2405 subtitle.set(number f, number l, string txt)
2408 \begin_layout Standard
2409 Set the text of subtitle.
2412 \begin_layout Subsubsection
2413 subtitle.get(number f, number l)
2416 \begin_layout Standard
2417 Get the text of subtitle.
2420 \begin_layout Subsubsection
2421 subtitle.delete(number f, number l)
2424 \begin_layout Standard
2425 Delete specified subtitle.
2428 \begin_layout Subsection
2432 \begin_layout Standard
2433 Host memory handling (extra memory saved to savestates).
2434 Host memory starts empty.
2437 \begin_layout Subsubsection
2438 hostmemory.read(number address)
2441 \begin_layout Standard
2442 Reads hostmemory slot address.
2443 Slot numbers out of range return false instead of numeric.
2446 \begin_layout Subsubsection
2447 hostmemory.write(number address, number value)
2450 \begin_layout Standard
2451 Writes hostmemory slot with 0-255.
2452 Slot numbers out of range cause extension of host memory slot space.
2455 \begin_layout Subsubsection
2456 hostmemory.readbyte(number address)
2459 \begin_layout Standard
2460 Read unsigned byte (1 element) from given address.
2461 Slots out of range return false.
2464 \begin_layout Subsubsection
2465 hostmemory.writebyte(number address, number value)
2468 \begin_layout Standard
2469 Write unsigned byte (1 element) to given slot.
2470 Slot numbers out of range cause extension.
2473 \begin_layout Subsubsection
2474 hostmemory.readsbyte(number address)
2477 \begin_layout Standard
2478 Read signed byte (1 element) from given address.
2479 Slots out of range return false.
2482 \begin_layout Subsubsection
2483 hostmemory.writesbyte(number address, number value)
2486 \begin_layout Standard
2487 Write signed byte (1 element) to given slot.
2488 Slot numbers out of range cause extension.
2491 \begin_layout Subsubsection
2492 hostmemory.readword(number address)
2495 \begin_layout Standard
2496 Read unsigned word (2 elements) from given address.
2497 Slots out of range return false.
2500 \begin_layout Subsubsection
2501 hostmemory.writeword(number address, number value)
2504 \begin_layout Standard
2505 Write unsigned word (2 elements) to given slot.
2506 Slot numbers out of range cause extension.
2509 \begin_layout Subsubsection
2510 hostmemory.readsword(number address)
2513 \begin_layout Standard
2514 Read signed word (2 elements) from given address.
2515 Slots out of range return false.
2518 \begin_layout Subsubsection
2519 hostmemory.writesword(number address, number value)
2522 \begin_layout Standard
2523 Write signed word (2 elements) to given slot.
2524 Slot numbers out of range cause extension.
2527 \begin_layout Subsubsection
2528 hostmemory.readdword(number address)
2531 \begin_layout Standard
2532 Read unsigned doubleword (4 elements) from given address.
2533 Slots out of range return false.
2536 \begin_layout Subsubsection
2537 hostmemory.writedword(number address, number value)
2540 \begin_layout Standard
2541 Write unsigned doubleword (4 elements) to given slot.
2542 Slot numbers out of range cause extension.
2545 \begin_layout Subsubsection
2546 hostmemory.readsdword(number address)
2549 \begin_layout Standard
2550 Read signed doubleword (4 elements) from given address.
2551 Slots out of range return false.
2554 \begin_layout Subsubsection
2555 hostmemory.writesdword(number address, number value)
2558 \begin_layout Standard
2559 Write signed doubleword (4 elements) to given slot.
2560 Slot numbers out of range cause extension.
2563 \begin_layout Subsubsection
2564 hostmemory.readqword(number address)
2567 \begin_layout Standard
2568 Read unsigned quadword (8 elements) from given address.
2569 Slots out of range return false.
2572 \begin_layout Subsubsection
2573 hostmemory.writeqword(number address, number value)
2576 \begin_layout Standard
2577 Write unsigned quadword (4 elements) to given slot.
2578 Slot numbers out of range cause extension.
2581 \begin_layout Subsubsection
2582 hostmemory.readsqword(number address)
2585 \begin_layout Standard
2586 Read signed quadword (8 elements) from given address.
2587 Slots out of range return false.
2590 \begin_layout Subsubsection
2591 hostmemory.writesqword(number address, number value)
2594 \begin_layout Standard
2595 Write signed quadword (8 elements) to given slot.
2596 Slot numbers out of range cause extension.
2599 \begin_layout Subsection
2603 \begin_layout Standard
2607 \begin_layout Subsubsection
2608 movie.currentframe()
2611 \begin_layout Standard
2612 Return number of current frame.
2615 \begin_layout Subsubsection
2619 \begin_layout Standard
2620 Return number of frames in movie.
2623 \begin_layout Subsubsection
2627 \begin_layout Standard
2628 Return true if in readonly mode, false if in readwrite.
2631 \begin_layout Subsubsection
2635 \begin_layout Standard
2636 Returns the current value of rerecord count.
2639 \begin_layout Subsubsection
2640 movie.set_readwrite()
2643 \begin_layout Standard
2644 Set readwrite mode (does not cause on_readwrite callback).
2647 \begin_layout Subsubsection
2648 movie.frame_subframes(number frame)
2651 \begin_layout Standard
2652 Count number of subframes in specified frame (frame numbers are 1-based)
2656 \begin_layout Subsubsection
2657 movie.read_subframes(number frame, number subframe)
2660 \begin_layout Standard
2661 Read specifed subframe in specified frame and return data as array (100
2662 elements, numbered 0-99 currently).
2665 \begin_layout Subsubsection
2669 \begin_layout Standard
2670 Returns the current value of the RTC as a pair (second, subsecond).
2673 \begin_layout Subsubsection
2674 movie.unsafe_rewind([UNSAFEREWIND state])
2677 \begin_layout Standard
2678 Start setting point for unsafe rewind or jump to point of unsafe rewind.
2681 \begin_layout Itemize
2682 If called without argument, causes emulator to start process of setting
2683 unsafe rewind point.
2684 When this has finished, callback on_set_rewind occurs, passing the rewind
2685 state to lua script.
2688 \begin_layout Itemize
2689 If called with argument, causes emulator rewind to passed rewind point as
2691 Readwrite mode is implicitly activated.
2694 \begin_layout Standard
2695 The following warnings apply to unsafe rewinding:
2698 \begin_layout Itemize
2699 There are no safety checks against misuse (that's what
2700 \begin_inset Quotes eld
2704 \begin_inset Quotes erd
2710 \begin_layout Itemize
2711 Only call rewind from timeline rewind point was set from.
2714 \begin_layout Itemize
2715 Only call rewind from after the rewind point was set.
2718 \begin_layout Subsection
2722 \begin_layout Standard
2723 Routines for settings manipulation
2726 \begin_layout Subsubsection
2727 settings.get(string name)
2730 \begin_layout Standard
2731 Get value of setting.
2732 If setting is blank, returns false.
2733 If setting value can't be obtained, returns (nil, error message).
2736 \begin_layout Subsubsection
2737 settings.set(string name, string value)
2740 \begin_layout Standard
2741 Set value of setting.
2742 If setting can't be set, returns (nil, error message).
2745 \begin_layout Subsubsection
2746 settings.is_set(string name)
2749 \begin_layout Standard
2750 Returns if setting is set.
2751 If setting does not exist, returns (nil, error message).
2754 \begin_layout Subsubsection
2755 settings.blank(string name)
2758 \begin_layout Standard
2759 Blanks a setting and returns true.
2760 If setting can't be blanked, returns (nil, error message).
2763 \begin_layout Subsection
2767 \begin_layout Standard
2768 Contains various functions for managing memory
2771 \begin_layout Subsubsection
2775 \begin_layout Standard
2776 Returns the number of VMAs
2779 \begin_layout Subsubsection
2780 memory.read_vma(number index)
2783 \begin_layout Standard
2784 Reads the specified VMA (indices start from zero).
2785 Trying to read invalid VMA gives nil.
2786 The read VMA is table with the following fields:
2789 \begin_layout Itemize
2790 region_name (string): The readable name of the VMA
2793 \begin_layout Itemize
2794 baseaddr (number): Base address of the VMA
2797 \begin_layout Itemize
2798 lastaddr (number): Last address in the VMA.
2801 \begin_layout Itemize
2802 size (number): The size of VMA in bytes.
2805 \begin_layout Itemize
2806 readonly (boolean): True of the VMA corresponds to ROM.
2809 \begin_layout Itemize
2810 iospace (boolean): True if the VMA is I/O space.
2813 \begin_layout Itemize
2814 native_endian (boolean): True if the VMA has native endian as opposed to
2818 \begin_layout Subsubsection
2819 memory.find_vma(number address)
2822 \begin_layout Standard
2823 Finds the VMA containing specified address.
2824 Returns table in the same format as read_vma or nil if not found.
2827 \begin_layout Subsubsection
2828 memory.readbyte(number address)
2831 \begin_layout Standard
2832 Reads the specified address as unsigned byte and returns the result.
2835 \begin_layout Subsubsection
2836 memory.readsbyte(number address)
2839 \begin_layout Standard
2840 Reads the specified address as signed byte and returns the result.
2843 \begin_layout Subsubsection
2844 memory.writebyte(number address, number value)
2847 \begin_layout Standard
2848 Writes the specified value (negative values undergo 2's complement) to specified
2849 address (as a byte).
2852 \begin_layout Subsubsection
2853 memory.readword(number address)
2856 \begin_layout Standard
2857 Reads the specified address as unsigned word and returns the result.
2860 \begin_layout Subsubsection
2861 memory.readsword(number address)
2864 \begin_layout Standard
2865 Reads the specified address as signed word and returns the result.
2868 \begin_layout Subsubsection
2869 memory.writeword(number address, number value)
2872 \begin_layout Standard
2873 Writes the specified value (negative values undergo 2's complement) to specified
2874 address (as a word).
2877 \begin_layout Subsubsection
2878 memory.readdword(number address)
2881 \begin_layout Standard
2882 Reads the specified address as unsigned doubleword and returns the result.
2885 \begin_layout Subsubsection
2886 memory.readsdword(number address)
2889 \begin_layout Standard
2890 Reads the specified address as signed doubleword and returns the result.
2893 \begin_layout Subsubsection
2894 memory.writedword(number address, number value)
2897 \begin_layout Standard
2898 Writes the specified value (negative values undergo 2's complement) to specified
2899 address (as a doubleword).
2902 \begin_layout Subsubsection
2903 memory.readqword(number address)
2906 \begin_layout Standard
2907 Reads the specified address as unsigned quadword and returns the result.
2910 \begin_layout Subsubsection
2911 memory.readsqword(number address)
2914 \begin_layout Standard
2915 Reads the specified address as signed quadword and returns the result.
2918 \begin_layout Subsubsection
2919 memory.writeqword(number address, number value)
2922 \begin_layout Standard
2923 Writes the specified value (negative values undergo 2's complement) to specified
2924 address (as a quadword).
2927 \begin_layout Subsubsection
2928 memory.hash_region(number base, number size)
2931 \begin_layout Standard
2932 Hash specified number of bytes starting from specified address and return
2936 \begin_layout Subsubsection
2940 \begin_layout Standard
2941 Hash the current system state.
2942 Mainly useful for debugging savestates.
2945 \begin_layout Subsubsection
2946 memory.readregion(number base, number size)
2949 \begin_layout Standard
2950 Read a region of memory.
2953 \begin_layout Itemize
2954 Warning: If the region crosses VMA boundary, the results are undefined.
2957 \begin_layout Subsubsection
2958 memory.map<type>([number base, number size])
2961 \begin_layout Standard
2962 Returns a table mapping specified memory aperture for read/write.
2963 If parameters are omitted, entiere map space is the aperture.
2966 \begin_layout Itemize
2967 Type may be one of: byte, sbyte, word, sword, dword, sdword, qword or sqword.
2970 \begin_layout Subsubsection
2971 memory.writeregion(number base, number size, table data)
2974 \begin_layout Standard
2975 Write a region of memory.
2978 \begin_layout Itemize
2979 Warning: If the region crosses VMA boundary, the results are undefined.
2982 \begin_layout Subsubsection
2983 memory.map_structure()
2986 \begin_layout Standard
2987 Returns a new mapping structure (MMAP_STRUCT)
2990 \begin_layout Subsubsection
2991 MMAP_STRUCT(string key, number address, string type)
2994 \begin_layout Standard
2995 Bind key in mmap structure to specified address with specified type.
2998 \begin_layout Itemize
2999 Type may be one of: byte, sbyte, word, sword, dword, sdword, qword or sqword.
3002 \begin_layout Subsubsection
3003 memory.read_expr(string expr)
3006 \begin_layout Standard
3007 Evaluate specified watch expression and return result
3010 \begin_layout Subsection
3014 \begin_layout Standard
3015 Contains functions for manipulating subtitles.
3018 \begin_layout Subsubsection
3019 subtitle.byindex(number index)
3022 \begin_layout Standard
3023 Get (basetime, length) pair of specified subtitle index or nothing if index
3027 \begin_layout Subsubsection
3028 subtitle.get(number basetime, number length)
3031 \begin_layout Standard
3032 Read the specified subtitle.
3034 \begin_inset Quotes eld
3038 \begin_inset Quotes erd
3041 if the subtitle does not exist.
3044 \begin_layout Subsubsection
3045 subtitle.set(number basetime, number length, string content)
3048 \begin_layout Standard
3049 Set the specified subtitle.
3052 \begin_layout Subsubsection
3053 subtitle.deltete(number basetime, number length)
3056 \begin_layout Standard
3057 Delete the specified subtitle.
3060 \begin_layout Subsection
3064 \begin_layout Standard
3065 Contains copy of global variables from time of Lua initialization.
3069 \begin_layout Subsection
3073 \begin_layout Standard
3074 Various callbacks to Lua that can occur.
3077 \begin_layout Subsubsection
3078 Callback: on_paint(bool not_synth)
3081 \begin_layout Standard
3082 Called when screen is being painted.
3083 Any gui.* calls requiring graphic context draw on the screen.
3086 \begin_layout Standard
3087 not_synth is true if this hook is being called in response to received frame,
3091 \begin_layout Subsubsection
3092 Callback: on_video()
3095 \begin_layout Standard
3096 Called when video dump frame is being painted.
3097 Any gui.* calls requiring graphic context draw on the video.
3100 \begin_layout Subsubsection
3101 Callback: on_frame_emulated()
3104 \begin_layout Standard
3105 Called when emulating frame has completed and on_paint()/on_video() calls
3106 are about to be issued.
3109 \begin_layout Subsubsection
3110 Callback: on_frame()
3113 \begin_layout Standard
3114 Called on each starting whole frame.
3117 \begin_layout Subsubsection
3118 Callback: on_startup()
3121 \begin_layout Standard
3122 Called when the emulator is starting (lsnes.rc and --run files has been run).
3125 \begin_layout Subsubsection
3126 Callback: on_rewind()
3129 \begin_layout Standard
3130 Called when rewind movie to beginning has completed.
3133 \begin_layout Subsubsection
3134 Callback: on_pre_load(string name)
3137 \begin_layout Standard
3138 Called just before savestate/movie load occurs (note: loads are always delayed,
3139 so this occurs even when load was initiated by lua).
3142 \begin_layout Subsubsection
3143 Callback: on_err_load(string name)
3146 \begin_layout Standard
3147 Called if loadstate goes wrong.
3150 \begin_layout Subsubsection
3151 Callback: on_post_load(string name, boolean was_savestate)
3154 \begin_layout Standard
3155 Called on successful loadstate.
3156 was_savestate gives if this was a savestate or a movie.
3159 \begin_layout Subsubsection
3160 Callback: on_pre_save(string name, boolean is_savestate)
3163 \begin_layout Standard
3164 Called just before savestate save occurs (note: movie saves are synchronous
3165 and won't trigger these callbacks if called from Lua).
3168 \begin_layout Subsubsection
3169 Callback: on_err_save(string name)
3172 \begin_layout Standard
3173 Called if savestate goes wrong.
3176 \begin_layout Subsubsection
3177 Callback: on_post_save(string name, boolean is_savestate)
3180 \begin_layout Standard
3181 Called on successful savaestate.
3182 is_savestate gives if this was a savestate or a movie.
3185 \begin_layout Subsubsection
3189 \begin_layout Standard
3190 Called when emulator is shutting down.
3193 \begin_layout Subsubsection
3194 Callback: on_input(boolean subframe)
3197 \begin_layout Standard
3198 Called when emulator is just sending input to bsnes core.
3199 Warning: This is called even in readonly mode, but the results are ignored.
3202 \begin_layout Subsubsection
3203 Callback: on_reset()
3206 \begin_layout Standard
3207 Called when SNES is reset.
3210 \begin_layout Subsubsection
3211 Callback: on_readwrite()
3214 \begin_layout Standard
3215 Called when moving into readwrite mode as result of
3216 \begin_inset Quotes eld
3220 \begin_inset Quotes erd
3223 command (note: moving to rwmode by Lua won't trigger this, as per recursive
3227 \begin_layout Subsubsection
3228 Callback: on_snoop(number port, number controller, number index, number
3232 \begin_layout Standard
3233 Called each time bsnes asks for input.
3234 The value is the final value to be sent to bsnes core (readonly mode, autohold
3235 and autofire have been taken into account).
3236 Might be useful when translating movies to format suitable for console
3238 Note: There is no way to modify the value to be sent.
3241 \begin_layout Itemize
3242 Not called if callback on_snoop2 is defined.
3245 \begin_layout Subsubsection
3246 Callback: on_snoop2(number port, number controller, number index, number
3250 \begin_layout Standard
3251 Like on_snoop, but reserves port 0 for system, having first user port be
3255 \begin_layout Subsubsection
3256 Callback: on_keyhook(string keyname, table state)
3259 \begin_layout Standard
3260 Sent when key that has keyhook events requested changes state.
3261 Keyname is name of the key (group) and state is the state (same kind as
3262 table values in input.raw).
3265 \begin_layout Subsubsection
3269 \begin_layout Standard
3270 Called when requested by set_idle_timeout(), the timeout has expired and
3271 emulator is waiting.
3274 \begin_layout Subsubsection
3275 Callback: on_timer()
3278 \begin_layout Standard
3279 Called when requested by set_idle_timeout() and the timeout has expired
3280 (regardless if emulator is waiting).
3283 \begin_layout Subsubsection
3284 Callback: on_set_rewind(UNSAFEREWIND r)
3287 \begin_layout Standard
3288 Called when unsafe rewind object has been constructed.
3291 \begin_layout Subsubsection
3292 Callback: on_pre_rewind()
3295 \begin_layout Standard
3296 Called just before unsafe rewind is about to occur.
3299 \begin_layout Subsubsection
3300 Callback: on_post_rewind()
3303 \begin_layout Standard
3304 Called just after unsafe rewind has occured.
3307 \begin_layout Subsubsection
3308 Callback: on_button(number port, number controller, number index, string
3312 \begin_layout Standard
3313 Called on controller button press, with following parameters:
3316 \begin_layout Itemize
3317 port: Port number (0 is system)
3320 \begin_layout Itemize
3321 controller: Controller within port
3324 \begin_layout Itemize
3325 index: Index of button.
3328 \begin_layout Itemize
3329 type: Type of event, one of:
3333 \begin_layout Itemize
3334 \begin_inset Quotes eld
3338 \begin_inset Quotes erd
3341 : Button was pressed.
3344 \begin_layout Itemize
3345 \begin_inset Quotes eld
3349 \begin_inset Quotes erd
3352 : Button was released.
3355 \begin_layout Itemize
3356 \begin_inset Quotes eld
3360 \begin_inset Quotes erd
3366 \begin_layout Itemize
3367 \begin_inset Quotes eld
3371 \begin_inset Quotes erd
3374 : Released from hold.
3377 \begin_layout Itemize
3378 \begin_inset Quotes eld
3382 \begin_inset Quotes erd
3385 : Typing input on button.
3388 \begin_layout Itemize
3389 \begin_inset Quotes eld
3393 \begin_inset Quotes erd
3396 : Typing input undone.
3399 \begin_layout Itemize
3400 \begin_inset Quotes eld
3403 autofire <duty> <cycle>
3404 \begin_inset Quotes erd
3407 : Autofire with specifie duty and cycle.
3410 \begin_layout Itemize
3411 \begin_inset Quotes eld
3415 \begin_inset Quotes erd
3421 \begin_layout Itemize
3422 \begin_inset Quotes eld
3426 \begin_inset Quotes erd
3429 : Analog action on axis.
3433 \begin_layout Section
3437 \begin_layout Itemize
3438 The editor edits in-memory movie.
3441 \begin_layout Itemize
3442 Because past can't be edited and readwrite mode doesn't allow future, editing
3450 \begin_layout Itemize
3451 Keyboard triggers the normal hotkeys and bindings.
3454 \begin_layout Subsection
3458 \begin_layout Itemize
3459 Clicking on cell in future (indicated by lack of redish background) toggles
3460 it (if it is a button) or prompts for a value (if it is an axis)
3463 \begin_layout Itemize
3464 Dragging vertically toggles sequence of buttons or changes a sequence of
3468 \begin_layout Subsection
3469 Right button actions
3472 \begin_layout Standard
3473 The right mouse button pops up a context-sensitive menu:
3476 \begin_layout Itemize
3477 Toggle <something>: Toggle this button
3480 \begin_layout Itemize
3481 Change <something>: Change this axis value
3484 \begin_layout Itemize
3485 Insert frame after: Insert a frame after this frame
3488 \begin_layout Itemize
3489 Append frame: Append a frame to movie
3492 \begin_layout Itemize
3493 Append frames: Append specified number of frames to movie
3496 \begin_layout Itemize
3497 Delete frame: Delete this frame
3500 \begin_layout Itemize
3501 Delete subframe: Delete this subframe
3504 \begin_layout Itemize
3505 Truncate movie: Delete this subframe and everything after it.
3508 \begin_layout Itemize
3509 Scroll to frame: Prompt for a frame and scroll the display to that frame.
3512 \begin_layout Itemize
3513 Scroll to current frame: Scroll the display to current position
3516 \begin_layout Itemize
3517 Run to frame: Prompts for frame and runs the emulation to that frame.
3520 \begin_layout Itemize
3521 Change number of lines visible: Change the height of the movie display (1
3525 \begin_layout Itemize
3526 Lock scroll to playback: While playing back or rewinding movies, the display
3527 will follow if enabled.
3530 \begin_layout Section
3531 Memory watch expression syntax
3534 \begin_layout Standard
3535 Memory watch expressions are in RPN (Reverse Polish Notation).
3536 At the end of expression, the top entry on stack is taken as the final
3540 \begin_layout Standard
3544 \begin_layout Itemize
3545 Evaluation order is strictly left to right.
3548 \begin_layout Itemize
3549 a is the entry on top of stack
3552 \begin_layout Itemize
3553 b is the entry immediately below top of stack
3556 \begin_layout Itemize
3557 ; separates values to be pushed (no intermediate pop).
3560 \begin_layout Itemize
3561 After end of element, all used stack slots are popped and all results are
3565 \begin_layout Itemize
3566 When pushing multiple values, the pushes occur in order shown.
3569 \begin_layout Standard
3570 The following operators are available:
3573 \begin_layout Itemize
3577 \begin_layout Itemize
3581 \begin_layout Itemize
3585 \begin_layout Itemize
3589 \begin_layout Itemize
3593 \begin_layout Itemize
3597 \begin_layout Itemize
3598 b : read_signed_byte(a)
3601 \begin_layout Itemize
3605 \begin_layout Itemize
3606 d : read_signed_dword(a)
3609 \begin_layout Itemize
3613 \begin_layout Itemize
3615 \begin_inset Formula $\pi$
3621 \begin_layout Itemize
3622 q : read_signed_qword(a)
3625 \begin_layout Itemize
3629 \begin_layout Itemize
3633 \begin_layout Itemize
3637 \begin_layout Itemize
3641 \begin_layout Itemize
3642 w : read_signed_word(a)
3645 \begin_layout Itemize
3649 \begin_layout Itemize
3650 B : read_unsigned_byte(a)
3653 \begin_layout Itemize
3654 C<number>z : Push number <number> to stack.
3657 \begin_layout Itemize
3658 D : read_unsigned_dword(a)
3661 \begin_layout Itemize
3662 C0x<number>z : Push number <number> (hexadecimal) to stack.
3665 \begin_layout Itemize
3666 H<digit> : Set hexadecimal mode with specified number of digits (use A-G
3670 \begin_layout Itemize
3671 Q : read_unsigned_qword(a)
3674 \begin_layout Itemize
3675 R<digit> : round a to <digit> digits.
3678 \begin_layout Itemize
3679 W : read_unsigned_word(a)
3682 \begin_layout Subsection
3686 \begin_layout Standard
3687 C0x007e0878zWC0x007e002czW-
3690 \begin_layout Enumerate
3691 Push value 0x7e0878 on top of stack (C0x007e0878z).
3694 \begin_layout Enumerate
3695 Pop the value on top of stack (0x7e0878), read word value at that address
3696 and push the result,call it x1 (W).
3699 \begin_layout Enumerate
3700 Push value 0x7e002c on top of stack (C0x007e002cz).
3703 \begin_layout Enumerate
3704 Pop the value on top of stack (0x7e002c), read word value at that address
3705 and push the result,call it x2 (W).
3708 \begin_layout Enumerate
3709 Pop the two top numbers on stack, x1 and x2, substract x1 from x2 and push
3713 \begin_layout Enumerate
3714 Since the expression ends, the final memory watch result is the top one
3715 on stack, which is x2 - x1.
3718 \begin_layout Section
3719 Modifier and key names:
3722 \begin_layout Subsection
3726 \begin_layout Subsubsection
3730 \begin_layout Standard
3731 Following modifier names are known:
3734 \begin_layout Itemize
3738 \begin_layout Itemize
3742 \begin_layout Itemize
3746 \begin_layout Itemize
3750 \begin_layout Itemize
3754 \begin_layout Subsubsection
3758 \begin_layout Standard
3759 Following key names are known:
3762 \begin_layout Itemize
3763 back, tab, return, escape, space, exclaim, quotedbl, hash, dollar, percent,
3764 ampersand, quote, leftparen, rightparen, asterisk, plus, comma, minus,
3765 period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
3766 greater, question, at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3767 q, r, s, t, u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
3768 underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3769 q, r, s, t, u, v, w, x, y, z, leftcurly, pipe, rightcurly, tilde, delete,
3770 start, lbutton, rbutton, cancel, mbutton, clear, shift, alt, control, menu,
3771 pause, capital, end, home, lefT, up, right, down, select, print, execute,
3772 snapshot, insert, help, numpad0, numpad1, numpad2, numpad3, numpad4, numpad5,
3773 numpad6, numpad7, numpad8, numpad9, multiply, add, separator, subtract,
3774 decimal, divide, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13,
3775 f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, numlock, scroll,
3776 pageup, pagedown, numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
3777 numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up, numpad_right,
3778 numpad_down, numpad_pageup, numpad_pagedown, numpad_end, numpad_begin,
3779 numpad_insert, numpad_delete, numpad_equal, numpad_multiply, numpad_add,
3780 numpad_separator, numpad_subtract, numpad_decimal, numpad_divide, windows_left,
3781 windows_right, windows_menu, command, special1, special2, special3, special4,
3782 special5, special6, special7, special8, special9, special10, special11,
3783 special12, special13, special14, special15, special16, special17, special18,
3784 special19, special20
3787 \begin_layout Section
3791 \begin_layout Standard
3792 Movie file is .zip archive in itself, normal ZIP archive tools work on it
3793 (note: If you recompress it, do not use compression methods other than
3794 store and deflate and especially do not use encryption of any kind).
3797 \begin_layout Subsection
3798 Detecting clean start/SRAM/Savestate
3801 \begin_layout Itemize
3803 \begin_inset Quotes eld
3807 \begin_inset Quotes erd
3810 it is savestate, otherwise:
3813 \begin_layout Itemize
3814 If file has members with names starting
3815 \begin_inset Quotes eld
3819 \begin_inset Quotes erd
3822 it is movie starting from SRAM, otherwise:
3825 \begin_layout Itemize
3826 It is movie starting from clear state.
3829 \begin_layout Subsection
3833 \begin_layout Standard
3834 Type of game ROM and region (as one line).
3838 \begin_layout Standard
3839 \begin_inset Tabular
3840 <lyxtabular version="3" rows="8" columns="3">
3841 <features tabularvalignment="middle">
3842 <column alignment="center" valignment="top" width="0">
3843 <column alignment="center" valignment="top" width="0">
3844 <column alignment="center" valignment="top" width="0">
3846 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3849 \begin_layout Plain Layout
3855 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3858 \begin_layout Plain Layout
3864 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3867 \begin_layout Plain Layout
3875 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3878 \begin_layout Plain Layout
3884 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3887 \begin_layout Plain Layout
3893 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3896 \begin_layout Plain Layout
3904 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3907 \begin_layout Plain Layout
3913 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3916 \begin_layout Plain Layout
3922 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3925 \begin_layout Plain Layout
3933 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3936 \begin_layout Plain Layout
3942 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3945 \begin_layout Plain Layout
3951 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3954 \begin_layout Plain Layout
3962 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3965 \begin_layout Plain Layout
3971 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3974 \begin_layout Plain Layout
3980 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3983 \begin_layout Plain Layout
3991 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3994 \begin_layout Plain Layout
4000 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4003 \begin_layout Plain Layout
4009 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4012 \begin_layout Plain Layout
4020 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4023 \begin_layout Plain Layout
4029 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4032 \begin_layout Plain Layout
4038 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4041 \begin_layout Plain Layout
4049 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4052 \begin_layout Plain Layout
4058 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4061 \begin_layout Plain Layout
4067 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4070 \begin_layout Plain Layout
4084 \begin_layout Standard
4088 \begin_layout Standard
4089 \begin_inset Tabular
4090 <lyxtabular version="3" rows="3" columns="2">
4091 <features tabularvalignment="middle">
4092 <column alignment="center" valignment="top" width="0">
4093 <column alignment="center" valignment="top" width="0">
4095 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4098 \begin_layout Plain Layout
4104 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4107 \begin_layout Plain Layout
4115 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4118 \begin_layout Plain Layout
4124 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4127 \begin_layout Plain Layout
4135 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4138 \begin_layout Plain Layout
4144 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4147 \begin_layout Plain Layout
4161 \begin_layout Subsection
4165 \begin_layout Standard
4166 Contains type of port #1 (as one line).
4167 Valid values are 'none', 'gamepad', 'multitap' and 'mouse'.
4168 If not present, defaults to 'gamepad'.
4171 \begin_layout Subsection
4175 \begin_layout Standard
4176 Contains type of port #2 (as one line).
4177 Valid values are 'none', 'gamepad', 'multitap', 'mouse', 'superscope',
4178 'justifier' and 'justifiers'.
4179 If not present, defaults to 'none'.
4182 \begin_layout Subsection
4186 \begin_layout Standard
4187 Contains name of the game (as one line).
4190 \begin_layout Subsection
4194 \begin_layout Standard
4195 Contains authors, one per line.
4196 Part before '|' is the full name, part after is the nickname.
4199 \begin_layout Subsection
4203 \begin_layout Standard
4205 \begin_inset Quotes eld
4209 \begin_inset Quotes erd
4213 Used to reject other saves.
4216 \begin_layout Subsection
4217 Member: controlsversion
4220 \begin_layout Standard
4222 \begin_inset Quotes eld
4226 \begin_inset Quotes erd
4230 Used to identify what controls are there.
4233 \begin_layout Subsection
4235 \begin_inset Quotes eld
4239 \begin_inset Quotes erd
4245 \begin_layout Standard
4246 Contains bsnes core version number (as one line).
4249 \begin_layout Subsection
4253 \begin_layout Standard
4254 Contains project ID (as one line).
4255 Used to identify if two movies are part of the same project.
4258 \begin_layout Subsection
4259 Member: {rom,slota,slotb}{,xml}.sha256
4262 \begin_layout Standard
4263 Contains SHA-256 of said ROM or ROM mapping file (as one line).
4264 Absent if corresponding file is absent.
4267 \begin_layout Subsection
4268 Member: moviesram.<name>
4271 \begin_layout Standard
4272 Raw binary startup SRAM of kind <name>.
4273 Only present in savestates and movies starting from SRAM.
4276 \begin_layout Subsection
4280 \begin_layout Standard
4281 Contains frame number (as one line) of frame movie was saved on.
4282 Only present in savestates.
4285 \begin_layout Subsection
4289 \begin_layout Standard
4290 Current value of lag counter (as one line).
4291 Only present in savestates.
4294 \begin_layout Subsection
4295 Member: pollcounters
4298 \begin_layout Standard
4299 Contains poll counters (currently 100 of them), one per line.
4300 Each line is raw poll count if DRDY is set for it.
4301 Otherwise it is negative poll count minus one.
4302 Only present in savestates.
4305 \begin_layout Subsection
4309 \begin_layout Standard
4310 Raw binary dump of host memory.
4311 Only present in savestates.
4314 \begin_layout Subsection
4318 \begin_layout Standard
4319 The raw binary savestate itself.
4320 Savestate detection uses this file, only present in savestates.
4323 \begin_layout Subsection
4327 \begin_layout Standard
4328 Screenshot of current frame.
4329 Only present in savestates.
4330 First 2 bytes are big-endian width of image, rest are 24-bit RGB image
4332 Height of image is inferred from the width and size of data.
4335 \begin_layout Subsection
4339 \begin_layout Standard
4340 Raw binary SRAM of kind <name> at time of savestate.
4341 Only present in savestates.
4344 \begin_layout Subsection
4348 \begin_layout Standard
4349 The actual input track, one line per subframe (blank lines are skipped).
4352 \begin_layout Itemize
4353 If the first byte of each line is '.', ' ', <tab> or '|', then the line is
4354 part of same frame as previous, otherwise it starts a new frame.
4357 \begin_layout Itemize
4358 First subframe must start a new frame.
4361 \begin_layout Standard
4362 Length of movie in frames is number of lines in input file that start a
4366 \begin_layout Subsection
4370 \begin_layout Standard
4375 \begin_layout Itemize
4376 Each line is in form <firstframe> <numframes> <text>.
4379 \begin_layout Itemize
4380 Linefeed is encoded as
4382 n, backslash is encoded as
4389 \begin_layout Subsection
4393 \begin_layout Standard
4394 Contains textual base-10 rerecord count (as one line; emulator just writes
4395 this, it doesn't read it) + 1.
4398 \begin_layout Subsection
4402 \begin_layout Standard
4403 This member stores set of load IDs.
4404 There is one load ID per rerecord (plus one corresponding to start of project).
4407 \begin_layout Itemize
4408 This member constists of concatenation of records
4411 \begin_layout Itemize
4412 Each record is 2-36 bytes long and can represent 1-16,843,009 consequtive
4416 \begin_layout Itemize
4417 IDs are interpretted as 256-bit big-endian integers with warparound.
4420 \begin_layout Itemize
4421 Initial predicted ID is all zeroes.
4424 \begin_layout Standard
4425 Format of each record is:
4428 \begin_layout Itemize
4429 1 byte: Opcode byte.
4430 Bits 0-4 are prefix length (prefixlen), bits 5-6 are count length (countlen).
4434 \begin_layout Itemize
4435 32-prefixlen bytes of ID.
4438 \begin_layout Itemize
4439 countlen bytes of big-endian count (count).
4442 \begin_layout Standard
4443 Records are processed as follows:
4446 \begin_layout Itemize
4447 To form the first ID encoded by record, take the first prefixlen bytes predicted
4448 ID and append the read ID value to it.
4449 The result is the first ID encoded.
4452 \begin_layout Itemize
4453 If countlen is 0, record encodes 1 ID.
4456 \begin_layout Itemize
4457 If countlen is 1, record encodes 2+count IDs.
4460 \begin_layout Itemize
4461 If countlen is 2, record encodes 258+count IDs.
4464 \begin_layout Itemize
4465 If countlen is 3, record encodes 65794+count IDs.
4468 \begin_layout Itemize
4469 The new predicted ID is the next ID after last one encoded by the record.
4472 \begin_layout Standard
4473 The number of rerecords + 1 is equal to the sum of number of IDs encoded
4477 \begin_layout Subsection
4478 Member: starttime.second
4481 \begin_layout Standard
4482 Movie starting time, second part.
4483 Epoch is Unix epoch.
4484 Default is 1,000,000,000.
4487 \begin_layout Subsection
4488 Member: starttime.subsecond
4491 \begin_layout Standard
4492 Movie starting time, subsecond part.
4497 \begin_layout Subsection
4498 Member: savetime.second
4501 \begin_layout Standard
4502 Movie saving time, second part.
4503 Default is starttime.second.
4504 Only present in savestates.
4507 \begin_layout Subsection
4508 Member: savetime.subsecond
4511 \begin_layout Standard
4512 Movie saving time, subsecond part.
4513 Default is starttime.subsecond.
4514 Only present in savestates.
4517 \begin_layout Section
4518 lsvs file format (commentary tracks)
4521 \begin_layout Subsection
4525 \begin_layout Itemize
4526 Each cluster is 8kB (8192 bytes) in size.
4529 \begin_layout Itemize
4530 Cluster n starts at offset 8192*n in file.
4533 \begin_layout Itemize
4534 The following clusters are system special:
4538 \begin_layout Itemize
4539 Cluster 0 and all clusters with number multiple of 2048 (cluster tables)
4542 \begin_layout Itemize
4543 Cluster 1 (superblock)
4547 \begin_layout Subsection
4551 \begin_layout Itemize
4552 The cluster table describing cluster n is stored in cluster n & ~0x7FF (zero
4556 \begin_layout Itemize
4557 This cluster table consists of 2048 4-byte big-endian integers.
4560 \begin_layout Itemize
4561 Each entry describes a cluster in 16MB supercluster, in order.
4564 \begin_layout Itemize
4565 The valid values for entries are:
4569 \begin_layout Itemize
4570 0x00000000: Free cluster
4573 \begin_layout Itemize
4574 0x00000001: Last cluster in chain.
4577 \begin_layout Itemize
4578 0xFFFFFFFF: System cluster (cluster tables and superblock)
4581 \begin_layout Itemize
4582 (anything else): Number of next cluster in chain.
4583 Must not be multiple of 2048.
4587 \begin_layout Itemize
4588 Due to limitations of the format, there can be at most 2097052 superclusters,
4589 giving maximum file size of 16TB.
4592 \begin_layout Subsection
4596 \begin_layout Itemize
4597 The stream table chain always starts in cluster 2.
4600 \begin_layout Itemize
4601 Otherwise, it follows normal chaining.
4604 \begin_layout Itemize
4605 The stream table consists of 16-byte entries:
4609 \begin_layout Itemize
4610 The first 8 bytes of entry give big-endian beginning position of stream
4611 in units of 1/48000 s.
4614 \begin_layout Itemize
4615 The next 4 bytes of entry give big-endian beginning cluster for control
4617 0 here marks the entry as not present.
4620 \begin_layout Itemize
4621 The last 4 bytes of entry give big-endian beginning cluster for codec data.
4625 \begin_layout Itemize
4626 Stream table clusters are normal clusters, following normal chaining.
4629 \begin_layout Itemize
4630 The stream begnning position is not guarenteed unique.
4631 There can be multiple streams with the same starting position in the file.
4634 \begin_layout Subsection
4638 \begin_layout Itemize
4639 The stream control data consists of entries 4 bytes each:
4643 \begin_layout Itemize
4644 The first 2 bytes of entry gives big-endian length of packet
4647 \begin_layout Itemize
4648 The next byte of entry gives audio length of packet in units of 1/400 s.
4651 \begin_layout Itemize
4652 The last byte is control byte.
4656 \begin_layout Itemize
4657 0 means this entry is not present and the control data ends.
4660 \begin_layout Itemize
4661 1 is valid control entry.
4666 \begin_layout Itemize
4667 The stream control data can also end by running into end of the readable
4672 \begin_layout Itemize
4673 This happens if there happens to be exact multiple of 2048 packets in stream
4674 and number of packets is nonzero.
4678 \begin_layout Itemize
4679 These clusters follow normal chaining.
4682 \begin_layout Subsection
4686 \begin_layout Itemize
4687 Stream codec data consists of raw Opus data packets packed back to back
4688 with nothing in between.
4691 \begin_layout Itemize
4692 Warning: Due to internal limitations, this data must reside in the first
4693 65536 superclusters (that is, the first 1TB of the file).
4696 \begin_layout Subsection
4700 \begin_layout Itemize
4701 The superblock is stored in cluster 1.
4705 \begin_layout Itemize
4706 The first 11 bytes are
4707 \begin_inset Quotes eld
4711 \begin_inset Quotes erd
4717 \begin_layout Itemize
4718 The rest are unused.
4721 \begin_layout Itemize
4722 This cluster 1 is marked as system special.
4725 \begin_layout Section
4726 Known ROM extensions
4729 \begin_layout Itemize
4730 SNES cartridge ROMs: sfc, smc, swc, fig, ufo, sf2, gd3, gd7, dx2, mgd, mgh.
4733 \begin_layout Itemize
4734 DMG cartridge ROMs: dmg, gb.
4737 \begin_layout Itemize
4738 GBC cartridge ROMs: cgb, gbc.
4741 \begin_layout Section
4745 \begin_layout Itemize
4746 The first line must be:
4747 \begin_inset Quotes eld
4751 \begin_inset Quotes erd
4757 \begin_layout Itemize
4758 There is one needed line:
4759 \begin_inset Quotes eld
4763 \begin_inset Quotes erd
4767 This sets system type to <systype>.
4768 The following system types are valid:
4772 \begin_layout Itemize
4776 \begin_layout Itemize
4777 bsx (BS-X non-slotted)
4780 \begin_layout Itemize
4781 bsxslotted (BS-X slotted)
4784 \begin_layout Itemize
4785 sufamiturbo (Sufami Turbo)
4788 \begin_layout Itemize
4789 sgb (Super Game Boy)
4792 \begin_layout Itemize
4796 \begin_layout Itemize
4797 gbc (Game Boy Color)
4800 \begin_layout Itemize
4801 gbc_gba (Game Boy Color with GBA initial register values)
4805 \begin_layout Itemize
4806 Optionally a region can be specified:
4807 \begin_inset Quotes eld
4811 \begin_inset Quotes erd
4815 The following values are valid:
4819 \begin_layout Itemize
4820 autodetect (Autodetect region: snes and sgb only)
4823 \begin_layout Itemize
4824 ntsc (NTSC: snes, bsx, bsxslotted, sufamiturbo, sgb)
4827 \begin_layout Itemize
4828 pal (PAL: snes, sgb)
4831 \begin_layout Itemize
4832 world (World: dmg, gbc, gbc_gba)
4836 \begin_layout Itemize
4837 ROM images are loaded as:
4838 \begin_inset Quotes eld
4842 \begin_inset Quotes erd
4846 The following types are valid:
4850 \begin_layout Itemize
4851 rom (Cartridge ROM in snes, dmg, gbc, gbc_gba.
4852 BIOS in bsx, bsxslotted, sufamiturbo)
4855 \begin_layout Itemize
4856 bsx (Cartridge ROM in bsx, bsxslotted)
4859 \begin_layout Itemize
4860 slot-a (Cartridge ROM in sufamiturbo)
4863 \begin_layout Itemize
4864 slot-b (Cartridge ROM in sufamiturbo)
4868 \begin_layout Itemize
4869 ROM markup can be loaded as:
4870 \begin_inset Quotes eld
4874 \begin_inset Quotes erd
4878 The types valid are the same as for ROMs.
4881 \begin_layout Itemize
4882 Patches can be loaded as
4883 \begin_inset Quotes eld
4886 patch[<offset>] <type> <file>
4887 \begin_inset Quotes erd
4891 The types are the same as for ROMs.
4895 \begin_layout Itemize
4896 Offset is given in form [+-]<number>.
4897 Usually offset is either +0 or -512.
4900 \begin_layout Itemize
4901 Default offset is +0.
4905 \begin_layout Subsection
4909 \begin_layout LyX-Code
4913 \begin_layout LyX-Code
4917 \begin_layout LyX-Code
4918 rom rom speedygonzales.sfc
4921 \begin_layout LyX-Code
4922 patch-512 rom sonicthehedgehog.ips
4925 \begin_layout Subsection
4929 \begin_layout LyX-Code
4933 \begin_layout LyX-Code
4937 \begin_layout LyX-Code
4938 rom rom supergameboy.sfc
4941 \begin_layout LyX-Code
4942 rom dmg megamanV.dmg
4945 \begin_layout Section
4946 Quick'n'dirty encode guide
4949 \begin_layout Enumerate
4950 Start the emulator and load the ROM and movie file.
4953 \begin_layout Enumerate
4954 Set large AVI option 'set-setting avi-large on'
4957 \begin_layout Enumerate
4958 Enable dumping 'dump-avi tmpdump'
4961 \begin_layout Enumerate
4962 Unpause and let it run until you want to end dumping.
4965 \begin_layout Enumerate
4966 Close the emulator (closing the window is the easiest way).
4970 \begin_layout Enumerate
4971 For each tmpdump*.avi file created, on command prompt, do 'x264 --crf 10
4972 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
4975 \begin_layout Enumerate
4976 Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
4979 \begin_layout Enumerate
4980 Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv + tmpdump_0000001.mkv
4981 + tmpdump_0000002.mkv' (list every tmpdump_<numbers>.mkv, with + in between).
4984 \begin_layout Enumerate
4985 Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'.
4986 Now final.mkv contains quick'n'dirty encode.
4989 \begin_layout Section
4990 Axis configurations for some gamepad types:
4993 \begin_layout Subsection
4997 \begin_layout Standard
4998 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be set to pressure-+.
5001 \begin_layout LyX-Code
5002 set-axis joystick0axis2 pressure-+
5005 \begin_layout LyX-Code
5006 set-axis joystick0axis5 pressure-+
5009 \begin_layout Itemize
5010 This is needed for SDL only.
5011 EVDEV sets those types correctly.
5014 \begin_layout Subsection
5016 \begin_inset Quotes eld
5020 \begin_inset Quotes erd
5026 \begin_layout Standard
5027 Axes 8-19 should be disabled.
5030 \begin_layout LyX-Code
5031 set-axis joystick0axis8 disabled
5034 \begin_layout LyX-Code
5035 set-axis joystick0axis9 disabled
5038 \begin_layout LyX-Code
5039 set-axis joystick0axis10 disabled
5042 \begin_layout LyX-Code
5043 set-axis joystick0axis11 disabled
5046 \begin_layout LyX-Code
5047 set-axis joystick0axis12 disabled
5050 \begin_layout LyX-Code
5051 set-axis joystick0axis13 disabled
5054 \begin_layout LyX-Code
5055 set-axis joystick0axis14 disabled
5058 \begin_layout LyX-Code
5059 set-axis joystick0axis15 disabled
5062 \begin_layout LyX-Code
5063 set-axis joystick0axis16 disabled
5066 \begin_layout LyX-Code
5067 set-axis joystick0axis17 disabled
5070 \begin_layout LyX-Code
5071 set-axis joystick0axis18 disabled
5074 \begin_layout LyX-Code
5075 set-axis joystick0axis19 disabled
5078 \begin_layout Section
5082 \begin_layout Subsection
5083 Problems from BSNES core:
5086 \begin_layout Itemize
5087 The whole pending save stuff.
5090 \begin_layout Itemize
5091 Lack of layer hiding.
5094 \begin_layout Itemize
5095 It is slow (especially accuracy).
5098 \begin_layout Itemize
5099 Firmwares can't be loaded from ZIP archives.
5102 \begin_layout Subsection
5106 \begin_layout Itemize
5107 Modifiers don't work with pseudo-keys (SDL, EVDEV).
5110 \begin_layout Itemize
5111 Audio for last dumped frame is not itself dumped.
5114 \begin_layout Itemize
5115 Audio in UI is pretty bad in quality if game doesn't run at full speed.
5118 \begin_layout Itemize
5119 No menus, command based interface (SDL).
5122 \begin_layout Itemize
5123 Long commands don't scroll.
5126 \begin_layout Section
5130 \begin_layout Subsection
5134 \begin_layout Itemize
5138 \begin_layout Itemize
5139 Fix dumper video corruption with levels 10-18.
5142 \begin_layout Subsection
5146 \begin_layout Itemize
5150 \begin_layout Itemize
5151 Lots of code cleanups
5154 \begin_layout Itemize
5155 Lua interface to settings
5158 \begin_layout Itemize
5159 Allow specifying AVI borders without Lua
5162 \begin_layout Itemize
5163 Fix scaling if vscale > 1 and originx > 0 (left border exists)
5166 \begin_layout Itemize
5167 on_snoop lua callback
5170 \begin_layout Itemize
5171 Faster movie loading and saving.
5174 \begin_layout Subsection
5178 \begin_layout Itemize
5182 \begin_layout Subsection
5186 \begin_layout Itemize
5190 \begin_layout Itemize
5191 Save jukebox functionality.
5194 \begin_layout Subsection
5198 \begin_layout Itemize
5199 Try to fix some nasty failing movie load edge cases
5202 \begin_layout Itemize
5203 Allow specifying scripts to run on command line.
5206 \begin_layout Subsection
5210 \begin_layout Itemize
5211 Major source code reorganization.
5214 \begin_layout Itemize
5215 Backup savestates before overwriting.
5218 \begin_layout Itemize
5219 Don't crash if loading initial state fails.
5222 \begin_layout Subsection
5226 \begin_layout Itemize
5230 \begin_layout Itemize
5231 Fix author name parsing
5234 \begin_layout Itemize
5235 Fix rerecord counting
5238 \begin_layout Itemize
5239 (SDL) Print messages to console if SDL is uninitialized
5242 \begin_layout Itemize
5243 Add movieinfo program
5246 \begin_layout Itemize
5247 Fix loading movies starting from SRAM.
5250 \begin_layout Subsection
5254 \begin_layout Itemize
5255 Add support for unattended dumping
5258 \begin_layout Itemize
5259 Fix compiling for Win32
5262 \begin_layout Itemize
5263 Don't lock up if sound can't be initialized
5266 \begin_layout Itemize
5267 Strip trailing CR from commands
5270 \begin_layout Itemize
5271 Don't try to do dubious things in global ctors (fix crash on startup)
5274 \begin_layout Subsection
5278 \begin_layout Itemize
5279 Small documentation tweaking
5282 \begin_layout Itemize
5286 \begin_layout Itemize
5287 Fix major bug in modifier matching
5290 \begin_layout Subsection
5294 \begin_layout Itemize
5295 Lots of documentation fixes
5298 \begin_layout Itemize
5299 Use dedicated callbacks for event backcomm., not commands.
5302 \begin_layout Itemize
5303 Ensure that the watchdog is not hit when executing delayed reset.
5306 \begin_layout Itemize
5307 Remove errant tab from joystick message.
5310 \begin_layout Subsection
5314 \begin_layout Itemize
5315 Make autofire operate in absolute time, not linear time
5318 \begin_layout Itemize
5319 Reinitialize controls when resuming from loadstate
5322 \begin_layout Itemize
5323 Some more code cleanups
5326 \begin_layout Itemize
5327 If Lua allocator fails, call OOM_panic()
5330 \begin_layout Itemize
5331 Byte/word/dword/qword sized host memory write/read functions.
5334 \begin_layout Itemize
5335 Dump at correct framerate if dumping interlaced NTSC (height=448).
5338 \begin_layout Subsection
5342 \begin_layout Itemize
5343 Actually include the complete source code
5346 \begin_layout Itemize
5350 \begin_layout Subsection
5354 \begin_layout Itemize
5355 Document {save,start}time.{,sub}second.
5358 \begin_layout Itemize
5359 Intercept time() from bsnes core.
5362 \begin_layout Subsection
5366 \begin_layout Itemize
5367 Allow disabling time() interception (allow build on Mac OS X)
5370 \begin_layout Itemize
5371 Use SDLMain on Mac OS X (make SDL not crash)
5374 \begin_layout Itemize
5375 Disable delayed resets (just plain too buggy for now).
5378 \begin_layout Itemize
5382 \begin_layout Itemize
5383 Use 16-bit for graphics/video instead of 32-bit.
5386 \begin_layout Itemize
5387 gui.rectangle/gui.pixel
5390 \begin_layout Itemize
5394 \begin_layout Itemize
5395 New CSCD writer implementation.
5398 \begin_layout Subsection
5402 \begin_layout Itemize
5403 Fix interaction of * and +.
5406 \begin_layout Itemize
5410 \begin_layout Itemize
5411 Use gettimeofday()/usleep(), these seem portable enough.
5414 \begin_layout Itemize
5415 Move joystick axis manipulation to keymapper code.
5418 \begin_layout Itemize
5419 Changes to how read-only works.
5422 \begin_layout Itemize
5423 Refactor controller input code.
5426 \begin_layout Subsection
5430 \begin_layout Itemize
5431 Fix mouseclick scale compensation.
5434 \begin_layout Itemize
5435 Draw area boundaries correctly in SDL code.
5438 \begin_layout Itemize
5442 \begin_layout Itemize
5443 Fix CSCD output (buffer overrun and race condition).
5446 \begin_layout Subsection
5450 \begin_layout Itemize
5451 JMD dumping support.
5454 \begin_layout Itemize
5455 Allow unattended dumping to JMD.
5458 \begin_layout Itemize
5462 \begin_layout Itemize
5463 Switch back to 32-bit colors.
5466 \begin_layout Itemize
5467 Add Lua function gui.color.
5470 \begin_layout Itemize
5471 Use some new C++11 features in GCC 4.6.
5474 \begin_layout Itemize
5475 Be prepared for core frequency changes.
5478 \begin_layout Itemize
5479 Pass colors in one chunk from Lua.
5482 \begin_layout Subsection
5486 \begin_layout Itemize
5487 New lua functions gui.line(), gui.status() and gui.circle(), memory.vma_count(),
5488 memory.read_vma() and memory.find_vma().
5491 \begin_layout Itemize
5492 Numerious documentation fixups
5495 \begin_layout Itemize
5496 RTC time format changed
5499 \begin_layout Itemize
5500 Reformat flags display
5503 \begin_layout Itemize
5504 Allow lua package name to be overridden
5507 \begin_layout Itemize
5508 SDUMP (high-quality dumping).
5511 \begin_layout Itemize
5512 Split platform support to plugins.
5515 \begin_layout Itemize
5516 Make all sound plugins support basic sound commands
5519 \begin_layout Itemize
5520 Support portaudio for sound.
5523 \begin_layout Itemize
5524 Allow disable Lua/SDL searching.
5527 \begin_layout Itemize
5528 Upconvert colors when copying lcscreen to screen.
5531 \begin_layout Itemize
5532 Reorganize source tree.
5535 \begin_layout Itemize
5536 Evdev joystick support.
5539 \begin_layout Itemize
5540 Refactor more code into generic window code.
5543 \begin_layout Subsection
5547 \begin_layout Itemize
5548 Refactor message handling.
5551 \begin_layout Itemize
5555 \begin_layout Itemize
5559 \begin_layout Itemize
5560 Finish pending saves before load/quit.
5563 \begin_layout Itemize
5564 Wxwidgets graphics plugin.
5567 \begin_layout Subsection
5571 \begin_layout Itemize
5572 Get rid of win32-crap.[ch]pp.
5575 \begin_layout Itemize
5576 Move files around a lot.
5579 \begin_layout Itemize
5580 Get rid of need for host C++ compiler.
5583 \begin_layout Itemize
5587 \begin_layout Itemize
5588 Refactor inter-component communication.
5591 \begin_layout Itemize
5595 \begin_layout Itemize
5596 Fix crash on multiline aliases.
5599 \begin_layout Itemize
5600 Load/Save settings in wxwidgets gui.
5603 \begin_layout Subsection
5607 \begin_layout Itemize
5608 Patch problems in bsnes core
5611 \begin_layout Itemize
5612 SNES is little-endian, not big-endian!
5615 \begin_layout Itemize
5616 Fix memory corruption in lcscreen::load()
5619 \begin_layout Subsection
5623 \begin_layout Itemize
5624 Fix interpretting repeat counts in rrdata loading.
5627 \begin_layout Itemize
5628 New lua callback: on_frame()
5631 \begin_layout Itemize
5632 Remove calls to runtosave() that aren't supposed to be there
5635 \begin_layout Itemize
5636 Lua function: movie.read_rtc()
5639 \begin_layout Itemize
5640 Ignore src/fonts/font.cpp
5643 \begin_layout Itemize
5644 Fix more bsnes core problems
5647 \begin_layout Itemize
5648 Control bsnes random seeding
5651 \begin_layout Itemize
5655 \begin_layout Itemize
5656 Some bsnes core debugging features (state dump and state hash)
5659 \begin_layout Itemize
5660 Fix titlebar version number (no, the last version wasn't 'lsnes-0-beta21',
5661 it was 'lsnes rr0-beta21').
5664 \begin_layout Subsection
5668 \begin_layout Itemize
5669 Fix memory corruption due to macro/field mixup
5672 \begin_layout Itemize
5673 search-memory update
5676 \begin_layout Itemize
5677 Allow direct-mapped framebuffer
5680 \begin_layout Itemize
5681 SDL: Use SDL_ANYFORMAT if possible
5684 \begin_layout Itemize
5685 SDMP2SOX: 2s delay modes.
5688 \begin_layout Itemize
5692 \begin_layout Itemize
5693 Use sed -E, not sed -r.
5694 Fixes building on Mac OS X.
5697 \begin_layout Itemize
5698 Wxwidgets: Save jukebox on exit
5701 \begin_layout Itemize
5702 Fix RTC if using load-movie on savestate.
5705 \begin_layout Itemize
5706 Fix crash related to full console mode.
5709 \begin_layout Subsection
5713 \begin_layout Itemize
5714 Wxwidgets: Allow bringing application to foreground on Mac OS X.
5717 \begin_layout Itemize
5718 Wxwidgets: Allow compiling on Mac OS X.
5721 \begin_layout Itemize
5722 Use movie compare instead of movie hashing (faster save/load).
5725 \begin_layout Itemize
5729 \begin_layout Subsection
5733 \begin_layout Itemize
5734 sdmp2sox: Pad soundtrack if using -l or -L.
5737 \begin_layout Itemize
5738 sdmp2sox: Fix NTSC overscan.
5741 \begin_layout Itemize
5742 sdmp2sox: Add AR correction mode.
5745 \begin_layout Itemize
5746 call lua_close() when exiting.
5749 \begin_layout Itemize
5750 Fix zip_writer bug causing warnings from info-zip and error from advzip.
5753 \begin_layout Subsection
5757 \begin_layout Itemize
5758 Fix IPS patching code (use bsnes core IPS patcher).
5761 \begin_layout Itemize
5762 Implement BPS patching (using bsnes core IPS patcher).
5765 \begin_layout Itemize
5766 Add feature to load headered ROMs.
5769 \begin_layout Subsection
5773 \begin_layout Itemize
5774 Show command names when showing keybindings
5777 \begin_layout Subsection
5781 \begin_layout Itemize
5782 Fix pause-on-end to be actually controllable
5785 \begin_layout Itemize
5786 SDL: Poll all events in queue, not just first one (fixes slowness in command
5790 \begin_layout Itemize
5791 Wxwidgets: Fix ROM loading.
5794 \begin_layout Subsection
5798 \begin_layout Itemize
5799 Lua: Add gui.textH, gui.textV, gui.textHV
5802 \begin_layout Itemize
5803 Fix text colors on SDL on Mac OS X
5806 \begin_layout Itemize
5807 Mode 'F' for finished in readonly mode.
5810 \begin_layout Itemize
5814 \begin_layout Itemize
5815 Reliably pause after skip poll
5818 \begin_layout Itemize
5819 Split UI and core into their own threads
5822 \begin_layout Subsection
5826 \begin_layout Itemize
5827 Remove leftover dummy SRAM slot
5830 \begin_layout Itemize
5831 Fix controller numbers.
5834 \begin_layout Subsection
5838 \begin_layout Itemize
5839 Fix lsnes-dumpavi after interface change.
5842 \begin_layout Itemize
5843 Also give BSNES patches for v085.
5846 \begin_layout Itemize
5847 Pack movie data in memory.
5850 \begin_layout Subsection
5854 \begin_layout Itemize
5855 Fix framecount/length given when loading movies.
5858 \begin_layout Itemize
5859 Controller command memory leak fixes.
5862 \begin_layout Itemize
5863 Don't leak palette if freeing screen object.
5866 \begin_layout Subsection
5870 \begin_layout Itemize
5874 \begin_layout Itemize
5875 Wxwidgets: Allow controlling dumper from the menu.
5878 \begin_layout Subsection
5882 \begin_layout Itemize
5883 Rewrite parts of manual
5886 \begin_layout Itemize
5887 Lua: Make it work with Lua 5.2.
5890 \begin_layout Subsection
5894 \begin_layout Itemize
5895 Win32: Fix compile errors.
5898 \begin_layout Subsection
5902 \begin_layout Itemize
5903 Refactor controller input code.
5906 \begin_layout Itemize
5907 Fix crash when using command line on SDL / Mac OS X.
5910 \begin_layout Subsection
5914 \begin_layout Itemize
5915 Delete core/coroutine (obsolete)
5918 \begin_layout Itemize
5919 Lag input display by one frame.
5922 \begin_layout Itemize
5923 Rewind movie to beginning function.
5926 \begin_layout Itemize
5927 Fix wrong frame number reported to Lua when repainting after loadstate
5930 \begin_layout Itemize
5931 Support UI editing of jukebox
5934 \begin_layout Itemize
5935 Wxwidgets: Save settings on exit.
5938 \begin_layout Itemize
5939 Support ${project} for filenames
5942 \begin_layout Itemize
5943 SDL: Fix command history
5946 \begin_layout Subsection
5950 \begin_layout Itemize
5951 Fix some order-of-global-ctor bugs.
5954 \begin_layout Subsection
5958 \begin_layout Itemize
5959 Fix crashes when quitting on Win32.
5962 \begin_layout Subsection
5966 \begin_layout Itemize
5967 EVDEV: Queue keypresses from joystick, don't send directly
5970 \begin_layout Itemize
5971 Wxwidgets: Load-Preserve that actually works.
5974 \begin_layout Subsection
5978 \begin_layout Itemize
5979 Wxwidgets: GUI for memory search.
5982 \begin_layout Itemize
5983 Warn about using synchronous queue in UI callback.
5986 \begin_layout Subsection
5990 \begin_layout Itemize
5991 Remember last saved file for each ROM
5994 \begin_layout Itemize
5995 Support MT dumping via boost.
5998 \begin_layout Itemize
6002 \begin_layout Itemize
6006 \begin_layout Itemize
6007 Make mouse be ordinary input instead of special-casing
6010 \begin_layout Itemize
6011 SDL: Don't screw up commands with NUL codepoints.
6014 \begin_layout Subsection
6018 \begin_layout Itemize
6019 Merge status panel and main window
6022 \begin_layout Itemize
6023 True movie slot support (the rest of it)
6026 \begin_layout Itemize
6027 SDL: Fix compilation error
6030 \begin_layout Itemize
6031 Elminate cross calls in dump menu code.
6034 \begin_layout Subsection
6038 \begin_layout Itemize
6039 Cancel pending saves command
6042 \begin_layout Itemize
6043 Wxwidgets: Code refactoring
6046 \begin_layout Itemize
6047 Wxwidgets: Fix system -> reset
6050 \begin_layout Itemize
6051 Wxwidgets: Read watch expressions in the right thread
6054 \begin_layout Subsection
6058 \begin_layout Itemize
6059 Wxwidgets: Don't prompt for member when running Lua script (Lua doesn't
6063 \begin_layout Itemize
6064 Wxwidgets: 128 -> 1024 Autohold slots (in case more are needed).
6067 \begin_layout Itemize
6068 Don't append trailing '-' to prefix when saving movie.
6071 \begin_layout Itemize
6072 Fix ROM/savestate handling (don't let user mismatch ROM and savestates).
6075 \begin_layout Subsection
6079 \begin_layout Itemize
6080 Document memory watch syntax.
6083 \begin_layout Subsection
6087 \begin_layout Itemize
6088 Fix unattended dumping (lsnes-dumpavi)
6091 \begin_layout Itemize
6095 \begin_layout Itemize
6096 Use adv_dumper instead of the old interface in lsnes-dumpavi (changes syntax)
6099 \begin_layout Itemize
6100 Add option to control sample rate preturbation in AVI dumper
6103 \begin_layout Subsection
6107 \begin_layout Itemize
6108 Wxwidgets: Fix dumper submodes
6111 \begin_layout Itemize
6112 Set core controller types before loadstate
6115 \begin_layout Subsection
6119 \begin_layout Itemize
6120 Fix compiling with bsnes v086.
6123 \begin_layout Subsection
6127 \begin_layout Itemize
6128 Don't prompt before quitting
6131 \begin_layout Itemize
6132 Start unpaused, preserve pause/unpause over load.
6135 \begin_layout Itemize
6136 Try to autodetect if ROM is headered.
6139 \begin_layout Itemize
6140 Wxwidgets: Only bring up ROM patching screen if specifically requested.
6143 \begin_layout Itemize
6144 Allow configuring some hotkeys.
6147 \begin_layout Subsection
6151 \begin_layout Itemize
6152 Lots of code cleanups
6155 \begin_layout Itemize
6156 Fix JMD compression (JMD dumping was broken)
6159 \begin_layout Itemize
6160 Don't crash if Lua C function throws an exception.
6163 \begin_layout Itemize
6164 Support bitmap drawing in Lua.
6167 \begin_layout Itemize
6168 Fix bsnes v085/v086 patches.
6171 \begin_layout Itemize
6172 Improve stability on win32.
6175 \begin_layout Subsection
6179 \begin_layout Itemize
6180 Don't corrupt movie if movie length is integer multiple of frames per page.
6183 \begin_layout Subsection
6187 \begin_layout Itemize
6188 New Lua hooks: on_rewind, on_frame_emulated, on_idle, on_timer
6191 \begin_layout Itemize
6192 New Lua functions: emulator_ready(), utime(), set_idle_timeout(), set_timer_time
6193 out(), bit.extract(), bit.value(), input.geta(), input.seta() and input.controllertyp
6197 \begin_layout Itemize
6198 Wxwidgets: Fix internal focus lost (hotkeys stop working)
6201 \begin_layout Itemize
6202 Wxwidgets: Fix broken modifiers
6205 \begin_layout Itemize
6206 on_paint has parameter now.
6209 \begin_layout Itemize
6210 Optional initital fill for bitmaps
6213 \begin_layout Itemize
6214 Fix palette changing.
6217 \begin_layout Itemize
6218 Optimize rendering a bit.
6221 \begin_layout Itemize
6225 \begin_layout Subsection
6229 \begin_layout Itemize
6230 Movieinfo: Fix display of port #2 type.
6233 \begin_layout Itemize
6234 Call on_input() after loadstate.
6237 \begin_layout Subsection
6241 \begin_layout Itemize
6242 Fix writing port2 data to movie.
6245 \begin_layout Itemize
6246 Fix SRAM handling with Bsnes v087.
6249 \begin_layout Subsection
6253 \begin_layout Itemize
6254 Library loading support
6257 \begin_layout Itemize
6258 Built-in TSCC encoder
6261 \begin_layout Itemize
6262 Hi-color (256T colors) dumping.
6265 \begin_layout Itemize
6266 Dump over TCP/IP(v6)
6269 \begin_layout Itemize
6270 Hidable status panel
6273 \begin_layout Itemize
6277 \begin_layout Itemize
6278 Adjustable sound volume
6281 \begin_layout Itemize
6285 \begin_layout Itemize
6286 Allow DnD into filename boxes
6289 \begin_layout Itemize
6293 \begin_layout Itemize
6294 Portaudio: Fix speaker popping at start
6297 \begin_layout Itemize
6301 \begin_layout Itemize
6302 Speed adjustment menu
6305 \begin_layout Itemize
6306 Win32 joystick support
6309 \begin_layout Itemize
6310 Lua: gui.rainbow and gui.box
6313 \begin_layout Itemize
6314 Split key lists into classes (the key list was large!)
6317 \begin_layout Itemize
6318 More save slots support
6321 \begin_layout Itemize
6322 Wxwidgets (wxJoystick) joystick support
6325 \begin_layout Subsection
6329 \begin_layout Itemize
6330 Lots of internal joystick refactoring
6333 \begin_layout Itemize
6334 Evdev: Add mapping for BTN_TOOL_QUINTTAP
6337 \begin_layout Itemize
6338 Wxwidgets: Settings mode (open settings without ROM)
6341 \begin_layout Itemize
6342 Wxwidgets: Prompt key to use option
6345 \begin_layout Itemize
6346 Wxwidgets: Fix crash if key goes away underneath
6349 \begin_layout Itemize
6350 Wxwidgets: Fix mouse position in presence of scaling
6353 \begin_layout Itemize
6354 AVI dumper: Mode 4 (high-quality resampling to common rate using SRC)
6357 \begin_layout Itemize
6358 Wxwidgets: Redesign hotkeys dialog to avoid tree control (tree control doesn't
6359 seem to work well on WinXP)
6362 \begin_layout Itemize
6363 Start paused option.
6366 \begin_layout Subsection
6370 \begin_layout Itemize
6374 \begin_layout Itemize
6375 lsnes-dumpavi: Start Lua before starting dumper
6378 \begin_layout Itemize
6379 AVI: Fix secondary audio in mode 4.
6382 \begin_layout Subsection
6386 \begin_layout Itemize
6387 AVI: Refactor ZMBV a bit.
6390 \begin_layout Itemize
6391 Fix error reading analog values from movie file
6394 \begin_layout Subsection
6398 \begin_layout Itemize
6399 Delayed reset support
6402 \begin_layout Itemize
6403 Lua: memory.hash_region
6406 \begin_layout Subsection
6410 \begin_layout Itemize
6411 Rework the build system
6414 \begin_layout Itemize
6415 Typing input support
6418 \begin_layout Itemize
6419 Fix building with bsnes v086 and v087.
6422 \begin_layout Itemize
6423 SDL: Save settings on exit
6426 \begin_layout Itemize
6427 SDL: Command to enter command line mode with given command.
6430 \begin_layout Itemize
6431 SDL: More advanced command editing.
6434 \begin_layout Subsection
6438 \begin_layout Itemize
6440 \begin_inset Quotes eld
6443 arrow keys and enter don't work
6444 \begin_inset Quotes erd
6450 \begin_layout Itemize
6454 \begin_layout Itemize
6455 Show mode changes due to rewinding.
6458 \begin_layout Itemize
6459 Unsafe rewind support
6462 \begin_layout Itemize
6463 Fix directory transversal.
6466 \begin_layout Subsection
6470 \begin_layout Itemize
6471 AVI: Sound mode 5 (48kHz high-quality)
6474 \begin_layout Itemize
6478 \begin_layout Itemize
6479 Map the SNES bus into address space
6482 \begin_layout Itemize
6483 Fix loading memory watch files with CRLF line endings
6486 \begin_layout Subsection
6490 \begin_layout Itemize
6491 Map bsnes internal state into memory space
6494 \begin_layout Itemize
6496 \begin_inset Quotes eld
6499 click on panel wedges the emulator
6500 \begin_inset Quotes erd
6506 \begin_layout Itemize
6507 DnD movies/saves on the main window.
6510 \begin_layout Subsection
6514 \begin_layout Itemize
6515 Split core bindings into own module.
6518 \begin_layout Itemize
6519 Remember invalid settings
6522 \begin_layout Itemize
6523 Support for modified Gambatte core for GB/GBC emulation.
6526 \begin_layout Itemize
6527 Reload/swap ROM function
6530 \begin_layout Subsection
6534 \begin_layout Itemize
6535 Fix step poll function
6538 \begin_layout Subsection
6542 \begin_layout Itemize
6543 Non-insane savestate anchoring
6546 \begin_layout Subsection
6550 \begin_layout Itemize
6551 More Memory search methods
6554 \begin_layout Itemize
6555 Preserve movie if loading in RO mode.
6558 \begin_layout Itemize
6559 Fix a obscure case in timeline check
6562 \begin_layout Itemize
6563 Revamp the entiere ROM loading code
6566 \begin_layout Itemize
6570 \begin_layout Itemize
6574 \begin_layout Itemize
6575 Standalone hotkey config dialog
6578 \begin_layout Itemize
6579 Show bindings in more user-friendly format
6582 \begin_layout Subsection
6586 \begin_layout Itemize
6590 \begin_layout Itemize
6591 Fix uninitialized variables in bsnes v085
6594 \begin_layout Subsection
6598 \begin_layout Itemize
6599 Merge gambatte core into mainline (from its own branch)
6602 \begin_layout Itemize
6603 Wxwidgets: Show expected dump file formats
6606 \begin_layout Itemize
6607 Memory watch: Data typing
6610 \begin_layout Itemize
6611 lsnes internal MMIO area.
6614 \begin_layout Itemize
6615 Wxwidgets: New memory watch editor
6618 \begin_layout Itemize
6619 Hexadecimal memory watches
6622 \begin_layout Itemize
6623 Wxwidgets: Monospaced panel
6626 \begin_layout Itemize
6627 Wxwidgets: Split memory watches in panel
6630 \begin_layout Itemize
6631 Wxwidgets: Disable VMAs in memory search
6634 \begin_layout Itemize
6635 lsnes-dumpavi: Fix speed bug
6638 \begin_layout Itemize
6639 Movie subtitle support
6642 \begin_layout Itemize
6643 Fix rerecord count reporting
6646 \begin_layout Itemize
6647 Don't trash movie when loading in readonly mode.
6650 \begin_layout Subsection
6654 \begin_layout Itemize
6655 Wxwidgets: Fix crashes on closing settings dialogs on Mac OS X.
6658 \begin_layout Itemize
6659 Fix build on Mac OS X.
6662 \begin_layout Itemize
6666 \begin_layout Itemize
6667 Wxwidgets: Hidable messages window
6670 \begin_layout Itemize
6674 \begin_layout Itemize
6675 Bsnes: Support inconsistent saves
6678 \begin_layout Itemize
6679 Bsnes: Allow simulating saving every frame
6682 \begin_layout Itemize
6683 Fix desync if savestate is loaded in readonly mode in certain conditions.
6686 \begin_layout Itemize
6687 Wxwidgets: Fix save dialogs on Mac OS X.
6690 \begin_layout Itemize
6691 Wxwidgets: Fix insane status width on Win32.
6694 \begin_layout Itemize
6695 Wxwidgets: Fix autohold processing to be faster.
6698 \begin_layout Itemize
6699 Wxwidgets: Allow loading ROMs and movies from commandline.
6702 \begin_layout Subsection
6706 \begin_layout Itemize
6707 Be a bit smarter with --load
6710 \begin_layout Itemize
6711 Rewrote higher-level parts of audio system
6714 \begin_layout Itemize
6715 Tool to build commentary tracks
6718 \begin_layout Itemize
6722 \begin_layout Itemize
6723 Gambatte: Add support for SVN358
6726 \begin_layout Itemize
6727 Use builtin font when rendering status panel.
6730 \begin_layout Itemize
6731 Option to detach memory watch to its own window.
6734 \begin_layout Itemize
6735 Recent ROMs/Movies menu
6738 \begin_layout Itemize
6742 \begin_layout Itemize
6743 Useful lag counter for SNES games that autopoll
6746 \begin_layout Itemize
6747 Fix buffer overflow in gambatte sound output
6750 \begin_layout Subsection
6754 \begin_layout Itemize
6755 Don't blow up on wxGTK if the window is hidden somehow
6758 \begin_layout Itemize
6759 Support simultaneous drop of ROM and movie.
6762 \begin_layout Itemize
6763 Gambatte: Don't save spurious SRAMs.
6766 \begin_layout Itemize
6767 Make SGB ROMs actually usable.
6770 \begin_layout Itemize
6771 Fix so that saved movies appear in recent movies.
6774 \begin_layout Itemize
6775 Don't open multiple commentary editors at once.
6778 \begin_layout Subsection
6782 \begin_layout Itemize
6783 Lua: memory.readregion/memory.writeregion
6786 \begin_layout Itemize
6787 Lua: memory.map{,s}{byte,word,dword,qword}
6790 \begin_layout Itemize
6791 Lua: memory.map_structure
6794 \begin_layout Itemize
6795 Lua: Fix bus_address for gambatte
6798 \begin_layout Itemize
6799 Fix features dependent of bsnes debugger
6802 \begin_layout Itemize
6803 Cleanup bsnes debugger logic
6806 \begin_layout Itemize
6807 Fix resets in presence of save every frame
6810 \begin_layout Subsection
6814 \begin_layout Itemize
6815 Lua: input.lcid_to_pcid
6818 \begin_layout Itemize
6819 Fix off-by-one bug with slot hashes
6822 \begin_layout Itemize
6823 Fix crashes on certain memory watch expressions
6826 \begin_layout Itemize
6827 Lua: memory.read_expr
6830 \begin_layout Itemize
6831 Lua: Fix memory.read_expr on nil argument
6834 \begin_layout Itemize
6835 Fix the code to compile on G++ 4.7
6838 \begin_layout Itemize
6839 Change button_id to be a function pointer field, not a virtual method
6842 \begin_layout Itemize
6843 Add bsnes patches to fix libsnes to compile on GCC 4.7
6846 \begin_layout Itemize
6847 Gambatte: Always use legacy lag counting
6850 \begin_layout Itemize
6851 Memory commands: Memory addresses are up to 16 hex digits, not up to 8
6854 \begin_layout Itemize
6855 Fix analog controllers
6858 \begin_layout Itemize
6862 \begin_layout Itemize
6863 Fix button symbols in input display
6866 \begin_layout Itemize
6867 Compensate for nuts bsnes superscope/justifier handling
6870 \begin_layout Itemize
6871 Lua: Fix bit.extract boolean handling
6874 \begin_layout Subsection
6878 \begin_layout Itemize
6879 Split emulation cores more from the rest
6882 \begin_layout Itemize
6883 Support having multiple emulation cores compiled at once
6886 \begin_layout Itemize
6887 Support arbitrary number of ports (well, up to 31 anyway).
6890 \begin_layout Itemize
6891 SNES debugger support
6894 \begin_layout Itemize
6895 Support 16-button controllers
6898 \begin_layout Itemize
6899 Remove old SDL front end
6902 \begin_layout Itemize
6903 Data-driven controller buttons
6906 \begin_layout Itemize
6907 Generate the port code from defines
6910 \begin_layout Subsection
6914 \begin_layout Itemize
6915 Update libgambatte to SVN364
6918 \begin_layout Itemize
6919 Get rid of partial linking (building with MXE works)
6922 \begin_layout Itemize
6923 Load XML even without gamepack files
6926 \begin_layout Itemize
6927 Support screen rotate & flip
6930 \begin_layout Itemize
6931 Fix bug when changing controller key to another subkey of the same key
6934 \begin_layout Subsection
6938 \begin_layout Itemize
6939 Stop at movie end: Don't off-by-one
6942 \begin_layout Itemize
6943 Fix crash closing lsnes with voice playback active.
6946 \begin_layout Itemize
6947 Import/Export OggOpus for commentary tracks
6950 \begin_layout Itemize
6951 16-button controllers.
6954 \begin_layout Itemize
6955 Don't show nonexistent controllers in input display
6958 \begin_layout Itemize
6959 Set voice record/playback volume from UI
6962 \begin_layout Itemize
6963 Patches for gambatte SVN364.
6966 \begin_layout Itemize
6967 Load markup (if exists) even without gamepack file.
6970 \begin_layout Itemize
6971 Screen rotation & flipping
6974 \begin_layout Itemize
6975 Lua: Some new bit functions
6978 \begin_layout Itemize
6979 Auto-refresh voice streams on change.
6982 \begin_layout Itemize
6983 Auto-refresh subtitles on change & new subtitle editor.
6986 \begin_layout Itemize
6987 Fix music volume adjustment.
6990 \begin_layout Subsection
6994 \begin_layout Itemize
6995 Use system threads instead of platform threads
6998 \begin_layout Itemize
6999 Cleanup build by allowing dummy and real drivers to link together.
7002 \begin_layout Itemize
7003 Split duplex support
7006 \begin_layout Subsection
7010 \begin_layout Itemize
7011 Wxwidgets: Fix memory watch rendering.
7014 \begin_layout Itemize
7015 Wxwidgets: Allow setting voice stream gain.
7018 \begin_layout Itemize
7019 Wxwidgets: VU meters and volume adjustment.
7022 \begin_layout Itemize
7023 Lua: Custom fonts support.
7026 \begin_layout Itemize
7027 Lua: Fix methods stopping working when resetting Lua.
7030 \begin_layout Itemize
7031 Fix loading standard-format movies in preserve (readonly) mode.
7034 \begin_layout Subsection
7038 \begin_layout Itemize
7039 Primitive movie editor
7042 \begin_layout Itemize
7043 Fix VU meter with no sound device.
7046 \begin_layout Itemize
7047 Fix various undefined return values.
7050 \begin_layout Itemize
7051 Show rates in VU meter window.
7054 \begin_layout Subsection
7058 \begin_layout Itemize
7059 Lua: Render queues as objects
7062 \begin_layout Itemize
7063 Bsnes: support hard resets
7066 \begin_layout Itemize
7067 Dedicated sound devices dialog
7070 \begin_layout Itemize
7071 Change the default AVI sound mode to 2 or 5.
7074 \begin_layout Itemize
7075 Fix totally borked movie saving.
7078 \begin_layout Itemize
7079 Portaudio: Use split duplex with different devices.
7082 \begin_layout Itemize
7083 Fix controls with gambatte core.
7086 \begin_layout Itemize
7087 Modify save slot set handling.
7090 \begin_layout Itemize
7091 lsnes-dumpavi: --firmware-path.
7094 \begin_layout Itemize
7095 Fix lots of compiler warnings.
7098 \begin_layout Subsection
7102 \begin_layout Itemize
7103 Commentary tool: Set nominal bit rate and limit max bit rate.
7106 \begin_layout Itemize
7107 Lua: Unconditionally reload host memory on loadstate
7110 \begin_layout Itemize
7111 Lua: Query bindings, manipulate aliases, create inverse bindings
7114 \begin_layout Itemize
7115 Lua: Fix crashes with resetting VM while some types of paint requests are
7119 \begin_layout Itemize
7120 Lua: gui.text: Clip the text properly instead of corrupting memory in some
7124 \begin_layout Itemize
7125 Save screenshot header reliably
7128 \begin_layout Itemize
7129 Lua: Backport input.get2 and input.set2
7132 \begin_layout Itemize
7133 Lua: New controller info functions.
7136 \begin_layout Itemize
7137 Movie editor: Fix reset delay counters to be the right way around.
7140 \begin_layout Itemize
7144 \begin_layout Itemize
7145 Lua: on_button and input.veto_button.
7148 \begin_layout Subsection
7152 \begin_layout Itemize
7153 Revert memory leak fix breaking input
7156 \begin_layout Itemize
7157 Refactor Opus handling
7160 \begin_layout Itemize
7161 Restrict member picking only to .zip files
7164 \begin_layout Itemize
7165 Fix reading of host-endian VMAs.
7168 \begin_layout Itemize
7169 Fix rlow and rhigh to be the right way around.
7172 \begin_layout Itemize
7173 Lua: Don't wedge VM if callback fails with an exception
7176 \begin_layout Itemize
7177 Refactor Ogg handling.
7180 \begin_layout Subsection
7184 \begin_layout Itemize
7185 Fix saving PNG screenshots on Win32.
7188 \begin_layout Itemize
7189 Movie editor: Sweep axis.
7192 \begin_layout Itemize
7193 Load selected slot in ro/rw/preserve/movie mode.
7196 \begin_layout Itemize
7197 input.joyset: Preserve and invert user input.
7200 \begin_layout Itemize
7201 Allow immediate saving at point of save (transfer saves).
7204 \begin_layout Itemize
7205 Wxwidgets: Filter filenames in dialogs, autoappend extensions.
7208 \begin_layout Itemize
7209 data/verysmall.font: Add missing glyph 70 (
7210 \begin_inset Quotes eld
7214 \begin_inset Quotes erd
7220 \begin_layout Itemize
7221 Lua: Allow painting custom fonts with halo.
7224 \begin_layout Itemize
7225 Fix memory value search to work on byte types.
7228 \begin_layout Subsection
7232 \begin_layout Itemize
7233 Reject oggopus files with incomplete pregap
7236 \begin_layout Itemize
7237 Fix multistream and ogg demuxing
7240 \begin_layout Itemize
7241 Workaround bug with screen >1024 pixels wide.
7244 \begin_layout Itemize
7245 Allow on_input to force/veto system controls.
7248 \begin_layout Itemize
7249 Dedicated autohold/autofire window.
7252 \begin_layout Itemize
7253 Support per-button autofire.
7256 \begin_layout Itemize
7257 Fix crash on trying to frameadvance/exit with no ROM loaded.
7260 \begin_layout Itemize
7261 Fix nonexistent controller key warnings.
7264 \begin_layout Itemize
7265 Movie editor: Fix mouse editing (TYPE_RAXIS)
7268 \begin_layout Itemize
7272 \begin_layout Itemize
7276 \begin_layout Itemize
7277 Add throttle axes (TYPE_TAXIS).
7280 \begin_layout Itemize
7281 Fix movie reading with first port having multiple controllers.
7284 \begin_layout Itemize
7285 Move some info from status panel to statusbar.
7288 \begin_layout Subsection
7292 \begin_layout Itemize
7293 Fix status panel (and movie editor) flicker
7296 \begin_layout Itemize
7297 Show effects of Lua in input display
7300 \begin_layout Itemize
7301 Offer lsmv.backup as file filter too for load lsmv
7304 \begin_layout Itemize
7305 Allow slowing down subframe advance
7308 \begin_layout Itemize
7309 Display current save slot information
7312 \begin_layout Itemize
7316 \begin_layout Itemize
7317 Fix hotkeys stopping working after X-ing settings dialog
7320 \begin_layout Itemize
7321 Movie editor: Fix bug if extending finished movie
7324 \begin_layout Itemize
7325 Cap current_frame_first_subframe to movie size when recounting movie
7328 \begin_layout Itemize
7329 Movie editor: Interpret ctrl+click as right click
7332 \begin_layout Subsection
7336 \begin_layout Itemize
7337 Autofire: Fix false status indications
7340 \begin_layout Itemize
7341 Fix subframe counter
7344 \begin_layout Itemize
7345 Fix print() after Lua reset
7348 \begin_layout Itemize
7349 New settings framework
7352 \begin_layout Itemize
7353 Remove some unused leftover stuff
7356 \begin_layout Itemize
7357 Fix race condition causing possible crash on startup
7360 \begin_layout Itemize
7361 Fix compiling if uint64_t and size_t are not compatible
7364 \begin_layout Itemize
7365 Lua: Don't crash if input.[gs]et{,a} is called outside on_input
7368 \begin_layout Subsection
7372 \begin_layout Itemize
7373 Fix bug causing crash if triple has invalid button