Developer log

From vice-emu
Revision as of 22:52, 26 July 2010 by Gpz (talk | contribs) (→‎trunk)
Jump to navigation Jump to search

The developer log is intended to be a central place for all developers to take down notes on what has changed during development. This helps to keep all porters up to date regarding API and Resource changes.

Branches

Here is a short overview of all branches that are currently active in SVN, i.e. someone develops a new feature that soon will be merged into trunk. Note here the upcoming features, if some testing is required on specific platforms or there is something porters need to be aware of.

x64sc

x64sc, the next step in C64 emulation. (merged before 2.2.2)

Disable on low-end ports

  • x64sc needs a lot of host CPU and reSID-fp
  • TODO: Disable building x64sc for: riscos (any others?)

UI rework

  • UI for x64sc using c64scui_init/shutdown, differences listed below
  • See SDL UI and/or *nix UIs for an example and suggested menu item naming
  • TODO: New UI for: amiga, beos, msdos, os/2
  • C64
    • Overall model selection, see c64/c64model.h
    • NOTE: The C64 model selection affects (and is affected by) all the resources listed below plus the SID model (and engine, if not reSID-fp already)
    • TODO: UI items for: amiga, beos, msdos, os/2
  • CIA
    • Resource: CIA1Model (toggle or enum with 0 & 1)
    • Resource: CIA2Model (toggle or enum with 0 & 1)
    • NOTE: could be used also in x64 and x128, probably not worth the hassle
    • TODO: UI items for: amiga, beos, msdos, os/2
  • VICII
    • Resource: VICIIModel (enum, see vicii.h)
    • TODO: UI items for: amiga, beos, msdos, os/2
  • System
    • Resource: GlueLogic (toggle or enum with 0 & 1, possibly more if variations found)
    • TODO: UI items for: amiga, beos, msdos, os/2
  • PAL/NTSC
    • Remove/disable the PAL/NTSC/oldNTSC items from the VICII menu (handled via VICIIModel or overall model instead)
    • TODO: Remove/disable UI items for: amiga, beos, msdos, os/2

Config split

  • Datadir uses machine_name as before, config/hotkeys/fliplist/etc (should) use machine_get_name() instead
  • Use "C64SC" for x64sc
    • NOTE: data/C64 is still used for x64sc
    • TODO: check config/etc file names/usage for: win32
  • Use "VSID" for vsid
    • Due to the config split, it is finally possible to have VSID config/hotkeys/etc
    • TODO: add load/save settings UI items for: amiga, beos, msdos, os/2, osx, win32
  • Use "CBM-II-5x0" for xcbm2 -model 510
    • Should get rid of segfaults when using different models with same config
    • TODO: check config/etc file names/usage for: win32

trunk

  • chris/v2.1-quicktime [2.1.2]
    • NEW: added QuickTime movie exporter (on Mac OS X for now)
    • API: introduced new soundmovie.c sound exporter
    • API: gfxoutput.h: extended interace of gfxoutputdrv_t
gfxoutputdrv_format_t *formatlist; // optional format list for exporter
void (*shutdown)(void);
int (*resources_init)(void);
int (*cmdline_options_init)(void);
    • Tested: Mac+Cocoa, Mac+Gtk, Mac+Xaw
    • Open: Adapted all UIs to use generic formatlist from extended gfxoutput_drv interface
  • soundrework.
    • oversampling setting removed. Oversampling is a bad, mostly unused solution for slightly improved audio quality. We can just do proper resamplers for machines that need it.
    • shorter sound buffer requires using audio buffers to their capacity. Some drivers may exhibit bugs with bufferspace() hook when audio buffer gets completely filled. These should be identified by bad behaviour on low latency setting such as 50 ms, while other sound drivers on same system might still work.
  • Userport Joystick Interface support (r20807)
    • NEW: 2 new virtual joysticks
    • API: joystick_port_map[] (arch/*/joy.[ch]) size changed from 2 to 4 (JOYSTICK_NUM, joystick.h)
    • Resource: ExtraJoy (toggle) and ExtraJoyType see src/joystick.h for the types.
    • TODO: UI items for the following ports: os2
    • TODO: Make the joystick UI correct, to clarify: c128, c64, c64dtv, cbm5x0 and plus4 have 2 native joystick port, vic20 has only 1 native joystick port and pet and cbm6x0/7x0 have no native joystick ports at all. The HIT userport joystick adapter can only be used on c64/c128, the other userport joystick adapters can be used on c64, c128, c64dtv, cbm6x0/7x0, pet and vic20.
    • TODO: Joystick mapping/handling fixes (if needed) for the following ports: gp2x.
    • NOTE: Snapshots don't load/save the two new values to maintain compatibility. Network code uses the new size; this may be a problem.
  • Plus4 SID cart add-ons support (20977)
    • Resource: DIGIBLASTER (toggle) for the digibooster add-on and SIDCartJoy (toggle) for the joystick port on the sidcart.
    • TODO: xplus4 UI items for the following ports: os/2
  • Lightpen/gun support (21132)
    • NEW: Lightpen/gun emulation in x64, x128 and xvic
    • Resource: Lightpen (toggle)
    • Resource: LightpenType (enum, see lightpen.h)
      • 0=Pen with button Up (TODO: product name?)
      • 1=Pen with button Left (TODO: product name?)
      • 2=Datel Pen
      • 3=Magnum Light Phaser
      • 4=Stack Light Rifle
    • TODO: Lightpen driver and UI items for the following ports: amiga, beos, os/2
    • NOTE: see SDL or win32 for driver implementation example
    • TODO: Fix clock calculation in VDC
    • TODO: other x's?
  • xvic cartridge system rewrite (21222)
    • NEW: Rewritten modular cartridge emulation similar to that of x64.
    • NEW: Mega-Cart emulation
    • Resource: CartridgeType (enum, see cartridge.h)
    • Resource: CartridgeFile (string)
    • Resource: CartridgeReset (toggle)
    • Resource: GenericCartridgeFile2000 (string)
    • Resource: GenericCartridgeFile4000 (string)
    • Resource: GenericCartridgeFile6000 (string)
    • Resource: GenericCartridgeFileA000 (string)
    • Resource: GenericCartridgeFileB000 (string)
    • NOTE: see win32/SDL/*nix UI for menu implementation.
    • NOTE: CartridgeFile and GenericCartridgeFileX000 and NOT meant to be manipulated directly by the UI. See the above note.
    • TODO: .crt like cartridge format (.vrt)
    • TODO: UI items for the following ports: os/2
  • xvic cartridge system improvements (r21505)
    • NEW: write back FE3 .bin and MC NvRAM images
    • Resource: FinalExpansionWriteBack (toggle)
    • Resource: MegaCartNvRAMWriteBack (toggle)
    • Resource: MegaCartNvRAMfilename (string)
    • TODO: UI items for the following ports: os/2
  • PET DWW (r?????)
    • NEW: DWW support for xpet
    • Resource: PETDWW (toggle)
    • Resource: PETDWWfilename (string)
    • TODO: UI items for the following ports: amiga, beos, dos, os/2, win32
  • x64/x64sc/x128 Cartridge System (r22615)
    • changed cartridge_detach_image() to take the cartid (from cartridge.h) as parameter. all UIs have been changed to pass -1, which means "all cartridges".
    • NOTE: UIs that actually support to attach several carts should use the param properly, and should use this function instead of changing whatever associated resource directly. (this will make it easier to change the underlying mechanism without breaking everything all the time)
  • x64/x64sc/x128 Cartridge System (r22623)
    • changed cartridge_get_file_name(), takes the cartid instead of the (meaningless) address for c64 now
      • affected emus: vic20 (the "WORD" in the prototype changed to "int", and it passes an address for type, and the "int" may now make it fail on 16bit hosts, meh :)) the logic should be changed to use cartids from cartridge.h instead, shouldnt matter else :)
      • affected ports: MSDOS
    • a new function c64export_query_list() defined in c64export.h can be used to get a list of all currently attached/active cartridges, so you can eg use it in a dynamic menu and detach them using cartridge_detach_image(). look in c64export.c:c64export_dump() for a small usage example.
    • TODO: fix MSDOS port, fix VIC20
  • MMC Replay (r?????)
    • NEW: MMC Replay support
    • .bin image attach for CARTRIDGE_MMC_REPLAY
    • Resource: MMCRCardImage (string)
    • Resource: MMCREEPROMImage (string)
    • Resource: MMCRCardRW (toggle)
    • Resource: MMCREEPROMRW (toggle)
    • Resource: MMCRRescueMode (toggle)
    • Resource: MMCRSDType (enum: 0=Auto, 1=MMC, 2=SD, 3=SDHC)
    • TODO: UI items for the following ports: amiga, beos, dos, os/2, win32
  • MMC64 card type
    • NEW: Cart type selection for MMC64
    • Resource: MMC64_sd_type (enum: 0=Auto, 1=MMC, 2=SD, 3=SDHC)
    • TODO: UI items for the following ports: amiga, beos, dos, os/2, win32
  • Magic Voice
    • NEW: (unfortunately not working yet) Magic Voice support
    • Resource: MagicVoiceImage (string)
    • Resource: MagicVoiceCartridgeEnabled (toggle)
    • TODO: UI items for the following ports: amiga, beos, dos, os/2, win32
  • ISEPIC
    • renamed Resource: "Isepic" to "IsepicCartridgeEnabled" (toggle)
  • Expert Cartridge
    • renamed Resource: "Expert" to "ExpertCartridgeEnabled" (toggle)
    • TODO: ports that use cartridge_attach_image(CARTRIDGE_EXPERT, NULL) (which will now fail!) must now simply set "ExpertCartridgeEnabled" to 1 to enable (as with other carts). possibly affected ports: amiga, beos, dos, os/2, win32, osx (x64, x64sc, x128)
    • renamed Resource: "CartridgeMode" to "ExpertCartridgeMode" (enum: 0=off 1=prg 2=on)
  • V364 Speech (Plus4)
    • NEW: v364 prototype speech chip support
    • Resource: SpeechImage (string)
    • Resource: SpeechEnabled (toggle)
    • TODO: UI items for the following ports: amiga, beos, dos, os/2, win32
  • BASIC load (r22628)
    • NEW: option for doing autostart LOAD without the ,1
    • Resource: AutostartBasicLoad (toggle)
    • NOTE: Doesn't work with AutostartPrgMode Inject, fixing is likely too much hassle (relinking...)
    • TODO: UI items for the following ports: amiga, beos, dos, os/2, *nix, win32
  • Vic Flash Plugin writeback (r22566)
    • NEW: writeback support for Vic Flash Plugin
    • Resource: VicFlashPluginWriteBack (toggle)
    • TODO: UI items for the following ports: amiga, beos, dos, os/2, win32
  • "PAL Emulation" is available in NTSC mode (r22746)
    • NEW: proper rendering with CRT emulation in NTSC mode
    • it is suggested to rename user visible strings that refer to "PAL Emulation" or "PAL Settings" to "CRT ..." to make clear that it is not only available in PAL mode.
    • ports that forced "PAL Emulation" disabled in NTSC mode should be changed so "PAL Emulation" can be enabled, and related options are available regardless of current video mode.
  • Gamma Calculation changed (r22749)
    • Resource: "ColorGamma" range was changed to 0...4000, and the new default is 2200 (which is the VGA 2.2 gamma). this change was needed to be able to handle different gammas of PAL/NTSC/etc. (and using the actual display hardware gamma as param is more intuitive too).
    • TODO: fix UI items of the following ports: amiga, beos, dos, os/2, osx, win32
    • possibly some #ifdef magic can be added in src/video/video-resources-pal.c to define correct defaults for platforms that don't use 2.2
  • "true aspect ratio" option (r22749)
    • geometry_s now contains (float)pixel_aspect_ratio which can be used to (optionally) scale the output canvas to get the true aspect ratio of the currently active video mode.
      • scale output rectangle horizontally by pixel_aspect_ratio if "true aspect ratio" option is enabled
      • to maintain consistancy across ports, use Resource:"TrueAspectRatio" (toggle). (must be defined in arch dependend files)
    • TODO: implement in ports that can make use of this: XAW, osx, win32 (other with hw scaling?)
  • "PAL Emulation" "CRT Emulation" is available for CRTC and VDC (r22752)
    • NEW: proper rendering with CRT emulation for CRTC and VDC output
    • Resource: CrtcExternalPalette (toggle)
    • Resource: VDCExternalPalette (toggle)
    • all ports that forced "PAL Emulation" disabled should be changed so "CRT Emulation" can be enabled, and related options are available regardless of current video chip. all related special cases can be removed.
    • TODO: fix UI items of the following ports: amiga, beos, dos, os/2, osx, win32, sdl (x128, xpet, xcbm2)

List of ports: amiga, beos, dos, os/2, osx, *nix, win32, sdl

List of ports outside UI updates: gp2x, riscos

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