o e@sdZddlmZddlmZmZddlmZddlm Z ddl m Z ddl m Z ddlmZdd lmZmZmZmZmZmZmZdd lmZdd lmZdd lmZmZmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&dd l'm(Z(ddl)m*Z*ddl+m,Z,ddl-m.Z.edZ/Gddde0Z1Gddde0Z2Gddde2Z3Gddde0Z4d8ddZ5d9d!d"Z6d:d+d,Z7Gd-d.d.eZ8Gd/d0d0eZ9Gd1d2d2e9Z:Gd3d4d4e:Z;Gd5d6d6e9Z<z0_array_str.._convert..) isinstancelistrrrbytesintrstrrNotImplementedError)itemr3r/r)r*r3:s z_array_str.._convert)r6r7)r/resultr)r=r* _array_str7s  r?!list[Object] | Dictionary | Arrayreturn list[Object]cCst|tr|St|S)zEnsure value is a list of pikepdf.Object, if it was not already. To support DecodeParms which can be present as either an array of dicts or a single dict. It's easier to convert to an array of one dict. )r6r7Z wrap_in_arrayas_list)r/r)r)r* _ensure_listKs rDobjDictionary | Streamnamer:type_Callable[[Any], T]defaultT | NonecCsDt|||}z||WSty|durYdSYnwtd|)zRRetrieve metadata from a dictionary or stream, and ensure it is the expected type.NzMetadata access for )getattr TypeErrorr;)rErGrHrJvalr)r)r*_metadata_from_objVs    rOc@s"eZdZUdZded<ded<dS) PaletteDataa5Returns the color space and binary representation of the palette. ``base_colorspace`` is typically ``"RGB"`` or ``"L"`` (for grayscale). ``palette`` is typically 256 or 256*3=768 bytes, for grayscale and RGB color respectively, with each unit/triplet being the grayscale/RGB triplet values. r:Zbase_colorspacer8paletteN)r%r&r'r(__annotations__r)r)r)r*rPcs  rPc@sPeZdZdZhdZehdBZddhZedFd dZe dGddZ e dGddZ e dHddZ e dIddZ e ddZe ddZe ddZe dJd!d"Ze dGd#d$Ze edKd&d'Ze dHd(d)Zd*d+Ze dHd,d-Ze dHd.d/Ze dLd1d2Zd3d4Ze dMd5d6Ze d7d8Ze dNd:d;ZedOd=d>ZedPdCdDZdES)Q PdfImageBasezAbstract base class for images.>z/CalGrayz/CalRGB /DeviceRGB /DeviceGray> /ICCBasedz/CalCMYK /DeviceCMYK /Separation/DeviceNrGr:rHrIrJr!rAcCdS)z!Get metadata for this image type.Nr)selfrGrHrJr)r)r* _metadatawzPdfImageBase._metadatar9cC|dtdS)z"Width of the image data in pixels.Widthrr]r9r\r)r)r*width{zPdfImageBase.widthcCr_)z#Height of the image data in pixels.Heightrrarbr)r)r*heightrdzPdfImageBase.heightboolcCr_)z)Return ``True`` if this is an image mask.Z ImageMaskF)r]rgrbr)r)r* image_maskrdzPdfImageBase.image_mask int | NonecCr_)z.Bits per component for this image (low-level).BitsPerComponentrrarbr)r)r*_bpcrdzPdfImageBase._bpccC|dtgS)zColorspace (low-level). ColorSpacer]r?rbr)r)r* _colorspacesrdzPdfImageBase._colorspacescCrl)zBList of names of the filters that we applied to encode this image.Filterrnrbr)r)r*filtersrdzPdfImageBase.filterscCrl)z/List of the /DecodeParms, arguments to filters.Z DecodeParms)r]rDrbr)r)r* decode_parmsrdzPdfImageBase.decode_parms str | NonecCs|jrdS|jrE|jd|jvr|jdS|jddkr<|jd}t|tr-||jvr-|St|tr<|ddvr<|dS|jddkrEdStdt|j)z:PDF name of the colorspace that best describes this image.Nr/Indexed)rVrYrYz not sure how to get colorspace: )rhroMAIN_COLORSPACESr6r:r7r;repr)r\Zsubspacer)r)r* colorspaces    zPdfImageBase.colorspacecCs(|jdus |jdkr|jrdSdS|jS)z!Bits per component of this image.Nrru)rkrhrbr)r)r*bits_per_componentszPdfImageBase.bits_per_componentImageCmsProfile | NonecCrZ)z4Return ICC profile for this image if one is defined.Nr)rbr)r)r*iccr^zPdfImageBase.icccCs d|jvS)z/Check if the image has a defined color palette.rt)rorbr)r)r*indexed zPdfImageBase.indexedc Cs\z |j}|ddkr|dd|krWdS|d|krWdSWdStttfy-YdSw)NrrtruTF)ro IndexErrorAttributeErrorKeyError)r\rGcsr)r)r*_colorspace_has_names z!PdfImageBase._colorspace_has_namecC |dS)d }n|jd kr]z|}Wnttfy\}ztd|d}~ww|dkrftdd|S)z``PIL.Image.mode`` equivalent for this image, where possible. If an ICC profile is attached to the image, we still attempt to resolve a Pillow mode. rDeviceN SeparationPrUru1rrTrrWrrVz-Not sure how to handle PDF image of this typeN) rrr}rxrzr ValueErrorrMr;)r\mer)r)r*modesB    zPdfImageBase.modecCstt|j|jidS)aReturn normalized the Filter and DecodeParms data. PDF has a lot of possible data structures concerning /Filter and /DecodeParms. /Filter can be absent or a name or an array, /DecodeParms can be absent or a dictionary (if /Filter is a name) or an array (if /Filter is an array). When both are arrays the lengths match. Normalize this into: [(/FilterName, {/DecodeParmName: Value, ...}), ...] The order of /Filter matters as indicates the encoding/decoding sequence. ) fillvalue)r7rrqrrrbr)r)r*filter_decodeparmsszPdfImageBase.filter_decodeparmsPaletteData | Nonec Cs|jsdSz |j\}}}}Wnty}ztd|d}~ww|js)|js)|jr0t|d}nt|}t|}||jvrI||j vrIt d||dkrPd}n$|dkrWd}n|d kr^d }n|d kred }n|d krld}n|dkrt| }t ||S)z8Retrieve the color palette for this image if applicable.Nz&Not sure how to interpret this paletterz(not sure how to interpret this palette: rTrrUrrWrrYrrXrrV) r}rorr|rrr:r8rvPRINT_COLORSPACESr;rrP)r\Z_idxbaseZ_hivallookuprr)r)r*rQ#s6  zPdfImageBase.palette Image.ImagecCrZ)z6Convert this PDF image to a Python PIL (Pillow) image.Nr)rbr)r)r* as_pil_imageAr^zPdfImageBase.as_pil_imagerErrq Sequence[str]cshdfddt|D}|r4t|dkr#td|jd|d|d|d }||d d}n|}g}|s@||fS|j}ztd d|D|_|tj }W||_||fS||_w) zRemove simple lossless compression where it appears. Args: obj: the compressed object filters: all files on the data >/CCITTFaxDecode /DCTDecode /JPXDecodez /JBIG2Decodecsg|] \}}|vr|qSr)r))r1nr<ZCOMPLEX_FILTERSr)r*r4Tsz7PdfImageBase._remove_simple_filters..ruzObject z has compound complex filters: z. We cannot decompress this.NrcSsg|]}t|qSr))r)r1sr)r)r*r4fr5) enumeratelenr;ZobjgenZread_raw_bytesrpr read_bytesr specialized)rErqidxZsimple_filtersZcomplex_filtersZoriginal_filtersdatar)rr*_remove_simple_filtersEs(  z#PdfImageBase._remove_simple_filtersN)rGr:rHrIrJr!rAr!rAr9rArg)rAri)rArsrAr{)rAr)rAr:)rArrAr)rErrqr) r%r&r'r(ZSIMPLE_COLORSPACESrvrrr]propertyrcrfrhrkrorqrrrxrzr|r}rrrrrrrrQr staticmethodrr)r)r)r*rSps`                "   rScseZdZUdZded<ded<fddZd?dd Zd d Zed d Z ddZ e ddZ e d@ddZ dAddZdBddZdBddZdBdd ZdAd!d"Zd#d$d%dCd(d)ZejfdDd-d.ZejfdEd0d1ZdBd2d3ZdFdGd7d8Zd9d:Zd;d<ZdHd=d>ZZS)IPdfImageaSupport class to provide a consistent API for manipulating PDF images. The data structure for images inside PDFs is irregular and complex, making it difficult to use without introducing errors for less typical cases. This class addresses these difficulties by providing a regular, Pythonic API similar in spirit (and convertible to) the Python Pillow imaging library. rrEr{_icccs:t|}||d|jvrtt}|||S)zGConstruct a PdfImage... or a PdfJpxImage if that is what we really are.r)super__new____init__rq PdfJpxImage)clsrEinstance __class__r)r*r{s     zPdfImage.__new__cCs2t|tr|jddkrtd||_d|_dS)zConstruct a PDF image from a Image XObject inside a PDF. ``pim = PdfImage(page.Resources.XObject['/ImageNN'])`` Args: obj: an Image XObject z/Subtype/Imagez'can't construct PdfImage from non-imageN)r6rZ stream_dictrrMrErr\rEr)r)r*rs zPdfImage.__init__cCst|tstS|j|jkSN)r6rSNotImplementedrEr\otherr)r)r*__eq__s  zPdfImage.__eq__cCs|}t||}td|_td|_|jdkrtd|_n |jdvr(td|_|jdkr/dnd |_|j|_ |j |_ ||j j |<||S) a@Insert a PIL image into a PDF (rudimentary). Args: pdf (pikepdf.Pdf): the PDF to attach the image to page (pikepdf.Object): the page to attach the image to name (str or pikepdf.Name): the name to set the image image (PIL.Image.Image): the image to insert z/XObjectrrrT)rrrUrrury)tobytesrrTypeZSubtyperrmrjrcr`rfreZ ResourcesZXObject)rZpdfpagerGimagerZimstreamr)r)r*_from_pil_images        zPdfImage._from_pil_imagecCt|j|||SrrOrEr[r)r)r*r]zPdfImage._metadatacCsD|jdkr|js |jdSt|jdtsJ|jddStd)NrVruz+Don't know how to find ICC stream for image)rxr}ror6r7r;rbr)r)r* _iccstreams  zPdfImage._iccstreamrAc Cs|jdvrdS|js>|j}|}t|}z t||_W|jSty=}zt|dkr1td|WYd}~|jSd}~ww|jS)zIf an ICC profile is attached, return a Pillow object that describe it. Most of the information may be found in ``icc.profile``. )rVrtNzcannot open profile from stringz#ICC profile corrupt or not readable) rxrrget_stream_bufferrrOSErrorr:r#)r\Z iccstreamZ iccbufferZ iccbytesiorr)r)r*r|s*    z PdfImage.iccstreamr r:csdfdd }dfdd }jj\}}|dgkr;jdkr(j}nd }|j||d ||d S|d gkrRjd ksK|sK|rR||dSt )aSAttempt to extract the image directly to a usable image file. If there is no way to extract the image without decompressing or transcoding then raise an exception. The type and format of image generated will vary. Args: stream: Writable file stream to write data to, e.g. an open file rArgcs,d}jddd|}jdko||kS)Nrur/ColorTransformrrrr)ZDEFAULT_CT_RGBctrbr)r*normal_dct_rgbsz0PdfImage._extract_direct..normal_dct_rgbcs,d}jddd|}jdko||kS)Nrrurrr)ZDEFAULT_CT_CMYKrrbr)r*normal_dct_cmyksz1PdfImage._extract_direct..normal_dct_cmykrrVN)r|z.tifrrz.jpgr) rrErqrxrrwrite_generate_ccitt_headerrr,)r\rrrrrqr|r)rbr*_extract_directs        zPdfImage._extract_directrcCsd}|jdkr dnd}|jdvrt||j|j|\}}n|jdkr,tt|}nt d|jdkrK|j durK|j \}}t ||j|||}|St ||j|}|S) zAExtract an image when there are 1/2/4/8 bits packed in byte data.rrru)ryz*BitsPerComponent must be 1, 2, 4, 8, or 16rN) rrzr Zunpack_subbyte_pixelsrrr memoryviewrr.rQZimage_from_buffer_and_paletteZimage_from_byte_buffer)r\Zstridescalebuffer base_moderQimr)r)r*_extract_transcoded_1248bitss*    z%PdfImage._extract_transcoded_1248bitsc Cs|jdvr tdz|}Wn ttfy/}zdt|vr*ts*t ddd}~wwt d|j |}|j durI|j \}}t|||}|S)N)rrz$1-bit RGB and CMYK are not supportedz(read_bytes called on unfilterable streamzRjbig2dec - not installed or installed version is too old (older than version 0.15)r)rr#r RuntimeErrorrr:rZ get_decoder availablerr frombytesrrQr Zfix_1bit_palette_image)r\rrrrrQr)r)r*_extract_transcoded_1bits*      z!PdfImage._extract_transcoded_1bitc Cs|jdvrt|jdkr!|jdkr!td|j|dddd}n?|jdkr:|jdkr:td|j|dddd}n&|jdkrD|}n|jdvrS|jdkrS| }n t t |d t |j |j d krr|jdurr|j|jd <|S) N>rrrryrawrrur)rrz, rVr)rr-rzrZ frombufferrrrrrr#rwrErxr|rinfo)r\rr)r)r*_extract_transcoded3s$    zPdfImage._extract_transcodedc Csz|j|dWStyYnwd}zWz4|}|jdkr2|j|dddWW|r0|dSdS|rG|j|dd WW|rE|d Sd SWntyb}zd t|vr]tt ||d}~wwW|rj|n|rr|wwtt |) aExtract the image to a stream. If possible, the compressed data is extracted and inserted into a compressed image file format without transcoding the compressed content. If this is not possible, the data will be decompressed and extracted to an appropriate format. Args: stream: Writable stream to write data to Returns: The file format extension. rNrZtiffZtiff_adobe_deflate)format compressionz.tiffZpng)rz.pngzcalled on unfilterable stream) rr,rrsavecloserr:r#rw)r\rrrr)r)r*_extract_to_streamNsF       zPdfImage._extract_to_streamNrr fileprefixBinaryIO | NonercCst|t|kr td|r|j|dSt}|j|d}|dttt||}|d}t||Wdt|S1sDwYt|S)aExtract the image directly to a usable image file. If possible, the compressed data is extracted and inserted into a compressed image file format without transcoding the compressed content. If this is not possible, the data will be decompressed and extracted to an appropriate format. Because it is not known until attempted what image format will be extracted, users should not assume what format they are getting back. When saving the image to a file, use a temporary filename, and then rename the file to its final name based on the returned file extension. Images might be saved as any of .png, .jpg, or .tiff. Examples: >>> im.extract_to(stream=bytes_io) '.png' >>> im.extract_to(fileprefix='/tmp/image00') '/tmp/image00.jpg' Args: stream: Writable stream to write data to. fileprefix (str or Path): The path to write the extracted image to, without the file extension. Returns: If *fileprefix* was provided, then the fileprefix with the appropriate extension. If no *fileprefix*, then an extension indicating the file type. z%Cannot set both stream and fileprefixrrwbN) rgrrrseekrr:openr )r\rrbio extensionfilepathtargetr)r)r* extract_tots"      zPdfImage.extract_to decode_levelrr8cC|jj|dS)z7Decompress this image and return it as unencoded bytes.r)rErr\rr)r)r*rzPdfImage.read_bytesrcCr)z+Access this image with the buffer protocol.r)rErrr)r)r*rrzPdfImage.get_stream_buffercCsXzt}|j|d|dt|WStyYnw|}|s*tt||S)zuExtract the image as a Pillow Image, using decompression as necessary. Caller must close the image. rr) rrrrrr,rr#rw)r\rrr)r)r*rs     zPdfImage.as_pil_imagerr| bytes | NonecCs|jstd|jdddrtd|jddd}|dkr$d}n |dkr+d}nd }|jdd d}d}t|}|d urBd }t|j||||S) z8Construct a CCITT G3 or G4 header from the PDF metadata.z$/CCITTFaxDecode without /DecodeParmsrz/EncodedByteAlignFz+/CCITTFaxDecode with /EncodedByteAlign truez/Krrz /BlackIs1N)rrrrr#rr Zgenerate_ccitt_headerr)r\rr|kZ ccitt_groupZ _black_is_oneZ photometryZimg_sizer)r)r*rs(  zPdfImage._generate_ccitt_headercCs|dS)z$Show the image however PIL wants to.N)rshowrbr)r)r*rsz PdfImage.showc C,d|jd|jd|jdtt|d S)Nzrrcrfhexidrbr)r)r*__repr__  zPdfImage.__repr__cCsFt}|}||d|WdS1swYdS)z!Display hook for IPython/Jupyter.ZPNGN)rrrgetvalue)r\brr)r)r* _repr_png_s   $zPdfImage._repr_png_)rErr)rr rAr:r)rrrr:rAr:)rrrAr8)rrrArr)rr8r|rrAr8rAr8)r%r&r'r(rRrrr classmethodrr]rrr|rrrrrrrrrrrrrrr __classcell__r)r)rr*rns<          .   '0   (rcsfeZdZdZfddZddZddd Zefd d ZedddZ edddZ ddZ Z S)rzSupport class for JPEG 2000 images. Implements the same API as :class:`PdfImage`. If you call PdfImage(object_that_is_actually_jpeg2000_image), pikepdf will return this class instead, due to the check in PdfImage.__new__. cst|||_dS)zInitialize a JPEG 2000 image.N)rrr_jpxpilrrr)r*rs zPdfJpxImage.__init__cCs0t|tstS|j|jkot|to|j|jkSr)r6rSrrErrrr)r)r*rs   zPdfJpxImage.__eq__rr cCs6||j|j\}}|dgkrt|j||dS)Nrz.jp2)rrErqr#r)r\rrrqr)r)r*rs    zPdfJpxImage._extract_directcs<tj}|r|S|jjdkrdgS|jjdkrdgStd)zReturn the effective colorspace of a JPEG 2000 image. If the ColorSpace dictionary is present, the colorspace embedded in the JPEG 2000 data will be ignored, as required by the specification. rrUrrTzComplex JP2 colorspace)rrorrr;)r\Zsuper_colorspacesrr)r*ros   zPdfJpxImage._colorspacesrAr9cCrZ)z=Return 8, since bpc is not meaningful for JPEG 2000 encoding.ryr)rbr)r)r*rk*szPdfJpxImage._bpcrgcCrZ)z4Return False, since JPEG 2000 should not be indexed.Fr)rbr)r)r*r}3szPdfJpxImage.indexedc Cr)Nz)ZdQd@dAZdBdCdDdRdIdJZdKdLZdMdNZdBS)SPdfInlineImagezRSupport class for PDF inline images. Implements the same API as :class:`PdfImage`.s/Ws/Widths/Hs/Heights/BPCs/BitsPerComponents/IMs /ImageMasks/CSs /ColorSpaces/Fs/Filters/DPs /DecodeParmss/Gs /DeviceGrays/RGBs /DeviceRGBs/CMYKs /DeviceCMYKs/Is/Indexeds/AHxs/ASCIIHexDecodes/A85s/ASCII85Decodes/LZWs /LZWDecodes/RLs/RunLengthDecodes/CCFs/CCITTFaxDecodes/DCTs /DCTDecodecCsi|]\}}||qSr)r))r1rvr)r)r* YszPdfInlineImage.r_dataztuple[Object, ...] _image_object image_data image_objecttuplec sr|_|_dfdd|D}z td|d}Wnty3}z td|d|d}~ww|_dS) zConstruct wrapper for inline image. Args: image_data: data stream for image, extracted from content stream image_object: the metadata for image, also from content stream  c3s |] }j|jdVqdS) remap_namesN) _unparse_objABBREVS)r1rErbr)r* ms z*PdfInlineImage.__init__..s<< s >>zparsing inline unicode_escapeN)rrjoinrparserdecoderE)r\rrZreparseZ reparsed_objrr)rbr*r^s  zPdfInlineImage.__init__cCs8t|tstS|j|jkot|to|j|jkSr)r6rSrrErr_inline_image_raw_bytesrr)r)r*rvs  zPdfInlineImage.__eq__cCst|tr#t|tr|jdd}t|tsJ|||S|jddSt|tr.|r,dSdSt|ttt fr=t | dSt t |)NT)resolvedstruesfalseascii)r6rrunparser8rrgr9rfloatr:encoder;rw)rrEr"rGr)r)r*r#s        zPdfInlineImage._unparse_objcCrrrr[r)r)r*r]rzPdfInlineImage._metadatarAr8cs&fddfdd}d|S)zACreate the content stream bytes that reproduce this inline image.c3s6jD]}j|jd}t|tsJ|VqdS)Nr!)rr#REVERSE_ABBREVSr6r8)Z metadata_objZunparsedrbr)r*metadata_tokenss z/PdfInlineImage.unparse..metadata_tokensc3s<dVdddDVdVjVdVdS)NsBI r cs|]}|VqdSrr))r1rr)r)r*r%zFPdfInlineImage.unparse..inline_image_tokens..s ID sEI)r'rr*r)r1r\r)r*inline_image_tokenss   z3PdfInlineImage.unparse..inline_image_tokensr)r')r\r5r)r4r*r-s  zPdfInlineImage.unparsecCstd)zIRaise an exception since ICC profiles are not supported on inline images.zJInline images with ICC profiles are not supported in the PDF specification)r.rbr)r)r*r|szPdfInlineImage.iccc CsLz|j}Wn tyd}Ynwd|d|jd|jdtt|d S)N?z#.)rnewZadd_blank_pagercrfZpagesZ contents_addr/r-Zexternalize_inline_imagesnextZimagesvaluesr)r\ZtmppdfZraw_imgZimgr)r)r*_convert_to_pdfimages z#PdfInlineImage._convert_to_pdfimagercC |S)z&Return inline image as a Pillow Image.)r;rrbr)r)r*rs zPdfInlineImage.as_pil_imageNrrrrrr:cCs|j||dS)zxExtract the inline image directly to a usable image file. See: :meth:`PdfImage.extract_to` r)r;r)r\rrr)r)r*rszPdfInlineImage.extract_tocCr<)z Return decompressed image bytes.)r;rrbr)r)r*rrzPdfInlineImage.read_bytescCr<)z"Return decompressed stream buffer.)r;rrbr)r)r*rrz PdfInlineImage.get_stream_buffer)rrrrrr)rrrr:)r%r&r'r(r$itemsr0rRrrrr#r]r-rr|rr;rrrrr)r)r)r*rBsl            rN)r/r0)r/r@rArB) rErFrGr:rHrIrJr!rArK)=r( __future__rabcrrdecimalrior itertoolsrpathlibrshutilr typingr r r r rrrZPILrZ PIL.ImageCmsrZpikepdfrrrrrrrrrrZpikepdf._exceptionsrZ pikepdf._qpdfrZpikepdf._versionrZpikepdf.modelsr r! Exceptionr#r,r-r.r?rDrOrPrSrrrr)r)r)r*sB      $  0        F