diff options
Diffstat (limited to 'trunk/src/emu/screen.h')
-rw-r--r-- | trunk/src/emu/screen.h | 445 |
1 files changed, 445 insertions, 0 deletions
diff --git a/trunk/src/emu/screen.h b/trunk/src/emu/screen.h new file mode 100644 index 00000000000..c89f227c1b7 --- /dev/null +++ b/trunk/src/emu/screen.h @@ -0,0 +1,445 @@ +/*************************************************************************** + + screen.h + + Core MAME screen device. + +**************************************************************************** + + 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. + +***************************************************************************/ + +#pragma once + +#ifndef __EMU_H__ +#error Dont include this file directly; include emu.h instead. +#endif + +#ifndef __SCREEN_H__ +#define __SCREEN_H__ + + +//************************************************************************** +// CONSTANTS +//************************************************************************** + +// screen types +enum screen_type_enum +{ + SCREEN_TYPE_INVALID = 0, + SCREEN_TYPE_RASTER, + SCREEN_TYPE_VECTOR, + SCREEN_TYPE_LCD +}; + + +// screen_update callback flags +const UINT32 UPDATE_HAS_NOT_CHANGED = 0x0001; // the video has not changed + + + +//************************************************************************** +// TYPE DEFINITIONS +//************************************************************************** + +// forward references +class render_texture; +class screen_device; + + +// ======================> screen_bitmap + +class screen_bitmap +{ +private: + // internal helpers + bitmap_t &live() { assert(m_live != NULL); return *m_live; } + const bitmap_t &live() const { assert(m_live != NULL); return *m_live; } + +public: + // construction/destruction + screen_bitmap() + : m_format(BITMAP_FORMAT_RGB32), + m_texformat(TEXFORMAT_RGB32), + m_live(&m_rgb32) { } + screen_bitmap(bitmap_ind16 &orig) + : m_format(BITMAP_FORMAT_IND16), + m_texformat(TEXFORMAT_PALETTE16), + m_live(&m_ind16), + m_ind16(orig, orig.cliprect()) { } + screen_bitmap(bitmap_rgb32 &orig) + : m_format(BITMAP_FORMAT_RGB32), + m_texformat(TEXFORMAT_RGB32), + m_live(&m_rgb32), + m_rgb32(orig, orig.cliprect()) { } + + // resizing + void resize(int width, int height) { live().resize(width, height); } + + // conversion + operator bitmap_t &() { return live(); } + bitmap_ind16 &as_ind16() { assert(m_format == BITMAP_FORMAT_IND16); return m_ind16; } + bitmap_rgb32 &as_rgb32() { assert(m_format == BITMAP_FORMAT_RGB32); return m_rgb32; } + + // getters + INT32 width() const { return live().width(); } + INT32 height() const { return live().height(); } + INT32 rowpixels() const { return live().rowpixels(); } + INT32 rowbytes() const { return live().rowbytes(); } + UINT8 bpp() const { return live().bpp(); } + bitmap_format format() const { return m_format; } + texture_format texformat() const { return m_texformat; } + bool valid() const { return live().valid(); } + palette_t *palette() const { return live().palette(); } + const rectangle &cliprect() const { return live().cliprect(); } + + // operations + void set_palette(palette_t *palette) { live().set_palette(palette); } + void set_format(bitmap_format format, texture_format texformat) + { + m_format = format; + m_texformat = texformat; + switch (format) + { + case BITMAP_FORMAT_IND16: m_live = &m_ind16; break; + case BITMAP_FORMAT_RGB32: m_live = &m_rgb32; break; + default: m_live = NULL; break; + } + m_ind16.reset(); + m_rgb32.reset(); + } + +private: + // internal state + bitmap_format m_format; + texture_format m_texformat; + bitmap_t * m_live; + bitmap_ind16 m_ind16; + bitmap_rgb32 m_rgb32; +}; + + +// ======================> other delegate types + +typedef delegate<void (screen_device &, bool)> vblank_state_delegate; + +typedef device_delegate<UINT32 (screen_device &, bitmap_ind16 &, const rectangle &)> screen_update_ind16_delegate; +typedef device_delegate<UINT32 (screen_device &, bitmap_rgb32 &, const rectangle &)> screen_update_rgb32_delegate; +typedef device_delegate<void (screen_device &, bool)> screen_vblank_delegate; + + +// ======================> screen_device + +class screen_device : public device_t +{ + friend class render_manager; + +public: + // construction/destruction + screen_device(const machine_config &mconfig, const char *tag, device_t *owner, UINT32 clock); + ~screen_device(); + + // configuration readers + screen_type_enum screen_type() const { return m_type; } + int width() const { return m_width; } + int height() const { return m_height; } + const rectangle &visible_area() const { return m_visarea; } + const rectangle &cliprect() const { return m_bitmap[0].cliprect(); } + bool oldstyle_vblank_supplied() const { return m_oldstyle_vblank_supplied; } + attoseconds_t refresh_attoseconds() const { return m_refresh; } + attoseconds_t vblank_attoseconds() const { return m_vblank; } + bitmap_format format() const { return !m_screen_update_ind16.isnull() ? BITMAP_FORMAT_IND16 : BITMAP_FORMAT_RGB32; } + float xoffset() const { return m_xoffset; } + float yoffset() const { return m_yoffset; } + float xscale() const { return m_xscale; } + float yscale() const { return m_yscale; } + bool have_screen_update() const { return !m_screen_update_ind16.isnull() && !m_screen_update_rgb32.isnull(); } + + // inline configuration helpers + static void static_set_type(device_t &device, screen_type_enum type); + static void static_set_raw(device_t &device, UINT32 pixclock, UINT16 htotal, UINT16 hbend, UINT16 hbstart, UINT16 vtotal, UINT16 vbend, UINT16 vbstart); + static void static_set_refresh(device_t &device, attoseconds_t rate); + static void static_set_vblank_time(device_t &device, attoseconds_t time); + static void static_set_size(device_t &device, UINT16 width, UINT16 height); + static void static_set_visarea(device_t &device, INT16 minx, INT16 maxx, INT16 miny, INT16 maxy); + static void static_set_default_position(device_t &device, double xscale, double xoffs, double yscale, double yoffs); + static void static_set_screen_update(device_t &device, screen_update_ind16_delegate callback); + static void static_set_screen_update(device_t &device, screen_update_rgb32_delegate callback); + static void static_set_screen_vblank(device_t &device, screen_vblank_delegate callback); + + // information getters + render_container &container() const { assert(m_container != NULL); return *m_container; } + + // dynamic configuration + void configure(int width, int height, const rectangle &visarea, attoseconds_t frame_period); + void reset_origin(int beamy = 0, int beamx = 0); + void set_visible_area(int min_x, int max_x, int min_y, int max_y); + + // beam positioning and state + int vpos() const; + int hpos() const; + bool vblank() const { return (machine().time() < m_vblank_end_time); } + bool hblank() const { int curpos = hpos(); return (curpos < m_visarea.min_x || curpos > m_visarea.max_x); } + + // timing + attotime time_until_pos(int vpos, int hpos = 0) const; + attotime time_until_vblank_start() const { return time_until_pos(m_visarea.max_y + 1); } + attotime time_until_vblank_end() const; + attotime time_until_update() const { return (machine().config().m_video_attributes & VIDEO_UPDATE_AFTER_VBLANK) ? time_until_vblank_end() : time_until_vblank_start(); } + attotime scan_period() const { return attotime(0, m_scantime); } + attotime frame_period() const { return (this == NULL) ? DEFAULT_FRAME_PERIOD : attotime(0, m_frame_period); }; + UINT64 frame_number() const { return m_frame_number; } + + // updating + int partial_updates() const { return m_partial_updates_this_frame; } + bool update_partial(int scanline); + void update_now(); + void reset_partial_updates(); + + // additional helpers + void register_vblank_callback(vblank_state_delegate vblank_callback); + void register_screen_bitmap(bitmap_t &bitmap); + int vblank_port_read(); + + // internal to the video system + bool update_quads(); + void update_burnin(); + + // globally accessible constants + static const int DEFAULT_FRAME_RATE = 60; + static const attotime DEFAULT_FRAME_PERIOD; + +private: + // timer IDs + enum + { + TID_VBLANK_START, + TID_VBLANK_END, + TID_SCANLINE0, + TID_SCANLINE + }; + + // device-level overrides + virtual void device_validity_check(validity_checker &valid) const; + virtual void device_start(); + virtual void device_stop(); + virtual void device_post_load(); + virtual void device_timer(emu_timer &timer, device_timer_id id, int param, void *ptr); + + // internal helpers + void set_container(render_container &container) { m_container = &container; } + void realloc_screen_bitmaps(); + void vblank_begin(); + void vblank_end(); + void finalize_burnin(); + void load_effect_overlay(const char *filename); + + // inline configuration data + screen_type_enum m_type; // type of screen + bool m_oldstyle_vblank_supplied; // MCFG_SCREEN_VBLANK_TIME macro used + attoseconds_t m_refresh; // default refresh period + attoseconds_t m_vblank; // duration of a VBLANK + float m_xoffset, m_yoffset; // default X/Y offsets + float m_xscale, m_yscale; // default X/Y scale factor + screen_update_ind16_delegate m_screen_update_ind16; // screen update callback (16-bit palette) + screen_update_rgb32_delegate m_screen_update_rgb32; // screen update callback (32-bit RGB) + screen_vblank_delegate m_screen_vblank; // screen vblank callback + + // internal state + render_container * m_container; // pointer to our container + + // dimensions + int m_width; // current width (HTOTAL) + int m_height; // current height (VTOTAL) + rectangle m_visarea; // current visible area (HBLANK end/start, VBLANK end/start) + + // textures and bitmaps + texture_format m_texformat; // texture format + render_texture * m_texture[2]; // 2x textures for the screen bitmap + screen_bitmap m_bitmap[2]; // 2x bitmaps for rendering + bitmap_ind64 m_burnin; // burn-in bitmap + UINT8 m_curbitmap; // current bitmap index + UINT8 m_curtexture; // current texture index + bool m_changed; // has this bitmap changed? + INT32 m_last_partial_scan; // scanline of last partial update + bitmap_argb32 m_screen_overlay_bitmap; // screen overlay bitmap + + // screen timing + attoseconds_t m_frame_period; // attoseconds per frame + attoseconds_t m_scantime; // attoseconds per scanline + attoseconds_t m_pixeltime; // attoseconds per pixel + attoseconds_t m_vblank_period; // attoseconds per VBLANK period + attotime m_vblank_start_time; // time of last VBLANK start + attotime m_vblank_end_time; // time of last VBLANK end + emu_timer * m_vblank_begin_timer; // timer to signal VBLANK start + emu_timer * m_vblank_end_timer; // timer to signal VBLANK end + emu_timer * m_scanline0_timer; // scanline 0 timer + emu_timer * m_scanline_timer; // scanline timer + UINT64 m_frame_number; // the current frame number + UINT32 m_partial_updates_this_frame;// partial update counter this frame + + // VBLANK callbacks + class callback_item + { + public: + callback_item(vblank_state_delegate callback) + : m_next(NULL), + m_callback(callback) { } + callback_item *next() const { return m_next; } + + callback_item * m_next; + vblank_state_delegate m_callback; + }; + simple_list<callback_item> m_callback_list; // list of VBLANK callbacks + + // auto-sizing bitmaps + class auto_bitmap_item + { + public: + auto_bitmap_item(bitmap_t &bitmap) + : m_next(NULL), + m_bitmap(bitmap) { } + auto_bitmap_item *next() const { return m_next; } + + auto_bitmap_item * m_next; + bitmap_t & m_bitmap; + }; + simple_list<auto_bitmap_item> m_auto_bitmap_list; // list of registered bitmaps +}; + +// device type definition +extern const device_type SCREEN; + +// iterator helper +typedef device_type_iterator<&device_creator<screen_device>, screen_device> screen_device_iterator; + + + +//************************************************************************** +// SCREEN DEVICE CONFIGURATION MACROS +//************************************************************************** + +#define SCREEN_UPDATE_NAME(name) screen_update_##name +#define SCREEN_UPDATE_IND16(name) UINT32 SCREEN_UPDATE_NAME(name)(device_t *, screen_device &screen, bitmap_ind16 &bitmap, const rectangle &cliprect) +#define SCREEN_UPDATE_RGB32(name) UINT32 SCREEN_UPDATE_NAME(name)(device_t *, screen_device &screen, bitmap_rgb32 &bitmap, const rectangle &cliprect) +#define SCREEN_UPDATE16_CALL(name) SCREEN_UPDATE_NAME(name)(NULL, screen, bitmap, cliprect) +#define SCREEN_UPDATE32_CALL(name) SCREEN_UPDATE_NAME(name)(NULL, screen, bitmap, cliprect) + +#define SCREEN_VBLANK_NAME(name) screen_vblank_##name +#define SCREEN_VBLANK(name) void SCREEN_VBLANK_NAME(name)(device_t *, screen_device &screen, bool vblank_on) +#define SCREEN_VBLANK_CALL(name) SCREEN_VBLANK_NAME(name)(NULL, screen, vblank_on) + +#define MCFG_SCREEN_ADD(_tag, _type) \ + MCFG_DEVICE_ADD(_tag, SCREEN, 0) \ + MCFG_SCREEN_TYPE(_type) \ + +#define MCFG_SCREEN_MODIFY(_tag) \ + MCFG_DEVICE_MODIFY(_tag) + +#define MCFG_SCREEN_TYPE(_type) \ + screen_device::static_set_type(*device, SCREEN_TYPE_##_type); \ + +#define MCFG_SCREEN_RAW_PARAMS(_pixclock, _htotal, _hbend, _hbstart, _vtotal, _vbend, _vbstart) \ + screen_device::static_set_raw(*device, _pixclock, _htotal, _hbend, _hbstart, _vtotal, _vbend, _vbstart); + +#define MCFG_SCREEN_REFRESH_RATE(_rate) \ + screen_device::static_set_refresh(*device, HZ_TO_ATTOSECONDS(_rate)); \ + +#define MCFG_SCREEN_VBLANK_TIME(_time) \ + screen_device::static_set_vblank_time(*device, _time); \ + +#define MCFG_SCREEN_SIZE(_width, _height) \ + screen_device::static_set_size(*device, _width, _height); \ + +#define MCFG_SCREEN_VISIBLE_AREA(_minx, _maxx, _miny, _maxy) \ + screen_device::static_set_visarea(*device, _minx, _maxx, _miny, _maxy); \ + +#define MCFG_SCREEN_DEFAULT_POSITION(_xscale, _xoffs, _yscale, _yoffs) \ + screen_device::static_set_default_position(*device, _xscale, _xoffs, _yscale, _yoffs); \ + +#define MCFG_SCREEN_UPDATE_STATIC(_func) \ + screen_device::static_set_screen_update(*device, screen_update_delegate_smart(&screen_update_##_func, "screen_update_" #_func)); \ + +#define MCFG_SCREEN_UPDATE_DRIVER(_class, _method) \ + screen_device::static_set_screen_update(*device, screen_update_delegate_smart(&_class::_method, #_class "::" #_method, NULL)); \ + +#define MCFG_SCREEN_UPDATE_DEVICE(_device, _class, _method) \ + screen_device::static_set_screen_update(*device, screen_update_delegate_smart(&_class::_method, #_class "::" #_method, _device)); \ + +#define MCFG_SCREEN_VBLANK_NONE() \ + screen_device::static_set_screen_vblank(*device, screen_vblank_delegate()); \ + +#define MCFG_SCREEN_VBLANK_STATIC(_func) \ + screen_device::static_set_screen_vblank(*device, screen_vblank_delegate(&screen_vblank_##_func, "screen_vblank_" #_func)); \ + +#define MCFG_SCREEN_VBLANK_DRIVER(_class, _method) \ + screen_device::static_set_screen_vblank(*device, screen_vblank_delegate(&_class::_method, #_class "::" #_method, NULL, (_class *)0)); \ + +#define MCFG_SCREEN_VBLANK_DEVICE(_device, _class, _method) \ + screen_device::static_set_screen_vblank(*device, screen_vblank_delegate(&_class::_method, #_class "::" #_method, _device, (_class *)0)); \ + + + +//************************************************************************** +// INLINE HELPERS +//************************************************************************** + +//------------------------------------------------- +// screen_update_delegate_smart - collection of +// inline helpers which create the appropriate +// screen_update_delegate based on the input +// function type +//------------------------------------------------- + +inline screen_update_ind16_delegate screen_update_delegate_smart(UINT32 (*callback)(device_t *, screen_device &, bitmap_ind16 &, const rectangle &), const char *name) +{ + return screen_update_ind16_delegate(callback, name); +} + +inline screen_update_rgb32_delegate screen_update_delegate_smart(UINT32 (*callback)(device_t *, screen_device &, bitmap_rgb32 &, const rectangle &), const char *name) +{ + return screen_update_rgb32_delegate(callback, name); +} + +template<class _FunctionClass> +inline screen_update_ind16_delegate screen_update_delegate_smart(UINT32 (_FunctionClass::*callback)(screen_device &, bitmap_ind16 &, const rectangle &), const char *name, const char *devname) +{ + return screen_update_ind16_delegate(callback, name, devname, (_FunctionClass *)0); +} + +template<class _FunctionClass> +inline screen_update_rgb32_delegate screen_update_delegate_smart(UINT32 (_FunctionClass::*callback)(screen_device &, bitmap_rgb32 &, const rectangle &), const char *name, const char *devname) +{ + return screen_update_rgb32_delegate(callback, name, devname, (_FunctionClass *)0); +} + + +#endif /* __SCREEN_H__ */ |