The "colors" parameter of SetDIBColorTable should be CONST.
[wine] / dlls / gdi / bitmap.c
1 /*
2  * GDI bitmap objects
3  *
4  * Copyright 1993 Alexandre Julliard
5  *           1998 Huw D M Davies
6  *
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.
11  *
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.
16  *
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  */
21
22 #include <stdlib.h>
23 #include <string.h>
24
25 #include "wine/winbase16.h"
26 #include "wine/winuser16.h"
27 #include "gdi.h"
28 #include "gdi_private.h"
29 #include "wine/debug.h"
30
31 WINE_DEFAULT_DEBUG_CHANNEL(bitmap);
32
33
34 static HGDIOBJ BITMAP_SelectObject( HGDIOBJ handle, void *obj, HDC hdc );
35 static INT BITMAP_GetObject16( HGDIOBJ handle, void *obj, INT count, LPVOID buffer );
36 static INT BITMAP_GetObject( HGDIOBJ handle, void *obj, INT count, LPVOID buffer );
37 static BOOL BITMAP_DeleteObject( HGDIOBJ handle, void *obj );
38
39 static const struct gdi_obj_funcs bitmap_funcs =
40 {
41     BITMAP_SelectObject,  /* pSelectObject */
42     BITMAP_GetObject16,   /* pGetObject16 */
43     BITMAP_GetObject,     /* pGetObjectA */
44     BITMAP_GetObject,     /* pGetObjectW */
45     NULL,                 /* pUnrealizeObject */
46     BITMAP_DeleteObject   /* pDeleteObject */
47 };
48
49 /***********************************************************************
50  *           BITMAP_GetWidthBytes
51  *
52  * Return number of bytes taken by a scanline of 16-bit aligned Windows DDB
53  * data.
54  */
55 static INT BITMAP_GetWidthBytes( INT bmWidth, INT bpp )
56 {
57     switch(bpp)
58     {
59     case 1:
60         return 2 * ((bmWidth+15) >> 4);
61
62     case 24:
63         bmWidth *= 3; /* fall through */
64     case 8:
65         return bmWidth + (bmWidth & 1);
66
67     case 32:
68         return bmWidth * 4;
69
70     case 16:
71     case 15:
72         return bmWidth * 2;
73
74     case 4:
75         return 2 * ((bmWidth+3) >> 2);
76
77     default:
78         WARN("Unknown depth %d, please report.\n", bpp );
79     }
80     return -1;
81 }
82
83
84 /******************************************************************************
85  * CreateBitmap [GDI32.@]
86  *
87  * Creates a bitmap with the specified info.
88  *
89  * PARAMS
90  *    width  [I] bitmap width
91  *    height [I] bitmap height
92  *    planes [I] Number of color planes
93  *    bpp    [I] Number of bits to identify a color
94  *    bits   [I] Pointer to array containing color data
95  *
96  * RETURNS
97  *    Success: Handle to bitmap
98  *    Failure: 0
99  */
100 HBITMAP WINAPI CreateBitmap( INT width, INT height, UINT planes,
101                                  UINT bpp, LPCVOID bits )
102 {
103     BITMAPOBJ *bmp;
104     HBITMAP hbitmap;
105
106     planes = (BYTE)planes;
107     bpp    = (BYTE)bpp;
108
109
110       /* Check parameters */
111     if (!height || !width)
112     {
113         height = 1;
114         width  = 1;
115         planes = 1;
116         bpp    = 1;
117     }
118     if (planes != 1) {
119         FIXME("planes = %d\n", planes);
120         return 0;
121     }
122     if (height < 0) height = -height;
123     if (width < 0) width = -width;
124
125       /* Create the BITMAPOBJ */
126     if (!(bmp = GDI_AllocObject( sizeof(BITMAPOBJ), BITMAP_MAGIC,
127                                  (HGDIOBJ *)&hbitmap, &bitmap_funcs )))
128         return 0;
129
130     TRACE("%dx%d, %d colors returning %p\n", width, height, 1 << (planes*bpp), hbitmap);
131
132     bmp->size.cx = 0;
133     bmp->size.cy = 0;
134     bmp->bitmap.bmType = 0;
135     bmp->bitmap.bmWidth = width;
136     bmp->bitmap.bmHeight = height;
137     bmp->bitmap.bmPlanes = planes;
138     bmp->bitmap.bmBitsPixel = bpp;
139     bmp->bitmap.bmWidthBytes = BITMAP_GetWidthBytes( width, bpp );
140     bmp->bitmap.bmBits = NULL;
141
142     bmp->funcs = NULL;
143     bmp->physBitmap = NULL;
144     bmp->dib = NULL;
145     bmp->segptr_bits = 0;
146
147     if (bits) /* Set bitmap bits */
148         SetBitmapBits( hbitmap, height * bmp->bitmap.bmWidthBytes,
149                          bits );
150     GDI_ReleaseObj( hbitmap );
151     return hbitmap;
152 }
153
154
155 /******************************************************************************
156  * CreateCompatibleBitmap [GDI32.@]
157  *
158  * Creates a bitmap compatible with the DC.
159  *
160  * PARAMS
161  *    hdc    [I] Handle to device context
162  *    width  [I] Width of bitmap
163  *    height [I] Height of bitmap
164  *
165  * RETURNS
166  *    Success: Handle to bitmap
167  *    Failure: 0
168  */
169 HBITMAP WINAPI CreateCompatibleBitmap( HDC hdc, INT width, INT height)
170 {
171     HBITMAP hbmpRet = 0;
172     DC *dc;
173
174     TRACE("(%p,%d,%d) = \n", hdc, width, height );
175     if (!(dc = DC_GetDCPtr( hdc ))) return 0;
176     if ((width >= 0x10000) || (height >= 0x10000)) {
177         FIXME("got bad width %d or height %d, please look for reason\n",
178               width, height );
179     }
180     else
181     {
182         INT planes, bpp;
183
184         if (GDIMAGIC( dc->header.wMagic ) != MEMORY_DC_MAGIC)
185         {
186             planes = GetDeviceCaps( hdc, PLANES );
187             bpp = GetDeviceCaps( hdc, BITSPIXEL );
188         }
189         else  /* memory DC, get the depth of the bitmap */
190         {
191             BITMAPOBJ *bmp = GDI_GetObjPtr( dc->hBitmap, BITMAP_MAGIC );
192             planes = bmp->bitmap.bmPlanes;
193             bpp = bmp->bitmap.bmBitsPixel;
194             GDI_ReleaseObj( dc->hBitmap );
195         }
196         hbmpRet = CreateBitmap( width, height, planes, bpp, NULL );
197     }
198     TRACE("\t\t%p\n", hbmpRet);
199     GDI_ReleaseObj(hdc);
200     return hbmpRet;
201 }
202
203
204 /******************************************************************************
205  * CreateBitmapIndirect [GDI32.@]
206  *
207  * Creates a bitmap with the specifies info.
208  *
209  * RETURNS
210  *    Success: Handle to bitmap
211  *    Failure: NULL
212  */
213 HBITMAP WINAPI CreateBitmapIndirect(
214     const BITMAP * bmp) /* [in] Pointer to the bitmap data */
215 {
216     return CreateBitmap( bmp->bmWidth, bmp->bmHeight, bmp->bmPlanes,
217                            bmp->bmBitsPixel, bmp->bmBits );
218 }
219
220
221 /***********************************************************************
222  * GetBitmapBits [GDI32.@]
223  *
224  * Copies bitmap bits of bitmap to buffer.
225  *
226  * RETURNS
227  *    Success: Number of bytes copied
228  *    Failure: 0
229  */
230 LONG WINAPI GetBitmapBits(
231     HBITMAP hbitmap, /* [in]  Handle to bitmap */
232     LONG count,        /* [in]  Number of bytes to copy */
233     LPVOID bits)       /* [out] Pointer to buffer to receive bits */
234 {
235     BITMAPOBJ *bmp = (BITMAPOBJ *) GDI_GetObjPtr( hbitmap, BITMAP_MAGIC );
236     LONG height, ret;
237
238     if (!bmp) return 0;
239
240     /* If the bits vector is null, the function should return the read size */
241     if(bits == NULL)
242     {
243         ret = bmp->bitmap.bmWidthBytes * bmp->bitmap.bmHeight;
244         goto done;
245     }
246
247     if (count < 0) {
248         WARN("(%ld): Negative number of bytes passed???\n", count );
249         count = -count;
250     }
251
252     /* Only get entire lines */
253     height = count / bmp->bitmap.bmWidthBytes;
254     if (height > bmp->bitmap.bmHeight) height = bmp->bitmap.bmHeight;
255     count = height * bmp->bitmap.bmWidthBytes;
256     if (count == 0)
257       {
258         WARN("Less than one entire line requested\n");
259         ret = 0;
260         goto done;
261       }
262
263
264     TRACE("(%p, %ld, %p) %dx%d %d colors fetched height: %ld\n",
265           hbitmap, count, bits, bmp->bitmap.bmWidth, bmp->bitmap.bmHeight,
266           1 << bmp->bitmap.bmBitsPixel, height );
267
268     if(bmp->funcs && bmp->funcs->pGetBitmapBits)
269     {
270         TRACE("Calling device specific BitmapBits\n");
271         ret = bmp->funcs->pGetBitmapBits(hbitmap, bits, count);
272     } else {
273
274         if(!bmp->bitmap.bmBits) {
275             WARN("Bitmap is empty\n");
276             ret = 0;
277         } else {
278             memcpy(bits, bmp->bitmap.bmBits, count);
279             ret = count;
280         }
281
282     }
283  done:
284     GDI_ReleaseObj( hbitmap );
285     return ret;
286 }
287
288
289 /******************************************************************************
290  * SetBitmapBits [GDI32.@]
291  *
292  * Sets bits of color data for a bitmap.
293  *
294  * RETURNS
295  *    Success: Number of bytes used in setting the bitmap bits
296  *    Failure: 0
297  */
298 LONG WINAPI SetBitmapBits(
299     HBITMAP hbitmap, /* [in] Handle to bitmap */
300     LONG count,        /* [in] Number of bytes in bitmap array */
301     LPCVOID bits)      /* [in] Address of array with bitmap bits */
302 {
303     BITMAPOBJ *bmp = (BITMAPOBJ *) GDI_GetObjPtr( hbitmap, BITMAP_MAGIC );
304     LONG height, ret;
305
306     if ((!bmp) || (!bits))
307         return 0;
308
309     if (count < 0) {
310         WARN("(%ld): Negative number of bytes passed???\n", count );
311         count = -count;
312     }
313
314     /* Only get entire lines */
315     height = count / bmp->bitmap.bmWidthBytes;
316     if (height > bmp->bitmap.bmHeight) height = bmp->bitmap.bmHeight;
317     count = height * bmp->bitmap.bmWidthBytes;
318
319     TRACE("(%p, %ld, %p) %dx%d %d colors fetched height: %ld\n",
320           hbitmap, count, bits, bmp->bitmap.bmWidth, bmp->bitmap.bmHeight,
321           1 << bmp->bitmap.bmBitsPixel, height );
322
323     if(bmp->funcs && bmp->funcs->pSetBitmapBits) {
324
325         TRACE("Calling device specific BitmapBits\n");
326         ret = bmp->funcs->pSetBitmapBits(hbitmap, bits, count);
327     } else {
328
329         if(!bmp->bitmap.bmBits) /* Alloc enough for entire bitmap */
330             bmp->bitmap.bmBits = HeapAlloc( GetProcessHeap(), 0, count );
331         if(!bmp->bitmap.bmBits) {
332             WARN("Unable to allocate bit buffer\n");
333             ret = 0;
334         } else {
335             memcpy(bmp->bitmap.bmBits, bits, count);
336             ret = count;
337         }
338     }
339
340     GDI_ReleaseObj( hbitmap );
341     return ret;
342 }
343
344 /**********************************************************************
345  *              BITMAP_CopyBitmap
346  *
347  */
348 HBITMAP BITMAP_CopyBitmap(HBITMAP hbitmap)
349 {
350     BITMAPOBJ *bmp = (BITMAPOBJ *) GDI_GetObjPtr( hbitmap, BITMAP_MAGIC );
351     HBITMAP res = 0;
352     BITMAP bm;
353
354     if(!bmp) return 0;
355
356     bm = bmp->bitmap;
357     bm.bmBits = NULL;
358     res = CreateBitmapIndirect(&bm);
359
360     if(res) {
361         char *buf = HeapAlloc( GetProcessHeap(), 0, bm.bmWidthBytes *
362                                bm.bmHeight );
363         GetBitmapBits (hbitmap, bm.bmWidthBytes * bm.bmHeight, buf);
364         SetBitmapBits (res, bm.bmWidthBytes * bm.bmHeight, buf);
365         HeapFree( GetProcessHeap(), 0, buf );
366     }
367
368     GDI_ReleaseObj( hbitmap );
369     return res;
370 }
371
372
373 /***********************************************************************
374  *           BITMAP_SetOwnerDC
375  *
376  * Set the type of DC that owns the bitmap. This is used when the
377  * bitmap is selected into a device to initialize the bitmap function
378  * table.
379  */
380 BOOL BITMAP_SetOwnerDC( HBITMAP hbitmap, DC *dc )
381 {
382     BITMAPOBJ *bitmap;
383     BOOL ret;
384
385     /* never set the owner of the stock bitmap since it can be selected in multiple DCs */
386     if (hbitmap == GetStockObject(DEFAULT_BITMAP)) return TRUE;
387
388     if (!(bitmap = GDI_GetObjPtr( hbitmap, BITMAP_MAGIC ))) return FALSE;
389
390     ret = TRUE;
391     if (!bitmap->funcs)  /* not owned by a DC yet */
392     {
393         if (dc->funcs->pCreateBitmap) ret = dc->funcs->pCreateBitmap( dc->physDev, hbitmap );
394         if (ret) bitmap->funcs = dc->funcs;
395     }
396     else if (bitmap->funcs != dc->funcs)
397     {
398         FIXME( "Trying to select bitmap %p in different DC type\n", hbitmap );
399         ret = FALSE;
400     }
401     GDI_ReleaseObj( hbitmap );
402     return ret;
403 }
404
405
406 /***********************************************************************
407  *           BITMAP_SelectObject
408  */
409 static HGDIOBJ BITMAP_SelectObject( HGDIOBJ handle, void *obj, HDC hdc )
410 {
411     HGDIOBJ ret;
412     BITMAPOBJ *bitmap = obj;
413     DC *dc = DC_GetDCPtr( hdc );
414
415     if (!dc) return 0;
416     if (GetObjectType( hdc ) != OBJ_MEMDC)
417     {
418         GDI_ReleaseObj( hdc );
419         return 0;
420     }
421     ret = dc->hBitmap;
422     if (handle == dc->hBitmap) goto done;  /* nothing to do */
423
424     if (bitmap->header.dwCount && (handle != GetStockObject(DEFAULT_BITMAP)))
425     {
426         WARN( "Bitmap already selected in another DC\n" );
427         GDI_ReleaseObj( hdc );
428         return 0;
429     }
430
431     if (!bitmap->funcs && !BITMAP_SetOwnerDC( handle, dc ))
432     {
433         GDI_ReleaseObj( hdc );
434         return 0;
435     }
436
437     if (dc->funcs->pSelectBitmap) handle = dc->funcs->pSelectBitmap( dc->physDev, handle );
438
439     if (handle)
440     {
441         dc->hBitmap = handle;
442         dc->flags &= ~DC_DIRTY;
443         SetRectRgn( dc->hVisRgn, 0, 0, bitmap->bitmap.bmWidth, bitmap->bitmap.bmHeight);
444         DC_InitDC( dc );
445     }
446     else ret = 0;
447
448  done:
449     GDI_ReleaseObj( hdc );
450     return ret;
451 }
452
453
454 /***********************************************************************
455  *           BITMAP_DeleteObject
456  */
457 static BOOL BITMAP_DeleteObject( HGDIOBJ handle, void *obj )
458 {
459     BITMAPOBJ * bmp = obj;
460
461     if (bmp->funcs && bmp->funcs->pDeleteBitmap)
462         bmp->funcs->pDeleteBitmap( handle );
463
464     if( bmp->bitmap.bmBits )
465         HeapFree( GetProcessHeap(), 0, bmp->bitmap.bmBits );
466
467     if (bmp->dib)
468     {
469         DIBSECTION *dib = bmp->dib;
470
471         if (dib->dsBm.bmBits)
472         {
473             if (dib->dshSection)
474             {
475                 SYSTEM_INFO SystemInfo;
476                 GetSystemInfo( &SystemInfo );
477                 UnmapViewOfFile( (char *)dib->dsBm.bmBits -
478                                  (dib->dsOffset % SystemInfo.dwAllocationGranularity) );
479             }
480             else if (!dib->dsOffset)
481                 VirtualFree(dib->dsBm.bmBits, 0L, MEM_RELEASE );
482         }
483         HeapFree(GetProcessHeap(), 0, dib);
484         bmp->dib = NULL;
485         if (bmp->segptr_bits)
486         { /* free its selector array */
487             WORD sel = SELECTOROF(bmp->segptr_bits);
488             WORD count = (GetSelectorLimit16(sel) / 0x10000) + 1;
489             int i;
490
491             for (i = 0; i < count; i++) FreeSelector16(sel + (i << __AHSHIFT));
492         }
493     }
494     return GDI_FreeObject( handle, obj );
495 }
496
497
498 /***********************************************************************
499  *           BITMAP_GetObject16
500  */
501 static INT BITMAP_GetObject16( HGDIOBJ handle, void *obj, INT count, LPVOID buffer )
502 {
503     BITMAPOBJ *bmp = obj;
504
505     if (bmp->dib)
506     {
507         if ( count <= sizeof(BITMAP16) )
508         {
509             BITMAP *bmp32 = &bmp->dib->dsBm;
510             BITMAP16 bmp16;
511             bmp16.bmType       = bmp32->bmType;
512             bmp16.bmWidth      = bmp32->bmWidth;
513             bmp16.bmHeight     = bmp32->bmHeight;
514             bmp16.bmWidthBytes = bmp32->bmWidthBytes;
515             bmp16.bmPlanes     = bmp32->bmPlanes;
516             bmp16.bmBitsPixel  = bmp32->bmBitsPixel;
517             bmp16.bmBits       = (SEGPTR)0;
518             memcpy( buffer, &bmp16, count );
519             return count;
520         }
521         else
522         {
523             FIXME("not implemented for DIBs: count %d\n", count);
524             return 0;
525         }
526     }
527     else
528     {
529         BITMAP16 bmp16;
530         bmp16.bmType       = bmp->bitmap.bmType;
531         bmp16.bmWidth      = bmp->bitmap.bmWidth;
532         bmp16.bmHeight     = bmp->bitmap.bmHeight;
533         bmp16.bmWidthBytes = bmp->bitmap.bmWidthBytes;
534         bmp16.bmPlanes     = bmp->bitmap.bmPlanes;
535         bmp16.bmBitsPixel  = bmp->bitmap.bmBitsPixel;
536         bmp16.bmBits       = (SEGPTR)0;
537         if (count > sizeof(bmp16)) count = sizeof(bmp16);
538         memcpy( buffer, &bmp16, count );
539         return count;
540     }
541 }
542
543
544 /***********************************************************************
545  *           BITMAP_GetObject
546  */
547 static INT BITMAP_GetObject( HGDIOBJ handle, void *obj, INT count, LPVOID buffer )
548 {
549     BITMAPOBJ *bmp = obj;
550
551     if (bmp->dib)
552     {
553         if( !buffer )
554             return sizeof(DIBSECTION);
555         if (count < sizeof(DIBSECTION))
556         {
557             if (count > sizeof(BITMAP)) count = sizeof(BITMAP);
558         }
559         else
560         {
561             if (count > sizeof(DIBSECTION)) count = sizeof(DIBSECTION);
562         }
563
564         memcpy( buffer, bmp->dib, count );
565         return count;
566     }
567     else
568     {
569         if( !buffer )
570             return sizeof(BITMAP);
571         if (count > sizeof(BITMAP)) count = sizeof(BITMAP);
572         memcpy( buffer, &bmp->bitmap, count );
573         return count;
574     }
575 }
576
577
578 /******************************************************************************
579  * CreateDiscardableBitmap [GDI32.@]
580  *
581  * Creates a discardable bitmap.
582  *
583  * RETURNS
584  *    Success: Handle to bitmap
585  *    Failure: NULL
586  */
587 HBITMAP WINAPI CreateDiscardableBitmap(
588     HDC hdc,    /* [in] Handle to device context */
589     INT width,  /* [in] Bitmap width */
590     INT height) /* [in] Bitmap height */
591 {
592     return CreateCompatibleBitmap( hdc, width, height );
593 }
594
595
596 /******************************************************************************
597  * GetBitmapDimensionEx [GDI32.@]
598  *
599  * Retrieves dimensions of a bitmap.
600  *
601  * RETURNS
602  *    Success: TRUE
603  *    Failure: FALSE
604  */
605 BOOL WINAPI GetBitmapDimensionEx(
606     HBITMAP hbitmap, /* [in]  Handle to bitmap */
607     LPSIZE size)     /* [out] Address of struct receiving dimensions */
608 {
609     BITMAPOBJ * bmp = (BITMAPOBJ *) GDI_GetObjPtr( hbitmap, BITMAP_MAGIC );
610     if (!bmp) return FALSE;
611     *size = bmp->size;
612     GDI_ReleaseObj( hbitmap );
613     return TRUE;
614 }
615
616
617 /******************************************************************************
618  * SetBitmapDimensionEx [GDI32.@]
619  *
620  * Assigns dimensions to a bitmap.
621  *
622  * RETURNS
623  *    Success: TRUE
624  *    Failure: FALSE
625  */
626 BOOL WINAPI SetBitmapDimensionEx(
627     HBITMAP hbitmap, /* [in]  Handle to bitmap */
628     INT x,           /* [in]  Bitmap width */
629     INT y,           /* [in]  Bitmap height */
630     LPSIZE prevSize) /* [out] Address of structure for orig dims */
631 {
632     BITMAPOBJ * bmp = (BITMAPOBJ *) GDI_GetObjPtr( hbitmap, BITMAP_MAGIC );
633     if (!bmp) return FALSE;
634     if (prevSize) *prevSize = bmp->size;
635     bmp->size.cx = x;
636     bmp->size.cy = y;
637     GDI_ReleaseObj( hbitmap );
638     return TRUE;
639 }