src/include/video.h

/*
 *  video.h - Video/graphics emulation
 *
 *  Basilisk II (C) 1997-2008 Christian Bauer
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef VIDEO_H
#define VIDEO_H

#include <vector>

#ifndef NO_STD_NAMESPACE
using std::vector;
#endif


/*
   Some of the terminology here is completely frelled. In Basilisk II, a
   "video mode" refers to a combination of resolution and color depth, and
   this information is stored in a video_mode structure. In Apple
   documentation, a "mode" historically refers to the color depth only
   (because old Macs had fixed-frequency monitors and could not change the
   resolution). These "modes" are assigned a number (0x80, 0x81, etc.),
   which we here call "Apple mode". When Macs learned how to deal with
   multiscan monitors, Apple introduced another type of "mode", also having
   numbers starting from 0x80 but refrerring to the resolution and/or video
   timing of the display (it's possible to have two modes with the same
   dimension but different refresh rates). We call this a "resolution ID". 
   The combination of "Apple mode" and "ID" corresponds to a Basilisk II
   "video mode". To make the confusion worse, the video driver control call
   that sets the color depth is called "SetMode" while the one that sets
   both depth and resolution is "SwitchMode"...
*/

// Color depth codes
enum video_depth {
        VDEPTH_1BIT,  // 2 colors
        VDEPTH_2BIT,  // 4 colors
        VDEPTH_4BIT,  // 16 colors
        VDEPTH_8BIT,  // 256 colors
        VDEPTH_16BIT, // "Thousands"
        VDEPTH_32BIT  // "Millions"
};

// 1, 2, 4 and 8 bit depths use a color palette
inline bool IsDirectMode(video_depth depth)
{
        return depth == VDEPTH_16BIT || depth == VDEPTH_32BIT;
}

// Return the depth code that corresponds to the specified bits-per-pixel value
inline video_depth DepthModeForPixelDepth(int depth)
{
        switch (depth) {
                case 1: return VDEPTH_1BIT;
                case 2: return VDEPTH_2BIT;
                case 4: return VDEPTH_4BIT;
                case 8: return VDEPTH_8BIT;
                case 15: case 16: return VDEPTH_16BIT;
                case 24: case 32: return VDEPTH_32BIT;
                default: return VDEPTH_1BIT;
        }
}

// Return a bytes-per-row value (assuming no padding) for the specified depth and pixel width
inline uint32 TrivialBytesPerRow(uint32 width, video_depth depth)
{
        switch (depth) {
                case VDEPTH_1BIT: return width / 8;
                case VDEPTH_2BIT: return width / 4;
                case VDEPTH_4BIT: return width / 2;
                case VDEPTH_8BIT: return width;
                case VDEPTH_16BIT: return width * 2;
                case VDEPTH_32BIT: return width * 4;
                default: return width;
        }
}


/*
   You are not completely free in your selection of depth/resolution
   combinations:
     1) the lowest supported color depth must be available in all
        resolutions
     2) if one resolution provides a certain color depth, it must also
        provide all lower supported depths

   For example, it is possible to have this set of modes:
     640x480 @ 8 bit
     640x480 @ 32 bit
     800x600 @ 8 bit
     800x600 @ 32 bit
     1024x768 @ 8 bit

   But this is not possible (violates rule 1):
     640x480 @ 8 bit
     800x600 @ 8 bit
     1024x768 @ 1 bit

   And neither is this (violates rule 2, 640x480 @ 16 bit is missing):
     640x480 @ 8 bit
     640x480 @ 32 bit
     800x600 @ 8 bit
     800x600 @ 16 bit
     1024x768 @ 8 bit
*/

// Description of a video mode
struct video_mode {
        uint32 x;                               // X size of screen (pixels)
        uint32 y;                               // Y size of screen (pixels)
        uint32 resolution_id;   // Resolution ID (should be >= 0x80 and uniquely identify the sets of modes with the same X/Y size)
        video_depth depth;              // Color depth (see definitions above)
        uint32 bytes_per_row;   // Bytes per row of frame buffer
        uint32 user_data;               // Free for use by platform-specific code
};

inline bool IsDirectMode(const video_mode &mode)
{
        return IsDirectMode(mode.depth);
}


// Mac video driver per-display private variables (opaque)
struct video_locals;


// Abstract base class representing one (possibly virtual) monitor
// ("monitor" = rectangular display with a contiguous frame buffer)
class monitor_desc {
public:
        monitor_desc(const vector<video_mode> &available_modes, video_depth default_depth, uint32 default_id);
        virtual ~monitor_desc() {}

        // Get Mac slot ID number
        uint8 get_slot_id(void) const {return slot_id;}

        // Get current Mac frame buffer base address
        uint32 get_mac_frame_base(void) const {return mac_frame_base;}

        // Set Mac frame buffer base address (called from switch_to_mode())
        void set_mac_frame_base(uint32 base) {mac_frame_base = base;}

        // Get current video mode
        const video_mode &get_current_mode(void) const {return *current_mode;}

        // Get Apple mode id for given depth
        uint16 depth_to_apple_mode(video_depth depth) const {return apple_mode_for_depth[depth];}

        // Get current color depth
        uint16 get_apple_mode(void) const {return depth_to_apple_mode(current_mode->depth);}

        // Get bytes-per-row value for specified resolution/depth
        // (if the mode isn't supported, make a good guess)
        uint32 get_bytes_per_row(video_depth depth, uint32 id) const;

        // Check whether a mode with the specified depth exists on this display
        bool has_depth(video_depth depth) const;

        // Mac video driver functions
        int16 driver_open(void);
        int16 driver_control(uint16 code, uint32 param, uint32 dce);
        int16 driver_status(uint16 code, uint32 param);

protected:
        vector<video_mode> modes;                         // List of supported video modes
        vector<video_mode>::const_iterator current_mode;  // Currently selected video mode

        uint32 mac_frame_base;  // Mac frame buffer address for current mode

// Mac video driver per-display private variables/functions
private:
        // Check whether the specified resolution ID is one of the supported resolutions
        bool has_resolution(uint32 id) const;

        // Return iterator signifying "invalid mode"
        vector<video_mode>::const_iterator invalid_mode(void) const {return modes.end();}

        // Find specified mode (depth/resolution) (or invalid_mode() if not found)
        vector<video_mode>::const_iterator find_mode(uint16 apple_mode, uint32 id) const;

        // Find maximum supported depth for given resolution ID
        video_depth max_depth_of_resolution(uint32 id) const;

        // Get X/Y size of specified resolution
        void get_size_of_resolution(uint32 id, uint32 &x, uint32 &y) const;

        // Set palette to 50% gray
        void set_gray_palette(void);

        // Load gamma-corrected black-to-white ramp to palette for direct-color mode
        void load_ramp_palette(void);

        // Allocate gamma table of specified size
        bool allocate_gamma_table(int size);

        // Set gamma table (0 = build linear ramp)
        bool set_gamma_table(uint32 user_table);

        // Switch video mode
        void switch_mode(vector<video_mode>::const_iterator it, uint32 param, uint32 dce);

        uint8 slot_id;               // NuBus slot ID number
        static uint8 next_slot_id;   // Next available slot ID

        uint8 palette[256 * 3];      // Color palette, 256 entries, RGB

        bool luminance_mapping;      // Luminance mapping on/off
        bool interrupts_enabled;     // VBL interrupts on/off
        bool dm_present;             // We received a GetVideoParameters call, so the Display Manager seems to be present

        uint32 gamma_table;          // Mac address of gamma table
        int alloc_gamma_table_size;  // Allocated size of gamma table

        uint16 current_apple_mode;   // Currently selected depth/resolution
        uint32 current_id;
        uint16 preferred_apple_mode; // Preferred depth/resolution
        uint32 preferred_id;

        uint32 slot_param;           // Mac address of Slot Manager parameter block

        // For compatibility reasons with older (pre-Display Manager) versions of
        // MacOS, the Apple modes must start at 0x80 and be contiguous. Therefore
        // we maintain an array to map the depth codes to the corresponding Apple
        // mode.
        uint16 apple_mode_for_depth[6];

// The following functions are implemented by platform-specific code
public:

        // Called by the video driver to switch the video mode on this display
        // (must call set_mac_frame_base())
        virtual void switch_to_current_mode(void) = 0;

        // Called by the video driver to set the color palette (in indexed modes)
        // or the gamma table (in direct modes)
        virtual void set_palette(uint8 *pal, int num) = 0;
};

// Vector of pointers to available monitor descriptions, filled by VideoInit()
extern vector<monitor_desc *> VideoMonitors;


extern int16 VideoDriverOpen(uint32 pb, uint32 dce);
extern int16 VideoDriverControl(uint32 pb, uint32 dce);
extern int16 VideoDriverStatus(uint32 pb, uint32 dce);


// System specific and internal functions/data
extern bool VideoInit(bool classic);
extern void VideoExit(void);

extern void VideoQuitFullScreen(void);

extern void VideoInterrupt(void);
extern void VideoRefresh(void);

#endif
Revision:	1.17
Committed:	2008-01-01T09:40:35Z (16 years, 5 months ago) by gbeauche
Content type:	text/plain
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.16:	+1 -1 lines
Log Message:	Happy New Year!
#	User	Rev	Content
1	cebix	1.1	/*
2			* video.h - Video/graphics emulation
3			*
4	gbeauche	1.17	* Basilisk II (C) 1997-2008 Christian Bauer
5	cebix	1.1	*
6			* This program is free software; you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation; either version 2 of the License, or
9			* (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15			*
16			* You should have received a copy of the GNU General Public License
17			* along with this program; if not, write to the Free Software
18			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19			*/
20
21			#ifndef VIDEO_H
22			#define VIDEO_H
23
24	cebix	1.6	#include <vector>
25
26	cebix	1.10	#ifndef NO_STD_NAMESPACE
27			using std::vector;
28			#endif
29
30	cebix	1.14
31	cebix	1.9	/*
32			Some of the terminology here is completely frelled. In Basilisk II, a
33			"video mode" refers to a combination of resolution and color depth, and
34			this information is stored in a video_mode structure. In Apple
35			documentation, a "mode" historically refers to the color depth only
36			(because old Macs had fixed-frequency monitors and could not change the
37			resolution). These "modes" are assigned a number (0x80, 0x81, etc.),
38			which we here call "Apple mode". When Macs learned how to deal with
39			multiscan monitors, Apple introduced another type of "mode", also having
40			numbers starting from 0x80 but refrerring to the resolution and/or video
41			timing of the display (it's possible to have two modes with the same
42			dimension but different refresh rates). We call this a "resolution ID".
43			The combination of "Apple mode" and "ID" corresponds to a Basilisk II
44			"video mode". To make the confusion worse, the video driver control call
45			that sets the color depth is called "SetMode" while the one that sets
46			both depth and resolution is "SwitchMode"...
47			*/
48
49	cebix	1.6	// Color depth codes
50			enum video_depth {
51			VDEPTH_1BIT, // 2 colors
52			VDEPTH_2BIT, // 4 colors
53			VDEPTH_4BIT, // 16 colors
54			VDEPTH_8BIT, // 256 colors
55			VDEPTH_16BIT, // "Thousands"
56			VDEPTH_32BIT // "Millions"
57	cebix	1.1	};
58
59	cebix	1.14	// 1, 2, 4 and 8 bit depths use a color palette
60	cebix	1.6	inline bool IsDirectMode(video_depth depth)
61			{
62			return depth == VDEPTH_16BIT \|\| depth == VDEPTH_32BIT;
63			}
64
65	cebix	1.9	// Return the depth code that corresponds to the specified bits-per-pixel value
66	cebix	1.8	inline video_depth DepthModeForPixelDepth(int depth)
67	cebix	1.6	{
68	cebix	1.8	switch (depth) {
69			case 1: return VDEPTH_1BIT;
70			case 2: return VDEPTH_2BIT;
71			case 4: return VDEPTH_4BIT;
72			case 8: return VDEPTH_8BIT;
73			case 15: case 16: return VDEPTH_16BIT;
74			case 24: case 32: return VDEPTH_32BIT;
75			default: return VDEPTH_1BIT;
76			}
77	cebix	1.6	}
78	cebix	1.1
79	cebix	1.9	// Return a bytes-per-row value (assuming no padding) for the specified depth and pixel width
80	cebix	1.8	inline uint32 TrivialBytesPerRow(uint32 width, video_depth depth)
81	cebix	1.6	{
82	cebix	1.8	switch (depth) {
83			case VDEPTH_1BIT: return width / 8;
84			case VDEPTH_2BIT: return width / 4;
85			case VDEPTH_4BIT: return width / 2;
86			case VDEPTH_8BIT: return width;
87			case VDEPTH_16BIT: return width * 2;
88			case VDEPTH_32BIT: return width * 4;
89	cebix	1.10	default: return width;
90	cebix	1.8	}
91	cebix	1.6	}
92
93	cebix	1.14
94	cebix	1.9	/*
95			You are not completely free in your selection of depth/resolution
96			combinations:
97			1) the lowest supported color depth must be available in all
98			resolutions
99			2) if one resolution provides a certain color depth, it must also
100			provide all lower supported depths
101
102			For example, it is possible to have this set of modes:
103			640x480 @ 8 bit
104			640x480 @ 32 bit
105			800x600 @ 8 bit
106			800x600 @ 32 bit
107			1024x768 @ 8 bit
108
109			But this is not possible (violates rule 1):
110			640x480 @ 8 bit
111			800x600 @ 8 bit
112			1024x768 @ 1 bit
113
114			And neither is this (violates rule 2, 640x480 @ 16 bit is missing):
115			640x480 @ 8 bit
116			640x480 @ 32 bit
117			800x600 @ 8 bit
118			800x600 @ 16 bit
119			1024x768 @ 8 bit
120			*/
121
122			// Description of a video mode
123	cebix	1.6	struct video_mode {
124	cebix	1.1	uint32 x; // X size of screen (pixels)
125			uint32 y; // Y size of screen (pixels)
126	cebix	1.6	uint32 resolution_id; // Resolution ID (should be >= 0x80 and uniquely identify the sets of modes with the same X/Y size)
127	cebix	1.14	video_depth depth; // Color depth (see definitions above)
128	cebix	1.6	uint32 bytes_per_row; // Bytes per row of frame buffer
129	cebix	1.14	uint32 user_data; // Free for use by platform-specific code
130	cebix	1.6	};
131
132			inline bool IsDirectMode(const video_mode &mode)
133			{
134			return IsDirectMode(mode.depth);
135			}
136
137
138	cebix	1.14	// Mac video driver per-display private variables (opaque)
139			struct video_locals;
140
141
142			// Abstract base class representing one (possibly virtual) monitor
143			// ("monitor" = rectangular display with a contiguous frame buffer)
144			class monitor_desc {
145			public:
146			monitor_desc(const vector<video_mode> &available_modes, video_depth default_depth, uint32 default_id);
147			virtual ~monitor_desc() {}
148
149			// Get Mac slot ID number
150			uint8 get_slot_id(void) const {return slot_id;}
151
152			// Get current Mac frame buffer base address
153			uint32 get_mac_frame_base(void) const {return mac_frame_base;}
154
155			// Set Mac frame buffer base address (called from switch_to_mode())
156			void set_mac_frame_base(uint32 base) {mac_frame_base = base;}
157
158			// Get current video mode
159			const video_mode &get_current_mode(void) const {return *current_mode;}
160
161			// Get Apple mode id for given depth
162			uint16 depth_to_apple_mode(video_depth depth) const {return apple_mode_for_depth[depth];}
163
164			// Get current color depth
165			uint16 get_apple_mode(void) const {return depth_to_apple_mode(current_mode->depth);}
166
167			// Get bytes-per-row value for specified resolution/depth
168			// (if the mode isn't supported, make a good guess)
169			uint32 get_bytes_per_row(video_depth depth, uint32 id) const;
170
171			// Check whether a mode with the specified depth exists on this display
172			bool has_depth(video_depth depth) const;
173
174			// Mac video driver functions
175			int16 driver_open(void);
176			int16 driver_control(uint16 code, uint32 param, uint32 dce);
177			int16 driver_status(uint16 code, uint32 param);
178
179			protected:
180			vector<video_mode> modes; // List of supported video modes
181			vector<video_mode>::const_iterator current_mode; // Currently selected video mode
182
183			uint32 mac_frame_base; // Mac frame buffer address for current mode
184
185			// Mac video driver per-display private variables/functions
186			private:
187			// Check whether the specified resolution ID is one of the supported resolutions
188			bool has_resolution(uint32 id) const;
189
190			// Return iterator signifying "invalid mode"
191			vector<video_mode>::const_iterator invalid_mode(void) const {return modes.end();}
192
193			// Find specified mode (depth/resolution) (or invalid_mode() if not found)
194			vector<video_mode>::const_iterator find_mode(uint16 apple_mode, uint32 id) const;
195
196			// Find maximum supported depth for given resolution ID
197			video_depth max_depth_of_resolution(uint32 id) const;
198
199			// Get X/Y size of specified resolution
200			void get_size_of_resolution(uint32 id, uint32 &x, uint32 &y) const;
201
202			// Set palette to 50% gray
203			void set_gray_palette(void);
204
205			// Load gamma-corrected black-to-white ramp to palette for direct-color mode
206			void load_ramp_palette(void);
207
208			// Allocate gamma table of specified size
209			bool allocate_gamma_table(int size);
210
211			// Set gamma table (0 = build linear ramp)
212			bool set_gamma_table(uint32 user_table);
213
214			// Switch video mode
215			void switch_mode(vector<video_mode>::const_iterator it, uint32 param, uint32 dce);
216
217			uint8 slot_id; // NuBus slot ID number
218			static uint8 next_slot_id; // Next available slot ID
219
220			uint8 palette[256 * 3]; // Color palette, 256 entries, RGB
221
222			bool luminance_mapping; // Luminance mapping on/off
223			bool interrupts_enabled; // VBL interrupts on/off
224			bool dm_present; // We received a GetVideoParameters call, so the Display Manager seems to be present
225
226			uint32 gamma_table; // Mac address of gamma table
227			int alloc_gamma_table_size; // Allocated size of gamma table
228
229			uint16 current_apple_mode; // Currently selected depth/resolution
230			uint32 current_id;
231			uint16 preferred_apple_mode; // Preferred depth/resolution
232			uint32 preferred_id;
233
234			uint32 slot_param; // Mac address of Slot Manager parameter block
235
236			// For compatibility reasons with older (pre-Display Manager) versions of
237			// MacOS, the Apple modes must start at 0x80 and be contiguous. Therefore
238			// we maintain an array to map the depth codes to the corresponding Apple
239			// mode.
240			uint16 apple_mode_for_depth[6];
241
242			// The following functions are implemented by platform-specific code
243			public:
244
245			// Called by the video driver to switch the video mode on this display
246			// (must call set_mac_frame_base())
247			virtual void switch_to_current_mode(void) = 0;
248
249			// Called by the video driver to set the color palette (in indexed modes)
250			// or the gamma table (in direct modes)
251			virtual void set_palette(uint8 *pal, int num) = 0;
252	cebix	1.1	};
253
254	cebix	1.14	// Vector of pointers to available monitor descriptions, filled by VideoInit()
255			extern vector<monitor_desc *> VideoMonitors;
256
257	cebix	1.1
258	cebix	1.2	extern int16 VideoDriverOpen(uint32 pb, uint32 dce);
259			extern int16 VideoDriverControl(uint32 pb, uint32 dce);
260			extern int16 VideoDriverStatus(uint32 pb, uint32 dce);
261	cebix	1.1
262	cebix	1.14
263	cebix	1.1	// System specific and internal functions/data
264			extern bool VideoInit(bool classic);
265			extern void VideoExit(void);
266
267			extern void VideoQuitFullScreen(void);
268
269			extern void VideoInterrupt(void);
270	cebix	1.4	extern void VideoRefresh(void);
271	cebix	1.1
272			#endif