/* * Copyright (c) 2021-2022, Matthew Olsson * * SPDX-License-Identifier: BSD-2-Clause */ #include #include #include #include #include #include #define RENDERER_HANDLER(name) \ PDFErrorOr Renderer::handle_##name([[maybe_unused]] ReadonlySpan args, [[maybe_unused]] Optional> extra_resources) #define RENDERER_TODO(name) \ RENDERER_HANDLER(name) \ { \ return Error(Error::Type::RenderingUnsupported, "draw operation: " #name); \ } namespace PDF { // Use a RAII object to restore the graphics state, to make sure it gets restored even if // a TRY(handle_operator()) causes us to exit the operators loop early. // Explicitly resize stack size at the end so that if the recursive document contains // `q q unsupportedop Q Q`, we undo the stack pushes from the inner `q q` even if // `unsupportedop` terminates processing the inner instruction stream before `Q Q` // would normally pop state. class Renderer::ScopedState { public: ScopedState(Renderer& renderer) : m_renderer(renderer) , m_starting_stack_depth(m_renderer.m_graphics_state_stack.size()) { MUST(m_renderer.handle_save_state({})); } ~ScopedState() { m_renderer.m_graphics_state_stack.shrink(m_starting_stack_depth); } private: Renderer& m_renderer; size_t m_starting_stack_depth; }; PDFErrorsOr Renderer::render(Document& document, Page const& page, RefPtr bitmap, Color background_color, RenderingPreferences rendering_preferences) { return Renderer(document, page, bitmap, background_color, rendering_preferences).render(); } ErrorOr> Renderer::apply_page_rotation(NonnullRefPtr bitmap, Page const& page, int extra_degrees) { int rotation_count = ((page.rotate + extra_degrees) / 90) % 4; if (rotation_count == 1) bitmap = TRY(bitmap->rotated(Gfx::RotationDirection::Clockwise)); else if (rotation_count == 2) bitmap = TRY(bitmap->rotated(Gfx::RotationDirection::Flip)); else if (rotation_count == 3) bitmap = TRY(bitmap->rotated(Gfx::RotationDirection::CounterClockwise)); return bitmap; } static void rect_path(Gfx::Path& path, float x, float y, float width, float height) { path.move_to({ x, y }); path.line_to({ x + width, y }); path.line_to({ x + width, y + height }); path.line_to({ x, y + height }); path.close(); } template static void rect_path(Gfx::Path& path, Gfx::Rect rect) { return rect_path(path, rect.x(), rect.y(), rect.width(), rect.height()); } template static Gfx::Path rect_path(Gfx::Rect const& rect) { Gfx::Path path; rect_path(path, rect); return path; } Renderer::Renderer(RefPtr document, Page const& page, RefPtr bitmap, Color background_color, RenderingPreferences rendering_preferences) : m_document(document) , m_bitmap(bitmap) , m_page(page) , m_painter(*bitmap) , m_anti_aliasing_painter(m_painter) , m_rendering_preferences(rendering_preferences) { auto media_box = m_page.media_box; Gfx::AffineTransform userspace_matrix; userspace_matrix.translate(media_box.lower_left_x, media_box.lower_left_y); float width = media_box.width(); float height = media_box.height(); float scale_x = static_cast(bitmap->width()) / width; float scale_y = static_cast(bitmap->height()) / height; userspace_matrix.scale(scale_x, scale_y); // PDF user-space coordinate y axis increases from bottom to top, so we have to // insert a horizontal reflection about the vertical midpoint into our transformation // matrix static Gfx::AffineTransform horizontal_reflection_matrix = { 1, 0, 0, -1, 0, 0 }; userspace_matrix.multiply(horizontal_reflection_matrix); userspace_matrix.translate(0.0f, -height); auto initial_clipping_path = rect_path(userspace_matrix.map(Gfx::FloatRect(0, 0, width, height))); m_graphics_state_stack.append(GraphicsState { userspace_matrix, { initial_clipping_path, initial_clipping_path } }); m_bitmap->fill(background_color); } PDFErrorsOr Renderer::render() { auto operators = TRY(Parser::parse_operators(m_document, TRY(m_page.page_contents(*m_document)))); Errors errors; for (auto& op : operators) { auto maybe_error = handle_operator(op); if (maybe_error.is_error()) { errors.add_error(maybe_error.release_error()); } } if (!errors.errors().is_empty()) return errors; return {}; } PDFErrorOr Renderer::handle_operator(Operator const& op, Optional> extra_resources) { switch (op.type()) { #define V(name, snake_name, symbol) \ case OperatorType::name: \ TRY(handle_##snake_name(op.arguments(), extra_resources)); \ break; ENUMERATE_OPERATORS(V) #undef V case OperatorType::TextNextLineShowString: TRY(handle_text_next_line_show_string(op.arguments())); break; case OperatorType::TextNextLineShowStringSetSpacing: TRY(handle_text_next_line_show_string_set_spacing(op.arguments())); break; } return {}; } RENDERER_HANDLER(save_state) { m_graphics_state_stack.append(state()); return {}; } RENDERER_HANDLER(restore_state) { m_graphics_state_stack.take_last(); return {}; } RENDERER_HANDLER(concatenate_matrix) { Gfx::AffineTransform new_transform( args[0].to_float(), args[1].to_float(), args[2].to_float(), args[3].to_float(), args[4].to_float(), args[5].to_float()); state().ctm.multiply(new_transform); m_text_rendering_matrix_is_dirty = true; return {}; } RENDERER_HANDLER(set_line_width) { state().line_width = args[0].to_float(); return {}; } RENDERER_HANDLER(set_line_cap) { state().line_cap_style = static_cast(args[0].get()); return {}; } RENDERER_HANDLER(set_line_join) { state().line_join_style = static_cast(args[0].get()); return {}; } RENDERER_HANDLER(set_miter_limit) { state().miter_limit = args[0].to_float(); return {}; } RENDERER_HANDLER(set_dash_pattern) { auto dash_array = MUST(m_document->resolve_to(args[0])); Vector pattern; for (auto& element : *dash_array) pattern.append(element.to_int()); state().line_dash_pattern = LineDashPattern { pattern, args[1].to_int() }; return {}; } RENDERER_HANDLER(set_color_rendering_intent) { state().color_rendering_intent = MUST(m_document->resolve_to(args[0]))->name(); return {}; } RENDERER_HANDLER(set_flatness_tolerance) { state().flatness_tolerance = args[0].to_float(); return {}; } RENDERER_HANDLER(set_graphics_state_from_dict) { auto resources = extra_resources.value_or(m_page.resources); auto dict_name = MUST(m_document->resolve_to(args[0]))->name(); auto ext_gstate_dict = MUST(resources->get_dict(m_document, CommonNames::ExtGState)); auto target_dict = MUST(ext_gstate_dict->get_dict(m_document, dict_name)); TRY(set_graphics_state_from_dict(target_dict)); return {}; } RENDERER_HANDLER(path_move) { m_current_path.move_to(map(args[0].to_float(), args[1].to_float())); return {}; } RENDERER_HANDLER(path_line) { VERIFY(!m_current_path.is_empty()); m_current_path.line_to(map(args[0].to_float(), args[1].to_float())); return {}; } RENDERER_HANDLER(path_cubic_bezier_curve) { VERIFY(args.size() == 6); m_current_path.cubic_bezier_curve_to( map(args[0].to_float(), args[1].to_float()), map(args[2].to_float(), args[3].to_float()), map(args[4].to_float(), args[5].to_float())); return {}; } RENDERER_HANDLER(path_cubic_bezier_curve_no_first_control) { VERIFY(args.size() == 4); VERIFY(!m_current_path.is_empty()); auto current_point = m_current_path.last_point(); m_current_path.cubic_bezier_curve_to( current_point, map(args[0].to_float(), args[1].to_float()), map(args[2].to_float(), args[3].to_float())); return {}; } RENDERER_HANDLER(path_cubic_bezier_curve_no_second_control) { VERIFY(args.size() == 4); VERIFY(!m_current_path.is_empty()); auto first_control_point = map(args[0].to_float(), args[1].to_float()); auto second_control_point = map(args[2].to_float(), args[3].to_float()); m_current_path.cubic_bezier_curve_to( first_control_point, second_control_point, second_control_point); return {}; } RENDERER_HANDLER(path_close) { m_current_path.close(); return {}; } RENDERER_HANDLER(path_append_rect) { auto rect = Gfx::FloatRect(args[0].to_float(), args[1].to_float(), args[2].to_float(), args[3].to_float()); // Note: The path of the rectangle is mapped (rather than the rectangle). // This is because negative width/heights are possible, and result in different // winding orders, but this is lost by Gfx::AffineTransform::map(). m_current_path.append_path(map(rect_path(rect))); return {}; } void Renderer::activate_clip() { auto bounding_box = state().clipping_paths.current.bounding_box(); m_painter.clear_clip_rect(); if (m_rendering_preferences.show_clipping_paths) { m_painter.stroke_path(rect_path(bounding_box), Color::Black, 1); } m_painter.add_clip_rect(bounding_box.to_type()); } void Renderer::deactivate_clip() { m_painter.clear_clip_rect(); state().clipping_paths.current = state().clipping_paths.next; } /// // Path painting operations /// void Renderer::begin_path_paint() { if (m_rendering_preferences.clip_paths) activate_clip(); } void Renderer::end_path_paint() { m_current_path.clear(); if (m_rendering_preferences.clip_paths) deactivate_clip(); } RENDERER_HANDLER(path_stroke) { begin_path_paint(); if (state().stroke_style.has>()) { m_anti_aliasing_painter.stroke_path(m_current_path, state().stroke_style.get>(), line_width()); } else { m_anti_aliasing_painter.stroke_path(m_current_path, state().stroke_style.get(), line_width()); } end_path_paint(); return {}; } RENDERER_HANDLER(path_close_and_stroke) { m_current_path.close(); TRY(handle_path_stroke(args)); return {}; } RENDERER_HANDLER(path_fill_nonzero) { begin_path_paint(); m_current_path.close_all_subpaths(); if (state().paint_style.has>()) { m_anti_aliasing_painter.fill_path(m_current_path, state().paint_style.get>(), 1.0, Gfx::Painter::WindingRule::Nonzero); } else { m_anti_aliasing_painter.fill_path(m_current_path, state().paint_style.get(), Gfx::Painter::WindingRule::Nonzero); } end_path_paint(); return {}; } RENDERER_HANDLER(path_fill_nonzero_deprecated) { return handle_path_fill_nonzero(args); } RENDERER_HANDLER(path_fill_evenodd) { begin_path_paint(); m_current_path.close_all_subpaths(); if (state().paint_style.has>()) { m_anti_aliasing_painter.fill_path(m_current_path, state().paint_style.get>(), 1.0, Gfx::Painter::WindingRule::EvenOdd); } else { m_anti_aliasing_painter.fill_path(m_current_path, state().paint_style.get(), Gfx::Painter::WindingRule::EvenOdd); } end_path_paint(); return {}; } RENDERER_HANDLER(path_fill_stroke_nonzero) { begin_path_paint(); if (state().stroke_style.has>()) { m_anti_aliasing_painter.stroke_path(m_current_path, state().stroke_style.get>(), line_width()); } else { m_anti_aliasing_painter.stroke_path(m_current_path, state().stroke_style.get(), line_width()); } m_current_path.close_all_subpaths(); if (state().paint_style.has>()) { m_anti_aliasing_painter.fill_path(m_current_path, state().paint_style.get>(), 1.0, Gfx::Painter::WindingRule::Nonzero); } else { m_anti_aliasing_painter.fill_path(m_current_path, state().paint_style.get(), Gfx::Painter::WindingRule::Nonzero); } end_path_paint(); return {}; } RENDERER_HANDLER(path_fill_stroke_evenodd) { begin_path_paint(); if (state().stroke_style.has>()) { m_anti_aliasing_painter.stroke_path(m_current_path, state().stroke_style.get>(), line_width()); } else { m_anti_aliasing_painter.stroke_path(m_current_path, state().stroke_style.get(), line_width()); } m_current_path.close_all_subpaths(); if (state().paint_style.has>()) { m_anti_aliasing_painter.fill_path(m_current_path, state().paint_style.get>(), 1.0, Gfx::Painter::WindingRule::EvenOdd); } else { m_anti_aliasing_painter.fill_path(m_current_path, state().paint_style.get(), Gfx::Painter::WindingRule::EvenOdd); } end_path_paint(); return {}; } RENDERER_HANDLER(path_close_fill_stroke_nonzero) { m_current_path.close(); return handle_path_fill_stroke_nonzero(args); } RENDERER_HANDLER(path_close_fill_stroke_evenodd) { m_current_path.close(); return handle_path_fill_stroke_evenodd(args); } RENDERER_HANDLER(path_end) { begin_path_paint(); end_path_paint(); return {}; } RENDERER_HANDLER(path_intersect_clip_nonzero) { // FIXME: Support arbitrary path clipping in Path and utilize that here auto next_clipping_bbox = state().clipping_paths.next.bounding_box(); next_clipping_bbox.intersect(m_current_path.bounding_box()); state().clipping_paths.next = rect_path(next_clipping_bbox); return {}; } RENDERER_HANDLER(path_intersect_clip_evenodd) { // FIXME: Should have different behavior than path_intersect_clip_nonzero return handle_path_intersect_clip_nonzero(args); } RENDERER_HANDLER(text_begin) { m_text_matrix = Gfx::AffineTransform(); m_text_line_matrix = Gfx::AffineTransform(); m_text_rendering_matrix_is_dirty = true; return {}; } RENDERER_HANDLER(text_end) { // FIXME: Do we need to do anything here? return {}; } RENDERER_HANDLER(text_set_char_space) { text_state().character_spacing = args[0].to_float(); return {}; } RENDERER_HANDLER(text_set_word_space) { text_state().word_spacing = args[0].to_float(); return {}; } RENDERER_HANDLER(text_set_horizontal_scale) { m_text_rendering_matrix_is_dirty = true; text_state().horizontal_scaling = args[0].to_float() / 100.0f; return {}; } RENDERER_HANDLER(text_set_leading) { text_state().leading = args[0].to_float(); return {}; } PDFErrorOr> Renderer::get_font(FontCacheKey const& key) { auto it = m_font_cache.find(key); if (it != m_font_cache.end()) { // Update the potentially-stale size set in text_set_matrix_and_line_matrix(). it->value->set_font_size(key.font_size); return it->value; } auto font = TRY(PDFFont::create(m_document, key.font_dictionary, key.font_size)); m_font_cache.set(key, font); return font; } RENDERER_HANDLER(text_set_font) { auto target_font_name = MUST(m_document->resolve_to(args[0]))->name(); text_state().font_size = args[1].to_float(); auto& text_rendering_matrix = calculate_text_rendering_matrix(); auto font_size = text_rendering_matrix.x_scale() * text_state().font_size / text_state().horizontal_scaling; auto resources = extra_resources.value_or(m_page.resources); auto fonts_dictionary = MUST(resources->get_dict(m_document, CommonNames::Font)); auto font_dictionary = MUST(fonts_dictionary->get_dict(m_document, target_font_name)); FontCacheKey cache_key { move(font_dictionary), font_size }; text_state().font = TRY(get_font(cache_key)); m_text_rendering_matrix_is_dirty = true; return {}; } RENDERER_HANDLER(text_set_rendering_mode) { text_state().rendering_mode = static_cast(args[0].get()); return {}; } RENDERER_HANDLER(text_set_rise) { m_text_rendering_matrix_is_dirty = true; text_state().rise = args[0].to_float(); return {}; } RENDERER_HANDLER(text_next_line_offset) { Gfx::AffineTransform transform(1.0f, 0.0f, 0.0f, 1.0f, args[0].to_float(), args[1].to_float()); m_text_line_matrix.multiply(transform); m_text_matrix = m_text_line_matrix; m_text_rendering_matrix_is_dirty = true; return {}; } RENDERER_HANDLER(text_next_line_and_set_leading) { text_state().leading = -args[1].to_float(); TRY(handle_text_next_line_offset(args)); return {}; } RENDERER_HANDLER(text_set_matrix_and_line_matrix) { Gfx::AffineTransform new_transform( args[0].to_float(), args[1].to_float(), args[2].to_float(), args[3].to_float(), args[4].to_float(), args[5].to_float()); m_text_line_matrix = new_transform; m_text_matrix = new_transform; m_text_rendering_matrix_is_dirty = true; // Settings the text/line matrix retroactively affects fonts if (text_state().font) { auto new_text_rendering_matrix = calculate_text_rendering_matrix(); text_state().font->set_font_size(text_state().font_size * new_text_rendering_matrix.x_scale() / text_state().horizontal_scaling); } return {}; } RENDERER_HANDLER(text_next_line) { TRY(handle_text_next_line_offset(Array { 0.0f, -text_state().leading })); return {}; } RENDERER_HANDLER(text_show_string) { auto text = MUST(m_document->resolve_to(args[0]))->string(); TRY(show_text(text)); return {}; } RENDERER_HANDLER(text_next_line_show_string) { TRY(handle_text_next_line(args)); TRY(handle_text_show_string(args)); return {}; } RENDERER_HANDLER(text_next_line_show_string_set_spacing) { TRY(handle_text_set_word_space(args.slice(0, 1))); TRY(handle_text_set_char_space(args.slice(1, 1))); TRY(handle_text_next_line_show_string(args.slice(2))); return {}; } RENDERER_HANDLER(text_show_string_array) { auto elements = MUST(m_document->resolve_to(args[0]))->elements(); for (auto& element : elements) { if (element.has_number()) { float shift = element.to_float() / 1000.0f; if (text_state().font->writing_mode() == WritingMode::Horizontal) m_text_matrix.translate(-shift * text_state().font_size * text_state().horizontal_scaling, 0.0f); else m_text_matrix.translate(0.0f, -shift * text_state().font_size); m_text_rendering_matrix_is_dirty = true; } else { auto str = element.get>()->cast()->string(); TRY(show_text(str)); } } return {}; } RENDERER_HANDLER(type3_font_set_glyph_width) { // FIXME: Do something with this. return {}; } RENDERER_HANDLER(type3_font_set_glyph_width_and_bbox) { // FIXME: Do something with this. return {}; } RENDERER_HANDLER(set_stroking_space) { state().stroke_color_space = TRY(get_color_space_from_resources(args[0], extra_resources.value_or(m_page.resources))); VERIFY(state().stroke_color_space); return {}; } RENDERER_HANDLER(set_painting_space) { state().paint_color_space = TRY(get_color_space_from_resources(args[0], extra_resources.value_or(m_page.resources))); VERIFY(state().paint_color_space); return {}; } RENDERER_HANDLER(set_stroking_color) { state().stroke_style = TRY(state().stroke_color_space->style(args)); return {}; } RENDERER_HANDLER(set_stroking_color_extended) { // FIXME: Handle Pattern color spaces auto last_arg = args.last(); if (last_arg.has>() && last_arg.get>()->is()) { dbgln("pattern space {}", last_arg.get>()->cast()->name()); return Error::rendering_unsupported_error("Pattern color spaces not yet implemented"); } state().stroke_style = TRY(state().stroke_color_space->style(args)); return {}; } RENDERER_HANDLER(set_painting_color) { state().paint_style = TRY(state().paint_color_space->style(args)); return {}; } RENDERER_HANDLER(set_painting_color_extended) { // FIXME: Handle Pattern color spaces auto last_arg = args.last(); if (last_arg.has>() && last_arg.get>()->is()) { dbgln("pattern space {}", last_arg.get>()->cast()->name()); return Error::rendering_unsupported_error("Pattern color spaces not yet implemented"); } state().paint_style = TRY(state().paint_color_space->style(args)); return {}; } RENDERER_HANDLER(set_stroking_color_and_space_to_gray) { state().stroke_color_space = DeviceGrayColorSpace::the(); state().stroke_style = TRY(state().stroke_color_space->style(args)); return {}; } RENDERER_HANDLER(set_painting_color_and_space_to_gray) { state().paint_color_space = DeviceGrayColorSpace::the(); state().paint_style = TRY(state().paint_color_space->style(args)); return {}; } RENDERER_HANDLER(set_stroking_color_and_space_to_rgb) { state().stroke_color_space = DeviceRGBColorSpace::the(); state().stroke_style = TRY(state().stroke_color_space->style(args)); return {}; } RENDERER_HANDLER(set_painting_color_and_space_to_rgb) { state().paint_color_space = DeviceRGBColorSpace::the(); state().paint_style = TRY(state().paint_color_space->style(args)); return {}; } RENDERER_HANDLER(set_stroking_color_and_space_to_cmyk) { state().stroke_color_space = TRY(DeviceCMYKColorSpace::the()); state().stroke_style = TRY(state().stroke_color_space->style(args)); return {}; } RENDERER_HANDLER(set_painting_color_and_space_to_cmyk) { state().paint_color_space = TRY(DeviceCMYKColorSpace::the()); state().paint_style = TRY(state().paint_color_space->style(args)); return {}; } RENDERER_TODO(shade) RENDERER_HANDLER(inline_image_begin) { // The parser only calls the inline_image_end handler for inline images. VERIFY_NOT_REACHED(); } RENDERER_HANDLER(inline_image_begin_data) { // The parser only calls the inline_image_end handler for inline images. VERIFY_NOT_REACHED(); } static PDFErrorOr expand_inline_image_value(Value const& value, HashMap const& value_expansions) { if (!value.has>()) return value; auto const& object = value.get>(); if (object->is()) { auto const& name = object->cast()->name(); auto expanded_name = value_expansions.get(name); if (!expanded_name.has_value()) return value; return Value { make_object(expanded_name.value()) }; } // For the Filters array. if (object->is()) { auto const& array = object->cast()->elements(); Vector expanded_array; for (auto const& element : array) { auto expanded_element = TRY(expand_inline_image_value(element, value_expansions)); expanded_array.append(expanded_element); } return Value { make_object(move(expanded_array)) }; } // For the DecodeParms dict. It might be fine to just `return value` here, I'm not sure if there can really be abbreviations in here. if (object->is()) { auto const& dict = object->cast()->map(); HashMap expanded_dict; for (auto const& [key, value] : dict) { auto expanded_value = TRY(expand_inline_image_value(value, value_expansions)); expanded_dict.set(key, expanded_value); } return Value { make_object(move(expanded_dict)) }; } VERIFY_NOT_REACHED(); } static PDFErrorOr expand_inline_image_colorspace(Value color_space_value, NonnullRefPtr resources, RefPtr document) { // PDF 1.7 spec, 4.8.6 Inline Images: // "Beginning with PDF 1.2, the value of the ColorSpace entry may also be the name // of a color space in the ColorSpace subdictionary of the current resource dictionary." // But PDF 1.7 spec, 4.5.2 Color Space Families: // "Outside a content stream, certain objects, such as image XObjects, // specify a color space as an explicit parameter, often associated with // the key ColorSpace. In this case, the color space array or name is // always defined directly as a PDF object, not by an entry in the // ColorSpace resource subdictionary." // This converts a named color space of an inline image to an explicit color space object, // so that the regular image drawing code tolerates it. if (!color_space_value.has>()) return color_space_value; auto const& object = color_space_value.get>(); if (!object->is()) return color_space_value; auto const& name = object->cast()->name(); if (name == "DeviceGray" || name == "DeviceRGB" || name == "DeviceCMYK") return color_space_value; auto color_space_resource_dict = TRY(resources->get_dict(document, CommonNames::ColorSpace)); return color_space_resource_dict->get_object(document, name); } static PDFErrorOr> expand_inline_image_abbreviations(NonnullRefPtr inline_stream, NonnullRefPtr resources, RefPtr document) { // TABLE 4.43 Entries in an inline image object static HashMap key_expansions { { "BPC", "BitsPerComponent" }, { "CS", "ColorSpace" }, { "D", "Decode" }, { "DP", "DecodeParms" }, { "F", "Filter" }, { "H", "Height" }, { "IM", "ImageMask" }, { "I", "Interpolate" }, { "Intent", "Intent" }, // "No abbreviation" { "L", "Length" }, // PDF 2.0; would make more sense to read in Parser. { "W", "Width" }, }; // TABLE 4.44 Additional abbreviations in an inline image object // "Also note that JBIG2Decode and JPXDecode are not listed in Table 4.44 // because those filters can be applied only to image XObjects." static HashMap value_expansions { { "G", "DeviceGray" }, { "RGB", "DeviceRGB" }, { "CMYK", "DeviceCMYK" }, { "I", "Indexed" }, { "AHx", "ASCIIHexDecode" }, { "A85", "ASCII85Decode" }, { "LZW", "LZWDecode" }, { "Fl", "FlateDecode" }, { "RL", "RunLengthDecode" }, { "CCF", "CCITTFaxDecode" }, { "DCT", "DCTDecode" }, }; // The values in key_expansions, that is the final expansions, are the valid keys in an inline image dict. HashTable valid_keys; for (auto const& [key, value] : key_expansions) valid_keys.set(value); HashMap expanded_dict; for (auto const& [key, value] : inline_stream->dict()->map()) { DeprecatedFlyString expanded_key = key_expansions.get(key).value_or(key); // "Entries other than those listed are ignored" if (!valid_keys.contains(expanded_key)) { dbgln("PDF: Ignoring invalid inline image key '{}'", expanded_key); continue; } Value expanded_value = TRY(expand_inline_image_value(value, value_expansions)); if (expanded_key == "ColorSpace") expanded_value = TRY(expand_inline_image_colorspace(expanded_value, resources, document)); expanded_dict.set(expanded_key, expanded_value); } auto map_object = make_object(move(expanded_dict)); return make_object(move(map_object), MUST(ByteBuffer::copy(inline_stream->bytes()))); } RENDERER_HANDLER(inline_image_end) { VERIFY(args.size() == 1); auto inline_stream = args[0].get>()->cast(); auto resources = extra_resources.value_or(m_page.resources); auto expanded_inline_stream = TRY(expand_inline_image_abbreviations(inline_stream, resources, m_document)); TRY(m_document->unfilter_stream(expanded_inline_stream)); TRY(show_image(expanded_inline_stream)); return {}; } RENDERER_HANDLER(paint_xobject) { VERIFY(args.size() > 0); auto resources = extra_resources.value_or(m_page.resources); auto xobject_name = args[0].get>()->cast()->name(); auto xobjects_dict = TRY(resources->get_dict(m_document, CommonNames::XObject)); auto xobject = TRY(xobjects_dict->get_stream(m_document, xobject_name)); Optional> xobject_resources {}; if (xobject->dict()->contains(CommonNames::Resources)) { xobject_resources = xobject->dict()->get_dict(m_document, CommonNames::Resources).value(); } auto subtype = MUST(xobject->dict()->get_name(m_document, CommonNames::Subtype))->name(); if (subtype == CommonNames::Image) { TRY(show_image(xobject)); return {}; } ScopedState scoped_state { *this }; Vector matrix; if (xobject->dict()->contains(CommonNames::Matrix)) { matrix = xobject->dict()->get_array(m_document, CommonNames::Matrix).value()->elements(); } else { matrix = Vector { Value { 1 }, Value { 0 }, Value { 0 }, Value { 1 }, Value { 0 }, Value { 0 } }; } MUST(handle_concatenate_matrix(matrix)); auto operators = TRY(Parser::parse_operators(m_document, xobject->bytes())); for (auto& op : operators) TRY(handle_operator(op, xobject_resources)); return {}; } RENDERER_HANDLER(marked_content_point) { // nop return {}; } RENDERER_HANDLER(marked_content_designate) { // nop return {}; } RENDERER_HANDLER(marked_content_begin) { // nop return {}; } RENDERER_HANDLER(marked_content_begin_with_property_list) { // nop return {}; } RENDERER_HANDLER(marked_content_end) { // nop return {}; } RENDERER_HANDLER(compatibility_begin) { // We're supposed to ignore unknown operands in compatibility_begin / compatibility_end sections. // But we want to know about all operands, so we just ignore this. // In practice, it seems like compatibility_begin / compatibility_end were introduced when // `sh` was added, and they're used exlusively around `sh`. return {}; } RENDERER_HANDLER(compatibility_end) { // See comment in compatibility_begin. return {}; } template Gfx::Point Renderer::map(T x, T y) const { return state().ctm.map(Gfx::Point { x, y }); } template Gfx::Size Renderer::map(Gfx::Size size) const { return state().ctm.map(size); } template Gfx::Rect Renderer::map(Gfx::Rect rect) const { return state().ctm.map(rect); } Gfx::Path Renderer::map(Gfx::Path const& path) const { return path.copy_transformed(state().ctm); } float Renderer::line_width() const { // PDF 1.7 spec, 4.3.2 Details of Graphics State Parameters, Line Width: // "A line width of 0 denotes the thinnest line that can be rendered at device resolution: 1 device pixel wide." if (state().line_width == 0) return 1; return state().ctm.x_scale() * state().line_width; } PDFErrorOr Renderer::set_graphics_state_from_dict(NonnullRefPtr dict) { // ISO 32000 (PDF 2.0), 8.4.5 Graphics state parameter dictionaries if (dict->contains(CommonNames::LW)) TRY(handle_set_line_width(Array { dict->get_value(CommonNames::LW) })); if (dict->contains(CommonNames::LC)) TRY(handle_set_line_cap(Array { dict->get_value(CommonNames::LC) })); if (dict->contains(CommonNames::LJ)) TRY(handle_set_line_join(Array { dict->get_value(CommonNames::LJ) })); if (dict->contains(CommonNames::ML)) TRY(handle_set_miter_limit(Array { dict->get_value(CommonNames::ML) })); if (dict->contains(CommonNames::D)) { auto array = MUST(dict->get_array(m_document, CommonNames::D)); TRY(handle_set_dash_pattern(array->elements())); } if (dict->contains(CommonNames::RI)) TRY(handle_set_color_rendering_intent(Array { dict->get_value(CommonNames::RI) })); // FIXME: OP // FIXME: op // FIXME: OPM // FIXME: Font // FIXME: BG // FIXME: BG2 // FIXME: UCR // FIXME: UCR2 // FIXME: TR // FIXME: TR2 // FIXME: HT if (dict->contains(CommonNames::FL)) TRY(handle_set_flatness_tolerance(Array { dict->get_value(CommonNames::FL) })); // FIXME: SM // FIXME: SA // FIXME: BM // FIXME: SMask // FIXME: CA // FIXME: ca // FIXME: AIS // FIXME: TK // FIXME: UseBlackPtComp // FIXME: HTO return {}; } PDFErrorOr Renderer::show_text(ByteString const& string) { if (!text_state().font) return Error::rendering_unsupported_error("Can't draw text because an invalid font was in use"); OwnPtr clip_raii; if (m_rendering_preferences.clip_text) clip_raii = make(*this); auto start_position = Gfx::FloatPoint { 0.0f, 0.0f }; auto end_position = TRY(text_state().font->draw_string(m_painter, start_position, string, *this)); // Update text matrix. auto delta = end_position - start_position; m_text_rendering_matrix_is_dirty = true; m_text_matrix.translate(delta); return {}; } enum UpsampleMode { StoreValuesUnchanged, UpsampleTo8Bit, }; static Vector upsample_to_8_bit(ReadonlyBytes content, int samples_per_line, int bits_per_component, UpsampleMode mode) { VERIFY(bits_per_component == 1 || bits_per_component == 2 || bits_per_component == 4); Vector upsampled_storage; upsampled_storage.ensure_capacity(content.size() * 8 / bits_per_component); u8 const mask = (1 << bits_per_component) - 1; int x = 0; for (auto byte : content) { for (int i = 0; i < 8; i += bits_per_component) { auto value = (byte >> (8 - bits_per_component - i)) & mask; if (mode == UpsampleMode::UpsampleTo8Bit) upsampled_storage.append(value * (255 / mask)); else upsampled_storage.append(value); ++x; // "Byte boundaries are ignored, except that each row of sample data must begin on a byte boundary." if (x == samples_per_line) { x = 0; break; } } } return upsampled_storage; } PDFErrorOr Renderer::load_image(NonnullRefPtr image) { auto image_dict = image->dict(); auto width = TRY(m_document->resolve_to(image_dict->get_value(CommonNames::Width))); auto height = TRY(m_document->resolve_to(image_dict->get_value(CommonNames::Height))); auto is_filter = [&](DeprecatedFlyString const& name) -> PDFErrorOr { if (!image_dict->contains(CommonNames::Filter)) return false; auto filter_object = TRY(image_dict->get_object(m_document, CommonNames::Filter)); if (filter_object->is()) return filter_object->cast()->name() == name; auto filters = filter_object->cast(); if (filters->elements().is_empty()) return false; auto last_filter_index = filters->elements().size() - 1; return MUST(filters->get_name_at(m_document, last_filter_index))->name() == name; }; if (TRY(is_filter(CommonNames::JPXDecode))) { return Error(Error::Type::RenderingUnsupported, "JPXDecode filter"); } bool is_image_mask = false; if (image_dict->contains(CommonNames::ImageMask)) { is_image_mask = TRY(m_document->resolve_to(image_dict->get_value(CommonNames::ImageMask))); } // "(Required for images, except those that use the JPXDecode filter; not allowed for image masks) [...] // it can be any type of color space except Pattern." NonnullRefPtr color_space = DeviceGrayColorSpace::the(); if (!is_image_mask) { auto color_space_object = MUST(image_dict->get_object(m_document, CommonNames::ColorSpace)); color_space = TRY(get_color_space_from_document(color_space_object)); } auto color_rendering_intent = state().color_rendering_intent; if (image_dict->contains(CommonNames::Intent)) color_rendering_intent = TRY(image_dict->get_name(m_document, CommonNames::Intent))->name(); // FIXME: Do something with color_rendering_intent. // "Valid values are 1, 2, 4, 8, and (in PDF 1.5) 16." // Per spec, this is required even for /Mask images, but it's required to be 1 there. // In practice, it's sometimes missing for /Mask images. auto bits_per_component = 1; if (!is_image_mask) bits_per_component = TRY(m_document->resolve_to(image_dict->get_value(CommonNames::BitsPerComponent))); switch (bits_per_component) { case 1: case 2: case 4: case 8: case 16: // Ok! break; default: return Error(Error::Type::MalformedPDF, "Image's /BitsPerComponent invalid"); } auto content = image->bytes(); int const n_components = color_space->number_of_components(); Vector resampled_storage; if (bits_per_component < 8) { UpsampleMode mode = color_space->family() == ColorSpaceFamily::Indexed ? UpsampleMode::StoreValuesUnchanged : UpsampleMode::UpsampleTo8Bit; resampled_storage = upsample_to_8_bit(content, width * n_components, bits_per_component, mode); content = resampled_storage; bits_per_component = 8; if (is_image_mask) { // "a sample value of 0 marks the page with the current color, and a 1 leaves the previous contents unchanged." // That's opposite of the normal alpha convention, and we're upsampling masks to 8 bit and use that as normal alpha. for (u8& byte : resampled_storage) byte = ~byte; } } else if (bits_per_component == 16) { if (color_space->family() == ColorSpaceFamily::Indexed) return Error(Error::Type::RenderingUnsupported, "16 bpp indexed images not yet supported"); // PDF 1.7 spec, 4.8.2 Sample Representation: // "units of 16 bits are given with the most significant byte first" // FIXME: Eventually use all 16 bits instead of throwing away the lower 8 bits. resampled_storage.ensure_capacity(content.size() / 2); for (size_t i = 0; i < content.size(); i += 2) resampled_storage.append(content[i]); content = resampled_storage; bits_per_component = 8; } Vector decode_array; if (image_dict->contains(CommonNames::Decode)) { decode_array = MUST(image_dict->get_array(m_document, CommonNames::Decode))->float_elements(); } else { decode_array = color_space->default_decode(); } Vector component_value_decoders; component_value_decoders.ensure_capacity(decode_array.size()); for (size_t i = 0; i < decode_array.size(); i += 2) { auto dmin = decode_array[i]; auto dmax = decode_array[i + 1]; component_value_decoders.empend(0.0f, 255.0f, dmin, dmax); } auto bitmap = TRY(Gfx::Bitmap::create(Gfx::BitmapFormat::BGRA8888, { width, height })); int x = 0; int y = 0; auto const bytes_per_component = bits_per_component / 8; Vector component_values; component_values.resize(n_components); while (!content.is_empty() && y < height) { auto sample = content.slice(0, bytes_per_component * n_components); content = content.slice(bytes_per_component * n_components); for (int i = 0; i < n_components; ++i) { auto component = sample.slice(0, bytes_per_component); sample = sample.slice(bytes_per_component); component_values[i] = component_value_decoders[i].interpolate(component[0]); } auto color = TRY(color_space->style(component_values)).get(); bitmap->set_pixel(x, y, color); ++x; if (x == width) { x = 0; ++y; } } return LoadedImage { bitmap, is_image_mask }; } PDFErrorOr> Renderer::make_mask_bitmap_from_array(NonnullRefPtr array, NonnullRefPtr image) { // PDF 1.7 spec, 4.8.5. Masked Images, Color Key Masking // "For color key masking, the value of the Mask entry is an array of 2 × n integers, [min_1 max_1 ... min_n max_n], // where n is the number of color components in the image’s color space. Each integer must be in the range 0 to 2**(BitsPerComponent − 1), // representing color values _before_ decoding with the Decode array. // An image sample is masked [...] if min_i ≤ c_i ≤ max_i for all 1 ≤ i ≤ n." // For indexed images, this means the array masks the index, not the color. auto image_dict = image->dict(); auto width = TRY(m_document->resolve_to(image_dict->get_value(CommonNames::Width))); auto height = TRY(m_document->resolve_to(image_dict->get_value(CommonNames::Height))); auto bits_per_component = TRY(m_document->resolve_to(image_dict->get_value(CommonNames::BitsPerComponent))); VERIFY(bits_per_component == 1 || bits_per_component == 2 || bits_per_component == 4 || bits_per_component == 8 || bits_per_component == 16); if (array->size() % 2 != 0) return Error(Error::Type::MalformedPDF, "Mask array must have an even number of elements"); auto n_components = array->size() / 2; Vector min, max; for (size_t i = 0; i < n_components; ++i) { min.append(array->at(i * 2).to_int()); max.append(array->at(i * 2 + 1).to_int()); } auto mask_bitmap = TRY(Gfx::Bitmap::create(Gfx::BitmapFormat::BGRA8888, { width, height })); auto bit_stream = make(make(image->bytes())); for (int y = 0; y < height; ++y) { for (int x = 0; x < width; ++x) { bool is_masked = true; for (size_t i = 0; i < n_components; ++i) { u16 sample = TRY(bit_stream->read_bits(bits_per_component)); if (sample < min[i] || sample > max[i]) { is_masked = false; TRY(bit_stream->read_bits((n_components - 1 - i) * bits_per_component)); break; } } mask_bitmap->set_pixel(x, y, Color::from_argb(is_masked ? 0x00'00'00'00 : 0xff'ff'ff'ff)); } bit_stream->align_to_byte_boundary(); } return mask_bitmap; } Gfx::AffineTransform Renderer::calculate_image_space_transformation(Gfx::IntSize size) { // Image space maps to a 1x1 unit of user space and starts at the top-left auto image_space = state().ctm; image_space.multiply(Gfx::AffineTransform( 1.0f / size.width(), 0.0f, 0.0f, -1.0f / size.height(), 0.0f, 1.0f)); return image_space; } void Renderer::show_empty_image(Gfx::IntSize size) { auto image_space_transformation = calculate_image_space_transformation(size); auto image_border = image_space_transformation.map(Gfx::IntRect { {}, size }); m_painter.stroke_path(rect_path(image_border), Color::Black, 1); } static ErrorOr> apply_alpha_channel(NonnullRefPtr image_bitmap, NonnullRefPtr mask_bitmap) { // Make alpha mask same size as image. if (mask_bitmap->size() != image_bitmap->size()) { // Some files have 2x2 images for color and huge masks that contain rendered text outlines. // So resize to the larger of the two. auto new_size = Gfx::IntSize { max(image_bitmap->width(), mask_bitmap->width()), max(image_bitmap->height(), mask_bitmap->height()) }; if (image_bitmap->size() != new_size) image_bitmap = TRY(image_bitmap->scaled_to_size(new_size)); if (mask_bitmap->size() != new_size) mask_bitmap = TRY(mask_bitmap->scaled_to_size(new_size)); } image_bitmap->add_alpha_channel(); for (int j = 0; j < image_bitmap->height(); ++j) { for (int i = 0; i < image_bitmap->width(); ++i) { auto image_color = image_bitmap->get_pixel(i, j); auto mask_color = mask_bitmap->get_pixel(i, j); image_color = image_color.with_alpha(mask_color.luminosity()); image_bitmap->set_pixel(i, j, image_color); } } return image_bitmap; } PDFErrorOr Renderer::show_image(NonnullRefPtr image) { auto image_dict = image->dict(); OwnPtr clip_raii; if (m_rendering_preferences.clip_images) clip_raii = make(*this); if (!m_rendering_preferences.show_images) { auto width = TRY(m_document->resolve_to(image_dict->get_value(CommonNames::Width))); auto height = TRY(m_document->resolve_to(image_dict->get_value(CommonNames::Height))); show_empty_image({ width, height }); return {}; } auto image_bitmap = TRY(load_image(image)); if (image_bitmap.is_image_mask) { // PDF 1.7 spec, 4.8.5 Masked Images, Stencil Masking: // "An image mask (an image XObject whose ImageMask entry is true) [...] is treated as a stencil mask [...]. // Sample values [...] designate places on the page that should either be marked with the current color or masked out (not marked at all)." if (!state().paint_style.has()) return Error(Error::Type::RenderingUnsupported, "Image masks with pattern fill not yet implemented"); // Move mask to alpha channel, and put current color in RGB. auto current_color = state().paint_style.get(); for (auto& pixel : *image_bitmap.bitmap) { u8 mask_alpha = Color::from_argb(pixel).luminosity(); pixel = current_color.with_alpha(mask_alpha).value(); } } else if (image_dict->contains(CommonNames::SMask)) { auto smask_bitmap = TRY(load_image(TRY(image_dict->get_stream(m_document, CommonNames::SMask)))); image_bitmap.bitmap = TRY(apply_alpha_channel(image_bitmap.bitmap, smask_bitmap.bitmap)); } else if (image_dict->contains(CommonNames::Mask)) { auto mask_object = TRY(image_dict->get_object(m_document, CommonNames::Mask)); if (mask_object->is()) { auto mask_bitmap = TRY(load_image(mask_object->cast())); image_bitmap.bitmap = TRY(apply_alpha_channel(image_bitmap.bitmap, mask_bitmap.bitmap)); } else if (mask_object->is()) { auto mask_bitmap = TRY(make_mask_bitmap_from_array(mask_object->cast(), image)); image_bitmap.bitmap = TRY(apply_alpha_channel(image_bitmap.bitmap, mask_bitmap)); } } auto image_space = calculate_image_space_transformation(image_bitmap.bitmap->size()); auto image_rect = Gfx::FloatRect { image_bitmap.bitmap->rect() }; m_painter.draw_scaled_bitmap_with_transform(image_bitmap.bitmap->rect(), image_bitmap.bitmap, image_rect, image_space); return {}; } PDFErrorOr> Renderer::get_color_space_from_resources(Value const& value, NonnullRefPtr resources) { auto color_space_name = value.get>()->cast()->name(); auto maybe_color_space_family = ColorSpaceFamily::get(color_space_name); if (!maybe_color_space_family.is_error()) { auto color_space_family = maybe_color_space_family.release_value(); if (color_space_family.may_be_specified_directly()) { return ColorSpace::create(color_space_name, *this); } } auto color_space_resource_dict = TRY(resources->get_dict(m_document, CommonNames::ColorSpace)); if (!color_space_resource_dict->contains(color_space_name)) { dbgln("missing key {}", color_space_name); return Error::rendering_unsupported_error("Missing entry for color space name"); } return get_color_space_from_document(TRY(color_space_resource_dict->get_object(m_document, color_space_name))); } PDFErrorOr> Renderer::get_color_space_from_document(NonnullRefPtr color_space_object) { return ColorSpace::create(m_document, color_space_object, *this); } Gfx::AffineTransform const& Renderer::calculate_text_rendering_matrix() const { if (m_text_rendering_matrix_is_dirty) { // PDF 1.7, 5.3.3. Text Space Details Gfx::AffineTransform parameter_matrix { text_state().horizontal_scaling, 0.0f, 0.0f, 1.0f, 0.0f, text_state().rise }; m_text_rendering_matrix = state().ctm; m_text_rendering_matrix.multiply(m_text_matrix); m_text_rendering_matrix.multiply(parameter_matrix); m_text_rendering_matrix_is_dirty = false; } return m_text_rendering_matrix; } PDFErrorOr Renderer::render_type3_glyph(Gfx::FloatPoint point, StreamObject const& glyph_data, Gfx::AffineTransform const& font_matrix, Optional> resources) { ScopedState scoped_state { *this }; auto text_rendering_matrix = calculate_text_rendering_matrix(); text_rendering_matrix.set_translation(point); state().ctm = text_rendering_matrix; state().ctm.scale(text_state().font_size, text_state().font_size); state().ctm.multiply(font_matrix); m_text_rendering_matrix_is_dirty = true; auto operators = TRY(Parser::parse_operators(m_document, glyph_data.bytes())); for (auto& op : operators) TRY(handle_operator(op, resources)); return {}; } }