blob: 70509abcfaa5198b165b0a286fa98a1d0fbd0dfc [file] [log] [blame]
// SplashBitmap.h
// Modified under the Poppler project -
// All changes made under the Poppler project to this file are licensed
// under GPL version 2 or later
// Copyright (C) 2007 Ilmari Heikkinen <>
// Copyright (C) 2009 Shen Liang <>
// Copyright (C) 2009, 2012 Albert Astals Cid <>
// Copyright (C) 2009 Stefan Thomas <>
// Copyright (C) 2010 Adrian Johnson <>
// Copyright (C) 2010 Harry Roberts <>
// Copyright (C) 2010 Christian Feuersänger <>
// Copyright (C) 2010 William Bader <>
// Copyright (C) 2012 Thomas Freitag <>
// To see a description of the changes please see the Changelog file that
// came with your tarball or type make ChangeLog if you are building from git
#pragma interface
#include "SplashTypes.h"
#include "poppler/GfxState.h"
#include <stdio.h>
class ImgWriter;
// SplashBitmap
class SplashBitmap {
// Create a new bitmap. It will have <widthA> x <heightA> pixels in
// color mode <modeA>. Rows will be padded out to a multiple of
// <rowPad> bytes. If <topDown> is false, the bitmap will be stored
// upside-down, i.e., with the last row first in memory.
SplashBitmap(int widthA, int heightA, int rowPad,
SplashColorMode modeA, GBool alphaA,
GBool topDown = gTrue, GooList *separationList = NULL);
static SplashBitmap *copy(SplashBitmap *src);
int getWidth() { return width; }
int getHeight() { return height; }
int getRowSize() { return rowSize; }
int getAlphaRowSize() { return width; }
int getRowPad() { return rowPad; }
SplashColorMode getMode() { return mode; }
SplashColorPtr getDataPtr() { return data; }
Guchar *getAlphaPtr() { return alpha; }
GooList *getSeparationList() { return separationList; }
SplashError writePNMFile(char *fileName);
SplashError writePNMFile(FILE *f);
SplashError writeAlphaPGMFile(char *fileName);
SplashError writeImgFile(SplashImageFileFormat format, char *fileName, int hDPI, int vDPI, const char *compressionString = "");
SplashError writeImgFile(SplashImageFileFormat format, FILE *f, int hDPI, int vDPI, const char *compressionString = "");
SplashError writeImgFile(ImgWriter *writer, FILE *f, int hDPI, int vDPI);
GBool convertToXBGR();
void getPixel(int x, int y, SplashColorPtr pixel);
void getRGBLine(int y, SplashColorPtr line);
void getXBGRLine(int y, SplashColorPtr line);
void getCMYKLine(int y, SplashColorPtr line);
Guchar getAlpha(int x, int y);
// Caller takes ownership of the bitmap data. The SplashBitmap
// object is no longer valid -- the next call should be to the
// destructor.
SplashColorPtr takeData();
int width, height; // size of bitmap
int rowPad;
int rowSize; // size of one row of data, in bytes
// - negative for bottom-up bitmaps
SplashColorMode mode; // color mode
SplashColorPtr data; // pointer to row zero of the color data
Guchar *alpha; // pointer to row zero of the alpha data
// (always top-down)
GooList *separationList; // list of spot colorants and their mapping functions
friend class Splash;