summaryrefslogtreecommitdiff
path: root/src/pdf_bridge.h
blob: 17323a297c712053890dc6a02cb621dfae8e3274 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
#ifndef PARDES_PDF_BRIDGE_H
#define PARDES_PDF_BRIDGE_H

#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

/*
 * MuPDF reports failures with setjmp/longjmp through fz_try/fz_catch. Those
 * jumps must never cross Zig frames, so every operation that can throw lives
 * behind this deliberately small C boundary.
 */
typedef struct pardes_pdf_document pardes_pdf_document;

typedef struct pardes_pdf_raster_layout {
    int width;
    int height;
    int stride;
    size_t samples_len;
} pardes_pdf_raster_layout;

typedef struct pardes_pdf_page_size {
    float width;
    float height;
} pardes_pdf_page_size;

typedef struct pardes_pdf_text {
    void *handle;
    const unsigned char *data;
    size_t len;
} pardes_pdf_text;

/*
 * All geometry crossing this boundary is normalized to the cached page's
 * bounds. (0,0) is the page's top-left and (1,1) its bottom-right, regardless
 * of the DPI used for a particular render. Corner names retain MuPDF's quad
 * orientation; callers must not collapse them to an axis-aligned rectangle.
 */
typedef struct pardes_pdf_point {
    float x;
    float y;
} pardes_pdf_point;

typedef struct pardes_pdf_quad {
    pardes_pdf_point ul;
    pardes_pdf_point ur;
    pardes_pdf_point ll;
    pardes_pdf_point lr;
} pardes_pdf_quad;

typedef enum pardes_pdf_highlight_kind {
    PARDES_PDF_HIGHLIGHT_CUSTOM = 0,
    PARDES_PDF_HIGHLIGHT_SEARCH = 1,
    PARDES_PDF_HIGHLIGHT_SELECTION = 2
} pardes_pdf_highlight_kind;

typedef struct pardes_pdf_highlight {
    pardes_pdf_quad quad;
    unsigned char rgba[4];
    int kind;
} pardes_pdf_highlight;

typedef struct pardes_pdf_search_quad {
    pardes_pdf_quad quad;
    size_t hit;
} pardes_pdf_search_quad;

typedef struct pardes_pdf_search_result {
    void *handle;
    const pardes_pdf_search_quad *quads;
    size_t quad_count;
    size_t hit_count;
} pardes_pdf_search_result;

typedef struct pardes_pdf_selection {
    void *handle;
    const pardes_pdf_quad *quads;
    size_t quad_count;
    pardes_pdf_point start;
    pardes_pdf_point end;
} pardes_pdf_selection;

typedef struct pardes_pdf_owned_text {
    void *handle;
    const unsigned char *data;
    size_t len;
} pardes_pdf_owned_text;

enum {
    PARDES_PDF_OK = 0,
    PARDES_PDF_ERROR = -1,
    PARDES_PDF_LIMIT_EXCEEDED = -2,

    /* Per-document MuPDF eviction cache; render buffers are separate. */
    PARDES_PDF_STORE_LIMIT_BYTES = 64 * 1024 * 1024,

    /*
     * Search grows geometrically up to this aggregate count and then fails
     * atomically with PARDES_PDF_LIMIT_EXCEEDED; it never returns a silently
     * truncated result. Selection uses one extra private probe slot so an
     * exact-at-the-limit result remains distinguishable from truncation.
     */
    PARDES_PDF_MAX_RESULT_QUADS = 65536
};

pardes_pdf_document *pardes_pdf_open(const char *path, int *page_count);
void pardes_pdf_close(pardes_pdf_document *document);

/* Page dimensions in PDF points after crop/rotation, without rasterizing. */
int pardes_pdf_get_page_size(
    pardes_pdf_document *document,
    int page,
    pardes_pdf_page_size *out
);

/*
 * Start at dpi, raise the uniform scale until both optional minimum pixel
 * dimensions are met, then clamp the page's longest side to max_dimension.
 * Measuring may populate the page cache, but never advances adaptive display
 * list promotion; only a successful render_into does that.
 */
int pardes_pdf_measure_render(
    pardes_pdf_document *document,
    int page,
    int dpi,
    int minimum_width,
    int minimum_height,
    int max_dimension,
    pardes_pdf_raster_layout *out
);

/*
 * Rasterize directly into an exactly-sized caller-owned packed RGBA buffer.
 * MuPDF wraps but never owns or frees samples. Every successful pixel is
 * opaque, including the caller-supplied highlights composited onto the page.
 */
int pardes_pdf_render_into(
    pardes_pdf_document *document,
    int page,
    int dpi,
    int minimum_width,
    int minimum_height,
    int max_dimension,
    const pardes_pdf_highlight *highlights,
    size_t highlight_count,
    unsigned char *samples,
    size_t samples_len,
    int width,
    int height,
    int stride
);

int pardes_pdf_page_text(
    pardes_pdf_document *document,
    int page,
    pardes_pdf_text *out
);
void pardes_pdf_drop_text(pardes_pdf_document *document, void *buffer);

/* Case-insensitive, single-page search using MuPDF 1.27's iterative API. */
int pardes_pdf_search_page(
    pardes_pdf_document *document,
    int page,
    const char *needle,
    pardes_pdf_search_result *out
);
void pardes_pdf_drop_search_result(pardes_pdf_document *document, void *result);

/* Word-snap two normalized points and return oriented highlight quads. */
int pardes_pdf_select(
    pardes_pdf_document *document,
    int page,
    pardes_pdf_point start,
    pardes_pdf_point end,
    pardes_pdf_selection *out
);
void pardes_pdf_drop_selection(pardes_pdf_document *document, void *selection);

/* Pure/no-throw oriented-quad hit test in normalized page space. */
int pardes_pdf_point_inside_quad(
    pardes_pdf_point point,
    pardes_pdf_quad quad
);

/* The input endpoints are normally the snapped points returned above. */
int pardes_pdf_copy_selection(
    pardes_pdf_document *document,
    int page,
    pardes_pdf_point start,
    pardes_pdf_point end,
    pardes_pdf_owned_text *out
);
void pardes_pdf_drop_owned_text(pardes_pdf_document *document, void *text);

#ifdef __cplusplus
}
#endif

#endif