| // Copyright 2019 PDFium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #include <utility> |
| |
| #include "build/build_config.h" |
| #include "core/fxcrt/fx_system.h" |
| #include "core/fxge/fx_dib.h" |
| #include "public/fpdf_progressive.h" |
| #include "testing/embedder_test.h" |
| #include "testing/gtest/include/gtest/gtest.h" |
| |
| namespace { |
| |
| constexpr FX_ARGB kBlack = 0xFF000000; |
| constexpr FX_ARGB kBlue = 0xFF0000FF; |
| constexpr FX_ARGB kGreen = 0xFF00FF00; |
| constexpr FX_ARGB kRed = 0xFFFF0000; |
| constexpr FX_ARGB kWhite = 0xFFFFFFFF; |
| |
| } // namespace |
| |
| class FPDFProgressiveRenderEmbedderTest : public EmbedderTest { |
| public: |
| class FakePause : public IFSDK_PAUSE { |
| public: |
| explicit FakePause(bool should_pause) : should_pause_(should_pause) { |
| IFSDK_PAUSE::version = 1; |
| IFSDK_PAUSE::user = nullptr; |
| IFSDK_PAUSE::NeedToPauseNow = Pause_NeedToPauseNow; |
| } |
| ~FakePause() = default; |
| static FPDF_BOOL Pause_NeedToPauseNow(IFSDK_PAUSE* param) { |
| return static_cast<FakePause*>(param)->should_pause_; |
| } |
| |
| private: |
| const bool should_pause_; |
| }; |
| |
| // StartRenderPageWithFlags() with no flags. |
| // The call returns true if the rendering is complete. |
| bool StartRenderPage(FPDF_PAGE page, IFSDK_PAUSE* pause); |
| |
| // Start rendering of |page| into a bitmap with the ability to |pause| the |
| // rendering with the specified rendering |flags|. |
| // The call returns true if the rendering is complete. |
| // |
| // See public/fpdfview.h for a list of page rendering flags. |
| bool StartRenderPageWithFlags(FPDF_PAGE page, IFSDK_PAUSE* pause, int flags); |
| |
| // Start rendering of |page| into a bitmap with the ability to pause the |
| // rendering with the specified rendering |flags| and the specified |
| // |color_scheme|. This also takes in the |background_color| for the bitmap. |
| // The call returns true if the rendering is complete. |
| // |
| // See public/fpdfview.h for the list of page rendering flags and |
| // the list of colors in the scheme. |
| bool StartRenderPageWithColorSchemeAndBackground( |
| FPDF_PAGE page, |
| IFSDK_PAUSE* pause, |
| int flags, |
| const FPDF_COLORSCHEME* color_scheme, |
| uint32_t background_color); |
| |
| // Continue rendering of |page| into the bitmap created in |
| // StartRenderPageWithFlags(). |
| // The call returns true if the rendering is complete. |
| bool ContinueRenderPage(FPDF_PAGE page, IFSDK_PAUSE* pause); |
| |
| // Simplified form of FinishRenderPageWithForms() with no form handle. |
| ScopedFPDFBitmap FinishRenderPage(FPDF_PAGE page); |
| |
| // Finish rendering of |page| into the bitmap created in |
| // StartRenderPageWithFlags(). This also renders the forms associated with |
| // the page. The form handle associated with |page| should be passed in via |
| // |handle|. If |handle| is nullptr, then forms on the page will not be |
| // rendered. |
| // This returns the bitmap generated by the progressive render calls. |
| ScopedFPDFBitmap FinishRenderPageWithForms(FPDF_PAGE page, |
| FPDF_FORMHANDLE handle); |
| |
| // Convert the |page| into a bitmap with a |background_color|, using the |
| // color scheme render API with the specific |flags| and |color_scheme|. |
| // The form handle associated with |page| should be passed in via |handle|. |
| // If |handle| is nullptr, then forms on the page will not be rendered. |
| // This returns the bitmap generated by the progressive render calls. |
| // |
| // See public/fpdfview.h for a list of page rendering flags and |
| // the color scheme that can be applied for rendering. |
| ScopedFPDFBitmap RenderPageWithForcedColorScheme( |
| FPDF_PAGE page, |
| FPDF_FORMHANDLE handle, |
| int flags, |
| const FPDF_COLORSCHEME* color_scheme, |
| FX_ARGB background_color); |
| |
| protected: |
| // Utility method to render the |page_num| of the currently loaded Pdf |
| // using RenderPageWithForcedColorScheme() passing in the render options |
| // and expected values for bitmap verification. |
| void VerifyRenderingWithColorScheme(int page_num, |
| int flags, |
| const FPDF_COLORSCHEME* color_scheme, |
| FX_ARGB background_color, |
| int bitmap_width, |
| int bitmap_height, |
| const char* md5); |
| |
| private: |
| // Keeps the bitmap used for progressive rendering alive until |
| // FPDF_RenderPage_Close() is called after which the bitmap is returned |
| // to the caller. |
| ScopedFPDFBitmap progressive_render_bitmap_; |
| int progressive_render_flags_ = 0; |
| }; |
| |
| bool FPDFProgressiveRenderEmbedderTest::StartRenderPage(FPDF_PAGE page, |
| IFSDK_PAUSE* pause) { |
| return StartRenderPageWithFlags(page, pause, 0); |
| } |
| |
| bool FPDFProgressiveRenderEmbedderTest::StartRenderPageWithFlags( |
| FPDF_PAGE page, |
| IFSDK_PAUSE* pause, |
| int flags) { |
| int width = static_cast<int>(FPDF_GetPageWidth(page)); |
| int height = static_cast<int>(FPDF_GetPageHeight(page)); |
| progressive_render_flags_ = flags; |
| int alpha = FPDFPage_HasTransparency(page) ? 1 : 0; |
| progressive_render_bitmap_ = |
| ScopedFPDFBitmap(FPDFBitmap_Create(width, height, alpha)); |
| FPDF_DWORD fill_color = alpha ? 0x00000000 : 0xFFFFFFFF; |
| FPDFBitmap_FillRect(progressive_render_bitmap_.get(), 0, 0, width, height, |
| fill_color); |
| int rv = FPDF_RenderPageBitmap_Start(progressive_render_bitmap_.get(), page, |
| 0, 0, width, height, 0, |
| progressive_render_flags_, pause); |
| return rv != FPDF_RENDER_TOBECONTINUED; |
| } |
| |
| bool FPDFProgressiveRenderEmbedderTest:: |
| StartRenderPageWithColorSchemeAndBackground( |
| FPDF_PAGE page, |
| IFSDK_PAUSE* pause, |
| int flags, |
| const FPDF_COLORSCHEME* color_scheme, |
| uint32_t background_color) { |
| int width = static_cast<int>(FPDF_GetPageWidth(page)); |
| int height = static_cast<int>(FPDF_GetPageHeight(page)); |
| progressive_render_flags_ = flags; |
| int alpha = FPDFPage_HasTransparency(page) ? 1 : 0; |
| progressive_render_bitmap_ = |
| ScopedFPDFBitmap(FPDFBitmap_Create(width, height, alpha)); |
| ASSERT(progressive_render_bitmap_); |
| FPDFBitmap_FillRect(progressive_render_bitmap_.get(), 0, 0, width, height, |
| background_color); |
| int rv = FPDF_RenderPageBitmapWithColorScheme_Start( |
| progressive_render_bitmap_.get(), page, 0, 0, width, height, 0, |
| progressive_render_flags_, color_scheme, pause); |
| return rv != FPDF_RENDER_TOBECONTINUED; |
| } |
| |
| bool FPDFProgressiveRenderEmbedderTest::ContinueRenderPage(FPDF_PAGE page, |
| IFSDK_PAUSE* pause) { |
| ASSERT(progressive_render_bitmap_); |
| |
| int rv = FPDF_RenderPage_Continue(page, pause); |
| return rv != FPDF_RENDER_TOBECONTINUED; |
| } |
| |
| ScopedFPDFBitmap FPDFProgressiveRenderEmbedderTest::FinishRenderPage( |
| FPDF_PAGE page) { |
| return FinishRenderPageWithForms(page, /*handle=*/nullptr); |
| } |
| |
| ScopedFPDFBitmap FPDFProgressiveRenderEmbedderTest::FinishRenderPageWithForms( |
| FPDF_PAGE page, |
| FPDF_FORMHANDLE handle) { |
| ASSERT(progressive_render_bitmap_); |
| |
| int width = static_cast<int>(FPDF_GetPageWidth(page)); |
| int height = static_cast<int>(FPDF_GetPageHeight(page)); |
| FPDF_FFLDraw(handle, progressive_render_bitmap_.get(), page, 0, 0, width, |
| height, 0, progressive_render_flags_); |
| FPDF_RenderPage_Close(page); |
| return std::move(progressive_render_bitmap_); |
| } |
| |
| ScopedFPDFBitmap |
| FPDFProgressiveRenderEmbedderTest::RenderPageWithForcedColorScheme( |
| FPDF_PAGE page, |
| FPDF_FORMHANDLE handle, |
| int flags, |
| const FPDF_COLORSCHEME* color_scheme, |
| FX_ARGB background_color) { |
| FakePause pause(true); |
| bool render_done = StartRenderPageWithColorSchemeAndBackground( |
| page, &pause, flags, color_scheme, background_color) == |
| FPDF_RENDER_TOBECONTINUED; |
| EXPECT_FALSE(render_done); |
| |
| while (!render_done) { |
| render_done = ContinueRenderPage(page, &pause); |
| } |
| return FinishRenderPageWithForms(page, form_handle_); |
| } |
| |
| // TODO(crbug.com/pdfium/11): Fix this test and enable. |
| #if defined(_SKIA_SUPPORT_) || defined(_SKIA_SUPPORT_PATHS_) |
| #define MAYBE_RenderWithoutPause DISABLED_RenderWithoutPause |
| #else |
| #define MAYBE_RenderWithoutPause RenderWithoutPause |
| #endif |
| TEST_F(FPDFProgressiveRenderEmbedderTest, MAYBE_RenderWithoutPause) { |
| #if defined(OS_WIN) |
| static constexpr char kMd5BaseContent[] = "649d6792ea50faf98c013c2d81710595"; |
| #elif defined(OS_MACOSX) |
| static constexpr char kMd5BaseContent[] = "83e9f5222c4c959b0b63a5cd24f773a1"; |
| #else |
| static constexpr char kMd5BaseContent[] = "a24edc7740f1d6f76899652dcf825dea"; |
| #endif |
| |
| // Test rendering of page content using progressive render APIs |
| // without pausing the rendering. |
| ASSERT_TRUE(OpenDocument("annotation_stamp_with_ap.pdf")); |
| FPDF_PAGE page = LoadPage(0); |
| ASSERT_TRUE(page); |
| FakePause pause(false); |
| EXPECT_TRUE(StartRenderPage(page, &pause)); |
| ScopedFPDFBitmap bitmap = FinishRenderPage(page); |
| CompareBitmap(bitmap.get(), 595, 842, kMd5BaseContent); |
| UnloadPage(page); |
| } |
| |
| // TODO(crbug.com/pdfium/11): Fix this test and enable. |
| #if defined(_SKIA_SUPPORT_) || defined(_SKIA_SUPPORT_PATHS_) |
| #define MAYBE_RenderWithPause DISABLED_RenderWithPause |
| #else |
| #define MAYBE_RenderWithPause RenderWithPause |
| #endif |
| TEST_F(FPDFProgressiveRenderEmbedderTest, MAYBE_RenderWithPause) { |
| #if defined(OS_WIN) |
| static constexpr char kMd5BaseContent[] = "649d6792ea50faf98c013c2d81710595"; |
| #elif defined(OS_MACOSX) |
| static constexpr char kMd5BaseContent[] = "83e9f5222c4c959b0b63a5cd24f773a1"; |
| #else |
| static constexpr char kMd5BaseContent[] = "a24edc7740f1d6f76899652dcf825dea"; |
| #endif |
| |
| // Test rendering of page content using progressive render APIs |
| // with pause in rendering. |
| ASSERT_TRUE(OpenDocument("annotation_stamp_with_ap.pdf")); |
| FPDF_PAGE page = LoadPage(0); |
| ASSERT_TRUE(page); |
| FakePause pause(true); |
| bool render_done = StartRenderPage(page, &pause); |
| EXPECT_FALSE(render_done); |
| |
| while (!render_done) { |
| render_done = ContinueRenderPage(page, &pause); |
| } |
| ScopedFPDFBitmap bitmap = FinishRenderPage(page); |
| CompareBitmap(bitmap.get(), 595, 842, kMd5BaseContent); |
| UnloadPage(page); |
| } |
| |
| // TODO(crbug.com/pdfium/11): Fix this test and enable. |
| #if defined(_SKIA_SUPPORT_) || defined(_SKIA_SUPPORT_PATHS_) |
| #define MAYBE_RenderAnnotWithPause DISABLED_RenderAnnotWithPause |
| #else |
| #define MAYBE_RenderAnnotWithPause RenderAnnotWithPause |
| #endif |
| TEST_F(FPDFProgressiveRenderEmbedderTest, MAYBE_RenderAnnotWithPause) { |
| #if defined(OS_WIN) |
| static constexpr char kMd5ContentWithAnnot[] = |
| "6aa001a77ec05d0f1b0d1d22e28744d4"; |
| #elif defined(OS_MACOSX) |
| static constexpr char kMd5ContentWithAnnot[] = |
| "80d7b6cc7b13a78d77a6151bc846e80b"; |
| #else |
| static constexpr char kMd5ContentWithAnnot[] = |
| "b42cef463483e668eaf4055a65e4f1f5"; |
| #endif |
| |
| // Test rendering of the page with annotations using progressive render APIs |
| // with pause in rendering. |
| ASSERT_TRUE(OpenDocument("annotation_stamp_with_ap.pdf")); |
| FPDF_PAGE page = LoadPage(0); |
| ASSERT_TRUE(page); |
| FakePause pause(true); |
| bool render_done = StartRenderPageWithFlags(page, &pause, FPDF_ANNOT); |
| EXPECT_FALSE(render_done); |
| |
| while (!render_done) { |
| render_done = ContinueRenderPage(page, &pause); |
| } |
| ScopedFPDFBitmap bitmap = FinishRenderPage(page); |
| CompareBitmap(bitmap.get(), 595, 842, kMd5ContentWithAnnot); |
| UnloadPage(page); |
| } |
| |
| // TODO(crbug.com/pdfium/11): Fix this test and enable. |
| #if defined(_SKIA_SUPPORT_) || defined(_SKIA_SUPPORT_PATHS_) |
| #define MAYBE_RenderFormsWithPause DISABLED_RenderFormsWithPause |
| #else |
| #define MAYBE_RenderFormsWithPause RenderFormsWithPause |
| #endif |
| TEST_F(FPDFProgressiveRenderEmbedderTest, MAYBE_RenderFormsWithPause) { |
| #if defined(OS_WIN) |
| static constexpr char kMd5ContentWithForms[] = |
| "d3204faa62b607f0bd3893c9c22cabcb"; |
| #elif defined(OS_MACOSX) |
| static constexpr char kMd5ContentWithForms[] = |
| "d485541d958fef08d24e8eca3e537023"; |
| #else |
| static constexpr char kMd5ContentWithForms[] = |
| "b890950d4b9bc163b1a96797f3004b53"; |
| #endif |
| |
| // Test rendering of the page with forms using progressive render APIs |
| // with pause in rendering. |
| ASSERT_TRUE(OpenDocument("text_form.pdf")); |
| FPDF_PAGE page = LoadPage(0); |
| ASSERT_TRUE(page); |
| FakePause pause(true); |
| bool render_done = StartRenderPage(page, &pause); |
| EXPECT_FALSE(render_done); |
| |
| while (!render_done) { |
| render_done = ContinueRenderPage(page, &pause); |
| } |
| ScopedFPDFBitmap bitmap = FinishRenderPageWithForms(page, form_handle_); |
| CompareBitmap(bitmap.get(), 300, 300, kMd5ContentWithForms); |
| UnloadPage(page); |
| } |
| |
| void FPDFProgressiveRenderEmbedderTest::VerifyRenderingWithColorScheme( |
| int page_num, |
| int flags, |
| const FPDF_COLORSCHEME* color_scheme, |
| FX_ARGB background_color, |
| int bitmap_width, |
| int bitmap_height, |
| const char* md5) { |
| ASSERT_TRUE(document_); |
| |
| FPDF_PAGE page = LoadPage(page_num); |
| ASSERT_TRUE(page); |
| |
| ScopedFPDFBitmap bitmap = RenderPageWithForcedColorScheme( |
| page, form_handle_, flags, color_scheme, background_color); |
| ASSERT_TRUE(bitmap); |
| CompareBitmap(bitmap.get(), bitmap_width, bitmap_height, md5); |
| UnloadPage(page); |
| } |
| |
| TEST_F(FPDFProgressiveRenderEmbedderTest, RenderTextWithColorScheme) { |
| // Test rendering of text with forced color scheme on. |
| #if defined(OS_WIN) |
| static constexpr char kMD5ContentWithText[] = |
| "4245f32cc11748a00fd69852a5e5808d"; |
| #elif defined(OS_MACOSX) |
| static constexpr char kMD5ContentWithText[] = |
| "754a742f10ce0926b766dc3dd47d1f64"; |
| #else |
| static constexpr char kMD5ContentWithText[] = |
| "f14d3caba5a973a28be8653aac9e4df3"; |
| #endif |
| |
| ASSERT_TRUE(OpenDocument("hello_world.pdf")); |
| |
| FPDF_COLORSCHEME color_scheme{kBlack, kWhite, kWhite, kWhite}; |
| VerifyRenderingWithColorScheme(/*page_num=*/0, /*flags=*/0, &color_scheme, |
| kBlack, 200, 200, kMD5ContentWithText); |
| } |
| |
| TEST_F(FPDFProgressiveRenderEmbedderTest, RenderPathWithColorScheme) { |
| // Test rendering of paths with forced color scheme on. |
| static const char kMD5Rectangles[] = "249f59b0d066c4f6bd89782a80822219"; |
| |
| ASSERT_TRUE(OpenDocument("rectangles.pdf")); |
| |
| FPDF_COLORSCHEME color_scheme{kWhite, kRed, kBlue, kBlue}; |
| VerifyRenderingWithColorScheme(/*page_num=*/0, /*flags=*/0, &color_scheme, |
| kBlack, 200, 300, kMD5Rectangles); |
| } |
| |
| TEST_F(FPDFProgressiveRenderEmbedderTest, |
| RenderPathWithColorSchemeAndConvertFillToStroke) { |
| // Test rendering of paths with forced color scheme on and conversion from |
| // fill to stroke enabled. The fill paths should be rendered as stroke. |
| static const char kMD5Rectangles[] = "0ebcc11e617635eca1fa9ce475383a80"; |
| |
| ASSERT_TRUE(OpenDocument("rectangles.pdf")); |
| |
| FPDF_COLORSCHEME color_scheme{kWhite, kRed, kBlue, kBlue}; |
| VerifyRenderingWithColorScheme(/*page_num=*/0, FPDF_CONVERT_FILL_TO_STROKE, |
| &color_scheme, kBlack, 200, 300, |
| kMD5Rectangles); |
| } |
| |
| TEST_F(FPDFProgressiveRenderEmbedderTest, RenderHighlightWithColorScheme) { |
| // Test rendering of highlight with forced color scheme on. |
| // |
| // Note: The fill color rendered for highlight is different from the normal |
| // path since highlights have Multiply blend mode, while the other path has |
| // Normal blend mode. |
| #if defined(OS_MACOSX) |
| static constexpr char kMD5ContentWithHighlightFill[] = |
| "a820afec9b99d3d3f2e9e9382bbad7c1"; |
| #else // OS_WIN & OS_LINUX |
| static constexpr char kMD5ContentWithHighlightFill[] = |
| "a08a0639f89446f66f3689ee8e08b9fe"; |
| #endif |
| |
| ASSERT_TRUE(OpenDocument("annotation_highlight_square_with_ap.pdf")); |
| |
| FPDF_COLORSCHEME color_scheme{kRed, kGreen, kWhite, kWhite}; |
| VerifyRenderingWithColorScheme(/*page_num=*/0, FPDF_ANNOT, &color_scheme, |
| kBlue, 612, 792, kMD5ContentWithHighlightFill); |
| } |
| |
| TEST_F(FPDFProgressiveRenderEmbedderTest, |
| RenderHighlightWithColorSchemeAndConvertFillToStroke) { |
| // Test rendering of highlight with forced color and converting fill to |
| // stroke. The highlight should be rendered as a stroke of the rect. |
| // |
| // Note: The stroke color rendered for highlight is different from the normal |
| // path since highlights have Multiply blend mode, while the other path has |
| // Normal blend mode. |
| #if defined(OS_MACOSX) |
| static constexpr char kMD5ContentWithHighlight[] = |
| "8837bea0b3520164b1784e513c882a2d"; |
| #else // OS_WIN & OS_LINUX |
| static constexpr char kMD5ContentWithHighlight[] = |
| "3dd8c02f5c06bac85e0d2c8bf37d1dc4"; |
| #endif |
| |
| ASSERT_TRUE(OpenDocument("annotation_highlight_square_with_ap.pdf")); |
| |
| FPDF_COLORSCHEME color_scheme{kRed, kGreen, kWhite, kWhite}; |
| VerifyRenderingWithColorScheme( |
| /*page_num=*/0, FPDF_ANNOT | FPDF_CONVERT_FILL_TO_STROKE, &color_scheme, |
| kBlue, 612, 792, kMD5ContentWithHighlight); |
| } |
| |
| TEST_F(FPDFProgressiveRenderEmbedderTest, RenderInkWithColorScheme) { |
| // Test rendering of multiple ink with forced color scheme on. |
| #if defined(OS_WIN) |
| static constexpr char kMD5ContentWithInk[] = |
| "1933e4ab19b9108ddcecd1a6abb20c85"; |
| #else // OS_MACOSX & OS_LINUX |
| static constexpr char kMD5ContentWithInk[] = |
| "797bce7dc6c50ee86b095405df9fe5aa"; |
| #endif |
| |
| ASSERT_TRUE(OpenDocument("annotation_ink_multiple.pdf")); |
| |
| FPDF_COLORSCHEME color_scheme{kBlack, kGreen, kRed, kRed}; |
| VerifyRenderingWithColorScheme(/*page_num=*/0, FPDF_ANNOT, &color_scheme, |
| kBlack, 612, 792, kMD5ContentWithInk); |
| } |
| |
| TEST_F(FPDFProgressiveRenderEmbedderTest, RenderStampWithColorScheme) { |
| // Test rendering of static annotation with forced color scheme on. |
| #if defined(OS_WIN) |
| static constexpr char kMD5ContentWithStamp[] = |
| "71dce8f1221e1d2fe59d74258c3afd54"; |
| #elif defined(OS_MACOSX) |
| static constexpr char kMD5ContentWithStamp[] = |
| "e2d9bef817d366021e5727d9350bde43"; |
| #else |
| static constexpr char kMD5ContentWithStamp[] = |
| "d5518b1d9765fa62897a24d12244080f"; |
| #endif |
| |
| ASSERT_TRUE(OpenDocument("annotation_stamp_with_ap.pdf")); |
| |
| FPDF_COLORSCHEME color_scheme{kBlue, kGreen, kRed, kRed}; |
| VerifyRenderingWithColorScheme(/*page_num=*/0, FPDF_ANNOT, &color_scheme, |
| kWhite, 595, 842, kMD5ContentWithStamp); |
| } |
| |
| TEST_F(FPDFProgressiveRenderEmbedderTest, RenderFormWithColorScheme) { |
| // Test rendering of form does not change with forced color scheme on. |
| static constexpr char kMD5ContentWithForm[] = |
| "080f7a4381606659301440e1b14dca35"; |
| |
| ASSERT_TRUE(OpenDocument("annotiter.pdf")); |
| |
| FPDF_COLORSCHEME color_scheme{kGreen, kGreen, kRed, kRed}; |
| VerifyRenderingWithColorScheme(/*page_num=*/0, FPDF_ANNOT, &color_scheme, |
| kWhite, 612, 792, kMD5ContentWithForm); |
| |
| // Verify that the MD5 hash matches when rendered without |color_scheme|. |
| VerifyRenderingWithColorScheme(/*page_num=*/0, FPDF_ANNOT, |
| /*color_scheme=*/nullptr, kWhite, 612, 792, |
| kMD5ContentWithForm); |
| } |