• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2016 The Android Open Source Project
3  * Copyright (C) 2016 Mopria Alliance, Inc.
4  * Copyright (C) 2013 Hewlett-Packard Development Company, L.P.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  *      http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 
19 #ifndef __LIB_WPRINT_H__
20 #define __LIB_WPRINT_H__
21 
22 #include "wtypes.h"
23 #include "wprint_df_types.h"
24 #include "mime_types.h"
25 #include "printer_capabilities_types.h"
26 #include "wprint_status_types.h"
27 #include "ifc_wprint.h"
28 #include <dlfcn.h>
29 #include <ctype.h>
30 #include <stdlib.h>
31 
32 #define WPRINT_BAD_JOB_HANDLE ((wJob_t) ERROR)
33 
34 #define _INTERFACE_MAJOR_VERSION  1
35 #define _INTERFACE_MINOR_VERSION  0
36 
37 #define _PLUGIN_MAJOR_VERSION 1
38 
39 #define WPRINT_INTERFACE_VERSION ((uint32)((_INTERFACE_MAJOR_VERSION << 16) | \
40     (_INTERFACE_MINOR_VERSION & 0xffff)))
41 #define WPRINT_PLUGIN_VERSION(X) ((uint32)((_PLUGIN_MAJOR_VERSION << 16) | (X & 0xffff)))
42 
43 #define major_version(X) ((X >> 16) & 0xffff)
44 #define minor_version(X) ((X >> 0) & 0xffff)
45 
46 #define STRIPE_HEIGHT           (16)
47 #define BUFFERED_ROWS           (STRIPE_HEIGHT * 8)
48 
49 #define MAX_MIME_LENGTH         (64)
50 #define MAX_PRINTER_ADDR_LENGTH (64)
51 #define MAX_FILENAME_LENGTH     (32)
52 #define MAX_PATHNAME_LENGTH     (255)
53 #define MAX_ID_STRING_LENGTH    (64)
54 #define MAX_NAME_LENGTH         (255)
55 
56 #define HTTP_TIMEOUT_MILLIS 30000
57 
58 #ifdef __cplusplus
59 extern "C"
60 {
61 #endif
62 
63 typedef enum {
64     DUPLEX_DRY_TIME_NORMAL, // 18 seconds
65     DUPLEX_DRY_TIME_LOWER, // 10 seconds
66     DUPLEX_DRY_TIME_MINIMUM     // 5 seconds
67 } duplex_dry_time_t;
68 
69 typedef enum {
70     PORT_INVALID = -1,
71     PORT_FILE = 0,
72     PORT_IPP = 631,
73 } port_t;
74 
75 typedef enum {
76     PCLNONE,
77     PCLm,
78     PCLJPEG,
79     PCLPWG,
80 
81     PCL_NUM_TYPES
82 } pcl_t;
83 
84 typedef enum {
85     AUTO_ROTATE,
86     CENTER_VERTICAL,
87     CENTER_HORIZONTAL,
88     ROTATE_BACK_PAGE,
89     BACK_PAGE_PREROTATED,
90     AUTO_SCALE,
91     AUTO_FIT,
92     PORTRAIT_MODE,
93     LANDSCAPE_MODE,
94     CENTER_ON_ORIENTATION,
95     DOCUMENT_SCALING,
96 } render_flags_t;
97 
98 #define RENDER_FLAG_AUTO_ROTATE           (1 << AUTO_ROTATE)
99 #define RENDER_FLAG_ROTATE_BACK_PAGE      (1 << ROTATE_BACK_PAGE)
100 #define RENDER_FLAG_BACK_PAGE_PREROTATED  (1 << BACK_PAGE_PREROTATED)
101 #define RENDER_FLAG_CENTER_VERTICAL       (1 << CENTER_VERTICAL)
102 #define RENDER_FLAG_CENTER_HORIZONTAL     (1 << CENTER_HORIZONTAL)
103 #define RENDER_FLAG_AUTO_SCALE            (1 << AUTO_SCALE)
104 #define RENDER_FLAG_AUTO_FIT              (1 << AUTO_FIT)
105 #define RENDER_FLAG_PORTRAIT_MODE         (1 << PORTRAIT_MODE)
106 #define RENDER_FLAG_LANDSCAPE_MODE        (1 << LANDSCAPE_MODE)
107 #define RENDER_FLAG_CENTER_ON_ORIENTATION (1 << CENTER_ON_ORIENTATION)
108 #define RENDER_FLAG_DOCUMENT_SCALING      (1 << DOCUMENT_SCALING)
109 
110 #define AUTO_SCALE_RENDER_FLAGS          (RENDER_FLAG_AUTO_SCALE | \
111                                           RENDER_FLAG_AUTO_ROTATE | \
112                                           RENDER_FLAG_CENTER_VERTICAL | \
113                                           RENDER_FLAG_CENTER_HORIZONTAL)
114 
115 #define AUTO_FIT_RENDER_FLAGS            (RENDER_FLAG_AUTO_FIT | \
116                                           RENDER_FLAG_AUTO_ROTATE | \
117                                           RENDER_FLAG_CENTER_ON_ORIENTATION)
118 
119 #define ORIENTATION_RENDER_FLAGS         (RENDER_FLAG_AUTO_ROTATE | \
120                                           RENDER_FLAG_PORTRAIT_MODE | \
121                                           RENDER_FLAG_LANDSCAPE_MODE | \
122                                           RENDER_FLAG_CENTER_ON_ORIENTATION)
123 
124 typedef void (*wprint_status_cb_t)(wJob_t job_id, void *parm);
125 
126 /*
127  * Parameters describing a job request
128  */
129 typedef struct {
130     media_size_t media_size;
131     media_type_t media_type;
132     duplex_t duplex;
133     duplex_dry_time_t dry_time;
134     color_space_t color_space;
135     media_tray_t media_tray;
136     unsigned int num_copies;
137     bool borderless;
138     unsigned int render_flags;
139     float job_top_margin;
140     float job_left_margin;
141     float job_right_margin;
142     float job_bottom_margin;
143 
144     bool renderInReverseOrder;
145 
146     // these values are pixels
147     unsigned int print_top_margin;
148     unsigned int print_left_margin;
149     unsigned int print_right_margin;
150     unsigned int print_bottom_margin;
151 
152     // these values are in pixels
153     unsigned int pixel_units;
154     unsigned int width;
155     unsigned int height;
156     unsigned int printable_area_width;
157     unsigned int printable_area_height;
158     unsigned int strip_height;
159 
160     bool cancelled;
161     bool last_page;
162     int page_num;
163     int copy_num;
164     int copy_page_num;
165     int page_corrupted;
166     bool page_printing;
167     bool page_backside;
168 
169     bool media_size_name;
170 
171     // these values are in inches
172     float page_width;
173     float page_height;
174     float page_top_margin;
175     float page_left_margin;
176     float page_right_margin;
177     float page_bottom_margin;
178 
179     const char *print_format;
180     char *page_range;
181     pcl_t pcl_type;
182     void *plugin_data;
183     bool ipp_1_0_supported;
184     bool ipp_2_0_supported;
185     bool epcl_ipp_supported;
186     bool accepts_pclm;
187     bool accepts_pdf;
188     bool copies_supported;
189     int print_quality;
190     const char *useragent;
191     char docCategory[10];
192     const char *media_default;
193 
194     // Expected certificate if any
195     uint8 *certificate;
196     int certificate_len;
197 
198     // IPP max job-name is 2**31 - 1, we set a shorter limit
199     char job_name[MAX_ID_STRING_LENGTH + 1];
200     char job_originating_user_name[MAX_NAME_LENGTH + 1];
201     int pdf_render_resolution;
202     bool accepts_app_name;
203     bool accepts_app_version;
204     bool accepts_os_name;
205     bool accepts_os_version;
206 } wprint_job_params_t;
207 
208 typedef struct wprint_connect_info_st wprint_connect_info_t;
209 
210 /*
211  * Parameters defining how to reach a remote printing service
212  */
213 struct wprint_connect_info_st {
214     const char *printer_addr;
215     const char *uri_path;
216     const char *uri_scheme;
217     int port_num;
218     /* Timeout per retry in milliseconds */
219     long timeout;
220     /* Return non-0 if the received certificate is not acceptable. */
221     int (*validate_certificate)(struct wprint_connect_info_st *connect_info, uint8 *data, int data_len);
222     /* User-supplied data. */
223     void *user;
224 };
225 
226 /*
227  * Current state of a queued job
228  */
229 typedef enum {
230     JOB_QUEUED = 1,
231     JOB_RUNNING,
232     JOB_BLOCKED,
233     JOB_DONE
234 } wprint_job_state_t;
235 
236 typedef struct {
237     wprint_job_state_t state;
238     unsigned int blocked_reasons;
239     int job_done_result;
240     // Certificate received from printer, if any
241     uint8 *certificate;
242     int certificate_len;
243 } wprint_job_callback_params_t;
244 
245 typedef enum {
246     PRIORITY_PASSTHRU = 1,
247     PRIORITY_LOCAL,
248 } wprint_priority_t;
249 
250 /* Forward declaration (actual definition in ifc_print_job.h) */
251 struct ifc_print_job_st;
252 
253 /*
254  * Defines an interface for delivering print jobs
255  */
256 typedef struct {
257     uint32 version;
258     wprint_priority_t priority;
259 
260     char const **(*get_mime_types)(void);
261 
262     char const **(*get_print_formats)(void);
263 
264     status_t (*start_job)(wJob_t job_handle, const ifc_wprint_t *wprint_ifc,
265             const struct ifc_print_job_st *job_ifc, wprint_job_params_t *job_params);
266 
267     status_t (*print_page)(wprint_job_params_t *job_params, const char *mime_type,
268             const char *pathname);
269 
270     status_t (*print_blank_page)(wJob_t job_handle,
271             wprint_job_params_t *job_params);
272 
273     status_t (*end_job)(wprint_job_params_t *job_params);
274 } wprint_plugin_t;
275 
276 /*
277  * Initialize the wprint system. Identify and gather capabilities of available plug-ins.
278  * Returns the number of plugins found or ERROR.
279  */
280 int wprintInit(void);
281 
282 /*
283  * Call to test if wprint is running or has been shut down.
284  */
285 bool wprintIsRunning();
286 
287 /*
288  * Gets the capabilities of the specified printer.
289  */
290 status_t wprintGetCapabilities(const wprint_connect_info_t *connect_info,
291         printer_capabilities_t *printer_cap);
292 
293 /*
294  * Fills in the job params structure with default values.
295  */
296 status_t wprintGetDefaultJobParams(wprint_job_params_t *job_params);
297 
298 /*
299  * Fills in the job params structure with values in accordance with printer capabilities.
300  */
301 status_t wprintGetFinalJobParams(wprint_job_params_t *job_param,
302         const printer_capabilities_t *printer_cap);
303 
304 /*
305  * Called once per job at the start of the job. Returns a print job handle that is used in
306  * other functions of this library. Returns WPRINT_BAD_JOB_HANDLE for errors.
307  */
308 wJob_t wprintStartJob(const char *printer_addr, port_t port_num,
309         const wprint_job_params_t *job_params, const printer_capabilities_t *printer_cap,
310         const char *mime_type, const char *pathname, wprint_status_cb_t cb_fn,
311         const char *debugDir, const char *scheme);
312 
313 /*
314  * Sent once per job at the end of the job. A current print job must end for the next one
315  * to start.
316  */
317 status_t wprintEndJob(wJob_t job_handle);
318 
319 /*
320  * Sent once per page of a multi-page job to deliver a page image in a previously
321  * specified MIME type. The page_number must increment from 1. last_page flag is true if it
322  * is the last page of the job.
323  *
324  * top/left/right/bottom margin are the incremental per page margins in pixels
325  * at the current print resolution that are added on top of the physical page
326  * page margins, passing in 0 results in the default page margins being used.
327  */
328 status_t wprintPage(wJob_t job_handle, int page_number, const char *filename, bool last_page,
329         bool pdf_page, unsigned int top_margin, unsigned int left_margin,
330         unsigned int right_margin, unsigned int bottom_margin);
331 
332 /*
333  * Cancels a spooled or running job. Returns OK or ERROR
334  */
335 status_t wprintCancelJob(wJob_t job_handle);
336 
337 /*
338  * Exits the print subsystem
339  */
340 status_t wprintExit(void);
341 
342 /*
343  * Supplies info about the sending application and OS name
344  */
345 void wprintSetSourceInfo(const char *appName, const char *appVersion, const char *osName);
346 
347 /* Global variables to hold API, application, and OS details */
348 extern int g_API_version;
349 extern char g_osName[MAX_ID_STRING_LENGTH + 1];
350 extern char g_appName[MAX_ID_STRING_LENGTH + 1];
351 extern char g_appVersion[MAX_ID_STRING_LENGTH + 1];
352 
353 #ifdef __cplusplus
354 }
355 #endif
356 
357 #endif // __LIB_WPRINT_H__