Release 1.7.13.
[wine/multimedia.git] / dlls / gdi32 / palette.c
blobd850d0fba7f5f0597733375a0b02f9b9ee5d3f89
1 /*
2 * GDI palette objects
4 * Copyright 1993,1994 Alexandre Julliard
5 * Copyright 1996 Alex Korobka
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 * NOTES:
22 * PALETTEOBJ is documented in the Dr. Dobbs Journal May 1993.
23 * Information in the "Undocumented Windows" is incorrect.
26 #include <stdarg.h>
27 #include <stdlib.h>
28 #include <string.h>
30 #include "windef.h"
31 #include "winbase.h"
32 #include "winerror.h"
33 #include "wingdi.h"
34 #include "winuser.h"
36 #include "gdi_private.h"
37 #include "wine/debug.h"
39 WINE_DEFAULT_DEBUG_CHANNEL(palette);
41 typedef BOOL (*unrealize_function)(HPALETTE);
43 typedef struct tagPALETTEOBJ
45 unrealize_function unrealize;
46 WORD version; /* palette version */
47 WORD count; /* count of palette entries */
48 PALETTEENTRY *entries;
49 } PALETTEOBJ;
51 static INT PALETTE_GetObject( HGDIOBJ handle, INT count, LPVOID buffer );
52 static BOOL PALETTE_UnrealizeObject( HGDIOBJ handle );
53 static BOOL PALETTE_DeleteObject( HGDIOBJ handle );
55 static const struct gdi_obj_funcs palette_funcs =
57 NULL, /* pSelectObject */
58 PALETTE_GetObject, /* pGetObjectA */
59 PALETTE_GetObject, /* pGetObjectW */
60 PALETTE_UnrealizeObject, /* pUnrealizeObject */
61 PALETTE_DeleteObject /* pDeleteObject */
64 /* Pointers to USER implementation of SelectPalette/RealizePalette */
65 /* they will be patched by USER on startup */
66 HPALETTE (WINAPI *pfnSelectPalette)(HDC hdc, HPALETTE hpal, WORD bkgnd ) = GDISelectPalette;
67 UINT (WINAPI *pfnRealizePalette)(HDC hdc) = GDIRealizePalette;
69 static UINT SystemPaletteUse = SYSPAL_STATIC; /* currently not considered */
71 static HPALETTE hPrimaryPalette = 0; /* used for WM_PALETTECHANGED */
72 static HPALETTE hLastRealizedPalette = 0; /* UnrealizeObject() needs it */
75 /***********************************************************************
76 * PALETTE_Init
78 * Create the system palette.
80 HPALETTE PALETTE_Init(void)
82 const RGBQUAD *entries = get_default_color_table( 8 );
83 char buffer[FIELD_OFFSET( LOGPALETTE, palPalEntry[20] )];
84 LOGPALETTE *palPtr = (LOGPALETTE *)buffer;
85 int i;
87 /* create default palette (20 system colors) */
89 palPtr->palVersion = 0x300;
90 palPtr->palNumEntries = 20;
91 for (i = 0; i < 20; i++)
93 palPtr->palPalEntry[i].peRed = entries[i < 10 ? i : 236 + i].rgbRed;
94 palPtr->palPalEntry[i].peGreen = entries[i < 10 ? i : 236 + i].rgbGreen;
95 palPtr->palPalEntry[i].peBlue = entries[i < 10 ? i : 236 + i].rgbBlue;
96 palPtr->palPalEntry[i].peFlags = 0;
98 return CreatePalette( palPtr );
102 /***********************************************************************
103 * CreatePalette [GDI32.@]
105 * Creates a logical color palette.
107 * RETURNS
108 * Success: Handle to logical palette
109 * Failure: NULL
111 HPALETTE WINAPI CreatePalette(
112 const LOGPALETTE* palette) /* [in] Pointer to logical color palette */
114 PALETTEOBJ * palettePtr;
115 HPALETTE hpalette;
116 int size;
118 if (!palette) return 0;
119 TRACE("entries=%i\n", palette->palNumEntries);
121 if (!(palettePtr = HeapAlloc( GetProcessHeap(), 0, sizeof(*palettePtr) ))) return 0;
122 palettePtr->unrealize = NULL;
123 palettePtr->version = palette->palVersion;
124 palettePtr->count = palette->palNumEntries;
125 size = palettePtr->count * sizeof(*palettePtr->entries);
126 if (!(palettePtr->entries = HeapAlloc( GetProcessHeap(), 0, size )))
128 HeapFree( GetProcessHeap(), 0, palettePtr );
129 return 0;
131 memcpy( palettePtr->entries, palette->palPalEntry, size );
132 if (!(hpalette = alloc_gdi_handle( palettePtr, OBJ_PAL, &palette_funcs )))
134 HeapFree( GetProcessHeap(), 0, palettePtr->entries );
135 HeapFree( GetProcessHeap(), 0, palettePtr );
137 TRACE(" returning %p\n", hpalette);
138 return hpalette;
142 /***********************************************************************
143 * CreateHalftonePalette [GDI32.@]
145 * Creates a halftone palette.
147 * RETURNS
148 * Success: Handle to logical halftone palette
149 * Failure: 0
151 * FIXME: This simply creates the halftone palette derived from running
152 * tests on a windows NT machine. This is assuming a color depth
153 * of greater that 256 color. On a 256 color device the halftone
154 * palette will be different and this function will be incorrect
156 HPALETTE WINAPI CreateHalftonePalette(
157 HDC hdc) /* [in] Handle to device context */
159 const RGBQUAD *entries = get_default_color_table( 8 );
160 char buffer[FIELD_OFFSET( LOGPALETTE, palPalEntry[256] )];
161 LOGPALETTE *pal = (LOGPALETTE *)buffer;
162 int i;
164 pal->palVersion = 0x300;
165 pal->palNumEntries = 256;
166 for (i = 0; i < 256; i++)
168 pal->palPalEntry[i].peRed = entries[i].rgbRed;
169 pal->palPalEntry[i].peGreen = entries[i].rgbGreen;
170 pal->palPalEntry[i].peBlue = entries[i].rgbBlue;
171 pal->palPalEntry[i].peFlags = 0;
173 return CreatePalette( pal );
177 /***********************************************************************
178 * GetPaletteEntries [GDI32.@]
180 * Retrieves palette entries.
182 * RETURNS
183 * Success: Number of entries from logical palette
184 * Failure: 0
186 UINT WINAPI GetPaletteEntries(
187 HPALETTE hpalette, /* [in] Handle of logical palette */
188 UINT start, /* [in] First entry to receive */
189 UINT count, /* [in] Number of entries to receive */
190 LPPALETTEENTRY entries) /* [out] Address of array receiving entries */
192 PALETTEOBJ * palPtr;
193 UINT numEntries;
195 TRACE("hpal = %p, count=%i\n", hpalette, count );
197 palPtr = GDI_GetObjPtr( hpalette, OBJ_PAL );
198 if (!palPtr) return 0;
200 /* NOTE: not documented but test show this to be the case */
201 if (count == 0)
203 count = palPtr->count;
205 else
207 numEntries = palPtr->count;
208 if (start+count > numEntries) count = numEntries - start;
209 if (entries)
211 if (start >= numEntries) count = 0;
212 else memcpy( entries, &palPtr->entries[start], count * sizeof(PALETTEENTRY) );
216 GDI_ReleaseObj( hpalette );
217 return count;
221 /***********************************************************************
222 * SetPaletteEntries [GDI32.@]
224 * Sets color values for range in palette.
226 * RETURNS
227 * Success: Number of entries that were set
228 * Failure: 0
230 UINT WINAPI SetPaletteEntries(
231 HPALETTE hpalette, /* [in] Handle of logical palette */
232 UINT start, /* [in] Index of first entry to set */
233 UINT count, /* [in] Number of entries to set */
234 const PALETTEENTRY *entries) /* [in] Address of array of structures */
236 PALETTEOBJ * palPtr;
237 UINT numEntries;
239 TRACE("hpal=%p,start=%i,count=%i\n",hpalette,start,count );
241 hpalette = get_full_gdi_handle( hpalette );
242 if (hpalette == GetStockObject(DEFAULT_PALETTE)) return 0;
243 palPtr = GDI_GetObjPtr( hpalette, OBJ_PAL );
244 if (!palPtr) return 0;
246 numEntries = palPtr->count;
247 if (start >= numEntries)
249 GDI_ReleaseObj( hpalette );
250 return 0;
252 if (start+count > numEntries) count = numEntries - start;
253 memcpy( &palPtr->entries[start], entries, count * sizeof(PALETTEENTRY) );
254 GDI_ReleaseObj( hpalette );
255 UnrealizeObject( hpalette );
256 return count;
260 /***********************************************************************
261 * ResizePalette [GDI32.@]
263 * Resizes logical palette.
265 * RETURNS
266 * Success: TRUE
267 * Failure: FALSE
269 BOOL WINAPI ResizePalette(
270 HPALETTE hPal, /* [in] Handle of logical palette */
271 UINT cEntries) /* [in] Number of entries in logical palette */
273 PALETTEOBJ * palPtr = GDI_GetObjPtr( hPal, OBJ_PAL );
274 PALETTEENTRY *entries;
276 if( !palPtr ) return FALSE;
277 TRACE("hpal = %p, prev = %i, new = %i\n", hPal, palPtr->count, cEntries );
279 if (!(entries = HeapReAlloc( GetProcessHeap(), HEAP_ZERO_MEMORY,
280 palPtr->entries, cEntries * sizeof(*palPtr->entries) )))
282 GDI_ReleaseObj( hPal );
283 return FALSE;
285 palPtr->entries = entries;
286 palPtr->count = cEntries;
288 GDI_ReleaseObj( hPal );
289 PALETTE_UnrealizeObject( hPal );
290 return TRUE;
294 /***********************************************************************
295 * AnimatePalette [GDI32.@]
297 * Replaces entries in logical palette.
299 * RETURNS
300 * Success: TRUE
301 * Failure: FALSE
303 * FIXME
304 * Should use existing mapping when animating a primary palette
306 BOOL WINAPI AnimatePalette(
307 HPALETTE hPal, /* [in] Handle to logical palette */
308 UINT StartIndex, /* [in] First entry in palette */
309 UINT NumEntries, /* [in] Count of entries in palette */
310 const PALETTEENTRY* PaletteColors) /* [in] Pointer to first replacement */
312 TRACE("%p (%i - %i)\n", hPal, StartIndex,StartIndex+NumEntries);
314 hPal = get_full_gdi_handle( hPal );
315 if( hPal != GetStockObject(DEFAULT_PALETTE) )
317 PALETTEOBJ * palPtr;
318 UINT pal_entries;
319 const PALETTEENTRY *pptr = PaletteColors;
321 palPtr = GDI_GetObjPtr( hPal, OBJ_PAL );
322 if (!palPtr) return FALSE;
324 pal_entries = palPtr->count;
325 if (StartIndex >= pal_entries)
327 GDI_ReleaseObj( hPal );
328 return FALSE;
330 if (StartIndex+NumEntries > pal_entries) NumEntries = pal_entries - StartIndex;
332 for (NumEntries += StartIndex; StartIndex < NumEntries; StartIndex++, pptr++) {
333 /* According to MSDN, only animate PC_RESERVED colours */
334 if (palPtr->entries[StartIndex].peFlags & PC_RESERVED) {
335 TRACE("Animating colour (%d,%d,%d) to (%d,%d,%d)\n",
336 palPtr->entries[StartIndex].peRed,
337 palPtr->entries[StartIndex].peGreen,
338 palPtr->entries[StartIndex].peBlue,
339 pptr->peRed, pptr->peGreen, pptr->peBlue);
340 palPtr->entries[StartIndex] = *pptr;
341 } else {
342 TRACE("Not animating entry %d -- not PC_RESERVED\n", StartIndex);
345 GDI_ReleaseObj( hPal );
346 /* FIXME: check for palette selected in active window */
348 return TRUE;
352 /***********************************************************************
353 * SetSystemPaletteUse [GDI32.@]
355 * Specify whether the system palette contains 2 or 20 static colors.
357 * RETURNS
358 * Success: Previous system palette
359 * Failure: SYSPAL_ERROR
361 UINT WINAPI SetSystemPaletteUse(
362 HDC hdc, /* [in] Handle of device context */
363 UINT use) /* [in] Palette-usage flag */
365 UINT old = SystemPaletteUse;
367 /* Device doesn't support colour palettes */
368 if (!(GetDeviceCaps(hdc, RASTERCAPS) & RC_PALETTE)) {
369 return SYSPAL_ERROR;
372 switch (use) {
373 case SYSPAL_NOSTATIC:
374 case SYSPAL_NOSTATIC256: /* WINVER >= 0x0500 */
375 case SYSPAL_STATIC:
376 SystemPaletteUse = use;
377 return old;
378 default:
379 return SYSPAL_ERROR;
384 /***********************************************************************
385 * GetSystemPaletteUse [GDI32.@]
387 * Gets state of system palette.
389 * RETURNS
390 * Current state of system palette
392 UINT WINAPI GetSystemPaletteUse(
393 HDC hdc) /* [in] Handle of device context */
395 return SystemPaletteUse;
399 /***********************************************************************
400 * GetSystemPaletteEntries [GDI32.@]
402 * Gets range of palette entries.
404 * RETURNS
405 * Success: Number of entries retrieved from palette
406 * Failure: 0
408 UINT WINAPI GetSystemPaletteEntries(
409 HDC hdc, /* [in] Handle of device context */
410 UINT start, /* [in] Index of first entry to be retrieved */
411 UINT count, /* [in] Number of entries to be retrieved */
412 LPPALETTEENTRY entries) /* [out] Array receiving system-palette entries */
414 UINT ret = 0;
415 DC *dc;
417 TRACE("hdc=%p,start=%i,count=%i\n", hdc,start,count);
419 if ((dc = get_dc_ptr( hdc )))
421 PHYSDEV physdev = GET_DC_PHYSDEV( dc, pGetSystemPaletteEntries );
422 ret = physdev->funcs->pGetSystemPaletteEntries( physdev, start, count, entries );
423 release_dc_ptr( dc );
425 return ret;
429 /***********************************************************************
430 * GetNearestPaletteIndex [GDI32.@]
432 * Gets palette index for color.
434 * NOTES
435 * Should index be initialized to CLR_INVALID instead of 0?
437 * RETURNS
438 * Success: Index of entry in logical palette
439 * Failure: CLR_INVALID
441 UINT WINAPI GetNearestPaletteIndex(
442 HPALETTE hpalette, /* [in] Handle of logical color palette */
443 COLORREF color) /* [in] Color to be matched */
445 PALETTEOBJ* palObj = GDI_GetObjPtr( hpalette, OBJ_PAL );
446 UINT index = 0;
448 if( palObj )
450 int i, diff = 0x7fffffff;
451 int r,g,b;
452 PALETTEENTRY* entry = palObj->entries;
454 for( i = 0; i < palObj->count && diff ; i++, entry++)
456 r = entry->peRed - GetRValue(color);
457 g = entry->peGreen - GetGValue(color);
458 b = entry->peBlue - GetBValue(color);
460 r = r*r + g*g + b*b;
462 if( r < diff ) { index = i; diff = r; }
464 GDI_ReleaseObj( hpalette );
466 TRACE("(%p,%06x): returning %d\n", hpalette, color, index );
467 return index;
471 /* null driver fallback implementation for GetNearestColor */
472 COLORREF nulldrv_GetNearestColor( PHYSDEV dev, COLORREF color )
474 unsigned char spec_type;
476 if (!(GetDeviceCaps( dev->hdc, RASTERCAPS ) & RC_PALETTE)) return color;
478 spec_type = color >> 24;
479 if (spec_type == 1 || spec_type == 2)
481 /* we need logical palette for PALETTERGB and PALETTEINDEX colorrefs */
482 UINT index;
483 PALETTEENTRY entry;
484 HPALETTE hpal = GetCurrentObject( dev->hdc, OBJ_PAL );
486 if (!hpal) hpal = GetStockObject( DEFAULT_PALETTE );
487 if (spec_type == 2) /* PALETTERGB */
488 index = GetNearestPaletteIndex( hpal, color );
489 else /* PALETTEINDEX */
490 index = LOWORD(color);
492 if (!GetPaletteEntries( hpal, index, 1, &entry ))
494 WARN("RGB(%x) : idx %d is out of bounds, assuming NULL\n", color, index );
495 if (!GetPaletteEntries( hpal, 0, 1, &entry )) return CLR_INVALID;
497 color = RGB( entry.peRed, entry.peGreen, entry.peBlue );
499 return color & 0x00ffffff;
503 /***********************************************************************
504 * GetNearestColor [GDI32.@]
506 * Gets a system color to match.
508 * RETURNS
509 * Success: Color from system palette that corresponds to given color
510 * Failure: CLR_INVALID
512 COLORREF WINAPI GetNearestColor(
513 HDC hdc, /* [in] Handle of device context */
514 COLORREF color) /* [in] Color to be matched */
516 COLORREF nearest = CLR_INVALID;
517 DC *dc;
519 if ((dc = get_dc_ptr( hdc )))
521 PHYSDEV physdev = GET_DC_PHYSDEV( dc, pGetNearestColor );
522 nearest = physdev->funcs->pGetNearestColor( physdev, color );
523 release_dc_ptr( dc );
525 return nearest;
529 /***********************************************************************
530 * PALETTE_GetObject
532 static INT PALETTE_GetObject( HGDIOBJ handle, INT count, LPVOID buffer )
534 PALETTEOBJ *palette = GDI_GetObjPtr( handle, OBJ_PAL );
536 if (!palette) return 0;
538 if (buffer)
540 if (count > sizeof(WORD)) count = sizeof(WORD);
541 memcpy( buffer, &palette->count, count );
543 else count = sizeof(WORD);
544 GDI_ReleaseObj( handle );
545 return count;
549 /***********************************************************************
550 * PALETTE_UnrealizeObject
552 static BOOL PALETTE_UnrealizeObject( HGDIOBJ handle )
554 PALETTEOBJ *palette = GDI_GetObjPtr( handle, OBJ_PAL );
556 if (palette)
558 unrealize_function unrealize = palette->unrealize;
559 palette->unrealize = NULL;
560 GDI_ReleaseObj( handle );
561 if (unrealize) unrealize( handle );
564 if (InterlockedCompareExchangePointer( (void **)&hLastRealizedPalette, 0, handle ) == handle)
565 TRACE("unrealizing palette %p\n", handle);
567 return TRUE;
571 /***********************************************************************
572 * PALETTE_DeleteObject
574 static BOOL PALETTE_DeleteObject( HGDIOBJ handle )
576 PALETTEOBJ *obj;
578 PALETTE_UnrealizeObject( handle );
579 if (!(obj = free_gdi_handle( handle ))) return FALSE;
580 HeapFree( GetProcessHeap(), 0, obj->entries );
581 return HeapFree( GetProcessHeap(), 0, obj );
585 /***********************************************************************
586 * GDISelectPalette (Not a Windows API)
588 HPALETTE WINAPI GDISelectPalette( HDC hdc, HPALETTE hpal, WORD wBkg)
590 HPALETTE ret = 0;
591 DC *dc;
593 TRACE("%p %p\n", hdc, hpal );
595 hpal = get_full_gdi_handle( hpal );
596 if (GetObjectType(hpal) != OBJ_PAL)
598 WARN("invalid selected palette %p\n",hpal);
599 return 0;
601 if ((dc = get_dc_ptr( hdc )))
603 PHYSDEV physdev = GET_DC_PHYSDEV( dc, pSelectPalette );
604 ret = dc->hPalette;
605 if (physdev->funcs->pSelectPalette( physdev, hpal, FALSE ))
607 dc->hPalette = hpal;
608 if (!wBkg) hPrimaryPalette = hpal;
610 else ret = 0;
611 release_dc_ptr( dc );
613 return ret;
617 /***********************************************************************
618 * GDIRealizePalette (Not a Windows API)
620 UINT WINAPI GDIRealizePalette( HDC hdc )
622 UINT realized = 0;
623 DC* dc = get_dc_ptr( hdc );
625 if (!dc) return 0;
627 TRACE("%p...\n", hdc );
629 if( dc->hPalette == GetStockObject( DEFAULT_PALETTE ))
631 PHYSDEV physdev = GET_DC_PHYSDEV( dc, pRealizeDefaultPalette );
632 realized = physdev->funcs->pRealizeDefaultPalette( physdev );
634 else if (InterlockedExchangePointer( (void **)&hLastRealizedPalette, dc->hPalette ) != dc->hPalette)
636 PHYSDEV physdev = GET_DC_PHYSDEV( dc, pRealizePalette );
637 PALETTEOBJ *palPtr = GDI_GetObjPtr( dc->hPalette, OBJ_PAL );
638 if (palPtr)
640 realized = physdev->funcs->pRealizePalette( physdev, dc->hPalette,
641 (dc->hPalette == hPrimaryPalette) );
642 palPtr->unrealize = physdev->funcs->pUnrealizePalette;
643 GDI_ReleaseObj( dc->hPalette );
646 else TRACE(" skipping (hLastRealizedPalette = %p)\n", hLastRealizedPalette);
648 release_dc_ptr( dc );
649 TRACE(" realized %i colors.\n", realized );
650 return realized;
654 /***********************************************************************
655 * SelectPalette [GDI32.@]
657 * Selects logical palette into DC.
659 * RETURNS
660 * Success: Previous logical palette
661 * Failure: NULL
663 HPALETTE WINAPI SelectPalette(
664 HDC hDC, /* [in] Handle of device context */
665 HPALETTE hPal, /* [in] Handle of logical color palette */
666 BOOL bForceBackground) /* [in] Foreground/background mode */
668 return pfnSelectPalette( hDC, hPal, bForceBackground );
672 /***********************************************************************
673 * RealizePalette [GDI32.@]
675 * Maps palette entries to system palette.
677 * RETURNS
678 * Success: Number of entries in logical palette
679 * Failure: GDI_ERROR
681 UINT WINAPI RealizePalette(
682 HDC hDC) /* [in] Handle of device context */
684 return pfnRealizePalette( hDC );
688 typedef HWND (WINAPI *WindowFromDC_funcptr)( HDC );
689 typedef BOOL (WINAPI *RedrawWindow_funcptr)( HWND, const RECT *, HRGN, UINT );
691 /**********************************************************************
692 * UpdateColors [GDI32.@]
694 * Remaps current colors to logical palette.
696 * RETURNS
697 * Success: TRUE
698 * Failure: FALSE
700 BOOL WINAPI UpdateColors(
701 HDC hDC) /* [in] Handle of device context */
703 HMODULE mod;
704 int size = GetDeviceCaps( hDC, SIZEPALETTE );
706 if (!size) return FALSE;
708 mod = GetModuleHandleA("user32.dll");
709 if (mod)
711 WindowFromDC_funcptr pWindowFromDC = (WindowFromDC_funcptr)GetProcAddress(mod,"WindowFromDC");
712 if (pWindowFromDC)
714 HWND hWnd = pWindowFromDC( hDC );
716 /* Docs say that we have to remap current drawable pixel by pixel
717 * but it would take forever given the speed of XGet/PutPixel.
719 if (hWnd && size)
721 RedrawWindow_funcptr pRedrawWindow = (void *)GetProcAddress( mod, "RedrawWindow" );
722 if (pRedrawWindow) pRedrawWindow( hWnd, NULL, 0, RDW_INVALIDATE );
726 return TRUE;
729 /*********************************************************************
730 * SetMagicColors (GDI32.@)
732 BOOL WINAPI SetMagicColors(HDC hdc, ULONG u1, ULONG u2)
734 FIXME("(%p 0x%08x 0x%08x): stub\n", hdc, u1, u2);
735 return TRUE;