Update to usvg 0.35 + additional improvements (#37)

Author: LaurenzV

Cargo.lock

@@ -37,11 +37,11 @@ required-features = ["cli"]
 [dependencies]
 miniz_oxide = "0.7"
 pdf-writer = "0.8"
-usvg = { version = "0.32", default-features = false }
+usvg = { version = "0.35", default-features = false }
 image = { version = "0.24", features = ["jpeg", "png", "gif"], optional = true }
 termcolor = { version = "1", optional = true }
-clap = { version = "3", features = ["derive"], optional = true }
-fontdb = { version = "0.13", optional= true }
+clap = { version = "4.4.2", features = ["derive"], optional = true }
+fontdb = { version = "0.14", optional= true }
 
 [dev-dependencies]
-usvg = { version = "0.32" }
+usvg = { version = "0.35.0" }

Cargo.toml

@@ -59,7 +59,7 @@ features like:
 Among the unsupported features are currently:
 - The `spreadMethod` attribute of gradients
 - Filters
-- Blend modes
+- Text will be converted into shapes before converting to PDF
 - Raster images are not color managed but use PDF's DeviceRGB color space
 - A number of features that were added in SVG2
 

NOTICE

@@ -39,20 +39,20 @@ In general, a large part of the SVG specification is supported, including featur
 Among the unsupported features are currently:
 - The `spreadMethod` attribute of gradients
 - Filters
-- Blend modes
 - Raster images are not color managed but use PDF's DeviceRGB color space
 - A number of features that were added in SVG2
-*/
+ */
 
 mod render;
 mod util;
 
 use pdf_writer::{Content, Filter, Finish, PdfWriter, Rect, Ref, TextStr};
 use usvg::utils::view_box_to_transform;
-use usvg::{Align, AspectRatio, Size, Transform, Tree, TreeParsing};
+use usvg::{Align, AspectRatio, NonZeroRect, Size, Transform, Tree, TreeParsing};
 
+use crate::render::tree_to_stream;
 use crate::util::context::Context;
-use crate::util::helper::{dpi_ratio, NameExt, RectExt};
+use crate::util::helper::dpi_ratio;
 
 /// Set size and scaling preferences for the conversion.
 #[derive(Copy, Clone)]
@@ -118,7 +118,7 @@ impl Default for Options {
 ///
 /// Does not load any fonts and consequently cannot convert `text` elements. To
 /// convert text, you should convert your source string to a
-/// [`usvg` tree](usvg::Tree) manually,
+/// [`usvg` tree](Tree) manually,
 /// [convert text with usvg](usvg::TreeTextToPath::convert_text) and then use
 /// [`convert_tree`].
 ///
@@ -132,7 +132,7 @@ pub fn convert_str(src: &str, options: Options) -> Result<Vec<u8>, usvg::Error>
     Ok(convert_tree(&tree, options))
 }
 
-/// Convert a [`usvg` tree](usvg::Tree) into a standalone PDF buffer.
+/// Convert a [`usvg` tree](Tree) into a standalone PDF buffer.
 ///
 /// ## Example
 /// The example below reads an SVG file, processes text within it, then converts
@@ -159,9 +159,8 @@ pub fn convert_str(src: &str, options: Options) -> Result<Vec<u8>, usvg::Error>
 /// # Ok(()) }
 /// ```
 pub fn convert_tree(tree: &Tree, options: Options) -> Vec<u8> {
-    let page_size = options.viewport.unwrap_or(tree.size);
-    let mut ctx =
-        Context::new(tree, options, initial_transform(&options, tree, page_size), None);
+    let pdf_size = pdf_size(tree, options);
+    let mut ctx = Context::new(tree, options, None);
     let mut writer = PdfWriter::new();
 
     let catalog_ref = ctx.alloc_ref();
@@ -174,31 +173,35 @@ pub fn convert_tree(tree: &Tree, options: Options) -> Vec<u8> {
 
     // Generate main content
     ctx.deferrer.push();
-    let tree_x_object = render::tree_to_x_object(tree, &mut writer, &mut ctx);
     let mut content = Content::new();
-    content.x_object(tree_x_object.as_name());
-
+    tree_to_stream(
+        tree,
+        &mut writer,
+        &mut content,
+        &mut ctx,
+        initial_transform(options.aspect, tree, pdf_size),
+    );
     let content_stream = ctx.finish_content(content);
     let mut stream = writer.stream(content_ref, &content_stream);
 
     if ctx.options.compress {
         stream.filter(Filter::FlateDecode);
     }
-
     stream.finish();
 
     let mut page = writer.page(page_ref);
     let mut page_resources = page.resources();
     ctx.deferrer.pop(&mut page_resources);
     page_resources.finish();
 
-    page.media_box(Rect::new(
-        0.0,
-        0.0,
-        dpi_ratio(options.dpi) * page_size.width() as f32,
-        dpi_ratio(options.dpi) * page_size.height() as f32,
-    ));
+    page.media_box(Rect::new(0.0, 0.0, pdf_size.width(), pdf_size.height()));
     page.parent(page_tree_ref);
+    page.group()
+        .transparency()
+        .isolated(true)
+        .knockout(false)
+        .color_space()
+        .srgb();
     page.contents(content_ref);
     page.finish();
 
@@ -208,7 +211,7 @@ pub fn convert_tree(tree: &Tree, options: Options) -> Vec<u8> {
     writer.finish()
 }
 
-/// Convert a [`usvg` tree](usvg::Tree) into a Form XObject that can be used as
+/// Convert a [`usvg` tree](Tree) into a Form XObject that can be used as
 /// part of a larger document.
 ///
 /// This method is intended for use in an existing [`PdfWriter`] workflow. It
@@ -304,30 +307,29 @@ pub fn convert_tree_into(
     writer: &mut PdfWriter,
     start_ref: Ref,
 ) -> Ref {
-    let mut ctx = Context::new(
-        tree,
-        options,
-        initial_transform(&options, tree, tree.size),
-        Some(start_ref.get()),
-    );
+    let pdf_size = pdf_size(tree, options);
+    let mut ctx = Context::new(tree, options, Some(start_ref.get()));
 
     let x_ref = ctx.alloc_ref();
     ctx.deferrer.push();
 
-    let tree_x_object = render::tree_to_x_object(tree, writer, &mut ctx);
     let mut content = Content::new();
-    content.x_object(tree_x_object.as_name());
-
+    tree_to_stream(
+        tree,
+        writer,
+        &mut content,
+        &mut ctx,
+        initial_transform(options.aspect, tree, pdf_size),
+    );
     let content_stream = ctx.finish_content(content);
 
     let mut x_object = writer.form_xobject(x_ref, &content_stream);
-    x_object.bbox(ctx.get_rect().as_pdf_rect());
-    // Revert the PDF transformation so that the resulting XObject is 1x1 in size.
+    x_object.bbox(Rect::new(0.0, 0.0, pdf_size.width(), pdf_size.height()));
     x_object.matrix([
-        1.0 / ctx.get_rect().width() as f32,
+        1.0 / pdf_size.width(),
         0.0,
         0.0,
-        1.0 / ctx.get_rect().height() as f32,
+        1.0 / pdf_size.height(),
         0.0,
         0.0,
     ]);
@@ -342,33 +344,35 @@ pub fn convert_tree_into(
     ctx.alloc_ref()
 }
 
-/// Return the initial transform that is necessary for the conversion between SVG coordinates
-/// and the final PDF page (including DPI and a custom viewport).
-fn initial_transform(options: &Options, tree: &Tree, actual_size: Size) -> Transform {
-    // Account for DPI.
-    let dpi_transform = Transform::new_scale(
-        dpi_ratio(options.dpi) as f64,
-        dpi_ratio(options.dpi) as f64,
-    );
+/// Return the dimensions of the PDF page
+fn pdf_size(tree: &Tree, options: Options) -> Size {
+    // If no custom viewport is defined, we use the size of the tree.
+    let viewport_size = options.viewport.unwrap_or(tree.size);
+    Size::from_wh(
+        viewport_size.width() * dpi_ratio(options.dpi),
+        viewport_size.height() * dpi_ratio(options.dpi),
+    )
+    .unwrap()
+}
 
+/// Return the initial transform that is necessary for the conversion between SVG coordinates
+/// and the final PDF page.
+fn initial_transform(
+    aspect: Option<AspectRatio>,
+    tree: &Tree,
+    pdf_size: Size,
+) -> Transform {
     // Account for the custom viewport that has been passed in the Options struct. If nothing has
-    // been passed, actual_size will be same as tree.size, so the transform will just be the
+    // been passed, pdf_size should be the same as tree.size, so the transform will just be the
     // default transform.
     let custom_viewport_transform = view_box_to_transform(
-        usvg::Rect::new(0.0, 0.0, tree.size.width(), tree.size.height()).unwrap(),
-        options.aspect.unwrap_or(AspectRatio {
-            defer: false,
-            align: Align::None,
-            slice: false,
-        }),
-        actual_size,
+        NonZeroRect::from_xywh(0.0, 0.0, tree.size.width(), tree.size.height()).unwrap(),
+        aspect.unwrap_or(AspectRatio { defer: false, align: Align::None, slice: false }),
+        pdf_size,
     );
 
     // Account for the direction of the y axis and the shift of the origin in the coordinate system.
-    let pdf_transform = Transform::new(1.0, 0.0, 0.0, -1.0, 0.0, actual_size.height());
+    let pdf_transform = Transform::from_row(1.0, 0.0, 0.0, -1.0, 0.0, pdf_size.height());
 
-    let mut base_transform = dpi_transform;
-    base_transform.append(&pdf_transform);
-    base_transform.append(&custom_viewport_transform);
-    base_transform
+    pdf_transform.pre_concat(custom_viewport_transform)
 }