Todo: Difference between revisions

From vice-emu
Jump to navigation Jump to search
VisualWikitext
Line 241: Line 241:
====ROMsets====
====ROMsets====


* all traces of "ROMset archives" should be removed. Nothing uses this, and no UI ever supported it correctly.
* a generic function should be created which scans the data directory of the emulator and returns a list of all .vrs files for the UI
* a generic function should be created which scans the data directory of the emulator and returns a list of all .vrs files for the UI
** then the UI can use said list in a dropdown list for quick selection
** then the UI can use said list in a dropdown list for quick selection

Revision as of 19:01, 24 March 2023

This is the list of known problems. also look at Tracker: open Bugs

This list always refers to the status of the last major release version, which was 3.7. Items that have been fixed by the time of a major release will be removed, items fixed after that will be marked as fixed and stay until the next major version. New items will be added as noticed.

Prime Directive

  • All developers shall subscribe to the vice-emu-mail mailinglist and perhaps join #vice-dev on freenode too (highly recommended).
  • Please respect the coding guidelines.
  • Document your code so other people than you are able to understand and fix it in a decade or two.
  • When adding/changing stuff that needs (G)UI items/changes, all developers should update the SDL and GTK3 UIs themselves, and immediately following their respective changes.
  • When adding/changing command-line options and/or resources, adding a new feature or change the behavior of an existing feature, please update the documentation.
  • After fixing a bug or implementing a new feature, update its status on the Bug Tracker and mark it as fixed in the TODO list below.
Only remove a bug/feature from this list when it was fixed/implemented in the latest stable release.
  • And most importantly...
 <@_tlr> Please at least test the issue you were trying to fix before committing.
That means: you break it, you fix it. Do not commit deal breaking changes without communicating it with the rest of the team. Generally regressions are not acceptable and respective commits are subject to be reverted.

Code cleanup and streamlining

As of 3.2 we started removing a lot of the old cruft, that was dangling around in the tree for way too long, to make maintenance easier

  • remove compiler- and platform- specific hacks (IFDEFS) in common code
$ ./src/findhacks.sh ccarchdep
$ ./src/findhacks.sh archdep
  • TODO: get rid of fullscreenarch.h and fullscreen.c - its no more required because both SDL and GTK3 can do all of the features fine. (fixed?)
  • replace readline and our fallback implementation with linenoise (https://github.com/antirez/linenoise), or perhaps linenoise-ng (https://github.com/arangodb/linenoise-ng) which appears to support Windows and UTF-8.
    • write a C <-> C++ wrapper for completions with linenoise-ng, so we can also drop linenoise (non-ng).

Build system

Documentation

Technical

  • many nodes are not yet linked correctly, which makes some of the exporters output garbled and/or suboptimal output (unix .info).
Workaround: use the .html or .pdf documentation, which is exported correctly.

Content

The documentation is partly outdated and/or incomplete, in particular:

  • some info that was previously hidden in target specific articles on the VICE knowledge base should get merged into vice.texi - the remaining articles are here
  • some descriptions of emulator formats are missing (D67, D1M, D2M, D4M...)
  • descriptions of several snapshot modules are missing (Plus4, TED...)

for details look at doc/Documentation-Howto.txt

Testbench

  • many test programs (mostly for vic20) are not yet integrated into the automatic testing
  • TODO: fix the reference screenshots and/or the scripts so they dont rely on the "normal" rendering mode anymore
  • TODO: make a test program to determine visible screen dimensions
  • TODO: make a test program to determine the type of delay line used for a PAL screen (UV or U only)

autostart problems

  • autostart seems to be broken in xcbm2 and xcbm5x0 at least with the settings the testbench wants to use
  • xplus4 gives "sound buffer overrun" on autostart with certain settings (which settings?)
  • x128 does not autostart prg files correctly when also a cartridge is attached (that forces c64 mode)

Emulators

Subsystems

Keyboard

  • When a key which is shifted on the real machine but unshifted on the PC or Unix keyboard you are using is pressed, the virtual shift is pressed together (i.e. at the same clock cycle) with the main key; this could not work with some keyboard routines.
Workaround: If you have to use the function keys, press the (real) shift key manually (e.g. F2 = Shift + F1, F4 = Shift + F3 and so on); this also works with other keys. In any case, using a positional keymap will remove much of this problem.
  • Some ports/emulators/keyboard-types do not have all required keymaps (and a fallback will used) - look at Keymaps for details
  • Although "shift lock" can be mapped to a key, not all ports and/or emulators support it due to missing keymaps and/or implementation details.
TODO: check ports and fix or at least add a comment in the keymaps
  • contact-bounce is not emulated
TODO: make a proper test program

Joystick

TODO: make a proper test program
  • when selecting "swap joysticks" or "swap userport joysticks" this will actually swap the related resources, which may be surprising when saving settings and loading them later. it also means its impossible to display whether they are swapped or not in the UI.
TODO: create a "JoysticksAreSwapped" resource, and update the code accordingly. (This is partially solved in the Gtk3 UI by using two internal states, one for controlports and one for userport, and reflecting the state in the menu with checkboxes)

Joystick port devices

  • Paperclip 64 dongle emulation is broken
  • Gun Stick lightpen emulation is not working (and disabled, unless experimental devices are enabled in joyport.h)
  • add a monitor command to control the value of the 'I/O simulation device', something like jpdb <port> <value>
 The monitor command would call:
 joyport_io_sim_set_ddr_lines(0xff, port);   /* Set data direction to output for all joystick lines */
 joyport_io_sim_set_out_lines(value, port);

 ports 1&2 for x64/x64sc/xscpu64/x128/x64dtv/xcbm5x0
 port 1 for xvic
 ports 1&2&6 for xplus4
  • Add gtk3 ui support for the host joystick mapping system.
 joyport_map_desc_t *mappings = joyport_get_mapping(port);   /* get the mappings for the given port */
 char *port_name = joyport_get_port_name(port);              /* get the name of the emulated port */
 if (joyport_has_mapping(port)) {                            /* only if the given port has a device that has pins to map */
     char *emulated_joystick_device_name = mappings->name;   /* get the name of the emulated device in the given port */
     if (mappings->pinmap != NULL) {                         /* only if the device has pin (digital line) mappings */
         for (int i = 0; mappings->pinmap[i].name; i++) {    /* go through all the pin mappings, if mapping pin name is NULL then we have reached the end */ 
             char *pin_name = mappings->pinmap[i].name;      /* get the pin name */
             int pin_nr = mappings->pinmap[i].pin;           /* get the pin number */
             ...                                             /* build host joystick direction/button dialog based on the above info */
         }
     }
     if (mappings->potmap != NULL) {                         /* only if the device has pot (analog line) mappings */
         for (int i = 0; mappings->potmap[i].name; i++) {    /* go through all the pot mappings, if mapping pot name is NULL then we have reached the end */ 
             char *pin_name = mappings->potmap[i].name;      /* get the pot name */
             int pin_nr = mappings->potmap[i].pin;           /* get the pot number */
             ...                                             /* build host joystick analog axis dialog based on the above info */
         }
     }
 }

Userport devices

  • diag 586220 harness emulation is not working (and disabled, unless experimental devices are enabled in userport.h)

Tapeport devices

  • diag 586220 harness emulation is not working (and disabled, unless experimental devices are enabled in tapeport.h)

Commandline

  • some options where the available parameters depend on the machine type lack proper descriptions (-drivetype)

Resources

  • It's unclear what the "event_relevant" member of resources actually means, and what the difference between RES_EVENT_SAME and RES_EVENT_STRICT is. This needs to documented and then probably a lot of resources fixed to use the correct values.

Monitor

  • Breakpoints/watchpoints should consider banks.
Binary Interface

The binary interface has a few design issues that should be fixed

  • Command 0x84 (get display) has several issues:
    • The first parameter should probably not be a boolean ("is this VICII?"), but "videochip number", with 0 being VICII and 1 being VDC on C128. Further Videochips could be added then (eg if we ever implement the BTX cartridge). Perhaps for compatibility reasons we start counting at 1, and make "0" a special parameter for "current one" I'm not sure what to do with this so I'm leaving it alone for the time being.

Also, the Documentation has some issues:

  • At some places it uses &foo and *bar to refer to "length" and a block of data(?). This is really weird and should be removed / replaced by something that is more clear.

Last not least the binmontest program needs cleanup, so it can serve as an example program:

  • Magic values are used for offsets at various places. It should use constants instead. Ideally, a common header file is used for both the test-program and the VICE code itself
  • More comments are needed in place of the various checks

History Recording

  • history recording currently breaks on a lot of user actions, such as using autostart or attaching a cartridge.
Workaround: make sure to start up with a bog standard c64, and then load/run the program in question manually

note: since history recording is very error prone and hard to debug, we depend on feedback (on either failure or success) on this topic very much. if you still have problems with the current release, please report them including testcases.

Screenshots / Media Recording

  • Screenshots with activated video filter (CRT emulation / Scale2x) do not deliver the expected (filtered) result.

Rendering

  • some things are still shared by videochips although they shouldnt be, resulting in conflicts for eg the color generation (visible in x128 in ports that show two windows at a time, when crt emulation is enabled, eg adjusting brightness affects also the other window)
  • TODO add a 4:3 fixed aspect ratio scaling mode
  • TODO when a test program has been written, adjust the "normal" border mode accordingly (CAUTION: fix testsuite first)
  • TODO put all border mode parameters into arrays, make a global function to query the parameters and modes (for UIs) and then add "TV" mode (like "normal", but not centered)
CRT Emulation
  • the rf-modulator output characteristics are not emulated, which means the so called "black bleeding" effect does not work (emusux0r, http://www.csdb.dk/release/?id=81780)
  • artefact color and luma/chroma crosstalk are not emulated (eg the "red/green stripes")

see http://hitmen.c02.at/temp/palstuff/ for some further info on this topic.

Drive Emulation

  • G64 image support is incomplete, the speedzone definitions are completely ignored
Note: this is no problem in practise, so far not a single title (game) could be located that would actually require this kind of support to work. Incase you find a program that needs this kind of support, please let us know.
  • RPM and Wobble settings have currently no effect when P64 images are used
virtual Devices
  • handling of CBM style sub partitions is incomplete, write operations on sub partitions may give unexpected results.
  • RELative files are only supported when using disk images ( https://sourceforge.net/p/vice-emu/bugs/703/ )
  • support for double sided disk images is very shaky, since no concept of disk sides exists and the tracks on the second side are referenced by an offset into the image, the handling of images with different number of tracks is needlessly hard and complicated (and thus broken).
  • the IEEE machines use the "virtual devices" for something slightly different than the IEC machines, for the IEEE machines its more like what "IEC Device" means for the IEC machines. This should be handled with a seperate resource similar to "IEC Device" in the other emulators.
True Drive Emulation
  • serial timing latency is not implemented. due to their physical properties, it takes about half a cycle for a value to show up at the respective output pin after it has been written to the register. and respectivly, it takes about half a cycle from changing an input pin until the value in the respective register changes.
  • mechanical delays (such as head stepping and motor spinup) are not emulated yet.
  • accessing device #7 on the IEC bus works (only real devices), but it only works if True Drive Emulation is OFF, even though this has nothing to do with drives. This needs to be fixed in TDE somehow.
generally the way device #7 is implemented as a special case that is different to devices 4-6 is questionable and should be made the same
1541
  • 1541 Emulation still fails a few test programs
1571
  • 2mhz mode of the 1571 is not handled correctly
    • drive CPUs always run at 1Mhz for all drives (hardcoded 1000000 at a few places)
    • 1571 has extra delay on on reading sync inside the drive, ("you cannot use BVC in 2mhz mode!")
  • 1571CR emulation does not work correctly
  • double sided 1571 images do not work correctly
    • regular (70 tracks) vs extended (80 or 84 tracks) d71 images are not handled at all (vdrive problem)
    • creating (formatting) G71 does not work correctly, the second BAM block will be wrong (vdrive problem)
    • double sided P64 can be used, but can not be created from within VICE (see patch #122, r32586). since these are non existant "in the wild" and probably not needed for anything - not a big problem :) to handle this properly, a seperate image format should get created (at least internally)
Extensions
  • when using dolphin dos 3 emulation, the state of the mc6821 is not saved to/restored from snapshots
  • when using supercard+ emulation, the optional additional index hole sensor (for the IHS nibbler) is not emulated
Drive Noise
  • since the current implementation is a very simple sample player, things like "drive composer" will not work

Datasette Emulation

  • unlike with a real datasette, the emulated counter will stop counting when no tape/image is present
  • when a t64 image is attached, the datasette status will incorrectly say "no image".
Note: since t64 is currently only accessable via kernal traps, the datasette emulation actually treats this case as if no image is present. The respective code must be updated so the datasette emulation actually "knows" about when t64 is in use.
  • motor noise is not emulated

Tape port devices

  • DTL Basic Dongle emulation is broken

Printer Emulation

there perhaps should be a way to explicitly set a directory for printer output files Gpz 01:24, 4 July 2011 (UTC)
  • printer noise is not emulated
  • printers don't work on the PET (or other IEEE-488 computers)
-> the reason for that is that they use either device traps or IEC Devices, none of which exists on the IEEE machines

RS232 Emulation

Detailed info on the state of RS232 emulation can be found here.

ROMsets

  • a generic function should be created which scans the data directory of the emulator and returns a list of all .vrs files for the UI
    • then the UI can use said list in a dropdown list for quick selection

c1541

unfortunately to fix this a lot of c1541 will have to be rewritten (mount image only once, not for each operation) Gpz (talk) 23:57, 13 December 2012 (UTC)
  • Remove optional dependency on libreadline once linenoise-ng has been tested properly.
See if linenoise-ng can be made to work with the MSYS2 shell, which would help with debugging c1541.

Chips

VIA

  • MYVIA_NEED_LATCHING option is broken
  • the code doesn't actually notify anything outside the chip when PB7 toggles
    • Same so far for the output from the shift register and its handshaking

used in: VIC20, PET, various drives

CIA

  • the case when CIA1 port A and port B are both in output mode, port A outputs low, port B outputs high, both are connected via the keyboard matrix and a value is read from port B is not handled correctly ( testprogs/CIA/ciaports ; http://noname.c64.org/csdb/release/?id=5375 ) (has been improved but is not perfect)
  • the various analog side effects that must be considered when pressing two or more keys are not emulated correctly, so this will currently not produce the correct results in some corner cases.
  • Shift Register IRQ triggers one cycle too early (see this bug)

used in: C64, C128, 1570/71

SID

  • POTX/POTY sampling jitter is not emulated
  • only one mouse or pair of paddles can be emulated at a time
  • 'dump' support in the monitor is missing

used in: C64, C128, CBM2, (VIC20, PLUS4, PET: SID cart)

TED

used in: Plus4

VDC

  • Some basic features of the VDC are missing:
  • Registers 34/35 (horizontal blanking position) not implemented
  • $d600 bit 7 STATUS flag is only approximately implemented. Fixing requires emulating the internal timing of the VDC.. (partially implemented in r35456, also see testprogs/VDC/vdctiming)
  • Differences between 8563 and 8568 are not all emulated, eg. register 38
  • Snapshot doesn't include VDC
  • Clock calculation for lightpen is incorrect (?)
  • Can't resize the screen enough to fit all video modes, e.g. vdcmodemania high resolution modes. Aspect ratio needs to change on the fly too.
  • Screen position is not always correct, e.g. vdcmodemania FLI parts

used in: C128

VIC

used in: VIC-20

VIC-II

used in: C64, CBM2

VIC-IIe

  • The test bit is not emulated, which results in things like 'real interlace' ([1]) and the $D030 new VIC-IIe color palette hack ([2]) not working.

used in: C128

t6721a

  • 48bit frames support is incorrect/broken
  • synthesizer condition 2 loss-effect-, shape- and repeat- bits have no effect
  • reading from the speach rom is not emulated (which is not really an issue since neither magic voice nor v364 have one)
  • snapshot support is missing

used in: Magic Voice, Plus4 (V364)

mc6821

  • interrupts are not implemented
  • implementation of C2 output modes is incomplete

used in: Formel64, Magic Formel, Dolphin-DOS 3

CS8900a

  • snapshot support is missing

used in: RR-Net/TFE

RIOT

  • I/O "peek" function is broken
  • I/O "dump" function is missing

used in: 2040/3040/4040/1001/8050/8250

PC8477/DP8473

  • I/O "dump" function is missing

used in: FD4000/FD2000

WD1770

  • I/O "dump" function is missing

used in: 1570/1571/1581

ACIA (6551)

Detailed info on the state of RS232 emulation can be found here.

Cores

spi-sdcard

  • snapshot support is missing

used in: MMC64, MMC Replay

ser-eeprom

  • snapshot support is missing

used in: MMC Replay

midi

  • snapshot support is missing

used in: C64, VIC-20

Machines

vsid

x64 / x64sc

NOTICE:

Since revision 36182 (2019-04-08), VICE will no longer build the old x64 binary by default. To make VICE build x64, pass `--enable-x64` to configure.

general
  • the memory layout for "Max Machine" is not yet correct
  • when SX-64 is selected, the tick for the CIA TOD clocks should always be 60Hz (regardless of PAL/NTSC)
  • for details see C64models
x64 issues addressed by x64sc

To clarify... these will never (as in can't) be emulated in the regular x64, unless we end up replacing x64 with x64sc.

  • some VIC-II bugs present in the old VIC-II core
    • inline gfx data changes are not emulated (see testprogs/VICII/gfxfetch/)
    • The VIC-II implementation lacks cycle exact sprite collision support
    • VIC-II shows wrong colors when switching from hires background to idle with borders open (see testprogs/VICII/border/*, Krestology)
    • VIC-II fetches from cartridge in ultimax mode can not be emulated properly for all carts

note: this is also broken in xcbm2

Workaround in all cases: use x64sc :)

x64 specific problems

note: While most of the x64sc improvements/fixes are impossible to shoehorn into x64 (hence the split), a few things could still be improved:

Workaround in all cases: use x64sc :)

Cartridge System

note: the detailed todo list/status is here.

  • some carts have no snapshot support yet (still broken: Magic Voice, MMC Replay, RR-Net MK3, Ethernet.)
    • IDE64 & ATA system can only handle "readonly" snapshots now. Somehow the image file must be matched to the snapshot to prevent corruption.
    • MMC64 snapshots do not include the SD-card
  • some carts do not work 100% yet (still broken: Magic Voice, MMC Replay.)
    • Magic Voice: emulation of the speech chip is incomplete (see Todo#t6721a), this breaks some words included in the magic voice rom and the "a-bee-c" cartridge. Memory mapping is incomplete/broken (which however affects no known software/testcase).
    • MMC Replay: only the BIOS mode works right now; the monitor may incorrectly access cartridge memory (even) if "bank cart" is explicitly set
  • the (very strange, and incompatible with most cartridges) passthrough port of the SFX sound expander is not emulated
  • various cartridges have no support for verbose i/o dump in the monitor
  • Passthrough port functionality depends on ordering of cartridge attaches, especially visible from the command line. (e.g. MMC64+RR ok, RR+MMC64 not)
  • TODO: IDE64 is missing a "make HD image read only" resource
  • TODO: IDE64 saves its config data into vicerc - it should use a bin image like every other cartridge
  • RAM link has some implementation problems
    • it uses the "Main Slot" allthough it has a Passthrough port - it should use "Slot 0" instead
    • it uses the "main image" API for save-as and flush - this is technically wrong and can only "work" right now because the "main image" (which is the ROM!) can not be changed
      • TODO: we need to create an API for saving/flushing secondary images (such as additional cartridge RAM or EEPROMs)

x128

  • Support for fast mode (2MHz) is implemented but incomplete, detailed information about the stealing of cycles by the VICII when switching back from fast mode is missing and therefor the emulation of it is incorrect.
  • support for c128 specific expansion port handling/mapping is missing in the c64/c128 cartridge system (MMC Replay, FastLoad128, MACH128, other?)
  • the relative speed and details like cycle-stealing of the z80 is inaccurate ( https://sourceforge.net/tracker/?func=detail&aid=3476760&group_id=223021&atid=1057617 )
xmx provided a test program, see testprogs/c128/z80/cycletimer
  • CPU history (chist) implementation is incomplete

xvic

Cartridge System
  • cartridge_get_info_list is not implemented
  • CRT/BIN saver are missing
    • writeback with crt file is not implemented
    • GUI elements for "save cartridge" are missing

x64dtv

The DTV emulator is very inaccurate and is in need of a partial rewrite. Maintainer wanted!

  • Misery 3: (http://noname.c64.org/csdb/release/?id=83196)
    • fails emudetect
    • plasma part is missing badlines
  • switching VICII border mode resets x64dtv ( https://sourceforge.net/tracker/?func=detail&aid=3004255&group_id=223021&atid=1057620 )
  • CPU history (chist) implementation is incomplete
  • the "PS/2 Mouse at Userport" should get refactored to be a regular Userport device in the common Userport system
  • "enable Userport Joystick" vs "Hummer Userport Joystick" is strange and confusing, especially since in the DTV emulator we dont even have a "UserportJoyType" selection. the regular "DTV Joystick on Userport" should become a regular Userport device.

xplus4

The plus4 emulator is generally work in progress and not yet "ready". Maintainer wanted!

Cartridge System
  • handling of the c0/c1/c2 roms is weak
    • cartridges share the same roms as internal roms
    • roms are not removed from the memory map if not present (just cleared)
  • "mmu" memory translation table handling is not implemented for cartridges
  • snapshot implementations are completely untested
  • .crt support is missing

xcbm2

  • The CBM-II emulator, when the execution bank is set to an open memory bank, sets the zeropage and stack access to unmapped, but actually existing memory. This is a bug but cannot be avoided with the current CPU code architecture.
  • break- and watchpoints in zeropage are broken. this is because of the old cpu core, and can likely not be fixed without migrating to the new one.
  • banking in the monitor is broken
  • breakpoints are broken
    • when a breakpoint is hit, the monitor disassembles from the wrong bank
    • breakpoints will only hit in the bank which is active in the monitor (!)
  • when running the burn-in diagnostic tests, the CIA is reported as bad ( https://sourceforge.net/tracker/?func=detail&aid=3102493&group_id=223021&atid=1057617 )
note: run like this: xcbm2 -model 610 -ntsc -drive8type 8050 -virtualdev +truedrive -8 cbm2-burnin.d80
  • CPU history (chist) implementation is incomplete
Cartridge System
  • not implemented yet

xcbm5x0

  • The emulator, when the execution bank is set to an open memory bank, sets the zeropage and stack access to unmapped, but actually existing memory. This is a bug but cannot be avoided with the current CPU code architecture.
  • break- and watchpoints in zeropage are broken. this is because of the old cpu core, and can likely not be fixed without migrating to the new one.
  • banking in the monitor is broken
  • In the C510 emulation the VIC-II timing is not exact, i.e. the stopping of the CPU during bad lines is wrong.
  • The C510 emulation uses the old VIC-II core which means no cycle exact sprite collisions, no inline gfx changes, and probably more.
  • CPU history (chist) implementation is incomplete
Cartridge System
  • not implemented yet

xpet

  • When running the "8296d diagnostic" test of the 8296 system disk on "xpet -model 8296" some tests fail:
    • when TDE is enabled, the program will hang. when TDE is disabled, the IEEE interface status will be reported as bad
    • the userport is reported as bad (perhaps some dongle is needed?)
note: run like this: "xpet -model 8296 -drive8type 8050 -8 8296d-systemdisk.d82 -editor edit-4-80-b-50Hz.901474-04.bin". the "burnin8296" program seems to be an older version of the "8296d diagnostic" program. it runs when TDE is enabled, but the 50Hz irq test fails.
  • break- and watchpoints in zeropage are broken. this is because of the old cpu core, and can likely not be fixed without migrating to the new one.
  • some combinations of selected keymap and keyboard model do not work because of missing keymaps
    • also the keymaps must match the "editor" ROM - currently only the UK (Business) ROM in included in VICE
    • the keymaps for US (host) keymap need to be checked and fixed
  • CPU history (chist) implementation is incomplete

Ports

archdep

Windows

Linux

*BSD

BeOS

  • BUG: Sound problems on slower machines (P100) with a non-official driver for sb16.
  • BUG: Compiling with `--enable-ethernet` fails due to absence of rawnetarch.{c,h} missing --Compyx 2016-10-26 (tested on Haiku)

GTK3 UI

Gtk3 is portable and widely supported and has a C interface. So we should be able to write the UI code once and have it run on our major platforms: Linux, Windows and OSX. Using GLib (a dependency of Gtk3) a lot of platform-dependent code in the UI can be avoided and many standard dialogs, such as open/save/select-dir need to written only once, Gtk3/GLib will handle most of the platform-dependent stuff.

The list of covered resources is here

UI code refactoring to support the new threaded UI code

This means a lot of work testing, documenting and debugging, so it deserves a separate page: Gtk3 Threaded UI

This is fixed in 3.6, though VSID might require some more work.

BUGS/TODO

This is a list of things to do and bugs to fix. This is no way an exhaustive list, to get a better understanding of what needs to be fixed/altered, run this command inside VICE's top dir: grep -n 'FIXME\|TODO\|XXX' `find src/arch/gtk3 -name '*.c'`, and be amazed.

  • Write documentation on how to use the UI
  • TODO: Add support for non-ASCII characters in the various file/path dialogs (snapshot, maybe even the various cartridge image/eeprom paths and the machine/drive ROM paths) (fixed?)
Menus
Main window(s)
  • TODO: make sure both hard- and software rendering match whats described in Scaling_cleanup - if so, the page can be cleaned out
Implemented, but only for a single display, no multi-display support yet. GDK seem to support multi-display setup querying, but we'd actually have to write code and test this to see how GDK handles this, if at all. (fixed?)
    • do not forget the VDC and the Monitor windows (fixed?)
VDC is handled, the monitor windows isn't, there aren't any resource for the monitor window, nor any event handlers. Another wish seems to be to put the VICII and VDC window next to each other for x128, which will probably mean introducing yet another resource to control this and override the Window1* resources. Probably some enum: USE_WINDOW1* = -1, ABOVE, BELOW, LEFT, RIGHT. And hope the Window Manager actually listens to our requests to move said window.
  • BUG: mouse grab (when mouse emulation is enabled) is not perfect. eg when the emulator is started with mouse enabled, the pointer is not initially moved into the emulator window.
Statusbar
  • BUG: On MacOS and Windows, the slider popup widget is hidden behind the rendered canvas, on Linux this works as it should. So currently the volume widget is disabled on MacOS and Windows
Dialogs
  • TODO: Polish the keyset dialog: at there very least split the UI into a 3x3 grid for the directions and a 4x2 grid for the fire buttons. Maybe use icons for the direction if they're in the default Gtk icon set.
Settings
  • TODO: ROM-set manager/settings need to be reworked and fixed. ROMset "archives" should be removed completely. see #ROMsets
  • TODO: HardSID settings are missing
Pet model
  • TODO: xpet seems to be fine, someone with actual PET knowledge should check this, especially the "SuperPET" stuff. (fixed?)
CBM2 model (xcbm2/xcbm5x0)
  • TODO: Check model settings glue logic.
Mostly works, the 50/60Hz switch is a problem. I'll need someone with some actual CBM-II knowledge to help me out here. Compyx 2020-01-08
Drive
Game Controller / Joysticks
  • TODO: we need an interface to map controller buttons and axis to joystick emulation, keyboard input and GUI actions
    • at this point, make sure the mapping can be different for each connected joystick
    • also make sure support for 2nd and 3rd button is handled correctly
  • TODO: joy-osx.c contains a lot of resources and commandline options that should not be there, but live in common code instead. this needs some refactoring to make game controllers work the same in all ports
    • similar for at least joy-unix.c, but commented out
vsid
  • BUG: Fix drag-n-drop behaviour, dragging multiple SID files onto the playlist widget works, but on Linux at least, dropping a SID file on the STIL view widget doesn't work (specifically the GtkTextView), this works on Windows oddly enough.
  • TODO: Implement "goto-next-SID" when having SLDB support enabled.
  • BUG: STIL view: some tunes (for example Last Ninja 2) print empty "tune #x" entries, so you'll get "Tune #1" in blue and a few empty lines, in the case of LN2 this goes on until tune #6. Most likely a bug in the use of hvsclib, not the lib itself.
  • TODO:Playlist: allow keyboard navigation. Perhaps also multi-select via Ctrl or Shift to delete multiple entries?
Monitor

The GUI based monitor currently uses a mercylessly hacked VTE library. When we looked for a way to put the monitor into a console window that works with GTK3, this seemed to be the only way to do it. The ugly hacks were required to make VTE compile and work on windows. This is also why we cant use a more modern version of the VTE library.

  • TODO: On the long run, we will have to write a custom renderer for a monitor window, which supports all the things we need to implement a classic "fullscreen editor" like ml monitor.
  • TODO: Again as a long term goal, we might want to support transparent support for native charsets

for some info on the monitor ui see: MonitorUI.

Unix (Linux)
Windows
macOS
  • TODO: joystick_ui_get_next_device_name should return the detected joysticks instead of the predefined list (fixed?)
  • TODO: Make the GTK UI create/use the macOS style "top menubar"
  • TODO: joy-osx.c contains a lot of resources and commandline options that should not be there, but live in common code instead. this needs some refactoring to make game controllers work the same in all ports
OpenGL
  • TODO: The OpenGL renderer should transform itself into a Cairo renderer if the system doesn't support OpenGL. (fixed?)
    • Stretch goal: the OpenGL renderer should fall back to legacy mode (the SDL renderer) if GTK3 itself has, instead of failing.
  • TODO: Do-not-scale option. Important for Cairo renderer, possible for OpenGL.

Feature requests / Stretch goals

  • Make 'smart cartridge attach' dialog smarter when attaching .bin images, show only valid cartridge types when selecting a cart image.
    • TODO: this needs a new API call that returns the valid sizes for a given type
  • make an option to force display size to 1x/2x/3x/4x
  • make a GUI based editor for keymaps
  • add statusbar indicators for cartridge LEDs.
VSID
  • Implement a playlist for VSID (partly done)
  • Add some sort of tree-based file browser (preferably using the HVSC as the default dir) to allow quick tune selection and help with building a playlist (ie via drag-n-drop)
  • Add HVSC BUGlist support to VSID
Support for this is available in src/hvsc, but there are very few actual entries in the BUGList.txt file. Maybe skip this one?

Upstream bugs

See Upstream bugs

SDL UI

BUGS/TODO

  • Write documentation on how to use the UI
  • BUG: FFmpeg media recording behaves unexpected when entering the menu [3]
Menus
  • TODO: some menu items need status text to show that the action has been done.
    • Drive>Fliplist settings>Add current image to fliplist
    • Drive>Fliplist settings>Remove current image from fliplist
    • Drive>Fliplist settings>Attach next image in fliplist
    • Drive>Fliplist settings>Attach previous image in fliplist
  • BUG: at a lot of places "inactive" (as in "cant be selected") menu items are missing the "N/A" on the right
  • TODO: A better way of showing filenames (maybe using contraction) needs to be made
Joysticks
Monitor
  • TODO: implement a scrollback buffer
File Selector
  • TODO: add filtering in file requester
Virtual Keyboard
  • TODO: shift/cbm/ctrl should be "sticky" (right now shifted keys are entered using backspace/cancel - which is odd)
  • TODO: the virtual keyboard handling of the SDL port must be updated/fixed to support all PET keyboards
VSID
  • TODO: Implement a playlist for VSID
  • TODO: Add HVSC song length database (SLDB) support to VSID (both .txt and .md5 file format)
  • TODO: Add HVSC sid tune information list (STIL) support to VSID
  • TODO: Add HVSC BUGlist support to VSID

Windows

  • TODO: embed icons into windows .exe files (fixed?)

OSX

  • BUG: Sound starts to distort heavily after few minutes [4] (fixed?)
  • BUG: Sounds terrible unless sampling is lowered from default 44Khz to 22Khz [5] (fixed?)
  • BUG: Emulator in default config makes no sound unless the OutputMode is changed to Stereo. [6] (fixed?)

External Libraries

VICE uses a few external libraries of which either header files or complete sources are included in the tree:

  • opencbm (src/opencbm.h) (https://sourceforge.net/p/opencbm/)
    • should get moved to src/lib/..
  • P64 (src/lib/p64)
  • ffmpeg (src/lib/libffmpeg)
    • building with `--enable-shared-ffmpeg` will fail when not root. VICE's configure triggers a build and install of liblame which tries to install into /usr/local/lib.
    • building out-of-tree currently fails with:
In file included from ../../../vice/src/lib/libffmpeg/libavutil/avutil.h:289:0,
                 from ../../../vice/src/lib/libffmpeg/libavutil/samplefmt.h:24,
                 from ../../../vice/src/lib/libffmpeg/libavcodec/avcodec.h:31,
                 from ../../../vice/src/lib/libffmpeg/libavformat/avformat.h:255,
                 from ../../../vice/src/gfxoutputdrv/ffmpeglib.h:36,
                 from ../../../vice/src/gfxoutputdrv/ffmpegdrv.c:37:
../../../vice/src/lib/libffmpeg/libavutil/common.h:50:10: fatal error: libavutil/avconfig.h: No such file or directory
 #include "libavutil/avconfig.h"
          ^~~~~~~~~~~~~~~~~~~~~~
compilation terminated.
Makefile:507: recipe for target 'ffmpegdrv.o' failed
TODO: rip out ffmpeg from the tree, disable "internal" ffmpeg support

besides the above, other libraries are used which are currently linked dynamically and must be supplied as dlls for the windows port

  • SDL
  • zlib
  • hardsid

Rewrites

  • The "sc" rewrites. Migrate emulators to the cycle based CPU core (6510dtvcore.c, should be renamed), which allows:
    • cycle based hooks for complex hardware expansions (SCPU)
    • in-line graphics data change emulation (see testprogs/VICII/gfxfetch)
    • cycle exact Blitter/DMA vblank start and proper LinearA/B counter handling on x64dtv
    • cycle based drawing
  • ...and requires (at least):
    • rewrite video chip modules to use:
      • cycle based fetch/etc (VIC & VICII done, VICII-DTV in progress)
      • cycle based drawing (VICII done)
    • remove 1 clock write offsets (at least CIA/VIA already handled)
    • an insane amount of regression testing (preferably with new testprogs where needed)

New Features

This is the place for the VICE developers to put down ideas about the future development of VICE.

Some of these ideas might never be realized, and might look completely absurd, but they could be the inspiration for other ideas.

By putting these ideas down they will be known to any other developers that would like to pick up one of the ideas and implement it.

also look at Tracker: open Feature Requests

general

History Recording

Snapshots

Keyboard

Tape

Monitor

Sound System

Video System

  • some kind of generic interface to handle video input is required to handle scanner/digitizer type of carts

Hardware emulation

SID

x64(sc)

  • internal (?)
    • c64/c128 1.44 MB disk drive support. ([7])
    • c64/c128 SCSI expansion support. ([8])
  • Cartridges
    • IDE64 improvements
      • IDE64 eth64 shortbus expansion support. ([9])
      • IDE64 duart shortbus expansion support. ([10])
    • Clockport improvements
      • Silversurfer (UART) support ([11])
      • IDE64 based eth64-II support ([12])
    • Community Information Locator Commodore 64/128 addon cartridge ([13])
    • Daisy Sound sampler audio input support. ([14])
    • PS64 speech cartridge support. ([15])
    • Voice Messenger speech cartridge support. ([16])
    • ramdrive support. ([17])
    • turbo master cartridge support (4Mhz 65C02). ([18] [19])
    • turbo process cartridge support (4Mhz 658156). ([20] [21])
    • flash-8 cartridge support (8Mhz 65816). ([22])
    • SCPU cartridge support (20Mhz 65816). (in progress, has lead to a new emulator called xscpu64) ([23] [24]) (https://sourceforge.net/tracker/?func=detail&aid=2030692&group_id=223021&atid=1057620)
    • The Final Chesscard (65c02) ([25])
    • German Btx cartridge (6803)
    • MasC=uerade Cartridge Converter support, this cart is originally intended to use c64 carts on the vic20, but in theory could also be used the other way around. ([26])
    • BI-80 cartridge support. ([27])
    • Buscard II IEEE488/printer-port cartridge support. ([28])
    • MAYA Software Eprom Cart
    • PCC-4/PCC-8 Eprom Cart (Jason Ranheim)
    • "Alien Flash"
      • VICEminus had this
    • Software of Sweden Megacart
    • DUBCRT
    • "MegaOne" - Easyflash compatible Flash cartridge, see here
  • Cartridges that wont be emulated:
    • SoftPROM cartridge ([29])
      • pointless, unless software specifically designed for this cart can be found. other than that its just an ordinary 8k game cart (with battery backed up ram instead of rom). Gpz 23:01, 30 October 2010 (UTC)
    • Net64 cartridge support. ([30])
      • this is exactly the same as "the final ethernet" (which is emulated) Gpz 23:27, 30 October 2010 (UTC)
    • 64NIC
      • again, same as TFE. also has an optional eprom, which is equivalent to using cart8
    • "GeoAction"
      • pointless, equivalent to Action Replay + GeoRAM/RamCart
    • "Flash Gordon"
      • pointless, external kernal with flash, prototype (not released)
  • Userport
    • CBM1660 (userport) modem300 support. ([31])
    • CBM1670 (userport) modem1200 support. ([32])
    • FB-RS232 (userport) support. ([33])
    • c64 p64 midi interface: ([34])
    • Scanntronik handyscanner (userport) support. ([35])
    • Video Byte II video digitizer (userport) support. ([36]) ([37])
    • Computera Eyes video digitizer (userport) support. ([38] [39])
    • Userport RocketDrive support. ([40])
    • CIA-IDE-HD support. ([41])
    • Aprotek universal rs232 adapter support. ([42])
    • Comet64 support. ([43])
    • L. Pantarottos adapter support. ([44])
    • WiC64 support ([45])
  • Tape Port
  • Video output.
    • c64 LCD64 screen support. ([51])

x128

  • c128 plus60k support.
  • c128 plus256k support.
  • c128 256K memory expansion hack support.

xvic

xplus4

  • add support for "speedy" freezer cartridge

xpet

  • PET ROM-socket RTC support. ([55])
  • 8296 pet hardware ram lines connected to userport support.
  • 8296 RAMdisk 2008 support. ([56])
  • 8296 pet switchable 4 screens output support.
  • pet IEEE488 -> IDE/RS232 support. ([57])
  • High-Res
    • High-Res Technologies Graphics Board support. ([58], [59])
    • Data Becker CBM-8000 hi-res graphics support. ([60])
    • SuperSoft High Resolution Graphics Board support. ([61])
    • Eltec petGRAFIK support. ([62])
    • Delph Electronics 8000C support. ([63])
  • MTU K-1002-2 DAC sound system support. ([64])

xcbm2

  • cbm2 z80, better nec v20, support.
  • cbm2 8088 support. ([65])
  • B700 HiRes Graphics Board support. ([66])

Drives

Printers

IEEE printer support is completely missing right now
    • MPS1361 support.
    • CBM4022 support. (supported by mps printer engine)
    • CBM8023 support. (supported by mps printer engine)
    • CBM8024 support.

Misc

Retrieved from "http://vice-emu.pokefinder.org/vicewiki/index.php?title=Todo&oldid=5826"