#include "mupdf/fitz/system.h"#include "mupdf/fitz/context.h"#include "mupdf/fitz/output.h"#include "mupdf/fitz/band-writer.h"#include "mupdf/fitz/pixmap.h"#include "mupdf/fitz/bitmap.h"#include "mupdf/fitz/buffer.h"#include "mupdf/fitz/image.h"#include "mupdf/fitz/writer.h"
Go to the source code of this file.
Classes | |
| struct | fz_pcl_options |
| struct | fz_pclm_options |
| struct | fz_pdfocr_options |
| struct | fz_pwg_options |
Function Documentation
◆ fz_apply_pcl_options()
| void fz_apply_pcl_options | ( | fz_context * | ctx, |
| fz_pcl_options * | opts, | ||
| fz_options * | args ) |
◆ fz_apply_pclm_options()
| void fz_apply_pclm_options | ( | fz_context * | ctx, |
| fz_pclm_options * | opts, | ||
| fz_options * | args ) |
◆ fz_apply_pdfocr_options()
| void fz_apply_pdfocr_options | ( | fz_context * | ctx, |
| fz_pdfocr_options * | opts, | ||
| fz_options * | options ) |
◆ fz_apply_pwg_options()
| void fz_apply_pwg_options | ( | fz_context * | ctx, |
| fz_pwg_options * | opts, | ||
| fz_options * | args ) |
Apply the given options to an initialised pwg options struct.
◆ fz_init_pcl_options()
| void fz_init_pcl_options | ( | fz_context * | ctx, |
| fz_pcl_options * | opts ) |
Parse PCL options.
Currently defined options and values are as follows:
preset=X Either "generic" or one of the presets as for fz_pcl_preset. spacing=0 No vertical spacing capability spacing=1 PCL 3 spacing (<ESC>*p+<n>Y) spacing=2 PCL 4 spacing (<ESC>*b<n>Y) spacing=3 PCL 5 spacing (<ESC>*b<n>Y and clear seed row) mode2 Disable/Enable mode 2 graphics compression mode3 Disable/Enable mode 3 graphics compression eog_reset End of graphics (<ESC>*rB) resets all parameters has_duplex Duplex supported (<ESC>&l<duplex>S) has_papersize Papersize setting supported (<ESC>&l<sizecode>A) has_copies Number of copies supported (<ESC>&l<copies>X) is_ljet4pjl Disable/Enable HP 4PJL model-specific output is_oce9050 Disable/Enable Oce 9050 model-specific output
◆ fz_init_pclm_options()
| void fz_init_pclm_options | ( | fz_context * | ctx, |
| fz_pclm_options * | opts ) |
Parse PCLm options.
Currently defined options and values are as follows:
compression=none: No compression compression=flate: Flate compression strip-height=n: Strip height (default 16)
◆ fz_init_pdfocr_options()
| void fz_init_pdfocr_options | ( | fz_context * | ctx, |
| fz_pdfocr_options * | opts ) |
Parse PDFOCR options.
Currently defined options and values are as follows:
compression=none: No compression compression=flate: Flate compression strip-height=n: Strip height (default 16) ocr-language=<lang>: OCR Language (default eng) ocr-datadir=<datadir>: OCR data path (default rely on TESSDATA_PREFIX)
◆ fz_init_pwg_options()
| void fz_init_pwg_options | ( | fz_context * | ctx, |
| fz_pwg_options * | opts ) |
Init pwg options to a sensible default.
◆ fz_new_buffer_from_image_as_jpeg()
| fz_buffer * fz_new_buffer_from_image_as_jpeg | ( | fz_context * | ctx, |
| fz_image * | image, | ||
| fz_color_params | color_params, | ||
| int | quality, | ||
| int | invert_cmyk ) |
◆ fz_new_buffer_from_image_as_jpx()
| fz_buffer * fz_new_buffer_from_image_as_jpx | ( | fz_context * | ctx, |
| fz_image * | image, | ||
| fz_color_params | color_params, | ||
| int | quality ) |
◆ fz_new_buffer_from_image_as_pam()
| fz_buffer * fz_new_buffer_from_image_as_pam | ( | fz_context * | ctx, |
| fz_image * | image, | ||
| fz_color_params | color_params ) |
◆ fz_new_buffer_from_image_as_pbm()
| fz_buffer * fz_new_buffer_from_image_as_pbm | ( | fz_context * | ctx, |
| fz_image * | image, | ||
| fz_color_params | color_params ) |
◆ fz_new_buffer_from_image_as_pkm()
| fz_buffer * fz_new_buffer_from_image_as_pkm | ( | fz_context * | ctx, |
| fz_image * | image, | ||
| fz_color_params | color_params ) |
◆ fz_new_buffer_from_image_as_png()
| fz_buffer * fz_new_buffer_from_image_as_png | ( | fz_context * | ctx, |
| fz_image * | image, | ||
| fz_color_params | color_params ) |
Re-encode a given image as a PNG into a buffer.
Ownership of the buffer is returned.
◆ fz_new_buffer_from_image_as_pnm()
| fz_buffer * fz_new_buffer_from_image_as_pnm | ( | fz_context * | ctx, |
| fz_image * | image, | ||
| fz_color_params | color_params ) |
◆ fz_new_buffer_from_image_as_psd()
| fz_buffer * fz_new_buffer_from_image_as_psd | ( | fz_context * | ctx, |
| fz_image * | image, | ||
| fz_color_params | color_params ) |
◆ fz_new_buffer_from_pixmap_as_jpeg()
| fz_buffer * fz_new_buffer_from_pixmap_as_jpeg | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| fz_color_params | color_params, | ||
| int | quality, | ||
| int | invert_cmyk ) |
◆ fz_new_buffer_from_pixmap_as_jpx()
| fz_buffer * fz_new_buffer_from_pixmap_as_jpx | ( | fz_context * | ctx, |
| fz_pixmap * | pix, | ||
| fz_color_params | color_params, | ||
| int | quality ) |
◆ fz_new_buffer_from_pixmap_as_pam()
| fz_buffer * fz_new_buffer_from_pixmap_as_pam | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| fz_color_params | color_params ) |
◆ fz_new_buffer_from_pixmap_as_pbm()
| fz_buffer * fz_new_buffer_from_pixmap_as_pbm | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| fz_color_params | color_params ) |
◆ fz_new_buffer_from_pixmap_as_pkm()
| fz_buffer * fz_new_buffer_from_pixmap_as_pkm | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| fz_color_params | color_params ) |
◆ fz_new_buffer_from_pixmap_as_png()
| fz_buffer * fz_new_buffer_from_pixmap_as_png | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| fz_color_params | color_params ) |
Re-encode a given pixmap as a PNG into a buffer.
Ownership of the buffer is returned.
◆ fz_new_buffer_from_pixmap_as_pnm()
| fz_buffer * fz_new_buffer_from_pixmap_as_pnm | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| fz_color_params | color_params ) |
◆ fz_new_buffer_from_pixmap_as_psd()
| fz_buffer * fz_new_buffer_from_pixmap_as_psd | ( | fz_context * | ctx, |
| fz_pixmap * | pix, | ||
| fz_color_params | color_params ) |
◆ fz_new_color_pcl_band_writer()
| fz_band_writer * fz_new_color_pcl_band_writer | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_pcl_options * | options ) |
Create a new band writer, outputting color pcl.
◆ fz_new_mono_pcl_band_writer()
| fz_band_writer * fz_new_mono_pcl_band_writer | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_pcl_options * | options ) |
Create a new band writer, outputting monochrome pcl.
◆ fz_new_mono_pwg_band_writer()
| fz_band_writer * fz_new_mono_pwg_band_writer | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_pwg_options * | pwg ) |
Create a new monochrome pwg band writer.
◆ fz_new_pam_band_writer()
| fz_band_writer * fz_new_pam_band_writer | ( | fz_context * | ctx, |
| fz_output * | out ) |
Create a band writer targeting pnm (greyscale, rgb or cmyk, with or without alpha).
◆ fz_new_pbm_band_writer()
| fz_band_writer * fz_new_pbm_band_writer | ( | fz_context * | ctx, |
| fz_output * | out ) |
Create a new band writer, targeting pbm.
◆ fz_new_pclm_band_writer()
| fz_band_writer * fz_new_pclm_band_writer | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_pclm_options * | options ) |
Create a new band writer, outputting pclm
◆ fz_new_pdfocr_band_writer()
| fz_band_writer * fz_new_pdfocr_band_writer | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_pdfocr_options * | options ) |
Create a new band writer, outputting pdfocr.
Ownership of output stays with the caller, the band writer borrows the reference. The caller must keep the output around for the duration of the band writer, and then close/drop as appropriate.
◆ fz_new_pkm_band_writer()
| fz_band_writer * fz_new_pkm_band_writer | ( | fz_context * | ctx, |
| fz_output * | out ) |
Create a new pkm band writer for CMYK pixmaps.
◆ fz_new_png_band_writer()
| fz_band_writer * fz_new_png_band_writer | ( | fz_context * | ctx, |
| fz_output * | out ) |
Create a new png band writer (greyscale or RGB, with or without alpha).
◆ fz_new_pnm_band_writer()
| fz_band_writer * fz_new_pnm_band_writer | ( | fz_context * | ctx, |
| fz_output * | out ) |
Create a band writer targeting pnm (greyscale or rgb, no alpha).
◆ fz_new_ps_band_writer()
| fz_band_writer * fz_new_ps_band_writer | ( | fz_context * | ctx, |
| fz_output * | out ) |
Create a postscript band writer for gray, rgb, or cmyk, no alpha.
◆ fz_new_psd_band_writer()
| fz_band_writer * fz_new_psd_band_writer | ( | fz_context * | ctx, |
| fz_output * | out ) |
Open a PSD band writer.
◆ fz_new_pwg_band_writer()
| fz_band_writer * fz_new_pwg_band_writer | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_pwg_options * | pwg ) |
Create a new color pwg band writer.
◆ fz_parse_pcl_options()
| fz_pcl_options * fz_parse_pcl_options | ( | fz_context * | ctx, |
| fz_pcl_options * | opts, | ||
| const char * | args ) |
◆ fz_parse_pclm_options()
| fz_pclm_options * fz_parse_pclm_options | ( | fz_context * | ctx, |
| fz_pclm_options * | opts, | ||
| const char * | args ) |
◆ fz_parse_pdfocr_options()
| fz_pdfocr_options * fz_parse_pdfocr_options | ( | fz_context * | ctx, |
| fz_pdfocr_options * | opts, | ||
| const char * | args ) |
◆ fz_parse_pwg_options()
| fz_pwg_options * fz_parse_pwg_options | ( | fz_context * | ctx, |
| fz_pwg_options * | opts, | ||
| const char * | args ) |
Initialise a pwg options struct, and parse the given options string.
◆ fz_pcl_preset()
| void fz_pcl_preset | ( | fz_context * | ctx, |
| fz_pcl_options * | opts, | ||
| const char * | preset ) |
Initialize PCL option struct for a given preset.
Currently defined presets include:
generic Generic PCL printer ljet4 HP DeskJet dj500 HP DeskJet 500 fs600 Kyocera FS-600 lj HP LaserJet, HP LaserJet Plus lj2 HP LaserJet IIp, HP LaserJet IId lj3 HP LaserJet III lj3d HP LaserJet IIId lj4 HP LaserJet 4 lj4pl HP LaserJet 4 PL lj4d HP LaserJet 4d lp2563b HP 2563B line printer oce9050 Oce 9050 Line printer
◆ fz_pdfocr_band_writer_set_progress()
| void fz_pdfocr_band_writer_set_progress | ( | fz_context * | ctx, |
| fz_band_writer * | writer, | ||
| fz_pdfocr_progress_fn * | progress_fn, | ||
| void * | progress_arg ) |
Set the progress callback for a pdfocr bandwriter.
◆ fz_save_bitmap_as_pbm()
| void fz_save_bitmap_as_pbm | ( | fz_context * | ctx, |
| fz_bitmap * | bitmap, | ||
| const char * | filename ) |
Save a bitmap as a pbm.
◆ fz_save_bitmap_as_pcl()
| void fz_save_bitmap_as_pcl | ( | fz_context * | ctx, |
| fz_bitmap * | bitmap, | ||
| char * | filename, | ||
| int | append, | ||
| const fz_pcl_options * | pcl ) |
Save a bitmap as mono PCL.
◆ fz_save_bitmap_as_pkm()
| void fz_save_bitmap_as_pkm | ( | fz_context * | ctx, |
| fz_bitmap * | bitmap, | ||
| const char * | filename ) |
Save a CMYK bitmap as a pkm.
◆ fz_save_bitmap_as_pwg()
| void fz_save_bitmap_as_pwg | ( | fz_context * | ctx, |
| fz_bitmap * | bitmap, | ||
| char * | filename, | ||
| int | append, | ||
| const fz_pwg_options * | pwg ) |
Save a bitmap as a PWG.
◆ fz_save_pixmap_as_jpeg()
| void fz_save_pixmap_as_jpeg | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| const char * | filename, | ||
| int | quality ) |
Save a pixmap as a JPEG.
◆ fz_save_pixmap_as_jpx()
| void fz_save_pixmap_as_jpx | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| const char * | filename, | ||
| int | q ) |
Save pixmap data as JP2K with no subsampling.
quality = 100 = lossless otherwise for a factor of x compression use 100-x. (so 80 is 1:20 compression)
◆ fz_save_pixmap_as_pam()
| void fz_save_pixmap_as_pam | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| const char * | filename ) |
Save a pixmap as a pnm (greyscale, rgb or cmyk, with or without alpha).
◆ fz_save_pixmap_as_pbm()
| void fz_save_pixmap_as_pbm | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| const char * | filename ) |
Save a pixmap as a pbm. (Performing halftoning).
◆ fz_save_pixmap_as_pcl()
| void fz_save_pixmap_as_pcl | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| char * | filename, | ||
| int | append, | ||
| const fz_pcl_options * | pcl ) |
Save an (RGB) pixmap as color PCL.
◆ fz_save_pixmap_as_pclm()
| void fz_save_pixmap_as_pclm | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| const char * | filename, | ||
| int | append, | ||
| const fz_pclm_options * | options ) |
Save a (Greyscale or RGB) pixmap as pclm.
◆ fz_save_pixmap_as_pdfocr()
| void fz_save_pixmap_as_pdfocr | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| char * | filename, | ||
| int | append, | ||
| const fz_pdfocr_options * | options ) |
Save a (Greyscale or RGB) pixmap as pdfocr.
◆ fz_save_pixmap_as_pkm()
| void fz_save_pixmap_as_pkm | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| const char * | filename ) |
Save a CMYK pixmap as a pkm. (Performing halftoning).
◆ fz_save_pixmap_as_png()
| void fz_save_pixmap_as_png | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| const char * | filename ) |
Save a (Greyscale or RGB) pixmap as a png.
◆ fz_save_pixmap_as_pnm()
| void fz_save_pixmap_as_pnm | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| const char * | filename ) |
Save a pixmap as a pnm (greyscale or rgb, no alpha).
◆ fz_save_pixmap_as_ps()
| void fz_save_pixmap_as_ps | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| char * | filename, | ||
| int | append ) |
Save a (gray, rgb, or cmyk, no alpha) pixmap out as postscript.
◆ fz_save_pixmap_as_psd()
| void fz_save_pixmap_as_psd | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| const char * | filename ) |
Save a pixmap as a PSD file.
◆ fz_save_pixmap_as_pwg()
| void fz_save_pixmap_as_pwg | ( | fz_context * | ctx, |
| fz_pixmap * | pixmap, | ||
| char * | filename, | ||
| int | append, | ||
| const fz_pwg_options * | pwg ) |
Save a pixmap as a PWG.
◆ fz_write_bitmap_as_pbm()
| void fz_write_bitmap_as_pbm | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| fz_bitmap * | bitmap ) |
Write a bitmap as a pbm.
◆ fz_write_bitmap_as_pcl()
| void fz_write_bitmap_as_pcl | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_bitmap * | bitmap, | ||
| const fz_pcl_options * | pcl ) |
Write a bitmap as mono PCL.
◆ fz_write_bitmap_as_pkm()
| void fz_write_bitmap_as_pkm | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| fz_bitmap * | bitmap ) |
Write a CMYK bitmap as a pkm.
◆ fz_write_bitmap_as_pwg()
| void fz_write_bitmap_as_pwg | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_bitmap * | bitmap, | ||
| const fz_pwg_options * | pwg ) |
Write a bitmap as a PWG.
◆ fz_write_bitmap_as_pwg_page()
| void fz_write_bitmap_as_pwg_page | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_bitmap * | bitmap, | ||
| const fz_pwg_options * | pwg ) |
Write a bitmap as a PWG page.
Caller should provide a file header by calling fz_write_pwg_file_header, but can then write several pages to the same file.
◆ fz_write_pixmap_as_jpeg()
| void fz_write_pixmap_as_jpeg | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| fz_pixmap * | pix, | ||
| int | quality, | ||
| int | invert_cmyk ) |
Write a pixmap as a JPEG.
◆ fz_write_pixmap_as_jpx()
| void fz_write_pixmap_as_jpx | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| fz_pixmap * | pix, | ||
| int | quality ) |
Pixmap data as JP2K with no subsampling.
quality = 100 = lossless otherwise for a factor of x compression use 100-x. (so 80 is 1:20 compression)
◆ fz_write_pixmap_as_pam()
| void fz_write_pixmap_as_pam | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| fz_pixmap * | pixmap ) |
Write a pixmap as a pnm (greyscale, rgb or cmyk, with or without alpha).
◆ fz_write_pixmap_as_pbm()
| void fz_write_pixmap_as_pbm | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| fz_pixmap * | pixmap ) |
◆ fz_write_pixmap_as_pcl()
| void fz_write_pixmap_as_pcl | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_pixmap * | pixmap, | ||
| const fz_pcl_options * | pcl ) |
Write an (RGB) pixmap as color PCL.
◆ fz_write_pixmap_as_pclm()
| void fz_write_pixmap_as_pclm | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_pixmap * | pixmap, | ||
| const fz_pclm_options * | options ) |
Write a (Greyscale or RGB) pixmap as pclm.
◆ fz_write_pixmap_as_pdfocr()
| void fz_write_pixmap_as_pdfocr | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_pixmap * | pixmap, | ||
| const fz_pdfocr_options * | options ) |
Write a (Greyscale or RGB) pixmap as pdfocr.
◆ fz_write_pixmap_as_pkm()
| void fz_write_pixmap_as_pkm | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| fz_pixmap * | pixmap ) |
◆ fz_write_pixmap_as_png()
| void fz_write_pixmap_as_png | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| fz_pixmap * | pixmap ) |
Write a (Greyscale or RGB) pixmap as a png.
◆ fz_write_pixmap_as_pnm()
| void fz_write_pixmap_as_pnm | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| fz_pixmap * | pixmap ) |
Write a pixmap as a pnm (greyscale or rgb, no alpha).
◆ fz_write_pixmap_as_ps()
| void fz_write_pixmap_as_ps | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_pixmap * | pixmap ) |
Write a (gray, rgb, or cmyk, no alpha) pixmap out as postscript.
◆ fz_write_pixmap_as_psd()
| void fz_write_pixmap_as_psd | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_pixmap * | pixmap ) |
Write a pixmap as a PSD file.
◆ fz_write_pixmap_as_pwg()
| void fz_write_pixmap_as_pwg | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_pixmap * | pixmap, | ||
| const fz_pwg_options * | pwg ) |
Write a pixmap as a PWG.
◆ fz_write_pixmap_as_pwg_page()
| void fz_write_pixmap_as_pwg_page | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| const fz_pixmap * | pixmap, | ||
| const fz_pwg_options * | pwg ) |
Write a pixmap as a PWG page.
Caller should provide a file header by calling fz_write_pwg_file_header, but can then write several pages to the same file.
◆ fz_write_ps_file_header()
| void fz_write_ps_file_header | ( | fz_context * | ctx, |
| fz_output * | out ) |
Write the file level header for ps band writer output.
◆ fz_write_ps_file_trailer()
| void fz_write_ps_file_trailer | ( | fz_context * | ctx, |
| fz_output * | out, | ||
| int | pages ) |
Write the file level trailer for ps band writer output.
◆ fz_write_pwg_file_header()
| void fz_write_pwg_file_header | ( | fz_context * | ctx, |
| fz_output * | out ) |
Output the file header to a pwg stream, ready for pages to follow it.
