mirror of
https://github.com/holub/mame
synced 2025-05-30 17:41:47 +03:00
100564d412
performance as a result of this change. Do not panic; report issues to the list in the short term and I will look into them. There are probably also some details I forgot to mention. Please ask questions if anything is not clear. NOTE: This is a major internal change to the way devices are handled in MAME. There is a small impact on drivers, but the bulk of the changes are to the devices themselves. Full documentation on the new device handling is in progress at http://mamedev.org/devwiki/index.php/MAME_Device_Basics Defined two new casting helpers: [Aaron Giles] downcast<type>(value) should be used for safe and efficient downcasting from a base class to a derived class. It wraps static_cast<> by adding an assert that a matching dynamic_cast<> returns the same result in debug builds. crosscast<type>(value) should be used for safe casting from one type to another in multiple inheritance scenarios. It compiles to a dynamic_cast<> plus an assert on the result. Since it does not optimize down to static_cast<>, you should prefer downcast<> over crosscast<> when you can. Redefined running_device to be a proper C++ class (now called device_t). Same for device_config (still called device_config). All devices and device_configs must now be derived from these base classes. This means each device type now has a pair of its own unique classes that describe the device. Drivers are encouraged to use the specific device types instead of the generic running_device or device_t classes. Drivers that have a state class defined in their header file are encouraged to use initializers off the constructor to locate devices. [Aaron Giles] Removed the following fields from the device and device configuration classes as they never were necessary or provided any use: device class, device family, source file, version, credits. [Aaron Giles] Added templatized variant of machine->device() which performs a downcast as part of the device fetch. Thus machine->device<timer_device>("timer") will locate a device named "timer", downcast it to a timer_device, and assert if the downcast fails. [Aaron Giles] Removed most publically accessible members of running_device/device_t in favor of inline accessor functions. The only remaining public member is machine. Thus all references to device->type are now device->type(), etc. [Aaron Giles] Created a number of device interface classes which are designed to be mix- ins for the device classes, providing specific extended functionality and information. There are standard interface classes for sound, execution, state, nvram, memory, and disassembly. Devices can opt into 0 or more of these classes. [Aaron Giles] Converted the classic CPU device to a standard device that uses the execution, state, memory, and disassembly interfaces. Used this new class (cpu_device) to implement the existing CPU device interface. In the future it will be possible to convert each CPU core to its own device type, but for now they are still all CPU devices with a cpu_type() that specifies exactly which kind of CPU. [Aaron Giles] Created a new header devlegcy.h which wraps the old device interface using some special template classes. To use these with an existing device, simply remove from the device header the DEVICE_GET_INFO() declaration and the #define mapping the ALL_CAPS name to the DEVICE_GET_INFO. In their place #include "devlegcy.h" and use the DECLARE_LEGACY_DEVICE() macro. In addition, there is a DECLARE_LEGACY_SOUND_DEVICE() macro for wrapping existing sound devices into new-style devices, and a DECLARE_LEGACY_NVRAM_DEVICE() for wrapping NVRAM devices. Also moved the token and inline_config members to the legacy device class, as these are not used in modern devices. [Aaron Giles] Converted the standard base devices (VIDEO_SCREEN, SPEAKER, and TIMER) from legacy devices to the new C++ style. Also renamed VIDEO_SCREEN to simply SCREEN. The various global functions that were previously used to access information or modify the state of these devices are now replaced by methods on the device classes. Specifically: video_screen_configure() == screen->configure() video_screen_set_visarea() == screen->set_visible_area() video_screen_update_partial() == screen->update_partial() video_screen_update_now() == screen->update_now() video_screen_get_vpos() == screen->vpos() video_screen_get_hpos() == screen->hpos() video_screen_get_vblank() == screen->vblank() video_screen_get_hblank() == screen->hblank() video_screen_get_width() == screen->width() video_screen_get_height() == screen->height() video_screen_get_visible_area() == screen->visible_area() video_screen_get_time_until_pos() == screen->time_until_pos() video_screen_get_time_until_vblank_start() == screen->time_until_vblank_start() video_screen_get_time_until_vblank_end() == screen->time_until_vblank_end() video_screen_get_time_until_update() == screen->time_until_update() video_screen_get_scan_period() == screen->scan_period() video_screen_get_frame_period() == screen->frame_period() video_screen_get_frame_number() == screen->frame_number() timer_device_adjust_oneshot() == timer->adjust() timer_device_adjust_periodic() == timer->adjust() timer_device_reset() == timer->reset() timer_device_enable() == timer->enable() timer_device_enabled() == timer->enabled() timer_device_get_param() == timer->param() timer_device_set_param() == timer->set_param() timer_device_get_ptr() == timer->get_ptr() timer_device_set_ptr() == timer->set_ptr() timer_device_timeelapsed() == timer->time_elapsed() timer_device_timeleft() == timer->time_left() timer_device_starttime() == timer->start_time() timer_device_firetime() == timer->fire_time() Updated all drivers that use the above functions to fetch the specific device type (timer_device or screen_device) and call the appropriate method. [Aaron Giles] Changed machine->primary_screen and the 'screen' parameter to VIDEO_UPDATE to specifically pass in a screen_device object. [Aaron Giles] Defined a new custom interface for the Z80 daisy chain. This interface behaves like the standard interfaces, and can be added to any device that implements the Z80 daisy chain behavior. Converted all existing Z80 daisy chain devices to new-style devices that inherit this interface. [Aaron Giles] Changed the way CPU state tables are built up. Previously, these were data structures defined by a CPU core which described all the registers and how to output them. This functionality is now part of the state interface and is implemented via the device_state_entry class. Updated all CPU cores which were using the old data structure to use the new form. The syntax is currently awkward, but will be cleaner for CPUs that are native new devices. [Aaron Giles] Converted the okim6295 and eeprom devices to the new model. These were necessary because they both require multiple interfaces to operate and it didn't make sense to create legacy device templates for these single cases. (okim6295 needs the sound interface and the memory interface, while eeprom requires both the nvram and memory interfaces). [Aaron Giles] Changed parameters in a few callback functions from pointers to references in situations where they are guaranteed to never be NULL. [Aaron Giles] Removed MDRV_CPU_FLAGS() which was only used for disabling a CPU. Changed it to MDRV_DEVICE_DISABLE() instead. Updated drivers. [Aaron Giles] Reorganized the token parsing for machine configurations. The core parsing code knows how to create/replace/remove devices, but all device token parsing is now handled in the device_config class, which in turn will make use of any interface classes or device-specific token handling for custom token processing. [Aaron Giles] Moved many validity checks out of validity.c and into the device interface classes. For example, address space validation is now part of the memory interface class. [Aaron Giles] Consolidated address space parameters (bus width, endianness, etc.) into a single address_space_config class. Updated all code that queried for address space parameters to use the new mechanism. [Aaron Giles]
183 lines
6.8 KiB
C++
183 lines
6.8 KiB
C++
/***************************************************************************
|
|
|
|
osdepend.h
|
|
|
|
OS-dependent code interface.
|
|
|
|
****************************************************************************
|
|
|
|
Copyright Aaron Giles
|
|
All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are
|
|
met:
|
|
|
|
* Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
* Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in
|
|
the documentation and/or other materials provided with the
|
|
distribution.
|
|
* Neither the name 'MAME' nor the names of its contributors may be
|
|
used to endorse or promote products derived from this software
|
|
without specific prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY AARON GILES ''AS IS'' AND ANY EXPRESS OR
|
|
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL AARON GILES BE LIABLE FOR ANY DIRECT,
|
|
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
|
|
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
****************************************************************************
|
|
|
|
The prototypes in this file describe the interfaces that the MAME core
|
|
relies upon to interact with the outside world. They are broken out into
|
|
several categories.
|
|
|
|
The general flow for an OSD port of MAME is as follows:
|
|
|
|
- parse the command line or display the frontend
|
|
- call run_game (mame.c) with the index in the driver list of
|
|
the game selected
|
|
- osd_init() is called shortly afterwards; at this time, you are
|
|
expected to set up the display system and create render_targets
|
|
- the input system will call osd_get_code_list()
|
|
- the input port system will call osd_customize_inputport_list()
|
|
- the sound system will call osd_start_audio_stream()
|
|
- while the game runs, osd_update() will be called periodically
|
|
- when the game exits, we return from run_game()
|
|
- the OSD layer is now in control again
|
|
|
|
This process is expected to be in flux over the next several versions
|
|
(this was written during 0.109u2 development) as some of the OSD
|
|
responsibilities are pushed into the core.
|
|
|
|
*******************************************************************c********/
|
|
|
|
#pragma once
|
|
|
|
#ifndef __OSDEPEND_H__
|
|
#define __OSDEPEND_H__
|
|
|
|
#include "emucore.h"
|
|
#include "osdcore.h"
|
|
|
|
|
|
class input_type_desc;
|
|
class device_t;
|
|
|
|
|
|
/*-----------------------------------------------------------------------------
|
|
osd_init: initialize the OSD system.
|
|
|
|
Parameters:
|
|
|
|
machine - pointer to a structure that contains parameters for the
|
|
current "machine"
|
|
|
|
Return value:
|
|
|
|
None
|
|
|
|
Notes:
|
|
|
|
This function is responsible for initializing the OSD-specific
|
|
video and input functionality, and registering that functionality
|
|
with the MAME core.
|
|
|
|
In terms of video, this function is expected to create one or more
|
|
render_targets that will be used by the MAME core to provide graphics
|
|
data to the system. Although it is possible to do this later, the
|
|
assumption in the MAME core is that the user interface will be
|
|
visible starting at osd_init() time, so you will have some work to
|
|
do to avoid these assumptions.
|
|
|
|
In terms of input, this function is expected to enumerate all input
|
|
devices available and describe them to the MAME core by adding
|
|
input devices and their attached items (buttons/axes) via the input
|
|
system.
|
|
|
|
Beyond these core responsibilities, osd_init() should also initialize
|
|
any other OSD systems that require information about the current
|
|
running_machine.
|
|
|
|
This callback is also the last opportunity to adjust the options
|
|
before they are consumed by the rest of the core.
|
|
|
|
Note that there is no corresponding osd_exit(). Rather, like most
|
|
systems in MAME, you can register an exit callback via the
|
|
add_exit_callback() function in mame.c.
|
|
|
|
Also note that there is no return value. If you need to report a
|
|
fatal error, use the fatalerror() function with a friendly message
|
|
to the user.
|
|
|
|
Future work/changes:
|
|
|
|
Audio initialization may eventually move into here as well,
|
|
instead of relying on independent callbacks from each system.
|
|
-----------------------------------------------------------------------------*/
|
|
void osd_init(running_machine *machine);
|
|
|
|
void osd_wait_for_debugger(device_t *device, int firststop);
|
|
|
|
|
|
|
|
/******************************************************************************
|
|
|
|
Display
|
|
|
|
******************************************************************************/
|
|
|
|
void osd_update(running_machine *machine, int skip_redraw);
|
|
|
|
|
|
|
|
|
|
/******************************************************************************
|
|
|
|
Sound
|
|
|
|
******************************************************************************/
|
|
|
|
void osd_update_audio_stream(running_machine *machine, INT16 *buffer, int samples_this_frame);
|
|
|
|
/*
|
|
control master volume. attenuation is the attenuation in dB (a negative
|
|
number). To convert from dB to a linear volume scale do the following:
|
|
volume = MAX_VOLUME;
|
|
while (attenuation++ < 0)
|
|
volume /= 1.122018454; // = (10 ^ (1/20)) = 1dB
|
|
*/
|
|
void osd_set_mastervolume(int attenuation);
|
|
|
|
|
|
|
|
/******************************************************************************
|
|
|
|
Controls
|
|
|
|
******************************************************************************/
|
|
|
|
/*
|
|
inptport.c defines some general purpose defaults for key and joystick bindings.
|
|
They may be further adjusted by the OS dependent code to better match the
|
|
available keyboard, e.g. one could map pause to the Pause key instead of P, or
|
|
snapshot to PrtScr instead of F12. Of course the user can further change the
|
|
settings to anything he/she likes.
|
|
This function is called on startup, before reading the configuration from disk.
|
|
Scan the list, and change the keys/joysticks you want.
|
|
*/
|
|
void osd_customize_input_type_list(input_type_desc *typelist);
|
|
|
|
|
|
|
|
#endif /* __OSDEPEND_H__ */
|