Issues rendering annotations from pdf to image #293

geirthanas · 2024-02-05T16:23:17Z

geirthanas
Feb 5, 2024

Hi! I have a pdf with 4 annotations/field forms that are filled out on my pdf, and I wanted to convert it to an image, however when I convert it the image no longer contains the filled out values- I'm using python.

I've tried specifying it here:
pil_image = page.render(scale = 300/72, may_draw_forms=True, draw_annots=True).to_pil()
and I've also taken from the documentation and tried rendering it through a bitmap but having the same issue:

render_args = (
    bitmap,  # the bitmap
    page,    # the page
    # positions and sizes are to be given in pixels and may exceed the bitmap
    0,       # left start position
    0,       # top start position
    width,   # horizontal size
    height,  # vertical size
    0,       # rotation (as constant, not in degrees!)
    pdfium_c.FPDF_ANNOT,  # rendering flags, combined with binary or
)

# Render the page
pdfium_c.FPDF_RenderPageBitmap(*render_args)

Any suggestions on why it might not be rendering in the image?

Answered by mara004

Feb 5, 2024

On the support model example: Make sure to call .init_forms() on the parent pdf before the page is instantiated.

On the raw API example, you'd need to call FPDF_FFLDraw(...), which takes an FPDF_FORMHANDLE and the render args.
Setting up the form requires several other APIs, which is somewhat complicated.
The support model should be more straightforward for your use case.

I agree the Readme's raw API rendering example is incomplete when it comes to forms.
The support model's implementation is more exhaustive:

init_forms()

pypdfium2/src/pypdfium2/_helpers/document.py

Lines 150 to 183 in a584927

      
   formtype = self.get_formtype()  
   if formtype == pdfium_c.FORMTYPE_NONE or self.

View full answer

mara004 · 2024-02-05T18:19:36Z

mara004
Feb 5, 2024
Maintainer

On the support model example: Make sure to call .init_forms() on the parent pdf before the page is instantiated.

On the raw API example, you'd need to call FPDF_FFLDraw(...), which takes an FPDF_FORMHANDLE and the render args.
Setting up the form requires several other APIs, which is somewhat complicated.
The support model should be more straightforward for your use case.

I agree the Readme's raw API rendering example is incomplete when it comes to forms.
The support model's implementation is more exhaustive:

init_forms()

pypdfium2/src/pypdfium2/_helpers/document.py

Lines 150 to 183 in a584927

    
           formtype = self.get_formtype() 
        
           if formtype == pdfium_c.FORMTYPE_NONE or self.formenv: 
        
               return 
        
           # safety check for older binaries to prevent a segfault (could be removed at some point) 
        
           # https://github.com/bblanchon/pdfium-binaries/issues/105 
        
           if "V8" in PDFIUM_INFO.flags and PDFIUM_INFO.origin != "sourcebuild" and PDFIUM_INFO.build <= 5677: 
        
               raise RuntimeError("V8 enabled pdfium-binaries builds <= 5677 crash on init_forms().") 
        
           if not config: 
        
               if "XFA" in PDFIUM_INFO.flags: 
        
                   js_platform = pdfium_c.IPDF_JSPLATFORM(version=3) 
        
                   config = pdfium_c.FPDF_FORMFILLINFO(version=2, xfa_disabled=False, m_pJsPlatform=ctypes.pointer(js_platform)) 
        
               else: 
        
                   config = pdfium_c.FPDF_FORMFILLINFO(version=2) 
        
           raw = pdfium_c.FPDFDOC_InitFormFillEnvironment(self, config) 
        
           if not raw: 
        
               raise PdfiumError(f"Initializing form env failed for document {self}.") 
        
           self.formenv = PdfFormEnv(raw, config, self) 
        
           self._add_kid(self.formenv) 
        
           if formtype in (pdfium_c.FORMTYPE_XFA_FULL, pdfium_c.FORMTYPE_XFA_FOREGROUND): 
        
               if "XFA" in PDFIUM_INFO.flags: 
        
                   ok = pdfium_c.FPDF_LoadXFA(self) 
        
                   if not ok: 
        
                       err = pdfium_c.FPDF_GetLastError() 
        
                       logger.warning(f"FPDF_LoadXFA() failed with {pdfium_i.XFAErrorToStr.get(err)}") 
        
               else: 
        
                   logger.warning( 
        
                       "init_forms() called on XFA pdf, but this pdfium binary was compiled without XFA support.\n" 
        
                       "Run `PDFIUM_PLATFORM=auto-v8 pip install -v pypdfium2 --no-binary pypdfium2` to get a build with XFA support." 
        
                   )

get_page()

pypdfium2/src/pypdfium2/_helpers/document.py

Lines 367 to 379 in a584927

    
           raw_page = pdfium_c.FPDF_LoadPage(self, index) 
        
           if not raw_page: 
        
               raise PdfiumError("Failed to load page.") 
        
           page = PdfPage(raw_page, self, self.formenv) 
        
           if self.formenv: 
        
               pdfium_c.FORM_OnAfterLoadPage(page, self.formenv) 
        
               self.formenv._add_kid(page) 
        
           else: 
        
               self._add_kid(page) 
        
           return page

render()

pypdfium2/src/pypdfium2/_helpers/page.py

Lines 439 to 440 in a584927

    
           if may_draw_forms and self.formenv: 
        
               pdfium_c.FPDF_FFLDraw(self.formenv, *render_args)

2 replies

mara004 Feb 5, 2024
Maintainer

In addition, if your document uses an XFA form, you'd need a special build of pdfium.
In that case, init_forms() would give you a warning with instructions how to procure such a build.

geirthanas Feb 5, 2024
Author

Thank you this worked for me, getting the FPDF_FFLDraw added to my calls made it work! Thank you!

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issues rendering annotations from pdf to image #293

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 1 comment 2 replies

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

Select a reply


	formtype = self.get_formtype()
	if formtype == pdfium_c.FORMTYPE_NONE or self.

Issues rendering annotations from pdf to image #293

geirthanas Feb 5, 2024

Replies: 1 comment · 2 replies

mara004 Feb 5, 2024 Maintainer

mara004 Feb 5, 2024 Maintainer

geirthanas Feb 5, 2024 Author

geirthanas
Feb 5, 2024

Replies: 1 comment 2 replies

mara004
Feb 5, 2024
Maintainer

mara004 Feb 5, 2024
Maintainer

geirthanas Feb 5, 2024
Author