xref: /third_party/skia/src/pdf/SkPDFDocument.cpp (revision cb93a386)
1/*
2 * Copyright 2011 Google Inc.
3 *
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
6 */
7
8#include "include/docs/SkPDFDocument.h"
9#include "src/pdf/SkPDFDocumentPriv.h"
10
11#include "include/core/SkStream.h"
12#include "include/docs/SkPDFDocument.h"
13#include "include/private/SkTo.h"
14#include "src/pdf/SkPDFDevice.h"
15#include "src/pdf/SkPDFFont.h"
16#include "src/pdf/SkPDFGradientShader.h"
17#include "src/pdf/SkPDFGraphicState.h"
18#include "src/pdf/SkPDFShader.h"
19#include "src/pdf/SkPDFTag.h"
20#include "src/pdf/SkPDFUtils.h"
21#include "src/utils/SkUTF.h"
22
23#include <utility>
24
25// For use in SkCanvas::drawAnnotation
26const char* SkPDFGetNodeIdKey() {
27    static constexpr char key[] = "PDF_Node_Key";
28    return key;
29}
30
31static SkString ToValidUtf8String(const SkData& d) {
32    if (d.size() == 0) {
33        SkDEBUGFAIL("Not a valid string, data length is zero.");
34        return SkString();
35    }
36
37    const char* c_str = static_cast<const char*>(d.data());
38    if (c_str[d.size() - 1] != 0) {
39        SkDEBUGFAIL("Not a valid string, not null-terminated.");
40        return SkString();
41    }
42
43    // CountUTF8 returns -1 if there's an invalid UTF-8 byte sequence.
44    int valid_utf8_chars_count = SkUTF::CountUTF8(c_str, d.size() - 1);
45    if (valid_utf8_chars_count == -1) {
46        SkDEBUGFAIL("Not a valid UTF-8 string.");
47        return SkString();
48    }
49
50    return SkString(c_str, d.size() - 1);
51}
52
53////////////////////////////////////////////////////////////////////////////////
54
55void SkPDFOffsetMap::markStartOfDocument(const SkWStream* s) { fBaseOffset = s->bytesWritten(); }
56
57static size_t difference(size_t minuend, size_t subtrahend) {
58    return SkASSERT(minuend >= subtrahend), minuend - subtrahend;
59}
60
61void SkPDFOffsetMap::markStartOfObject(int referenceNumber, const SkWStream* s) {
62    SkASSERT(referenceNumber > 0);
63    size_t index = SkToSizeT(referenceNumber - 1);
64    if (index >= fOffsets.size()) {
65        fOffsets.resize(index + 1);
66    }
67    fOffsets[index] = SkToInt(difference(s->bytesWritten(), fBaseOffset));
68}
69
70int SkPDFOffsetMap::objectCount() const {
71    return SkToInt(fOffsets.size() + 1); // Include the special zeroth object in the count.
72}
73
74int SkPDFOffsetMap::emitCrossReferenceTable(SkWStream* s) const {
75    int xRefFileOffset = SkToInt(difference(s->bytesWritten(), fBaseOffset));
76    s->writeText("xref\n0 ");
77    s->writeDecAsText(this->objectCount());
78    s->writeText("\n0000000000 65535 f \n");
79    for (int offset : fOffsets) {
80        SkASSERT(offset > 0);  // Offset was set.
81        s->writeBigDecAsText(offset, 10);
82        s->writeText(" 00000 n \n");
83    }
84    return xRefFileOffset;
85}
86//
87////////////////////////////////////////////////////////////////////////////////
88
89#define SKPDF_MAGIC "\xD3\xEB\xE9\xE1"
90#ifndef SK_BUILD_FOR_WIN
91static_assert((SKPDF_MAGIC[0] & 0x7F) == "Skia"[0], "");
92static_assert((SKPDF_MAGIC[1] & 0x7F) == "Skia"[1], "");
93static_assert((SKPDF_MAGIC[2] & 0x7F) == "Skia"[2], "");
94static_assert((SKPDF_MAGIC[3] & 0x7F) == "Skia"[3], "");
95#endif
96static void serializeHeader(SkPDFOffsetMap* offsetMap, SkWStream* wStream) {
97    offsetMap->markStartOfDocument(wStream);
98    wStream->writeText("%PDF-1.4\n%" SKPDF_MAGIC "\n");
99    // The PDF spec recommends including a comment with four
100    // bytes, all with their high bits set.  "\xD3\xEB\xE9\xE1" is
101    // "Skia" with the high bits set.
102}
103#undef SKPDF_MAGIC
104
105static void begin_indirect_object(SkPDFOffsetMap* offsetMap,
106                                  SkPDFIndirectReference ref,
107                                  SkWStream* s) {
108    offsetMap->markStartOfObject(ref.fValue, s);
109    s->writeDecAsText(ref.fValue);
110    s->writeText(" 0 obj\n");  // Generation number is always 0.
111}
112
113static void end_indirect_object(SkWStream* s) { s->writeText("\nendobj\n"); }
114
115// Xref table and footer
116static void serialize_footer(const SkPDFOffsetMap& offsetMap,
117                             SkWStream* wStream,
118                             SkPDFIndirectReference infoDict,
119                             SkPDFIndirectReference docCatalog,
120                             SkUUID uuid) {
121    int xRefFileOffset = offsetMap.emitCrossReferenceTable(wStream);
122    SkPDFDict trailerDict;
123    trailerDict.insertInt("Size", offsetMap.objectCount());
124    SkASSERT(docCatalog != SkPDFIndirectReference());
125    trailerDict.insertRef("Root", docCatalog);
126    SkASSERT(infoDict != SkPDFIndirectReference());
127    trailerDict.insertRef("Info", infoDict);
128    if (SkUUID() != uuid) {
129        trailerDict.insertObject("ID", SkPDFMetadata::MakePdfId(uuid, uuid));
130    }
131    wStream->writeText("trailer\n");
132    trailerDict.emitObject(wStream);
133    wStream->writeText("\nstartxref\n");
134    wStream->writeBigDecAsText(xRefFileOffset);
135    wStream->writeText("\n%%EOF");
136}
137
138static SkPDFIndirectReference generate_page_tree(
139        SkPDFDocument* doc,
140        std::vector<std::unique_ptr<SkPDFDict>> pages,
141        const std::vector<SkPDFIndirectReference>& pageRefs) {
142    // PDF wants a tree describing all the pages in the document.  We arbitrary
143    // choose 8 (kNodeSize) as the number of allowed children.  The internal
144    // nodes have type "Pages" with an array of children, a parent pointer, and
145    // the number of leaves below the node as "Count."  The leaves are passed
146    // into the method, have type "Page" and need a parent pointer. This method
147    // builds the tree bottom up, skipping internal nodes that would have only
148    // one child.
149    SkASSERT(pages.size() > 0);
150    struct PageTreeNode {
151        std::unique_ptr<SkPDFDict> fNode;
152        SkPDFIndirectReference fReservedRef;
153        int fPageObjectDescendantCount;
154
155        static std::vector<PageTreeNode> Layer(std::vector<PageTreeNode> vec, SkPDFDocument* doc) {
156            std::vector<PageTreeNode> result;
157            static constexpr size_t kMaxNodeSize = 8;
158            const size_t n = vec.size();
159            SkASSERT(n >= 1);
160            const size_t result_len = (n - 1) / kMaxNodeSize + 1;
161            SkASSERT(result_len >= 1);
162            SkASSERT(n == 1 || result_len < n);
163            result.reserve(result_len);
164            size_t index = 0;
165            for (size_t i = 0; i < result_len; ++i) {
166                if (n != 1 && index + 1 == n) {  // No need to create a new node.
167                    result.push_back(std::move(vec[index++]));
168                    continue;
169                }
170                SkPDFIndirectReference parent = doc->reserveRef();
171                auto kids_list = SkPDFMakeArray();
172                int descendantCount = 0;
173                for (size_t j = 0; j < kMaxNodeSize && index < n; ++j) {
174                    PageTreeNode& node = vec[index++];
175                    node.fNode->insertRef("Parent", parent);
176                    kids_list->appendRef(doc->emit(*node.fNode, node.fReservedRef));
177                    descendantCount += node.fPageObjectDescendantCount;
178                }
179                auto next = SkPDFMakeDict("Pages");
180                next->insertInt("Count", descendantCount);
181                next->insertObject("Kids", std::move(kids_list));
182                result.push_back(PageTreeNode{std::move(next), parent, descendantCount});
183            }
184            return result;
185        }
186    };
187    std::vector<PageTreeNode> currentLayer;
188    currentLayer.reserve(pages.size());
189    SkASSERT(pages.size() == pageRefs.size());
190    for (size_t i = 0; i < pages.size(); ++i) {
191        currentLayer.push_back(PageTreeNode{std::move(pages[i]), pageRefs[i], 1});
192    }
193    currentLayer = PageTreeNode::Layer(std::move(currentLayer), doc);
194    while (currentLayer.size() > 1) {
195        currentLayer = PageTreeNode::Layer(std::move(currentLayer), doc);
196    }
197    SkASSERT(currentLayer.size() == 1);
198    const PageTreeNode& root = currentLayer[0];
199    return doc->emit(*root.fNode, root.fReservedRef);
200}
201
202template<typename T, typename... Args>
203static void reset_object(T* dst, Args&&... args) {
204    dst->~T();
205    new (dst) T(std::forward<Args>(args)...);
206}
207
208////////////////////////////////////////////////////////////////////////////////
209
210SkPDFDocument::SkPDFDocument(SkWStream* stream,
211                             SkPDF::Metadata metadata)
212    : SkDocument(stream)
213    , fMetadata(std::move(metadata)) {
214    constexpr float kDpiForRasterScaleOne = 72.0f;
215    if (fMetadata.fRasterDPI != kDpiForRasterScaleOne) {
216        fInverseRasterScale = kDpiForRasterScaleOne / fMetadata.fRasterDPI;
217        fRasterScale        = fMetadata.fRasterDPI / kDpiForRasterScaleOne;
218    }
219    if (fMetadata.fStructureElementTreeRoot) {
220        fTagTree.init(fMetadata.fStructureElementTreeRoot);
221    }
222    fExecutor = metadata.fExecutor;
223}
224
225SkPDFDocument::~SkPDFDocument() {
226    // subclasses of SkDocument must call close() in their destructors.
227    this->close();
228}
229
230SkPDFIndirectReference SkPDFDocument::emit(const SkPDFObject& object, SkPDFIndirectReference ref){
231    SkAutoMutexExclusive lock(fMutex);
232    object.emitObject(this->beginObject(ref));
233    this->endObject();
234    return ref;
235}
236
237SkWStream* SkPDFDocument::beginObject(SkPDFIndirectReference ref) SK_REQUIRES(fMutex) {
238    begin_indirect_object(&fOffsetMap, ref, this->getStream());
239    return this->getStream();
240};
241
242void SkPDFDocument::endObject() SK_REQUIRES(fMutex) {
243    end_indirect_object(this->getStream());
244};
245
246static SkSize operator*(SkISize u, SkScalar s) { return SkSize{u.width() * s, u.height() * s}; }
247static SkSize operator*(SkSize u, SkScalar s) { return SkSize{u.width() * s, u.height() * s}; }
248
249SkCanvas* SkPDFDocument::onBeginPage(SkScalar width, SkScalar height) {
250    SkASSERT(fCanvas.imageInfo().dimensions().isZero());
251    if (fPages.empty()) {
252        // if this is the first page if the document.
253        {
254            SkAutoMutexExclusive autoMutexAcquire(fMutex);
255            serializeHeader(&fOffsetMap, this->getStream());
256
257        }
258
259        fInfoDict = this->emit(*SkPDFMetadata::MakeDocumentInformationDict(fMetadata));
260        if (fMetadata.fPDFA) {
261            fUUID = SkPDFMetadata::CreateUUID(fMetadata);
262            // We use the same UUID for Document ID and Instance ID since this
263            // is the first revision of this document (and Skia does not
264            // support revising existing PDF documents).
265            // If we are not in PDF/A mode, don't use a UUID since testing
266            // works best with reproducible outputs.
267            fXMP = SkPDFMetadata::MakeXMPObject(fMetadata, fUUID, fUUID, this);
268        }
269    }
270    // By scaling the page at the device level, we will create bitmap layer
271    // devices at the rasterized scale, not the 72dpi scale.  Bitmap layer
272    // devices are created when saveLayer is called with an ImageFilter;  see
273    // SkPDFDevice::onCreateDevice().
274    SkISize pageSize = (SkSize{width, height} * fRasterScale).toRound();
275    SkMatrix initialTransform;
276    // Skia uses the top left as the origin but PDF natively has the origin at the
277    // bottom left. This matrix corrects for that, as well as the raster scale.
278    initialTransform.setScaleTranslate(fInverseRasterScale, -fInverseRasterScale,
279                                       0, fInverseRasterScale * pageSize.height());
280    fPageDevice = sk_make_sp<SkPDFDevice>(pageSize, this, initialTransform);
281    reset_object(&fCanvas, fPageDevice);
282    fCanvas.scale(fRasterScale, fRasterScale);
283    fPageRefs.push_back(this->reserveRef());
284    return &fCanvas;
285}
286
287static void populate_link_annotation(SkPDFDict* annotation, const SkRect& r) {
288    annotation->insertName("Subtype", "Link");
289    annotation->insertInt("F", 4);  // required by ISO 19005
290    // Border: 0 = Horizontal corner radius.
291    //         0 = Vertical corner radius.
292    //         0 = Width, 0 = no border.
293    annotation->insertObject("Border", SkPDFMakeArray(0, 0, 0));
294    annotation->insertObject("Rect", SkPDFMakeArray(r.fLeft, r.fTop, r.fRight, r.fBottom));
295}
296
297static SkPDFIndirectReference append_destinations(
298        SkPDFDocument* doc,
299        const std::vector<SkPDFNamedDestination>& namedDestinations)
300{
301    SkPDFDict destinations;
302    for (const SkPDFNamedDestination& dest : namedDestinations) {
303        auto pdfDest = SkPDFMakeArray();
304        pdfDest->reserve(5);
305        pdfDest->appendRef(dest.fPage);
306        pdfDest->appendName("XYZ");
307        pdfDest->appendScalar(dest.fPoint.x());
308        pdfDest->appendScalar(dest.fPoint.y());
309        pdfDest->appendInt(0);  // Leave zoom unchanged
310        destinations.insertObject(ToValidUtf8String(*dest.fName), std::move(pdfDest));
311    }
312    return doc->emit(destinations);
313}
314
315std::unique_ptr<SkPDFArray> SkPDFDocument::getAnnotations() {
316    std::unique_ptr<SkPDFArray> array;
317    size_t count = fCurrentPageLinks.size();
318    if (0 == count) {
319        return array;  // is nullptr
320    }
321    array = SkPDFMakeArray();
322    array->reserve(count);
323    for (const auto& link : fCurrentPageLinks) {
324        SkPDFDict annotation("Annot");
325        populate_link_annotation(&annotation, link->fRect);
326        if (link->fType == SkPDFLink::Type::kUrl) {
327            std::unique_ptr<SkPDFDict> action = SkPDFMakeDict("Action");
328            action->insertName("S", "URI");
329            action->insertString("URI", ToValidUtf8String(*link->fData));
330            annotation.insertObject("A", std::move(action));
331        } else if (link->fType == SkPDFLink::Type::kNamedDestination) {
332            annotation.insertName("Dest", ToValidUtf8String(*link->fData));
333        } else {
334            SkDEBUGFAIL("Unknown link type.");
335        }
336
337        if (link->fNodeId) {
338            int structParentKey = createStructParentKeyForNodeId(link->fNodeId);
339            if (structParentKey != -1) {
340                annotation.insertInt("StructParent", structParentKey);
341            }
342        }
343
344        SkPDFIndirectReference annotationRef = emit(annotation);
345        array->appendRef(annotationRef);
346        if (link->fNodeId) {
347            fTagTree.addNodeAnnotation(link->fNodeId, annotationRef, SkToUInt(this->currentPageIndex()));
348        }
349    }
350    return array;
351}
352
353void SkPDFDocument::onEndPage() {
354    SkASSERT(!fCanvas.imageInfo().dimensions().isZero());
355    reset_object(&fCanvas);
356    SkASSERT(fPageDevice);
357
358    auto page = SkPDFMakeDict("Page");
359
360    SkSize mediaSize = fPageDevice->imageInfo().dimensions() * fInverseRasterScale;
361    std::unique_ptr<SkStreamAsset> pageContent = fPageDevice->content();
362    auto resourceDict = fPageDevice->makeResourceDict();
363    SkASSERT(fPageRefs.size() > 0);
364    fPageDevice = nullptr;
365
366    page->insertObject("Resources", std::move(resourceDict));
367    page->insertObject("MediaBox", SkPDFUtils::RectToArray(SkRect::MakeSize(mediaSize)));
368
369    if (std::unique_ptr<SkPDFArray> annotations = getAnnotations()) {
370        page->insertObject("Annots", std::move(annotations));
371        fCurrentPageLinks.clear();
372    }
373
374    page->insertRef("Contents", SkPDFStreamOut(nullptr, std::move(pageContent), this));
375    // The StructParents unique identifier for each page is just its
376    // 0-based page index.
377    page->insertInt("StructParents", SkToInt(this->currentPageIndex()));
378    fPages.emplace_back(std::move(page));
379}
380
381void SkPDFDocument::onAbort() {
382    this->waitForJobs();
383}
384
385static sk_sp<SkData> SkSrgbIcm() {
386    // Source: http://www.argyllcms.com/icclibsrc.html
387    static const char kProfile[] =
388        "\0\0\14\214argl\2 \0\0mntrRGB XYZ \7\336\0\1\0\6\0\26\0\17\0:acspM"
389        "SFT\0\0\0\0IEC sRGB\0\0\0\0\0\0\0\0\0\0\0\0\0\0\366\326\0\1\0\0\0\0"
390        "\323-argl\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"
391        "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\21desc\0\0\1P\0\0\0\231cprt\0"
392        "\0\1\354\0\0\0gdmnd\0\0\2T\0\0\0pdmdd\0\0\2\304\0\0\0\210tech\0\0\3"
393        "L\0\0\0\14vued\0\0\3X\0\0\0gview\0\0\3\300\0\0\0$lumi\0\0\3\344\0\0"
394        "\0\24meas\0\0\3\370\0\0\0$wtpt\0\0\4\34\0\0\0\24bkpt\0\0\0040\0\0\0"
395        "\24rXYZ\0\0\4D\0\0\0\24gXYZ\0\0\4X\0\0\0\24bXYZ\0\0\4l\0\0\0\24rTR"
396        "C\0\0\4\200\0\0\10\14gTRC\0\0\4\200\0\0\10\14bTRC\0\0\4\200\0\0\10"
397        "\14desc\0\0\0\0\0\0\0?sRGB IEC61966-2.1 (Equivalent to www.srgb.co"
398        "m 1998 HP profile)\0\0\0\0\0\0\0\0\0\0\0?sRGB IEC61966-2.1 (Equiva"
399        "lent to www.srgb.com 1998 HP profile)\0\0\0\0\0\0\0\0text\0\0\0\0C"
400        "reated by Graeme W. Gill. Released into the public domain. No Warr"
401        "anty, Use at your own risk.\0\0desc\0\0\0\0\0\0\0\26IEC http://www"
402        ".iec.ch\0\0\0\0\0\0\0\0\0\0\0\26IEC http://www.iec.ch\0\0\0\0\0\0\0"
403        "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"
404        "\0\0\0\0\0\0desc\0\0\0\0\0\0\0.IEC 61966-2.1 Default RGB colour sp"
405        "ace - sRGB\0\0\0\0\0\0\0\0\0\0\0.IEC 61966-2.1 Default RGB colour "
406        "space - sRGB\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0sig \0\0\0"
407        "\0CRT desc\0\0\0\0\0\0\0\rIEC61966-2.1\0\0\0\0\0\0\0\0\0\0\0\rIEC6"
408        "1966-2.1\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0"
409        "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0view\0\0\0\0"
410        "\0\23\244|\0\24_0\0\20\316\2\0\3\355\262\0\4\23\n\0\3\\g\0\0\0\1XY"
411        "Z \0\0\0\0\0L\n=\0P\0\0\0W\36\270meas\0\0\0\0\0\0\0\1\0\0\0\0\0\0\0"
412        "\0\0\0\0\0\0\0\0\0\0\0\2\217\0\0\0\2XYZ \0\0\0\0\0\0\363Q\0\1\0\0\0"
413        "\1\26\314XYZ \0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0XYZ \0\0\0\0\0\0o\240"
414        "\0\0008\365\0\0\3\220XYZ \0\0\0\0\0\0b\227\0\0\267\207\0\0\30\331X"
415        "YZ \0\0\0\0\0\0$\237\0\0\17\204\0\0\266\304curv\0\0\0\0\0\0\4\0\0\0"
416        "\0\5\0\n\0\17\0\24\0\31\0\36\0#\0(\0-\0002\0007\0;\0@\0E\0J\0O\0T\0"
417        "Y\0^\0c\0h\0m\0r\0w\0|\0\201\0\206\0\213\0\220\0\225\0\232\0\237\0"
418        "\244\0\251\0\256\0\262\0\267\0\274\0\301\0\306\0\313\0\320\0\325\0"
419        "\333\0\340\0\345\0\353\0\360\0\366\0\373\1\1\1\7\1\r\1\23\1\31\1\37"
420        "\1%\1+\0012\0018\1>\1E\1L\1R\1Y\1`\1g\1n\1u\1|\1\203\1\213\1\222\1"
421        "\232\1\241\1\251\1\261\1\271\1\301\1\311\1\321\1\331\1\341\1\351\1"
422        "\362\1\372\2\3\2\14\2\24\2\35\2&\2/\0028\2A\2K\2T\2]\2g\2q\2z\2\204"
423        "\2\216\2\230\2\242\2\254\2\266\2\301\2\313\2\325\2\340\2\353\2\365"
424        "\3\0\3\13\3\26\3!\3-\0038\3C\3O\3Z\3f\3r\3~\3\212\3\226\3\242\3\256"
425        "\3\272\3\307\3\323\3\340\3\354\3\371\4\6\4\23\4 \4-\4;\4H\4U\4c\4q"
426        "\4~\4\214\4\232\4\250\4\266\4\304\4\323\4\341\4\360\4\376\5\r\5\34"
427        "\5+\5:\5I\5X\5g\5w\5\206\5\226\5\246\5\265\5\305\5\325\5\345\5\366"
428        "\6\6\6\26\6'\0067\6H\6Y\6j\6{\6\214\6\235\6\257\6\300\6\321\6\343\6"
429        "\365\7\7\7\31\7+\7=\7O\7a\7t\7\206\7\231\7\254\7\277\7\322\7\345\7"
430        "\370\10\13\10\37\0102\10F\10Z\10n\10\202\10\226\10\252\10\276\10\322"
431        "\10\347\10\373\t\20\t%\t:\tO\td\ty\t\217\t\244\t\272\t\317\t\345\t"
432        "\373\n\21\n'\n=\nT\nj\n\201\n\230\n\256\n\305\n\334\n\363\13\13\13"
433        "\"\0139\13Q\13i\13\200\13\230\13\260\13\310\13\341\13\371\14\22\14"
434        "*\14C\14\\\14u\14\216\14\247\14\300\14\331\14\363\r\r\r&\r@\rZ\rt\r"
435        "\216\r\251\r\303\r\336\r\370\16\23\16.\16I\16d\16\177\16\233\16\266"
436        "\16\322\16\356\17\t\17%\17A\17^\17z\17\226\17\263\17\317\17\354\20"
437        "\t\20&\20C\20a\20~\20\233\20\271\20\327\20\365\21\23\0211\21O\21m\21"
438        "\214\21\252\21\311\21\350\22\7\22&\22E\22d\22\204\22\243\22\303\22"
439        "\343\23\3\23#\23C\23c\23\203\23\244\23\305\23\345\24\6\24'\24I\24j"
440        "\24\213\24\255\24\316\24\360\25\22\0254\25V\25x\25\233\25\275\25\340"
441        "\26\3\26&\26I\26l\26\217\26\262\26\326\26\372\27\35\27A\27e\27\211"
442        "\27\256\27\322\27\367\30\33\30@\30e\30\212\30\257\30\325\30\372\31"
443        " \31E\31k\31\221\31\267\31\335\32\4\32*\32Q\32w\32\236\32\305\32\354"
444        "\33\24\33;\33c\33\212\33\262\33\332\34\2\34*\34R\34{\34\243\34\314"
445        "\34\365\35\36\35G\35p\35\231\35\303\35\354\36\26\36@\36j\36\224\36"
446        "\276\36\351\37\23\37>\37i\37\224\37\277\37\352 \25 A l \230 \304 \360"
447        "!\34!H!u!\241!\316!\373\"'\"U\"\202\"\257\"\335#\n#8#f#\224#\302#\360"
448        "$\37$M$|$\253$\332%\t%8%h%\227%\307%\367&'&W&\207&\267&\350'\30'I'"
449        "z'\253'\334(\r(?(q(\242(\324)\6)8)k)\235)\320*\2*5*h*\233*\317+\2+"
450        "6+i+\235+\321,\5,9,n,\242,\327-\14-A-v-\253-\341.\26.L.\202.\267.\356"
451        "/$/Z/\221/\307/\376050l0\2440\3331\0221J1\2021\2721\3622*2c2\2332\324"
452        "3\r3F3\1773\2703\3614+4e4\2364\3305\0235M5\2075\3025\375676r6\2566"
453        "\3517$7`7\2347\3278\0248P8\2148\3109\0059B9\1779\2749\371:6:t:\262"
454        ":\357;-;k;\252;\350<'<e<\244<\343=\"=a=\241=\340> >`>\240>\340?!?a"
455        "?\242?\342@#@d@\246@\347A)AjA\254A\356B0BrB\265B\367C:C}C\300D\3DG"
456        "D\212D\316E\22EUE\232E\336F\"FgF\253F\360G5G{G\300H\5HKH\221H\327I"
457        "\35IcI\251I\360J7J}J\304K\14KSK\232K\342L*LrL\272M\2MJM\223M\334N%"
458        "NnN\267O\0OIO\223O\335P'PqP\273Q\6QPQ\233Q\346R1R|R\307S\23S_S\252"
459        "S\366TBT\217T\333U(UuU\302V\17V\\V\251V\367WDW\222W\340X/X}X\313Y\32"
460        "YiY\270Z\7ZVZ\246Z\365[E[\225[\345\\5\\\206\\\326]']x]\311^\32^l^\275"
461        "_\17_a_\263`\5`W`\252`\374aOa\242a\365bIb\234b\360cCc\227c\353d@d\224"
462        "d\351e=e\222e\347f=f\222f\350g=g\223g\351h?h\226h\354iCi\232i\361j"
463        "Hj\237j\367kOk\247k\377lWl\257m\10m`m\271n\22nkn\304o\36oxo\321p+p"
464        "\206p\340q:q\225q\360rKr\246s\1s]s\270t\24tpt\314u(u\205u\341v>v\233"
465        "v\370wVw\263x\21xnx\314y*y\211y\347zFz\245{\4{c{\302|!|\201|\341}A"
466        "}\241~\1~b~\302\177#\177\204\177\345\200G\200\250\201\n\201k\201\315"
467        "\2020\202\222\202\364\203W\203\272\204\35\204\200\204\343\205G\205"
468        "\253\206\16\206r\206\327\207;\207\237\210\4\210i\210\316\2113\211\231"
469        "\211\376\212d\212\312\2130\213\226\213\374\214c\214\312\2151\215\230"
470        "\215\377\216f\216\316\2176\217\236\220\6\220n\220\326\221?\221\250"
471        "\222\21\222z\222\343\223M\223\266\224 \224\212\224\364\225_\225\311"
472        "\2264\226\237\227\n\227u\227\340\230L\230\270\231$\231\220\231\374"
473        "\232h\232\325\233B\233\257\234\34\234\211\234\367\235d\235\322\236"
474        "@\236\256\237\35\237\213\237\372\240i\240\330\241G\241\266\242&\242"
475        "\226\243\6\243v\243\346\244V\244\307\2458\245\251\246\32\246\213\246"
476        "\375\247n\247\340\250R\250\304\2517\251\251\252\34\252\217\253\2\253"
477        "u\253\351\254\\\254\320\255D\255\270\256-\256\241\257\26\257\213\260"
478        "\0\260u\260\352\261`\261\326\262K\262\302\2638\263\256\264%\264\234"
479        "\265\23\265\212\266\1\266y\266\360\267h\267\340\270Y\270\321\271J\271"
480        "\302\272;\272\265\273.\273\247\274!\274\233\275\25\275\217\276\n\276"
481        "\204\276\377\277z\277\365\300p\300\354\301g\301\343\302_\302\333\303"
482        "X\303\324\304Q\304\316\305K\305\310\306F\306\303\307A\307\277\310="
483        "\310\274\311:\311\271\3128\312\267\3136\313\266\3145\314\265\3155\315"
484        "\265\3166\316\266\3177\317\270\3209\320\272\321<\321\276\322?\322\301"
485        "\323D\323\306\324I\324\313\325N\325\321\326U\326\330\327\\\327\340"
486        "\330d\330\350\331l\331\361\332v\332\373\333\200\334\5\334\212\335\20"
487        "\335\226\336\34\336\242\337)\337\257\3406\340\275\341D\341\314\342"
488        "S\342\333\343c\343\353\344s\344\374\345\204\346\r\346\226\347\37\347"
489        "\251\3502\350\274\351F\351\320\352[\352\345\353p\353\373\354\206\355"
490        "\21\355\234\356(\356\264\357@\357\314\360X\360\345\361r\361\377\362"
491        "\214\363\31\363\247\3644\364\302\365P\365\336\366m\366\373\367\212"
492        "\370\31\370\250\3718\371\307\372W\372\347\373w\374\7\374\230\375)\375"
493        "\272\376K\376\334\377m\377\377";
494    const size_t kProfileLength = 3212;
495    static_assert(kProfileLength == sizeof(kProfile) - 1, "");
496    return SkData::MakeWithoutCopy(kProfile, kProfileLength);
497}
498
499static SkPDFIndirectReference make_srgb_color_profile(SkPDFDocument* doc) {
500    std::unique_ptr<SkPDFDict> dict = SkPDFMakeDict();
501    dict->insertInt("N", 3);
502    dict->insertObject("Range", SkPDFMakeArray(0, 1, 0, 1, 0, 1));
503    return SkPDFStreamOut(std::move(dict), SkMemoryStream::Make(SkSrgbIcm()), doc, true);
504}
505
506static std::unique_ptr<SkPDFArray> make_srgb_output_intents(SkPDFDocument* doc) {
507    // sRGB is specified by HTML, CSS, and SVG.
508    auto outputIntent = SkPDFMakeDict("OutputIntent");
509    outputIntent->insertName("S", "GTS_PDFA1");
510    outputIntent->insertString("RegistryName", "http://www.color.org");
511    outputIntent->insertString("OutputConditionIdentifier",
512                               "Custom");
513    outputIntent->insertString("Info","sRGB IEC61966-2.1");
514    outputIntent->insertRef("DestOutputProfile", make_srgb_color_profile(doc));
515    auto intentArray = SkPDFMakeArray();
516    intentArray->appendObject(std::move(outputIntent));
517    return intentArray;
518}
519
520SkPDFIndirectReference SkPDFDocument::getPage(size_t pageIndex) const {
521    SkASSERT(pageIndex < fPageRefs.size());
522    return fPageRefs[pageIndex];
523}
524
525const SkMatrix& SkPDFDocument::currentPageTransform() const {
526    return fPageDevice->initialTransform();
527}
528
529int SkPDFDocument::createMarkIdForNodeId(int nodeId) {
530    return fTagTree.createMarkIdForNodeId(nodeId, SkToUInt(this->currentPageIndex()));
531}
532
533int SkPDFDocument::createStructParentKeyForNodeId(int nodeId) {
534    return fTagTree.createStructParentKeyForNodeId(nodeId, SkToUInt(this->currentPageIndex()));
535}
536
537static std::vector<const SkPDFFont*> get_fonts(const SkPDFDocument& canon) {
538    std::vector<const SkPDFFont*> fonts;
539    fonts.reserve(canon.fFontMap.count());
540    // Sort so the output PDF is reproducible.
541    for (const auto& [unused, font] : canon.fFontMap) {
542        fonts.push_back(&font);
543    }
544    std::sort(fonts.begin(), fonts.end(), [](const SkPDFFont* u, const SkPDFFont* v) {
545        return u->indirectReference().fValue < v->indirectReference().fValue;
546    });
547    return fonts;
548}
549
550void SkPDFDocument::onClose(SkWStream* stream) {
551    SkASSERT(fCanvas.imageInfo().dimensions().isZero());
552    if (fPages.empty()) {
553        this->waitForJobs();
554        return;
555    }
556    auto docCatalog = SkPDFMakeDict("Catalog");
557    if (fMetadata.fPDFA) {
558        SkASSERT(fXMP != SkPDFIndirectReference());
559        docCatalog->insertRef("Metadata", fXMP);
560        // Don't specify OutputIntents if we are not in PDF/A mode since
561        // no one has ever asked for this feature.
562        docCatalog->insertObject("OutputIntents", make_srgb_output_intents(this));
563    }
564
565    docCatalog->insertRef("Pages", generate_page_tree(this, std::move(fPages), fPageRefs));
566
567    if (!fNamedDestinations.empty()) {
568        docCatalog->insertRef("Dests", append_destinations(this, fNamedDestinations));
569        fNamedDestinations.clear();
570    }
571
572    // Handle tagged PDFs.
573    if (SkPDFIndirectReference root = fTagTree.makeStructTreeRoot(this)) {
574        // In the document catalog, indicate that this PDF is tagged.
575        auto markInfo = SkPDFMakeDict("MarkInfo");
576        markInfo->insertBool("Marked", true);
577        docCatalog->insertObject("MarkInfo", std::move(markInfo));
578        docCatalog->insertRef("StructTreeRoot", root);
579    }
580
581    auto docCatalogRef = this->emit(*docCatalog);
582
583    for (const SkPDFFont* f : get_fonts(*this)) {
584        f->emitSubset(this);
585    }
586
587    this->waitForJobs();
588    {
589        SkAutoMutexExclusive autoMutexAcquire(fMutex);
590        serialize_footer(fOffsetMap, this->getStream(), fInfoDict, docCatalogRef, fUUID);
591    }
592}
593
594void SkPDFDocument::incrementJobCount() { fJobCount++; }
595
596void SkPDFDocument::signalJobComplete() { fSemaphore.signal(); }
597
598void SkPDFDocument::waitForJobs() {
599     // fJobCount can increase while we wait.
600     while (fJobCount > 0) {
601         fSemaphore.wait();
602         --fJobCount;
603     }
604}
605
606///////////////////////////////////////////////////////////////////////////////
607
608void SkPDF::SetNodeId(SkCanvas* canvas, int nodeID) {
609    sk_sp<SkData> payload = SkData::MakeWithCopy(&nodeID, sizeof(nodeID));
610    const char* key = SkPDFGetNodeIdKey();
611    canvas->drawAnnotation({0, 0, 0, 0}, key, payload.get());
612}
613
614sk_sp<SkDocument> SkPDF::MakeDocument(SkWStream* stream, const SkPDF::Metadata& metadata) {
615    SkPDF::Metadata meta = metadata;
616    if (meta.fRasterDPI <= 0) {
617        meta.fRasterDPI = 72.0f;
618    }
619    if (meta.fEncodingQuality < 0) {
620        meta.fEncodingQuality = 0;
621    }
622    return stream ? sk_make_sp<SkPDFDocument>(stream, std::move(meta)) : nullptr;
623}
624