include/vcl/bitmapaccess.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_VCL_BMPACC_HXX
  21 #define INCLUDED_VCL_BMPACC_HXX
  22
  23 #include <memory>
  24 #include <tools/solar.h>
  25 #include <vcl/dllapi.h>
  26 #include <vcl/salbtype.hxx>
  27 #include <vcl/bitmap.hxx>
  28
  29 typedef BitmapColor (*FncGetPixel)(ConstScanline pScanline, long nX, const ColorMask& rMask);
  30 typedef void (*FncSetPixel)(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
  31
  32
  33 class VCL_DLLPUBLIC BitmapInfoAccess
  34 {
  35     friend class BitmapReadAccess;
  36
  37 public:
  38     BitmapInfoAccess(Bitmap& rBitmap);
  39     virtual ~BitmapInfoAccess();
  40
  41     bool operator!() const
  42     {
  43         return mpBuffer == nullptr;
  44     }
  45
  46     long Width() const
  47     {
  48         return mpBuffer ? mpBuffer->mnWidth : 0L;
  49     }
  50
  51     long Height() const
  52     {
  53         return mpBuffer ? mpBuffer->mnHeight : 0L;
  54     }
  55
  56     bool IsTopDown() const
  57     {
  58         assert(mpBuffer && "Access is not valid!");
  59
  60         return mpBuffer && (mpBuffer->mnFormat & ScanlineFormat::TopDown);
  61     }
  62
  63     bool IsBottomUp() const
  64     {
  65         return !IsTopDown();
  66     }
  67
  68     ScanlineFormat GetScanlineFormat() const
  69     {
  70         assert(mpBuffer && "Access is not valid!");
  71
  72         return mpBuffer ? RemoveScanline(mpBuffer->mnFormat) : ScanlineFormat::NONE;
  73     }
  74
  75     sal_uLong GetScanlineSize() const
  76     {
  77         assert(mpBuffer && "Access is not valid!");
  78
  79         return mpBuffer ? mpBuffer->mnScanlineSize : 0UL;
  80     }
  81
  82     sal_uInt16 GetBitCount() const
  83     {
  84         assert(mpBuffer && "Access is not valid!");
  85
  86         return mpBuffer ? mpBuffer->mnBitCount : 0;
  87     }
  88
  89     BitmapColor GetBestMatchingColor(const BitmapColor& rBitmapColor)
  90     {
  91         if (HasPalette())
  92             return BitmapColor((sal_uInt8) GetBestPaletteIndex(rBitmapColor));
  93         else
  94             return rBitmapColor;
  95     }
  96
  97     bool HasPalette() const
  98     {
  99         assert(mpBuffer && "Access is not valid!");
 100
 101         return mpBuffer && !!mpBuffer->maPalette;
 102     }
 103
 104     const BitmapPalette& GetPalette() const
 105     {
 106         assert(mpBuffer && "Access is not valid!");
 107
 108         return mpBuffer->maPalette;
 109     }
 110
 111     sal_uInt16 GetPaletteEntryCount() const
 112     {
 113         assert(HasPalette() && "Bitmap has no palette!");
 114
 115         return HasPalette() ? mpBuffer->maPalette.GetEntryCount() : 0;
 116     }
 117
 118     const BitmapColor& GetPaletteColor( sal_uInt16 nColor ) const
 119     {
 120         assert(mpBuffer && "Access is not valid!");
 121         assert(HasPalette() && "Bitmap has no palette!");
 122
 123         return mpBuffer->maPalette[nColor];
 124     }
 125
 126     const BitmapColor& GetBestPaletteColor(const BitmapColor& rBitmapColor) const
 127     {
 128         return GetPaletteColor(GetBestPaletteIndex(rBitmapColor));
 129     }
 130
 131     sal_uInt16 GetBestPaletteIndex(const BitmapColor& rBitmapColor) const;
 132
 133     ColorMask& GetColorMask() const
 134     {
 135         assert(mpBuffer && "Access is not valid!");
 136
 137         return mpBuffer->maColorMask;
 138     }
 139
 140 private:
 141     BitmapInfoAccess(const BitmapInfoAccess&) = delete;
 142     BitmapInfoAccess& operator=(const BitmapInfoAccess&) = delete;
 143
 144 protected:
 145     Bitmap maBitmap;
 146     BitmapBuffer* mpBuffer;
 147     ColorMask maColorMask;
 148     BitmapAccessMode mnAccessMode;
 149
 150     SAL_DLLPRIVATE void ImplCreate(Bitmap& rBitmap);
 151     SAL_DLLPRIVATE void ImplDestroy();
 152
 153 protected:
 154     BitmapInfoAccess(Bitmap& rBitmap, BitmapAccessMode nMode);
 155 };
 156
 157
 158 class VCL_DLLPUBLIC BitmapReadAccess : public BitmapInfoAccess
 159 {
 160     friend class BitmapWriteAccess;
 161
 162 public:
 163     BitmapReadAccess(Bitmap& rBitmap);
 164     virtual ~BitmapReadAccess() override;
 165
 166     Scanline GetBuffer() const
 167     {
 168         assert(mpBuffer && "Access is not valid!");
 169
 170         return mpBuffer ? mpBuffer->mpBits : nullptr;
 171     }
 172
 173     Scanline GetScanline(long nY) const
 174     {
 175         assert(mpBuffer && "Access is not valid!");
 176         assert(nY < mpBuffer->mnHeight && "y-coordinate out of range!");
 177
 178         if (mpBuffer->mnFormat & ScanlineFormat::TopDown)
 179         {
 180             return mpBuffer->mpBits + (nY * mpBuffer->mnScanlineSize);
 181         }
 182         return mpBuffer->mpBits + ((mpBuffer->mnHeight - 1 - nY) * mpBuffer->mnScanlineSize);
 183     }
 184
 185     BitmapColor GetPixelFromData(const sal_uInt8* pData, long nX) const
 186     {
 187         assert(pData && "Access is not valid!");
 188
 189         return mFncGetPixel( pData, nX, maColorMask );
 190     }
 191
 192     void SetPixelOnData(sal_uInt8* pData, long nX, const BitmapColor& rBitmapColor)
 193     {
 194         assert(pData && "Access is not valid!");
 195
 196         mFncSetPixel(pData, nX, rBitmapColor, maColorMask);
 197     }
 198
 199     BitmapColor GetPixel(long nY, long nX) const
 200     {
 201         assert(mpBuffer && "Access is not valid!");
 202         assert(nX < mpBuffer->mnWidth && "x-coordinate out of range!");
 203         assert(nY < mpBuffer->mnHeight && "y-coordinate out of range!");
 204
 205         return mFncGetPixel(GetScanline(nY), nX, maColorMask );
 206     }
 207
 208     BitmapColor GetColor(long nY, long nX) const
 209     {
 210         if (HasPalette())
 211             return mpBuffer->maPalette[GetPixelIndex(nY, nX)];
 212         else
 213             return GetPixel(nY, nX);
 214     }
 215
 216     sal_uInt8 GetPixelIndex(long nY, long nX) const
 217     {
 218         return GetPixel(nY, nX).GetBlueOrIndex();
 219     }
 220
 221     sal_uInt8 GetLuminance(long nY, long nX) const
 222     {
 223         return GetColor(nY, nX).GetLuminance();
 224     }
 225
 226     /** Get the interpolated color at coordinates fY, fX; if outside, return rFallback */
 227     BitmapColor GetInterpolatedColorWithFallback( double fY, double fX, const BitmapColor& rFallback ) const;
 228
 229     /** Get the color at coordinates fY, fX; if outside, return rFallback. Automatically does the correct
 230         inside/outside checks, e.g. static_cast< sal_uInt32 >(-0.25) *is* 0, not -1 and has to be outside */
 231     BitmapColor GetColorWithFallback( double fY, double fX, const BitmapColor& rFallback ) const;
 232
 233 private:
 234     BitmapReadAccess(const BitmapReadAccess&) = delete;
 235     BitmapReadAccess& operator=(const BitmapReadAccess&) = delete;
 236
 237 protected:
 238     FncGetPixel mFncGetPixel;
 239     FncSetPixel mFncSetPixel;
 240
 241     SAL_DLLPRIVATE void ImplInitScanBuffer( Bitmap& rBitmap );
 242     SAL_DLLPRIVATE bool ImplSetAccessPointers( ScanlineFormat nFormat );
 243
 244 public:
 245
 246     SAL_DLLPRIVATE BitmapBuffer* ImplGetBitmapBuffer() const
 247     {
 248         return mpBuffer;
 249     }
 250
 251     static BitmapColor GetPixelForN1BitMsbPal(ConstScanline pScanline, long nX, const ColorMask& rMask);
 252     static BitmapColor GetPixelForN1BitLsbPal(ConstScanline pScanline, long nX, const ColorMask& rMask);
 253     static BitmapColor GetPixelForN4BitMsnPal(ConstScanline pScanline, long nX, const ColorMask& rMask);
 254     static BitmapColor GetPixelForN4BitLsnPal(ConstScanline pScanline, long nX, const ColorMask& rMask);
 255     static BitmapColor GetPixelForN8BitPal(ConstScanline pScanline, long nX, const ColorMask& rMask);
 256     static BitmapColor GetPixelForN8BitTcMask(ConstScanline pScanline, long nX, const ColorMask& rMask);
 257     static BitmapColor GetPixelForN16BitTcMsbMask(ConstScanline pScanline, long nX, const ColorMask& rMask);
 258     static BitmapColor GetPixelForN16BitTcLsbMask(ConstScanline pScanline, long nX, const ColorMask& rMask);
 259     static BitmapColor GetPixelForN24BitTcBgr(ConstScanline pScanline, long nX, const ColorMask& rMask);
 260     static BitmapColor GetPixelForN24BitTcRgb(ConstScanline pScanline, long nX, const ColorMask& rMask);
 261     static BitmapColor GetPixelForN32BitTcAbgr(ConstScanline pScanline, long nX, const ColorMask& rMask);
 262     static BitmapColor GetPixelForN32BitTcArgb(ConstScanline pScanline, long nX, const ColorMask& rMask);
 263     static BitmapColor GetPixelForN32BitTcBgra(ConstScanline pScanline, long nX, const ColorMask& rMask);
 264     static BitmapColor GetPixelForN32BitTcRgba(ConstScanline pScanline, long nX, const ColorMask& rMask);
 265     static BitmapColor GetPixelForN32BitTcMask(ConstScanline pScanline, long nX, const ColorMask& rMask);
 266
 267     static void SetPixelForN1BitMsbPal(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
 268     static void SetPixelForN1BitLsbPal(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
 269     static void SetPixelForN4BitMsnPal(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
 270     static void SetPixelForN4BitLsnPal(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
 271     static void SetPixelForN8BitPal(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
 272     static void SetPixelForN8BitTcMask(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
 273     static void SetPixelForN16BitTcMsbMask(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
 274     static void SetPixelForN16BitTcLsbMask(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
 275     static void SetPixelForN24BitTcBgr(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
 276     static void SetPixelForN24BitTcRgb(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
 277     static void SetPixelForN32BitTcAbgr(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
 278     static void SetPixelForN32BitTcArgb(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
 279     static void SetPixelForN32BitTcBgra(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
 280     static void SetPixelForN32BitTcRgba(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
 281     static void SetPixelForN32BitTcMask(Scanline pScanline, long nX, const BitmapColor& rBitmapColor, const ColorMask& rMask);
 282
 283 protected:
 284     BitmapReadAccess(Bitmap& rBitmap, BitmapAccessMode nMode);
 285 };
 286
 287
 288 class VCL_DLLPUBLIC BitmapWriteAccess : public BitmapReadAccess
 289 {
 290 public:
 291     BitmapWriteAccess(Bitmap& rBitmap);
 292     virtual ~BitmapWriteAccess() override;
 293
 294     void CopyScanline(long nY, const BitmapReadAccess& rReadAcc);
 295     void CopyScanline(long nY,
 296                       ConstScanline aSrcScanline,
 297                       ScanlineFormat nSrcScanlineFormat,
 298                       sal_uLong nSrcScanlineSize);
 299
 300     void CopyBuffer( const BitmapReadAccess& rReadAcc );
 301
 302     void SetPalette(const BitmapPalette& rPalette)
 303     {
 304         assert(mpBuffer && "Access is not valid!");
 305
 306         mpBuffer->maPalette = rPalette;
 307     }
 308
 309     void SetPaletteEntryCount(sal_uInt16 nCount)
 310     {
 311         assert(mpBuffer && "Access is not valid!");
 312
 313         mpBuffer->maPalette.SetEntryCount(nCount);
 314     }
 315
 316     void SetPaletteColor(sal_uInt16 nColor, const BitmapColor& rBitmapColor)
 317     {
 318         assert(mpBuffer && "Access is not valid!");
 319         assert(HasPalette() && "Bitmap has no palette!");
 320
 321         mpBuffer->maPalette[nColor] = rBitmapColor;
 322     }
 323
 324     void SetPixel(long nY, long nX, const BitmapColor& rBitmapColor)
 325     {
 326         assert(mpBuffer && "Access is not valid!");
 327         assert(nX < mpBuffer->mnWidth && "x-coordinate out of range!");
 328         assert(nY < mpBuffer->mnHeight && "y-coordinate out of range!");
 329
 330         mFncSetPixel(GetScanline(nY), nX, rBitmapColor, maColorMask);
 331     }
 332
 333     void SetPixelIndex(long nY, long nX, sal_uInt8 cIndex)
 334     {
 335         SetPixel(nY, nX, BitmapColor(cIndex));
 336     }
 337
 338     void SetLineColor(const Color& rColor);
 339
 340     void SetFillColor();
 341     void SetFillColor(const Color& rColor);
 342
 343     void Erase(const Color& rColor);
 344
 345     void DrawLine(const Point& rStart, const Point& rEnd);
 346
 347     void FillRect(const tools::Rectangle& rRect);
 348     void DrawRect(const tools::Rectangle& rRect);
 349
 350 private:
 351
 352     std::unique_ptr<BitmapColor> mpLineColor;
 353     std::unique_ptr<BitmapColor> mpFillColor;
 354
 355     BitmapWriteAccess() = delete;
 356     BitmapWriteAccess(const BitmapWriteAccess&) = delete;
 357     BitmapWriteAccess& operator=(const BitmapWriteAccess&) = delete;
 358 };
 359
 360 #endif // INCLUDED_VCL_BMPACC_HXX
 361
 362 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */