281 lines
11 KiB
C++
281 lines
11 KiB
C++
/*
|
|
* Copyright 2013 Google Inc.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license that can be
|
|
* found in the LICENSE file.
|
|
*/
|
|
|
|
#ifndef SkDocument_DEFINED
|
|
#define SkDocument_DEFINED
|
|
|
|
#include "SkBitmap.h"
|
|
#include "SkPicture.h"
|
|
#include "SkPixelSerializer.h"
|
|
#include "SkRect.h"
|
|
#include "SkRefCnt.h"
|
|
#include "SkString.h"
|
|
#include "SkTime.h"
|
|
|
|
class SkCanvas;
|
|
class SkWStream;
|
|
|
|
#define SK_SUPPORT_LEGACY_DOCUMENT_API
|
|
|
|
/** SK_ScalarDefaultDPI is 72 DPI.
|
|
*/
|
|
#define SK_ScalarDefaultRasterDPI 72.0f
|
|
|
|
/**
|
|
* High-level API for creating a document-based canvas. To use..
|
|
*
|
|
* 1. Create a document, specifying a stream to store the output.
|
|
* 2. For each "page" of content:
|
|
* a. canvas = doc->beginPage(...)
|
|
* b. draw_my_content(canvas);
|
|
* c. doc->endPage();
|
|
* 3. Close the document with doc->close().
|
|
*/
|
|
class SK_API SkDocument : public SkRefCnt {
|
|
public:
|
|
struct OptionalTimestamp {
|
|
SkTime::DateTime fDateTime;
|
|
bool fEnabled;
|
|
OptionalTimestamp() : fEnabled(false) {}
|
|
};
|
|
|
|
/**
|
|
* Optional metadata to be passed into the PDF factory function.
|
|
*/
|
|
struct PDFMetadata {
|
|
SkString fTitle;
|
|
SkString fAuthor;
|
|
SkString fSubject;
|
|
SkString fKeywords;
|
|
SkString fCreator;
|
|
OptionalTimestamp fCreation;
|
|
OptionalTimestamp fModified;
|
|
};
|
|
|
|
/**
|
|
* Create a PDF-backed document, writing the results into a
|
|
* SkWStream.
|
|
*
|
|
* PDF pages are sized in point units. 1 pt == 1/72 inch ==
|
|
* 127/360 mm.
|
|
*
|
|
* @param stream A PDF document will be written to this
|
|
* stream. The document may write to the stream at
|
|
* anytime during its lifetime, until either close() is
|
|
* called or the document is deleted.
|
|
* @param dpi The DPI (pixels-per-inch) at which features without
|
|
* native PDF support will be rasterized (e.g. draw image
|
|
* with perspective, draw text with perspective, ...) A
|
|
* larger DPI would create a PDF that reflects the
|
|
* original intent with better fidelity, but it can make
|
|
* for larger PDF files too, which would use more memory
|
|
* while rendering, and it would be slower to be processed
|
|
* or sent online or to printer.
|
|
* @param metadata a PDFmetadata object. Any fields may be left
|
|
* empty.
|
|
* @param jpegEncoder For PDF documents, if a jpegEncoder is set,
|
|
* use it to encode SkImages and SkBitmaps as [JFIF]JPEGs.
|
|
* This feature is deprecated and is only supplied for
|
|
* backwards compatability.
|
|
* The prefered method to create PDFs with JPEG images is
|
|
* to use SkImage::NewFromEncoded() and not jpegEncoder.
|
|
* Chromium uses NewFromEncoded.
|
|
* If the encoder is unset, or if jpegEncoder->onEncode()
|
|
* returns NULL, fall back on encoding images losslessly
|
|
* with Deflate.
|
|
* @param pdfa Iff true, include XMP metadata, a document UUID,
|
|
* and sRGB output intent information. This adds length
|
|
* to the document and makes it non-reproducable, but are
|
|
* necessary features for PDF/A-2b conformance
|
|
*
|
|
* @returns NULL if there is an error, otherwise a newly created
|
|
* PDF-backed SkDocument.
|
|
*/
|
|
static sk_sp<SkDocument> MakePDF(SkWStream* stream,
|
|
SkScalar dpi,
|
|
const SkDocument::PDFMetadata& metadata,
|
|
sk_sp<SkPixelSerializer> jpegEncoder,
|
|
bool pdfa);
|
|
|
|
static sk_sp<SkDocument> MakePDF(SkWStream* stream,
|
|
SkScalar dpi = SK_ScalarDefaultRasterDPI) {
|
|
return SkDocument::MakePDF(stream, dpi, SkDocument::PDFMetadata(),
|
|
nullptr, false);
|
|
}
|
|
|
|
/**
|
|
* Create a PDF-backed document, writing the results into a file.
|
|
*/
|
|
static sk_sp<SkDocument> MakePDF(const char outputFilePath[],
|
|
SkScalar dpi = SK_ScalarDefaultRasterDPI);
|
|
|
|
/**
|
|
* Create a XPS-backed document, writing the results into the stream.
|
|
* Returns NULL if XPS is not supported.
|
|
*/
|
|
static sk_sp<SkDocument> MakeXPS(SkWStream* stream,
|
|
SkScalar dpi = SK_ScalarDefaultRasterDPI);
|
|
|
|
/**
|
|
* Create a XPS-backed document, writing the results into a file.
|
|
* Returns NULL if XPS is not supported.
|
|
*/
|
|
static sk_sp<SkDocument> MakeXPS(const char path[],
|
|
SkScalar dpi = SK_ScalarDefaultRasterDPI);
|
|
|
|
#ifdef SK_SUPPORT_LEGACY_DOCUMENT_API
|
|
|
|
/**
|
|
* Create a PDF-backed document, writing the results into a SkWStream.
|
|
*
|
|
* PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm.
|
|
*
|
|
* @param SkWStream* A PDF document will be written to this
|
|
* stream. The document may write to the stream at
|
|
* anytime during its lifetime, until either close() is
|
|
* called or the document is deleted.
|
|
* @param dpi The DPI (pixels-per-inch) at which features without
|
|
* native PDF support will be rasterized (e.g. draw image
|
|
* with perspective, draw text with perspective, ...) A
|
|
* larger DPI would create a PDF that reflects the
|
|
* original intent with better fidelity, but it can make
|
|
* for larger PDF files too, which would use more memory
|
|
* while rendering, and it would be slower to be processed
|
|
* or sent online or to printer.
|
|
* @returns NULL if there is an error, otherwise a newly created
|
|
* PDF-backed SkDocument.
|
|
*/
|
|
static SkDocument* CreatePDF(SkWStream* stream,
|
|
SkScalar dpi = SK_ScalarDefaultRasterDPI) {
|
|
return SkDocument::MakePDF(stream, dpi, SkDocument::PDFMetadata(),
|
|
nullptr, false).release();
|
|
}
|
|
|
|
/**
|
|
* @param jpegEncoder For PDF documents, if a jpegEncoder is set,
|
|
* use it to encode SkImages and SkBitmaps as [JFIF]JPEGs.
|
|
* This feature is deprecated and is only supplied for
|
|
* backwards compatability.
|
|
*
|
|
* The prefered method to create PDFs with JPEG images is
|
|
* to use SkImage::NewFromEncoded() and not jpegEncoder.
|
|
* Chromium uses NewFromEncoded.
|
|
*
|
|
* If the encoder is unset, or if jpegEncoder->onEncode()
|
|
* returns NULL, fall back on encoding images losslessly
|
|
* with Deflate.
|
|
*/
|
|
static SkDocument* CreatePDF(SkWStream* stream,
|
|
SkScalar dpi,
|
|
SkPixelSerializer* jpegEncoder) {
|
|
return SkDocument::MakePDF(stream, dpi, SkDocument::PDFMetadata(),
|
|
sk_ref_sp(jpegEncoder), false).release();
|
|
}
|
|
|
|
/**
|
|
* Create a PDF-backed document, writing the results into a file.
|
|
*/
|
|
static SkDocument* CreatePDF(const char outputFilePath[],
|
|
SkScalar dpi = SK_ScalarDefaultRasterDPI) {
|
|
return SkDocument::MakePDF(outputFilePath, dpi).release();
|
|
}
|
|
|
|
#endif // SK_SUPPORT_LEGACY_DOCUMENT_API
|
|
|
|
/**
|
|
* Begin a new page for the document, returning the canvas that will draw
|
|
* into the page. The document owns this canvas, and it will go out of
|
|
* scope when endPage() or close() is called, or the document is deleted.
|
|
*/
|
|
SkCanvas* beginPage(SkScalar width, SkScalar height,
|
|
const SkRect* content = NULL);
|
|
|
|
/**
|
|
* Call endPage() when the content for the current page has been drawn
|
|
* (into the canvas returned by beginPage()). After this call the canvas
|
|
* returned by beginPage() will be out-of-scope.
|
|
*/
|
|
void endPage();
|
|
|
|
/**
|
|
* Call close() when all pages have been drawn. This will close the file
|
|
* or stream holding the document's contents. After close() the document
|
|
* can no longer add new pages. Deleting the document will automatically
|
|
* call close() if need be.
|
|
* Returns true on success or false on failure.
|
|
*/
|
|
bool close();
|
|
|
|
/**
|
|
* Call abort() to stop producing the document immediately.
|
|
* The stream output must be ignored, and should not be trusted.
|
|
*/
|
|
void abort();
|
|
|
|
#ifdef SK_SUPPORT_LEGACY_DOCUMENT_API
|
|
/**
|
|
* Set the document's metadata, if supported by the document
|
|
* type. The creationDate and modifiedDate parameters can be
|
|
* nullptr. For example:
|
|
*
|
|
* SkDocument* make_doc(SkWStream* output) {
|
|
* std::vector<SkDocument::Attribute> info;
|
|
* info.emplace_back(SkString("Title"), SkString("..."));
|
|
* info.emplace_back(SkString("Author"), SkString("..."));
|
|
* info.emplace_back(SkString("Subject"), SkString("..."));
|
|
* info.emplace_back(SkString("Keywords"), SkString("..."));
|
|
* info.emplace_back(SkString("Creator"), SkString("..."));
|
|
* SkTime::DateTime now;
|
|
* SkTime::GetDateTime(&now);
|
|
* SkDocument* doc = SkDocument::CreatePDF(output);
|
|
* doc->setMetadata(&info[0], (int)info.size(), &now, &now);
|
|
* return doc;
|
|
* }
|
|
*/
|
|
struct Attribute {
|
|
SkString fKey, fValue;
|
|
Attribute(const SkString& k, const SkString& v) : fKey(k), fValue(v) {}
|
|
};
|
|
virtual void setMetadata(const SkDocument::Attribute[],
|
|
int /* attributeCount */,
|
|
const SkTime::DateTime* /* creationDate */,
|
|
const SkTime::DateTime* /* modifiedDate */) {}
|
|
#endif // SK_SUPPORT_LEGACY_DOCUMENT_API
|
|
|
|
protected:
|
|
SkDocument(SkWStream*, void (*)(SkWStream*, bool aborted));
|
|
|
|
// note: subclasses must call close() in their destructor, as the base class
|
|
// cannot do this for them.
|
|
virtual ~SkDocument();
|
|
|
|
virtual SkCanvas* onBeginPage(SkScalar width, SkScalar height,
|
|
const SkRect& content) = 0;
|
|
virtual void onEndPage() = 0;
|
|
virtual bool onClose(SkWStream*) = 0;
|
|
virtual void onAbort() = 0;
|
|
|
|
// Allows subclasses to write to the stream as pages are written.
|
|
SkWStream* getStream() { return fStream; }
|
|
|
|
enum State {
|
|
kBetweenPages_State,
|
|
kInPage_State,
|
|
kClosed_State
|
|
};
|
|
State getState() const { return fState; }
|
|
|
|
private:
|
|
SkWStream* fStream;
|
|
void (*fDoneProc)(SkWStream*, bool aborted);
|
|
State fState;
|
|
|
|
typedef SkRefCnt INHERITED;
|
|
};
|
|
|
|
#endif
|