Fix features dependent on bsnes debugger
[lsnes.git] / manual.lyx
blob5e18c48bfcc64d1d9d8d5cc0c8088b621b9a3c22
1 #LyX 2.0 created this file. For more info see http://www.lyx.org/
2 \lyxformat 413
3 \begin_document
4 \begin_header
5 \textclass article
6 \use_default_options true
7 \maintain_unincluded_children false
8 \language finnish
9 \language_package default
10 \inputencoding auto
11 \fontencoding global
12 \font_roman default
13 \font_sans default
14 \font_typewriter default
15 \font_default_family default
16 \use_non_tex_fonts false
17 \font_sc false
18 \font_osf false
19 \font_sf_scale 100
20 \font_tt_scale 100
22 \graphics default
23 \default_output_format default
24 \output_sync 0
25 \bibtex_command default
26 \index_command default
27 \paperfontsize default
28 \use_hyperref false
29 \papersize default
30 \use_geometry false
31 \use_amsmath 1
32 \use_esint 1
33 \use_mhchem 1
34 \use_mathdots 1
35 \cite_engine basic
36 \use_bibtopic false
37 \use_indices false
38 \paperorientation portrait
39 \suppress_date false
40 \use_refstyle 1
41 \index Hakusana
42 \shortcut idx
43 \color #008000
44 \end_index
45 \secnumdepth 3
46 \tocdepth 3
47 \paragraph_separation indent
48 \paragraph_indentation default
49 \quotes_language english
50 \papercolumns 1
51 \papersides 1
52 \paperpagestyle default
53 \tracking_changes false
54 \output_changes false
55 \html_math_output 0
56 \html_css_as_file 0
57 \html_be_strict false
58 \end_header
60 \begin_body
62 \begin_layout Section
63 Introduction
64 \end_layout
66 \begin_layout Standard
67 lsnes is SNES rerecording emulator based on bsnes core.
68 \end_layout
70 \begin_layout Section
71 Dependencies
72 \end_layout
74 \begin_layout Enumerate
75 bsnes libsnes (for bsnes SNES core)
76 \end_layout
78 \begin_deeper
79 \begin_layout Enumerate
80 v084-v087 (v084 or v085 for delayreset support)
81 \end_layout
83 \begin_layout Enumerate
84 accuracy or compatiblity core with debugger enabled.
85 \end_layout
87 \begin_layout Enumerate
88 Patched version (using included 7 patches)
89 \end_layout
91 \end_deeper
92 \begin_layout Enumerate
93 gambatte (for gambatte core)
94 \end_layout
96 \begin_deeper
97 \begin_layout Enumerate
98 SVN r320
99 \end_layout
101 \begin_layout Enumerate
102 Patched with included patches
103 \end_layout
105 \end_deeper
106 \begin_layout Enumerate
107 Zlib
108 \end_layout
110 \begin_layout Enumerate
111 boost_iostreams
112 \end_layout
114 \begin_layout Enumerate
115 boost_filesystem
116 \end_layout
118 \begin_layout Enumerate
119 boost_thread (if native std::thread is not available)
120 \end_layout
122 \begin_layout Enumerate
123 libsdl (SDL only)
124 \end_layout
126 \begin_layout Enumerate
127 sdlmain (SDL only, part of SDL)
128 \end_layout
130 \begin_layout Enumerate
131 boost_conversion (this is header-only library)
132 \end_layout
134 \begin_layout Enumerate
135 libswscale (wxwidgets graphics only)
136 \end_layout
138 \begin_layout Enumerate
139 Portaudio (portaudio sound only)
140 \end_layout
142 \begin_layout Enumerate
143 libao (libao sound only)
144 \end_layout
146 \begin_layout Enumerate
147 Lua (if Lua support is needed).
148 \end_layout
150 \begin_deeper
151 \begin_layout Itemize
152 Version 5.1.X or 5.2X.
153 \end_layout
155 \end_deeper
156 \begin_layout Enumerate
157 G++ 4.6 (bsnes doesn't seem to like 4.7, status for gambatte is unknown).
158 \end_layout
160 \begin_layout Section
161 Building
162 \end_layout
164 \begin_layout Itemize
165 Copy bsnes sources (the bsnes subdirectory) to subdirectory 'bsnes' (for
166  bsnes core).
167 \end_layout
169 \begin_layout Itemize
170 Copy gambatte sources to subdirectory 'gambatte' (for gambatte core).
171 \end_layout
173 \begin_layout Itemize
174 Patch the bsnes sources with included patches (directory 'bsnes-patches/<version
175 >', bsnes core)
176 \end_layout
178 \begin_layout Itemize
179 Patch the gambatte sources with included patches (directory 'gambatte-patches/<v
180 ersion>', gambatte core)
181 \end_layout
183 \begin_layout Itemize
184 Edit options.build (or copy of that file)
185 \end_layout
187 \begin_layout Itemize
188 Run make (passing 'OPTIONS=<filename>' if using something else than options.build
190 \end_layout
192 \begin_layout Section
193 Command line options
194 \end_layout
196 \begin_layout Subsection
197 ROM options
198 \end_layout
200 \begin_layout Subsubsection
201 --rom=<file> (lsnes/SDL, lsnes/wxwidgets, lsnes-avidump)
202 \end_layout
204 \begin_layout Standard
205 Load <file> as ROM.
206 \end_layout
208 \begin_layout Subsection
209 Session options
210 \end_layout
212 \begin_layout Subsubsection
213 --pause
214 \end_layout
216 \begin_layout Standard
217 Start paused
218 \end_layout
220 \begin_layout Subsubsection
221 <filename> (lsnes/SDL, lsnes-avidump, movieinfo)
222 \end_layout
224 \begin_layout Standard
225 Load <filename> as movie or savestate file.
226  All other session options are ignored.
227 \end_layout
229 \begin_layout Subsubsection
230 --port1=<device> (lsnes/SDL, bsnes core only)
231 \end_layout
233 \begin_layout Standard
234 Set type of port1.
235  Valid values are:
236 \end_layout
238 \begin_layout Itemize
239 none: No device connected
240 \end_layout
242 \begin_layout Itemize
243 gamepad: One gamepad (the default)
244 \end_layout
246 \begin_layout Itemize
247 multitap: Four gamepads (warning: makes most games refuse to start)
248 \end_layout
250 \begin_layout Itemize
251 mouse: Mouse.
252 \end_layout
254 \begin_layout Subsubsection
255 --port2=<type> (lsnes/SDL, bsnes core only)
256 \end_layout
258 \begin_layout Standard
259 Set type of port2.
260  Valid values are:
261 \end_layout
263 \begin_layout Itemize
264 none: No device connected (the default)
265 \end_layout
267 \begin_layout Itemize
268 gamepad: One gamepad
269 \end_layout
271 \begin_layout Itemize
272 multitap: Four gamepads.
273 \end_layout
275 \begin_layout Itemize
276 mouse: Mouse
277 \end_layout
279 \begin_layout Itemize
280 superscope: Super Scope
281 \end_layout
283 \begin_layout Itemize
284 justifier: One justifier
285 \end_layout
287 \begin_layout Itemize
288 justifiers: Two justifiers
289 \end_layout
291 \begin_layout Subsubsection
292 --gamename=<name> (lsnes/SDL)
293 \end_layout
295 \begin_layout Standard
296 Set the name of game to <name>.
297  Default is blank.
298 \end_layout
300 \begin_layout Subsubsection
301 --author=<name> (lsnes/SDL)
302 \end_layout
304 \begin_layout Standard
305 Add author with full name of <name> (no nickname).
306 \end_layout
308 \begin_layout Subsubsection
309 --author=|<name> (lsnes/SDL)
310 \end_layout
312 \begin_layout Standard
313 Add author with nickname of <name> (no full name).
314 \end_layout
316 \begin_layout Subsubsection
317 --author=<fullname>|<nickname> (lsnes/SDL)
318 \end_layout
320 \begin_layout Standard
321 Add author with full name of <fullname> and nickname of <nickname>.
322 \end_layout
324 \begin_layout Subsubsection
325 --rtc-second=<value> (lsnes/SDL)
326 \end_layout
328 \begin_layout Standard
329 Set RTC second (0 is 1st January 1970 00:00:00Z).
330  Default is 1,000,000,000.
331 \end_layout
333 \begin_layout Subsubsection
334 --rtc-subsecond=<value> (lsnes/SDL)
335 \end_layout
337 \begin_layout Standard
338 Set RTC subsecond.
339  Range is 0-.
340  Unit is CPU cycle.
341  Default is 0.
342 \end_layout
344 \begin_layout Subsubsection
345 --anchor-savestate=<file> (lsnes/SDL)
346 \end_layout
348 \begin_layout Standard
349 Set the anchor savestate file.
350 \end_layout
352 \begin_layout Subsubsection
353 --load=<file> (lsnes/wxwidgets)
354 \end_layout
356 \begin_layout Standard
357 After loading the ROM, load <file> as savestate/movie.
358 \end_layout
360 \begin_layout Subsection
361 Misc.
362  options:
363 \end_layout
365 \begin_layout Subsubsection
366 --run=<file> (lsnes/SDL)
367 \end_layout
369 \begin_layout Standard
370 After running main RC file, run this file.
371  If multiple are specified, these execute in order specified.
372 \end_layout
374 \begin_layout Subsection
375 dump options (lsnes-dumpavi only)
376 \end_layout
378 \begin_layout Subsubsection
379 --dumper=<dumper>
380 \end_layout
382 \begin_layout Standard
383 Set the dumper to use (required).
384  Use 'list' for listing of known dumpers.
385 \end_layout
387 \begin_layout Subsubsection
388 --mode=<mode>
389 \end_layout
391 \begin_layout Standard
392 Set the mode to use (required for dumpers with multiple modes, forbidden
393  otherwise).
394  Use 'list' for known modes.
395 \end_layout
397 \begin_layout Subsubsection
398 --prefix=<prefix>
399 \end_layout
401 \begin_layout Standard
402 Set dump prefix.
403  Default is 
404 \begin_inset Quotes eld
405 \end_inset
407 avidump
408 \begin_inset Quotes erd
409 \end_inset
412 \end_layout
414 \begin_layout Subsubsection
415 --option=<name>=<value>
416 \end_layout
418 \begin_layout Standard
419 Set option <name> to value <value>.
420 \end_layout
422 \begin_layout Subsubsection
423 --length=<length>
424 \end_layout
426 \begin_layout Standard
427 Set number of frames to dump.
428  Mandatory.
429 \end_layout
431 \begin_layout Subsubsection
432 --lua=<script>
433 \end_layout
435 \begin_layout Standard
436 Run specified lua script (lsnes-dumpavi does not have initialization files).
437 \end_layout
439 \begin_layout Subsubsection
440 --load-library=<library>
441 \end_layout
443 \begin_layout Standard
444 Load the specified shared object / dynamic library / dynamic link library.
445 \end_layout
447 \begin_layout Section
448 Startup file lsnes.rc
449 \end_layout
451 \begin_layout Standard
452 Upon startup, lsnes (lsnes/SDL only) executes file lsnes.rc as commands.
453  This file is located in:
454 \end_layout
456 \begin_layout Itemize
457 Windows: %APPDATA%
458 \backslash
459 lsnes
460 \backslash
461 lsnes.rc (if %APPDATA% exists)
462 \end_layout
464 \begin_layout Itemize
465 Unix: $XDG_CONFIG_HOME/lsnes/lsnes.rc (if $XDG_CONFIG_HOME exists)
466 \end_layout
468 \begin_layout Itemize
469 Unix: $HOME/.config/lsnes/lsnes.rc (if $HOME exists)
470 \end_layout
472 \begin_layout Itemize
473 All: ./lsnes.rc (fallback default).
474 \end_layout
476 \begin_layout Standard
477 If leading directories do not exist, attempt to create them is made.
478 \end_layout
480 \begin_layout Section
481 Internal commands
482 \end_layout
484 \begin_layout Itemize
485 Commands beginning with '*' invoke the corresponding command without alias
486  expansion.
487 \end_layout
489 \begin_layout Itemize
490 If command starts with '+' (after possible '*'), the command is executed
491  as-is when button is pressed, and when button is released, it is executed
492  with '+' replaced by '-'.
493 \end_layout
495 \begin_layout Itemize
496 Commands without '+' execute only on negative edge (release).
497 \end_layout
499 \begin_layout Subsection
500 Settings:
501 \end_layout
503 \begin_layout Standard
504 Settings control various aspects of emulator behaviour.
505 \end_layout
507 \begin_layout Subsubsection
508 set-setting <setting> <value>
509 \end_layout
511 \begin_layout Standard
512 Sets setting <setting> to value <value> (may be empty).
513 \end_layout
515 \begin_layout Subsubsection
516 unset-setting <setting>
517 \end_layout
519 \begin_layout Standard
520 Try to unset setting <setting> (not all settings can be unset).
521 \end_layout
523 \begin_layout Subsubsection
524 get-setting <setting>
525 \end_layout
527 \begin_layout Standard
528 Read value of setting <setting>
529 \end_layout
531 \begin_layout Subsubsection
532 show-settings
533 \end_layout
535 \begin_layout Standard
536 Print names and values of all settings.
537 \end_layout
539 \begin_layout Subsection
540 Keybindings
541 \end_layout
543 \begin_layout Standard
544 Keybindings bind commands or aliases to keys (or pseudo-keys).
546 \end_layout
548 \begin_layout Standard
549 Notes:
550 \end_layout
552 \begin_layout Itemize
553 Do not bind edge active (+/-) commands to keys with modifiers, that won't
554  work right!
555 \end_layout
557 \begin_layout Itemize
558 Names of keys and modifiers are platform-dependent.
559 \end_layout
561 \begin_layout Itemize
562 Be careful before binding pseudo-keys (such as joystick axes, buttons or
563  hats) with modifiers.
564  That may or may not work right.
565 \end_layout
567 \begin_layout Subsubsection
568 bind-key [<mod>/<modmask>] <key> <command>
569 \end_layout
571 \begin_layout Standard
572 Bind <command> to key <key> (activating if modifiers in <modmask> (comma-seperat
573 ed list) are set as <mod> (comma-seperated list).
574 \end_layout
576 \begin_layout Standard
577 The names of keys and modifiers are platform-dependent.
578 \end_layout
580 \begin_layout Subsubsection
581 unbind-key [<mod>/<modmask>] <key>
582 \end_layout
584 \begin_layout Standard
585 Unbind command from <key> (with specified <mod> and <modmask>).
586 \end_layout
588 \begin_layout Subsubsection
589 set-axis <axis> [disabled | axis | axis-inverse | pressure0- | pressure0+
590  | pressure-0 | pressure-+ | pressure+0 | pressure+-] [minus=<val>] [zero=<val>]
591  [plus=<val>] [tolerance=<val>]
592 \end_layout
594 \begin_layout Standard
595 Set axis parameters for axis <axis>.
596 \end_layout
598 \begin_layout Itemize
599 disabled: Disable axis
600 \end_layout
602 \begin_layout Itemize
603 axis: Normal axis
604 \end_layout
606 \begin_layout Itemize
607 axis-inverse: Inverse axis
608 \end_layout
610 \begin_layout Itemize
611 pressure0-: Pressure sensitive.
612  Released at 0, pressed at -.
613 \end_layout
615 \begin_layout Itemize
616 pressure0+: Pressure sensitive.
617  Released at 0, pressed at +.
618 \end_layout
620 \begin_layout Itemize
621 pressure-0: Pressure sensitive.
622  Released at -, pressed at 0.
623 \end_layout
625 \begin_layout Itemize
626 pressure-+: Pressure sensitive.
627  Released at -, pressed at +.
628 \end_layout
630 \begin_layout Itemize
631 pressure+0: Pressure sensitive.
632  Released at +, pressed at 0.
633 \end_layout
635 \begin_layout Itemize
636 pressure+-: Pressure sensitive.
637  Released at +, pressed at -.
638 \end_layout
640 \begin_layout Itemize
641 minus=<val>: Calibration at extreme minus position (-32768-32767)
642 \end_layout
644 \begin_layout Itemize
645 zero=<val>: Calibration at neutral position (-32768-32767)
646 \end_layout
648 \begin_layout Itemize
649 plus=<val>: Calibration at extreme plus position (-32768-32767)
650 \end_layout
652 \begin_layout Itemize
653 tolerance=<value>: Center band tolerance (0<x<1).
654  The smaller the value, the more sensitive the control is.
655 \end_layout
657 \begin_layout Subsubsection
658 show-bindings
659 \end_layout
661 \begin_layout Standard
662 Print all key bindings in effect.
663 \end_layout
665 \begin_layout Subsection
666 Aliases
667 \end_layout
669 \begin_layout Standard
670 Aliases bind command to sequence of commands.
671  After alias has been defined, it replaces the command it shadows.
672 \end_layout
674 \begin_layout Standard
675 Notes:
676 \end_layout
678 \begin_layout Itemize
679 You can't alias command to itself.
680 \end_layout
682 \begin_layout Itemize
683 Aliases starting with +/- are edge active just like ordinary commands starting
684  with +/-.
685 \end_layout
687 \begin_layout Itemize
688 One command can be aliased to multiple commands.
689 \end_layout
691 \begin_layout Subsubsection
692 alias-command <command> <expansion>
693 \end_layout
695 \begin_layout Standard
696 Append <expansion> to alias <command>.
697  If alias does not already exist, it is created.
698 \end_layout
700 \begin_layout Subsubsection
701 unalias-command <command>
702 \end_layout
704 \begin_layout Standard
705 Clear alias expansion for <command>.
706 \end_layout
708 \begin_layout Subsubsection
709 show-aliases
710 \end_layout
712 \begin_layout Standard
713 Print all aliases and their expansions in effect.
714 \end_layout
716 \begin_layout Subsection
717 run-script <script>
718 \end_layout
720 \begin_layout Standard
721 Run <script> as if commands were entered on the command line.
722 \end_layout
724 \begin_layout Subsection
725 Video dumping
726 \end_layout
728 \begin_layout Standard
729 Following commands control video dumping:
730 \end_layout
732 \begin_layout Subsubsection
733 start-dump <dumper> [<mode>] <prefix/filename>
734 \end_layout
736 \begin_layout Standard
737 Start dumping using dumper <dumper>.
738  If mode is present or not and if prefix or filename is present depends
739  on the dumper and dumper mode.
740 \end_layout
742 \begin_layout Standard
743 The following dumpers are available:
744 \end_layout
746 \begin_layout Itemize
747 INTERNAL-AVI-CSCD: Internal CSCD in .avi dumper.
748 \end_layout
750 \begin_deeper
751 \begin_layout Itemize
752 Mode: uncompressed/pcm: Uncompressed video, PCM audio.
753  Takes prefix.
754 \end_layout
756 \begin_layout Itemize
757 Mode: cscd/pcm: CSCD video, PCM audio.
758  Takes prefix.
759 \end_layout
761 \end_deeper
762 \begin_layout Itemize
763 INTERNAL-JMD: Internal .jmd dumper.
764 \end_layout
766 \begin_deeper
767 \begin_layout Itemize
768 Does not take mode.
769 \end_layout
771 \begin_layout Itemize
772 Takes a filename.
773 \end_layout
775 \end_deeper
776 \begin_layout Itemize
777 INTERNAL-RAW: Internal RAW dumper.
778 \end_layout
780 \begin_deeper
781 \begin_layout Itemize
782 Does not take mode.
783 \end_layout
785 \begin_layout Itemize
786 Takes a prefix.
787 \end_layout
789 \begin_layout Itemize
790 Sound is big-endian signed 16-bit, usually at 32040.5Hz.
791 \end_layout
793 \begin_layout Itemize
794 Video is always upscaled to double resolution (512x448 / 512 x 478).
795 \end_layout
797 \begin_layout Itemize
798 Video framerate is usually 322445/6448 fps for PAL and 10738636/178683 fps
799  for NTSC.
800 \end_layout
802 \end_deeper
803 \begin_layout Itemize
804 INTERNAL-SDMP: Internal SDMP dumper.
805 \end_layout
807 \begin_deeper
808 \begin_layout Itemize
809 Mode 'ms': Multi-segment.
810  Takes prefix.
811 \end_layout
813 \begin_layout Itemize
814 Mode 'ss': Single-segment.
815  Takes filename.
816 \end_layout
818 \end_deeper
819 \begin_layout Subsubsection
820 end-dump <dumper>
821 \end_layout
823 \begin_layout Standard
824 End dumping using <dumper>
825 \end_layout
827 \begin_layout Subsubsection
828 show-dumpers [<dumper>]
829 \end_layout
831 \begin_layout Standard
832 Show the list of dumpers or list of modes for <dumper>
833 \end_layout
835 \begin_layout Subsection
836 Memory manipulation
837 \end_layout
839 \begin_layout Standard
840 <address> may be decimal or hexadecimal (prefixed with '0x').
841  <value> can be hexadecimal (prefixed with '0x'), unsigned or signed (prefixed
842  with '-') decimal.
843 \end_layout
845 \begin_layout Standard
846 The available element <sizes> are:
847 \end_layout
849 \begin_layout Itemize
850 byte: 1 byte
851 \end_layout
853 \begin_layout Itemize
854 word: 2 bytes
855 \end_layout
857 \begin_layout Itemize
858 dword: 4 bytes
859 \end_layout
861 \begin_layout Itemize
862 qword: 8 bytes
863 \end_layout
865 \begin_layout Standard
866 When reading RAM and ROM, multi-byte reads/writes are big-endian.
867  When dealing with DSP memory, multi-byte reads/writes are native-endian
868  (do not use operand sizes exceeding DSP bitness, except dword is OK for
869  24-bit memory).
870 \end_layout
872 \begin_layout Subsubsection
873 read-<size> <address>
874 \end_layout
876 \begin_layout Standard
877 Read the value of byte in <address>.
878 \end_layout
880 \begin_layout Subsubsection
881 read-s<size> <address>
882 \end_layout
884 \begin_layout Standard
885 Read the value of signed byte in <address>.
886 \end_layout
888 \begin_layout Subsubsection
889 write-<size> <address> <value>
890 \end_layout
892 \begin_layout Standard
893 Write <value> to byte in address <address>.
894 \end_layout
896 \begin_layout Subsubsection
897 search-memory reset
898 \end_layout
900 \begin_layout Standard
901 Reset the memory search
902 \end_layout
904 \begin_layout Subsubsection
905 search-memory count
906 \end_layout
908 \begin_layout Standard
909 Print number of candidates remaining
910 \end_layout
912 \begin_layout Subsubsection
913 search-memory print
914 \end_layout
916 \begin_layout Standard
917 Print all candidates remaining
918 \end_layout
920 \begin_layout Subsubsection
921 search-memory <usflag><sizeflag><op>
922 \end_layout
924 \begin_layout Standard
925 Searches memory for addresses satisfying criteria.
926 \end_layout
928 \begin_layout Standard
929 <usflag> can be:
930 \end_layout
932 \begin_layout Itemize
933 u: unsigned
934 \end_layout
936 \begin_layout Itemize
937 s: signed
938 \end_layout
940 \begin_layout Standard
941 <sizeflag> can be:
942 \end_layout
944 \begin_layout Itemize
945 b: byte
946 \end_layout
948 \begin_layout Itemize
949 w: word
950 \end_layout
952 \begin_layout Itemize
953 d: dword
954 \end_layout
956 \begin_layout Itemize
957 q: qword
958 \end_layout
960 \begin_layout Standard
961 <op> can be:
962 \end_layout
964 \begin_layout Itemize
965 lt: < previous value.
966 \end_layout
968 \begin_layout Itemize
969 le: <= previous value.
970 \end_layout
972 \begin_layout Itemize
973 eq: = previous value.
974 \end_layout
976 \begin_layout Itemize
977 ne: != previous value.
978 \end_layout
980 \begin_layout Itemize
981 ge: >= previous value.
982 \end_layout
984 \begin_layout Itemize
985 gt: > previous value.
986 \end_layout
988 \begin_layout Subsubsection
989 search-memory <sizeflag> <value>
990 \end_layout
992 \begin_layout Standard
993 Searches for addresses that currently have value <value>.
994  <sizeflag> is as in previous command.
995 \end_layout
997 \begin_layout Subsection
998 Main commands
999 \end_layout
1001 \begin_layout Standard
1002 These commands are not available in lsnesrc, but are available after ROM
1003  has been loaded.
1004 \end_layout
1006 \begin_layout Subsubsection
1007 quit-emulator [/y]
1008 \end_layout
1010 \begin_layout Standard
1011 Quits the emulator (asking for confirmation).
1012  If /y is given, no confirmation is asked.
1013 \end_layout
1015 \begin_layout Subsubsection
1016 pause-emulator
1017 \end_layout
1019 \begin_layout Standard
1020 Toggle paused/unpaused
1021 \end_layout
1023 \begin_layout Subsubsection
1024 +advance-frame 
1025 \end_layout
1027 \begin_layout Standard
1028 Advance frame.
1029  If the button is still held after configurable timeout expires, game unpauses
1030  for the duration frame advance is held.
1031 \end_layout
1033 \begin_layout Subsubsection
1034 +advance-poll 
1035 \end_layout
1037 \begin_layout Standard
1038 Advance subframe.
1039  If the button is still held after configurable timeout expires, game unpauses
1040  for the duration frame advance is held.
1041 \end_layout
1043 \begin_layout Subsubsection
1044 advance-skiplag 
1045 \end_layout
1047 \begin_layout Standard
1048 Skip to first poll in frame after current.
1049 \end_layout
1051 \begin_layout Subsubsection
1052 reset 
1053 \end_layout
1055 \begin_layout Standard
1056 Reset the SNES after this frame.
1057 \end_layout
1059 \begin_layout Subsubsection
1060 load <filename> 
1061 \end_layout
1063 \begin_layout Standard
1064 Load savestate <filename> in current mode.
1065 \end_layout
1067 \begin_layout Subsubsection
1068 load-state <filename> 
1069 \end_layout
1071 \begin_layout Standard
1072 Load savestate <filename> in readwrite mode.
1073 \end_layout
1075 \begin_layout Subsubsection
1076 load-readonly <filename> 
1077 \end_layout
1079 \begin_layout Standard
1080 Load savestate <filename> in readonly mode.
1081 \end_layout
1083 \begin_layout Subsubsection
1084 load-preserve <filename> 
1085 \end_layout
1087 \begin_layout Standard
1088 Load savestate <filename> in readonly mode, preserving current events.
1089 \end_layout
1091 \begin_layout Subsubsection
1092 load-movie <filename> 
1093 \end_layout
1095 \begin_layout Standard
1096 Load savestate <filename>, ignoring save part in readonly mode.
1097 \end_layout
1099 \begin_layout Subsubsection
1100 save-state <filename> 
1101 \end_layout
1103 \begin_layout Standard
1104 Save system state to <filename> as soon as possible.
1105 \end_layout
1107 \begin_layout Subsubsection
1108 save-movie <filename> 
1109 \end_layout
1111 \begin_layout Standard
1112 Save movie to <filename>.
1113 \end_layout
1115 \begin_layout Subsubsection
1116 set-rwmode 
1117 \end_layout
1119 \begin_layout Standard
1120 Set read-write mode.
1121 \end_layout
1123 \begin_layout Subsubsection
1124 set-romode 
1125 \end_layout
1127 \begin_layout Standard
1128 Set read-only mode
1129 \end_layout
1131 \begin_layout Subsubsection
1132 toggle-rwmode 
1133 \end_layout
1135 \begin_layout Standard
1136 Toggle between read-only and read-write modes.
1137 \end_layout
1139 \begin_layout Subsubsection
1140 set-gamename <name> 
1141 \end_layout
1143 \begin_layout Standard
1144 Set name of the game to <name>
1145 \end_layout
1147 \begin_layout Subsubsection
1148 get-gamename 
1149 \end_layout
1151 \begin_layout Standard
1152 Print the name of the game.
1153 \end_layout
1155 \begin_layout Subsubsection
1156 add-author <author> 
1157 \end_layout
1159 \begin_layout Standard
1160 Adds new author <author>.
1161  If <author> does not contain '|' it is full name.
1162  If it contains '|', '|' splits the full name and nickname.
1163 \end_layout
1165 \begin_layout Subsubsection
1166 edit-author <num> <author> 
1167 \end_layout
1169 \begin_layout Standard
1170 Edit the author in slot <num> (0-based) to be <author> (see add-author for
1171  format)
1172 \end_layout
1174 \begin_layout Subsubsection
1175 remove-author <num> 
1176 \end_layout
1178 \begin_layout Standard
1179 Remove author in slot <num>
1180 \end_layout
1182 \begin_layout Subsubsection
1183 print-authors 
1184 \end_layout
1186 \begin_layout Standard
1187 Print authors.
1188 \end_layout
1190 \begin_layout Subsubsection
1191 test-1, test-2, test-3
1192 \end_layout
1194 \begin_layout Standard
1195 Internal test commands.
1196  Don't use.
1197 \end_layout
1199 \begin_layout Subsubsection
1200 take-screenshot <filename> 
1201 \end_layout
1203 \begin_layout Standard
1204 Save screenshot to <filename>.
1205 \end_layout
1207 \begin_layout Subsubsection
1208 +controller<num><button>
1209 \end_layout
1211 \begin_layout Standard
1212 Press button <button> on controller <num> (1-8).
1213  The following button names are known:
1214 \end_layout
1216 \begin_layout Itemize
1217 left
1218 \end_layout
1220 \begin_layout Itemize
1221 right
1222 \end_layout
1224 \begin_layout Itemize
1226 \end_layout
1228 \begin_layout Itemize
1229 down
1230 \end_layout
1232 \begin_layout Itemize
1234 \end_layout
1236 \begin_layout Itemize
1238 \end_layout
1240 \begin_layout Itemize
1242 \end_layout
1244 \begin_layout Itemize
1246 \end_layout
1248 \begin_layout Itemize
1250 \end_layout
1252 \begin_layout Itemize
1254 \end_layout
1256 \begin_layout Itemize
1257 select
1258 \end_layout
1260 \begin_layout Itemize
1261 start
1262 \end_layout
1264 \begin_layout Itemize
1265 trigger
1266 \end_layout
1268 \begin_layout Itemize
1269 cursor
1270 \end_layout
1272 \begin_layout Itemize
1273 pause
1274 \end_layout
1276 \begin_layout Itemize
1277 turbo
1278 \end_layout
1280 \begin_layout Subsubsection
1281 controllerh<num><button>
1282 \end_layout
1284 \begin_layout Standard
1285 Hold/unhold button <button> on controller <num> (1-8).
1286  See +controller for button names.
1287 \end_layout
1289 \begin_layout Subsubsection
1290 controllerf<num><button>
1291 \end_layout
1293 \begin_layout Standard
1294 Hold/unhold button <button> on controller <num> (1-8) for the next frame.
1295  See +controller for button names.
1296 \end_layout
1298 \begin_layout Standard
1299 Cauntion: Does not work properly if outside frame advance.
1300 \end_layout
1302 \begin_layout Subsubsection
1303 autofire (<pattern>|-)...
1304 \end_layout
1306 \begin_layout Standard
1307 Set autofire pattern.
1308  Each parameter is comma-separated list of button names (in form of 1start,
1309  1A, 2B, etc..) to hold on that frame.
1310  After reaching the end of pattern, the pattern restarts from the beginning.
1311 \end_layout
1313 \begin_layout Subsubsection
1314 repaint
1315 \end_layout
1317 \begin_layout Standard
1318 Force a repaint.
1319 \end_layout
1321 \begin_layout Subsection
1322 Save jukebox 
1323 \end_layout
1325 \begin_layout Subsubsection
1326 cycle-jukebox-backward
1327 \end_layout
1329 \begin_layout Standard
1330 Cycle save jukebox backwards.
1331 \end_layout
1333 \begin_layout Subsubsection
1334 cycle-jukebox-forward
1335 \end_layout
1337 \begin_layout Standard
1338 Cycle save jukebox forwards
1339 \end_layout
1341 \begin_layout Subsubsection
1342 load-jukebox
1343 \end_layout
1345 \begin_layout Standard
1346 Do load from jukebox (current mode).
1347 \end_layout
1349 \begin_layout Subsubsection
1350 save-jukebox
1351 \end_layout
1353 \begin_layout Standard
1354 Do state save to jukebox.
1355 \end_layout
1357 \begin_layout Subsection
1358 Lua 
1359 \end_layout
1361 \begin_layout Standard
1362 Only available if lua support is compiled in.
1363 \end_layout
1365 \begin_layout Subsubsection
1366 evaluate-lua <luacode>
1367 \end_layout
1369 \begin_layout Standard
1370 Run Lua code <luacode> using built-in Lua interpretter.
1371 \end_layout
1373 \begin_layout Subsubsection
1374 run-lua <script>
1375 \end_layout
1377 \begin_layout Standard
1378 Run specified lua file using built-in Lua interpretter.
1379 \end_layout
1381 \begin_layout Subsubsection
1382 reset-lua
1383 \end_layout
1385 \begin_layout Standard
1386 Clear the Lua VM state and restore to factory defaults.
1387 \end_layout
1389 \begin_layout Subsection
1390 Memory watch
1391 \end_layout
1393 \begin_layout Subsubsection
1394 add-watch <name> <expression>
1395 \end_layout
1397 \begin_layout Standard
1398 Adds new watch (or modifies old one).
1399 \end_layout
1401 \begin_layout Subsubsection
1402 remove-watch <name>
1403 \end_layout
1405 \begin_layout Standard
1406 Remove a watch.
1407 \end_layout
1409 \begin_layout Subsection
1410 Sound 
1411 \end_layout
1413 \begin_layout Subsubsection
1414 enable-sound <on/off> 
1415 \end_layout
1417 \begin_layout Standard
1418 Enable/Disable sound.
1419 \end_layout
1421 \begin_layout Subsubsection
1422 set-sound-device <device> 
1423 \end_layout
1425 \begin_layout Standard
1426 Set sound device to <device>
1427 \end_layout
1429 \begin_layout Subsubsection
1430 show-sound-status 
1431 \end_layout
1433 \begin_layout Standard
1434 Show status of sound system.
1435 \end_layout
1437 \begin_layout Subsubsection
1438 show-sound-devices
1439 \end_layout
1441 \begin_layout Standard
1442 Show all available devices.
1443 \end_layout
1445 \begin_layout Subsubsection
1446 set-volume <multiplier>
1447 \end_layout
1449 \begin_layout Standard
1450 Set the volume multiplier to <multiplier>.
1451  1 is normal volume, and higher numbers are louder.
1452 \end_layout
1454 \begin_layout Subsubsection
1455 set-volume <multiplier>%
1456 \end_layout
1458 \begin_layout Standard
1459 Set the volume multiplier to <multiplier> percent.
1460  100 is normal volume, and higher numbers are louder.
1461 \end_layout
1463 \begin_layout Subsubsection
1464 set-volume <multiplier>dB
1465 \end_layout
1467 \begin_layout Standard
1468 Set the volume multiplier to <multiplier> dB.
1469  0 is normal volume, and higher numbers are louder.
1470  The value may be negative.
1471 \end_layout
1473 \begin_layout Subsection
1474 Misc.
1475 \end_layout
1477 \begin_layout Subsubsection
1478 reload-rom [<file>]
1479 \end_layout
1481 \begin_layout Standard
1482 Reloads the main ROM image from <file>.
1483 \end_layout
1485 \begin_layout Subsubsection
1486 edit-subtitle <firstframe> <length> [<text>]
1487 \end_layout
1489 \begin_layout Standard
1490 Edit or delete a subtitle.
1491 \end_layout
1493 \begin_layout Subsubsection
1494 list-subtitle
1495 \end_layout
1497 \begin_layout Standard
1498 List subtitles.
1499 \end_layout
1501 \begin_layout Subsection
1502 Commentary track
1503 \end_layout
1505 \begin_layout Subsubsection
1506 list-streams
1507 \end_layout
1509 \begin_layout Standard
1510 List streams
1511 \end_layout
1513 \begin_layout Subsubsection
1514 play-stream <id>
1515 \end_layout
1517 \begin_layout Standard
1518 Play stream <id>.
1519 \end_layout
1521 \begin_layout Subsubsection
1522 delete-stream <id>
1523 \end_layout
1525 \begin_layout Standard
1526 Delete stream <id>
1527 \end_layout
1529 \begin_layout Subsubsection
1530 change-timebase <id> <newbase>
1531 \end_layout
1533 \begin_layout Standard
1534 Change time base of <id> to <newbase>.
1535  The time base can be given as samples (integer) or second (postfix with
1536  s).
1537 \end_layout
1539 \begin_layout Subsubsection
1540 import-stream-opus <timebase> <file>
1541 \end_layout
1543 \begin_layout Standard
1544 Import opus stream from <file>, placing it at <timebase>.
1545  This operation is lossless.
1546 \end_layout
1548 \begin_layout Subsubsection
1549 import-stream-pcm <timebase> <file>
1550 \end_layout
1552 \begin_layout Standard
1553 Import PCM (.sox, 1ch@48kHz) stream from <file>, placing it at <timebase>.
1554 \end_layout
1556 \begin_layout Subsubsection
1557 export-stream-opus <id> <file>
1558 \end_layout
1560 \begin_layout Standard
1561 Export stream <id> as opus stream to <file>.
1562  This operation is lossless.
1563 \end_layout
1565 \begin_layout Subsubsection
1566 export-stream-pcm <id> <file>
1567 \end_layout
1569 \begin_layout Standard
1570 Export stream <id> as PCM (.sox) stream to <file>.
1572 \end_layout
1574 \begin_layout Subsubsection
1575 export-superstream <file>
1576 \end_layout
1578 \begin_layout Standard
1579 Export the entiere superstream as PCM (.sox) stream to <file>.
1580 \end_layout
1582 \begin_layout Subsubsection
1583 load-collection <file>
1584 \end_layout
1586 \begin_layout Standard
1587 Load collection (if there is existing collection, unload it) from <file>
1588 \end_layout
1590 \begin_layout Subsubsection
1591 unload-collection
1592 \end_layout
1594 \begin_layout Standard
1595 Unload collection.
1596 \end_layout
1598 \begin_layout Subsubsection
1599 +tangent
1600 \end_layout
1602 \begin_layout Standard
1603 Tangent for recording voice for commentary track.
1604  While pressed, record a stream.
1605 \end_layout
1607 \begin_layout Subsection
1608 SDL Platform commands 
1609 \end_layout
1611 \begin_layout Standard
1612 The following are valid on SDL platform.
1613 \end_layout
1615 \begin_layout Subsubsection
1616 identify-key
1617 \end_layout
1619 \begin_layout Standard
1620 Asks to press a key and then identifies that (pseudo-)key.
1621 \end_layout
1623 \begin_layout Subsubsection
1624 toggle-console 
1625 \end_layout
1627 \begin_layout Standard
1628 Toggle between windowed/fullscreen console.
1629 \end_layout
1631 \begin_layout Subsubsection
1632 scroll-fullup 
1633 \end_layout
1635 \begin_layout Standard
1636 Scroll messages window as far back as it goes.
1637 \end_layout
1639 \begin_layout Subsubsection
1640 scroll-fulldown 
1641 \end_layout
1643 \begin_layout Standard
1644 Scroll messages window as far forward as it goes.
1645 \end_layout
1647 \begin_layout Subsubsection
1648 scroll-up 
1649 \end_layout
1651 \begin_layout Standard
1652 Scroll messages window back one screenful.
1653 \end_layout
1655 \begin_layout Subsubsection
1656 scroll-down 
1657 \end_layout
1659 \begin_layout Standard
1660 Scroll messages window forward one screenful.
1661 \end_layout
1663 \begin_layout Subsubsection
1664 prompt-command <command>
1665 \end_layout
1667 \begin_layout Standard
1668 Enter command prompt, with prompt prepopulated with specified command.
1669 \end_layout
1671 \begin_layout Section
1672 Settings
1673 \end_layout
1675 \begin_layout Subsection
1676 Core settings
1677 \end_layout
1679 \begin_layout Subsubsection
1680 firmwarepath
1681 \end_layout
1683 \begin_layout Standard
1684 Set where bsnes looks for firmware files.
1685  Default is 
1686 \begin_inset Quotes eld
1687 \end_inset
1690 \begin_inset Quotes erd
1691 \end_inset
1694 \end_layout
1696 \begin_layout Subsubsection
1697 target
1698 \end_layout
1700 \begin_layout Standard
1701 Set the target .
1702  Numeric, range is 0.001 to 
1703 \begin_inset Quotes eld
1704 \end_inset
1706 infinite
1707 \begin_inset Quotes erd
1708 \end_inset
1711  Default is native framerate.
1712 \end_layout
1714 \begin_layout Subsubsection
1715 savecompression
1716 \end_layout
1718 \begin_layout Standard
1719 Set save compression level (integer 0-9).
1720  Default is 7 (0 is no compression).
1721 \end_layout
1723 \begin_layout Subsubsection
1724 advance-timeout
1725 \end_layout
1727 \begin_layout Standard
1728 Set the frame advance timeout in milliseconds.
1729  Numeric integer, range is 0-999999999.
1730  Default is 500.
1731 \end_layout
1733 \begin_layout Subsubsection
1734 allow-inconsistent-saves (bsnes only)
1735 \end_layout
1737 \begin_layout Standard
1738 If true, save without synchronization.
1739  Makes games seriously unstable.
1740 \end_layout
1742 \begin_layout Subsubsection
1743 save-every-frame (bsnes only)
1744 \end_layout
1746 \begin_layout Standard
1747 If true, simulate saving on each frame.
1748  Trades off emulation accuracy for sync stability.
1749  Also needed if the movie assumes saving on each frame for rewind.
1750 \end_layout
1752 \begin_layout Subsection
1753 AVI dumper settings
1754 \end_layout
1756 \begin_layout Subsubsection
1757 avi-large
1758 \end_layout
1760 \begin_layout Standard
1761 AVI dumper: Always dump at 512x448 or 512x478 regardless of what the console
1762  outputs.
1763 \end_layout
1765 \begin_layout Subsubsection
1766 avi-left-border
1767 \end_layout
1769 \begin_layout Standard
1770 AVI dumper: Set the default left border thickness (unless lua overrides)
1771  for dumps.
1772  Range 0-8191.
1773  Default is 0.
1774 \end_layout
1776 \begin_layout Subsubsection
1777 avi-right-border
1778 \end_layout
1780 \begin_layout Standard
1781 AVI dumper: Set the default right border thickness (unless lua overrides)
1782  for dumps.
1783  Range 0-8191.
1784  Default is 0.
1785 \end_layout
1787 \begin_layout Subsubsection
1788 avi-top-border
1789 \end_layout
1791 \begin_layout Standard
1792 AVI dumper: Set the default top border thickness (unless lua overrides)
1793  for dumps.
1794  Range 0-8191.
1795  Default is 0.
1796 \end_layout
1798 \begin_layout Subsubsection
1799 avi-bottom-border
1800 \end_layout
1802 \begin_layout Standard
1803 AVI dumper: Set the default bottom border thickness (unless lua overrides)
1804  for dumps.
1805  Range 0-8191.
1806  Default is 0.
1807 \end_layout
1809 \begin_layout Subsubsection
1810 avi-maxframes
1811 \end_layout
1813 \begin_layout Standard
1814 AVI dumper: Maximum number of frames per dump segment (0 => unlimited).
1815  Range 0-999999999.
1816  Default is 0.
1817 \end_layout
1819 \begin_layout Subsubsection
1820 avi-compresison
1821 \end_layout
1823 \begin_layout Standard
1824 AVI dumper: Compression level (0-18).
1825 \end_layout
1827 \begin_layout Itemize
1828 Compression levels 10 and above are not compatible with stock CSCD codec.
1829 \end_layout
1831 \begin_layout Itemize
1832 Recomended level is 7.
1833 \end_layout
1835 \begin_layout Subsubsection
1836 avi-soundrate
1837 \end_layout
1839 \begin_layout Standard
1840 AVI dumper: Set method of determining the sound rate.
1841 \end_layout
1843 \begin_layout Itemize
1844 0: Pick nearest of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48, 64, 88.2, 96,
1845  128, 176.4 and 192 kHz.
1846 \end_layout
1848 \begin_layout Itemize
1849 1: Round down to nearest integer.
1850 \end_layout
1852 \begin_layout Itemize
1853 2: Round up to nearest ingeter.
1854 \end_layout
1856 \begin_layout Subsection
1857 JMD options
1858 \end_layout
1860 \begin_layout Subsubsection
1861 jmd-copression
1862 \end_layout
1864 \begin_layout Standard
1865 JMD dumper: Compression level (0-9).
1866 \end_layout
1868 \begin_layout Subsection
1869 SDL platform settings
1870 \end_layout
1872 \begin_layout Subsubsection
1873 autorepeat-first-delay
1874 \end_layout
1876 \begin_layout Standard
1877 Sets the delay for first character in typematic autorepeat.
1878 \end_layout
1880 \begin_layout Subsubsection
1881 autorepeat-subsequent-delay
1882 \end_layout
1884 \begin_layout Standard
1885 Sets the delay for subsequent characters in typematic autorepeat.
1886 \end_layout
1888 \begin_layout Section
1889 Lua functions
1890 \end_layout
1892 \begin_layout Subsection
1893 Core (in main table)
1894 \end_layout
1896 \begin_layout Subsubsection
1897 print
1898 \end_layout
1900 \begin_layout Standard
1901 Print line to message console.
1902 \end_layout
1904 \begin_layout Subsubsection
1905 exec(string command)
1906 \end_layout
1908 \begin_layout Standard
1909 Run command as it was entered on the command line
1910 \end_layout
1912 \begin_layout Subsubsection
1913 utime()
1914 \end_layout
1916 \begin_layout Standard
1917 Returns two values.
1918  First is time since some epoch in seconds, the second is microseconds mod
1919  10^6 since that epoch.
1920 \end_layout
1922 \begin_layout Subsubsection
1923 emulator_ready()
1924 \end_layout
1926 \begin_layout Standard
1927 Returns true if emulator has finished booting, false if not (on_startup()
1928  will be issued later).
1929 \end_layout
1931 \begin_layout Subsubsection
1932 set_idle_timeout(number timeout)
1933 \end_layout
1935 \begin_layout Standard
1936 Set number of microseconds to block idle for.
1937  After this timeout has expired, on_idle() will be called once.
1938 \end_layout
1940 \begin_layout Subsubsection
1941 set_timer_timeout(number timeout)
1942 \end_layout
1944 \begin_layout Standard
1945 Set number of microseconds to block timer for.
1946  After this timeout has expired, on_timer() will be called once.
1947 \end_layout
1949 \begin_layout Subsubsection
1950 bus_address(number snesaddr)
1951 \end_layout
1953 \begin_layout Standard
1954 Returns virtual address corresponding to specified address on SNES bus.
1955 \end_layout
1957 \begin_layout Subsubsection
1958 loopwrapper(function fun, ...)
1959 \end_layout
1961 \begin_layout Standard
1962 Calls function fun with function and specified arguments.
1963  The function passed suspends execution until the function returned is called.
1964  Handy for linear flow control among multiple invocations of a hook.
1965  Example code:
1966 \end_layout
1968 \begin_layout LyX-Code
1969 on_paint = loopwrapper(function(wait)
1970 \end_layout
1972 \begin_deeper
1973 \begin_layout LyX-Code
1974 while true do
1975 \end_layout
1977 \begin_deeper
1978 \begin_layout LyX-Code
1979 gui.text(0, 0, 
1980 \begin_inset Quotes eld
1981 \end_inset
1983 Test!
1984 \begin_inset Quotes erd
1985 \end_inset
1988 \end_layout
1990 \begin_layout LyX-Code
1991 wait();
1992 \end_layout
1994 \end_deeper
1995 \begin_layout LyX-Code
1997 \end_layout
1999 \end_deeper
2000 \begin_layout LyX-Code
2001 end);
2002 \end_layout
2004 \begin_layout Subsection
2005 Table bit:
2006 \end_layout
2008 \begin_layout Standard
2009 Bitwise logical functions and related.
2010 \end_layout
2012 \begin_layout Subsubsection
2013 bit.none(number...) / bit.bnot(number...)
2014 \end_layout
2016 \begin_layout Standard
2017 48-bit bitwise NOT / NONE function (set bits that are set in none of the
2018  arguments).
2019 \end_layout
2021 \begin_layout Subsubsection
2022 bit.any(number...) / bit.bor(number...)
2023 \end_layout
2025 \begin_layout Standard
2026 48-bit bitwise OR / ANY function (set bits that are set in any of the arguments).
2027 \end_layout
2029 \begin_layout Subsubsection
2030 bit.all(number...) / bit.band(number...)
2031 \end_layout
2033 \begin_layout Standard
2034 48-bit bitwise AND / ALL function (set bits that are set in all of the arguments
2036 \end_layout
2038 \begin_layout Subsubsection
2039 bit.parity(number...) / bit.bxor(number...)
2040 \end_layout
2042 \begin_layout Standard
2043 48-bit bitwise XOR / PARITY function (set bits that are set in odd number
2044  of the arguments).
2045 \end_layout
2047 \begin_layout Subsubsection
2048 bit.lrotate(number base[, number amount[, number bits]])
2049 \end_layout
2051 \begin_layout Standard
2052 Rotate bits-bit (max 48, default 48) number left by amount (default 1) places.
2053 \end_layout
2055 \begin_layout Subsubsection
2056 bit.rrotate(number base[, number amount[, number bits]])
2057 \end_layout
2059 \begin_layout Standard
2060 Rotate bits-bit (max 48, default 48) number right by amount (default 1)
2061  places.
2062 \end_layout
2064 \begin_layout Subsubsection
2065 bit.lshift(number base[, number amount[, number bits]])
2066 \end_layout
2068 \begin_layout Standard
2069 Shift bits-bit (max 48, default 48) number left by amount (default 1) places.
2070  The new bits are filled with zeroes.
2071 \end_layout
2073 \begin_layout Subsubsection
2074 bit.lrshift(number base[, number amount[, number bits]])
2075 \end_layout
2077 \begin_layout Standard
2078 Shift bits-bit (max 48, default 48) number logically right by amount (default
2079  1) places.
2080  The new bits are filled with zeroes.
2081 \end_layout
2083 \begin_layout Subsubsection
2084 bit.arshift(number base[, number amount[, number bits]])
2085 \end_layout
2087 \begin_layout Standard
2088 Shift bits-bit (max 48, default 48) number arithmetically right by amount
2089  (default 1) places.
2090  The new bits are shifted in with copy of the high bit.
2091 \end_layout
2093 \begin_layout Subsubsection
2094 bit.extract(number base[, number bit0[, number bit1,...]])
2095 \end_layout
2097 \begin_layout Standard
2098 Returns number that has bit0-th bit as bit 0, bit1-th bit as 1 and so on.
2099 \end_layout
2101 \begin_layout Standard
2102 Notes: 
2103 \end_layout
2105 \begin_layout Itemize
2106 Bit numbers up to 51 should work reliably (then things start falling apart
2107  due to double precision issues).
2108 \end_layout
2110 \begin_layout Itemize
2111 There are two special bit positions, true and false, standing for always
2112  set bit and always clear bit.
2113 \end_layout
2115 \begin_layout Subsubsection
2116 bit.value([number bit1[, number bit2,...]])
2117 \end_layout
2119 \begin_layout Standard
2120 Returns bitwise OR of 1 left shifted by bit1 places, 1 left shifted by bit2
2121  places and so on.
2122  As special value, nil argument is no-op.
2123 \end_layout
2125 \begin_layout Subsection
2126 Table gui:
2127 \end_layout
2129 \begin_layout Standard
2130 Most of these functions can only be called in on_paint and on_video callbacks.
2131  Exceptions are noted.
2132 \end_layout
2134 \begin_layout Standard
2135 Colors are 32-bit.
2136  Bits 0-7 are the blue component, bits 8-15 are the green component, bits
2137  16-23 are the red component, bits 24-31 are alpha component (0 is fully
2138  opaque, 255 is almost transparent).
2139  -1 is the fully transparent color.
2140  Alpha values greater than 127 do work.
2141 \end_layout
2143 \begin_layout Standard
2144 Origin of coordinates is at top left corner of game display area.
2145  Left and top gaps correspond to negative coordinates.
2146 \end_layout
2148 \begin_layout Subsubsection
2149 gui.resolution()
2150 \end_layout
2152 \begin_layout Standard
2153 Returns 2-tuple (hresolution, vresolution).
2154 \end_layout
2156 \begin_layout Subsubsection
2157 gui.<class>_gap(number gap)
2158 \end_layout
2160 \begin_layout Standard
2161 Set the <class> (left, right, top, bottom) gap to specified value (max gap
2162  is 8191).
2163 \end_layout
2165 \begin_layout Subsubsection
2166 gui.text(number x, number y, string text[, number fgc[, number bgc]])
2167 \end_layout
2169 \begin_layout Standard
2170 Draw specified text on the GUI (each character cell is 8 or 16 wide and
2171  16 high).
2172  Parameters:
2173 \end_layout
2175 \begin_layout Itemize
2176 x: X-coordinate to start the drawing from (and x-coordinate at begining
2177  of the lines).
2178 \end_layout
2180 \begin_layout Itemize
2181 y: Y-coordinate to start the drawing from.
2182 \end_layout
2184 \begin_layout Itemize
2185 text: The text to draw.
2186 \end_layout
2188 \begin_layout Itemize
2189 fgc: Text color (default is 0xFFFFFF (white))
2190 \end_layout
2192 \begin_layout Itemize
2193 bgc: Background color (default is -1 (transparent))
2194 \end_layout
2196 \begin_layout Subsubsection
2197 gui.textH(number x, number y, string text[, number fgc[, number bgc]])
2198 \end_layout
2200 \begin_layout Standard
2201 Like gui.text, but draw using double-width.
2202 \end_layout
2204 \begin_layout Subsubsection
2205 gui.textV(number x, number y, string text[, number fgc[, number bgc]])
2206 \end_layout
2208 \begin_layout Standard
2209 Like gui.text, but draw using double-height.
2210 \end_layout
2212 \begin_layout Subsubsection
2213 gui.textHV(number x, number y, string text[, number fgc[, number bgc]])
2214 \end_layout
2216 \begin_layout Standard
2217 Like gui.text, but draw using double-width/double-height.
2218 \end_layout
2220 \begin_layout Subsubsection
2221 gui.rectangle(number x, number y, number width, number height[, number thickness[
2222 , number outline[, number fill]]])
2223 \end_layout
2225 \begin_layout Standard
2226 Draw rectangle on the GUI.
2227  Parameters:
2228 \end_layout
2230 \begin_layout Itemize
2231 x: X-coordinate of left edge.
2232 \end_layout
2234 \begin_layout Itemize
2235 y: Y-coordinate of upper edge.
2236 \end_layout
2238 \begin_layout Itemize
2239 width: Width of rectangle.
2240 \end_layout
2242 \begin_layout Itemize
2243 height: Height of rectangle.
2244 \end_layout
2246 \begin_layout Itemize
2247 thickness: Thickness of outline (default is 1).
2248 \end_layout
2250 \begin_layout Itemize
2251 outline: Color of outline (default is 0xFFFFFF (white))
2252 \end_layout
2254 \begin_layout Itemize
2255 fill: Color of fill (default is -1 (transparent))
2256 \end_layout
2258 \begin_layout Subsubsection
2259 gui.box(number x, number y, number width, number height[, number thickness[,
2260  number outline1[,number outline2[, number fill]]]])
2261 \end_layout
2263 \begin_layout Standard
2264 Draw rectangle with 3D effect on the GUI.
2265  Parameters:
2266 \end_layout
2268 \begin_layout Itemize
2269 x: X-coordinate of left edge.
2270 \end_layout
2272 \begin_layout Itemize
2273 y: Y-coordinate of upper edge.
2274 \end_layout
2276 \begin_layout Itemize
2277 width: Width of rectangle.
2278 \end_layout
2280 \begin_layout Itemize
2281 height: Height of rectangle.
2282 \end_layout
2284 \begin_layout Itemize
2285 thickness: Thickness of outline (default is 1).
2286 \end_layout
2288 \begin_layout Itemize
2289 outline1: First color of outline (default is 0xFFFFFF (white))
2290 \end_layout
2292 \begin_layout Itemize
2293 outline2: First color of outline (default is 0x808080 (dark gray))
2294 \end_layout
2296 \begin_layout Itemize
2297 fill: Color of fill (default is 0xC0C0C0 (light grayy))
2298 \end_layout
2300 \begin_layout Subsubsection
2301 gui.pixel(number x, number y[, number color])
2302 \end_layout
2304 \begin_layout Standard
2305 Draw one pixel on the GUI.
2306  Parameters:
2307 \end_layout
2309 \begin_layout Itemize
2310 x: X-coordinate of the pixel
2311 \end_layout
2313 \begin_layout Itemize
2314 y: Y-coordinate of the pixel
2315 \end_layout
2317 \begin_layout Itemize
2318 color: Color of the pixel (default is 0xFFFFFF (white))
2319 \end_layout
2321 \begin_layout Subsubsection
2322 gui.crosshair(number x, number y[, number length[, number color]])
2323 \end_layout
2325 \begin_layout Standard
2326 Draw a crosshair.
2327  Parameters:
2328 \end_layout
2330 \begin_layout Itemize
2331 x: X-coordinate of the crosshair
2332 \end_layout
2334 \begin_layout Itemize
2335 y: Y-coordinate of the crosshair
2336 \end_layout
2338 \begin_layout Itemize
2339 length: Length of the crosshair lines (default 10).
2340 \end_layout
2342 \begin_layout Itemize
2343 color: Color of the crosshair (default is 0xFFFFFF (white))
2344 \end_layout
2346 \begin_layout Subsubsection
2347 gui.line(number x1, number y1, number x2, number y2[, number color])
2348 \end_layout
2350 \begin_layout Standard
2351 Draw a thin line.
2352  Parameters:
2353 \end_layout
2355 \begin_layout Itemize
2356 x1: X-coordinate of one end.
2357 \end_layout
2359 \begin_layout Itemize
2360 y1: Y-coordinate of one end.
2361 \end_layout
2363 \begin_layout Itemize
2364 x2: X-coordinate of the other end.
2365 \end_layout
2367 \begin_layout Itemize
2368 y2: Y-coordinate of the other end.
2369 \end_layout
2371 \begin_layout Itemize
2372 color: Color of the line (default is 0xFFFFFF (white)).
2373 \end_layout
2375 \begin_layout Subsubsection
2376 gui.circle(number x, number y, number r[, number thick[, number border[,
2377  number fil]]])
2378 \end_layout
2380 \begin_layout Standard
2381 Draw a circle.
2382  Parameters.
2383 \end_layout
2385 \begin_layout Itemize
2386 x: X-coordinate of the center
2387 \end_layout
2389 \begin_layout Itemize
2390 y: Y-coordinate of the center
2391 \end_layout
2393 \begin_layout Itemize
2394 r: The radius of the circle
2395 \end_layout
2397 \begin_layout Itemize
2398 thick: Border thickness
2399 \end_layout
2401 \begin_layout Itemize
2402 border: Border color (default is 0xFFFFFF (white))
2403 \end_layout
2405 \begin_layout Itemize
2406 fill: Fill color (default is -1 (transparent)).
2407 \end_layout
2409 \begin_layout Subsubsection
2410 gui.bitmap_draw(number x, number y, bitmap bitmap, palette palette)
2411 \end_layout
2413 \begin_layout Standard
2414 Draw a bitmap on screen with specified palette.
2415  Parameters:
2416 \end_layout
2418 \begin_layout Itemize
2419 x: X-coordinate of left edge.
2420 \end_layout
2422 \begin_layout Itemize
2423 y: Y-coordinate of top edge.
2424 \end_layout
2426 \begin_layout Itemize
2427 bitmap: The bitmap to draw
2428 \end_layout
2430 \begin_layout Itemize
2431 palette: The palette to draw the bitmap using.
2432 \end_layout
2434 \begin_layout Subsubsection
2435 gui.bitmap_draw(number x, number y, dbitmap bitmap)
2436 \end_layout
2438 \begin_layout Standard
2439 Draw a bitmap on screen.
2440  Parameters:
2441 \end_layout
2443 \begin_layout Itemize
2444 x: X-coordinate of left edge.
2445 \end_layout
2447 \begin_layout Itemize
2448 y: Y-coordinate of top edge.
2449 \end_layout
2451 \begin_layout Itemize
2452 bitmap: The bitmap to draw
2453 \end_layout
2455 \begin_layout Subsubsection
2456 gui.palette_new()
2457 \end_layout
2459 \begin_layout Standard
2460 Returns a new palette (initially all transparent).
2461  Can be used anywhere.
2462 \end_layout
2464 \begin_layout Subsubsection
2465 gui.bitmap_new(number w, number h, boolean direct[, bool icolor])
2466 \end_layout
2468 \begin_layout Standard
2469 Returns a new bitmap/dbitmap.
2470  Can be used anywhere.
2471  Parameters:
2472 \end_layout
2474 \begin_layout Itemize
2475 w: The width of new bitmap
2476 \end_layout
2478 \begin_layout Itemize
2479 h: The height of new bitmap
2480 \end_layout
2482 \begin_layout Itemize
2483 direct: If true, the returned bitmap is dbitmap, otherwise bitmap.
2484 \end_layout
2486 \begin_layout Itemize
2487 icolor: Initital fill color (defaults to 0 on BITMAP, -1 on DBITMAP)
2488 \end_layout
2490 \begin_layout Subsubsection
2491 gui.bitmap_load(string file)
2492 \end_layout
2494 \begin_layout Standard
2495 Returns loaded bitmap/dbitmap (if bitmap, the second return value is palette
2496  for bitmap).
2497  Can be used anywhere.
2498  Parameters:
2499 \end_layout
2501 \begin_layout Itemize
2502 file: The name of file to load.
2503 \end_layout
2505 \begin_layout Subsubsection
2506 gui.palette_set(palette palette, number index, number color)
2507 \end_layout
2509 \begin_layout Standard
2510 Sets color in palette.
2511  Can be used anywhere.
2512  Parameters:
2513 \end_layout
2515 \begin_layout Itemize
2516 palette: The palette to manipulate
2517 \end_layout
2519 \begin_layout Itemize
2520 index: Index of color (0-65535).
2521 \end_layout
2523 \begin_layout Itemize
2524 color: The color value.
2525 \end_layout
2527 \begin_layout Subsubsection
2528 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y, number color)
2529 \end_layout
2531 \begin_layout Standard
2532 Sets specified pixel in bitmap.
2533  Can be used anywhere.
2534  Parameters:
2535 \end_layout
2537 \begin_layout Itemize
2538 bitmap: The bitmap to manipulate
2539 \end_layout
2541 \begin_layout Itemize
2542 x: The x-coordinate of the pixel.
2543 \end_layout
2545 \begin_layout Itemize
2546 y: The y-coordinate of the pixel.
2547 \end_layout
2549 \begin_layout Itemize
2550 color: If bitmap is a bitmap, color index (0-65535).
2551  Otherwise color value.
2552 \end_layout
2554 \begin_layout Subsubsection
2555 gui.bitmap_size(bitmap/dbitmap bitmap)
2556 \end_layout
2558 \begin_layout Standard
2559 Get size of bitmap.
2560  Can be used anywhere.
2561  Parameters:
2562 \end_layout
2564 \begin_layout Itemize
2565 bitmap: The bitmap to query.
2566 \end_layout
2568 \begin_layout Standard
2569 The first return is the width, the second is the height.
2570 \end_layout
2572 \begin_layout Subsubsection
2573 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy, bitmap/dbitmap
2574  src, number sx, number sy, number w, number h[, number ck])
2575 \end_layout
2577 \begin_layout Standard
2578 Blit a part of bitmap to another.
2579  Can be used anywhere.
2580  Parameters:
2581 \end_layout
2583 \begin_layout Itemize
2584 dest: Destination to blit to.
2585 \end_layout
2587 \begin_layout Itemize
2588 dx: left edge of target
2589 \end_layout
2591 \begin_layout Itemize
2592 dy: Top edge of target
2593 \end_layout
2595 \begin_layout Itemize
2596 src: The source to blit from.
2597  Must be of the same type as destination.
2598 \end_layout
2600 \begin_layout Itemize
2601 sx: left edge of source
2602 \end_layout
2604 \begin_layout Itemize
2605 sy: Top edge of source
2606 \end_layout
2608 \begin_layout Itemize
2609 w: Width of region
2610 \end_layout
2612 \begin_layout Itemize
2613 h: Height of region.
2614 \end_layout
2616 \begin_layout Itemize
2617 ck: Color key.
2618  Pixels of this color are not blitted.
2619 \end_layout
2621 \begin_deeper
2622 \begin_layout Itemize
2623 If bitmaps are bitmaps, this is color index of colorkey.
2624  Values outside range 0-65535 cause no key to be used as colorkey.
2625 \end_layout
2627 \begin_layout Itemize
2628 If bitmaps are dbitmaps, this color value of colorkey.
2629 \end_layout
2631 \begin_layout Itemize
2632 May be absent or nil for no colorkey blit.
2633 \end_layout
2635 \end_deeper
2636 \begin_layout Subsubsection
2637 gui.repaint()
2638 \end_layout
2640 \begin_layout Standard
2641 Request on_repaint() to happen as soon as possible.
2642  Can be used anywhere.
2643 \end_layout
2645 \begin_layout Subsubsection
2646 gui.subframe_update(boolean on)
2647 \end_layout
2649 \begin_layout Standard
2650 Request subframe updates (calling on_paint() on subframes) to happen (on=true)
2651  or not happen (on=false).
2652  Can be used anywhere.
2653 \end_layout
2655 \begin_layout Subsubsection
2656 gui.screenshot(string filename)
2657 \end_layout
2659 \begin_layout Standard
2660 Write PNG screenshot of the current frame (no drawings) to specified file.
2661  Can be used anywhere.
2662 \end_layout
2664 \begin_layout Subsubsection
2665 gui.color(number r, number g, number b[, number a])
2666 \end_layout
2668 \begin_layout Standard
2669 Returns color (in notation Lua scripts use) corresponding to color (r,g,b),
2670  each component in scale 0-255.
2671  If a is specified, that is alpha (0 is fully transparent, 256(sic) is fully
2672  opaque).
2673  The default alpha is 256.
2674 \end_layout
2676 \begin_layout Subsubsection
2677 gui.status(string name, string value)
2678 \end_layout
2680 \begin_layout Standard
2681 Set status field 
2682 \begin_inset Quotes eld
2683 \end_inset
2685 L[<name>]
2686 \begin_inset Quotes erd
2687 \end_inset
2689  to <value> in status area.
2690  Can be used anywhere.
2691 \end_layout
2693 \begin_layout Subsubsection
2694 gui.rainbow(number step, number steps[, number color])
2695 \end_layout
2697 \begin_layout Standard
2698 Perform hue rotation of color <color> (default bright red), by <step> steps.
2699  The number of steps per full rotation is given by absolute value of <steps>.
2700 \end_layout
2702 \begin_layout Standard
2703 If <steps> is negative, the rotation will be counterclockwise.
2704 \end_layout
2706 \begin_layout Subsubsection
2707 gui.screenshot(string filename)
2708 \end_layout
2710 \begin_layout Standard
2711 Saves a screenshot into specified file.
2712 \end_layout
2714 \begin_layout Subsection
2715 table input
2716 \end_layout
2718 \begin_layout Standard
2719 Input handling.
2720  Only available in on_input callback.
2721 \end_layout
2723 \begin_layout Subsubsection
2724 input.get(number controller, number index)
2725 \end_layout
2727 \begin_layout Standard
2728 Read the specified index (0-11) from specified controller (0-7).
2729  Notes:
2730 \end_layout
2732 \begin_layout Itemize
2733 Uses physical controller numbering.
2734  Gamepad in port 2 is controller 4, not 1!
2735 \end_layout
2737 \begin_layout Subsubsection
2738 input.set(number controller, number index, number value)
2739 \end_layout
2741 \begin_layout Standard
2742 Write the specified index (0-11) from specified controller (0-7), storing
2743  value.
2744  Notes:
2745 \end_layout
2747 \begin_layout Itemize
2748 Uses physical controller numbering.
2749  Gamepad in port 2 is controller 4, not 1!
2750 \end_layout
2752 \begin_layout Subsubsection
2753 input.geta(number controller)
2754 \end_layout
2756 \begin_layout Standard
2757 Get input state for entiere controller.
2758  Returns 13 return values.
2759 \end_layout
2761 \begin_layout Itemize
2762 1st return value: Bitmask: bit i is set if i:th index is nonzero
2763 \end_layout
2765 \begin_layout Itemize
2766 2nd-13th return value: value of i:th index.
2767 \end_layout
2769 \begin_layout Subsubsection
2770 input.seta(number controller, number bitmask, number args...)
2771 \end_layout
2773 \begin_layout Standard
2774 Set state for entiere controller.
2775  args is up to 12 values for indices (overriding values in bitmask if specified).
2776 \end_layout
2778 \begin_layout Subsubsection
2779 input.controllertype(number controller)
2780 \end_layout
2782 \begin_layout Standard
2783 Get the type of controller as string.
2784  Valid values are:
2785 \end_layout
2787 \begin_layout Itemize
2788 gamepad
2789 \end_layout
2791 \begin_layout Itemize
2792 mouse
2793 \end_layout
2795 \begin_layout Itemize
2796 justifier
2797 \end_layout
2799 \begin_layout Itemize
2800 superscope
2801 \end_layout
2803 \begin_layout Subsubsection
2804 input.reset([number cycles])
2805 \end_layout
2807 \begin_layout Standard
2808 Execute reset.
2809  If cycles is greater than zero, do delayed reset.
2810  0 (or no value) causes immediate reset.
2811 \end_layout
2813 \begin_layout Itemize
2814 Only available with subframe flag false.
2815 \end_layout
2817 \begin_layout Subsubsection
2818 input.raw()
2819 \end_layout
2821 \begin_layout Standard
2822 Returns table of tables of all available keys and axes.
2823  The first table is indexed by key name (platform-dependent!), and the inner
2824  table has the following fields:
2825 \end_layout
2827 \begin_layout Itemize
2828 last_rawval: Last reported raw value for control.
2829 \end_layout
2831 \begin_layout Itemize
2832 ktype: Type of key (disabled, key, mouse, axis, axis-inverse, hat, pressure-m0,
2833  pressure-mp, pressure-0m, pressure-0p, pressure-pm, pressure-p0).
2834 \end_layout
2836 \begin_layout Itemize
2837 cal_left: Minimum calibration value.
2838  Only meaningful with axis and pressure types.
2839 \end_layout
2841 \begin_layout Itemize
2842 cal_center: Center calibration value.
2843  Only meaningful with axis and pressure types.
2844 \end_layout
2846 \begin_layout Itemize
2847 cal_right: Maximum calibration value.
2848  Only meaningful with axis and pressure types.
2849 \end_layout
2851 \begin_layout Itemize
2852 cal_tolerance: Dead zone tolerance.
2853  Only meaningful with axis and pressure types.
2854 \end_layout
2856 \begin_layout Subsubsection
2857 input.keyhook(string key, boolean state)
2858 \end_layout
2860 \begin_layout Standard
2861 Requests that keyhook events to be sent for key (state=true) or not sent
2862  (state=false).
2863 \end_layout
2865 \begin_layout Subsubsection
2866 input.joyget(number controller)
2867 \end_layout
2869 \begin_layout Standard
2870 Returns table for current controls for specified controller.
2871  The names of fields vary by controller type.
2872 \end_layout
2874 \begin_layout Itemize
2875 The buttons have the same name as those are referred to in other contexts
2876  in the emulator
2877 \end_layout
2879 \begin_layout Itemize
2880 The analog axes are 
2881 \begin_inset Quotes eld
2882 \end_inset
2884 xaxis
2885 \begin_inset Quotes erd
2886 \end_inset
2888  and 
2889 \begin_inset Quotes eld
2890 \end_inset
2892 yaxis
2893 \begin_inset Quotes erd
2894 \end_inset
2897 \end_layout
2899 \begin_layout Subsubsection
2900 input.joyset(number controller, table controls)
2901 \end_layout
2903 \begin_layout Standard
2904 Set the the state of specified controller to values specified in specified
2905  table.
2906 \end_layout
2908 \begin_layout Subsection
2909 Table subtitle
2910 \end_layout
2912 \begin_layout Standard
2913 Subtitle handling
2914 \end_layout
2916 \begin_layout Subsubsection
2917 subtitle.byindex(number i)
2918 \end_layout
2920 \begin_layout Standard
2921 Read the frame and length of ith subtitle.
2922  Returns nothing if not present.
2923 \end_layout
2925 \begin_layout Subsubsection
2926 subtitle.set(number f, number l, string txt)
2927 \end_layout
2929 \begin_layout Standard
2930 Set the text of subtitle.
2931 \end_layout
2933 \begin_layout Subsubsection
2934 subtitle.get(number f, number l)
2935 \end_layout
2937 \begin_layout Standard
2938 Get the text of subtitle.
2939 \end_layout
2941 \begin_layout Subsubsection
2942 subtitle.delete(number f, number l)
2943 \end_layout
2945 \begin_layout Standard
2946 Delete specified subtitle.
2947 \end_layout
2949 \begin_layout Subsection
2950 Table hostmemory
2951 \end_layout
2953 \begin_layout Standard
2954 Host memory handling (extra memory saved to savestates).
2955  Host memory starts empty.
2956 \end_layout
2958 \begin_layout Subsubsection
2959 hostmemory.read(number address)
2960 \end_layout
2962 \begin_layout Standard
2963 Reads hostmemory slot address.
2964  Slot numbers out of range return false instead of numeric.
2965 \end_layout
2967 \begin_layout Subsubsection
2968 hostmemory.write(number address, number value)
2969 \end_layout
2971 \begin_layout Standard
2972 Writes hostmemory slot with 0-255.
2973  Slot numbers out of range cause extension of host memory slot space.
2974 \end_layout
2976 \begin_layout Subsubsection
2977 hostmemory.readbyte(number address)
2978 \end_layout
2980 \begin_layout Standard
2981 Read unsigned byte (1 element) from given address.
2982  Slots out of range return false.
2983 \end_layout
2985 \begin_layout Subsubsection
2986 hostmemory.writebyte(number address, number value)
2987 \end_layout
2989 \begin_layout Standard
2990 Write unsigned byte (1 element) to given slot.
2991  Slot numbers out of range cause extension.
2992 \end_layout
2994 \begin_layout Subsubsection
2995 hostmemory.readsbyte(number address)
2996 \end_layout
2998 \begin_layout Standard
2999 Read signed byte (1 element) from given address.
3000  Slots out of range return false.
3001 \end_layout
3003 \begin_layout Subsubsection
3004 hostmemory.writesbyte(number address, number value)
3005 \end_layout
3007 \begin_layout Standard
3008 Write signed byte (1 element) to given slot.
3009  Slot numbers out of range cause extension.
3010 \end_layout
3012 \begin_layout Subsubsection
3013 hostmemory.readword(number address)
3014 \end_layout
3016 \begin_layout Standard
3017 Read unsigned word (2 elements) from given address.
3018  Slots out of range return false.
3019 \end_layout
3021 \begin_layout Subsubsection
3022 hostmemory.writeword(number address, number value)
3023 \end_layout
3025 \begin_layout Standard
3026 Write unsigned word (2 elements) to given slot.
3027  Slot numbers out of range cause extension.
3028 \end_layout
3030 \begin_layout Subsubsection
3031 hostmemory.readsword(number address)
3032 \end_layout
3034 \begin_layout Standard
3035 Read signed word (2 elements) from given address.
3036  Slots out of range return false.
3037 \end_layout
3039 \begin_layout Subsubsection
3040 hostmemory.writesword(number address, number value)
3041 \end_layout
3043 \begin_layout Standard
3044 Write signed word (2 elements) to given slot.
3045  Slot numbers out of range cause extension.
3046 \end_layout
3048 \begin_layout Subsubsection
3049 hostmemory.readdword(number address)
3050 \end_layout
3052 \begin_layout Standard
3053 Read unsigned doubleword (4 elements) from given address.
3054  Slots out of range return false.
3055 \end_layout
3057 \begin_layout Subsubsection
3058 hostmemory.writedword(number address, number value)
3059 \end_layout
3061 \begin_layout Standard
3062 Write unsigned doubleword (4 elements) to given slot.
3063  Slot numbers out of range cause extension.
3064 \end_layout
3066 \begin_layout Subsubsection
3067 hostmemory.readsdword(number address)
3068 \end_layout
3070 \begin_layout Standard
3071 Read signed doubleword (4 elements) from given address.
3072  Slots out of range return false.
3073 \end_layout
3075 \begin_layout Subsubsection
3076 hostmemory.writesdword(number address, number value)
3077 \end_layout
3079 \begin_layout Standard
3080 Write signed doubleword (4 elements) to given slot.
3081  Slot numbers out of range cause extension.
3082 \end_layout
3084 \begin_layout Subsubsection
3085 hostmemory.readqword(number address)
3086 \end_layout
3088 \begin_layout Standard
3089 Read unsigned quadword (8 elements) from given address.
3090  Slots out of range return false.
3091 \end_layout
3093 \begin_layout Subsubsection
3094 hostmemory.writeqword(number address, number value)
3095 \end_layout
3097 \begin_layout Standard
3098 Write unsigned quadword (4 elements) to given slot.
3099  Slot numbers out of range cause extension.
3100 \end_layout
3102 \begin_layout Subsubsection
3103 hostmemory.readsqword(number address)
3104 \end_layout
3106 \begin_layout Standard
3107 Read signed quadword (8 elements) from given address.
3108  Slots out of range return false.
3109 \end_layout
3111 \begin_layout Subsubsection
3112 hostmemory.writesqword(number address, number value)
3113 \end_layout
3115 \begin_layout Standard
3116 Write signed quadword (8 elements) to given slot.
3117  Slot numbers out of range cause extension.
3118 \end_layout
3120 \begin_layout Subsection
3121 Table movie
3122 \end_layout
3124 \begin_layout Standard
3125 Movie handling
3126 \end_layout
3128 \begin_layout Subsubsection
3129 movie.currentframe()
3130 \end_layout
3132 \begin_layout Standard
3133 Return number of current frame.
3134 \end_layout
3136 \begin_layout Subsubsection
3137 movie.framecount()
3138 \end_layout
3140 \begin_layout Standard
3141 Return number of frames in movie.
3142 \end_layout
3144 \begin_layout Subsubsection
3145 movie.readonly()
3146 \end_layout
3148 \begin_layout Standard
3149 Return true if in readonly mode, false if in readwrite.
3150 \end_layout
3152 \begin_layout Subsubsection
3153 movie.rerecords()
3154 \end_layout
3156 \begin_layout Standard
3157 Returns the current value of rerecord count.
3158 \end_layout
3160 \begin_layout Subsubsection
3161 movie.set_readwrite()
3162 \end_layout
3164 \begin_layout Standard
3165 Set readwrite mode (does not cause on_readwrite callback).
3166 \end_layout
3168 \begin_layout Subsubsection
3169 movie.frame_subframes(number frame)
3170 \end_layout
3172 \begin_layout Standard
3173 Count number of subframes in specified frame (frame numbers are 1-based)
3174  and return that.
3175 \end_layout
3177 \begin_layout Subsubsection
3178 movie.read_subframe(number frame, number subframe)
3179 \end_layout
3181 \begin_layout Standard
3182 Read specifed subframe in specified frame and return data as array (100
3183  elements, numbered 0-99 currently).
3184 \end_layout
3186 \begin_layout Subsubsection
3187 movie.read_rtc()
3188 \end_layout
3190 \begin_layout Standard
3191 Returns the current value of the RTC as a pair (second, subsecond).
3192 \end_layout
3194 \begin_layout Subsubsection
3195 movie.unsafe_rewind([UNSAFEREWIND state])
3196 \end_layout
3198 \begin_layout Standard
3199 Start setting point for unsafe rewind or jump to point of unsafe rewind.
3200 \end_layout
3202 \begin_layout Itemize
3203 If called without argument, causes emulator to start process of setting
3204  unsafe rewind point.
3205  When this has finished, callback on_set_rewind occurs, passing the rewind
3206  state to lua script.
3207 \end_layout
3209 \begin_layout Itemize
3210 If called with argument, causes emulator rewind to passed rewind point as
3211  soon as possible.
3212  Readwrite mode is implicitly activated.
3213 \end_layout
3215 \begin_layout Standard
3216 The following warnings apply to unsafe rewinding:
3217 \end_layout
3219 \begin_layout Itemize
3220 There are no safety checks against misuse (that's what 
3221 \begin_inset Quotes eld
3222 \end_inset
3224 unsafe
3225 \begin_inset Quotes erd
3226 \end_inset
3228  comes from)!
3229 \end_layout
3231 \begin_layout Itemize
3232 Only call rewind from timeline rewind point was set from.
3233 \end_layout
3235 \begin_layout Itemize
3236 Only call rewind from after the rewind point was set.
3237 \end_layout
3239 \begin_layout Subsection
3240 Table settings
3241 \end_layout
3243 \begin_layout Standard
3244 Routines for settings manipulation
3245 \end_layout
3247 \begin_layout Subsubsection
3248 settings.get(string name)
3249 \end_layout
3251 \begin_layout Standard
3252 Get value of setting.
3253  If setting is blank, returns false.
3254  If setting value can't be obtained, returns (nil, error message).
3255 \end_layout
3257 \begin_layout Subsubsection
3258 settings.set(string name, string value)
3259 \end_layout
3261 \begin_layout Standard
3262 Set value of setting.
3263  If setting can't be set, returns (nil, error message).
3264 \end_layout
3266 \begin_layout Subsubsection
3267 settings.is_set(string name)
3268 \end_layout
3270 \begin_layout Standard
3271 Returns if setting is set.
3272  If setting does not exist, returns (nil, error message).
3273 \end_layout
3275 \begin_layout Subsubsection
3276 settings.blank(string name)
3277 \end_layout
3279 \begin_layout Standard
3280 Blanks a setting and returns true.
3281  If setting can't be blanked, returns (nil, error message).
3282 \end_layout
3284 \begin_layout Subsection
3285 Table memory
3286 \end_layout
3288 \begin_layout Standard
3289 Contains various functions for managing memory
3290 \end_layout
3292 \begin_layout Subsubsection
3293 memory.vma_count()
3294 \end_layout
3296 \begin_layout Standard
3297 Returns the number of VMAs
3298 \end_layout
3300 \begin_layout Subsubsection
3301 memory.read_vma(number index)
3302 \end_layout
3304 \begin_layout Standard
3305 Reads the specified VMA (indices start from zero).
3306  Trying to read invalid VMA gives nil.
3307  The read VMA is table with the following fields:
3308 \end_layout
3310 \begin_layout Itemize
3311 region_name (string): The readable name of the VMA
3312 \end_layout
3314 \begin_layout Itemize
3315 baseaddr (number): Base address of the VMA
3316 \end_layout
3318 \begin_layout Itemize
3319 lastaddr (number): Last address in the VMA.
3320 \end_layout
3322 \begin_layout Itemize
3323 size (number): The size of VMA in bytes.
3324 \end_layout
3326 \begin_layout Itemize
3327 readonly (boolean): True of the VMA corresponds to ROM.
3328 \end_layout
3330 \begin_layout Itemize
3331 iospace (boolean): True if the VMA is I/O space.
3332 \end_layout
3334 \begin_layout Itemize
3335 native_endian (boolean): True if the VMA has native endian as opposed to
3336  little endian.
3337 \end_layout
3339 \begin_layout Subsubsection
3340 memory.find_vma(number address)
3341 \end_layout
3343 \begin_layout Standard
3344 Finds the VMA containing specified address.
3345  Returns table in the same format as read_vma or nil if not found.
3346 \end_layout
3348 \begin_layout Subsubsection
3349 memory.readbyte(number address)
3350 \end_layout
3352 \begin_layout Standard
3353 Reads the specified address as unsigned byte and returns the result.
3354 \end_layout
3356 \begin_layout Subsubsection
3357 memory.readsbyte(number address)
3358 \end_layout
3360 \begin_layout Standard
3361 Reads the specified address as signed byte and returns the result.
3362 \end_layout
3364 \begin_layout Subsubsection
3365 memory.writebyte(number address, number value)
3366 \end_layout
3368 \begin_layout Standard
3369 Writes the specified value (negative values undergo 2's complement) to specified
3370  address (as a byte).
3371 \end_layout
3373 \begin_layout Subsubsection
3374 memory.readword(number address)
3375 \end_layout
3377 \begin_layout Standard
3378 Reads the specified address as unsigned word and returns the result.
3379 \end_layout
3381 \begin_layout Subsubsection
3382 memory.readsword(number address)
3383 \end_layout
3385 \begin_layout Standard
3386 Reads the specified address as signed word and returns the result.
3387 \end_layout
3389 \begin_layout Subsubsection
3390 memory.writeword(number address, number value)
3391 \end_layout
3393 \begin_layout Standard
3394 Writes the specified value (negative values undergo 2's complement) to specified
3395  address (as a word).
3396 \end_layout
3398 \begin_layout Subsubsection
3399 memory.readdword(number address)
3400 \end_layout
3402 \begin_layout Standard
3403 Reads the specified address as unsigned doubleword and returns the result.
3404 \end_layout
3406 \begin_layout Subsubsection
3407 memory.readsdword(number address)
3408 \end_layout
3410 \begin_layout Standard
3411 Reads the specified address as signed doubleword and returns the result.
3412 \end_layout
3414 \begin_layout Subsubsection
3415 memory.writedword(number address, number value)
3416 \end_layout
3418 \begin_layout Standard
3419 Writes the specified value (negative values undergo 2's complement) to specified
3420  address (as a doubleword).
3421 \end_layout
3423 \begin_layout Subsubsection
3424 memory.readqword(number address)
3425 \end_layout
3427 \begin_layout Standard
3428 Reads the specified address as unsigned quadword and returns the result.
3429 \end_layout
3431 \begin_layout Subsubsection
3432 memory.readsqword(number address)
3433 \end_layout
3435 \begin_layout Standard
3436 Reads the specified address as signed quadword and returns the result.
3437 \end_layout
3439 \begin_layout Subsubsection
3440 memory.writeqword(number address, number value)
3441 \end_layout
3443 \begin_layout Standard
3444 Writes the specified value (negative values undergo 2's complement) to specified
3445  address (as a quadword).
3446 \end_layout
3448 \begin_layout Subsubsection
3449 memory.hash_region(number base, number size)
3450 \end_layout
3452 \begin_layout Standard
3453 Hash specified number of bytes starting from specified address and return
3454  the SHA-256.
3455 \end_layout
3457 \begin_layout Subsubsection
3458 memory.hash_state()
3459 \end_layout
3461 \begin_layout Standard
3462 Hash the current system state.
3463  Mainly useful for debugging savestates.
3464 \end_layout
3466 \begin_layout Subsubsection
3467 memory.readregion(number base, number size)
3468 \end_layout
3470 \begin_layout Standard
3471 Read a region of memory.
3472 \end_layout
3474 \begin_layout Itemize
3475 Warning: If the region crosses VMA boundary, the results are undefined.
3476 \end_layout
3478 \begin_layout Subsubsection
3479 memory.map<type>([number base, number size])
3480 \end_layout
3482 \begin_layout Standard
3483 Returns a table mapping specified memory aperture for read/write.
3484  If parameters are omitted, entiere map space is the aperture.
3485 \end_layout
3487 \begin_layout Itemize
3488 Type may be one of: byte, sbyte, word, sword, dword, sdword, qword or sqword.
3489 \end_layout
3491 \begin_layout Subsubsection
3492 memory.writeregion(number base, number size, table data)
3493 \end_layout
3495 \begin_layout Standard
3496 Write a region of memory.
3497 \end_layout
3499 \begin_layout Itemize
3500 Warning: If the region crosses VMA boundary, the results are undefined.
3501 \end_layout
3503 \begin_layout Subsubsection
3504 memory.map_struct()
3505 \end_layout
3507 \begin_layout Standard
3508 Returns a new mapping structure (MMAP_STRUCT)
3509 \end_layout
3511 \begin_layout Subsubsection
3512 MMAP_STRUCT(string key, number address, string type)
3513 \end_layout
3515 \begin_layout Standard
3516 Bind key in mmap structure to specified address with specified type.
3517 \end_layout
3519 \begin_layout Itemize
3520 Type may be one of: byte, sbyte, word, sword, dword, sdword, qword or sqword.
3521 \end_layout
3523 \begin_layout Subsection
3524 Table subtitle
3525 \end_layout
3527 \begin_layout Standard
3528 Contains functions for manipulating subtitles.
3529 \end_layout
3531 \begin_layout Subsubsection
3532 subtitle.byindex(number index)
3533 \end_layout
3535 \begin_layout Standard
3536 Get (basetime, length) pair of specified subtitle index or nothing if index
3537  isn't valid.
3538 \end_layout
3540 \begin_layout Subsubsection
3541 subtitle.get(number basetime, number length)
3542 \end_layout
3544 \begin_layout Standard
3545 Read the specified subtitle.
3546  Returns 
3547 \begin_inset Quotes eld
3548 \end_inset
3551 \begin_inset Quotes erd
3552 \end_inset
3554  if the subtitle does not exist.
3555 \end_layout
3557 \begin_layout Subsubsection
3558 subtitle.set(number basetime, number length, string content)
3559 \end_layout
3561 \begin_layout Standard
3562 Set the specified subtitle.
3563 \end_layout
3565 \begin_layout Subsubsection
3566 subtitle.deltete(number basetime, number length)
3567 \end_layout
3569 \begin_layout Standard
3570 Delete the specified subtitle.
3571 \end_layout
3573 \begin_layout Subsection
3574 Table _SYSTEM
3575 \end_layout
3577 \begin_layout Standard
3578 Contains copy of global variables from time of Lua initialization.
3579  Non-writeable.
3580 \end_layout
3582 \begin_layout Subsection
3583 Callbacks
3584 \end_layout
3586 \begin_layout Standard
3587 Various callbacks to Lua that can occur.
3588 \end_layout
3590 \begin_layout Subsubsection
3591 Callback: on_paint(bool not_synth)
3592 \end_layout
3594 \begin_layout Standard
3595 Called when screen is being painted.
3596  Any gui.* calls requiring graphic context draw on the screen.
3597 \end_layout
3599 \begin_layout Standard
3600 not_synth is true if this hook is being called in response to received frame,
3601  false otherwise.
3602 \end_layout
3604 \begin_layout Subsubsection
3605 Callback: on_video()
3606 \end_layout
3608 \begin_layout Standard
3609 Called when video dump frame is being painted.
3610  Any gui.* calls requiring graphic context draw on the video.
3611 \end_layout
3613 \begin_layout Subsubsection
3614 Callback: on_frame_emulated()
3615 \end_layout
3617 \begin_layout Standard
3618 Called when emulating frame has completed and on_paint()/on_video() calls
3619  are about to be issued.
3620 \end_layout
3622 \begin_layout Subsubsection
3623 Callback: on_frame()
3624 \end_layout
3626 \begin_layout Standard
3627 Called on each starting whole frame.
3628 \end_layout
3630 \begin_layout Subsubsection
3631 Callback: on_startup()
3632 \end_layout
3634 \begin_layout Standard
3635 Called when the emulator is starting (lsnes.rc and --run files has been run).
3636 \end_layout
3638 \begin_layout Subsubsection
3639 Callback: on_rewind()
3640 \end_layout
3642 \begin_layout Standard
3643 Called when rewind movie to beginning has completed.
3644 \end_layout
3646 \begin_layout Subsubsection
3647 Callback: on_pre_load(string name)
3648 \end_layout
3650 \begin_layout Standard
3651 Called just before savestate/movie load occurs (note: loads are always delayed,
3652  so this occurs even when load was initiated by lua).
3653 \end_layout
3655 \begin_layout Subsubsection
3656 Callback: on_err_load(string name)
3657 \end_layout
3659 \begin_layout Standard
3660 Called if loadstate goes wrong.
3661 \end_layout
3663 \begin_layout Subsubsection
3664 Callback: on_post_load(string name, boolean was_savestate)
3665 \end_layout
3667 \begin_layout Standard
3668 Called on successful loadstate.
3669  was_savestate gives if this was a savestate or a movie.
3670 \end_layout
3672 \begin_layout Subsubsection
3673 Callback: on_pre_save(string name, boolean is_savestate)
3674 \end_layout
3676 \begin_layout Standard
3677 Called just before savestate save occurs (note: movie saves are synchronous
3678  and won't trigger these callbacks if called from Lua).
3679 \end_layout
3681 \begin_layout Subsubsection
3682 Callback: on_err_save(string name)
3683 \end_layout
3685 \begin_layout Standard
3686 Called if savestate goes wrong.
3687 \end_layout
3689 \begin_layout Subsubsection
3690 Callback: on_post_save(string name, boolean is_savestate)
3691 \end_layout
3693 \begin_layout Standard
3694 Called on successful savaestate.
3695  is_savestate gives if this was a savestate or a movie.
3696 \end_layout
3698 \begin_layout Subsubsection
3699 Callback: on_quit()
3700 \end_layout
3702 \begin_layout Standard
3703 Called when emulator is shutting down.
3704 \end_layout
3706 \begin_layout Subsubsection
3707 Callback: on_input(boolean subframe)
3708 \end_layout
3710 \begin_layout Standard
3711 Called when emulator is just sending input to bsnes core.
3712  Warning: This is called even in readonly mode, but the results are ignored.
3713 \end_layout
3715 \begin_layout Subsubsection
3716 Callback: on_reset()
3717 \end_layout
3719 \begin_layout Standard
3720 Called when SNES is reset.
3721 \end_layout
3723 \begin_layout Subsubsection
3724 Callback: on_readwrite()
3725 \end_layout
3727 \begin_layout Standard
3728 Called when moving into readwrite mode as result of 
3729 \begin_inset Quotes eld
3730 \end_inset
3732 set-rwmode
3733 \begin_inset Quotes erd
3734 \end_inset
3736  command (note: moving to rwmode by Lua won't trigger this, as per recursive
3737  entry protection).
3738 \end_layout
3740 \begin_layout Subsubsection
3741 Callback: on_snoop(number port, number controller, number index, number
3742  value)
3743 \end_layout
3745 \begin_layout Standard
3746 Called each time bsnes asks for input.
3747  The value is the final value to be sent to bsnes core (readonly mode, autohold
3748  and autofire have been taken into account).
3749  Might be useful when translating movies to format suitable for console
3750  verification.
3751  Note: There is no way to modify the value to be sent.
3752 \end_layout
3754 \begin_layout Subsubsection
3755 Callback: on_keyhook(string keyname, table state)
3756 \end_layout
3758 \begin_layout Standard
3759 Sent when key that has keyhook events requested changes state.
3760  Keyname is name of the key (group) and state is the state (same kind as
3761  table values in input.raw).
3762 \end_layout
3764 \begin_layout Subsubsection
3765 Callback: on_idle()
3766 \end_layout
3768 \begin_layout Standard
3769 Called when requested by set_idle_timeout(), the timeout has expired and
3770  emulator is waiting.
3771 \end_layout
3773 \begin_layout Subsubsection
3774 Callback: on_timer()
3775 \end_layout
3777 \begin_layout Standard
3778 Called when requested by set_idle_timeout() and the timeout has expired
3779  (regardless if emulator is waiting).
3780 \end_layout
3782 \begin_layout Subsubsection
3783 Callback: on_set_rewind(UNSAFEREWIND r)
3784 \end_layout
3786 \begin_layout Standard
3787 Called when unsafe rewind object has been constructed.
3788 \end_layout
3790 \begin_layout Subsubsection
3791 Callback: on_pre_rewind() 
3792 \end_layout
3794 \begin_layout Standard
3795 Called just before unsafe rewind is about to occur.
3796 \end_layout
3798 \begin_layout Subsubsection
3799 Callback: on_post_rewind() 
3800 \end_layout
3802 \begin_layout Standard
3803 Called just after unsafe rewind has occured.
3804 \end_layout
3806 \begin_layout Section
3807 Memory watch expression syntax
3808 \end_layout
3810 \begin_layout Standard
3811 Memory watch expressions are in RPN (Reverse Polish Notation).
3812  At the end of expression, the top entry on stack is taken as the final
3813  result.
3814 \end_layout
3816 \begin_layout Standard
3817 Notations:
3818 \end_layout
3820 \begin_layout Itemize
3821 Evaluation order is strictly left to right.
3822 \end_layout
3824 \begin_layout Itemize
3825 a is the entry on top of stack
3826 \end_layout
3828 \begin_layout Itemize
3829 b is the entry immediately below top of stack
3830 \end_layout
3832 \begin_layout Itemize
3833 ; separates values to be pushed (no intermediate pop).
3834 \end_layout
3836 \begin_layout Itemize
3837 After end of element, all used stack slots are popped and all results are
3838  pushed.
3839 \end_layout
3841 \begin_layout Itemize
3842 When pushing multiple values, the pushes occur in order shown.
3843 \end_layout
3845 \begin_layout Standard
3846 The following operators are available:
3847 \end_layout
3849 \begin_layout Itemize
3850 + : a + b
3851 \end_layout
3853 \begin_layout Itemize
3854 - : a - b
3855 \end_layout
3857 \begin_layout Itemize
3858 * : a * b
3859 \end_layout
3861 \begin_layout Itemize
3862 / : a / b
3863 \end_layout
3865 \begin_layout Itemize
3866 % : a % b
3867 \end_layout
3869 \begin_layout Itemize
3870 a : atan(a)
3871 \end_layout
3873 \begin_layout Itemize
3874 b : read_signed_byte(a)
3875 \end_layout
3877 \begin_layout Itemize
3878 c : cos(a)
3879 \end_layout
3881 \begin_layout Itemize
3882 d : read_signed_dword(a)
3883 \end_layout
3885 \begin_layout Itemize
3886 i : quotent(a / b)
3887 \end_layout
3889 \begin_layout Itemize
3890 p :
3891 \begin_inset Formula $\pi$
3892 \end_inset
3895 \end_layout
3897 \begin_layout Itemize
3898 q : read_signed_qword(a)
3899 \end_layout
3901 \begin_layout Itemize
3902 r : sqrt(a)
3903 \end_layout
3905 \begin_layout Itemize
3906 s : sin(a)
3907 \end_layout
3909 \begin_layout Itemize
3910 t : tan(a)
3911 \end_layout
3913 \begin_layout Itemize
3914 u : a; a
3915 \end_layout
3917 \begin_layout Itemize
3918 w : read_signed_word(a)
3919 \end_layout
3921 \begin_layout Itemize
3922 A : atan2(a, b)
3923 \end_layout
3925 \begin_layout Itemize
3926 B : read_unsigned_byte(a)
3927 \end_layout
3929 \begin_layout Itemize
3930 C<number>z : Push number <number> to stack.
3931 \end_layout
3933 \begin_layout Itemize
3934 D : read_unsigned_dword(a)
3935 \end_layout
3937 \begin_layout Itemize
3938 C0x<number>z : Push number <number> (hexadecimal) to stack.
3939 \end_layout
3941 \begin_layout Itemize
3942 Q : read_unsigned_qword(a)
3943 \end_layout
3945 \begin_layout Itemize
3946 R<digit> : round a to <digit> digits.
3947 \end_layout
3949 \begin_layout Itemize
3950 W : read_unsigned_word(a)
3951 \end_layout
3953 \begin_layout Subsection
3954 Example:
3955 \end_layout
3957 \begin_layout Standard
3958 C0x007e0878zWC0x007e002czW-
3959 \end_layout
3961 \begin_layout Enumerate
3962 Push value 0x7e0878 on top of stack (C0x007e0878z).
3963 \end_layout
3965 \begin_layout Enumerate
3966 Pop the value on top of stack (0x7e0878), read word value at that address
3967  and push the result,call it x1 (W).
3968 \end_layout
3970 \begin_layout Enumerate
3971 Push value 0x7e002c on top of stack (C0x007e002cz).
3972 \end_layout
3974 \begin_layout Enumerate
3975 Pop the value on top of stack (0x7e002c), read word value at that address
3976  and push the result,call it x2 (W).
3977 \end_layout
3979 \begin_layout Enumerate
3980 Pop the two top numbers on stack, x1 and x2, substract x1 from x2 and push
3981  x2 - x1 (-).
3982 \end_layout
3984 \begin_layout Enumerate
3985 Since the expression ends, the final memory watch result is the top one
3986  on stack, which is x2 - x1.
3987 \end_layout
3989 \begin_layout Section
3990 Modifier and key names:
3991 \end_layout
3993 \begin_layout Subsection
3994 SDL Platform
3995 \end_layout
3997 \begin_layout Subsubsection
3998 Modifier names
3999 \end_layout
4001 \begin_layout Standard
4002 Following modifier names are known:
4003 \end_layout
4005 \begin_layout Itemize
4006 ctrl, lctrl, rctrl: Control keys
4007 \end_layout
4009 \begin_layout Itemize
4010 alt, lalt, ralt: ALT keys.
4011 \end_layout
4013 \begin_layout Itemize
4014 shift, lshift, rshift: Shift keys.
4015 \end_layout
4017 \begin_layout Itemize
4018 meta, lmeta, rmeta: Meta keys.
4019 \end_layout
4021 \begin_layout Itemize
4022 num, caps: Numlock/Capslock (these are sticky!)
4023 \end_layout
4025 \begin_layout Itemize
4026 mode: Mode select.
4027 \end_layout
4029 \begin_layout Subsubsection
4030 Key names
4031 \end_layout
4033 \begin_layout Standard
4034 Following key names are known:
4035 \end_layout
4037 \begin_layout Itemize
4038 backspace, tab, clear, return, pause, escape, space, exclaim, quotedbl,
4039  hash, dollar, ampersand, quote, leftparen, rightparen, asterisk, plus,
4040  comma, minus, period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon,
4041  less, equals, greater, question, at, leftbracket, backslash, rightbracket,
4042  caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n,
4043  o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0, world_1, world_2,
4044  world_3, world_4, world_5, world_6, world_7, world_8, world_9, world_10,
4045  world_11, world_12, world_13, world_14, world_15, world_16, world_17, world_18,
4046  world_19, world_20, world_21, world_22, world_23, world_24, world_25, world_26,
4047  world_27, world_28, world_29, world_30, world_31, world_32, world_33, world_34,
4048  world_35, world_36, world_37, world_38, world_39, world_40, world_41, world_42,
4049  world_43, world_44, world_45, world_46, world_47, world_48, world_49, world_50,
4050  world_51, world_52, world_53, world_54, world_55, world_56, world_57, world_58,
4051  world_59, world_60, world_61, world_62, world_63, world_64, world_65, world_66,
4052  world_67, world_68, world_69, world_70, world_71, world_72, world_73, world_74,
4053  world_75, world_76, world_77, world_78, world_79, world_80, world_81, world_82,
4054  world_83, world_84, world_85, world_86, world_87, world_88, world_89, world_90,
4055  world_91, world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3, kp4,
4056  kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide, kp_multiply, kp_minus, kp_plus,
4057  kp_enter, kp_equals, up, down, right, left, insert, home, end, pageup,
4058  pagedown, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14,
4059  f15, numlock, capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt,
4060  lalt, rmeta, lmeta, lsuper, rsuper, mode, compose, help, print, sysreq,
4061  break, menu, power, euro, undo
4062 \end_layout
4064 \begin_layout Itemize
4065 Names of form 'key<n>' where <n> is 0-255 are interpretted as key having
4066  hardware-dependent scan code of <n> (useful to bind those keys that don't
4067  have symbolic names).
4068 \end_layout
4070 \begin_layout Subsubsection
4071 Joystick pseudo-keys:
4072 \end_layout
4074 \begin_layout Itemize
4075 joystick<num>button<button>: Joystick <num> (0-based) button <button> (0-based).
4076 \end_layout
4078 \begin_layout Itemize
4079 joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat> (0-based) up.
4080 \end_layout
4082 \begin_layout Itemize
4083 joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat> (0-based) left.
4084 \end_layout
4086 \begin_layout Itemize
4087 joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat> (0-based) down.
4088 \end_layout
4090 \begin_layout Itemize
4091 joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat> (0-based) right.
4092 \end_layout
4094 \begin_layout Itemize
4095 joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis> negative
4096  position (axis modes axis and axis_inverse).
4097 \end_layout
4099 \begin_layout Itemize
4100 joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis> positive
4101  position (axis modes axis and axis_inverse).
4102 \end_layout
4104 \begin_layout Itemize
4105 joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis> pressure (axis
4106  modes pressure_*).
4107 \end_layout
4109 \begin_layout Subsubsection
4110 Special buttons:
4111 \end_layout
4113 \begin_layout Itemize
4114 Escape: Enter/Exit Command mode, cancel modal dialogs.
4115 \end_layout
4117 \begin_layout Itemize
4118 Return (also KPEnter): Execute command, ok modal dialog.
4119 \end_layout
4121 \begin_layout Itemize
4122 Pgup/Up (also KP8/9 if no num lock, CTRL+P; command mode): Previous command
4123  in command history
4124 \end_layout
4126 \begin_layout Itemize
4127 Pgdn/Down(also KP2/3 if no num lock, CTRL+N; command mode): Next command
4128  in command history
4129 \end_layout
4131 \begin_layout Itemize
4132 Home (also KP7 if no num lock, CTRL+A; command mode): Beginning of command.
4133 \end_layout
4135 \begin_layout Itemize
4136 End (also KP1 if no num lock, CTRL+E; command mode): End of command.
4137 \end_layout
4139 \begin_layout Itemize
4140 Left (also KP4 if no num lock, CTRL+B; command mode): Move cursor left.
4141 \end_layout
4143 \begin_layout Itemize
4144 Right (also KP6 if no num lock, CTRL+F; command mode): Move cursor right.
4145 \end_layout
4147 \begin_layout Itemize
4148 Delete (also KP.
4149  if no num lock; command mode): Delete character to right of cursor.
4150 \end_layout
4152 \begin_layout Itemize
4153 Insert (also KP0 if no num lock; command mode): Toggle between insert /
4154  overwrite modes.
4155 \end_layout
4157 \begin_layout Itemize
4158 Backspace (command mode): Delete character to left of cursor.
4159 \end_layout
4161 \begin_layout Itemize
4162 CTRL+LEFT (also ALT+B; command mode): Previous word.
4163 \end_layout
4165 \begin_layout Itemize
4166 CTRL+RIGHT (also ALT+F; command mode): Next word.
4167 \end_layout
4169 \begin_layout Itemize
4170 ALT+D (also CTRL+W; command mode): Delete word.
4171 \end_layout
4173 \begin_layout Itemize
4174 LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump corrupted!).
4175 \end_layout
4177 \begin_layout Subsection
4178 wxWidgets platform
4179 \end_layout
4181 \begin_layout Subsubsection
4182 Modifier names:
4183 \end_layout
4185 \begin_layout Standard
4186 Following modifier names are known:
4187 \end_layout
4189 \begin_layout Itemize
4191 \end_layout
4193 \begin_layout Itemize
4194 ctrl
4195 \end_layout
4197 \begin_layout Itemize
4198 shift 
4199 \end_layout
4201 \begin_layout Itemize
4202 meta
4203 \end_layout
4205 \begin_layout Itemize
4206 cmd (Mac OS X only)
4207 \end_layout
4209 \begin_layout Subsubsection
4210 Key names:
4211 \end_layout
4213 \begin_layout Standard
4214 Following key names are known:
4215 \end_layout
4217 \begin_layout Itemize
4218 back, tab, return, escape, space, exclaim, quotedbl, hash, dollar, percent,
4219  ampersand, quote, leftparen, rightparen, asterisk, plus, comma, minus,
4220  period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
4221  greater, question, at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
4222  q, r, s, t, u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
4223  underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
4224  q, r, s, t, u, v, w, x, y, z, leftcurly, pipe, rightcurly, tilde, delete,
4225  start, lbutton, rbutton, cancel, mbutton, clear, shift, alt, control, menu,
4226  pause, capital, end, home, lefT, up, right, down, select, print, execute,
4227  snapshot, insert, help, numpad0, numpad1, numpad2, numpad3, numpad4, numpad5,
4228  numpad6, numpad7, numpad8, numpad9, multiply, add, separator, subtract,
4229  decimal, divide, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13,
4230  f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, numlock, scroll,
4231  pageup, pagedown, numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
4232  numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up, numpad_right,
4233  numpad_down, numpad_pageup, numpad_pagedown, numpad_end, numpad_begin,
4234  numpad_insert, numpad_delete, numpad_equal, numpad_multiply, numpad_add,
4235  numpad_separator, numpad_subtract, numpad_decimal, numpad_divide, windows_left,
4236  windows_right, windows_menu, command, special1, special2, special3, special4,
4237  special5, special6, special7, special8, special9, special10, special11,
4238  special12, special13, special14, special15, special16, special17, special18,
4239  special19, special20
4240 \end_layout
4242 \begin_layout Section
4243 Movie file format
4244 \end_layout
4246 \begin_layout Standard
4247 Movie file is .zip archive in itself, normal ZIP archive tools work on it
4248  (note: If you recompress it, do not use compression methods other than
4249  store and deflate and especially do not use encryption of any kind).
4250 \end_layout
4252 \begin_layout Subsection
4253 Detecting clean start/SRAM/Savestate
4254 \end_layout
4256 \begin_layout Itemize
4257 If file has member 
4258 \begin_inset Quotes eld
4259 \end_inset
4261 savestate
4262 \begin_inset Quotes erd
4263 \end_inset
4265  it is savestate, otherwise:
4266 \end_layout
4268 \begin_layout Itemize
4269 If file has members with names starting 
4270 \begin_inset Quotes eld
4271 \end_inset
4273 moviesram.
4274 \begin_inset Quotes erd
4275 \end_inset
4277  it is movie starting from SRAM, otherwise:
4278 \end_layout
4280 \begin_layout Itemize
4281 It is movie starting from clear state.
4282 \end_layout
4284 \begin_layout Subsection
4285 Member: gametype
4286 \end_layout
4288 \begin_layout Standard
4289 Type of game ROM and region (as one line).
4290  Valid values are:
4291 \end_layout
4293 \begin_layout Standard
4294 \begin_inset Tabular
4295 <lyxtabular version="3" rows="8" columns="3">
4296 <features tabularvalignment="middle">
4297 <column alignment="center" valignment="top" width="0">
4298 <column alignment="center" valignment="top" width="0">
4299 <column alignment="center" valignment="top" width="0">
4300 <row>
4301 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4302 \begin_inset Text
4304 \begin_layout Plain Layout
4305 Value
4306 \end_layout
4308 \end_inset
4309 </cell>
4310 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4311 \begin_inset Text
4313 \begin_layout Plain Layout
4314 System
4315 \end_layout
4317 \end_inset
4318 </cell>
4319 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4320 \begin_inset Text
4322 \begin_layout Plain Layout
4323 Region
4324 \end_layout
4326 \end_inset
4327 </cell>
4328 </row>
4329 <row>
4330 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4331 \begin_inset Text
4333 \begin_layout Plain Layout
4334 snes_pal
4335 \end_layout
4337 \end_inset
4338 </cell>
4339 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4340 \begin_inset Text
4342 \begin_layout Plain Layout
4343 Super NES
4344 \end_layout
4346 \end_inset
4347 </cell>
4348 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4349 \begin_inset Text
4351 \begin_layout Plain Layout
4353 \end_layout
4355 \end_inset
4356 </cell>
4357 </row>
4358 <row>
4359 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4360 \begin_inset Text
4362 \begin_layout Plain Layout
4363 sgb_pal
4364 \end_layout
4366 \end_inset
4367 </cell>
4368 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4369 \begin_inset Text
4371 \begin_layout Plain Layout
4372 Super Game Boy
4373 \end_layout
4375 \end_inset
4376 </cell>
4377 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4378 \begin_inset Text
4380 \begin_layout Plain Layout
4382 \end_layout
4384 \end_inset
4385 </cell>
4386 </row>
4387 <row>
4388 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4389 \begin_inset Text
4391 \begin_layout Plain Layout
4392 snes_ntsc
4393 \end_layout
4395 \end_inset
4396 </cell>
4397 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4398 \begin_inset Text
4400 \begin_layout Plain Layout
4401 Super NES
4402 \end_layout
4404 \end_inset
4405 </cell>
4406 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4407 \begin_inset Text
4409 \begin_layout Plain Layout
4410 NTSC
4411 \end_layout
4413 \end_inset
4414 </cell>
4415 </row>
4416 <row>
4417 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4418 \begin_inset Text
4420 \begin_layout Plain Layout
4421 sgb_ntsc
4422 \end_layout
4424 \end_inset
4425 </cell>
4426 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4427 \begin_inset Text
4429 \begin_layout Plain Layout
4430 Super Game Boy
4431 \end_layout
4433 \end_inset
4434 </cell>
4435 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4436 \begin_inset Text
4438 \begin_layout Plain Layout
4439 NTSC
4440 \end_layout
4442 \end_inset
4443 </cell>
4444 </row>
4445 <row>
4446 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4447 \begin_inset Text
4449 \begin_layout Plain Layout
4451 \end_layout
4453 \end_inset
4454 </cell>
4455 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4456 \begin_inset Text
4458 \begin_layout Plain Layout
4459 BS-X (non-slotted)
4460 \end_layout
4462 \end_inset
4463 </cell>
4464 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4465 \begin_inset Text
4467 \begin_layout Plain Layout
4468 NTSC
4469 \end_layout
4471 \end_inset
4472 </cell>
4473 </row>
4474 <row>
4475 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4476 \begin_inset Text
4478 \begin_layout Plain Layout
4479 bsxslotted
4480 \end_layout
4482 \end_inset
4483 </cell>
4484 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4485 \begin_inset Text
4487 \begin_layout Plain Layout
4488 BS-X (slotted)
4489 \end_layout
4491 \end_inset
4492 </cell>
4493 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4494 \begin_inset Text
4496 \begin_layout Plain Layout
4497 NTSC
4498 \end_layout
4500 \end_inset
4501 </cell>
4502 </row>
4503 <row>
4504 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4505 \begin_inset Text
4507 \begin_layout Plain Layout
4508 sufamiturbo
4509 \end_layout
4511 \end_inset
4512 </cell>
4513 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4514 \begin_inset Text
4516 \begin_layout Plain Layout
4517 Sufami Turbo
4518 \end_layout
4520 \end_inset
4521 </cell>
4522 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4523 \begin_inset Text
4525 \begin_layout Plain Layout
4526 NTSC
4527 \end_layout
4529 \end_inset
4530 </cell>
4531 </row>
4532 </lyxtabular>
4534 \end_inset
4537 \end_layout
4539 \begin_layout Standard
4540 Frame rates are:
4541 \end_layout
4543 \begin_layout Standard
4544 \begin_inset Tabular
4545 <lyxtabular version="3" rows="3" columns="2">
4546 <features tabularvalignment="middle">
4547 <column alignment="center" valignment="top" width="0">
4548 <column alignment="center" valignment="top" width="0">
4549 <row>
4550 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4551 \begin_inset Text
4553 \begin_layout Plain Layout
4554 Region
4555 \end_layout
4557 \end_inset
4558 </cell>
4559 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4560 \begin_inset Text
4562 \begin_layout Plain Layout
4563 Framerate (fps)
4564 \end_layout
4566 \end_inset
4567 </cell>
4568 </row>
4569 <row>
4570 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4571 \begin_inset Text
4573 \begin_layout Plain Layout
4575 \end_layout
4577 \end_inset
4578 </cell>
4579 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4580 \begin_inset Text
4582 \begin_layout Plain Layout
4583 322445/6448
4584 \end_layout
4586 \end_inset
4587 </cell>
4588 </row>
4589 <row>
4590 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4591 \begin_inset Text
4593 \begin_layout Plain Layout
4594 NTSC
4595 \end_layout
4597 \end_inset
4598 </cell>
4599 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4600 \begin_inset Text
4602 \begin_layout Plain Layout
4603 10738636/178683
4604 \end_layout
4606 \end_inset
4607 </cell>
4608 </row>
4609 </lyxtabular>
4611 \end_inset
4614 \end_layout
4616 \begin_layout Subsection
4617 Member: port1
4618 \end_layout
4620 \begin_layout Standard
4621 Contains type of port #1 (as one line).
4622  Valid values are 'none', 'gamepad', 'multitap' and 'mouse'.
4623  If not present, defaults to 'gamepad'.
4624 \end_layout
4626 \begin_layout Subsection
4627 Member: port2
4628 \end_layout
4630 \begin_layout Standard
4631 Contains type of port #2 (as one line).
4632  Valid values are 'none', 'gamepad', 'multitap', 'mouse', 'superscope',
4633  'justifier' and 'justifiers'.
4634  If not present, defaults to 'none'.
4635 \end_layout
4637 \begin_layout Subsection
4638 Member: gamename
4639 \end_layout
4641 \begin_layout Standard
4642 Contains name of the game (as one line).
4643 \end_layout
4645 \begin_layout Subsection
4646 Member: authors
4647 \end_layout
4649 \begin_layout Standard
4650 Contains authors, one per line.
4651  Part before '|' is the full name, part after is the nickname.
4652 \end_layout
4654 \begin_layout Subsection
4655 Member: systemid
4656 \end_layout
4658 \begin_layout Standard
4659 Always 
4660 \begin_inset Quotes eld
4661 \end_inset
4663 lsnes-rr1
4664 \begin_inset Quotes erd
4665 \end_inset
4667  (one line).
4668  Used to reject other saves.
4669 \end_layout
4671 \begin_layout Subsection
4672 Member: controlsversion
4673 \end_layout
4675 \begin_layout Standard
4676 Always 
4677 \begin_inset Quotes eld
4678 \end_inset
4681 \begin_inset Quotes erd
4682 \end_inset
4684  (one line).
4685  Used to identify what controls are there.
4686 \end_layout
4688 \begin_layout Subsection
4689 Member: 
4690 \begin_inset Quotes eld
4691 \end_inset
4693 coreversion
4694 \begin_inset Quotes erd
4695 \end_inset
4698 \end_layout
4700 \begin_layout Standard
4701 Contains bsnes core version number (as one line).
4702 \end_layout
4704 \begin_layout Subsection
4705 Member: projectid
4706 \end_layout
4708 \begin_layout Standard
4709 Contains project ID (as one line).
4710  Used to identify if two movies are part of the same project.
4711 \end_layout
4713 \begin_layout Subsection
4714 Member: {rom,slota,slotb}{,xml}.sha256
4715 \end_layout
4717 \begin_layout Standard
4718 Contains SHA-256 of said ROM or ROM mapping file (as one line).
4719  Absent if corresponding file is absent.
4720 \end_layout
4722 \begin_layout Subsection
4723 Member: moviesram.<name>
4724 \end_layout
4726 \begin_layout Standard
4727 Raw binary startup SRAM of kind <name>.
4728  Only present in savestates and movies starting from SRAM.
4729 \end_layout
4731 \begin_layout Subsection
4732 Member: saveframe
4733 \end_layout
4735 \begin_layout Standard
4736 Contains frame number (as one line) of frame movie was saved on.
4737  Only present in savestates.
4738 \end_layout
4740 \begin_layout Subsection
4741 Member: lagcounter
4742 \end_layout
4744 \begin_layout Standard
4745 Current value of lag counter (as one line).
4746  Only present in savestates.
4747 \end_layout
4749 \begin_layout Subsection
4750 Member: pollcounters
4751 \end_layout
4753 \begin_layout Standard
4754 Contains poll counters (currently 100 of them), one per line.
4755  Each line is raw poll count if DRDY is set for it.
4756  Otherwise it is negative poll count minus one.
4757  Only present in savestates.
4758 \end_layout
4760 \begin_layout Subsection
4761 Member: hostmemory
4762 \end_layout
4764 \begin_layout Standard
4765 Raw binary dump of host memory.
4766  Only present in savestates.
4767 \end_layout
4769 \begin_layout Subsection
4770 Member: savestate
4771 \end_layout
4773 \begin_layout Standard
4774 The raw binary savestate itself.
4775  Savestate detection uses this file, only present in savestates.
4776 \end_layout
4778 \begin_layout Subsection
4779 Member: screenshot
4780 \end_layout
4782 \begin_layout Standard
4783 Screenshot of current frame.
4784  Only present in savestates.
4785  First 2 bytes are big-endian width of image, rest are 24-bit RGB image
4786  data.
4787  Height of image is inferred from the width and size of data.
4788 \end_layout
4790 \begin_layout Subsection
4791 Member: sram.<name>
4792 \end_layout
4794 \begin_layout Standard
4795 Raw binary SRAM of kind <name> at time of savestate.
4796  Only present in savestates.
4797 \end_layout
4799 \begin_layout Subsection
4800 Member: input
4801 \end_layout
4803 \begin_layout Standard
4804 The actual input track, one line per subframe (blank lines are skipped).
4805 \end_layout
4807 \begin_layout Itemize
4808 If the first byte of each line is '.', ' ', <tab> or '|', then the line is
4809  part of same frame as previous, otherwise it starts a new frame.
4810 \end_layout
4812 \begin_layout Itemize
4813 First subframe must start a new frame.
4814 \end_layout
4816 \begin_layout Standard
4817 Length of movie in frames is number of lines in input file that start a
4818  new frame.
4819 \end_layout
4821 \begin_layout Subsection
4822 Member: subtitles
4823 \end_layout
4825 \begin_layout Standard
4826 Subtitle track.
4827  Optional.
4828 \end_layout
4830 \begin_layout Itemize
4831 Each line is in form <firstframe> <numframes> <text>.
4832 \end_layout
4834 \begin_layout Itemize
4835 Linefeed is encoded as 
4836 \backslash
4837 n, backslash is encoded as 
4838 \backslash
4840 \backslash
4842 \end_layout
4844 \begin_layout Subsection
4845 Member: rerecords
4846 \end_layout
4848 \begin_layout Standard
4849 Contains textual base-10 rerecord count (as one line; emulator just writes
4850  this, it doesn't read it) + 1.
4851 \end_layout
4853 \begin_layout Subsection
4854 Member: rrdata
4855 \end_layout
4857 \begin_layout Standard
4858 This member stores set of load IDs.
4859  There is one load ID per rerecord (plus one corresponding to start of project).
4860 \end_layout
4862 \begin_layout Itemize
4863 This member constists of concatenation of records
4864 \end_layout
4866 \begin_layout Itemize
4867 Each record is 2-36 bytes long and can represent 1-16,843,009 consequtive
4868  IDs.
4869 \end_layout
4871 \begin_layout Itemize
4872 IDs are interpretted as 256-bit big-endian integers with warparound.
4873 \end_layout
4875 \begin_layout Itemize
4876 Initial predicted ID is all zeroes.
4877 \end_layout
4879 \begin_layout Standard
4880 Format of each record is:
4881 \end_layout
4883 \begin_layout Itemize
4884 1 byte: Opcode byte.
4885  Bits 0-4 are prefix length (prefixlen), bits 5-6 are count length (countlen).
4886  Bit 7 is unused.
4887 \end_layout
4889 \begin_layout Itemize
4890 32-prefixlen bytes of ID.
4891 \end_layout
4893 \begin_layout Itemize
4894 countlen bytes of big-endian count (count).
4895 \end_layout
4897 \begin_layout Standard
4898 Records are processed as follows:
4899 \end_layout
4901 \begin_layout Itemize
4902 To form the first ID encoded by record, take the first prefixlen bytes predicted
4903  ID and append the read ID value to it.
4904  The result is the first ID encoded.
4905 \end_layout
4907 \begin_layout Itemize
4908 If countlen is 0, record encodes 1 ID.
4909 \end_layout
4911 \begin_layout Itemize
4912 If countlen is 1, record encodes 2+count IDs.
4913 \end_layout
4915 \begin_layout Itemize
4916 If countlen is 2, record encodes 258+count IDs.
4917 \end_layout
4919 \begin_layout Itemize
4920 If countlen is 3, record encodes 65794+count IDs.
4921 \end_layout
4923 \begin_layout Itemize
4924 The new predicted ID is the next ID after last one encoded by the record.
4925 \end_layout
4927 \begin_layout Standard
4928 The number of rerecords + 1 is equal to the sum of number of IDs encoded
4929  by all records.
4930 \end_layout
4932 \begin_layout Subsection
4933 Member: starttime.second
4934 \end_layout
4936 \begin_layout Standard
4937 Movie starting time, second part.
4938  Epoch is Unix epoch.
4939  Default is 1,000,000,000.
4940 \end_layout
4942 \begin_layout Subsection
4943 Member: starttime.subsecond
4944 \end_layout
4946 \begin_layout Standard
4947 Movie starting time, subsecond part.
4948  Unit is CPU clocks.
4949  Default is 0.
4950 \end_layout
4952 \begin_layout Subsection
4953 Member: savetime.second
4954 \end_layout
4956 \begin_layout Standard
4957 Movie saving time, second part.
4958  Default is starttime.second.
4959  Only present in savestates.
4960 \end_layout
4962 \begin_layout Subsection
4963 Member: savetime.subsecond
4964 \end_layout
4966 \begin_layout Standard
4967 Movie saving time, subsecond part.
4968  Default is starttime.subsecond.
4969  Only present in savestates.
4970 \end_layout
4972 \begin_layout Section
4973 lsvs file format (commentary tracks)
4974 \end_layout
4976 \begin_layout Subsection
4977 Clusters
4978 \end_layout
4980 \begin_layout Itemize
4981 Each cluster is 8kB (8192 bytes) in size.
4982 \end_layout
4984 \begin_layout Itemize
4985 Cluster n starts at offset 8192*n in file.
4986 \end_layout
4988 \begin_layout Itemize
4989 The following clusters are system special:
4990 \end_layout
4992 \begin_deeper
4993 \begin_layout Itemize
4994 Cluster 0 and all clusters with number multiple of 2048 (cluster tables)
4995 \end_layout
4997 \begin_layout Itemize
4998 Cluster 1 (superblock)
4999 \end_layout
5001 \end_deeper
5002 \begin_layout Subsection
5003 Cluster tables
5004 \end_layout
5006 \begin_layout Itemize
5007 The cluster table describing cluster n is stored in cluster n & ~0x7FF (zero
5008  last 11 bits of n).
5009 \end_layout
5011 \begin_layout Itemize
5012 This cluster table consists of 2048 4-byte big-endian integers.
5013 \end_layout
5015 \begin_layout Itemize
5016 Each entry describes a cluster in 16MB supercluster, in order.
5017 \end_layout
5019 \begin_layout Itemize
5020 The valid values for entries are:
5021 \end_layout
5023 \begin_deeper
5024 \begin_layout Itemize
5025 0x00000000: Free cluster
5026 \end_layout
5028 \begin_layout Itemize
5029 0x00000001: Last cluster in chain.
5030 \end_layout
5032 \begin_layout Itemize
5033 0xFFFFFFFF: System cluster (cluster tables and superblock)
5034 \end_layout
5036 \begin_layout Itemize
5037 (anything else): Number of next cluster in chain.
5038  Must not be multiple of 2048.
5039 \end_layout
5041 \end_deeper
5042 \begin_layout Itemize
5043 Due to limitations of the format, there can be at most 2097052 superclusters,
5044  giving maximum file size of 16TB.
5045 \end_layout
5047 \begin_layout Subsection
5048 Stream table
5049 \end_layout
5051 \begin_layout Itemize
5052 The stream table chain always starts in cluster 2.
5053 \end_layout
5055 \begin_layout Itemize
5056 Otherwise, it follows normal chaining.
5057 \end_layout
5059 \begin_layout Itemize
5060 The stream table consists of 16-byte entries:
5061 \end_layout
5063 \begin_deeper
5064 \begin_layout Itemize
5065 The first 8 bytes of entry give big-endian beginning position of stream
5066  in units of 1/48000 s.
5067 \end_layout
5069 \begin_layout Itemize
5070 The next 4 bytes of entry give big-endian beginning cluster for control
5071  data.
5072  0 here marks the entry as not present.
5073 \end_layout
5075 \begin_layout Itemize
5076 The last 4 bytes of entry give big-endian beginning cluster for codec data.
5077 \end_layout
5079 \end_deeper
5080 \begin_layout Itemize
5081 Stream table clusters are normal clusters, following normal chaining.
5082 \end_layout
5084 \begin_layout Itemize
5085 The stream begnning position is not guarenteed unique.
5086  There can be multiple streams with the same starting position in the file.
5087 \end_layout
5089 \begin_layout Subsection
5090 Stream control data
5091 \end_layout
5093 \begin_layout Itemize
5094 The stream control data consists of entries 4 bytes each:
5095 \end_layout
5097 \begin_deeper
5098 \begin_layout Itemize
5099 The first 2 bytes of entry gives big-endian length of packet
5100 \end_layout
5102 \begin_layout Itemize
5103 The next byte of entry gives audio length of packet in units of 1/400 s.
5104 \end_layout
5106 \begin_layout Itemize
5107 The last byte is control byte.
5108 \end_layout
5110 \begin_deeper
5111 \begin_layout Itemize
5112 0 means this entry is not present and the control data ends.
5113 \end_layout
5115 \begin_layout Itemize
5116 1 is valid control entry.
5117 \end_layout
5119 \end_deeper
5120 \end_deeper
5121 \begin_layout Itemize
5122 The stream control data can also end by running into end of the readable
5123  chain.
5124 \end_layout
5126 \begin_deeper
5127 \begin_layout Itemize
5128 This happens if there happens to be exact multiple of 2048 packets in stream
5129  and number of packets is nonzero.
5130 \end_layout
5132 \end_deeper
5133 \begin_layout Itemize
5134 These clusters follow normal chaining.
5135 \end_layout
5137 \begin_layout Subsection
5138 Stream codec data
5139 \end_layout
5141 \begin_layout Itemize
5142 Stream codec data consists of raw Opus data packets packed back to back
5143  with nothing in between.
5144 \end_layout
5146 \begin_layout Itemize
5147 Warning: Due to internal limitations, this data must reside in the first
5148  65536 superclusters (that is, the first 1TB of the file).
5149 \end_layout
5151 \begin_layout Subsection
5152 Superblock
5153 \end_layout
5155 \begin_layout Itemize
5156 The superblock is stored in cluster 1.
5158 \end_layout
5160 \begin_layout Itemize
5161 The first 11 bytes are 
5162 \begin_inset Quotes eld
5163 \end_inset
5165 sefs-magic
5166 \begin_inset Quotes erd
5167 \end_inset
5169 <NUL>.
5170 \end_layout
5172 \begin_layout Itemize
5173 The rest are unused.
5174 \end_layout
5176 \begin_layout Itemize
5177 This cluster 1 is marked as system special.
5178 \end_layout
5180 \begin_layout Section
5181 Known ROM extensions
5182 \end_layout
5184 \begin_layout Itemize
5185 SNES cartridge ROMs: sfc, smc, swc, fig, ufo, sf2, gd3, gd7, dx2, mgd, mgh.
5186 \end_layout
5188 \begin_layout Itemize
5189 DMG cartridge ROMs: dmg, gb.
5190 \end_layout
5192 \begin_layout Itemize
5193 GBC cartridge ROMs: cgb, gbc.
5194 \end_layout
5196 \begin_layout Section
5197 Gamepack files
5198 \end_layout
5200 \begin_layout Itemize
5201 The first line must be: 
5202 \begin_inset Quotes eld
5203 \end_inset
5205 [GAMEPACK FILE]
5206 \begin_inset Quotes erd
5207 \end_inset
5210 \end_layout
5212 \begin_layout Itemize
5213 There is one needed line: 
5214 \begin_inset Quotes eld
5215 \end_inset
5217 type <systype>
5218 \begin_inset Quotes erd
5219 \end_inset
5222  This sets system type to <systype>.
5223  The following system types are valid:
5224 \end_layout
5226 \begin_deeper
5227 \begin_layout Itemize
5228 snes (SNES)
5229 \end_layout
5231 \begin_layout Itemize
5232 bsx (BS-X non-slotted)
5233 \end_layout
5235 \begin_layout Itemize
5236 bsxslotted (BS-X slotted)
5237 \end_layout
5239 \begin_layout Itemize
5240 sufamiturbo (Sufami Turbo)
5241 \end_layout
5243 \begin_layout Itemize
5244 sgb (Super Game Boy)
5245 \end_layout
5247 \begin_layout Itemize
5248 dmg (Game Boy)
5249 \end_layout
5251 \begin_layout Itemize
5252 gbc (Game Boy Color)
5253 \end_layout
5255 \begin_layout Itemize
5256 gbc_gba (Game Boy Color with GBA initial register values)
5257 \end_layout
5259 \end_deeper
5260 \begin_layout Itemize
5261 Optionally a region can be specified: 
5262 \begin_inset Quotes eld
5263 \end_inset
5265 region <region>
5266 \begin_inset Quotes erd
5267 \end_inset
5270  The following values are valid:
5271 \end_layout
5273 \begin_deeper
5274 \begin_layout Itemize
5275 autodetect (Autodetect region: snes and sgb only)
5276 \end_layout
5278 \begin_layout Itemize
5279 ntsc (NTSC: snes, bsx, bsxslotted, sufamiturbo, sgb)
5280 \end_layout
5282 \begin_layout Itemize
5283 pal (PAL: snes, sgb)
5284 \end_layout
5286 \begin_layout Itemize
5287 world (World: dmg, gbc, gbc_gba)
5288 \end_layout
5290 \end_deeper
5291 \begin_layout Itemize
5292 ROM images are loaded as: 
5293 \begin_inset Quotes eld
5294 \end_inset
5296 rom <type> <file>
5297 \begin_inset Quotes erd
5298 \end_inset
5301  The following types are valid:
5302 \end_layout
5304 \begin_deeper
5305 \begin_layout Itemize
5306 rom (Cartridge ROM in snes, dmg, gbc, gbc_gba.
5307  BIOS in bsx, bsxslotted, sufamiturbo)
5308 \end_layout
5310 \begin_layout Itemize
5311 bsx (Cartridge ROM in bsx, bsxslotted)
5312 \end_layout
5314 \begin_layout Itemize
5315 slot-a (Cartridge ROM in sufamiturbo)
5316 \end_layout
5318 \begin_layout Itemize
5319 slot-b (Cartridge ROM in sufamiturbo)
5320 \end_layout
5322 \end_deeper
5323 \begin_layout Itemize
5324 ROM markup can be loaded as: 
5325 \begin_inset Quotes eld
5326 \end_inset
5328 xml <type> <file>
5329 \begin_inset Quotes erd
5330 \end_inset
5333  The types valid are the same as for ROMs.
5334 \end_layout
5336 \begin_layout Itemize
5337 Patches can be loaded as 
5338 \begin_inset Quotes eld
5339 \end_inset
5341 patch[<offset>] <type> <file>
5342 \begin_inset Quotes erd
5343 \end_inset
5346  The types are the same as for ROMs.
5347 \end_layout
5349 \begin_deeper
5350 \begin_layout Itemize
5351 Offset is given in form [+-]<number>.
5352  Usually offset is either +0 or -512.
5353 \end_layout
5355 \begin_layout Itemize
5356 Default offset is +0.
5357 \end_layout
5359 \end_deeper
5360 \begin_layout Subsection
5361 Example:
5362 \end_layout
5364 \begin_layout LyX-Code
5365 [GAMEPACK FILE]
5366 \end_layout
5368 \begin_layout LyX-Code
5369 type snes
5370 \end_layout
5372 \begin_layout LyX-Code
5373 rom rom speedygonzales.sfc
5374 \end_layout
5376 \begin_layout LyX-Code
5377 patch-512 rom sonicthehedgehog.ips
5378 \end_layout
5380 \begin_layout Subsection
5381 Example 2:
5382 \end_layout
5384 \begin_layout LyX-Code
5385 [GAMEPACK FILE]
5386 \end_layout
5388 \begin_layout LyX-Code
5389 type sgb
5390 \end_layout
5392 \begin_layout LyX-Code
5393 rom rom supergameboy.sfc
5394 \end_layout
5396 \begin_layout LyX-Code
5397 rom dmg megamanV.dmg
5398 \end_layout
5400 \begin_layout Section
5401 Quick'n'dirty encode guide
5402 \end_layout
5404 \begin_layout Enumerate
5405 Start the emulator and load the ROM and movie file.
5406 \end_layout
5408 \begin_layout Enumerate
5409 Set large AVI option 'set-setting avi-large on'
5410 \end_layout
5412 \begin_layout Enumerate
5413 Enable dumping 'dump-avi tmpdump' 
5414 \end_layout
5416 \begin_layout Enumerate
5417 Unpause and let it run until you want to end dumping.
5418 \end_layout
5420 \begin_layout Enumerate
5421 Close the emulator (closing the window is the easiest way).
5422  Or use 'end-avi'.
5423 \end_layout
5425 \begin_layout Enumerate
5426 For each tmpdump*.avi file created, on command prompt, do 'x264 --crf 10
5427  -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
5428 \end_layout
5430 \begin_layout Enumerate
5431 Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
5432 \end_layout
5434 \begin_layout Enumerate
5435 Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv + tmpdump_0000001.mkv
5436  + tmpdump_0000002.mkv' (list every tmpdump_<numbers>.mkv, with + in between).
5437 \end_layout
5439 \begin_layout Enumerate
5440 Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'.
5441  Now final.mkv contains quick'n'dirty encode.
5442 \end_layout
5444 \begin_layout Section
5445 Axis configurations for some gamepad types:
5446 \end_layout
5448 \begin_layout Subsection
5449 XBox360 controller:
5450 \end_layout
5452 \begin_layout Standard
5453 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be set to pressure-+.
5454 \end_layout
5456 \begin_layout LyX-Code
5457 set-axis joystick0axis2 pressure-+
5458 \end_layout
5460 \begin_layout LyX-Code
5461 set-axis joystick0axis5 pressure-+
5462 \end_layout
5464 \begin_layout Itemize
5465 This is needed for SDL only.
5466  EVDEV sets those types correctly.
5467 \end_layout
5469 \begin_layout Subsection
5470 PS3 
5471 \begin_inset Quotes eld
5472 \end_inset
5474 sixaxis
5475 \begin_inset Quotes erd
5476 \end_inset
5478  controller:
5479 \end_layout
5481 \begin_layout Standard
5482 Axes 8-19 should be disabled.
5483 \end_layout
5485 \begin_layout LyX-Code
5486 set-axis joystick0axis8 disabled
5487 \end_layout
5489 \begin_layout LyX-Code
5490 set-axis joystick0axis9 disabled
5491 \end_layout
5493 \begin_layout LyX-Code
5494 set-axis joystick0axis10 disabled
5495 \end_layout
5497 \begin_layout LyX-Code
5498 set-axis joystick0axis11 disabled
5499 \end_layout
5501 \begin_layout LyX-Code
5502 set-axis joystick0axis12 disabled
5503 \end_layout
5505 \begin_layout LyX-Code
5506 set-axis joystick0axis13 disabled
5507 \end_layout
5509 \begin_layout LyX-Code
5510 set-axis joystick0axis14 disabled
5511 \end_layout
5513 \begin_layout LyX-Code
5514 set-axis joystick0axis15 disabled
5515 \end_layout
5517 \begin_layout LyX-Code
5518 set-axis joystick0axis16 disabled
5519 \end_layout
5521 \begin_layout LyX-Code
5522 set-axis joystick0axis17 disabled
5523 \end_layout
5525 \begin_layout LyX-Code
5526 set-axis joystick0axis18 disabled
5527 \end_layout
5529 \begin_layout LyX-Code
5530 set-axis joystick0axis19 disabled
5531 \end_layout
5533 \begin_layout Section
5534 Errata:
5535 \end_layout
5537 \begin_layout Subsection
5538 Problems from BSNES core:
5539 \end_layout
5541 \begin_layout Itemize
5542 The whole pending save stuff.
5543 \end_layout
5545 \begin_layout Itemize
5546 Lack of layer hiding.
5547 \end_layout
5549 \begin_layout Itemize
5550 It is slow (especially accuracy).
5551 \end_layout
5553 \begin_layout Itemize
5554 Firmwares can't be loaded from ZIP archives.
5555 \end_layout
5557 \begin_layout Subsection
5558 Other problems:
5559 \end_layout
5561 \begin_layout Itemize
5562 Modifiers don't work with pseudo-keys (SDL, EVDEV).
5563 \end_layout
5565 \begin_layout Itemize
5566 Audio for last dumped frame is not itself dumped.
5567 \end_layout
5569 \begin_layout Itemize
5570 Audio in UI is pretty bad in quality if game doesn't run at full speed.
5571 \end_layout
5573 \begin_layout Itemize
5574 No menus, command based interface (SDL).
5575 \end_layout
5577 \begin_layout Itemize
5578 Long commands don't scroll.
5579 \end_layout
5581 \begin_layout Section
5582 Changelog:
5583 \end_layout
5585 \begin_layout Subsection
5586 rr0-beta1
5587 \end_layout
5589 \begin_layout Itemize
5590 Fix -Wall warnings
5591 \end_layout
5593 \begin_layout Itemize
5594 Fix dumper video corruption with levels 10-18.
5595 \end_layout
5597 \begin_layout Subsection
5598 rr0-beta2
5599 \end_layout
5601 \begin_layout Itemize
5602 Autofire
5603 \end_layout
5605 \begin_layout Itemize
5606 Lots of code cleanups
5607 \end_layout
5609 \begin_layout Itemize
5610 Lua interface to settings
5611 \end_layout
5613 \begin_layout Itemize
5614 Allow specifying AVI borders without Lua
5615 \end_layout
5617 \begin_layout Itemize
5618 Fix scaling if vscale > 1 and originx > 0 (left border exists)
5619 \end_layout
5621 \begin_layout Itemize
5622 on_snoop lua callback
5623 \end_layout
5625 \begin_layout Itemize
5626 Faster movie loading and saving.
5627 \end_layout
5629 \begin_layout Subsection
5630 rr0-beta3
5631 \end_layout
5633 \begin_layout Itemize
5634 Joystick support
5635 \end_layout
5637 \begin_layout Subsection
5638 rr0-beta4
5639 \end_layout
5641 \begin_layout Itemize
5642 Fix multi-buttons
5643 \end_layout
5645 \begin_layout Itemize
5646 Save jukebox functionality.
5647 \end_layout
5649 \begin_layout Subsection
5650 rr0-beta5
5651 \end_layout
5653 \begin_layout Itemize
5654 Try to fix some nasty failing movie load edge cases
5655 \end_layout
5657 \begin_layout Itemize
5658 Allow specifying scripts to run on command line.
5659 \end_layout
5661 \begin_layout Subsection
5662 rr0-beta6
5663 \end_layout
5665 \begin_layout Itemize
5666 Major source code reorganization.
5667 \end_layout
5669 \begin_layout Itemize
5670 Backup savestates before overwriting.
5671 \end_layout
5673 \begin_layout Itemize
5674 Don't crash if loading initial state fails.
5675 \end_layout
5677 \begin_layout Subsection
5678 rr0-beta7
5679 \end_layout
5681 \begin_layout Itemize
5682 Fix firmware lookup
5683 \end_layout
5685 \begin_layout Itemize
5686 Fix author name parsing
5687 \end_layout
5689 \begin_layout Itemize
5690 Fix rerecord counting
5691 \end_layout
5693 \begin_layout Itemize
5694 (SDL) Print messages to console if SDL is uninitialized
5695 \end_layout
5697 \begin_layout Itemize
5698 Add movieinfo program
5699 \end_layout
5701 \begin_layout Itemize
5702 Fix loading movies starting from SRAM.
5703 \end_layout
5705 \begin_layout Subsection
5706 rr0-beta8
5707 \end_layout
5709 \begin_layout Itemize
5710 Add support for unattended dumping
5711 \end_layout
5713 \begin_layout Itemize
5714 Fix compiling for Win32
5715 \end_layout
5717 \begin_layout Itemize
5718 Don't lock up if sound can't be initialized
5719 \end_layout
5721 \begin_layout Itemize
5722 Strip trailing CR from commands
5723 \end_layout
5725 \begin_layout Itemize
5726 Don't try to do dubious things in global ctors (fix crash on startup)
5727 \end_layout
5729 \begin_layout Subsection
5730 rr0-beta9
5731 \end_layout
5733 \begin_layout Itemize
5734 Small documentation tweaking
5735 \end_layout
5737 \begin_layout Itemize
5738 Fix make clean
5739 \end_layout
5741 \begin_layout Itemize
5742 Fix major bug in modifier matching
5743 \end_layout
5745 \begin_layout Subsection
5746 rr0-beta10
5747 \end_layout
5749 \begin_layout Itemize
5750 Lots of documentation fixes
5751 \end_layout
5753 \begin_layout Itemize
5754 Use dedicated callbacks for event backcomm., not commands.
5755 \end_layout
5757 \begin_layout Itemize
5758 Ensure that the watchdog is not hit when executing delayed reset.
5759 \end_layout
5761 \begin_layout Itemize
5762 Remove errant tab from joystick message.
5763 \end_layout
5765 \begin_layout Subsection
5766 rr0-beta11
5767 \end_layout
5769 \begin_layout Itemize
5770 Make autofire operate in absolute time, not linear time
5771 \end_layout
5773 \begin_layout Itemize
5774 Reinitialize controls when resuming from loadstate
5775 \end_layout
5777 \begin_layout Itemize
5778 Some more code cleanups
5779 \end_layout
5781 \begin_layout Itemize
5782 If Lua allocator fails, call OOM_panic()
5783 \end_layout
5785 \begin_layout Itemize
5786 Byte/word/dword/qword sized host memory write/read functions.
5787 \end_layout
5789 \begin_layout Itemize
5790 Dump at correct framerate if dumping interlaced NTSC (height=448).
5791 \end_layout
5793 \begin_layout Subsection
5794 rr0-beta12
5795 \end_layout
5797 \begin_layout Itemize
5798 Actually include the complete source code
5799 \end_layout
5801 \begin_layout Itemize
5802 Keep track of RTC
5803 \end_layout
5805 \begin_layout Subsection
5806 rr0-beta13
5807 \end_layout
5809 \begin_layout Itemize
5810 Document {save,start}time.{,sub}second.
5811 \end_layout
5813 \begin_layout Itemize
5814 Intercept time() from bsnes core.
5815 \end_layout
5817 \begin_layout Subsection
5818 rr0-beta14
5819 \end_layout
5821 \begin_layout Itemize
5822 Allow disabling time() interception (allow build on Mac OS X)
5823 \end_layout
5825 \begin_layout Itemize
5826 Use SDLMain on Mac OS X (make SDL not crash)
5827 \end_layout
5829 \begin_layout Itemize
5830 Disable delayed resets (just plain too buggy for now).
5831 \end_layout
5833 \begin_layout Itemize
5834 Code cleanups
5835 \end_layout
5837 \begin_layout Itemize
5838 Use 16-bit for graphics/video instead of 32-bit.
5839 \end_layout
5841 \begin_layout Itemize
5842 gui.rectangle/gui.pixel
5843 \end_layout
5845 \begin_layout Itemize
5846 gui.crosshair
5847 \end_layout
5849 \begin_layout Itemize
5850 New CSCD writer implementation.
5851 \end_layout
5853 \begin_layout Subsection
5854 rr0-beta15
5855 \end_layout
5857 \begin_layout Itemize
5858 Fix interaction of * and +.
5859 \end_layout
5861 \begin_layout Itemize
5862 Manual improvements
5863 \end_layout
5865 \begin_layout Itemize
5866 Use gettimeofday()/usleep(), these seem portable enough.
5867 \end_layout
5869 \begin_layout Itemize
5870 Move joystick axis manipulation to keymapper code.
5871 \end_layout
5873 \begin_layout Itemize
5874 Changes to how read-only works.
5875 \end_layout
5877 \begin_layout Itemize
5878 Refactor controller input code.
5879 \end_layout
5881 \begin_layout Subsection
5882 rr0-beta16
5883 \end_layout
5885 \begin_layout Itemize
5886 Fix mouseclick scale compensation.
5887 \end_layout
5889 \begin_layout Itemize
5890 Draw area boundaries correctly in SDL code.
5891 \end_layout
5893 \begin_layout Itemize
5894 gui.screenshot.
5895 \end_layout
5897 \begin_layout Itemize
5898 Fix CSCD output (buffer overrun and race condition).
5899 \end_layout
5901 \begin_layout Subsection
5902 rr0-beta17
5903 \end_layout
5905 \begin_layout Itemize
5906 JMD dumping support.
5907 \end_layout
5909 \begin_layout Itemize
5910 Allow unattended dumping to JMD.
5911 \end_layout
5913 \begin_layout Itemize
5914 Move to BSNES v083.
5915 \end_layout
5917 \begin_layout Itemize
5918 Switch back to 32-bit colors.
5919 \end_layout
5921 \begin_layout Itemize
5922 Add Lua function gui.color.
5923 \end_layout
5925 \begin_layout Itemize
5926 Use some new C++11 features in GCC 4.6.
5927 \end_layout
5929 \begin_layout Itemize
5930 Be prepared for core frequency changes.
5931 \end_layout
5933 \begin_layout Itemize
5934 Pass colors in one chunk from Lua.
5935 \end_layout
5937 \begin_layout Subsection
5938 rr0-beta18
5939 \end_layout
5941 \begin_layout Itemize
5942 New lua functions gui.line(), gui.status() and gui.circle(), memory.vma_count(),
5943  memory.read_vma() and memory.find_vma().
5944 \end_layout
5946 \begin_layout Itemize
5947 Numerious documentation fixups
5948 \end_layout
5950 \begin_layout Itemize
5951 RTC time format changed
5952 \end_layout
5954 \begin_layout Itemize
5955 Reformat flags display
5956 \end_layout
5958 \begin_layout Itemize
5959 Allow lua package name to be overridden
5960 \end_layout
5962 \begin_layout Itemize
5963 SDUMP (high-quality dumping).
5964 \end_layout
5966 \begin_layout Itemize
5967 Split platform support to plugins.
5968 \end_layout
5970 \begin_layout Itemize
5971 Make all sound plugins support basic sound commands
5972 \end_layout
5974 \begin_layout Itemize
5975 Support portaudio for sound.
5976 \end_layout
5978 \begin_layout Itemize
5979 Allow disable Lua/SDL searching.
5980 \end_layout
5982 \begin_layout Itemize
5983 Upconvert colors when copying lcscreen to screen.
5984 \end_layout
5986 \begin_layout Itemize
5987 Reorganize source tree.
5988 \end_layout
5990 \begin_layout Itemize
5991 Evdev joystick support.
5992 \end_layout
5994 \begin_layout Itemize
5995 Refactor more code into generic window code.
5996 \end_layout
5998 \begin_layout Subsection
5999 rr0-beta19
6000 \end_layout
6002 \begin_layout Itemize
6003 Refactor message handling.
6004 \end_layout
6006 \begin_layout Itemize
6007 Rework makefile
6008 \end_layout
6010 \begin_layout Itemize
6011 Documentation fixes
6012 \end_layout
6014 \begin_layout Itemize
6015 Finish pending saves before load/quit.
6016 \end_layout
6018 \begin_layout Itemize
6019 Wxwidgets graphics plugin.
6020 \end_layout
6022 \begin_layout Subsection
6023 rr0-beta20
6024 \end_layout
6026 \begin_layout Itemize
6027 Get rid of win32-crap.[ch]pp.
6028 \end_layout
6030 \begin_layout Itemize
6031 Move files around a lot.
6032 \end_layout
6034 \begin_layout Itemize
6035 Get rid of need for host C++ compiler.
6036 \end_layout
6038 \begin_layout Itemize
6039 Bsnes v084 core.
6040 \end_layout
6042 \begin_layout Itemize
6043 Refactor inter-component communication.
6044 \end_layout
6046 \begin_layout Itemize
6047 Fix zero luma.
6048 \end_layout
6050 \begin_layout Itemize
6051 Fix crash on multiline aliases.
6052 \end_layout
6054 \begin_layout Itemize
6055 Load/Save settings in wxwidgets gui.
6056 \end_layout
6058 \begin_layout Subsection
6059 rr0-beta21
6060 \end_layout
6062 \begin_layout Itemize
6063 Patch problems in bsnes core
6064 \end_layout
6066 \begin_layout Itemize
6067 SNES is little-endian, not big-endian!
6068 \end_layout
6070 \begin_layout Itemize
6071 Fix memory corruption in lcscreen::load()
6072 \end_layout
6074 \begin_layout Subsection
6075 rr0-beta22
6076 \end_layout
6078 \begin_layout Itemize
6079 Fix interpretting repeat counts in rrdata loading.
6080 \end_layout
6082 \begin_layout Itemize
6083 New lua callback: on_frame()
6084 \end_layout
6086 \begin_layout Itemize
6087 Remove calls to runtosave() that aren't supposed to be there
6088 \end_layout
6090 \begin_layout Itemize
6091 Lua function: movie.read_rtc()
6092 \end_layout
6094 \begin_layout Itemize
6095 Ignore src/fonts/font.cpp
6096 \end_layout
6098 \begin_layout Itemize
6099 Fix more bsnes core problems
6100 \end_layout
6102 \begin_layout Itemize
6103 Control bsnes random seeding
6104 \end_layout
6106 \begin_layout Itemize
6107 Pause-on-end
6108 \end_layout
6110 \begin_layout Itemize
6111 Some bsnes core debugging features (state dump and state hash)
6112 \end_layout
6114 \begin_layout Itemize
6115 Fix titlebar version number (no, the last version wasn't 'lsnes-0-beta21',
6116  it was 'lsnes rr0-beta21').
6117 \end_layout
6119 \begin_layout Subsection
6120 rr0-beta23
6121 \end_layout
6123 \begin_layout Itemize
6124 Fix memory corruption due to macro/field mixup
6125 \end_layout
6127 \begin_layout Itemize
6128 search-memory update
6129 \end_layout
6131 \begin_layout Itemize
6132 Allow direct-mapped framebuffer
6133 \end_layout
6135 \begin_layout Itemize
6136 SDL: Use SDL_ANYFORMAT if possible
6137 \end_layout
6139 \begin_layout Itemize
6140 SDMP2SOX: 2s delay modes.
6141 \end_layout
6143 \begin_layout Itemize
6144 Wxwidgets: Cleanups
6145 \end_layout
6147 \begin_layout Itemize
6148 Use sed -E, not sed -r.
6149  Fixes building on Mac OS X.
6150 \end_layout
6152 \begin_layout Itemize
6153 Wxwidgets: Save jukebox on exit
6154 \end_layout
6156 \begin_layout Itemize
6157 Fix RTC if using load-movie on savestate.
6158 \end_layout
6160 \begin_layout Itemize
6161 Fix crash related to full console mode.
6162 \end_layout
6164 \begin_layout Subsection
6165 rr0-beta24
6166 \end_layout
6168 \begin_layout Itemize
6169 Wxwidgets: Allow bringing application to foreground on Mac OS X.
6170 \end_layout
6172 \begin_layout Itemize
6173 Wxwidgets: Allow compiling on Mac OS X.
6174 \end_layout
6176 \begin_layout Itemize
6177 Use movie compare instead of movie hashing (faster save/load).
6178 \end_layout
6180 \begin_layout Itemize
6181 Lua: _SYSTEM table.
6182 \end_layout
6184 \begin_layout Subsection
6185 rr0-beta25
6186 \end_layout
6188 \begin_layout Itemize
6189 sdmp2sox: Pad soundtrack if using -l or -L.
6190 \end_layout
6192 \begin_layout Itemize
6193 sdmp2sox: Fix NTSC overscan.
6194 \end_layout
6196 \begin_layout Itemize
6197 sdmp2sox: Add AR correction mode.
6198 \end_layout
6200 \begin_layout Itemize
6201 call lua_close() when exiting.
6202 \end_layout
6204 \begin_layout Itemize
6205 Fix zip_writer bug causing warnings from info-zip and error from advzip.
6206 \end_layout
6208 \begin_layout Subsection
6209 rr0-beta26
6210 \end_layout
6212 \begin_layout Itemize
6213 Fix IPS patching code (use bsnes core IPS patcher).
6214 \end_layout
6216 \begin_layout Itemize
6217 Implement BPS patching (using bsnes core IPS patcher).
6218 \end_layout
6220 \begin_layout Itemize
6221 Add feature to load headered ROMs.
6222 \end_layout
6224 \begin_layout Subsection
6225 rr0-beta27
6226 \end_layout
6228 \begin_layout Itemize
6229 Show command names when showing keybindings
6230 \end_layout
6232 \begin_layout Subsection
6234 \end_layout
6236 \begin_layout Itemize
6237 Fix pause-on-end to be actually controllable
6238 \end_layout
6240 \begin_layout Itemize
6241 SDL: Poll all events in queue, not just first one (fixes slowness in command
6242  typing)
6243 \end_layout
6245 \begin_layout Itemize
6246 Wxwidgets: Fix ROM loading.
6247 \end_layout
6249 \begin_layout Subsection
6250 rr1-beta0
6251 \end_layout
6253 \begin_layout Itemize
6254 Lua: Add gui.textH, gui.textV, gui.textHV
6255 \end_layout
6257 \begin_layout Itemize
6258 Fix text colors on SDL on Mac OS X
6259 \end_layout
6261 \begin_layout Itemize
6262 Mode 'F' for finished in readonly mode.
6263 \end_layout
6265 \begin_layout Itemize
6266 Fix some WS errors.
6267 \end_layout
6269 \begin_layout Itemize
6270 Reliably pause after skip poll
6271 \end_layout
6273 \begin_layout Itemize
6274 Split UI and core into their own threads
6275 \end_layout
6277 \begin_layout Subsection
6278 rr1-beta1
6279 \end_layout
6281 \begin_layout Itemize
6282 Remove leftover dummy SRAM slot
6283 \end_layout
6285 \begin_layout Itemize
6286 Fix controller numbers.
6287 \end_layout
6289 \begin_layout Subsection
6290 rr1-beta2
6291 \end_layout
6293 \begin_layout Itemize
6294 Fix lsnes-dumpavi after interface change.
6295 \end_layout
6297 \begin_layout Itemize
6298 Also give BSNES patches for v085.
6299 \end_layout
6301 \begin_layout Itemize
6302 Pack movie data in memory.
6303 \end_layout
6305 \begin_layout Subsection
6306 rr1-beta3
6307 \end_layout
6309 \begin_layout Itemize
6310 Fix framecount/length given when loading movies.
6311 \end_layout
6313 \begin_layout Itemize
6314 Controller command memory leak fixes.
6315 \end_layout
6317 \begin_layout Itemize
6318 Don't leak palette if freeing screen object.
6319 \end_layout
6321 \begin_layout Subsection
6322 rr1-beta4
6323 \end_layout
6325 \begin_layout Itemize
6326 Detect revisions.
6327 \end_layout
6329 \begin_layout Itemize
6330 Wxwidgets: Allow controlling dumper from the menu.
6331 \end_layout
6333 \begin_layout Subsection
6334 rr1-beta5
6335 \end_layout
6337 \begin_layout Itemize
6338 Rewrite parts of manual
6339 \end_layout
6341 \begin_layout Itemize
6342 Lua: Make it work with Lua 5.2.
6343 \end_layout
6345 \begin_layout Subsection
6346 rr1-beta6
6347 \end_layout
6349 \begin_layout Itemize
6350 Win32: Fix compile errors.
6351 \end_layout
6353 \begin_layout Subsection
6354 rr1-beta7
6355 \end_layout
6357 \begin_layout Itemize
6358 Refactor controller input code.
6359 \end_layout
6361 \begin_layout Itemize
6362 Fix crash when using command line on SDL / Mac OS X.
6363 \end_layout
6365 \begin_layout Subsection
6366 rr1-beta8
6367 \end_layout
6369 \begin_layout Itemize
6370 Delete core/coroutine (obsolete)
6371 \end_layout
6373 \begin_layout Itemize
6374 Lag input display by one frame.
6375 \end_layout
6377 \begin_layout Itemize
6378 Rewind movie to beginning function.
6379 \end_layout
6381 \begin_layout Itemize
6382 Fix wrong frame number reported to Lua when repainting after loadstate
6383 \end_layout
6385 \begin_layout Itemize
6386 Support UI editing of jukebox
6387 \end_layout
6389 \begin_layout Itemize
6390 Wxwidgets: Save settings on exit.
6391 \end_layout
6393 \begin_layout Itemize
6394 Support ${project} for filenames
6395 \end_layout
6397 \begin_layout Itemize
6398 SDL: Fix command history
6399 \end_layout
6401 \begin_layout Subsection
6402 rr1-beta9
6403 \end_layout
6405 \begin_layout Itemize
6406 Fix some order-of-global-ctor bugs.
6407 \end_layout
6409 \begin_layout Subsection
6410 rr1-beta10
6411 \end_layout
6413 \begin_layout Itemize
6414 Fix crashes when quitting on Win32.
6415 \end_layout
6417 \begin_layout Subsection
6418 rr1-beta11
6419 \end_layout
6421 \begin_layout Itemize
6422 EVDEV: Queue keypresses from joystick, don't send directly
6423 \end_layout
6425 \begin_layout Itemize
6426 Wxwidgets: Load-Preserve that actually works.
6427 \end_layout
6429 \begin_layout Subsection
6430 rr1-beta12
6431 \end_layout
6433 \begin_layout Itemize
6434 Wxwidgets: GUI for memory search.
6435 \end_layout
6437 \begin_layout Itemize
6438 Warn about using synchronous queue in UI callback.
6439 \end_layout
6441 \begin_layout Subsection
6442 rr1-beta13
6443 \end_layout
6445 \begin_layout Itemize
6446 Remember last saved file for each ROM
6447 \end_layout
6449 \begin_layout Itemize
6450 Support MT dumping via boost.
6451 \end_layout
6453 \begin_layout Itemize
6454 Lua: input.raw
6455 \end_layout
6457 \begin_layout Itemize
6458 Lua: input.keyhook
6459 \end_layout
6461 \begin_layout Itemize
6462 Make mouse be ordinary input instead of special-casing
6463 \end_layout
6465 \begin_layout Itemize
6466 SDL: Don't screw up commands with NUL codepoints.
6467 \end_layout
6469 \begin_layout Subsection
6470 rr1-beta14
6471 \end_layout
6473 \begin_layout Itemize
6474 Merge status panel and main window
6475 \end_layout
6477 \begin_layout Itemize
6478 True movie slot support (the rest of it)
6479 \end_layout
6481 \begin_layout Itemize
6482 SDL: Fix compilation error
6483 \end_layout
6485 \begin_layout Itemize
6486 Elminate cross calls in dump menu code.
6487 \end_layout
6489 \begin_layout Subsection
6490 rr1-beta15
6491 \end_layout
6493 \begin_layout Itemize
6494 Cancel pending saves command
6495 \end_layout
6497 \begin_layout Itemize
6498 Wxwidgets: Code refactoring
6499 \end_layout
6501 \begin_layout Itemize
6502 Wxwidgets: Fix system -> reset
6503 \end_layout
6505 \begin_layout Itemize
6506 Wxwidgets: Read watch expressions in the right thread
6507 \end_layout
6509 \begin_layout Subsection
6510 rr1-beta16
6511 \end_layout
6513 \begin_layout Itemize
6514 Wxwidgets: Don't prompt for member when running Lua script (Lua doesn't
6515  support that).
6516 \end_layout
6518 \begin_layout Itemize
6519 Wxwidgets: 128 -> 1024 Autohold slots (in case more are needed).
6520 \end_layout
6522 \begin_layout Itemize
6523 Don't append trailing '-' to prefix when saving movie.
6524 \end_layout
6526 \begin_layout Itemize
6527 Fix ROM/savestate handling (don't let user mismatch ROM and savestates).
6528 \end_layout
6530 \begin_layout Subsection
6532 \end_layout
6534 \begin_layout Itemize
6535 Document memory watch syntax.
6536 \end_layout
6538 \begin_layout Subsection
6539 rr1-delta1
6540 \end_layout
6542 \begin_layout Itemize
6543 Fix unattended dumping (lsnes-dumpavi)
6544 \end_layout
6546 \begin_layout Itemize
6547 Support RAW dumping
6548 \end_layout
6550 \begin_layout Itemize
6551 Use adv_dumper instead of the old interface in lsnes-dumpavi (changes syntax)
6552 \end_layout
6554 \begin_layout Itemize
6555 Add option to control sample rate preturbation in AVI dumper
6556 \end_layout
6558 \begin_layout Subsection
6559 rr1-delta2
6560 \end_layout
6562 \begin_layout Itemize
6563 Wxwidgets: Fix dumper submodes
6564 \end_layout
6566 \begin_layout Itemize
6567 Set core controller types before loadstate
6568 \end_layout
6570 \begin_layout Subsection
6571 rr1-delta2epsilon1
6572 \end_layout
6574 \begin_layout Itemize
6575 Fix compiling with bsnes v086.
6576 \end_layout
6578 \begin_layout Subsection
6579 rr1-delta3
6580 \end_layout
6582 \begin_layout Itemize
6583 Don't prompt before quitting
6584 \end_layout
6586 \begin_layout Itemize
6587 Start unpaused, preserve pause/unpause over load.
6588 \end_layout
6590 \begin_layout Itemize
6591 Try to autodetect if ROM is headered.
6592 \end_layout
6594 \begin_layout Itemize
6595 Wxwidgets: Only bring up ROM patching screen if specifically requested.
6596 \end_layout
6598 \begin_layout Itemize
6599 Allow configuring some hotkeys.
6600 \end_layout
6602 \begin_layout Subsection
6603 rr1-delta4
6604 \end_layout
6606 \begin_layout Itemize
6607 Lots of code cleanups
6608 \end_layout
6610 \begin_layout Itemize
6611 Fix JMD compression (JMD dumping was broken)
6612 \end_layout
6614 \begin_layout Itemize
6615 Don't crash if Lua C function throws an exception.
6616 \end_layout
6618 \begin_layout Itemize
6619 Support bitmap drawing in Lua.
6620 \end_layout
6622 \begin_layout Itemize
6623 Fix bsnes v085/v086 patches.
6624 \end_layout
6626 \begin_layout Itemize
6627 Improve stability on win32.
6628 \end_layout
6630 \begin_layout Subsection
6631 rr1-delta4epsilon1
6632 \end_layout
6634 \begin_layout Itemize
6635 Don't corrupt movie if movie length is integer multiple of frames per page.
6636 \end_layout
6638 \begin_layout Subsection
6639 rr1-delta5
6640 \end_layout
6642 \begin_layout Itemize
6643 New Lua hooks: on_rewind, on_frame_emulated, on_idle, on_timer
6644 \end_layout
6646 \begin_layout Itemize
6647 New Lua functions: emulator_ready(), utime(), set_idle_timeout(), set_timer_time
6648 out(), bit.extract(), bit.value(), input.geta(), input.seta() and input.controllertyp
6650 \end_layout
6652 \begin_layout Itemize
6653 Wxwidgets: Fix internal focus lost (hotkeys stop working)
6654 \end_layout
6656 \begin_layout Itemize
6657 Wxwidgets: Fix broken modifiers
6658 \end_layout
6660 \begin_layout Itemize
6661 on_paint has parameter now.
6662 \end_layout
6664 \begin_layout Itemize
6665 Optional initital fill for bitmaps
6666 \end_layout
6668 \begin_layout Itemize
6669 Fix palette changing.
6670 \end_layout
6672 \begin_layout Itemize
6673 Optimize rendering a bit.
6674 \end_layout
6676 \begin_layout Itemize
6677 Bsnes v087 support.
6678 \end_layout
6680 \begin_layout Subsection
6681 rr1-delta5epsilon1
6682 \end_layout
6684 \begin_layout Itemize
6685 Movieinfo: Fix display of port #2 type.
6686 \end_layout
6688 \begin_layout Itemize
6689 Call on_input() after loadstate.
6690 \end_layout
6692 \begin_layout Subsection
6693 rr1-delta5epsilon2
6694 \end_layout
6696 \begin_layout Itemize
6697 Fix writing port2 data to movie.
6698 \end_layout
6700 \begin_layout Itemize
6701 Fix SRAM handling with Bsnes v087.
6702 \end_layout
6704 \begin_layout Subsection
6705 rr1-delta6
6706 \end_layout
6708 \begin_layout Itemize
6709 Library loading support
6710 \end_layout
6712 \begin_layout Itemize
6713 Built-in TSCC encoder
6714 \end_layout
6716 \begin_layout Itemize
6717 Hi-color (256T colors) dumping.
6718 \end_layout
6720 \begin_layout Itemize
6721 Dump over TCP/IP(v6)
6722 \end_layout
6724 \begin_layout Itemize
6725 Hidable status panel
6726 \end_layout
6728 \begin_layout Itemize
6729 Turbo toggle/hold
6730 \end_layout
6732 \begin_layout Itemize
6733 Adjustable sound volume
6734 \end_layout
6736 \begin_layout Itemize
6737 Screen scaling
6738 \end_layout
6740 \begin_layout Itemize
6741 Allow DnD into filename boxes
6742 \end_layout
6744 \begin_layout Itemize
6745 Configurable paths
6746 \end_layout
6748 \begin_layout Itemize
6749 Portaudio: Fix speaker popping at start
6750 \end_layout
6752 \begin_layout Itemize
6753 Lots of UI changes
6754 \end_layout
6756 \begin_layout Itemize
6757 Speed adjustment menu
6758 \end_layout
6760 \begin_layout Itemize
6761 Win32 joystick support
6762 \end_layout
6764 \begin_layout Itemize
6765 Lua: gui.rainbow and gui.box
6766 \end_layout
6768 \begin_layout Itemize
6769 Split key lists into classes (the key list was large!)
6770 \end_layout
6772 \begin_layout Itemize
6773 More save slots support
6774 \end_layout
6776 \begin_layout Itemize
6777 Wxwidgets (wxJoystick) joystick support
6778 \end_layout
6780 \begin_layout Subsection
6781 rr1-delta7
6782 \end_layout
6784 \begin_layout Itemize
6785 Lots of internal joystick refactoring
6786 \end_layout
6788 \begin_layout Itemize
6789 Evdev: Add mapping for BTN_TOOL_QUINTTAP
6790 \end_layout
6792 \begin_layout Itemize
6793 Wxwidgets: Settings mode (open settings without ROM)
6794 \end_layout
6796 \begin_layout Itemize
6797 Wxwidgets: Prompt key to use option
6798 \end_layout
6800 \begin_layout Itemize
6801 Wxwidgets: Fix crash if key goes away underneath
6802 \end_layout
6804 \begin_layout Itemize
6805 Wxwidgets: Fix mouse position in presence of scaling
6806 \end_layout
6808 \begin_layout Itemize
6809 AVI dumper: Mode 4 (high-quality resampling to common rate using SRC)
6810 \end_layout
6812 \begin_layout Itemize
6813 Wxwidgets: Redesign hotkeys dialog to avoid tree control (tree control doesn't
6814  seem to work well on WinXP)
6815 \end_layout
6817 \begin_layout Itemize
6818 Start paused option.
6819 \end_layout
6821 \begin_layout Subsection
6822 rr1-delta7epsilon1
6823 \end_layout
6825 \begin_layout Itemize
6826 AVI: ZMBV support
6827 \end_layout
6829 \begin_layout Itemize
6830 lsnes-dumpavi: Start Lua before starting dumper
6831 \end_layout
6833 \begin_layout Itemize
6834 AVI: Fix secondary audio in mode 4.
6835 \end_layout
6837 \begin_layout Subsection
6838 rr1-delta7epsilon2
6839 \end_layout
6841 \begin_layout Itemize
6842 AVI: Refactor ZMBV a bit.
6843 \end_layout
6845 \begin_layout Itemize
6846 Fix error reading analog values from movie file
6847 \end_layout
6849 \begin_layout Subsection
6850 rr1-delta8
6851 \end_layout
6853 \begin_layout Itemize
6854 Delayed reset support
6855 \end_layout
6857 \begin_layout Itemize
6858 Lua: memory.hash_region
6859 \end_layout
6861 \begin_layout Subsection
6862 rr1-delta8epsilon1
6863 \end_layout
6865 \begin_layout Itemize
6866 Rework the build system
6867 \end_layout
6869 \begin_layout Itemize
6870 Typing input support
6871 \end_layout
6873 \begin_layout Itemize
6874 Fix building with bsnes v086 and v087.
6875 \end_layout
6877 \begin_layout Itemize
6878 SDL: Save settings on exit
6879 \end_layout
6881 \begin_layout Itemize
6882 SDL: Command to enter command line mode with given command.
6883 \end_layout
6885 \begin_layout Itemize
6886 SDL: More advanced command editing.
6887 \end_layout
6889 \begin_layout Subsection
6890 rr1-delta9
6891 \end_layout
6893 \begin_layout Itemize
6894 wxMSW: Fix the 
6895 \begin_inset Quotes eld
6896 \end_inset
6898 arrow keys and enter don't work
6899 \begin_inset Quotes erd
6900 \end_inset
6902  problem
6903 \end_layout
6905 \begin_layout Itemize
6906 MSU-1 support
6907 \end_layout
6909 \begin_layout Itemize
6910 Show mode changes due to rewinding.
6911 \end_layout
6913 \begin_layout Itemize
6914 Unsafe rewind support
6915 \end_layout
6917 \begin_layout Itemize
6918 Fix directory transversal.
6919 \end_layout
6921 \begin_layout Subsection
6922 rr1-delta10
6923 \end_layout
6925 \begin_layout Itemize
6926 AVI: Sound mode 5 (48kHz high-quality)
6927 \end_layout
6929 \begin_layout Itemize
6930 Lua: Reset Lua VM
6931 \end_layout
6933 \begin_layout Itemize
6934 Map the SNES bus into address space
6935 \end_layout
6937 \begin_layout Itemize
6938 Fix loading memory watch files with CRLF line endings
6939 \end_layout
6941 \begin_layout Subsection
6942 rr1-delta10epsilon1
6943 \end_layout
6945 \begin_layout Itemize
6946 Map bsnes internal state into memory space
6947 \end_layout
6949 \begin_layout Itemize
6950 Fix the 
6951 \begin_inset Quotes eld
6952 \end_inset
6954 click on panel wedges the emulator
6955 \begin_inset Quotes erd
6956 \end_inset
6958  for real.
6959 \end_layout
6961 \begin_layout Itemize
6962 DnD movies/saves on the main window.
6963 \end_layout
6965 \begin_layout Subsection
6966 rr1-delta11
6967 \end_layout
6969 \begin_layout Itemize
6970 Split core bindings into own module.
6971 \end_layout
6973 \begin_layout Itemize
6974 Remember invalid settings
6975 \end_layout
6977 \begin_layout Itemize
6978 Support for modified Gambatte core for GB/GBC emulation.
6979 \end_layout
6981 \begin_layout Itemize
6982 Reload/swap ROM function
6983 \end_layout
6985 \begin_layout Subsection
6986 rr1-delta11epsilon1
6987 \end_layout
6989 \begin_layout Itemize
6990 Fix step poll function
6991 \end_layout
6993 \begin_layout Subsection
6994 rr1-delta12
6995 \end_layout
6997 \begin_layout Itemize
6998 Non-insane savestate anchoring
6999 \end_layout
7001 \begin_layout Subsection
7002 rr1-delta13
7003 \end_layout
7005 \begin_layout Itemize
7006 More Memory search methods
7007 \end_layout
7009 \begin_layout Itemize
7010 Preserve movie if loading in RO mode.
7011 \end_layout
7013 \begin_layout Itemize
7014 Fix a obscure case in timeline check
7015 \end_layout
7017 \begin_layout Itemize
7018 Revamp the entiere ROM loading code
7019 \end_layout
7021 \begin_layout Itemize
7022 Support DnD on ROMs
7023 \end_layout
7025 \begin_layout Itemize
7026 Revamp menu layout
7027 \end_layout
7029 \begin_layout Itemize
7030 Standalone hotkey config dialog
7031 \end_layout
7033 \begin_layout Itemize
7034 Show bindings in more user-friendly format
7035 \end_layout
7037 \begin_layout Subsection
7038 rr1-delta13epsilon1
7039 \end_layout
7041 \begin_layout Itemize
7042 Pipedec support
7043 \end_layout
7045 \begin_layout Itemize
7046 Fix uninitialized variables in bsnes v085
7047 \end_layout
7049 \begin_layout Subsection
7050 rr1-delta14
7051 \end_layout
7053 \begin_layout Itemize
7054 Merge gambatte core into mainline (from its own branch)
7055 \end_layout
7057 \begin_layout Itemize
7058 Wxwidgets: Show expected dump file formats
7059 \end_layout
7061 \begin_layout Itemize
7062 Memory watch: Data typing
7063 \end_layout
7065 \begin_layout Itemize
7066 lsnes internal MMIO area.
7067 \end_layout
7069 \begin_layout Itemize
7070 Wxwidgets: New memory watch editor
7071 \end_layout
7073 \begin_layout Itemize
7074 Hexadecimal memory watches
7075 \end_layout
7077 \begin_layout Itemize
7078 Wxwidgets: Monospaced panel
7079 \end_layout
7081 \begin_layout Itemize
7082 Wxwidgets: Split memory watches in panel
7083 \end_layout
7085 \begin_layout Itemize
7086 Wxwidgets: Disable VMAs in memory search
7087 \end_layout
7089 \begin_layout Itemize
7090 lsnes-dumpavi: Fix speed bug
7091 \end_layout
7093 \begin_layout Itemize
7094 Movie subtitle support
7095 \end_layout
7097 \begin_layout Itemize
7098 Fix rerecord count reporting
7099 \end_layout
7101 \begin_layout Itemize
7102 Don't trash movie when loading in readonly mode.
7103 \end_layout
7105 \begin_layout Subsection
7106 rr1-delta14epsilon1
7107 \end_layout
7109 \begin_layout Itemize
7110 Wxwidgets: Fix crashes on closing settings dialogs on Mac OS X.
7111 \end_layout
7113 \begin_layout Itemize
7114 Fix build on Mac OS X.
7115 \end_layout
7117 \begin_layout Itemize
7118 Lua: loopwrapper
7119 \end_layout
7121 \begin_layout Itemize
7122 Wxwidgets: Hidable messages window
7123 \end_layout
7125 \begin_layout Itemize
7126 Lua: input.joyset
7127 \end_layout
7129 \begin_layout Itemize
7130 Bsnes: Support inconsistent saves
7131 \end_layout
7133 \begin_layout Itemize
7134 Bsnes: Allow simulating saving every frame
7135 \end_layout
7137 \begin_layout Itemize
7138 Fix desync if savestate is loaded in readonly mode in certain conditions.
7139 \end_layout
7141 \begin_layout Itemize
7142 Wxwidgets: Fix save dialogs on Mac OS X.
7143 \end_layout
7145 \begin_layout Itemize
7146 Wxwidgets: Fix insane status width on Win32.
7147 \end_layout
7149 \begin_layout Itemize
7150 Wxwidgets: Fix autohold processing to be faster.
7151 \end_layout
7153 \begin_layout Itemize
7154 Wxwidgets: Allow loading ROMs and movies from commandline.
7155 \end_layout
7157 \begin_layout Subsection
7158 rr1-delta15
7159 \end_layout
7161 \begin_layout Itemize
7162 Be a bit smarter with --load
7163 \end_layout
7165 \begin_layout Itemize
7166 Rewrote higher-level parts of audio system
7167 \end_layout
7169 \begin_layout Itemize
7170 Tool to build commentary tracks
7171 \end_layout
7173 \begin_layout Itemize
7174 Lua: input.joyget
7175 \end_layout
7177 \begin_layout Itemize
7178 Gambatte: Add support for SVN358
7179 \end_layout
7181 \begin_layout Itemize
7182 Use builtin font when rendering status panel.
7183 \end_layout
7185 \begin_layout Itemize
7186 Option to detach memory watch to its own window.
7187 \end_layout
7189 \begin_layout Itemize
7190 Recent ROMs/Movies menu
7191 \end_layout
7193 \begin_layout Itemize
7194 Libao support
7195 \end_layout
7197 \begin_layout Itemize
7198 Useful lag counter for SNES games that autopoll
7199 \end_layout
7201 \begin_layout Itemize
7202 Fix buffer overflow in gambatte sound output
7203 \end_layout
7205 \begin_layout Subsection
7206 rr1-delta15epsilon1
7207 \end_layout
7209 \begin_layout Itemize
7210 Don't blow up on wxGTK if the window is hidden somehow
7211 \end_layout
7213 \begin_layout Itemize
7214 Support simultaneous drop of ROM and movie.
7215 \end_layout
7217 \begin_layout Itemize
7218 Gambatte: Don't save spurious SRAMs.
7219 \end_layout
7221 \begin_layout Itemize
7222 Make SGB ROMs actually usable.
7223 \end_layout
7225 \begin_layout Itemize
7226 Fix so that saved movies appear in recent movies.
7227 \end_layout
7229 \begin_layout Itemize
7230 Don't open multiple commentary editors at once.
7231 \end_layout
7233 \end_body
7234 \end_document