Todo: Difference between revisions

From vice-emu
Jump to navigation Jump to search
 
(674 intermediate revisions by 9 users not shown)
Line 1: Line 1:
==Prime Directive==
* 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 [https://sourceforge.net/tracker/?limit=50&group_id=223021&atid=1057617&status=1&submit=Filter Bug Tracker] and mark it as fixed in the list below.
<pre>
<@_tlr> Please at least test the issue you were trying to fix before committing.
</pre>
----
==Known Issues==


This is the list of known problems. also look at [https://sourceforge.net/tracker/?limit=100&func=&group_id=223021&atid=1057617&assignee=&status=4&category=&artgroup=&keyword=&submitter=&artifact_id=&assignee=&status=1&category=&artgroup=&submitter=&keyword=&artifact_id=&submit=Filter&mass_category=&mass_priority=&mass_resolution=&mass_assignee=&mass_artgroup=&mass_status=&mass_cannedresponse= Tracker: open Bugs]
This is the list of known problems. also look at [https://sourceforge.net/tracker/?limit=100&func=&group_id=223021&atid=1057617&assignee=&status=4&category=&artgroup=&keyword=&submitter=&artifact_id=&assignee=&status=1&category=&artgroup=&submitter=&keyword=&artifact_id=&submit=Filter&mass_category=&mass_priority=&mass_resolution=&mass_assignee=&mass_artgroup=&mass_status=&mass_cannedresponse= Tracker: open Bugs]


This list always refers to the status of the last major release version, which was '''3.2'''. 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.
This list always refers to the status of the last major release version, which was '''3.8'''. 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==


===Documentation===
* '''All developers shall subscribe to the [https://sourceforge.net/p/vice-emu/mailman/ vice-emu-mail mailinglist]''' and perhaps join #vice-dev on freenode too (highly recommended).
====MAN Pages====
* Please '''respect the [https://sourceforge.net/p/vice-emu/code/HEAD/tree/trunk/vice/doc/coding-guidelines.txt coding guidelines]'''.
* the man pages are very outdated and should perhaps be generated from the infotext
* '''Document your code''' so other people than you are able to understand and fix it in a decade or two.
** the man pages refer to the path where the html documentation can be found, this should get adjusted to whats actually used
* 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.
* the following man pages are missing: vsid
* 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'''.
* man pages for the individual emulator binaries should get installed as symbolic links to vice.1
* After fixing a bug or implementing a new feature, '''update''' its status on '''the [https://sourceforge.net/tracker/?limit=50&group_id=223021&atid=1057617&status=1&submit=Filter 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.
====Manual====
* And most importantly...
=====Technical=====
<pre>
* many nodes are not yet linked correctly, which makes some of the exporters output garbled and/or suboptimal output (windows .hlp, unix .info).
<@_tlr> Please at least test the issue you were trying to fix before committing.
 
</pre>
: '''Workaround:''' use the .html or .pdf documentation, which is exported correctly.
: 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.'''
 
=====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 [[VICEKB|here]]
* some descriptions of emulator formats are missing (D67, D1M, D2M, D4M...)
* descriptions of several snapshot modules are missing (Plus4, TED...)
* generate target specific documentation
** win32 documentation. (.chm format)
** amiga documentation. (.guide format)
** <s>BeOS documentation</s>. (.html format)
** MSDOS documentation. (.txt format)
** OS/2 documentation. (.inf format)
** RiscOS documentation.
** SDL documentation.
 
for details look at doc/Documentation-Howto.txt
 
----


===Testbench===
==Testbench==


* many test programs (mostly for vic20) are not yet integrated into the automatic testing
* 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''': 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 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 ===
* x128 does not autostart prg files correctly when also a cartridge is attached (that forces c64 mode)


----
==Emulators==


===Subsystems===
===Subsystems===
Line 63: Line 37:
* 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.
* 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.


: note: also see [[VICEKB#20-006|this knowledgebase article]]
: '''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.
 
: '''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.
 
* When typing very quickly, some keypresses might get lost. This comes from the fact that the keyboard is (and can not) be scanned in real time (ie every 1mhz cycle). Even if we could remove the per frame scanning from the emulator itself, the operating system and last not least the keyboard itself would still impose a certain limit (something like 10ms for USB HID keyboards, for example). That means if a key is pressed and released within that timespan, the emulator does (and can not) know about it.
 
: '''Workaround''': the only workaround is to type slower, it cant be fixed.


* Some ports/emulators/keyboard-types do not have all required keymaps (and a fallback will used) - look at [[Keymaps]] for details
* Some ports/emulators/keyboard-types do not have all required keymaps (and a fallback will used) - look at [[Keymaps]] for details
Line 81: Line 49:
====Joystick====
====Joystick====


* currently VICE interprets all buttons of a connected joystick as fire button ( https://sourceforge.net/tracker/?func=detail&aid=3292139&group_id=223021&atid=1057620 )
WIP [[Joymappings]]
* 2nd button of C64GS joystick (cheetah annilihator) not implemented ( http://sourceforge.net/p/vice-emu/feature-requests/189/ )
 
* contact-bounce is not emulated
* contact-bounce is not emulated
: '''TODO''': make a proper test program
: '''TODO''': make a proper test program
: https://csdb.dk/release/index.php?id=242527


====Joystick port devices====
====Monitor====


* Paperclip 64 dongle emulation is broken
* TODO: Breakpoints/watchpoints should consider banks, and perhaps PLA/MMU config
* banking should somehow work also with cartridges. for this some generic interface in the cartridge system needs to be created


====Commandline====
===== Profiler =====


* some options where the available parameters depend on the machine type lack proper descriptions (-drivetype)
The new profiler feature is still incomplete ( https://sourceforge.net/p/vice-emu/patches/350/ )


====Monitor====
* support for banking (main CPU) is only implemented in x64(sc) right now
** banking should somehow consider cartridge banks, once we have generic support for it in the monitor
* perhaps additional stats for "stolen cycles" (cycles used by the VICII) can be added
* branch taken / not taken statistics
* support for drive CPUs is missing
* support for other CPUs than 6502 is missing
* binary remote monitor commands need to be implemented (perhaps once more of the above works, so we know how these must look like)
 
===== 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:


* When loading a snapshot, the monitor break/watchpoints break.
* 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
* Improve the remote interface
* More comments are needed in place of the various checks


====History Recording====
====History Recording====
Line 120: Line 109:
* 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)
* 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")
* artefact color and luma/chroma crosstalk are not emulated (eg the "red/green stripes")
* color generation should get a partial rewrite according to new research by pepto (http://colodore.com)


see http://hitmen.c02.at/temp/palstuff/ for some further info on this topic.
see http://hitmen.c02.at/temp/palstuff/ for some further info on this topic.
Line 126: Line 114:
====Drive Emulation====
====Drive Emulation====


* Dual disk drive 2040/3040 support (DOS1, 670 blocks free) is not working
* when using a dual drive, and no TDE, only the first drive (0:) can be used.
* G64 image support is incomplete, the speedzone definitions are completely ignored
* 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.
: ''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.
Line 137: Line 123:
* RELative files are only supported when using disk images ( https://sourceforge.net/p/vice-emu/bugs/703/ )
* 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).
* 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=====
=====True Drive Emulation=====
Line 142: Line 129:
* mechanical delays (such as head stepping and motor spinup) are not emulated yet.
* 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.
* 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.
======1541======
: 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 Emulation still fails a few test programs
======1571======
======1571======
* 2mhz mode of the 1571 is not handled correctly
* 2mhz mode of the 1571 is not handled correctly
** drive CPUs always run at 1Mhz for all drives (hardcoded 1000000 at a few places)
** 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!")
** 1571 has extra delay on on reading sync inside the drive, ("you cannot use BVC in 2mhz mode!")
* 1571CR emulation does not work correctly
* 1571CR (MOS5710) emulation is incomplete
** extra FDC2 registers are not implemented
* double sided 1571 images do 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)
** 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)
** 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)
** 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)
======Dual Drives======
r25459 by Rhialto:
I enabled up to DRIVE_NUM IEEE-488 drives, rather than 2 (in True Drive Emulation mode). In some places where they are enumerated, it is 4. The drives use their full 3 bits of jumpered drive number now, rather than just 1 bit.
I have also generalised  code so as to allow another dual drive. Since dual drives currently use up two device numbers, it will use 10 and 11. I'm currently simplifying the methods for checking the dualness of a drive.
When that is done, I hope to have gained enough understanding of the code to remove the horrible hack of using 2 devices for a dual drive, and remove it. It looks like it will simplify a lot of code (including removing lots of code that I changed for allowing 2 dual drives). That will have some repercussions on the GUIs, since for every drive you may need to be able to attach ''two'' image files. It also would add an extra "drive" parameter (in addition to the current "unit" parameter) to a shedload of functions, although this is a pretty mechanical change. In fact, it is the GUI change that currently holds me back...
'''TODO''': Think of some elegant way to represent settings for 8 floppy images (for 4 dual drives), without requiring all GUIs to be updated at once.
'''TODO''': After that, I can rework the code to make dual drives more regular and hence allow 4 of them.


=====Extensions=====
=====Extensions=====
Line 180: Line 153:
: ''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.''
: ''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
* motor noise is not emulated
====Tape port devices====
* DTL Basic Dongle emulation is broken


====Printer Emulation====
====Printer Emulation====
Line 190: Line 159:
: ''there perhaps should be a way to explicitly set a directory for printer output files'' [[User:Gpz|Gpz]] 01:24, 4 July 2011 (UTC)
: ''there perhaps should be a way to explicitly set a directory for printer output files'' [[User:Gpz|Gpz]] 01:24, 4 July 2011 (UTC)
* printer noise is not emulated
* printer noise is not emulated
* printers don't work on the PET (or other IEEE-488 computers)


----
----


===c1541===
===Cores===


* handling of .d81 CBM sub partitions and CMD DIR subdirectories is broken due to the way disk images are handled.
{| class="wikitable"
** accessing files does not work ( https://sourceforge.net/tracker/?func=detail&aid=3367519&group_id=223021&atid=1057617 )
! Core !! used in !!
** listing directories does not work ( https://sourceforge.net/tracker/?func=detail&aid=3367517&group_id=223021&atid=1057617 )
|-
: ''unfortunately to fix this a lot of c1541 will have to be rewritten (mount image only once, not for each operation)'' [[User:Gpz|Gpz]] ([[User talk:Gpz|talk]]) 23:57, 13 December 2012 (UTC)
| VIA || VIC20, PET, various drives ||
|-
| CIA || C64, C128, 1570/71 ||
|-
| SID || C64, C128, CBM2, (VIC20, PLUS4, PET: SID cart) ||
|-
| TED || Plus4 || snapshots are broken
|-
| VDC || C128 || snapshots are broken
|-
| VIC || VIC-20 ||
|-
| VIC-II || C64, CBM2 ||
|-
| VIC-IIe || C128 ||
|-
| t6721a || Magic Voice, Plus4 (V364) || snapshot support is missing
|-
| mc6821 || Formel64, Magic Formel, Dolphin-DOS 3 ||
|-
| CS8900a || RR-Net/TFE || snapshot support is missing
|-
| RIOT || 2040/3040/4040/1001/8050/8250 ||
|-
| PC8477/DP8473 || FD4000/FD2000 ||
|-
| WD1770 || 1570/1571/1581 ||
|-
| ACIA (6551)|| Swiftlink ||
|-
| spi-sdcard || MMC64, MMC Replay || snapshot support is missing
|-
| ser-eeprom || MMC Replay || snapshot support is missing
|-
| midi || C64, VIC-20 || snapshot support is missing
|}


* since virtual drive emulation does not support REL files on the host filesystem, c1541 can not extract them to R00 files ( https://sourceforge.net/p/vice-emu/bugs/702/ )
====VIA====


----
* MYVIA_NEED_LATCHING option is possibly broken, but in any case untested
 
* the code doesn't actually notify anything outside the chip when PB7 toggles
===Chips===
** Same so far for the output from the shift register and its handshaking


====CIA====
====CIA====
Line 211: Line 214:
* 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 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.
* 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 only cycle too early (see [http://sourceforge.net/p/vice-emu/bugs/599/ this] bug)
* <s>Shift Register IRQ triggers one cycle too early (see [http://sourceforge.net/p/vice-emu/bugs/599/ this] bug)</s> (fixed)
* I/O "peek" function is broken
 
used in: C64, C128, 1570/71


====SID====
====SID====


* we need different tweak values (filter bias etc) for 6518 and 8580
* the POTX/POTY sampling period is not taken into account (512 cycles)
* POTX/POTY sampling jitter is not emulated
* POTX/POTY sampling jitter is not emulated
* only one mouse or pair of paddles can be emulated at a time
* 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====
====TED====


* snapshots are broken
* FLI does not work ( https://sourceforge.net/tracker/?func=detail&aid=3205787&group_id=223021&atid=1057617 )
* FLI does not work ( https://sourceforge.net/tracker/?func=detail&aid=3205787&group_id=223021&atid=1057617 )
used in: Plus4


====VDC====
====VDC====


* Some basic features of the VDC are missing:
* Some basic features of the VDC are missing:
** Interlaced mode ( https://sourceforge.net/tracker/?func=detail&aid=2871065&group_id=223021&atid=1057617 ) - This will require a major rewrite of the output as it is currently basically 640x200(ish) vertically stretched to keep the aspect right, but in interlaced it will have to go to 640x400ish with no vertical stretching. None of the other emulated models change output modes like this and it can break some platforms.
** Registers 34/35 (horizontal blanking position) not implemented
* 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)
* $d600 bit 7 STATUS flag is always set, ie. the VDC is never 'busy'. Fixing requires emulating the internal timing of the VDC..
** Differences between 8563 and 8568 are not all emulated, eg. register 38
* Differences between 8563 and 8568 are not all emulated, eg. register 38
* Clock calculation for lightpen is incorrect (?)
* Snapshot doesn't include VDC
* 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.
* Clock calculation for lightpen is incorrect
* Screen position is not always correct, e.g. vdcmodemania FLI parts
 
used in: C128


====VIC====
====VIC====
Line 254: Line 244:
** lightpen values are off (see testprogs/VIC20/split-tests/lightpen, http://sleepingelephant.com/ipw-web/bulletin/bb/viewtopic.php?t=4870 )
** lightpen values are off (see testprogs/VIC20/split-tests/lightpen, http://sleepingelephant.com/ipw-web/bulletin/bb/viewtopic.php?t=4870 )
** some glitches when XPOS is 0, breaks (at least) Vicual MMIX credits part (http://www.cs.tut.fi/~albert/Pu-239/vicual-mmix/)
** some glitches when XPOS is 0, breaks (at least) Vicual MMIX credits part (http://www.cs.tut.fi/~albert/Pu-239/vicual-mmix/)
used in: VIC-20


====VIC-II====
====VIC-II====
Line 263: Line 251:
* DMA delay artifacts are not emulated correctly ( https://sourceforge.net/tracker/?func=detail&aid=3325466&group_id=223021&atid=1057617 )
* DMA delay artifacts are not emulated correctly ( https://sourceforge.net/tracker/?func=detail&aid=3325466&group_id=223021&atid=1057617 )
* Sprite fetch bugs in sideborder are not emulated correctly ( https://sourceforge.net/tracker/?func=detail&aid=3325426&group_id=223021&atid=1057617 )
* Sprite fetch bugs in sideborder are not emulated correctly ( https://sourceforge.net/tracker/?func=detail&aid=3325426&group_id=223021&atid=1057617 )
 
* DMA delay does not affect idle byte correctly [https://sourceforge.net/p/vice-emu/bugs/1855/ bug#1855]
used in: C64, CBM2
* 6569R1 sprite oddity at X-position $163 is not emulated correctly [https://sourceforge.net/p/vice-emu/bugs/1857/ bug #1857]


====VIC-IIe====
====VIC-IIe====


* The test bit is not emulated, which results in things like 'real interlace' ([http://sites.google.com/site/h2obsession/CBM/C128/Interlace]) and the $D030 new VIC-IIe color palette hack ([http://www.commodore128.org/index.php?topic=3665.0]) not working.
* The test bit is not emulated, which results in things like 'real interlace' ([http://sites.google.com/site/h2obsession/CBM/C128/Interlace]) and the $D030 new VIC-IIe color palette hack ([http://www.commodore128.org/index.php?topic=3665.0]) not working.
used in: C128


====t6721a====
====t6721a====
Line 277: Line 263:
* synthesizer condition 2 loss-effect-, shape- and repeat- bits have no effect
* 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)
* 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====
====mc6821====
Line 285: Line 268:
* interrupts are not implemented
* interrupts are not implemented
* implementation of C2 output modes is incomplete
* 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====
====RIOT====


* I/O "peek" function is broken
* 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
----
===Cores===
====spi-sdcard====
* snapshot support is missing
used in: MMC64, MMC Replay
====spi-eeprom====
* snapshot support is missing
used in: MMC Replay
====midi====
* snapshot support is missing
used in: C64, VIC-20


----
----
Line 329: Line 277:
===Machines===
===Machines===


====vsid====
====x64sc====


====x64 / x64sc====
Note: [[x64_Bugs|x64]] is deprecated.


=====general=====
=====general=====


* the memory layout for "Max Machine" is not yet correct
* some C64 models are not emulated 100% correctly (for details see [[C64models]])
* when SX-64 is selected, the tick for the CIA TOD clocks should always be 60Hz (regardless of PAL/NTSC)
** the memory layout for "Max Machine" is not yet correct
* for details see [[C64models]]
** The Japanese C64 has "C= lock" instead of "Shift Lock" (the keyboard is physically different)


=====x64 issues addressed by x64sc=====
=====Cartridge System=====


To clarify... these will never (as in can't) be emulated in the regular x64, unless we end up replacing x64 with x64sc.
''note: the detailed todo list/status is [[cartsystem|here]].''
 
* 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:
 
* testprogs/VICII/spritesteal (ntscold)
* testprogs/VICII/spriteenable
* missing open border on top of testprogs/VICII/sprite0move
* testprogs/VICII/split-tests/modesplit
* switching VICII border mode resets x64 ( https://sourceforge.net/tracker/?func=detail&aid=3004255&group_id=223021&atid=1057620 )
 
'''Workaround''' in all cases: use x64sc :)
 
=====Cartridge System=====


* some carts have no snapshot support yet (still broken: MMC64, Magic Voice, MMC Replay, MIDI, RR-Net MK3, Ethernet.)
* 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.
** 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.)
* 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).
** 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
** MMC Replay: only the BIOS mode works right now; the monitor may incorrectly access cartridge memory (even) if "bank cart" is explicitly set
** RR-Net MK3: to get the ethernet functionality it must be explicitly enabled too, and will appear as a "clockport" internally (which is wrong)
* the (very strange, and incompatible with most cartridges) passthrough port of the SFX sound expander is not emulated
* 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
* 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)
* 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


''note: the detailed todo list/status is [[cartsystem|here]].''
----
 
====x128====
====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 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 )
* 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 ) '''TODO''': cycle accurate test programs
: xmx provided a test program, see testprogs/c128/z80/cycletimer
* CPU history (chist) implementation is incomplete
* CPU history (chist) implementation is incomplete
* should get rewritten to use the new 6510 "sc" core
----


====xvic====
====xvic====
Line 389: Line 318:
* programs that do not work for unknown reason:
* programs that do not work for unknown reason:
** "Grave Cave" ( https://sourceforge.net/tracker/?func=detail&aid=3297561&group_id=223021&atid=1057617 )
** "Grave Cave" ( https://sourceforge.net/tracker/?func=detail&aid=3297561&group_id=223021&atid=1057617 )
* the naming of the VIAs in the sourcecode is mixed up, it should be VIA1 for the one at 9110 and VIA2 for the one at 9120
 
----


====x64dtv====
====x64dtv====
Line 399: Line 329:
* switching VICII border mode resets x64dtv ( https://sourceforge.net/tracker/?func=detail&aid=3004255&group_id=223021&atid=1057620 )
* 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
* 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====
====xplus4====
<big>The plus4 emulator is generally work in progress and not yet "ready". Maintainer wanted!</big>
<big>The plus4 emulator is generally work in progress and not yet "ready". Maintainer wanted!</big>
* support for Snapshots is incomplete/broken (TED, PIA, V364 Speech, ...) ( https://sourceforge.net/tracker/?func=detail&aid=2878220&group_id=223021&atid=1057617 )
* support for Snapshots is incomplete/broken (TED, PIA, V364 Speech, ...) ( https://sourceforge.net/tracker/?func=detail&aid=2878220&group_id=223021&atid=1057617 )
* emulation of the V364 speech chip is incomplete (see [[Todo#t6721a]])
* CPU history (chist) implementation is incomplete
* should get rewritten to use the new 6502 "sc" core
=====Cartridge System=====
* handling of the c0/c1/c2 roms is weak
* handling of the c0/c1/c2 roms is weak
** cartridges share the same roms as internal roms
** cartridges share the same roms as internal roms
** roms are not removed from the memory map if not present (just cleared)
** roms are not removed from the memory map if not present (just cleared)
* emulation of the V364 speech chip is incomplete (see [[Todo#t6721a]])
* "mmu" memory translation table handling is not implemented for cartridges
* CPU history (chist) implementation is incomplete
* snapshot implementations are completely untested
 
----


====xcbm2====
====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.
* 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 )
* 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''
: ''note: run like this: xcbm2 -model 610 -ntsc -drive8type 8050 -virtualdev +truedrive -8 cbm2-burnin.d80''
* CPU history (chist) implementation is incomplete
* CPU history (chist) implementation is incomplete
* should get rewritten to use the new 6502 "sc" core
===== Cartridge System =====
* <s>not implemented yet</s> (fixed)
----


====xcbm5x0====
====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.
* 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.
* 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.
* The C510 emulation uses the old VIC-II core which means no cycle exact sprite collisions, no inline gfx changes, and probably more. See [[x64_Bugs|here]] for details.
* CPU history (chist) implementation is incomplete
* CPU history (chist) implementation is incomplete
* should get rewritten to use the new 6502 "sc" core
===== Cartridge System =====
* <s>not implemented yet</s> (fixed)
----


====xpet====
====xpet====
Line 434: Line 376:
** the userport is reported as bad (perhaps some dongle is needed?)
** 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.''
: ''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
* 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
* CPU history (chist) implementation is incomplete
* should get rewritten to use the new 6502 "sc" core
----
----
===SC Rewrites===


===Ports===
As a long term goal, everything should be rewritten to use the new "sc" cpu cores (and the non sc cores removed):


* Make a list of Hotkeys used per port, compare and try to make them the same / alike. ( [[Hotkey cleanup]] )
* Migrate emulators to the cycle based CPU core (6510dtvcore.c, should be renamed), which allows:
* enable/disable menu items in drive settings menu according to [[Drive_options_precedence]]
** cycle based hooks for complex hardware expansions (SCPU)
* Fix all Keymap handling according to [[Keymaps]]
** 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)


* make datasette interface nicer (hotkeys) ( https://sourceforge.net/tracker/index.php?func=detail&aid=2525175&group_id=223021&atid=1057620 )
----
* allow browsing of archives (zip etc) ( https://sourceforge.net/tracker/index.php?func=detail&aid=2942868&group_id=223021&atid=1057620 )
* add dual monitor support (for x128) ( https://sourceforge.net/tracker/?func=detail&aid=2780684&group_id=223021&atid=1057620 )
* add realtime speed adjustment ui / hotkeys ( https://sourceforge.net/tracker/?func=detail&aid=2904137&group_id=223021&atid=1057620 )


* Monitor Improvements: ( also see [[MonitorUI]] )
== Tools ==
*:* use cbm font ( https://sourceforge.net/tracker/?func=detail&aid=3134010&group_id=223021&atid=1057620 )
=== c1541 ===
* improve vsync / add option to sync to actual output framerate ( https://sourceforge.net/tracker/?func=detail&aid=3009846&group_id=223021&atid=1057620 )


====Windows====
* handling of .d81 CBM sub partitions and CMD DIR subdirectories is broken due to the way disk images are handled.
** accessing files does not work ( https://sourceforge.net/tracker/?func=detail&aid=3367519&group_id=223021&atid=1057617 )
** listing directories does not work ( https://sourceforge.net/tracker/?func=detail&aid=3367517&group_id=223021&atid=1057617 )
: ''unfortunately to fix this a lot of c1541 will have to be rewritten (mount image only once, not for each operation)'' [[User:Gpz|Gpz]] ([[User talk:Gpz|talk]]) 23:57, 13 December 2012 (UTC)
* since virtual drive emulation does not support REL files on the host filesystem, c1541 can not extract them to R00 files ( https://sourceforge.net/p/vice-emu/bugs/702/ )
 
* <s>Remove optional dependency on libreadline once linenoise-ng has been tested properly.</s>
:: See if linenoise-ng can be made to work with the MSYS2 shell, which would help with debugging c1541.


* there seems to be a problem with ParSID ( https://sourceforge.net/tracker/?func=detail&aid=2981666&group_id=223021&atid=1057617 )
----
==Ports==


====Linux====
Some of the mess isn't ours! See here for [[Upstream bugs]].


* ADD: support for rtkit ( https://sourceforge.net/tracker/?func=detail&aid=3088679&group_id=223021&atid=1057619 )
===archdep===


====*BSD====
* '''TODO:''' allow browsing of archives (zip etc) ( https://sourceforge.net/tracker/index.php?func=detail&aid=2942868&group_id=223021&atid=1057620 )


* serial device hangs on open() in NetBSD 5.0.2 ( https://sourceforge.net/tracker/?func=detail&aid=3043294&group_id=223021&atid=1057617 )
====Windows====


====BeOS====
* '''TODO:''' the native (console based) monitor does not work in windows


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


===GTK3 UI===
===GTK3 UI===


The how and why we go Gtk3 for *nix, Windows and OSX should be clear, but I'll reiterate: since we don't have any Windows or OSX maintainters left and failed to attract new ones, the decision was made to use Gtk3 as the new UI for 'modern' OSes.
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: <code>grep -n 'FIXME\|TODO\|XXX' `find src/arch/gtk3 -name '*.c'`</code>, and be amazed.


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.
* <b>Write documentation on how to use the UI</b>
* '''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?)


==== Current development state ====
The list of covered resources is [[Gtk3_Resource_Coverage|here]]


* All emulators work, though some UI code still needs to be written or updated to properly support all machines
==== Main window(s) ====
* Default renderer is OpenGL 3.2 based (GTK 3.16 required) and does full HW scaling. Fallback renderer is Cairo-based, which will scale in software if necessary but slows down noticably when it does.
* All UI code is hand-written, we tried using Glade/GtkBuilder, but the amount of machines and extra hardware VICE supports is way too much what a static UI can handle
* Though many UI elements look okay, some don't. This isn't lazyness but rather to avoid tweaking the layout only to discover later that it still needs to be changed. So any layout/style issues will eventually get fixed. So don't complain about it, unless there are glaring bugs (such as dialogs that are too large to fit on a decent screen)


==== BUGS/TODO ====
* '''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.


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: <code>grep -n 'FIXME\|TODO\|XXX' `find src/arch/gtk3 -name '*.c'`</code>, and be amazed.
* '''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.


* Mouse-grab. The UI items is there, but the actual mouse code isn't implemented yet (2017-11-08)
==== Statusbar ====
* The Tape Devices widget needs to check if resources can be set to avoid segfaults (2017-11-14)


* make sure both hard- and software rendering match whats described in [[Scaling_cleanup]] - if so, the page can be cleaned out
* '''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


==== Monitor ====
==== Dialogs ====
* '''TODO''': Polish the keyset dialog: <s>at there very least split the UI into a 3x3 grid for the directions and a 4x2 grid for the fire buttons</s>. Maybe use icons for the direction if they're in the default Gtk icon set.
:: Only arrow icons for North, West, South and East are available. Gtk3 used to have a [https://docs.gtk.org/gtk3/class.Arrow.html GtkArrow] class, but that has been deprecated since 3.14 and removed from 4.x. So we'll have to write our own (which should also prove useful for joystick mapping widgets).


* implement the monitor window with a text-widget and hook up the console input/output interface to it
==== Settings ====


for some info on the monitor ui see: [[MonitorUI]].
* '''TODO:''' HardSID settings are missing


==== OpenGL ====
=====ROMsets=====
* The OpenGL renderer should transform itself into a Cairo renderer if the system doesn't support OpenGL. (2017-11-15)
* Do-not-scale option. Important for Cairo renderer, possible for OpenGL. (2017-11-15)
* Stretch goal: the OpenGL renderer should fall back to legacy mode (the SDL renderer) if GTK3 itself has, instead of failing. (2017-11-15)
 
==== Settings ====


The list of covered resources is [[Gtk3_Resource_Coverage|here]]
* 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


* xpet: "model settings" - more glue logic is needed (2017-11-21)
* '''TODO:''' ROM-set manager/settings need to be reworked and fixed. ROMset "archives" should be removed completely. see [[#ROMsets]]
* On Windows (and perhaps OSX) the MIDI widget should show a combobox with supported drivers (2017-11-14)
* ROM settings are missing (partially supported, needs work (2018-01-31)
* CRT-emulation settings are missing (the sliders at the bottom in GTK2 UI). perhaps just move them into the regular settings
* using scroll wheel on tree view should scroll up/down
* Monitor Settings -> "KeepMonitorOpen" resource does not exist (should probably be created in the yet to do monitor UI code)


==== C64 Cartridge settings ====
===== CBM2 model (xcbm2/xcbm5x0) =====
* MMCR - cartridge image and EEPROM image is mixed up. only the filename selection is related to the EEPROM, the other stuff is related to the cartridge image/flash ROM. also "make eeprom read/write" checkbox is missing. (take GMOD2 as an example, its correct)


* check I/O extensions for proper behaviour:
* '''TODO:''' Check model settings glue logic.
** <s>Memory Expansion Hack</s>
:: Mostly works, the 50/60Hz switch is a problem. I'll need someone with some actual CBM-II knowledge to help me out here. [[User:Compyx|Compyx]] 2020-01-08
*** <s>BUG: enable one hack after the other from left to right, then go back from right left -> crash (i cant reproduce this anymore, WTF [[User:Gpz|Gpz]] ([[User talk:Gpz|talk]]) 00:15, 13 May 2018 (CEST))</s>
**** <s>ok, it doesnt seem to be a gui problem, crashes in plus256k.c:329 or c64_256k.c:441</s>
** GEO-RAM
** RAM Expansion Module
*** BUG: can be enabled but not disabled after that
** RamCart
** Double Quick Brown Box
*** BUG: can be enabled but not disabled after that
** Expert Cartridge
** ISEPIC
** EasyFlash
** GMod2
** IDE64
** MMC64
** MMC Replay
** Retro Replay
** <s>Super Snapshot V5</s>
** Ethernet Cartridge
** RR-Net Mk3
** <s>IEEE-488 interface</s>
** <s>Magic Voice</s>


==== Menus ====
===== Joysticks =====
* <s>in the HELP menu the "browse documentation" item is non functional. we either need a portable solution, or use archdep code here</s>
** its implemented now using the method recommended for GTK3. needs to be checked on windows and OSX. after 3.2 the "htmlbrowsercommand" resource can be removed.
*** it only half works in windows? here acrobat reader starts, and then displays an error message? [[User:Gpz|Gpz]] ([[User talk:Gpz|talk]]) 23:47, 12 May 2018 (CEST)


==== Dialogs ====
see [[Joymappings]]
* "File->Netplay" needs some testing and refactoring. perhaps move it into settings?
** Work is under way in uinetplay_new.c, which mostly works but needs the client/server mapping of keyboard/joystick etc. And indeed moving into settings would be prefered (compyx, 2018-02-09)
* Many open/save dialogs could be improved by remembering the last used directory. Already done are 'smart-attach', 'cart-attach' and 'disk-attach'. (compyx, 2018-05-12)


==== Media recording ====
==== vsid ====
* Implement audio recording and video recording (2017-12-17) -- Mostly implemented, what is missing is a 'stop recording' button on the status bar ([[user:compyx|compyx]] 2017-12-23)
* MacOS: Add QuickTime recording settings widget, like the FFMPEG recording settings widget (I can't do this, someone with MacOS/QuickTime knowledge will have implement that [[user:compyx|compyx]] 2017-12-17)


==== Upstream bugs ====
* '''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.


* Some combobox contents appear to have 'empty' entries and sometimes the colors of the items change (upstream Gtk3 bug) (2017-11-08)
* '''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.


==== Feature requests / Stretch goals ====
* '''TODO:'''Playlist: allow keyboard navigation. Perhaps also multi-select via Ctrl or Shift to delete multiple entries?


* Add some way to show the keycodes of the keys being pressed (perhaps in the status bar?) - that would make it a lot easier to fix/create keymaps
* 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 preview of the RAM init pattern (2017-11-08)
* Add 'revert changes' to dialogs/widgets to revert resources to their state when the widget/dialog was activated. (This is different from restoring to factory defaults) (2017-11-16)
* Add a 'smart' cartridge attach dialog: show "preview" of .crt image if selected in the dialog, show only valid cartridge types when selecting a cart image.
* Add a 'detach all drive images' item


==== VSID ====
* Implement a playlist for VSID
* Add HVSC song length database (SLDB) support to VSID (<s>both .txt and</s> .md5 file format)
* Add HVSC sid tune information list (STIL) support to VSID
* Add HVSC BUGlist support to VSID
* 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?


===SDL UI===
* Update mixer sliders to use proper units etc like the mixer sliders in the other emus


* x64 uses the japanese kernal font when japanese model is selected
==== Monitor ====
* in x128 hammering runstop/restore would crash the emulator in sdl_canvas_create, the SDL2 version of this code is broken [https://sourceforge.net/p/vice-emu/bugs/980/]
* there is no interface for browsing files inside (d64..) images
* Drive>Fliplist settings>Add current image to fliplist>Item needs status text to show that the action has been done.
* Drive>Fliplist settings>Remove current image from fliplist>Item needs status text to show that the action has been done.
* Drive>Fliplist settings>Attach next image in fliplist>Item needs status text to show that the action has been done.
* Drive>Fliplist settings>Attach previous image in fliplist>Item needs status text to show that the action has been done.
* A better way of showing filenames (maybe using contraction) needs to be made
* Hide "dot files" in the file selectors (on *nix) [https://sourceforge.net/p/vice-emu/feature-requests/41/]
* at a lot of places "inactive" (as in "cant be selected") menu items are missing the "N/A" on the right
** Cartridge>MMC64>Enable MMC64 can not be used unless a MMC64 ROM has been selected, it should be made inactive if not


----
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.


==Code cleanup and streamlining==
* '''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:''' <s>Again as a long term goal, we might want to support transparent support for native charsets</s> (implemented in trunk)


As of 3.2 we will remove a lot of the old cruft, that was dangling around in the tree for way too long, to make maintenance easier
for some info on the monitor ui see: [[MonitorUI]].


* remove all GUIs except the GTK3 and SDL UIs
==== macOS ====
* remove translation support (SDL and GTK3 do not have any support for this, so this applies mostly to the command line help)
* remove compiler- and platform- specific hacks (IFDEFS) in common code
* merge archdep* files of SDL and Gtk3 into src/archdep/ (so the same code is used for GTK3 and SDL)
* remove the YUV rendering code, its broken and archaic and shouldnt be needed anywhere
* add howto into docs dir for gtk3 building (needs windows/linux/osx specific instructions)
* remove COMMON_KBD (or better things in #ifndef COMMON_KBD - formerly used by OS/2 and BeOS)
* remove the third scaling method described in [[Scaling_cleanup]] (formerly used by XAW)
* add proper [[Icons]] to both UIs


==External Libraries==
* '''TODO:''' joystick_ui_get_next_device_name should return the detected joysticks instead of the predefined list (fixed?)
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/)
* '''TODO:''' Make the GTK UI create/use the macOS style "top menubar"
** 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.


besides the above, other libraries are used which are currently linked dynamically and must be supplied as dlls for the windows port
* '''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


* SDL
==== OpenGL ====
* zlib
* '''TODO:''' The OpenGL renderer should transform itself into a Cairo renderer if the system doesn't support OpenGL. (fixed?)
* hardsid
** 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.


==Rewrites==
==== Stretch goals ====


* The "sc" rewrites. Migrate emulators to the cycle based CPU core (6510dtvcore.c, should be renamed), which allows:
* Make 'smart cartridge attach' dialog smarter when attaching .bin images, show only valid cartridge types when selecting a cart image.
** cycle based hooks for complex hardware expansions (SCPU)
** '''TODO''': this needs a new API call that returns the valid sizes for a given type
** in-line graphics data change emulation (see testprogs/VICII/gfxfetch)
* make an option to force display size to 1x/2x/3x/4x
** cycle exact Blitter/DMA vblank start and proper LinearA/B counter handling on x64dtv
* make a GUI based editor for keymaps
** cycle based drawing
* add statusbar indicators for cartridge LEDs.
* ...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.
===SDL UI===


Some of these ideas might never be realized, and might look completely absurd, but they could be the inspiration for other ideas.  
* <b>Write documentation on how to use the UI</b>
* '''BUG:''' FFmpeg media recording behaves unexpected when entering the menu [https://sourceforge.net/p/vice-emu/bugs/898/]
* '''TODO''': get rid of fullscreenarch.h and fullscreen.c - its no more required because SDL can do all of the features fine.


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.
====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


also look at [https://sourceforge.net/tracker/?limit=100&func=&group_id=223021&atid=1057620&assignee=&status=1&category=&artgroup=&keyword=&submitter=&artifact_id=&assignee=&status=1&category=&artgroup=&submitter=&keyword=&artifact_id=&submit=Filter&mass_category=&mass_priority=&mass_assignee=&mass_artgroup=&mass_status=&mass_cannedresponse= Tracker: open Feature Requests]
====Datasette====


===general===
*'''TODO:''' add menu items for "Reset datasette counter" (UI action handlers have been added in the "compyx/sdl-uiactions" branch)


* native screenshot support. (in progress)
====Joysticks====
* script language integration. (lua or python perhaps)
* Some more Kernal patches, for instance for changing colors and patching the reset routine to make it faster (maybe configurable).
* proper support for paddles (https://sourceforge.net/tracker/?func=detail&aid=2686763&group_id=223021&atid=1057620)
* integrate a rs232->telnet codepath (https://sourceforge.net/tracker/?func=detail&aid=3033061&group_id=223021&atid=1057620)
* option to autostart in already running instance ( https://sourceforge.net/tracker/?func=detail&aid=3201905&group_id=223021&atid=1057620 )
* option to save attached (disk/tape/cart) images at shutdown, restore at next run ( https://sourceforge.net/tracker/?func=detail&aid=3302938&group_id=223021&atid=1057620 )
* use second joystick button as auto fire ( https://sourceforge.net/tracker/index.php?func=detail&aid=2459184&group_id=223021&atid=1057620 )


====History Recording====
see [[Joymappings]]
 
* (optionally) make quicksave filenames depend on image filename ( https://sourceforge.net/tracker/?func=detail&aid=3295768&group_id=223021&atid=1057620 )
* find a way to not include the actual game binary in a history file ( https://sourceforge.net/tracker/?func=detail&aid=3295768&group_id=223021&atid=1057620 )
 
====Keyboard====
 
====Tape====
* support for DC2N .dmp files (cassette files) ( https://sourceforge.net/tracker/?func=detail&aid=3203248&group_id=223021&atid=1057620 )


====Monitor====
====Monitor====
* '''TODO:''' implement a scrollback buffer


* (optionally) display all executed commands when in trace mode ( https://sourceforge.net/tracker/?func=detail&aid=3356800&group_id=223021&atid=1057620 )
====File Selector====
* improve handling of memory ranges ( https://sourceforge.net/tracker/?func=detail&aid=3161941&group_id=223021&atid=1057620 )
* '''TODO:''' add filtering in file requester


====Sound System====
====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


* sound sync needs a rewrite, its too complex and fails a lot
==== VSID ====
 
* '''TODO:''' Implement a playlist for VSID
====Video System====
* '''TODO:''' Add HVSC song length database (SLDB) support to VSID (<s>both .txt and</s> .md5 file format)
 
* '''TODO:''' Add HVSC sid tune information list (STIL) support to VSID
* implement a generic framerate converter (screen blending) ( https://sourceforge.net/tracker/?func=detail&aid=2792693&group_id=223021&atid=1057620 )
* '''TODO:''' Add HVSC BUGlist support to VSID
* add option to rotate / flip / mirror the output ( https://sourceforge.net/tracker/?func=detail&aid=3291057&group_id=223021&atid=1057620 )
* add an option in the CRT emulator / Palette generator to simulate b/w,amber,green monitors ( https://sourceforge.net/tracker/index.php?func=detail&aid=3052248&group_id=223021&atid=1057620 )
 
* some kind of generic interface to handle video input is required to handle scanner/digitizer type of carts
 
===Hardware emulation===
 
====SID====
* add support for Catweasel MK4 style playback ( https://sourceforge.net/tracker/?func=detail&aid=2962481&group_id=223021&atid=1057620 )
 
====x64(sc)====
 
* internal (?)
** c64/c128 1.44 MB disk drive support. ([http://www.market.croadria.com/c64/c64diskTR20.shtml])
** c64/c128 SCSI expansion support. ([http://www.zimmers.net/anonftp/pub/cbm/documents/projects/scsi/index.html])
 
* Cartridges
** IDE64 improvements
*** IDE64 eth64 shortbus expansion support. ([http://www.volny.cz/dundera/eth64.html])
*** IDE64 duart shortbus expansion support. ([http://www.volny.cz/dundera/duart.html])
** Clockport improvements
*** Silversurfer (UART) support ([http://rr.c64.org/wiki/Inside_Surfer.txt])
*** IDE64 based eth64-II support ([http://www.ide64.org/eth64v2.html])
** Community Information Locator Commodore 64/128 addon cartridge ([http://starbase.globalpc.net/~jbevren/kiosk/writeup.txt])
** RAM Floppy (REX 9680) support
** Daisy Sound sampler audio input support. ([http://www.cbmhardware.de/dlmanager/download.php?id=243])
** PS64 speech cartridge support. ([http://oms.wmhost.com/ps64/])
** Voice Messenger speech cartridge support. ([http://www.c64-wiki.de/index.php/Voice_Messenger])
** ramlink support. ([http://unusedino.de/ec64/technical/aay/c64/rlmain.htm] [http://members.optusnet.com.au/spacetaxi64/DRIVERS/DRIVER-FILES/ramlink.rar])
** ramdrive support. ([http://mikenaberezny.com/hardware/c64-128/cmd-ppi-ramdrive/])
** turbo master cartridge support (4Mhz 65C02). ([http://headgap.com/Library/64/4%20MHZ%2064.txt] [http://members.optusnet.com.au/vortex69/DRIVERS/CPU-TURBOMASTER.jpg])
** turbo process cartridge support (4Mhz 658156). ([http://retroisle.com/commodore/c64128/Utilities/rmtp.zip6] [http://www.zimmers.net/anonftp/pub/cbm/documents/projects/accelerators/turboprocess/index.html])
** flash-8 cartridge support (8Mhz 65816). ([http://www.spacetaxi.bravehost.com/DRIVERS/FLASH-8.rar])
** SCPU cartridge support (20Mhz 65816). (in progress, has lead to a new emulator called xscpu64) ([http://unusedino.de/ec64/technical/aay/c64/scpumain.htm] [http://members.optusnet.com.au/spacetaxi64/DRIVERS/DRIVER-FILES/SuperCPU.zip]) (https://sourceforge.net/tracker/?func=detail&aid=2030692&group_id=223021&atid=1057620)
** The Final Chesscard (65c02) ([http://www.cbmhardware.de/misc/c64parts.php])
** 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. ([http://www.go4retro.com/projects/converter/])
** BI-80 cartridge support. ([http://mikenaberezny.com/hardware/peripherals/bi-80-display-adapter/])
** Buscard II IEEE488/printer-port cartridge support. ([http://mikenaberezny.com/hardware/peripherals/buscard-ii-ieee-488-interface/])
** "Disk Mate" (Datel)
** MAYA Software Eprom Cart
** PCC-4/PCC-8 Eprom Cart (Jason Ranheim)
** "Alien Flash"
*** VICEminus had this
** [https://csdb.dk/release/index.php?id=150339 Software of Sweden Megacart]
** [https://datadoor.bandcamp.com/album/dubcrt DUBCRT]
** "MegaOne" - Easyflash compatible Flash cartridge, see [http://www.commodore.gen.tr/forum/index.php?topic=11933.210;wap2 here]
 
* Cartridges that wont be emulated:
** ''SoftPROM cartridge ([http://www.c64-wiki.de/index.php/SOFT-PROM])''
*** ''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). [[User:Gpz|Gpz]] 23:01, 30 October 2010 (UTC)''
** ''Net64 cartridge support. ([http://www.harbaum.org/till/c64/index.shtml])''
*** ''this is exactly the same as "the final ethernet" (which is emulated) [[User:Gpz|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. ([http://members.optusnet.com.au/spacetaxi64/DRIVERS/DRIVER-FILES/swift-a.rar])
** CBM1670 (userport) modem1200 support. ([http://members.optusnet.com.au/spacetaxi64/DRIVERS/DRIVER-FILES/swift-a.rar])
** FB-RS232 (userport) support. ([http://members.optusnet.com.au/spacetaxi64/DRIVERS/DRIVER-FILES/swift-a.rar])
** c64 p64 midi interface: ([http://www.firestarter-music.de/prophetcart/p64_fullmidi_V1_1.jpg])
** Scanntronik handyscanner (userport) support. ([http://members.optusnet.com.au/spacetaxi64/DRIVERS/DRIVER-FILES/scanner.rar])
** Video Byte II video digitizer (userport) support. ([http://members.optusnet.com.au/spacetaxi64/DRIVERS/DRIVER-FILES/video-digitize.rar]) ([http://moogle-tech.com/blog/?p=104])
** Computera Eyes video digitizer (userport) support. ([http://www.spacetaxi.bravehost.com/DRIVERS/Computer%20eyes.zip] [http://members.optusnet.com.au/spacetaxi64/DRIVERS/DRIVER-FILES/COMPUTER-EYES-64.zip])
** Userport RocketDrive support. ([http://www.cbmhardware.de/avr/homepage.html])
** CIA-IDE-HD support. ([http://members.optusnet.com.au/vortex69/PC-HARDWARE/CIA-IDE-HD/CIA-IDE-HD.html])
** Aprotek universal rs232 adapter support. ([http://mikenaberezny.com/hardware/peripherals/aprotek-universal-rs-232/])
** Comet64 support. ([http://www.commodoreserver.com/ProductView.asp?PID=365065CF529B4C408F7D01C08BA34803])
** L. Pantarottos adapter support. ([http://www.synnes.org/c64/c64_joy_adapter_schematics.html])
 
* Joystick Port
** c64/c128 pc-joystick support. ([http://members.elysium.pl/ytm/html/projects.html])
** datel 3-button mouse support. ([http://members.optusnet.com.au/spacetaxi64/DRIVERS/DRIVER-FILES/1351a.rar])
** animation station support. ([http://members.optusnet.com.au/spacetaxi64/DRIVERS/DRIVER-FILES/koala-pad&Animation%20station.rar])
** Power-pad support.
** super sketch support. ([http://members.optusnet.com.au/spacetaxi64/DRIVERS/DRIVER-FILES/super-sketch.rar])
** add support for switching the emulated 1351 mouse to joystick mode by doing a hard reset while pressing the right mouse button ( https://sourceforge.net/tracker/?func=detail&aid=2631893&group_id=223021&atid=1057620 )
** add support for 8player joystick adapter "inception" ([http://www.c64.cz/inception/])
 
* Tape Port
 
* Video output.
** c64 LCD64 screen support. ([http://www.64hdd.com/projects/c64-proj3.html])
 
====x128====
 
* c128 plus60k support.
* c128 plus256k support.
* c128 256K memory expansion hack support.
 
====xvic====
* VIC20 RTC cartridge support. ([http://jledger.proboards.com/index.cgi?board=microhacking&action=display&thread=2381])
* ''vic20 iec2ata support. ([http://www.djupdal.org/cbm/iecata/])''
** ''pointless to emulate, as it is a simple iec device, very similar to what you get when using virtual drive on the filesystem.'' [[User:Gpz|Gpz]] 05:08, 15 August 2010 (UTC)
* vic20 ethernet support. ([http://members.lycos.co.uk/leeedavison/6502/vic20/network/index.html])
* support for modified vic20 ( https://sourceforge.net/tracker/?func=detail&aid=3315683&group_id=223021&atid=1057620 )
* .crt like cartridge format (.vrt), perhaps take it from vice-minus ( http://viceminus.git.sourceforge.net/git/gitweb.cgi?p=viceminus/viceminus;a=commit;h=29c32f2ea2d299cb40228030c355625e800a00ca )
* add Cartridge attach heuristic for image pairs
 
====xplus4====
* add support for "speedy" freezer cartridge
 
====xpet====
* PET ROM-socket RTC support. ([http://jledger.proboards.com/index.cgi?board=microhacking&action=display&thread=2381])
* 8296 pet hardware ram lines connected to userport support.
* 8296 RAMdisk 2008 support. ([http://www.cbmhardware.de/cbmrd2008/index.php])
* 8296 pet switchable 4 screens output support.
* pet IEEE488 -> IDE/RS232 support. ([http://petcbmide.blogspot.com/])
* High-Res
** High-Res Technologies Graphics Board support. ([http://mikenaberezny.com/hardware/projects/high-res-technologies-graphics-board/], [http://www.6502.org/users/sjgray/computer/hsg/index.html])
** Data Becker CBM-8000 hi-res graphics support. ([http://lc64.blogspot.de/2017/09/first-test-with-data-becker-hi-res.html])
** SuperSoft High Resolution Graphics Board support. ([https://github.com/sjgray/SuperSoft-HR])
** Eltec petGRAFIK support. ([http://www.cbmhardware.de/dlmanager/index.php?id=322])
** Delph Electronics 8000C support. ([https://github.com/sjgray/Delph8000C])
* MTU K-1002-2 DAC sound system support. ([http://mikenaberezny.com/hardware/peripherals/mtu-k-1002-2-dac/])
 
====xcbm2====
* cbm2 z80, better nec v20, support.
* cbm2 8088 support. ([https://github.com/MichalPleban/cbm2-8088-card])
* B700 HiRes Graphics Board support. ([https://github.com/sjgray/B700-Hires-Card])
 
====Drives====
 
* (optionally) automatically enable warp mode when drives are being accessed. ( https://sourceforge.net/tracker/?func=detail&aid=2028999&group_id=223021&atid=1057620 )
* add support for dual disk drives
* IEC
** CMD harddrive support. ([http://members.optusnet.com.au/spacetaxi64/DRIVERS/DRIVER-FILES/cmd-hard.rar])  (https://sourceforge.net/tracker/?func=detail&aid=2786810&group_id=223021&atid=1057620)
** IEC2IEEE/RS232C adapter support. ([http://mikenaberezny.com/hardware/projects/interpod-ieee-488-interface/])
** ''sd2iec / uIEC support ( https://sourceforge.net/tracker/?func=detail&aid=3287595&group_id=223021&atid=1057620 )''
**: ''somewhat pointless, since this would be very much what you get from using the virtual filesystem drive'' [[User:Gpz|Gpz]] 07:02, 11 July 2011 (UTC)
* IEEE
** D9060/D9090 CBM harddrive support. ([http://members.optusnet.com.au/spacetaxi64/DRIVERS/DRIVER-FILES/D9090-D9060.rar])
** MiniChief type harddrives support. ([http://www.zimmers.net/anonftp/pub/cbm/manuals/drives/MiniChief.zip])
** MW1000 HD support. ([http://members.optusnet.com.au/vortex69/HD-HISTORY/SSEL.doc])
** Alpha20 HD support. ([http://members.optusnet.com.au/vortex69/HD-HISTORY/Apstor-20-SBS.doc])
** Alpha10 HD support. ([http://members.optusnet.com.au/vortex69/HD-HISTORY/Alpha-10.doc])
** Borsu20 HD support. ([http://members.optusnet.com.au/vortex69/HD-HISTORY/BORSU-20mb.doc])
** HardBox HD support. ([http://members.optusnet.com.au/vortex69/HD-HISTORY/Hardbox.doc])
** Mator Shark HD support. ([http://mikenaberezny.com/hardware/peripherals/mator-shark-hard-drive/])
 
====Printers====
* (optionally) make printer output pixel perfect ( https://sourceforge.net/tracker/?func=detail&aid=2476279&group_id=223021&atid=1057620 )
* IEC
** DPS1101 support.
** MPS801 support.
** MPS802/CBM1526 support.
** MPS1000 support.
** MPS1250 support.
** Fidelity Impact Printer support. ([http://mikenaberezny.com/hardware/peripherals/fidelity-impact-printer/])
* IEEE
** MPS1361 support.
** CBM4022 support.
** CBM8023 support.
** CBM8024 support.


====Misc====


* add/implement C65 emulator ( https://sourceforge.net/tracker/?func=detail&aid=2472096&group_id=223021&atid=1057620 )
[[Category:TODO]]

Latest revision as of 16:58, 6 May 2024

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.8. 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.

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

  • 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

WIP Joymappings

  • contact-bounce is not emulated
TODO: make a proper test program
https://csdb.dk/release/index.php?id=242527

Monitor

  • TODO: Breakpoints/watchpoints should consider banks, and perhaps PLA/MMU config
  • banking should somehow work also with cartridges. for this some generic interface in the cartridge system needs to be created
Profiler

The new profiler feature is still incomplete ( https://sourceforge.net/p/vice-emu/patches/350/ )

  • support for banking (main CPU) is only implemented in x64(sc) right now
    • banking should somehow consider cartridge banks, once we have generic support for it in the monitor
  • perhaps additional stats for "stolen cycles" (cycles used by the VICII) can be added
  • branch taken / not taken statistics
  • support for drive CPUs is missing
  • support for other CPUs than 6502 is missing
  • binary remote monitor commands need to be implemented (perhaps once more of the above works, so we know how these must look like)
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
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 (MOS5710) emulation is incomplete
    • extra FDC2 registers are not implemented
  • 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

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

Cores

Core used in
VIA VIC20, PET, various drives
CIA C64, C128, 1570/71
SID C64, C128, CBM2, (VIC20, PLUS4, PET: SID cart)
TED Plus4 snapshots are broken
VDC C128 snapshots are broken
VIC VIC-20
VIC-II C64, CBM2
VIC-IIe C128
t6721a Magic Voice, Plus4 (V364) snapshot support is missing
mc6821 Formel64, Magic Formel, Dolphin-DOS 3
CS8900a RR-Net/TFE snapshot support is missing
RIOT 2040/3040/4040/1001/8050/8250
PC8477/DP8473 FD4000/FD2000
WD1770 1570/1571/1581
ACIA (6551) Swiftlink
spi-sdcard MMC64, MMC Replay snapshot support is missing
ser-eeprom MMC Replay snapshot support is missing
midi C64, VIC-20 snapshot support is missing

VIA

  • MYVIA_NEED_LATCHING option is possibly broken, but in any case untested
  • 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

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) (fixed)

SID

  • POTX/POTY sampling jitter is not emulated
  • only one mouse or pair of paddles can be emulated at a time

TED

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
  • 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

VIC

VIC-II

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.

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)

mc6821

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

RIOT

  • I/O "peek" function is broken

Machines

x64sc

Note: x64 is deprecated.

general
  • some C64 models are not emulated 100% correctly (for details see C64models)
    • the memory layout for "Max Machine" is not yet correct
    • The Japanese C64 has "C= lock" instead of "Shift Lock" (the keyboard is physically different)
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

x128

xmx provided a test program, see testprogs/c128/z80/cycletimer
  • CPU history (chist) implementation is incomplete
  • should get rewritten to use the new 6510 "sc" core

xvic


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

xcbm2

note: run like this: xcbm2 -model 610 -ntsc -drive8type 8050 -virtualdev +truedrive -8 cbm2-burnin.d80
  • CPU history (chist) implementation is incomplete
  • should get rewritten to use the new 6502 "sc" core
Cartridge System
  • not implemented yet (fixed)

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.
  • 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. See here for details.
  • CPU history (chist) implementation is incomplete
  • should get rewritten to use the new 6502 "sc" core
Cartridge System
  • not implemented yet (fixed)

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.
  • 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
  • should get rewritten to use the new 6502 "sc" core

SC Rewrites

As a long term goal, everything should be rewritten to use the new "sc" cpu cores (and the non sc cores removed):

  • 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)

Tools

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.

Ports

Some of the mess isn't ours! See here for Upstream bugs.

archdep

Windows

  • TODO: the native (console based) monitor does not work in windows

GTK3 UI

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?)

The list of covered resources is here

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.
Only arrow icons for North, West, South and East are available. Gtk3 used to have a GtkArrow class, but that has been deprecated since 3.14 and removed from 4.x. So we'll have to write our own (which should also prove useful for joystick mapping widgets).

Settings

  • TODO: HardSID settings are missing
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
  • TODO: ROM-set manager/settings need to be reworked and fixed. ROMset "archives" should be removed completely. see #ROMsets
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
Joysticks

see Joymappings

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.
  • 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?
  • 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?
  • Update mixer sliders to use proper units etc like the mixer sliders in the other emus

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 (implemented in trunk)

for some info on the monitor ui see: MonitorUI.

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.

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.

SDL UI

  • Write documentation on how to use the UI
  • BUG: FFmpeg media recording behaves unexpected when entering the menu [3]
  • TODO: get rid of fullscreenarch.h and fullscreen.c - its no more required because SDL can do all of the features fine.

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

Datasette

  • TODO: add menu items for "Reset datasette counter" (UI action handlers have been added in the "compyx/sdl-uiactions" branch)

Joysticks

see Joymappings

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