blob: a694bbc51a945abf94a9a44f36b342404b8fbe35 [file] [log] [blame]
// ImageOutputDev.h
// Copyright 1998-2003 Glyph & Cog, LLC
// 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) 2006 Rainer Keller <>
// Copyright (C) 2008 Timothy Lee <>
// Copyright (C) 2009 Carlos Garcia Campos <>
// Copyright (C) 2010 Jakob Voss <>
// Copyright (C) 2012, 2013 Adrian Johnson <>
// Copyright (C) 2013 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
#include "poppler/poppler-config.h"
#pragma interface
#include <stdio.h>
#include "goo/gtypes.h"
#include "goo/ImgWriter.h"
#include "OutputDev.h"
class GfxState;
// ImageOutputDev
class ImageOutputDev: public OutputDev {
enum ImageType {
enum ImageFormat {
// Create an OutputDev which will write images to files named
// <fileRoot>-NNN.<type> or <fileRoot>-PPP-NNN.<type>, if
// <pageNames> is set. Normally, all images are written as PBM
// (.pbm) or PPM (.ppm) files unless PNG or Tiff output is enabled
// (PNG is used if both are enabled). If Jpeg is enabled, JPEG images
// are written as JPEG (.jpg) files.
ImageOutputDev(char *fileRootA, GBool pageNamesA, GBool listImagesA);
// Destructor.
virtual ~ImageOutputDev();
// Use PNG format for output
void enablePNG(GBool png) { outputPNG = png; }
// Use TIFF format for output
void enableTiff(GBool tiff) { outputTiff = tiff; }
// Use Jpeg format for Jpeg files
void enableJpeg(GBool jpeg) { dumpJPEG = jpeg; }
// Use Jpeg2000 format for Jpeg2000 files
void enableJpeg2000(GBool jp2) { dumpJP2 = jp2; }
// Use JBIG2 format for JBIG2 files
void enableJBig2(GBool jbig2) { dumpJBIG2 = jbig2; }
// Use CCITT format for CCITT files
void enableCCITT(GBool ccitt) { dumpCCITT = ccitt; }
// Check if file was successfully created.
virtual GBool isOk() { return ok; }
// Does this device use tilingPatternFill()? If this returns false,
// tiling pattern fills will be reduced to a series of other drawing
// operations.
virtual GBool useTilingPatternFill() { return gTrue; }
// Does this device use beginType3Char/endType3Char? Otherwise,
// text in Type 3 fonts will be drawn with drawChar/drawString.
virtual GBool interpretType3Chars() { return gFalse; }
// Does this device need non-text content?
virtual GBool needNonText() { return gTrue; }
// Start a page
virtual void startPage(int pageNumA, GfxState *state, XRef *xref)
{ pageNum = pageNumA; }
//---- get info about output device
// Does this device use upside-down coordinates?
// (Upside-down means (0,0) is the top left corner of the page.)
virtual GBool upsideDown() { return gTrue; }
// Does this device use drawChar() or drawString()?
virtual GBool useDrawChar() { return gFalse; }
//----- path painting
virtual GBool tilingPatternFill(GfxState *state, Gfx *gfx, Catalog *cat, Object *str,
double *pmat, int paintType, int tilingType, Dict *resDict,
double *mat, double *bbox,
int x0, int y0, int x1, int y1,
double xStep, double yStep);
//----- image drawing
virtual void drawImageMask(GfxState *state, Object *ref, Stream *str,
int width, int height, GBool invert,
GBool interpolate, GBool inlineImg);
virtual void drawImage(GfxState *state, Object *ref, Stream *str,
int width, int height, GfxImageColorMap *colorMap,
GBool interpolate, int *maskColors, GBool inlineImg);
virtual void drawMaskedImage(GfxState *state, Object *ref, Stream *str,
int width, int height,
GfxImageColorMap *colorMap,
GBool interpolate,
Stream *maskStr, int maskWidth, int maskHeight,
GBool maskInvert, GBool maskInterpolate);
virtual void drawSoftMaskedImage(GfxState *state, Object *ref, Stream *str,
int width, int height,
GfxImageColorMap *colorMap,
GBool interpolate,
Stream *maskStr,
int maskWidth, int maskHeight,
GfxImageColorMap *maskColorMap,
GBool maskInterpolate);
// Sets the output filename with a given file extension
void setFilename(const char *fileExt);
void listImage(GfxState *state, Object *ref, Stream *str,
int width, int height,
GfxImageColorMap *colorMap,
GBool interpolate, GBool inlineImg,
ImageType imageType);
void writeImage(GfxState *state, Object *ref, Stream *str,
int width, int height, GfxImageColorMap *colorMap, GBool inlineImg);
void writeRawImage(Stream *str, const char *ext);
void writeImageFile(ImgWriter *writer, ImageFormat format, const char *ext,
Stream *str, int width, int height, GfxImageColorMap *colorMap);
char *fileRoot; // root of output file names
char *fileName; // buffer for output file names
GBool listImages; // list images instead of dumping
GBool dumpJPEG; // set to dump native JPEG files
GBool dumpJP2; // set to dump native JPEG2000 files
GBool dumpJBIG2; // set to dump native JBIG2 files
GBool dumpCCITT; // set to dump native CCITT files
GBool outputPNG; // set to output in PNG format
GBool outputTiff; // set to output in TIFF format
GBool pageNames; // set to include page number in file names
int pageNum; // current page number
int imgNum; // current image number
GBool ok; // set up ok?