libcapsraster-local.h

Go to the documentation of this file.

#pragma once
 
/*
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * (c) 2018 Juergen Borleis <flap@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 <math.h>
 
#include <libcapsbase.h>
#include <libcapsppcommon.h>
 
#ifdef DEBUG
# define caps_print_debug(fmt, ...) caps_print_debug_template(fmt, ##__VA_ARGS__)
#else
# define caps_print_debug(fmt, ...)
#endif
 
#ifdef DSO_HIDDEN
# define DSO_VISIBLE __attribute__ ((visibility("default")))
#else
# define DSO_VISIBLE
#endif /* DSO_HIDDEN */
 
#ifndef ARRAY_SIZE
# define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
#endif
 
#ifdef ENABLE_NLS
 
# ifndef PACKAGE
#  error "Missing 'PACKAGE' macro: include 'config.h' first"
# endif /* PACKAGE */
 
# define _(string) dgettext(PACKAGE, string)
# include <libintl.h>
 
#else /* ENABLE_NLS */
 
# define _(string) (string)
 
#endif /* ENABLE_NLS */
 
#define NLS_(string) (string)
 
#include "libcapsraster-api.h"
 
struct rasterizer_info;
struct caps_rasterizer;
struct raster_adapt_preparation;
 
enum rstr_tweaks {
    RSTRS_INHERIT_FILEDESC = 1, 
};
 
struct rstr_provider {
    const char *name; 
    enum rstr_tweaks tweaks; 
    int (*init)(struct caps_rasterizer *rstr); 
    int (*job_start)(struct caps_rasterizer *rstr, unsigned *pcnt); 
    int (*page_next)(struct caps_rasterizer *rstr); 
    int (*page_render)(struct caps_rasterizer *rstr, const struct caps_rstr_page *page_conf, struct raster_adapt_preparation *raster_conf); 
    int (*page_image_get)(struct caps_rasterizer *rstr, struct caps_rstr_raster *desc); 
    const void *(*line_get)(struct caps_rasterizer *rstr, const struct caps_rstr_raster *desc, unsigned line_no); 
    void (*job_end)(struct caps_rasterizer *rstr); 
    int (*exit)(struct caps_rasterizer *rstr); 
};
 
struct raster_adapt_preparation {
    /*
     * Information about the input format and how the rasterizer should process it
     * Note: this information reflects the original size and orientation of the document
     */
    /* note: source_sz isn't redundant. Think about printing a DIN A3 document on a DIN A4 printer */
    struct caps_rect source_sz; 
    struct caps_area source_area; 
    int source_area_used; 
    struct caps_rect source_print_sz; 
    /*
     * Information how to convert from #source_sz to #target_sz into the final raster
     */
    double scale_x; 
    double scale_y; 
    int print_rotation; 
    double raster_resolution_x; 
    double raster_resolution_y; 
    enum caps_colour_format raster_cf; 
    /*
     * Information about the real target medium the printer driver provides
     * Note: this information reflects the size and orientation,
     *       defined by the printer driver
     */
    struct caps_rect target_sz; 
    struct caps_area target_area; 
    struct caps_rect target_area_sz; 
    /*
     * The raster may not fill the whole #target_sz. For example this could happen
     * if a DIN A5 document should be printed on a DIN A4 print medium.
     * In this case the raster can be placed somewhere on the print medium. "somewhere" depends on
     * the alignment printing parameters.
     */
    double raster_offset_x; 
    double raster_offset_y; 
};
 
struct rstr_print_state {
    /* printer supported features */
    unsigned hw_copy:1; 
    unsigned front_page_no; /* -> setze duplex_front, wenn diese Seite reingereicht wird */
    unsigned reverse_page_no; /* -> setzt duplex_reverse, wenn diese Seite reingereicht wird, setzt eject_media wenn damit die Seite fertig ist */
    unsigned current_page; 
    unsigned cur_page_kept:1; 
    unsigned copies_to_be_done; 
    unsigned print_media_amount; 
    unsigned print_media_done; 
    unsigned last_medium_reached:1; 
    enum caps_colour_format req_format; 
};
 
struct doc_page_range_entry {
    unsigned first; 
    unsigned last; 
};
 
struct doc_range_list {
    struct caps_var_table entries; 
    ssize_t iterator; 
};
 
struct doc_page_range {
    struct doc_range_list print_ranges; 
    unsigned document_pages; 
    unsigned overall_pages_to_print;
};
 
enum caps_rstr_alignment {
    CAPS_RSTR_ALIGN_CENTER = 0,
    CAPS_RSTR_ALIGN_TOP = 1,
    CAPS_RSTR_ALIGN_BOTTOM = 2,
    CAPS_RSTR_ALIGN_LEFT = 4,
    CAPS_RSTR_ALIGN_RIGHT = 8,
};
 
enum caps_rstr_orientation {
    CAPS_RSTR_ORIENT_HEAD_UP = 0, 
    CAPS_RSTR_ORIENT_LANDSCAPE = 1, 
    CAPS_RSTR_ORIENT_HEAD_DOWN = 2, 
    CAPS_RSTR_ORIENT_SEASCAPE = 3, 
};
 
#define JOB_ORIENTATION_UNSET 360
 
struct document_desc {
    int fh; 
    const char *mime_type; 
    /* Job's print settings, contain all the defaults plus processed job's printing parameters */
    unsigned copies; 
    unsigned collate:1; 
    /* If both the following variables are '0', print in simplex mode, related to printing parameter 'sides=one-sided' */
    unsigned duplex_long_edge:1; 
    unsigned duplex_short_edge:1; 
    unsigned fidelity:1; 
    unsigned rotation_auto:1; 
    enum caps_rstr_orientation orientation; 
    unsigned fit_auto:1; 
    unsigned fit_to_medium:1; 
    unsigned fit_to_imageable_area:1; 
    enum caps_rstr_alignment alignment; 
    struct caps_ppd_resolution resolution; 
    struct caps_ppd_options_table *ppd_options; 
    struct doc_page_range page_range_info;
 
    /* dynamic info about the job */
    struct rstr_print_state state; 
    struct caps_rstr_page_desc pg_desc; 
    struct caps_job_progression prog_info; 
};
 
struct caps_rasterizer {
    const struct rstr_provider *provider;
    struct caps_rstr_page_limits limits; 
    struct document_desc *raster_job;
 
    struct raster_adapt_preparation setup; 
    struct rasterizer_info *info; 
};
 
#define RSTR_ALL_CFORMATS (/*CAPS_CF_MONOCHROME0 | CAPS_CF_MONOCHROME1 |*/ CAPS_CF_GREY | CAPS_CF_RGB | CAPS_CF_CMYK)
 
/* from libcapsraster-helper.c */
void handle_initial_page(struct document_desc *job, unsigned pcnt) __nonnull();
int handle_next_page(struct document_desc *job) __nonnull();
void page_setup(struct document_desc *job, struct raster_adapt_preparation *setup, const struct caps_rstr_page *page) __nonnull();
 
/* from doc-print-simplex.c */
void simplex_next_page(struct document_desc *job) __nonnull();
void simplex_collating_next_page(struct document_desc *job) __nonnull();
 
/* from doc-print-duplex.c */
void duplex_collating_next_page(struct document_desc *job) __nonnull();
void duplex_next_page(struct document_desc *job) __nonnull();
 
/* from doc-page-iterator.c */
unsigned job_page_get_next(struct document_desc *job, unsigned cpage) __nonnull();
unsigned job_page_count_calculate(struct document_desc *job, unsigned pgs) __nonnull();
struct document_desc *job_create(int fd, struct caps_ppd_options_table *ppd_options, const char *params) __nonnull((2));
void job_destroy(struct document_desc *job) __nonnull();
int job_file_seek(struct document_desc *job, off_t offset) __nonnull();
ssize_t job_file_read(struct document_desc *job, void *buf, size_t count) __nonnull();
bool job_is_duplex(struct document_desc *job) __nonnull();
bool job_is_collating(struct document_desc *job) __nonnull();
unsigned job_copies_get(struct document_desc *job) __nonnull();
 
#define ptsperinch 72.0
 
#define RECT_IS_PORTRAIT 1
#define RECT_IS_LANDSCAPE 0
 
static inline __nonnull() int rect_orient(const struct caps_rect *rect)
{
    if (isgreater(rect->width, rect->length))
        return RECT_IS_LANDSCAPE;
 
    return RECT_IS_PORTRAIT;
}
 
static inline struct caps_rect rect_tip_over(const struct caps_rect r)
{
    struct caps_rect ro;
 
    ro.width = r.length;
    ro.length = r.width;
 
    return ro;
}
 
static __const inline unsigned pts_to_pixel(double pts, double resolution)
{
    return (unsigned)(((pts * resolution) / ptsperinch) + 0.5);
}