pdf.h File Reference

#include <glib.h>
#include <glib/gi18n.h>
#include <inttypes.h>
#include <stdio.h>

Include dependency graph for pdf.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	dt_pdf_t
struct	dt_pdf_image_t
struct	dt_pdf_page_t

Macros
#define	dt_pdf_inch_to_point(inch)   ((inch) * 72.0)
#define	dt_pdf_point_to_inch(pt)   ((pt) / 72.0)
#define	dt_pdf_mm_to_point(mm)   dt_pdf_inch_to_point((mm) / 25.4)
#define	dt_pdf_point_to_mm(pt)   dt_pdf_point_to_inch((pt) * 25.4)
#define	dt_pdf_point_to_pixel(pt, dpi)   (dt_pdf_point_to_inch(pt) * (dpi))
#define	dt_pdf_pixel_to_point(px, dpi)   (dt_pdf_inch_to_point((px) / (dpi)))

Typedefs
typedef enum dt_pdf_stream_encoder_t	dt_pdf_stream_encoder_t
typedef struct dt_pdf_t	dt_pdf_t
typedef struct dt_pdf_image_t	dt_pdf_image_t
typedef struct dt_pdf_page_t	dt_pdf_page_t

Enumerations
enum	dt_pdf_stream_encoder_t {   DT_PDF_STREAM_ENCODER_ASCII_HEX = 0 ,   DT_PDF_STREAM_ENCODER_FLATE = 1 }

Functions
dt_pdf_t *	dt_pdf_start (const char *filename, float width, float height, float dpi, dt_pdf_stream_encoder_t default_encoder)
int	dt_pdf_add_icc (dt_pdf_t *pdf, const char *filename)
int	dt_pdf_add_icc_from_data (dt_pdf_t *pdf, const unsigned char *data, size_t size)
dt_pdf_image_t *	dt_pdf_add_image (dt_pdf_t *pdf, const unsigned char *image, int width, int height, int bpp, int icc_id, float border)
dt_pdf_page_t *	dt_pdf_add_page (dt_pdf_t *pdf, dt_pdf_image_t **images, int n_images)
void	dt_pdf_finish (dt_pdf_t *pdf, dt_pdf_page_t **pages, int n_pages)
int	dt_pdf_parse_length (const char *str, float *length)
int	dt_pdf_parse_paper_size (const char *str, float *width, float *height)

Variables
struct {
const char *   name
const float   factor
}	dt_pdf_units []
static const int	dt_pdf_units_n = sizeof(dt_pdf_units) / sizeof(dt_pdf_units[0])
struct {
const char *   name
const float   width
const float   height
}	dt_pdf_paper_sizes []
static const int	dt_pdf_paper_sizes_n = sizeof(dt_pdf_paper_sizes) / sizeof(dt_pdf_paper_sizes[0]) - 1

Macro Definition Documentation

dt_pdf_inch_to_point

#define dt_pdf_inch_to_point

(

inch

)

((inch) * 72.0)

Definition at line 40 of file pdf.h.

dt_pdf_mm_to_point

#define dt_pdf_mm_to_point

(

mm

)

dt_pdf_inch_to_point((mm) / 25.4)

Definition at line 42 of file pdf.h.

dt_pdf_pixel_to_point

#define dt_pdf_pixel_to_point	(		px,
			dpi
	)		(dt_pdf_inch_to_point((px) / (dpi)))

Definition at line 45 of file pdf.h.

dt_pdf_point_to_inch

#define dt_pdf_point_to_inch

(

pt

)

((pt) / 72.0)

Definition at line 41 of file pdf.h.

dt_pdf_point_to_mm

#define dt_pdf_point_to_mm

(

pt

)

dt_pdf_point_to_inch((pt) * 25.4)

Definition at line 43 of file pdf.h.

dt_pdf_point_to_pixel

#define dt_pdf_point_to_pixel	(		pt,
			dpi
	)		(dt_pdf_point_to_inch(pt) * (dpi))

Definition at line 44 of file pdf.h.

Typedef Documentation

dt_pdf_image_t

typedef struct dt_pdf_image_t dt_pdf_image_t

dt_pdf_page_t

typedef struct dt_pdf_page_t dt_pdf_page_t

dt_pdf_stream_encoder_t

typedef enum dt_pdf_stream_encoder_t dt_pdf_stream_encoder_t

dt_pdf_t

typedef struct dt_pdf_t dt_pdf_t

Enumeration Type Documentation

dt_pdf_stream_encoder_t

enum dt_pdf_stream_encoder_t

Enumerator
DT_PDF_STREAM_ENCODER_ASCII_HEX
DT_PDF_STREAM_ENCODER_FLATE

Definition at line 47 of file pdf.h.

Function Documentation

dt_pdf_add_icc()

int dt_pdf_add_icc	(	dt_pdf_t *	pdf,
		const char *	filename
	)

Definition at line 317 of file common/pdf.c.

References dt_free, dt_pdf_add_icc_from_data(), and dt_read_file().

dt_pdf_add_icc_from_data()

int dt_pdf_add_icc_from_data	(	dt_pdf_t *	pdf,
		const unsigned char *	data,
		size_t	size
	)

Definition at line 331 of file common/pdf.c.

References _pdf_set_offset(), _pdf_stream_encoder_ASCIIHex(), dt_pdf_t::bytes_written, dt_pdf_t::fd, dt_pdf_t::next_id, and size.

Referenced by dt_pdf_add_icc(), and write_image().

dt_pdf_add_image()

dt_pdf_image_t * dt_pdf_add_image	(	dt_pdf_t *	pdf,
		const unsigned char *	image,
		int	width,
		int	height,
		int	bpp,
		int	icc_id,
		float	border
	)

Todo:

: allow setting it from the outside

Definition at line 375 of file common/pdf.c.

References _pdf_set_offset(), _pdf_write_stream(), dt_pdf_image_t::bb_height, dt_pdf_image_t::bb_width, dt_pdf_image_t::bb_x, dt_pdf_image_t::bb_y, bpp, dt_pdf_t::bytes_written, dt_pdf_t::default_encoder, dt_free, dt_pdf_t::fd, height, dt_pdf_image_t::height, IS_NULL_PTR, dt_pdf_image_t::name_id, dt_pdf_t::next_id, dt_pdf_t::next_image, dt_pdf_image_t::object_id, dt_pdf_image_t::outline_mode, dt_pdf_t::page_height, dt_pdf_t::page_width, dt_pdf_image_t::size, stream_encoder_filters, width, and dt_pdf_image_t::width.

Referenced by _create_pdf(), and write_image().

dt_pdf_add_page()

dt_pdf_page_t * dt_pdf_add_page	(	dt_pdf_t *	pdf,
		dt_pdf_image_t **	images,
		int	n_images
	)

Definition at line 457 of file common/pdf.c.

References _pdf_set_offset(), dt_pdf_image_t::bb_height, dt_pdf_image_t::bb_width, dt_pdf_image_t::bb_x, dt_pdf_image_t::bb_y, dt_pdf_t::bytes_written, dt_pdf_t::dpi, dt_pdf_t::fd, height, dt_pdf_image_t::height, i, IS_NULL_PTR, MIN, dt_pdf_image_t::name_id, dt_pdf_t::next_id, dt_pdf_image_t::object_id, dt_pdf_page_t::object_id, dt_pdf_t::page_height, dt_pdf_t::page_width, dt_pdf_image_t::rotate_to_fit, dt_pdf_page_t::size, width, and dt_pdf_image_t::width.

Referenced by _create_pdf(), and write_image().

dt_pdf_finish()

void dt_pdf_finish	(	dt_pdf_t *	pdf,
		dt_pdf_page_t **	pages,
		int	n_pages
	)

Todo:

find something less necrophilic, maybe hash of image + history? or just of filename + date :)

Definition at line 639 of file common/pdf.c.

References _pdf_set_offset(), dt_pdf_t::bytes_written, dt_free, dt_pdf_t::fd, gmt, i, dt_pdf_t::next_id, dt_pdf_t::offsets, PACKAGE_STRING, pages, size, t, and dt_pdf_t::title.

Referenced by _create_pdf(), free_params(), and write_image().

dt_pdf_parse_length()

int dt_pdf_parse_length	(	const char *	str,
		float *	length
	)

Definition at line 69 of file common/pdf.c.

References dt_free, dt_pdf_units, i, IS_NULL_PTR, name, res, and SKIP_SPACES.

Referenced by _paper_size().

dt_pdf_parse_paper_size()

int dt_pdf_parse_paper_size	(	const char *	str,
		float *	width,
		float *	height
	)

Definition at line 117 of file common/pdf.c.

References dt_free, dt_pdf_paper_sizes, dt_pdf_units, FALSE, height, i, IS_NULL_PTR, name, res, SKIP_SPACES, TRUE, and width.

Referenced by _paper_size(), and _set_paper_size().

dt_pdf_start()

dt_pdf_t * dt_pdf_start	(	const char *	filename,
		float	width,
		float	height,
		float	dpi,
		dt_pdf_stream_encoder_t	default_encoder
	)

Definition at line 217 of file common/pdf.c.

References _pdf_set_offset(), dt_pdf_t::bytes_written, dt_pdf_t::default_encoder, dt_pdf_t::dpi, dt_free, dt_pdf_t::fd, height, IS_NULL_PTR, dt_pdf_t::n_offsets, dt_pdf_t::next_id, dt_pdf_t::next_image, dt_pdf_t::offsets, dt_pdf_t::page_height, dt_pdf_t::page_width, and width.

Referenced by _create_pdf(), and write_image().

Variable Documentation

[struct]

const struct { ... } dt_pdf_paper_sizes[]

Initial value:

=
{
  {N_("a4"),     (( ( 210 ) / 25.4 ) * 72.0),   (( ( 297 ) / 25.4 ) * 72.0)},
  {N_("a3"),     (( ( 297 ) / 25.4 ) * 72.0),   (( ( 420 ) / 25.4 ) * 72.0)},
  {N_("letter"), (( 8.5 ) * 72.0), (( 11.0 ) * 72.0)},
  {N_("legal"),  (( 8.5 ) * 72.0), (( 14.0 ) * 72.0)},
  {NULL,         0.0,                       0.0}
}

Referenced by _set_paper_size(), dt_pdf_parse_paper_size(), gui_init(), and size_toggle_callback().

dt_pdf_paper_sizes_n

const int dt_pdf_paper_sizes_n = sizeof(dt_pdf_paper_sizes) / sizeof(dt_pdf_paper_sizes[0]) - 1

static

Definition at line 119 of file pdf.h.

Referenced by _set_paper_size(), and size_toggle_callback().

[struct]

const struct { ... } dt_pdf_units[]

Initial value:

=
{
  {N_("mm"),   (( ( 1.0 ) / 25.4 ) * 72.0)},
  {N_("cm"),   (( ( 10.0 ) / 25.4 ) * 72.0)},
  {N_("inch"), (( 1.0 ) * 72.0)},
  {N_("\""),   (( 1.0 ) * 72.0)},
  {NULL,       0.0}
}

Referenced by dt_pdf_parse_length(), and dt_pdf_parse_paper_size().

dt_pdf_units_n

const int dt_pdf_units_n = sizeof(dt_pdf_units) / sizeof(dt_pdf_units[0])

static

Definition at line 101 of file pdf.h.

factor

const float factor

Definition at line 91 of file pdf.h.

Referenced by __OMP_DECLARE_SIMD__(), __OMP_DECLARE_SIMD__(), __OMP_DECLARE_SIMD__(), __OMP_DECLARE_SIMD__(), __OMP_DECLARE_SIMD__(), _aniso_div_solve(), _bh_round_to_n_digits(), _biharmonic_dome(), _blendif_compute_factor(), _blendif_compute_factor(), _blendif_compute_factor(), _blendop_blendif_boost_factor_callback(), _compute_range(), _default_process_tiling_cl_ptp(), _default_process_tiling_cl_roi(), _default_process_tiling_ptp(), _default_process_tiling_roi(), _diffuse_error(), _get_brush_smoothing(), _hl_count_thresholds(), _sp_chol_cl_free(), _sp_chol_factor(), _sp_chol_factor_cl(), _sp_chol_free(), _sp_chol_solve(), _sp_chol_solve_cl(), _sp_pde_factor(), _sp_pde_solve(), _util_get_svg_img(), distort_backtransform(), distort_transform(), dt_bauhaus_slider_set_factor(), dt_dev_convert_roi(), dt_exif_xmp_decode(), dt_exif_xmp_encode_internal(), dt_masks_gui_add_interaction_slider(), dt_nn_upsample_nearest(), dt_opencl_image_fits_device(), dt_opencl_image_fits_device_reason(), dt_screen_set_dpi_factor(), dt_tiling_piece_fits_host_memory(), dt_widget_set_dpi_factor(), legacy_params(), orthonormalize_v_with_qr_single(), scrolled(), and scrolled().

height

const float height

Definition at line 107 of file pdf.h.

name

const char * name

Definition at line 90 of file pdf.h.

Referenced by _apply_preferences(), _baseline_check(), _build_softproof_gamut_popover(), _build_tree_store(), _check_hidpi_placement(), _collect_item(), _collect_item_string(), _collect_sorted_tree_names(), _collect_style(), _columns_of(), _crawler_folder(), _create_profile(), _delete_tagids(), _device_by_cname(), _dnd_clear_root(), _dt_CGATS_get_name(), _dt_colorchecker_CGATS_fill_patch_values(), _dt_colorchecker_label_build_name(), _dt_conf_get_var_locked(), _dt_get_builtin_colorchecker_name(), _dt_pthread_rwlock_diag_log_rdlock(), _dt_pthread_rwlock_diag_log_wrlock(), _dt_style_update_iop_order(), _edit_preset(), _edit_preset_response(), _event_dnd_received(), _find_metadata_iter_per_text(), _folded_key(), _folder_holds(), _folder_survey_styles_for_import(), _format_changed(), _free_space_to_alloc(), _get_active_preset_name(), _get_cursor_name(), _get_node_for_name(), _group_member(), _gui_presets_popup_menu_show_internal(), _gui_styles_dialog_run(), _gui_styles_edit_style_response(), _gui_styles_new_style_response(), _guides_add_guide(), _guides_get_value(), _has_list(), _hm_dest_module_from_id(), _hm_id_to_op_name(), _hm_module_from_id(), _hm_module_label_short(), _hm_module_row_label(), _hm_pretty_id(), _hm_pretty_id_from_id_ht(), _hm_topo_apply_solution(), _image_with_flags(), _init_presets(), _introspect_dump(), _ioporder_get_current_order_name(), _layer_name_non_empty(), _lib_geotagging_get_timezones(), _lib_snapshots_add_button_clicked_callback(), _lrop(), _maybe_file_uncategorized(), _menu_append_join_group(), _menuitem_delete_preset(), _menuitem_pick_preset(), _menuitem_preferences(), _menuitem_update_preset(), _migrate_schema(), _name_editing_done(), _name_start_editing(), _name_value_new(), _new_button_clicked(), _new_tree_text_column(), _observe_delete(), _overlay_dump_skips(), _overlay_report(), _panel_handle_resize(), _pixelpipe_cache_create_entry_locked(), _prepend_style(), _read_mask_row(), _rebuild_memory(), _rename_module_key_press(), _run_brush_case(), _run_case(), _run_case_at(), _sanitize_confgen(), _sanitize_requested_layer_name(), _set_directory_tags(), _set_hash_member(), _set_location_collection(), _set_up_label(), _sibling_name(), _splash_build_author_list(), _splash_capitalize_name(), _splash_load_slides(), _splash_shadow_label_new(), _split_tree_name(), _storage_changed(), _studio_style_pool_contains(), _styles_init_source_dev(), _styles_prepare_source_dev(), _styles_row_activated_callback(), _time_hit_test(), _time_overlay_brush(), _time_overlay_form(), _time_overlay_group(), _timezone_save(), _tree_name_show(), _tree_tagname_show(), _update_display_profile(), _update_layout(), _upgrade_library_schema_step(), _widget_label(), _wire_conv(), _write_missing_map(), _write_page(), _xmp_append_metadata(), add_rights_preset(), append_display(), dt_collection_get_property_values(), dt_collection_name(), dt_collection_query_get_property_values(), dt_collection_query_set_iop_names(), dt_color_checker_get_patch_by_name(), dt_colorchecker_find_builtin(), dt_colorspaces_create_alternate_profile(), dt_colorspaces_create_darktable_profile(), dt_colorspaces_create_vendor_profile(), dt_colorspaces_get_profile_name(), dt_colorspaces_set_display_profile(), dt_conf_get_and_sanitize_float(), dt_conf_get_and_sanitize_int(), dt_conf_get_and_sanitize_int64(), dt_conf_get_bool(), dt_conf_get_float(), dt_conf_get_float_fast(), dt_conf_get_folder_to_file_chooser(), dt_conf_get_int(), dt_conf_get_int64(), dt_conf_get_int64_fast(), dt_conf_get_int_fast(), dt_conf_get_string(), dt_conf_get_string_const(), dt_conf_get_var(), dt_conf_init(), dt_conf_is_default(), dt_conf_is_equal(), dt_conf_key_not_empty(), dt_conf_set_bool(), dt_conf_set_float(), dt_conf_set_folder_from_file_chooser(), dt_conf_set_if_not_overridden(), dt_conf_set_int(), dt_conf_set_int64(), dt_conf_set_string(), dt_confgen_exists(), dt_confgen_get(), dt_confgen_get_bool(), dt_confgen_get_float(), dt_confgen_get_int(), dt_confgen_get_int64(), dt_confgen_get_label(), dt_confgen_get_tooltip(), dt_confgen_type(), dt_confgen_value_exists(), dt_control_signal_connect(), dt_control_signal_init(), dt_control_signal_raise(), dt_control_work(), dt_control_work_res(), dt_dev_get_module_instance(), dt_dev_pixelpipe_cache_get(), dt_dev_pixelpipe_cache_get_writable(), dt_dev_pixelpipe_process_rec(), dt_dlopencl_init(), dt_drawlayer_cache_alloc_temp_buffer(), dt_drawlayer_cache_ensure_mask_buffer(), dt_drawlayer_cache_ensure_scratch_buffer(), dt_drawlayer_cache_free_temp_buffer(), dt_drawlayer_cache_patch_alloc_shared(), dt_drawlayer_io_make_unique_name(), dt_drawlayer_io_make_unique_name_plain(), dt_get_help_url(), dt_get_medium(), dt_get_paper(), dt_gmodule_symbol(), dt_gui_doc_screenshot_add_target(), dt_gui_load_theme(), dt_gui_preferences_show(), dt_gui_presets_add_generic(), dt_gui_presets_add_with_blendop(), dt_gui_presets_apply_preset(), dt_gui_presets_confirm_and_delete(), dt_gui_presets_update_autoapply(), dt_gui_presets_update_av(), dt_gui_presets_update_filter(), dt_gui_presets_update_fl(), dt_gui_presets_update_iso(), dt_gui_presets_update_ldr(), dt_gui_presets_update_mml(), dt_gui_presets_update_tv(), dt_gui_store_last_preset(), dt_gui_styles_dialog_edit(), dt_guides_add_guide(), dt_history_item_as_string(), dt_history_repository_write_mask_item(), dt_history_style_on_image(), dt_history_style_on_list(), dt_image_repository_get_versions(), dt_imageio_get_format_by_name(), dt_imageio_get_storage_by_name(), dt_imageio_load_modules_format(), dt_imageio_load_modules_storage(), dt_imageio_open_exr(), dt_imageio_png_read_profile(), dt_interpolation_new(), dt_introspection_get_child(), dt_introspection_get_enum_value(), dt_lib_get_module(), dt_lib_presets_add(), dt_lib_presets_popup_menu_show(), dt_map_location_delete(), dt_map_location_name_exists(), dt_map_location_new(), dt_map_location_rename(), dt_masks_group_set_name_from_module(), dt_module_load_modules(), dt_opencl_create_kernel(), dt_pdf_parse_length(), dt_pdf_parse_paper_size(), dt_pixel_cache_new_entry(), dt_pixelpipe_cache_alloc_align_cache_impl(), dt_preset_repository_add_iop_preset(), dt_preset_repository_add_module_preset(), dt_preset_repository_add_shipped_preset(), dt_preset_repository_delete_module_preset(), dt_preset_repository_duplicate_module_preset(), dt_preset_repository_find_rowid(), dt_preset_repository_get_conditions(), dt_preset_repository_get_iop_preset(), dt_preset_repository_get_module_preset(), dt_preset_repository_module_preset_exists(), dt_preset_repository_set_blend_params(), dt_preset_repository_set_module_version(), dt_preset_repository_update_camera(), dt_preset_repository_update_flag(), dt_preset_repository_update_iop_params(), dt_preset_repository_update_module_params(), dt_preset_repository_update_range(), dt_preview_window_spawn(), dt_print_file(), dt_pthread_rwlock_set_name(), dt_pthread_setname(), dt_removed_image_repository_clear(), dt_removed_image_repository_create(), dt_removed_image_repository_restore(), dt_style_repository_get_id_by_name(), dt_style_repository_get_iop_list(), dt_style_repository_get_style(), dt_style_repository_insert_header(), dt_styles_apply_to_image(), dt_styles_apply_to_image_merge(), dt_styles_create_from_image(), dt_styles_create_from_style(), dt_styles_create_style_header(), dt_styles_delete_by_name(), dt_styles_delete_by_name_adv(), dt_styles_exists(), dt_styles_get_by_name(), dt_styles_get_description(), dt_styles_get_id_by_name(), dt_styles_get_item_list(), dt_styles_get_item_list_as_string(), dt_styles_has_module_order(), dt_styles_module_order_list(), dt_styles_update(), dt_supervisor_cacheline_create(), dt_supervisor_cacheline_delete(), dt_tag_detach_by_string(), dt_tag_exists(), dt_tag_get_tag_id_by_name(), dt_tag_new(), dt_tag_new_from_gui(), dt_tag_repository_find_by_name(), dt_tag_repository_find_by_name_nocase(), dt_tag_repository_get_by_path_with_counts(), dt_tag_repository_get_name(), dt_tag_repository_insert(), dt_thumbtable_update(), dt_view_extend_modes_str(), dtgtk_gradient_slider_multivalue_new_with_color_and_name(), dtgtk_gradient_slider_multivalue_new_with_name(), dtgtk_gradient_slider_new_with_color_and_name(), dtgtk_gradient_slider_new_with_name(), edit_clicked(), edit_preset(), edit_preset(), entry_activated(), export_button_clicked_callback(), export_raw(), export_raw_button_clicked_callback(), export_style(), get_active_preset_name(), get_export_filename(), get_language_names(), get_preset_element(), get_preset_element_float(), get_preset_element_int(), get_query_string(), gui_init(), gui_reset(), imported_style_name(), init_presets(), init_tab_general(), init_table(), is_member(), list_match_string(), lookup_color(), main(), main_csv(), menuitem_delete_preset(), menuitem_update_preset(), paper_exists(), parse_csv(), print_usage(), read_f32(), read_f32(), set_format_by_name(), set_params(), set_storage_by_name(), test_name(), tree_count_show(), tree_insert_presets(), tree_key_press_presets(), tree_row_activated_presets(), and update_table().

width

const float width

Definition at line 106 of file pdf.h.