libcapsraster-api.h

Go to the documentation of this file.

#pragma once
 
/*
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * (c) 2018 Juergen Borleis <projects@caps-printing.org>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 */
 
#include <libcapsprovider.h>
#include <libcapsppd.h>
#include <features.h>
 
__BEGIN_DECLS
 
struct caps_rasterizer;
struct caps_pp_handle;
struct caps_pp_page;
 
#define LIBCAPSRASTER_MAJOR 1
#define LIBCAPSRASTER_MINOR 1
#define LIBCAPSRASTER_MICRO 0
void caps_libraster_version_get(unsigned *major, unsigned *minor, unsigned *micro) __nonnull();
enum caps_rstr_feature {
    CAPS_RSTR_NOTHING = 0,
    CAPS_RSTR_HW_COPY, 
};
const struct caps_supported_mime_list *caps_rstr_mime_list_get(void) __const __returns_nonnull;
void caps_librstr_init(void);
struct caps_rasterizer *caps_rstr_create(void) __returns_nonnull;
void caps_rstr_destroy(struct caps_rasterizer *rstr) __nonnull();
struct caps_rstr_page_desc {
    /* The printing state machine */
    unsigned no; 
    unsigned copies; 
    unsigned duplex_front:1; 
    unsigned duplex_reverse:1; 
    unsigned last_page:1; 
    unsigned eject_medium:1; 
    /* The document's page dimension */
    const char *medium_name; 
    struct caps_rect medium_sz; 
    struct caps_area printing_area; 
    struct caps_rect printing_sz; 
} __attribute__((designated_init));
struct caps_rstr_page_limits {
    unsigned max_line_length; 
    unsigned max_width; 
    unsigned max_length; 
    enum caps_colour_format cf; 
};
#define FAV_ROTATION_NONE (0)
#define FAV_ROTATION_COUNTERCLOCKWISE (-90)
#define FAV_ROTATION_CLOCKWISE (+90)
struct caps_rstr_page {
    /* Print medium description */
    struct caps_rect medium_sz; 
    struct caps_area margins; 
    int rotation_favoured; 
    /* Raster configuration (default or user settings) */
    enum caps_colour_format cf; 
    double resolution_horizontal; 
    double resolution_vertical; 
} __attribute__((designated_init));
struct caps_rstr_raster {
    /* The following medium size is the base for the raster information below */
    unsigned medium_width; 
    unsigned medium_length; 
    /*
     * Since margins and raster offset can overlap, we need the correct margins here
     * The following information are required to re-create a raster which covers the whole
     * medium, even if the raster is smaller than the medium or (seldom) larger.
     * Refer #caps_rstr_raster_get() for calculation.
     */
    unsigned margin_bottom; 
    unsigned margin_right; 
    unsigned margin_top; 
    unsigned margin_left; 
    /*
     * Raster position on the medium (for scaled raster), both can be 0 for a raster which fits exactly into the medium.
     * But in this case the margins must still be considered!
     * The raster position already includes all kind of alignments.
     */
    unsigned offset_top; 
    unsigned offset_left; 
    /* Real and available raster description */
    unsigned width; 
    unsigned length; 
    unsigned dot_size; 
    enum caps_colour_format cf; 
    const void *buffer; 
    ptrdiff_t line_length; 
} __attribute__((designated_init));
int caps_rstr_job_attach(struct caps_rasterizer *rstr, int fd, struct caps_ppd_options_table *ppd_options, const char *params) __nonnull((1,3)) __warn_unused_res;
void caps_rstr_job_detach(struct caps_rasterizer *rstr) __nonnull();
struct caps_rstr_page_limits caps_rstr_limits_get(struct caps_rasterizer *rstr) __nonnull();
void caps_rstr_printer_feature_set(struct caps_rasterizer *rstr, enum caps_rstr_feature feature) __nonnull();
int caps_rstr_page_get_next(struct caps_rasterizer *rstr, const struct caps_rstr_page_desc **pg_desc) __nonnull();
int caps_rstr_page_rasterize(struct caps_rasterizer *rstr, const struct caps_rstr_page *pg) __nonnull();
int caps_rstr_raster_get(struct caps_rasterizer *rstr, struct caps_rstr_raster *desc) __nonnull();
const void *caps_rstr_line_get(struct caps_rasterizer *rstr, const struct caps_rstr_raster *desc, unsigned line_no) __nonnull() __returns_nonnull;
const char *caps_rstr_job_mime_get(const struct caps_rasterizer *rstr) __nonnull() __pure;
bool caps_rstr_job_is_duplex(struct caps_rasterizer *rstr) __nonnull();
bool caps_rstr_job_is_collating(struct caps_rasterizer *rstr) __nonnull();
enum caps_ppd_color_formats caps_rstr_job_color_mode_get(struct caps_rasterizer *rstr) __nonnull();
const char *caps_rstr_job_medium_format_name_get(struct caps_rasterizer *rstr) __nonnull() __returns_nonnull;
const struct caps_ppd_resolution *caps_rstr_job_resolution_get(struct caps_rasterizer *rstr) __nonnull();
enum caps_ppd_paper_leading_edges caps_rstr_job_medium_orientation_get(struct caps_rasterizer *rstr) __nonnull();
struct caps_rect caps_rstr_job_medium_size_get(struct caps_rasterizer *rstr) __nonnull();
struct caps_area caps_rstr_job_medium_imageable_get(struct caps_rasterizer *rstr) __nonnull();
struct caps_area caps_rstr_job_medium_margins_get(struct caps_rasterizer *rstr) __nonnull();
unsigned caps_rstr_job_copies_get(struct caps_rasterizer *rstr) __nonnull();
const char *caps_rstr_job_value_get(struct caps_rasterizer *rstr, const char *keyword, const char *name) __nonnull((1,2));
const char *caps_rstr_job_choice_get(struct caps_rasterizer *rstr, const char *keyword) __nonnull();
const struct caps_job_progression *caps_rstr_job_progression_get(struct caps_rasterizer *rstr) __nonnull();
const char *caps_rstr_format_name_get(const struct caps_rect *size) __nonnull();
struct caps_rect caps_rstr_format_size_get(const char *format_name) __nonnull();
int caps_rstr_format_validate(const char *format_name) __nonnull();
int caps_rstr_page_default_setup(struct caps_rasterizer *rstr, struct caps_rstr_page *pg) __nonnull();
int caps_rstr_predictive_size_get(struct caps_rasterizer *rstr, struct caps_rect size, struct caps_rect *psize) __nonnull();
__END_DECLS