libpng.3 260 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052
  1. .TH LIBPNG 3 "April 14, 2019"
  2. .SH NAME
  3. libpng \- Portable Network Graphics (PNG) Reference Library 1.6.37
  4. .SH SYNOPSIS
  5. \fB#include <png.h>\fP
  6. \fBpng_uint_32 png_access_version_number (void);\fP
  7. \fBvoid png_benign_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP
  8. \fBvoid png_build_grayscale_palette (int \fP\fIbit_depth\fP\fB, png_colorp \fIpalette\fP\fB);\fP
  9. \fBpng_voidp png_calloc (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP
  10. \fBvoid png_chunk_benign_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP
  11. \fBvoid png_chunk_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP
  12. \fBvoid png_chunk_warning (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fImessage\fP\fB);\fP
  13. \fBvoid png_convert_from_struct_tm (png_timep \fP\fIptime\fP\fB, struct tm FAR * \fIttime\fP\fB);\fP
  14. \fBvoid png_convert_from_time_t (png_timep \fP\fIptime\fP\fB, time_t \fIttime\fP\fB);\fP
  15. \fBpng_charp png_convert_to_rfc1123 (png_structp \fP\fIpng_ptr\fP\fB, png_timep \fIptime\fP\fB);\fP
  16. \fBpng_infop png_create_info_struct (png_structp \fIpng_ptr\fP\fB);\fP
  17. \fBpng_structp png_create_read_struct (png_const_charp \fP\fIuser_png_ver\fP\fB, png_voidp \fP\fIerror_ptr\fP\fB, png_error_ptr \fP\fIerror_fn\fP\fB, png_error_ptr \fIwarn_fn\fP\fB);\fP
  18. \fBpng_structp png_create_read_struct_2 (png_const_charp \fP\fIuser_png_ver\fP\fB, png_voidp \fP\fIerror_ptr\fP\fB, png_error_ptr \fP\fIerror_fn\fP\fB, png_error_ptr \fP\fIwarn_fn\fP\fB, png_voidp \fP\fImem_ptr\fP\fB, png_malloc_ptr \fP\fImalloc_fn\fP\fB, png_free_ptr \fIfree_fn\fP\fB);\fP
  19. \fBpng_structp png_create_write_struct (png_const_charp \fP\fIuser_png_ver\fP\fB, png_voidp \fP\fIerror_ptr\fP\fB, png_error_ptr \fP\fIerror_fn\fP\fB, png_error_ptr \fIwarn_fn\fP\fB);\fP
  20. \fBpng_structp png_create_write_struct_2 (png_const_charp \fP\fIuser_png_ver\fP\fB, png_voidp \fP\fIerror_ptr\fP\fB, png_error_ptr \fP\fIerror_fn\fP\fB, png_error_ptr \fP\fIwarn_fn\fP\fB, png_voidp \fP\fImem_ptr\fP\fB, png_malloc_ptr \fP\fImalloc_fn\fP\fB, png_free_ptr \fIfree_fn\fP\fB);\fP
  21. \fBvoid png_data_freer (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fP\fIfreer\fP\fB, png_uint_32 \fImask\fP\fB);\fP
  22. \fBvoid png_destroy_info_struct (png_structp \fP\fIpng_ptr\fP\fB, png_infopp \fIinfo_ptr_ptr\fP\fB);\fP
  23. \fBvoid png_destroy_read_struct (png_structpp \fP\fIpng_ptr_ptr\fP\fB, png_infopp \fP\fIinfo_ptr_ptr\fP\fB, png_infopp \fIend_info_ptr_ptr\fP\fB);\fP
  24. \fBvoid png_destroy_write_struct (png_structpp \fP\fIpng_ptr_ptr\fP\fB, png_infopp \fIinfo_ptr_ptr\fP\fB);\fP
  25. \fBvoid png_err (png_structp \fIpng_ptr\fP\fB);\fP
  26. \fBvoid png_error (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fIerror\fP\fB);\fP
  27. \fBvoid png_free (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fIptr\fP\fB);\fP
  28. \fBvoid png_free_chunk_list (png_structp \fIpng_ptr\fP\fB);\fP
  29. \fBvoid png_free_default (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fIptr\fP\fB);\fP
  30. \fBvoid png_free_data (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fInum\fP\fB);\fP
  31. \fBpng_byte png_get_bit_depth (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  32. \fBpng_uint_32 png_get_bKGD (png_const_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_color_16p \fI*background\fP\fB);\fP
  33. \fBpng_byte png_get_channels (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  34. \fBpng_uint_32 png_get_cHRM (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, double \fP\fI*white_x\fP\fB, double \fP\fI*white_y\fP\fB, double \fP\fI*red_x\fP\fB, double \fP\fI*red_y\fP\fB, double \fP\fI*green_x\fP\fB, double \fP\fI*green_y\fP\fB, double \fP\fI*blue_x\fP\fB, double \fI*blue_y\fP\fB);\fP
  35. \fBpng_uint_32 png_get_cHRM_fixed (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fI*white_x\fP\fB, png_uint_32 \fP\fI*white_y\fP\fB, png_uint_32 \fP\fI*red_x\fP\fB, png_uint_32 \fP\fI*red_y\fP\fB, png_uint_32 \fP\fI*green_x\fP\fB, png_uint_32 \fP\fI*green_y\fP\fB, png_uint_32 \fP\fI*blue_x\fP\fB, png_uint_32 \fI*blue_y\fP\fB);\fP
  36. \fBpng_uint_32 png_get_cHRM_XYZ (png_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, double \fP\fI*red_X\fP\fB, double \fP\fI*red_Y\fP\fB, double \fP\fI*red_Z\fP\fB, double \fP\fI*green_X\fP\fB, double \fP\fI*green_Y\fP\fB, double \fP\fI*green_Z\fP\fB, double \fP\fI*blue_X\fP\fB, double \fP\fI*blue_Y\fP\fB, double \fI*blue_Z\fP\fB);\fP
  37. \fBpng_uint_32 png_get_cHRM_XYZ_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_fixed_point \fP\fI*int_red_X\fP\fB, png_fixed_point \fP\fI*int_red_Y\fP\fB, png_fixed_point \fP\fI*int_red_Z\fP\fB, png_fixed_point \fP\fI*int_green_X\fP\fB, png_fixed_point \fP\fI*int_green_Y\fP\fB, png_fixed_point \fP\fI*int_green_Z\fP\fB, png_fixed_point \fP\fI*int_blue_X\fP\fB, png_fixed_point \fP\fI*int_blue_Y\fP\fB, png_fixed_point \fI*int_blue_Z\fP\fB);\fP
  38. \fBpng_uint_32 png_get_chunk_cache_max (png_const_structp \fIpng_ptr\fP\fB);\fP
  39. \fBpng_alloc_size_t png_get_chunk_malloc_max (png_const_structp \fIpng_ptr\fP\fB);\fP
  40. \fBpng_byte png_get_color_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  41. \fBpng_uint_32 png_get_compression_buffer_size (png_const_structp \fIpng_ptr\fP\fB);\fP
  42. \fBpng_byte png_get_compression_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  43. \fBpng_byte png_get_copyright (png_const_structp \fIpng_ptr\fP\fB);\fP
  44. \fBpng_uint_32 png_get_current_row_number \fI(png_const_structp\fP\fB);\fP
  45. \fBpng_byte png_get_current_pass_number \fI(png_const_structp\fP\fB);\fP
  46. \fBpng_voidp png_get_error_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
  47. \fBpng_byte png_get_filter_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  48. \fBpng_uint_32 png_get_gAMA (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, double \fI*file_gamma\fP\fB);\fP
  49. \fBpng_uint_32 png_get_gAMA_fixed (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fI*int_file_gamma\fP\fB);\fP
  50. \fBpng_byte png_get_header_ver (png_const_structp \fIpng_ptr\fP\fB);\fP
  51. \fBpng_byte png_get_header_version (png_const_structp \fIpng_ptr\fP\fB);\fP
  52. \fBpng_uint_32 png_get_eXIf (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_bytep \fI*exif\fP\fB);\fP
  53. \fBpng_uint_32 png_get_eXIf_1 (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_unit_32 \fP\fI*num_exif\fP\fB, png_bytep \fI*exif\fP\fB);\fP
  54. \fBpng_uint_32 png_get_hIST (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_uint_16p \fI*hist\fP\fB);\fP
  55. \fBpng_uint_32 png_get_iCCP (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_charpp \fP\fIname\fP\fB, int \fP\fI*compression_type\fP\fB, png_bytepp \fP\fIprofile\fP\fB, png_uint_32 \fI*proflen\fP\fB);\fP
  56. \fBpng_uint_32 png_get_IHDR (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fI*width\fP\fB, png_uint_32 \fP\fI*height\fP\fB, int \fP\fI*bit_depth\fP\fB, int \fP\fI*color_type\fP\fB, int \fP\fI*interlace_type\fP\fB, int \fP\fI*compression_type\fP\fB, int \fI*filter_type\fP\fB);\fP
  57. \fBpng_uint_32 png_get_image_height (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  58. \fBpng_uint_32 png_get_image_width (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  59. \fBpng_int_32 png_get_int_32 (png_bytep \fIbuf\fP\fB);\fP
  60. \fBpng_byte png_get_interlace_type (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  61. \fBpng_uint_32 png_get_io_chunk_type (png_const_structp \fIpng_ptr\fP\fB);\fP
  62. \fBpng_voidp png_get_io_ptr (png_structp \fIpng_ptr\fP\fB);\fP
  63. \fBpng_uint_32 png_get_io_state (png_structp \fIpng_ptr\fP\fB);\fP
  64. \fBpng_byte png_get_libpng_ver (png_const_structp \fIpng_ptr\fP\fB);\fP
  65. \fBint png_get_palette_max(png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  66. \fBpng_voidp png_get_mem_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
  67. \fBpng_uint_32 png_get_oFFs (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fI*offset_x\fP\fB, png_uint_32 \fP\fI*offset_y\fP\fB, int \fI*unit_type\fP\fB);\fP
  68. \fBpng_uint_32 png_get_pCAL (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_charp \fP\fI*purpose\fP\fB, png_int_32 \fP\fI*X0\fP\fB, png_int_32 \fP\fI*X1\fP\fB, int \fP\fI*type\fP\fB, int \fP\fI*nparams\fP\fB, png_charp \fP\fI*units\fP\fB, png_charpp \fI*params\fP\fB);\fP
  69. \fBpng_uint_32 png_get_pHYs (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fI*res_x\fP\fB, png_uint_32 \fP\fI*res_y\fP\fB, int \fI*unit_type\fP\fB);\fP
  70. \fBfloat png_get_pixel_aspect_ratio (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  71. \fBpng_uint_32 png_get_pHYs_dpi (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fI*res_x\fP\fB, png_uint_32 \fP\fI*res_y\fP\fB, int \fI*unit_type\fP\fB);\fP
  72. \fBpng_fixed_point png_get_pixel_aspect_ratio_fixed (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  73. \fBpng_uint_32 png_get_pixels_per_inch (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  74. \fBpng_uint_32 png_get_pixels_per_meter (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  75. \fBpng_voidp png_get_progressive_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
  76. \fBpng_uint_32 png_get_PLTE (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_colorp \fP\fI*palette\fP\fB, int \fI*num_palette\fP\fB);\fP
  77. \fBpng_byte png_get_rgb_to_gray_status (png_const_structp \fIpng_ptr\fP\fB);\fP
  78. \fBpng_uint_32 png_get_rowbytes (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  79. \fBpng_bytepp png_get_rows (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  80. \fBpng_uint_32 png_get_sBIT (png_const_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_color_8p \fI*sig_bit\fP\fB);\fP
  81. \fBvoid png_get_sCAL (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, int* \fP\fIunit\fP\fB, double* \fP\fIwidth\fP\fB, double* \fIheight\fP\fB);\fP
  82. \fBvoid png_get_sCAL_fixed (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, int* \fP\fIunit\fP\fB, png_fixed_pointp \fP\fIwidth\fP\fB, png_fixed_pointp \fIheight\fP\fB);\fP
  83. \fBvoid png_get_sCAL_s (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, int* \fP\fIunit\fP\fB, png_charpp \fP\fIwidth\fP\fB, png_charpp \fIheight\fP\fB);\fP
  84. \fBpng_bytep png_get_signature (png_const_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
  85. \fBpng_uint_32 png_get_sPLT (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_spalette_p \fI*splt_ptr\fP\fB);\fP
  86. \fBpng_uint_32 png_get_sRGB (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, int \fI*file_srgb_intent\fP\fB);\fP
  87. \fBpng_uint_32 png_get_text (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_textp \fP\fI*text_ptr\fP\fB, int \fI*num_text\fP\fB);\fP
  88. \fBpng_uint_32 png_get_tIME (png_const_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_timep \fI*mod_time\fP\fB);\fP
  89. \fBpng_uint_32 png_get_tRNS (png_const_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_bytep \fP\fI*trans_alpha\fP\fB, int \fP\fI*num_trans\fP\fB, png_color_16p \fI*trans_color\fP\fB);\fP
  90. \fB/* This function is really an inline macro. \fI*/
  91. \fBpng_uint_16 png_get_uint_16 (png_bytep \fIbuf\fP\fB);\fP
  92. \fBpng_uint_32 png_get_uint_31 (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fIbuf\fP\fB);\fP
  93. \fB/* This function is really an inline macro. \fI*/
  94. \fBpng_uint_32 png_get_uint_32 (png_bytep \fIbuf\fP\fB);\fP
  95. \fBpng_uint_32 png_get_unknown_chunks (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_unknown_chunkpp \fIunknowns\fP\fB);\fP
  96. \fBpng_voidp png_get_user_chunk_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
  97. \fBpng_uint_32 png_get_user_height_max (png_const_structp \fIpng_ptr\fP\fB);\fP
  98. \fBpng_voidp png_get_user_transform_ptr (png_const_structp \fIpng_ptr\fP\fB);\fP
  99. \fBpng_uint_32 png_get_user_width_max (png_const_structp \fIpng_ptr\fP\fB);\fP
  100. \fBpng_uint_32 png_get_valid (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fIflag\fP\fB);\fP
  101. \fBfloat png_get_x_offset_inches (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  102. \fBpng_fixed_point png_get_x_offset_inches_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  103. \fBpng_int_32 png_get_x_offset_microns (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  104. \fBpng_int_32 png_get_x_offset_pixels (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  105. \fBpng_uint_32 png_get_x_pixels_per_inch (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  106. \fBpng_uint_32 png_get_x_pixels_per_meter (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  107. \fBfloat png_get_y_offset_inches (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  108. \fBpng_fixed_point png_get_y_offset_inches_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  109. \fBpng_int_32 png_get_y_offset_microns (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  110. \fBpng_int_32 png_get_y_offset_pixels (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  111. \fBpng_uint_32 png_get_y_pixels_per_inch (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  112. \fBpng_uint_32 png_get_y_pixels_per_meter (png_const_structp \fP\fIpng_ptr\fP\fB, png_const_infop \fIinfo_ptr\fP\fB);\fP
  113. \fBint png_handle_as_unknown (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fIchunk_name\fP\fB);\fP
  114. \fBint png_image_begin_read_from_file (png_imagep \fP\fIimage\fP\fB, const char \fI*file_name\fP\fB);\fP
  115. \fBint png_image_begin_read_from_stdio (png_imagep \fP\fIimage\fP\fB, FILE* \fIfile\fP\fB);\fP
  116. \fBint, png_image_begin_read_from_memory (png_imagep \fP\fIimage\fP\fB, png_const_voidp \fP\fImemory\fP\fB, size_t \fIsize\fP\fB);\fP
  117. \fBint png_image_finish_read (png_imagep \fP\fIimage\fP\fB, png_colorp \fP\fIbackground\fP\fB, void \fP\fI*buffer\fP\fB, png_int_32 \fP\fIrow_stride\fP\fB, void \fI*colormap\fP\fB);\fP
  118. \fBvoid png_image_free (png_imagep \fIimage\fP\fB);\fP
  119. \fBint png_image_write_to_file (png_imagep \fP\fIimage\fP\fB, const char \fP\fI*file\fP\fB, int \fP\fIconvert_to_8bit\fP\fB, const void \fP\fI*buffer\fP\fB, png_int_32 \fP\fIrow_stride\fP\fB, void \fI*colormap\fP\fB);\fP
  120. \fBint png_image_write_to_memory (png_imagep \fP\fIimage\fP\fB, void \fP\fI*memory\fP\fB, png_alloc_size_t * PNG_RESTRICT \fP\fImemory_bytes\fP\fB, int \fP\fIconvert_to_8_bit\fP\fB, const void \fP\fI*buffer\fP\fB, png_int_32 \fP\fIrow_stride\fP\fB, const void \fI*colormap\fP\fB);\fP
  121. \fBint png_image_write_to_stdio (png_imagep \fP\fIimage\fP\fB, FILE \fP\fI*file\fP\fB, int \fP\fIconvert_to_8_bit\fP\fB, const void \fP\fI*buffer\fP\fB, png_int_32 \fP\fIrow_stride\fP\fB, void \fI*colormap\fP\fB);\fP
  122. \fBvoid png_info_init_3 (png_infopp \fP\fIinfo_ptr\fP\fB, size_t \fIpng_info_struct_size\fP\fB);\fP
  123. \fBvoid png_init_io (png_structp \fP\fIpng_ptr\fP\fB, FILE \fI*fp\fP\fB);\fP
  124. \fBvoid png_longjmp (png_structp \fP\fIpng_ptr\fP\fB, int \fIval\fP\fB);\fP
  125. \fBpng_voidp png_malloc (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP
  126. \fBpng_voidp png_malloc_default (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP
  127. \fBpng_voidp png_malloc_warn (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIsize\fP\fB);\fP
  128. \fBpng_uint_32 png_permit_mng_features (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fImng_features_permitted\fP\fB);\fP
  129. \fBvoid png_process_data (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_bytep \fP\fIbuffer\fP\fB, size_t \fIbuffer_size\fP\fB);\fP
  130. \fBsize_t png_process_data_pause (png_structp \fP\fIpng_ptr\fP\fB, int \fIsave\fP\fB);\fP
  131. \fBpng_uint_32 png_process_data_skip (png_structp \fP\fIpng_ptr\fP\fB);\fP
  132. \fBvoid png_progressive_combine_row (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fP\fIold_row\fP\fB, png_bytep \fInew_row\fP\fB);\fP
  133. \fBvoid png_read_end (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
  134. \fBvoid png_read_image (png_structp \fP\fIpng_ptr\fP\fB, png_bytepp \fIimage\fP\fB);\fP
  135. \fBvoid png_read_info (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
  136. \fBvoid png_read_png (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fP\fItransforms\fP\fB, png_voidp \fIparams\fP\fB);\fP
  137. \fBvoid png_read_row (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fP\fIrow\fP\fB, png_bytep \fIdisplay_row\fP\fB);\fP
  138. \fBvoid png_read_rows (png_structp \fP\fIpng_ptr\fP\fB, png_bytepp \fP\fIrow\fP\fB, png_bytepp \fP\fIdisplay_row\fP\fB, png_uint_32 \fInum_rows\fP\fB);\fP
  139. \fBvoid png_read_update_info (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
  140. \fBint png_reset_zstream (png_structp \fIpng_ptr\fP\fB);\fP
  141. \fBvoid png_save_int_32 (png_bytep \fP\fIbuf\fP\fB, png_int_32 \fIi\fP\fB);\fP
  142. \fBvoid png_save_uint_16 (png_bytep \fP\fIbuf\fP\fB, unsigned int \fIi\fP\fB);\fP
  143. \fBvoid png_save_uint_32 (png_bytep \fP\fIbuf\fP\fB, png_uint_32 \fIi\fP\fB);\fP
  144. \fBvoid png_set_add_alpha (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fP\fIfiller\fP\fB, int \fIflags\fP\fB);\fP
  145. \fBvoid png_set_alpha_mode (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fImode\fP\fB, double \fIoutput_gamma\fP\fB);\fP
  146. \fBvoid png_set_alpha_mode_fixed (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fImode\fP\fB, png_fixed_point \fIoutput_gamma\fP\fB);\fP
  147. \fBvoid png_set_background (png_structp \fP\fIpng_ptr\fP\fB, png_color_16p \fP\fIbackground_color\fP\fB, int \fP\fIbackground_gamma_code\fP\fB, int \fP\fIneed_expand\fP\fB, double \fIbackground_gamma\fP\fB);\fP
  148. \fBvoid png_set_background_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_color_16p \fP\fIbackground_color\fP\fB, int \fP\fIbackground_gamma_code\fP\fB, int \fP\fIneed_expand\fP\fB, png_uint_32 \fIbackground_gamma\fP\fB);\fP
  149. \fBvoid png_set_benign_errors (png_structp \fP\fIpng_ptr\fP\fB, int \fIallowed\fP\fB);\fP
  150. \fBvoid png_set_bgr (png_structp \fIpng_ptr\fP\fB);\fP
  151. \fBvoid png_set_bKGD (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_color_16p \fIbackground\fP\fB);\fP
  152. \fBvoid png_set_check_for_invalid_index (png_structrp \fP\fIpng_ptr\fP\fB, int \fIallowed\fP\fB);\fP
  153. \fBvoid png_set_cHRM (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, double \fP\fIwhite_x\fP\fB, double \fP\fIwhite_y\fP\fB, double \fP\fIred_x\fP\fB, double \fP\fIred_y\fP\fB, double \fP\fIgreen_x\fP\fB, double \fP\fIgreen_y\fP\fB, double \fP\fIblue_x\fP\fB, double \fIblue_y\fP\fB);\fP
  154. \fBvoid png_set_cHRM_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fIwhite_x\fP\fB, png_uint_32 \fP\fIwhite_y\fP\fB, png_uint_32 \fP\fIred_x\fP\fB, png_uint_32 \fP\fIred_y\fP\fB, png_uint_32 \fP\fIgreen_x\fP\fB, png_uint_32 \fP\fIgreen_y\fP\fB, png_uint_32 \fP\fIblue_x\fP\fB, png_uint_32 \fIblue_y\fP\fB);\fP
  155. \fBvoid png_set_cHRM_XYZ (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, double \fP\fIred_X\fP\fB, double \fP\fIred_Y\fP\fB, double \fP\fIred_Z\fP\fB, double \fP\fIgreen_X\fP\fB, double \fP\fIgreen_Y\fP\fB, double \fP\fIgreen_Z\fP\fB, double \fP\fIblue_X\fP\fB, double \fP\fIblue_Y\fP\fB, double \fIblue_Z\fP\fB);\fP
  156. \fBvoid png_set_cHRM_XYZ_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_fixed_point \fP\fIint_red_X\fP\fB, png_fixed_point \fP\fIint_red_Y\fP\fB, png_fixed_point \fP\fIint_red_Z\fP\fB, png_fixed_point \fP\fIint_green_X\fP\fB, png_fixed_point \fP\fIint_green_Y\fP\fB, png_fixed_point \fP\fIint_green_Z\fP\fB, png_fixed_point \fP\fIint_blue_X\fP\fB, png_fixed_point \fP\fIint_blue_Y\fP\fB, png_fixed_point \fIint_blue_Z\fP\fB);\fP
  157. \fBvoid png_set_chunk_cache_max (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fIuser_chunk_cache_max\fP\fB);\fP
  158. \fBvoid png_set_compression_level (png_structp \fP\fIpng_ptr\fP\fB, int \fIlevel\fP\fB);\fP
  159. \fBvoid png_set_compression_mem_level (png_structp \fP\fIpng_ptr\fP\fB, int \fImem_level\fP\fB);\fP
  160. \fBvoid png_set_compression_method (png_structp \fP\fIpng_ptr\fP\fB, int \fImethod\fP\fB);\fP
  161. \fBvoid png_set_compression_strategy (png_structp \fP\fIpng_ptr\fP\fB, int \fIstrategy\fP\fB);\fP
  162. \fBvoid png_set_compression_window_bits (png_structp \fP\fIpng_ptr\fP\fB, int \fIwindow_bits\fP\fB);\fP
  163. \fBvoid png_set_crc_action (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fIcrit_action\fP\fB, int \fIancil_action\fP\fB);\fP
  164. \fBvoid png_set_error_fn (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fIerror_ptr\fP\fB, png_error_ptr \fP\fIerror_fn\fP\fB, png_error_ptr \fIwarning_fn\fP\fB);\fP
  165. \fBvoid png_set_expand (png_structp \fIpng_ptr\fP\fB);\fP
  166. \fBvoid png_set_expand_16 (png_structp \fIpng_ptr\fP\fB);\fP
  167. \fBvoid png_set_expand_gray_1_2_4_to_8 (png_structp \fIpng_ptr\fP\fB);\fP
  168. \fBvoid png_set_filler (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fP\fIfiller\fP\fB, int \fIflags\fP\fB);\fP
  169. \fBvoid png_set_filter (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fImethod\fP\fB, int \fIfilters\fP\fB);\fP
  170. \fBvoid png_set_filter_heuristics (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fIheuristic_method\fP\fB, int \fP\fInum_weights\fP\fB, png_doublep \fP\fIfilter_weights\fP\fB, png_doublep \fIfilter_costs\fP\fB);\fP
  171. \fBvoid png_set_filter_heuristics_fixed (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fIheuristic_method\fP\fB, int \fP\fInum_weights\fP\fB, png_fixed_point_p \fP\fIfilter_weights\fP\fB, png_fixed_point_p \fIfilter_costs\fP\fB);\fP
  172. \fBvoid png_set_flush (png_structp \fP\fIpng_ptr\fP\fB, int \fInrows\fP\fB);\fP
  173. \fBvoid png_set_gamma (png_structp \fP\fIpng_ptr\fP\fB, double \fP\fIscreen_gamma\fP\fB, double \fIdefault_file_gamma\fP\fB);\fP
  174. \fBvoid png_set_gamma_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fP\fIscreen_gamma\fP\fB, png_uint_32 \fIdefault_file_gamma\fP\fB);\fP
  175. \fBvoid png_set_gAMA (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, double \fIfile_gamma\fP\fB);\fP
  176. \fBvoid png_set_gAMA_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fIfile_gamma\fP\fB);\fP
  177. \fBvoid png_set_gray_1_2_4_to_8 (png_structp \fIpng_ptr\fP\fB);\fP
  178. \fBvoid png_set_gray_to_rgb (png_structp \fIpng_ptr\fP\fB);\fP
  179. \fBvoid png_set_eXIf (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_bytep \fIexif\fP\fB);\fP
  180. \fBvoid png_set_eXIf_1 (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fInum_exif\fP\fB, png_bytep \fIexif\fP\fB);\fP
  181. \fBvoid png_set_hIST (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_16p \fIhist\fP\fB);\fP
  182. \fBvoid png_set_iCCP (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_const_charp \fP\fIname\fP\fB, int \fP\fIcompression_type\fP\fB, png_const_bytep \fP\fIprofile\fP\fB, png_uint_32 \fIproflen\fP\fB);\fP
  183. \fBint png_set_interlace_handling (png_structp \fIpng_ptr\fP\fB);\fP
  184. \fBvoid png_set_invalid (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fImask\fP\fB);\fP
  185. \fBvoid png_set_invert_alpha (png_structp \fIpng_ptr\fP\fB);\fP
  186. \fBvoid png_set_invert_mono (png_structp \fIpng_ptr\fP\fB);\fP
  187. \fBvoid png_set_IHDR (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fIwidth\fP\fB, png_uint_32 \fP\fIheight\fP\fB, int \fP\fIbit_depth\fP\fB, int \fP\fIcolor_type\fP\fB, int \fP\fIinterlace_type\fP\fB, int \fP\fIcompression_type\fP\fB, int \fIfilter_type\fP\fB);\fP
  188. \fBvoid png_set_keep_unknown_chunks (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fIkeep\fP\fB, png_bytep \fP\fIchunk_list\fP\fB, int \fInum_chunks\fP\fB);\fP
  189. \fBjmp_buf* png_set_longjmp_fn (png_structp \fP\fIpng_ptr\fP\fB, png_longjmp_ptr \fP\fIlongjmp_fn\fP\fB, size_t \fIjmp_buf_size\fP\fB);\fP
  190. \fBvoid png_set_chunk_malloc_max (png_structp \fP\fIpng_ptr\fP\fB, png_alloc_size_t \fIuser_chunk_cache_max\fP\fB);\fP
  191. \fBvoid png_set_compression_buffer_size (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fIsize\fP\fB);\fP
  192. \fBvoid png_set_mem_fn (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fImem_ptr\fP\fB, png_malloc_ptr \fP\fImalloc_fn\fP\fB, png_free_ptr \fIfree_fn\fP\fB);\fP
  193. \fBvoid png_set_oFFs (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fIoffset_x\fP\fB, png_uint_32 \fP\fIoffset_y\fP\fB, int \fIunit_type\fP\fB);\fP
  194. \fBint png_set_option(png_structrp \fP\fIpng_ptr\fP\fB, int \fP\fIoption\fP\fB, int \fIonoff\fP\fB);\fP
  195. \fBvoid png_set_packing (png_structp \fIpng_ptr\fP\fB);\fP
  196. \fBvoid png_set_packswap (png_structp \fIpng_ptr\fP\fB);\fP
  197. \fBvoid png_set_palette_to_rgb (png_structp \fIpng_ptr\fP\fB);\fP
  198. \fBvoid png_set_pCAL (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_charp \fP\fIpurpose\fP\fB, png_int_32 \fP\fIX0\fP\fB, png_int_32 \fP\fIX1\fP\fB, int \fP\fItype\fP\fB, int \fP\fInparams\fP\fB, png_charp \fP\fIunits\fP\fB, png_charpp \fIparams\fP\fB);\fP
  199. \fBvoid png_set_pHYs (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_uint_32 \fP\fIres_x\fP\fB, png_uint_32 \fP\fIres_y\fP\fB, int \fIunit_type\fP\fB);\fP
  200. \fBvoid png_set_progressive_read_fn (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fIprogressive_ptr\fP\fB, png_progressive_info_ptr \fP\fIinfo_fn\fP\fB, png_progressive_row_ptr \fP\fIrow_fn\fP\fB, png_progressive_end_ptr \fIend_fn\fP\fB);\fP
  201. \fBvoid png_set_PLTE (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_colorp \fP\fIpalette\fP\fB, int \fInum_palette\fP\fB);\fP
  202. \fBvoid png_set_quantize (png_structp \fP\fIpng_ptr\fP\fB, png_colorp \fP\fIpalette\fP\fB, int \fP\fInum_palette\fP\fB, int \fP\fImaximum_colors\fP\fB, png_uint_16p \fP\fIhistogram\fP\fB, int \fIfull_quantize\fP\fB);\fP
  203. \fBvoid png_set_read_fn (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fIio_ptr\fP\fB, png_rw_ptr \fIread_data_fn\fP\fB);\fP
  204. \fBvoid png_set_read_status_fn (png_structp \fP\fIpng_ptr\fP\fB, png_read_status_ptr \fIread_row_fn\fP\fB);\fP
  205. \fBvoid png_set_read_user_chunk_fn (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fIuser_chunk_ptr\fP\fB, png_user_chunk_ptr \fIread_user_chunk_fn\fP\fB);\fP
  206. \fBvoid png_set_read_user_transform_fn (png_structp \fP\fIpng_ptr\fP\fB, png_user_transform_ptr \fIread_user_transform_fn\fP\fB);\fP
  207. \fBvoid png_set_rgb_to_gray (png_structp \fP\fIpng_ptr\fP\fB, int \fP\fIerror_action\fP\fB, double \fP\fIred\fP\fB, double \fIgreen\fP\fB);\fP
  208. \fBvoid png_set_rgb_to_gray_fixed (png_structp \fP\fIpng_ptr\fP\fB, int error_action png_uint_32 \fP\fIred\fP\fB, png_uint_32 \fIgreen\fP\fB);\fP
  209. \fBvoid png_set_rows (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_bytepp \fIrow_pointers\fP\fB);\fP
  210. \fBvoid png_set_sBIT (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_color_8p \fIsig_bit\fP\fB);\fP
  211. \fBvoid png_set_sCAL (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fP\fIunit\fP\fB, double \fP\fIwidth\fP\fB, double \fIheight\fP\fB);\fP
  212. \fBvoid png_set_sCAL_fixed (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fP\fIunit\fP\fB, png_fixed_point \fP\fIwidth\fP\fB, png_fixed_point \fIheight\fP\fB);\fP
  213. \fBvoid png_set_sCAL_s (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fP\fIunit\fP\fB, png_charp \fP\fIwidth\fP\fB, png_charp \fIheight\fP\fB);\fP
  214. \fBvoid png_set_scale_16 (png_structp \fIpng_ptr\fP\fB);\fP
  215. \fBvoid png_set_shift (png_structp \fP\fIpng_ptr\fP\fB, png_color_8p \fItrue_bits\fP\fB);\fP
  216. \fBvoid png_set_sig_bytes (png_structp \fP\fIpng_ptr\fP\fB, int \fInum_bytes\fP\fB);\fP
  217. \fBvoid png_set_sPLT (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_spalette_p \fP\fIsplt_ptr\fP\fB, int \fInum_spalettes\fP\fB);\fP
  218. \fBvoid png_set_sRGB (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fIsrgb_intent\fP\fB);\fP
  219. \fBvoid png_set_sRGB_gAMA_and_cHRM (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fIsrgb_intent\fP\fB);\fP
  220. \fBvoid png_set_strip_16 (png_structp \fIpng_ptr\fP\fB);\fP
  221. \fBvoid png_set_strip_alpha (png_structp \fIpng_ptr\fP\fB);\fP
  222. \fBvoid png_set_strip_error_numbers (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fIstrip_mode\fP\fB);\fP
  223. \fBvoid png_set_swap (png_structp \fIpng_ptr\fP\fB);\fP
  224. \fBvoid png_set_swap_alpha (png_structp \fIpng_ptr\fP\fB);\fP
  225. \fBvoid png_set_text (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_textp \fP\fItext_ptr\fP\fB, int \fInum_text\fP\fB);\fP
  226. \fBvoid png_set_text_compression_level (png_structp \fP\fIpng_ptr\fP\fB, int \fIlevel\fP\fB);\fP
  227. \fBvoid png_set_text_compression_mem_level (png_structp \fP\fIpng_ptr\fP\fB, int \fImem_level\fP\fB);\fP
  228. \fBvoid png_set_text_compression_strategy (png_structp \fP\fIpng_ptr\fP\fB, int \fIstrategy\fP\fB);\fP
  229. \fBvoid png_set_text_compression_window_bits (png_structp \fP\fIpng_ptr\fP\fB, int \fIwindow_bits\fP\fB);\fP
  230. \fBvoid png_set_text_compression_method (png_structp \fP\fIpng_ptr\fP\fB, int \fImethod\fP\fB);\fP
  231. \fBvoid png_set_tIME (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_timep \fImod_time\fP\fB);\fP
  232. \fBvoid png_set_tRNS (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_bytep \fP\fItrans_alpha\fP\fB, int \fP\fInum_trans\fP\fB, png_color_16p \fItrans_color\fP\fB);\fP
  233. \fBvoid png_set_tRNS_to_alpha (png_structp \fIpng_ptr\fP\fB);\fP
  234. \fBpng_uint_32 png_set_unknown_chunks (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, png_unknown_chunkp \fP\fIunknowns\fP\fB, int \fP\fInum\fP\fB, int \fIlocation\fP\fB);\fP
  235. \fBvoid png_set_unknown_chunk_location (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fP\fIchunk\fP\fB, int \fIlocation\fP\fB);\fP
  236. \fBvoid png_set_user_limits (png_structp \fP\fIpng_ptr\fP\fB, png_uint_32 \fP\fIuser_width_max\fP\fB, png_uint_32 \fIuser_height_max\fP\fB);\fP
  237. \fBvoid png_set_user_transform_info (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fIuser_transform_ptr\fP\fB, int \fP\fIuser_transform_depth\fP\fB, int \fIuser_transform_channels\fP\fB);\fP
  238. \fBvoid png_set_write_fn (png_structp \fP\fIpng_ptr\fP\fB, png_voidp \fP\fIio_ptr\fP\fB, png_rw_ptr \fP\fIwrite_data_fn\fP\fB, png_flush_ptr \fIoutput_flush_fn\fP\fB);\fP
  239. \fBvoid png_set_write_status_fn (png_structp \fP\fIpng_ptr\fP\fB, png_write_status_ptr \fIwrite_row_fn\fP\fB);\fP
  240. \fBvoid png_set_write_user_transform_fn (png_structp \fP\fIpng_ptr\fP\fB, png_user_transform_ptr \fIwrite_user_transform_fn\fP\fB);\fP
  241. \fBint png_sig_cmp (png_bytep \fP\fIsig\fP\fB, size_t \fP\fIstart\fP\fB, size_t \fInum_to_check\fP\fB);\fP
  242. \fBvoid png_start_read_image (png_structp \fIpng_ptr\fP\fB);\fP
  243. \fBvoid png_warning (png_structp \fP\fIpng_ptr\fP\fB, png_const_charp \fImessage\fP\fB);\fP
  244. \fBvoid png_write_chunk (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fP\fIchunk_name\fP\fB, png_bytep \fP\fIdata\fP\fB, size_t \fIlength\fP\fB);\fP
  245. \fBvoid png_write_chunk_data (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fP\fIdata\fP\fB, size_t \fIlength\fP\fB);\fP
  246. \fBvoid png_write_chunk_end (png_structp \fIpng_ptr\fP\fB);\fP
  247. \fBvoid png_write_chunk_start (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fP\fIchunk_name\fP\fB, png_uint_32 \fIlength\fP\fB);\fP
  248. \fBvoid png_write_end (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
  249. \fBvoid png_write_flush (png_structp \fIpng_ptr\fP\fB);\fP
  250. \fBvoid png_write_image (png_structp \fP\fIpng_ptr\fP\fB, png_bytepp \fIimage\fP\fB);\fP
  251. \fBvoid png_write_info (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
  252. \fBvoid png_write_info_before_PLTE (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fIinfo_ptr\fP\fB);\fP
  253. \fBvoid png_write_png (png_structp \fP\fIpng_ptr\fP\fB, png_infop \fP\fIinfo_ptr\fP\fB, int \fP\fItransforms\fP\fB, png_voidp \fIparams\fP\fB);\fP
  254. \fBvoid png_write_row (png_structp \fP\fIpng_ptr\fP\fB, png_bytep \fIrow\fP\fB);\fP
  255. \fBvoid png_write_rows (png_structp \fP\fIpng_ptr\fP\fB, png_bytepp \fP\fIrow\fP\fB, png_uint_32 \fInum_rows\fP\fB);\fP
  256. \fBvoid png_write_sig (png_structp \fIpng_ptr\fP\fB);\fP
  257. .SH DESCRIPTION
  258. The
  259. .I libpng
  260. library supports encoding, decoding, and various manipulations of
  261. the Portable Network Graphics (PNG) format image files. It uses the
  262. .IR zlib(3)
  263. compression library.
  264. Following is a copy of the libpng-manual.txt file that accompanies libpng.
  265. .SH LIBPNG.TXT
  266. libpng-manual.txt - A description on how to use and modify libpng
  267. Copyright (c) 2018-2019 Cosmin Truta
  268. Copyright (c) 1998-2018 Glenn Randers-Pehrson
  269. This document is released under the libpng license.
  270. For conditions of distribution and use, see the disclaimer
  271. and license in png.h
  272. Based on:
  273. libpng version 1.6.36, December 2018, through 1.6.37 - April 2019
  274. Updated and distributed by Cosmin Truta
  275. Copyright (c) 2018-2019 Cosmin Truta
  276. libpng versions 0.97, January 1998, through 1.6.35 - July 2018
  277. Updated and distributed by Glenn Randers-Pehrson
  278. Copyright (c) 1998-2018 Glenn Randers-Pehrson
  279. libpng 1.0 beta 6 - version 0.96 - May 28, 1997
  280. Updated and distributed by Andreas Dilger
  281. Copyright (c) 1996, 1997 Andreas Dilger
  282. libpng 1.0 beta 2 - version 0.88 - January 26, 1996
  283. For conditions of distribution and use, see copyright
  284. notice in png.h. Copyright (c) 1995, 1996 Guy Eric
  285. Schalnat, Group 42, Inc.
  286. Updated/rewritten per request in the libpng FAQ
  287. Copyright (c) 1995, 1996 Frank J. T. Wojcik
  288. December 18, 1995 & January 20, 1996
  289. TABLE OF CONTENTS
  290. I. Introduction
  291. II. Structures
  292. III. Reading
  293. IV. Writing
  294. V. Simplified API
  295. VI. Modifying/Customizing libpng
  296. VII. MNG support
  297. VIII. Changes to Libpng from version 0.88
  298. IX. Changes to Libpng from version 1.0.x to 1.2.x
  299. X. Changes to Libpng from version 1.0.x/1.2.x to 1.4.x
  300. XI. Changes to Libpng from version 1.4.x to 1.5.x
  301. XII. Changes to Libpng from version 1.5.x to 1.6.x
  302. XIII. Detecting libpng
  303. XIV. Source code repository
  304. XV. Coding style
  305. .SH I. Introduction
  306. This file describes how to use and modify the PNG reference library
  307. (known as libpng) for your own use. In addition to this
  308. file, example.c is a good starting point for using the library, as
  309. it is heavily commented and should include everything most people
  310. will need. We assume that libpng is already installed; see the
  311. INSTALL file for instructions on how to configure and install libpng.
  312. For examples of libpng usage, see the files "example.c", "pngtest.c",
  313. and the files in the "contrib" directory, all of which are included in
  314. the libpng distribution.
  315. Libpng was written as a companion to the PNG specification, as a way
  316. of reducing the amount of time and effort it takes to support the PNG
  317. file format in application programs.
  318. The PNG specification (second edition), November 2003, is available as
  319. a W3C Recommendation and as an ISO Standard (ISO/IEC 15948:2004 (E)) at
  320. <https://www.w3.org/TR/2003/REC-PNG-20031110/>.
  321. The W3C and ISO documents have identical technical content.
  322. The PNG-1.2 specification is available at
  323. <https://png-mng.sourceforge.io/pub/png/spec/1.2/>.
  324. It is technically equivalent
  325. to the PNG specification (second edition) but has some additional material.
  326. The PNG-1.0 specification is available as RFC 2083 at
  327. <https://png-mng.sourceforge.io/pub/png/spec/1.0/> and as a
  328. W3C Recommendation at <https://www.w3.org/TR/REC-png-961001>.
  329. Some additional chunks are described in the special-purpose public chunks
  330. documents at <http://www.libpng.org/pub/png/spec/register/>
  331. Other information
  332. about PNG, and the latest version of libpng, can be found at the PNG home
  333. page, <http://www.libpng.org/pub/png/>.
  334. Most users will not have to modify the library significantly; advanced
  335. users may want to modify it more. All attempts were made to make it as
  336. complete as possible, while keeping the code easy to understand.
  337. Currently, this library only supports C. Support for other languages
  338. is being considered.
  339. Libpng has been designed to handle multiple sessions at one time,
  340. to be easily modifiable, to be portable to the vast majority of
  341. machines (ANSI, K&R, 16-, 32-, and 64-bit) available, and to be easy
  342. to use. The ultimate goal of libpng is to promote the acceptance of
  343. the PNG file format in whatever way possible. While there is still
  344. work to be done (see the TODO file), libpng should cover the
  345. majority of the needs of its users.
  346. Libpng uses zlib for its compression and decompression of PNG files.
  347. Further information about zlib, and the latest version of zlib, can
  348. be found at the zlib home page, <https://zlib.net/>.
  349. The zlib compression utility is a general purpose utility that is
  350. useful for more than PNG files, and can be used without libpng.
  351. See the documentation delivered with zlib for more details.
  352. You can usually find the source files for the zlib utility wherever you
  353. find the libpng source files.
  354. Libpng is thread safe, provided the threads are using different
  355. instances of the structures. Each thread should have its own
  356. png_struct and png_info instances, and thus its own image.
  357. Libpng does not protect itself against two threads using the
  358. same instance of a structure.
  359. .SH II. Structures
  360. There are two main structures that are important to libpng, png_struct
  361. and png_info. Both are internal structures that are no longer exposed
  362. in the libpng interface (as of libpng 1.5.0).
  363. The png_info structure is designed to provide information about the
  364. PNG file. At one time, the fields of png_info were intended to be
  365. directly accessible to the user. However, this tended to cause problems
  366. with applications using dynamically loaded libraries, and as a result
  367. a set of interface functions for png_info (the png_get_*() and png_set_*()
  368. functions) was developed, and direct access to the png_info fields was
  369. deprecated..
  370. The png_struct structure is the object used by the library to decode a
  371. single image. As of 1.5.0 this structure is also not exposed.
  372. Almost all libpng APIs require a pointer to a png_struct as the first argument.
  373. Many (in particular the png_set and png_get APIs) also require a pointer
  374. to png_info as the second argument. Some application visible macros
  375. defined in png.h designed for basic data access (reading and writing
  376. integers in the PNG format) don't take a png_info pointer, but it's almost
  377. always safe to assume that a (png_struct*) has to be passed to call an API
  378. function.
  379. You can have more than one png_info structure associated with an image,
  380. as illustrated in pngtest.c, one for information valid prior to the
  381. IDAT chunks and another (called "end_info" below) for things after them.
  382. The png.h header file is an invaluable reference for programming with libpng.
  383. And while I'm on the topic, make sure you include the libpng header file:
  384. #include <png.h>
  385. and also (as of libpng-1.5.0) the zlib header file, if you need it:
  386. #include <zlib.h>
  387. .SS Types
  388. The png.h header file defines a number of integral types used by the
  389. APIs. Most of these are fairly obvious; for example types corresponding
  390. to integers of particular sizes and types for passing color values.
  391. One exception is how non-integral numbers are handled. For application
  392. convenience most APIs that take such numbers have C (double) arguments;
  393. however, internally PNG, and libpng, use 32 bit signed integers and encode
  394. the value by multiplying by 100,000. As of libpng 1.5.0 a convenience
  395. macro PNG_FP_1 is defined in png.h along with a type (png_fixed_point)
  396. which is simply (png_int_32).
  397. All APIs that take (double) arguments also have a matching API that
  398. takes the corresponding fixed point integer arguments. The fixed point
  399. API has the same name as the floating point one with "_fixed" appended.
  400. The actual range of values permitted in the APIs is frequently less than
  401. the full range of (png_fixed_point) (\-21474 to +21474). When APIs require
  402. a non-negative argument the type is recorded as png_uint_32 above. Consult
  403. the header file and the text below for more information.
  404. Special care must be take with sCAL chunk handling because the chunk itself
  405. uses non-integral values encoded as strings containing decimal floating point
  406. numbers. See the comments in the header file.
  407. .SS Configuration
  408. The main header file function declarations are frequently protected by C
  409. preprocessing directives of the form:
  410. #ifdef PNG_feature_SUPPORTED
  411. declare-function
  412. #endif
  413. ...
  414. #ifdef PNG_feature_SUPPORTED
  415. use-function
  416. #endif
  417. The library can be built without support for these APIs, although a
  418. standard build will have all implemented APIs. Application programs
  419. should check the feature macros before using an API for maximum
  420. portability. From libpng 1.5.0 the feature macros set during the build
  421. of libpng are recorded in the header file "pnglibconf.h" and this file
  422. is always included by png.h.
  423. If you don't need to change the library configuration from the default, skip to
  424. the next section ("Reading").
  425. Notice that some of the makefiles in the 'scripts' directory and (in 1.5.0) all
  426. of the build project files in the 'projects' directory simply copy
  427. scripts/pnglibconf.h.prebuilt to pnglibconf.h. This means that these build
  428. systems do not permit easy auto-configuration of the library - they only
  429. support the default configuration.
  430. The easiest way to make minor changes to the libpng configuration when
  431. auto-configuration is supported is to add definitions to the command line
  432. using (typically) CPPFLAGS. For example:
  433. CPPFLAGS=\-DPNG_NO_FLOATING_ARITHMETIC
  434. will change the internal libpng math implementation for gamma correction and
  435. other arithmetic calculations to fixed point, avoiding the need for fast
  436. floating point support. The result can be seen in the generated pnglibconf.h -
  437. make sure it contains the changed feature macro setting.
  438. If you need to make more extensive configuration changes - more than one or two
  439. feature macro settings - you can either add \-DPNG_USER_CONFIG to the build
  440. command line and put a list of feature macro settings in pngusr.h or you can set
  441. DFA_XTRA (a makefile variable) to a file containing the same information in the
  442. form of 'option' settings.
  443. A. Changing pnglibconf.h
  444. A variety of methods exist to build libpng. Not all of these support
  445. reconfiguration of pnglibconf.h. To reconfigure pnglibconf.h it must either be
  446. rebuilt from scripts/pnglibconf.dfa using awk or it must be edited by hand.
  447. Hand editing is achieved by copying scripts/pnglibconf.h.prebuilt to
  448. pnglibconf.h and changing the lines defining the supported features, paying
  449. very close attention to the 'option' information in scripts/pnglibconf.dfa
  450. that describes those features and their requirements. This is easy to get
  451. wrong.
  452. B. Configuration using DFA_XTRA
  453. Rebuilding from pnglibconf.dfa is easy if a functioning 'awk', or a later
  454. variant such as 'nawk' or 'gawk', is available. The configure build will
  455. automatically find an appropriate awk and build pnglibconf.h.
  456. The scripts/pnglibconf.mak file contains a set of make rules for doing the
  457. same thing if configure is not used, and many of the makefiles in the scripts
  458. directory use this approach.
  459. When rebuilding simply write a new file containing changed options and set
  460. DFA_XTRA to the name of this file. This causes the build to append the new file
  461. to the end of scripts/pnglibconf.dfa. The pngusr.dfa file should contain lines
  462. of the following forms:
  463. everything = off
  464. This turns all optional features off. Include it at the start of pngusr.dfa to
  465. make it easier to build a minimal configuration. You will need to turn at least
  466. some features on afterward to enable either reading or writing code, or both.
  467. option feature on
  468. option feature off
  469. Enable or disable a single feature. This will automatically enable other
  470. features required by a feature that is turned on or disable other features that
  471. require a feature which is turned off. Conflicting settings will cause an error
  472. message to be emitted by awk.
  473. setting feature default value
  474. Changes the default value of setting 'feature' to 'value'. There are a small
  475. number of settings listed at the top of pnglibconf.h, they are documented in the
  476. source code. Most of these values have performance implications for the library
  477. but most of them have no visible effect on the API. Some can also be overridden
  478. from the API.
  479. This method of building a customized pnglibconf.h is illustrated in
  480. contrib/pngminim/*. See the "$(PNGCONF):" target in the makefile and
  481. pngusr.dfa in these directories.
  482. C. Configuration using PNG_USER_CONFIG
  483. If \-DPNG_USER_CONFIG is added to the CPPFLAGS when pnglibconf.h is built,
  484. the file pngusr.h will automatically be included before the options in
  485. scripts/pnglibconf.dfa are processed. Your pngusr.h file should contain only
  486. macro definitions turning features on or off or setting settings.
  487. Apart from the global setting "everything = off" all the options listed above
  488. can be set using macros in pngusr.h:
  489. #define PNG_feature_SUPPORTED
  490. is equivalent to:
  491. option feature on
  492. #define PNG_NO_feature
  493. is equivalent to:
  494. option feature off
  495. #define PNG_feature value
  496. is equivalent to:
  497. setting feature default value
  498. Notice that in both cases, pngusr.dfa and pngusr.h, the contents of the
  499. pngusr file you supply override the contents of scripts/pnglibconf.dfa
  500. If confusing or incomprehensible behavior results it is possible to
  501. examine the intermediate file pnglibconf.dfn to find the full set of
  502. dependency information for each setting and option. Simply locate the
  503. feature in the file and read the C comments that precede it.
  504. This method is also illustrated in the contrib/pngminim/* makefiles and
  505. pngusr.h.
  506. .SH III. Reading
  507. We'll now walk you through the possible functions to call when reading
  508. in a PNG file sequentially, briefly explaining the syntax and purpose
  509. of each one. See example.c and png.h for more detail. While
  510. progressive reading is covered in the next section, you will still
  511. need some of the functions discussed in this section to read a PNG
  512. file.
  513. .SS Setup
  514. You will want to do the I/O initialization(*) before you get into libpng,
  515. so if it doesn't work, you don't have much to undo. Of course, you
  516. will also want to insure that you are, in fact, dealing with a PNG
  517. file. Libpng provides a simple check to see if a file is a PNG file.
  518. To use it, pass in the first 1 to 8 bytes of the file to the function
  519. png_sig_cmp(), and it will return 0 (false) if the bytes match the
  520. corresponding bytes of the PNG signature, or nonzero (true) otherwise.
  521. Of course, the more bytes you pass in, the greater the accuracy of the
  522. prediction.
  523. If you are intending to keep the file pointer open for use in libpng,
  524. you must ensure you don't read more than 8 bytes from the beginning
  525. of the file, and you also have to make a call to png_set_sig_bytes()
  526. with the number of bytes you read from the beginning. Libpng will
  527. then only check the bytes (if any) that your program didn't read.
  528. (*): If you are not using the standard I/O functions, you will need
  529. to replace them with custom functions. See the discussion under
  530. Customizing libpng.
  531. FILE *fp = fopen(file_name, "rb");
  532. if (!fp)
  533. {
  534. return ERROR;
  535. }
  536. if (fread(header, 1, number, fp) != number)
  537. {
  538. return ERROR;
  539. }
  540. is_png = !png_sig_cmp(header, 0, number);
  541. if (!is_png)
  542. {
  543. return NOT_PNG;
  544. }
  545. Next, png_struct and png_info need to be allocated and initialized. In
  546. order to ensure that the size of these structures is correct even with a
  547. dynamically linked libpng, there are functions to initialize and
  548. allocate the structures. We also pass the library version, optional
  549. pointers to error handling functions, and a pointer to a data struct for
  550. use by the error functions, if necessary (the pointer and functions can
  551. be NULL if the default error handlers are to be used). See the section
  552. on Changes to Libpng below regarding the old initialization functions.
  553. The structure allocation functions quietly return NULL if they fail to
  554. create the structure, so your application should check for that.
  555. png_structp png_ptr = png_create_read_struct
  556. (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
  557. user_error_fn, user_warning_fn);
  558. if (!png_ptr)
  559. return ERROR;
  560. png_infop info_ptr = png_create_info_struct(png_ptr);
  561. if (!info_ptr)
  562. {
  563. png_destroy_read_struct(&png_ptr,
  564. (png_infopp)NULL, (png_infopp)NULL);
  565. return ERROR;
  566. }
  567. If you want to use your own memory allocation routines,
  568. use a libpng that was built with PNG_USER_MEM_SUPPORTED defined, and use
  569. png_create_read_struct_2() instead of png_create_read_struct():
  570. png_structp png_ptr = png_create_read_struct_2
  571. (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
  572. user_error_fn, user_warning_fn, (png_voidp)
  573. user_mem_ptr, user_malloc_fn, user_free_fn);
  574. The error handling routines passed to png_create_read_struct()
  575. and the memory alloc/free routines passed to png_create_struct_2()
  576. are only necessary if you are not using the libpng supplied error
  577. handling and memory alloc/free functions.
  578. When libpng encounters an error, it expects to longjmp back
  579. to your routine. Therefore, you will need to call setjmp and pass
  580. your png_jmpbuf(png_ptr). If you read the file from different
  581. routines, you will need to update the longjmp buffer every time you enter
  582. a new routine that will call a png_*() function.
  583. See your documentation of setjmp/longjmp for your compiler for more
  584. information on setjmp/longjmp. See the discussion on libpng error
  585. handling in the Customizing Libpng section below for more information
  586. on the libpng error handling. If an error occurs, and libpng longjmp's
  587. back to your setjmp, you will want to call png_destroy_read_struct() to
  588. free any memory.
  589. if (setjmp(png_jmpbuf(png_ptr)))
  590. {
  591. png_destroy_read_struct(&png_ptr, &info_ptr,
  592. &end_info);
  593. fclose(fp);
  594. return ERROR;
  595. }
  596. Pass (png_infopp)NULL instead of &end_info if you didn't create
  597. an end_info structure.
  598. If you would rather avoid the complexity of setjmp/longjmp issues,
  599. you can compile libpng with PNG_NO_SETJMP, in which case
  600. errors will result in a call to PNG_ABORT() which defaults to abort().
  601. You can #define PNG_ABORT() to a function that does something
  602. more useful than abort(), as long as your function does not
  603. return.
  604. Now you need to set up the input code. The default for libpng is to
  605. use the C function fread(). If you use this, you will need to pass a
  606. valid FILE * in the function png_init_io(). Be sure that the file is
  607. opened in binary mode. If you wish to handle reading data in another
  608. way, you need not call the png_init_io() function, but you must then
  609. implement the libpng I/O methods discussed in the Customizing Libpng
  610. section below.
  611. png_init_io(png_ptr, fp);
  612. If you had previously opened the file and read any of the signature from
  613. the beginning in order to see if this was a PNG file, you need to let
  614. libpng know that there are some bytes missing from the start of the file.
  615. png_set_sig_bytes(png_ptr, number);
  616. You can change the zlib compression buffer size to be used while
  617. reading compressed data with
  618. png_set_compression_buffer_size(png_ptr, buffer_size);
  619. where the default size is 8192 bytes. Note that the buffer size
  620. is changed immediately and the buffer is reallocated immediately,
  621. instead of setting a flag to be acted upon later.
  622. If you want CRC errors to be handled in a different manner than
  623. the default, use
  624. png_set_crc_action(png_ptr, crit_action, ancil_action);
  625. The values for png_set_crc_action() say how libpng is to handle CRC errors in
  626. ancillary and critical chunks, and whether to use the data contained
  627. therein. Starting with libpng-1.6.26, this also governs how an ADLER32 error
  628. is handled while reading the IDAT chunk. Note that it is impossible to
  629. "discard" data in a critical chunk.
  630. Choices for (int) crit_action are
  631. PNG_CRC_DEFAULT 0 error/quit
  632. PNG_CRC_ERROR_QUIT 1 error/quit
  633. PNG_CRC_WARN_USE 3 warn/use data
  634. PNG_CRC_QUIET_USE 4 quiet/use data
  635. PNG_CRC_NO_CHANGE 5 use the current value
  636. Choices for (int) ancil_action are
  637. PNG_CRC_DEFAULT 0 error/quit
  638. PNG_CRC_ERROR_QUIT 1 error/quit
  639. PNG_CRC_WARN_DISCARD 2 warn/discard data
  640. PNG_CRC_WARN_USE 3 warn/use data
  641. PNG_CRC_QUIET_USE 4 quiet/use data
  642. PNG_CRC_NO_CHANGE 5 use the current value
  643. When the setting for crit_action is PNG_CRC_QUIET_USE, the CRC and ADLER32
  644. checksums are not only ignored, but they are not evaluated.
  645. .SS Setting up callback code
  646. You can set up a callback function to handle any unknown chunks in the
  647. input stream. You must supply the function
  648. read_chunk_callback(png_structp png_ptr,
  649. png_unknown_chunkp chunk);
  650. {
  651. /* The unknown chunk structure contains your
  652. chunk data, along with similar data for any other
  653. unknown chunks: */
  654. png_byte name[5];
  655. png_byte *data;
  656. size_t size;
  657. /* Note that libpng has already taken care of
  658. the CRC handling */
  659. /* put your code here. Search for your chunk in the
  660. unknown chunk structure, process it, and return one
  661. of the following: */
  662. return \-n; /* chunk had an error */
  663. return 0; /* did not recognize */
  664. return n; /* success */
  665. }
  666. (You can give your function another name that you like instead of
  667. "read_chunk_callback")
  668. To inform libpng about your function, use
  669. png_set_read_user_chunk_fn(png_ptr, user_chunk_ptr,
  670. read_chunk_callback);
  671. This names not only the callback function, but also a user pointer that
  672. you can retrieve with
  673. png_get_user_chunk_ptr(png_ptr);
  674. If you call the png_set_read_user_chunk_fn() function, then all unknown
  675. chunks which the callback does not handle will be saved when read. You can
  676. cause them to be discarded by returning '1' ("handled") instead of '0'. This
  677. behavior will change in libpng 1.7 and the default handling set by the
  678. png_set_keep_unknown_chunks() function, described below, will be used when the
  679. callback returns 0. If you want the existing behavior you should set the global
  680. default to PNG_HANDLE_CHUNK_IF_SAFE now; this is compatible with all current
  681. versions of libpng and with 1.7. Libpng 1.6 issues a warning if you keep the
  682. default, or PNG_HANDLE_CHUNK_NEVER, and the callback returns 0.
  683. At this point, you can set up a callback function that will be
  684. called after each row has been read, which you can use to control
  685. a progress meter or the like. It's demonstrated in pngtest.c.
  686. You must supply a function
  687. void read_row_callback(png_structp png_ptr,
  688. png_uint_32 row, int pass);
  689. {
  690. /* put your code here */
  691. }
  692. (You can give it another name that you like instead of "read_row_callback")
  693. To inform libpng about your function, use
  694. png_set_read_status_fn(png_ptr, read_row_callback);
  695. When this function is called the row has already been completely processed and
  696. the 'row' and 'pass' refer to the next row to be handled. For the
  697. non-interlaced case the row that was just handled is simply one less than the
  698. passed in row number, and pass will always be 0. For the interlaced case the
  699. same applies unless the row value is 0, in which case the row just handled was
  700. the last one from one of the preceding passes. Because interlacing may skip a
  701. pass you cannot be sure that the preceding pass is just 'pass\-1'; if you really
  702. need to know what the last pass is record (row,pass) from the callback and use
  703. the last recorded value each time.
  704. As with the user transform you can find the output row using the
  705. PNG_ROW_FROM_PASS_ROW macro.
  706. .SS Unknown-chunk handling
  707. Now you get to set the way the library processes unknown chunks in the
  708. input PNG stream. Both known and unknown chunks will be read. Normal
  709. behavior is that known chunks will be parsed into information in
  710. various info_ptr members while unknown chunks will be discarded. This
  711. behavior can be wasteful if your application will never use some known
  712. chunk types. To change this, you can call:
  713. png_set_keep_unknown_chunks(png_ptr, keep,
  714. chunk_list, num_chunks);
  715. keep - 0: default unknown chunk handling
  716. 1: ignore; do not keep
  717. 2: keep only if safe-to-copy
  718. 3: keep even if unsafe-to-copy
  719. You can use these definitions:
  720. PNG_HANDLE_CHUNK_AS_DEFAULT 0
  721. PNG_HANDLE_CHUNK_NEVER 1
  722. PNG_HANDLE_CHUNK_IF_SAFE 2
  723. PNG_HANDLE_CHUNK_ALWAYS 3
  724. chunk_list - list of chunks affected (a byte string,
  725. five bytes per chunk, NULL or '\0' if
  726. num_chunks is positive; ignored if
  727. numchunks <= 0).
  728. num_chunks - number of chunks affected; if 0, all
  729. unknown chunks are affected. If positive,
  730. only the chunks in the list are affected,
  731. and if negative all unknown chunks and
  732. all known chunks except for the IHDR,
  733. PLTE, tRNS, IDAT, and IEND chunks are
  734. affected.
  735. Unknown chunks declared in this way will be saved as raw data onto a
  736. list of png_unknown_chunk structures. If a chunk that is normally
  737. known to libpng is named in the list, it will be handled as unknown,
  738. according to the "keep" directive. If a chunk is named in successive
  739. instances of png_set_keep_unknown_chunks(), the final instance will
  740. take precedence. The IHDR and IEND chunks should not be named in
  741. chunk_list; if they are, libpng will process them normally anyway.
  742. If you know that your application will never make use of some particular
  743. chunks, use PNG_HANDLE_CHUNK_NEVER (or 1) as demonstrated below.
  744. Here is an example of the usage of png_set_keep_unknown_chunks(),
  745. where the private "vpAg" chunk will later be processed by a user chunk
  746. callback function:
  747. png_byte vpAg[5]={118, 112, 65, 103, (png_byte) '\0'};
  748. #if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED)
  749. png_byte unused_chunks[]=
  750. {
  751. 104, 73, 83, 84, (png_byte) '\0', /* hIST */
  752. 105, 84, 88, 116, (png_byte) '\0', /* iTXt */
  753. 112, 67, 65, 76, (png_byte) '\0', /* pCAL */
  754. 115, 67, 65, 76, (png_byte) '\0', /* sCAL */
  755. 115, 80, 76, 84, (png_byte) '\0', /* sPLT */
  756. 116, 73, 77, 69, (png_byte) '\0', /* tIME */
  757. };
  758. #endif
  759. ...
  760. #if defined(PNG_UNKNOWN_CHUNKS_SUPPORTED)
  761. /* ignore all unknown chunks
  762. * (use global setting "2" for libpng16 and earlier):
  763. */
  764. png_set_keep_unknown_chunks(read_ptr, 2, NULL, 0);
  765. /* except for vpAg: */
  766. png_set_keep_unknown_chunks(read_ptr, 2, vpAg, 1);
  767. /* also ignore unused known chunks: */
  768. png_set_keep_unknown_chunks(read_ptr, 1, unused_chunks,
  769. (int)(sizeof unused_chunks)/5);
  770. #endif
  771. .SS User limits
  772. The PNG specification allows the width and height of an image to be as
  773. large as 2^(31\-1 (0x7fffffff), or about 2.147 billion rows and columns.
  774. For safety, libpng imposes a default limit of 1 million rows and columns.
  775. Larger images will be rejected immediately with a png_error() call. If
  776. you wish to change these limits, you can use
  777. png_set_user_limits(png_ptr, width_max, height_max);
  778. to set your own limits (libpng may reject some very wide images
  779. anyway because of potential buffer overflow conditions).
  780. You should put this statement after you create the PNG structure and
  781. before calling png_read_info(), png_read_png(), or png_process_data().
  782. When writing a PNG datastream, put this statement before calling
  783. png_write_info() or png_write_png().
  784. If you need to retrieve the limits that are being applied, use
  785. width_max = png_get_user_width_max(png_ptr);
  786. height_max = png_get_user_height_max(png_ptr);
  787. The PNG specification sets no limit on the number of ancillary chunks
  788. allowed in a PNG datastream. By default, libpng imposes a limit of
  789. a total of 1000 sPLT, tEXt, iTXt, zTXt, and unknown chunks to be stored.
  790. If you have set up both info_ptr and end_info_ptr, the limit applies
  791. separately to each. You can change the limit on the total number of such
  792. chunks that will be stored, with
  793. png_set_chunk_cache_max(png_ptr, user_chunk_cache_max);
  794. where 0x7fffffffL means unlimited. You can retrieve this limit with
  795. chunk_cache_max = png_get_chunk_cache_max(png_ptr);
  796. Libpng imposes a limit of 8 Megabytes (8,000,000 bytes) on the amount of
  797. memory that any chunk other than IDAT can occupy, originally or when
  798. decompressed (prior to libpng-1.6.32 the limit was only applied to compressed
  799. chunks after decompression). You can change this limit with
  800. png_set_chunk_malloc_max(png_ptr, user_chunk_malloc_max);
  801. and you can retrieve the limit with
  802. chunk_malloc_max = png_get_chunk_malloc_max(png_ptr);
  803. Any chunks that would cause either of these limits to be exceeded will
  804. be ignored.
  805. .SS Information about your system
  806. If you intend to display the PNG or to incorporate it in other image data you
  807. need to tell libpng information about your display or drawing surface so that
  808. libpng can convert the values in the image to match the display.
  809. From libpng-1.5.4 this information can be set before reading the PNG file
  810. header. In earlier versions png_set_gamma() existed but behaved incorrectly if
  811. called before the PNG file header had been read and png_set_alpha_mode() did not
  812. exist.
  813. If you need to support versions prior to libpng-1.5.4 test the version number
  814. as illustrated below using "PNG_LIBPNG_VER >= 10504" and follow the procedures
  815. described in the appropriate manual page.
  816. You give libpng the encoding expected by your system expressed as a 'gamma'
  817. value. You can also specify a default encoding for the PNG file in
  818. case the required information is missing from the file. By default libpng
  819. assumes that the PNG data matches your system, to keep this default call:
  820. png_set_gamma(png_ptr, screen_gamma, output_gamma);
  821. or you can use the fixed point equivalent:
  822. png_set_gamma_fixed(png_ptr, PNG_FP_1*screen_gamma,
  823. PNG_FP_1*output_gamma);
  824. If you don't know the gamma for your system it is probably 2.2 - a good
  825. approximation to the IEC standard for display systems (sRGB). If images are
  826. too contrasty or washed out you got the value wrong - check your system
  827. documentation!
  828. Many systems permit the system gamma to be changed via a lookup table in the
  829. display driver, a few systems, including older Macs, change the response by
  830. default. As of 1.5.4 three special values are available to handle common
  831. situations:
  832. PNG_DEFAULT_sRGB: Indicates that the system conforms to the
  833. IEC 61966-2-1 standard. This matches almost
  834. all systems.
  835. PNG_GAMMA_MAC_18: Indicates that the system is an older
  836. (pre Mac OS 10.6) Apple Macintosh system with
  837. the default settings.
  838. PNG_GAMMA_LINEAR: Just the fixed point value for 1.0 - indicates
  839. that the system expects data with no gamma
  840. encoding.
  841. You would use the linear (unencoded) value if you need to process the pixel
  842. values further because this avoids the need to decode and re-encode each
  843. component value whenever arithmetic is performed. A lot of graphics software
  844. uses linear values for this reason, often with higher precision component values
  845. to preserve overall accuracy.
  846. The output_gamma value expresses how to decode the output values, not how
  847. they are encoded. The values used correspond to the normal numbers used to
  848. describe the overall gamma of a computer display system; for example 2.2 for
  849. an sRGB conformant system. The values are scaled by 100000 in the _fixed
  850. version of the API (so 220000 for sRGB.)
  851. The inverse of the value is always used to provide a default for the PNG file
  852. encoding if it has no gAMA chunk and if png_set_gamma() has not been called
  853. to override the PNG gamma information.
  854. When the ALPHA_OPTIMIZED mode is selected the output gamma is used to encode
  855. opaque pixels however pixels with lower alpha values are not encoded,
  856. regardless of the output gamma setting.
  857. When the standard Porter Duff handling is requested with mode 1 the output
  858. encoding is set to be linear and the output_gamma value is only relevant
  859. as a default for input data that has no gamma information. The linear output
  860. encoding will be overridden if png_set_gamma() is called - the results may be
  861. highly unexpected!
  862. The following numbers are derived from the sRGB standard and the research
  863. behind it. sRGB is defined to be approximated by a PNG gAMA chunk value of
  864. 0.45455 (1/2.2) for PNG. The value implicitly includes any viewing
  865. correction required to take account of any differences in the color
  866. environment of the original scene and the intended display environment; the
  867. value expresses how to *decode* the image for display, not how the original
  868. data was *encoded*.
  869. sRGB provides a peg for the PNG standard by defining a viewing environment.
  870. sRGB itself, and earlier TV standards, actually use a more complex transform
  871. (a linear portion then a gamma 2.4 power law) than PNG can express. (PNG is
  872. limited to simple power laws.) By saying that an image for direct display on
  873. an sRGB conformant system should be stored with a gAMA chunk value of 45455
  874. (11.3.3.2 and 11.3.3.5 of the ISO PNG specification) the PNG specification
  875. makes it possible to derive values for other display systems and
  876. environments.
  877. The Mac value is deduced from the sRGB based on an assumption that the actual
  878. extra viewing correction used in early Mac display systems was implemented as
  879. a power 1.45 lookup table.
  880. Any system where a programmable lookup table is used or where the behavior of
  881. the final display device characteristics can be changed requires system
  882. specific code to obtain the current characteristic. However this can be
  883. difficult and most PNG gamma correction only requires an approximate value.
  884. By default, if png_set_alpha_mode() is not called, libpng assumes that all
  885. values are unencoded, linear, values and that the output device also has a
  886. linear characteristic. This is only very rarely correct - it is invariably
  887. better to call png_set_alpha_mode() with PNG_DEFAULT_sRGB than rely on the
  888. default if you don't know what the right answer is!
  889. The special value PNG_GAMMA_MAC_18 indicates an older Mac system (pre Mac OS
  890. 10.6) which used a correction table to implement a somewhat lower gamma on an
  891. otherwise sRGB system.
  892. Both these values are reserved (not simple gamma values) in order to allow
  893. more precise correction internally in the future.
  894. NOTE: the values can be passed to either the fixed or floating
  895. point APIs, but the floating point API will also accept floating point
  896. values.
  897. The second thing you may need to tell libpng about is how your system handles
  898. alpha channel information. Some, but not all, PNG files contain an alpha
  899. channel. To display these files correctly you need to compose the data onto a
  900. suitable background, as described in the PNG specification.
  901. Libpng only supports composing onto a single color (using png_set_background;
  902. see below). Otherwise you must do the composition yourself and, in this case,
  903. you may need to call png_set_alpha_mode:
  904. #if PNG_LIBPNG_VER >= 10504
  905. png_set_alpha_mode(png_ptr, mode, screen_gamma);
  906. #else
  907. png_set_gamma(png_ptr, screen_gamma, 1.0/screen_gamma);
  908. #endif
  909. The screen_gamma value is the same as the argument to png_set_gamma; however,
  910. how it affects the output depends on the mode. png_set_alpha_mode() sets the
  911. file gamma default to 1/screen_gamma, so normally you don't need to call
  912. png_set_gamma. If you need different defaults call png_set_gamma() before
  913. png_set_alpha_mode() - if you call it after it will override the settings made
  914. by png_set_alpha_mode().
  915. The mode is as follows:
  916. PNG_ALPHA_PNG: The data is encoded according to the PNG
  917. specification. Red, green and blue, or gray, components are
  918. gamma encoded color values and are not premultiplied by the
  919. alpha value. The alpha value is a linear measure of the
  920. contribution of the pixel to the corresponding final output pixel.
  921. You should normally use this format if you intend to perform
  922. color correction on the color values; most, maybe all, color
  923. correction software has no handling for the alpha channel and,
  924. anyway, the math to handle pre-multiplied component values is
  925. unnecessarily complex.
  926. Before you do any arithmetic on the component values you need
  927. to remove the gamma encoding and multiply out the alpha
  928. channel. See the PNG specification for more detail. It is
  929. important to note that when an image with an alpha channel is
  930. scaled, linear encoded, pre-multiplied component values must
  931. be used!
  932. The remaining modes assume you don't need to do any further color correction or
  933. that if you do, your color correction software knows all about alpha (it
  934. probably doesn't!). They 'associate' the alpha with the color information by
  935. storing color channel values that have been scaled by the alpha. The
  936. advantage is that the color channels can be resampled (the image can be
  937. scaled) in this form. The disadvantage is that normal practice is to store
  938. linear, not (gamma) encoded, values and this requires 16-bit channels for
  939. still images rather than the 8-bit channels that are just about sufficient if
  940. gamma encoding is used. In addition all non-transparent pixel values,
  941. including completely opaque ones, must be gamma encoded to produce the final
  942. image. These are the 'STANDARD', 'ASSOCIATED' or 'PREMULTIPLIED' modes
  943. described below (the latter being the two common names for associated alpha
  944. color channels). Note that PNG files always contain non-associated color
  945. channels; png_set_alpha_mode() with one of the modes causes the decoder to
  946. convert the pixels to an associated form before returning them to your
  947. application.
  948. Since it is not necessary to perform arithmetic on opaque color values so
  949. long as they are not to be resampled and are in the final color space it is
  950. possible to optimize the handling of alpha by storing the opaque pixels in
  951. the PNG format (adjusted for the output color space) while storing partially
  952. opaque pixels in the standard, linear, format. The accuracy required for
  953. standard alpha composition is relatively low, because the pixels are
  954. isolated, therefore typically the accuracy loss in storing 8-bit linear
  955. values is acceptable. (This is not true if the alpha channel is used to
  956. simulate transparency over large areas - use 16 bits or the PNG mode in
  957. this case!) This is the 'OPTIMIZED' mode. For this mode a pixel is
  958. treated as opaque only if the alpha value is equal to the maximum value.
  959. PNG_ALPHA_STANDARD: The data libpng produces is encoded in the
  960. standard way assumed by most correctly written graphics software.
  961. The gamma encoding will be removed by libpng and the
  962. linear component values will be pre-multiplied by the
  963. alpha channel.
  964. With this format the final image must be re-encoded to
  965. match the display gamma before the image is displayed.
  966. If your system doesn't do that, yet still seems to
  967. perform arithmetic on the pixels without decoding them,
  968. it is broken - check out the modes below.
  969. With PNG_ALPHA_STANDARD libpng always produces linear
  970. component values, whatever screen_gamma you supply. The
  971. screen_gamma value is, however, used as a default for
  972. the file gamma if the PNG file has no gamma information.
  973. If you call png_set_gamma() after png_set_alpha_mode() you
  974. will override the linear encoding. Instead the
  975. pre-multiplied pixel values will be gamma encoded but
  976. the alpha channel will still be linear. This may
  977. actually match the requirements of some broken software,
  978. but it is unlikely.
  979. While linear 8-bit data is often used it has
  980. insufficient precision for any image with a reasonable
  981. dynamic range. To avoid problems, and if your software
  982. supports it, use png_set_expand_16() to force all
  983. components to 16 bits.
  984. PNG_ALPHA_OPTIMIZED: This mode is the same as PNG_ALPHA_STANDARD
  985. except that completely opaque pixels are gamma encoded according to
  986. the screen_gamma value. Pixels with alpha less than 1.0
  987. will still have linear components.
  988. Use this format if you have control over your
  989. compositing software and so don't do other arithmetic
  990. (such as scaling) on the data you get from libpng. Your
  991. compositing software can simply copy opaque pixels to
  992. the output but still has linear values for the
  993. non-opaque pixels.
  994. In normal compositing, where the alpha channel encodes
  995. partial pixel coverage (as opposed to broad area
  996. translucency), the inaccuracies of the 8-bit
  997. representation of non-opaque pixels are irrelevant.
  998. You can also try this format if your software is broken;
  999. it might look better.
  1000. PNG_ALPHA_BROKEN: This is PNG_ALPHA_STANDARD; however, all component
  1001. values, including the alpha channel are gamma encoded. This is
  1002. broken because, in practice, no implementation that uses this choice
  1003. correctly undoes the encoding before handling alpha composition. Use this
  1004. choice only if other serious errors in the software or hardware you use
  1005. mandate it. In most cases of broken software or hardware the bug in the
  1006. final display manifests as a subtle halo around composited parts of the
  1007. image. You may not even perceive this as a halo; the composited part of
  1008. the image may simply appear separate from the background, as though it had
  1009. been cut out of paper and pasted on afterward.
  1010. If you don't have to deal with bugs in software or hardware, or if you can fix
  1011. them, there are three recommended ways of using png_set_alpha_mode():
  1012. png_set_alpha_mode(png_ptr, PNG_ALPHA_PNG,
  1013. screen_gamma);
  1014. You can do color correction on the result (libpng does not currently
  1015. support color correction internally). When you handle the alpha channel
  1016. you need to undo the gamma encoding and multiply out the alpha.
  1017. png_set_alpha_mode(png_ptr, PNG_ALPHA_STANDARD,
  1018. screen_gamma);
  1019. png_set_expand_16(png_ptr);
  1020. If you are using the high level interface, don't call png_set_expand_16();
  1021. instead pass PNG_TRANSFORM_EXPAND_16 to the interface.
  1022. With this mode you can't do color correction, but you can do arithmetic,
  1023. including composition and scaling, on the data without further processing.
  1024. png_set_alpha_mode(png_ptr, PNG_ALPHA_OPTIMIZED,
  1025. screen_gamma);
  1026. You can avoid the expansion to 16-bit components with this mode, but you
  1027. lose the ability to scale the image or perform other linear arithmetic.
  1028. All you can do is compose the result onto a matching output. Since this
  1029. mode is libpng-specific you also need to write your own composition
  1030. software.
  1031. The following are examples of calls to png_set_alpha_mode to achieve the
  1032. required overall gamma correction and, where necessary, alpha
  1033. premultiplication.
  1034. png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
  1035. Choices for the alpha_mode are
  1036. PNG_ALPHA_PNG 0 /* according to the PNG standard */
  1037. PNG_ALPHA_STANDARD 1 /* according to Porter/Duff */
  1038. PNG_ALPHA_ASSOCIATED 1 /* as above; this is the normal practice */
  1039. PNG_ALPHA_PREMULTIPLIED 1 /* as above */
  1040. PNG_ALPHA_OPTIMIZED 2 /* 'PNG' for opaque pixels, else 'STANDARD' */
  1041. PNG_ALPHA_BROKEN 3 /* the alpha channel is gamma encoded */
  1042. PNG_ALPHA_PNG is the default libpng handling of the alpha channel. It is not
  1043. pre-multiplied into the color components. In addition the call states
  1044. that the output is for a sRGB system and causes all PNG files without gAMA
  1045. chunks to be assumed to be encoded using sRGB.
  1046. png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
  1047. In this case the output is assumed to be something like an sRGB conformant
  1048. display preceded by a power-law lookup table of power 1.45. This is how
  1049. early Mac systems behaved.
  1050. png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_GAMMA_LINEAR);
  1051. This is the classic Jim Blinn approach and will work in academic
  1052. environments where everything is done by the book. It has the shortcoming
  1053. of assuming that input PNG data with no gamma information is linear - this
  1054. is unlikely to be correct unless the PNG files were generated locally.
  1055. Most of the time the output precision will be so low as to show
  1056. significant banding in dark areas of the image.
  1057. png_set_expand_16(pp);
  1058. png_set_alpha_mode(pp, PNG_ALPHA_STANDARD, PNG_DEFAULT_sRGB);
  1059. This is a somewhat more realistic Jim Blinn inspired approach. PNG files
  1060. are assumed to have the sRGB encoding if not marked with a gamma value and
  1061. the output is always 16 bits per component. This permits accurate scaling
  1062. and processing of the data. If you know that your input PNG files were
  1063. generated locally you might need to replace PNG_DEFAULT_sRGB with the
  1064. correct value for your system.
  1065. png_set_alpha_mode(pp, PNG_ALPHA_OPTIMIZED, PNG_DEFAULT_sRGB);
  1066. If you just need to composite the PNG image onto an existing background
  1067. and if you control the code that does this you can use the optimization
  1068. setting. In this case you just copy completely opaque pixels to the
  1069. output. For pixels that are not completely transparent (you just skip
  1070. those) you do the composition math using png_composite or png_composite_16
  1071. below then encode the resultant 8-bit or 16-bit values to match the output
  1072. encoding.
  1073. Other cases
  1074. If neither the PNG nor the standard linear encoding work for you because
  1075. of the software or hardware you use then you have a big problem. The PNG
  1076. case will probably result in halos around the image. The linear encoding
  1077. will probably result in a washed out, too bright, image (it's actually too
  1078. contrasty.) Try the ALPHA_OPTIMIZED mode above - this will probably
  1079. substantially reduce the halos. Alternatively try:
  1080. png_set_alpha_mode(pp, PNG_ALPHA_BROKEN, PNG_DEFAULT_sRGB);
  1081. This option will also reduce the halos, but there will be slight dark
  1082. halos round the opaque parts of the image where the background is light.
  1083. In the OPTIMIZED mode the halos will be light halos where the background
  1084. is dark. Take your pick - the halos are unavoidable unless you can get
  1085. your hardware/software fixed! (The OPTIMIZED approach is slightly
  1086. faster.)
  1087. When the default gamma of PNG files doesn't match the output gamma.
  1088. If you have PNG files with no gamma information png_set_alpha_mode allows
  1089. you to provide a default gamma, but it also sets the output gamma to the
  1090. matching value. If you know your PNG files have a gamma that doesn't
  1091. match the output you can take advantage of the fact that
  1092. png_set_alpha_mode always sets the output gamma but only sets the PNG
  1093. default if it is not already set:
  1094. png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_DEFAULT_sRGB);
  1095. png_set_alpha_mode(pp, PNG_ALPHA_PNG, PNG_GAMMA_MAC);
  1096. The first call sets both the default and the output gamma values, the
  1097. second call overrides the output gamma without changing the default. This
  1098. is easier than achieving the same effect with png_set_gamma. You must use
  1099. PNG_ALPHA_PNG for the first call - internal checking in png_set_alpha will
  1100. fire if more than one call to png_set_alpha_mode and png_set_background is
  1101. made in the same read operation, however multiple calls with PNG_ALPHA_PNG
  1102. are ignored.
  1103. If you don't need, or can't handle, the alpha channel you can call
  1104. png_set_background() to remove it by compositing against a fixed color. Don't
  1105. call png_set_strip_alpha() to do this - it will leave spurious pixel values in
  1106. transparent parts of this image.
  1107. png_set_background(png_ptr, &background_color,
  1108. PNG_BACKGROUND_GAMMA_SCREEN, 0, 1);
  1109. The background_color is an RGB or grayscale value according to the data format
  1110. libpng will produce for you. Because you don't yet know the format of the PNG
  1111. file, if you call png_set_background at this point you must arrange for the
  1112. format produced by libpng to always have 8-bit or 16-bit components and then
  1113. store the color as an 8-bit or 16-bit color as appropriate. The color contains
  1114. separate gray and RGB component values, so you can let libpng produce gray or
  1115. RGB output according to the input format, but low bit depth grayscale images
  1116. must always be converted to at least 8-bit format. (Even though low bit depth
  1117. grayscale images can't have an alpha channel they can have a transparent
  1118. color!)
  1119. You set the transforms you need later, either as flags to the high level
  1120. interface or libpng API calls for the low level interface. For reference the
  1121. settings and API calls required are:
  1122. 8-bit values:
  1123. PNG_TRANSFORM_SCALE_16 | PNG_EXPAND
  1124. png_set_expand(png_ptr); png_set_scale_16(png_ptr);
  1125. If you must get exactly the same inaccurate results
  1126. produced by default in versions prior to libpng-1.5.4,
  1127. use PNG_TRANSFORM_STRIP_16 and png_set_strip_16(png_ptr)
  1128. instead.
  1129. 16-bit values:
  1130. PNG_TRANSFORM_EXPAND_16
  1131. png_set_expand_16(png_ptr);
  1132. In either case palette image data will be expanded to RGB. If you just want
  1133. color data you can add PNG_TRANSFORM_GRAY_TO_RGB or png_set_gray_to_rgb(png_ptr)
  1134. to the list.
  1135. Calling png_set_background before the PNG file header is read will not work
  1136. prior to libpng-1.5.4. Because the failure may result in unexpected warnings or
  1137. errors it is therefore much safer to call png_set_background after the head has
  1138. been read. Unfortunately this means that prior to libpng-1.5.4 it cannot be
  1139. used with the high level interface.
  1140. .SS The high-level read interface
  1141. At this point there are two ways to proceed; through the high-level
  1142. read interface, or through a sequence of low-level read operations.
  1143. You can use the high-level interface if (a) you are willing to read
  1144. the entire image into memory, and (b) the input transformations
  1145. you want to do are limited to the following set:
  1146. PNG_TRANSFORM_IDENTITY No transformation
  1147. PNG_TRANSFORM_SCALE_16 Strip 16-bit samples to
  1148. 8-bit accurately
  1149. PNG_TRANSFORM_STRIP_16 Chop 16-bit samples to
  1150. 8-bit less accurately
  1151. PNG_TRANSFORM_STRIP_ALPHA Discard the alpha channel
  1152. PNG_TRANSFORM_PACKING Expand 1, 2 and 4-bit
  1153. samples to bytes
  1154. PNG_TRANSFORM_PACKSWAP Change order of packed
  1155. pixels to LSB first
  1156. PNG_TRANSFORM_EXPAND Perform set_expand()
  1157. PNG_TRANSFORM_INVERT_MONO Invert monochrome images
  1158. PNG_TRANSFORM_SHIFT Normalize pixels to the
  1159. sBIT depth
  1160. PNG_TRANSFORM_BGR Flip RGB to BGR, RGBA
  1161. to BGRA
  1162. PNG_TRANSFORM_SWAP_ALPHA Flip RGBA to ARGB or GA
  1163. to AG
  1164. PNG_TRANSFORM_INVERT_ALPHA Change alpha from opacity
  1165. to transparency
  1166. PNG_TRANSFORM_SWAP_ENDIAN Byte-swap 16-bit samples
  1167. PNG_TRANSFORM_GRAY_TO_RGB Expand grayscale samples
  1168. to RGB (or GA to RGBA)
  1169. PNG_TRANSFORM_EXPAND_16 Expand samples to 16 bits
  1170. (This excludes setting a background color, doing gamma transformation,
  1171. quantizing, and setting filler.) If this is the case, simply do this:
  1172. png_read_png(png_ptr, info_ptr, png_transforms, NULL)
  1173. where png_transforms is an integer containing the bitwise OR of some
  1174. set of transformation flags. This call is equivalent to png_read_info(),
  1175. followed the set of transformations indicated by the transform mask,
  1176. then png_read_image(), and finally png_read_end().
  1177. (The final parameter of this call is not yet used. Someday it might point
  1178. to transformation parameters required by some future input transform.)
  1179. You must use png_transforms and not call any png_set_transform() functions
  1180. when you use png_read_png().
  1181. After you have called png_read_png(), you can retrieve the image data
  1182. with
  1183. row_pointers = png_get_rows(png_ptr, info_ptr);
  1184. where row_pointers is an array of pointers to the pixel data for each row:
  1185. png_bytep row_pointers[height];
  1186. If you know your image size and pixel size ahead of time, you can allocate
  1187. row_pointers prior to calling png_read_png() with
  1188. if (height > PNG_UINT_32_MAX/(sizeof (png_byte)))
  1189. png_error (png_ptr,
  1190. "Image is too tall to process in memory");
  1191. if (width > PNG_UINT_32_MAX/pixel_size)
  1192. png_error (png_ptr,
  1193. "Image is too wide to process in memory");
  1194. row_pointers = png_malloc(png_ptr,
  1195. height*(sizeof (png_bytep)));
  1196. for (int i=0; i<height, i++)
  1197. row_pointers[i]=NULL; /* security precaution */
  1198. for (int i=0; i<height, i++)
  1199. row_pointers[i]=png_malloc(png_ptr,
  1200. width*pixel_size);
  1201. png_set_rows(png_ptr, info_ptr, &row_pointers);
  1202. Alternatively you could allocate your image in one big block and define
  1203. row_pointers[i] to point into the proper places in your block, but first
  1204. be sure that your platform is able to allocate such a large buffer:
  1205. /* Guard against integer overflow */
  1206. if (height > PNG_SIZE_MAX/(width*pixel_size)) {
  1207. png_error(png_ptr,"image_data buffer would be too large");
  1208. }
  1209. png_bytep buffer=png_malloc(png_ptr,height*width*pixel_size);
  1210. for (int i=0; i<height, i++)
  1211. row_pointers[i]=buffer+i*width*pixel_size;
  1212. png_set_rows(png_ptr, info_ptr, &row_pointers);
  1213. If you use png_set_rows(), the application is responsible for freeing
  1214. row_pointers (and row_pointers[i], if they were separately allocated).
  1215. If you don't allocate row_pointers ahead of time, png_read_png() will
  1216. do it, and it'll be free'ed by libpng when you call png_destroy_*().
  1217. .SS The low-level read interface
  1218. If you are going the low-level route, you are now ready to read all
  1219. the file information up to the actual image data. You do this with a
  1220. call to png_read_info().
  1221. png_read_info(png_ptr, info_ptr);
  1222. This will process all chunks up to but not including the image data.
  1223. This also copies some of the data from the PNG file into the decode structure
  1224. for use in later transformations. Important information copied in is:
  1225. 1) The PNG file gamma from the gAMA chunk. This overwrites the default value
  1226. provided by an earlier call to png_set_gamma or png_set_alpha_mode.
  1227. 2) Prior to libpng-1.5.4 the background color from a bKGd chunk. This
  1228. damages the information provided by an earlier call to png_set_background
  1229. resulting in unexpected behavior. Libpng-1.5.4 no longer does this.
  1230. 3) The number of significant bits in each component value. Libpng uses this to
  1231. optimize gamma handling by reducing the internal lookup table sizes.
  1232. 4) The transparent color information from a tRNS chunk. This can be modified by
  1233. a later call to png_set_tRNS.
  1234. .SS Querying the info structure
  1235. Functions are used to get the information from the info_ptr once it
  1236. has been read. Note that these fields may not be completely filled
  1237. in until png_read_end() has read the chunk data following the image.
  1238. png_get_IHDR(png_ptr, info_ptr, &width, &height,
  1239. &bit_depth, &color_type, &interlace_type,
  1240. &compression_type, &filter_method);
  1241. width - holds the width of the image
  1242. in pixels (up to 2^31).
  1243. height - holds the height of the image
  1244. in pixels (up to 2^31).
  1245. bit_depth - holds the bit depth of one of the
  1246. image channels. (valid values are
  1247. 1, 2, 4, 8, 16 and depend also on
  1248. the color_type. See also
  1249. significant bits (sBIT) below).
  1250. color_type - describes which color/alpha channels
  1251. are present.
  1252. PNG_COLOR_TYPE_GRAY
  1253. (bit depths 1, 2, 4, 8, 16)
  1254. PNG_COLOR_TYPE_GRAY_ALPHA
  1255. (bit depths 8, 16)
  1256. PNG_COLOR_TYPE_PALETTE
  1257. (bit depths 1, 2, 4, 8)
  1258. PNG_COLOR_TYPE_RGB
  1259. (bit_depths 8, 16)
  1260. PNG_COLOR_TYPE_RGB_ALPHA
  1261. (bit_depths 8, 16)
  1262. PNG_COLOR_MASK_PALETTE
  1263. PNG_COLOR_MASK_COLOR
  1264. PNG_COLOR_MASK_ALPHA
  1265. interlace_type - (PNG_INTERLACE_NONE or
  1266. PNG_INTERLACE_ADAM7)
  1267. compression_type - (must be PNG_COMPRESSION_TYPE_BASE
  1268. for PNG 1.0)
  1269. filter_method - (must be PNG_FILTER_TYPE_BASE
  1270. for PNG 1.0, and can also be
  1271. PNG_INTRAPIXEL_DIFFERENCING if
  1272. the PNG datastream is embedded in
  1273. a MNG-1.0 datastream)
  1274. Any of width, height, color_type, bit_depth,
  1275. interlace_type, compression_type, or filter_method can
  1276. be NULL if you are not interested in their values.
  1277. Note that png_get_IHDR() returns 32-bit data into
  1278. the application's width and height variables.
  1279. This is an unsafe situation if these are not png_uint_32
  1280. variables. In such situations, the
  1281. png_get_image_width() and png_get_image_height()
  1282. functions described below are safer.
  1283. width = png_get_image_width(png_ptr,
  1284. info_ptr);
  1285. height = png_get_image_height(png_ptr,
  1286. info_ptr);
  1287. bit_depth = png_get_bit_depth(png_ptr,
  1288. info_ptr);
  1289. color_type = png_get_color_type(png_ptr,
  1290. info_ptr);
  1291. interlace_type = png_get_interlace_type(png_ptr,
  1292. info_ptr);
  1293. compression_type = png_get_compression_type(png_ptr,
  1294. info_ptr);
  1295. filter_method = png_get_filter_type(png_ptr,
  1296. info_ptr);
  1297. channels = png_get_channels(png_ptr, info_ptr);
  1298. channels - number of channels of info for the
  1299. color type (valid values are 1 (GRAY,
  1300. PALETTE), 2 (GRAY_ALPHA), 3 (RGB),
  1301. 4 (RGB_ALPHA or RGB + filler byte))
  1302. rowbytes = png_get_rowbytes(png_ptr, info_ptr);
  1303. rowbytes - number of bytes needed to hold a row
  1304. This value, the bit_depth, color_type,
  1305. and the number of channels can change
  1306. if you use transforms such as
  1307. png_set_expand(). See
  1308. png_read_update_info(), below.
  1309. signature = png_get_signature(png_ptr, info_ptr);
  1310. signature - holds the signature read from the
  1311. file (if any). The data is kept in
  1312. the same offset it would be if the
  1313. whole signature were read (i.e. if an
  1314. application had already read in 4
  1315. bytes of signature before starting
  1316. libpng, the remaining 4 bytes would
  1317. be in signature[4] through signature[7]
  1318. (see png_set_sig_bytes())).
  1319. These are also important, but their validity depends on whether the chunk
  1320. has been read. The png_get_valid(png_ptr, info_ptr, PNG_INFO_<chunk>) and
  1321. png_get_<chunk>(png_ptr, info_ptr, ...) functions return non-zero if the
  1322. data has been read, or zero if it is missing. The parameters to the
  1323. png_get_<chunk> are set directly if they are simple data types, or a
  1324. pointer into the info_ptr is returned for any complex types.
  1325. The colorspace data from gAMA, cHRM, sRGB, iCCP, and sBIT chunks
  1326. is simply returned to give the application information about how the
  1327. image was encoded. Libpng itself only does transformations using the file
  1328. gamma when combining semitransparent pixels with the background color, and,
  1329. since libpng-1.6.0, when converting between 8-bit sRGB and 16-bit linear pixels
  1330. within the simplified API. Libpng also uses the file gamma when converting
  1331. RGB to gray, beginning with libpng-1.0.5, if the application calls
  1332. png_set_rgb_to_gray()).
  1333. png_get_PLTE(png_ptr, info_ptr, &palette,
  1334. &num_palette);
  1335. palette - the palette for the file
  1336. (array of png_color)
  1337. num_palette - number of entries in the palette
  1338. png_get_gAMA(png_ptr, info_ptr, &file_gamma);
  1339. png_get_gAMA_fixed(png_ptr, info_ptr, &int_file_gamma);
  1340. file_gamma - the gamma at which the file is
  1341. written (PNG_INFO_gAMA)
  1342. int_file_gamma - 100,000 times the gamma at which the
  1343. file is written
  1344. png_get_cHRM(png_ptr, info_ptr, &white_x, &white_y, &red_x,
  1345. &red_y, &green_x, &green_y, &blue_x, &blue_y)
  1346. png_get_cHRM_XYZ(png_ptr, info_ptr, &red_X, &red_Y, &red_Z,
  1347. &green_X, &green_Y, &green_Z, &blue_X, &blue_Y,
  1348. &blue_Z)
  1349. png_get_cHRM_fixed(png_ptr, info_ptr, &int_white_x,
  1350. &int_white_y, &int_red_x, &int_red_y,
  1351. &int_green_x, &int_green_y, &int_blue_x,
  1352. &int_blue_y)
  1353. png_get_cHRM_XYZ_fixed(png_ptr, info_ptr, &int_red_X, &int_red_Y,
  1354. &int_red_Z, &int_green_X, &int_green_Y,
  1355. &int_green_Z, &int_blue_X, &int_blue_Y,
  1356. &int_blue_Z)
  1357. {white,red,green,blue}_{x,y}
  1358. A color space encoding specified using the
  1359. chromaticities of the end points and the
  1360. white point. (PNG_INFO_cHRM)
  1361. {red,green,blue}_{X,Y,Z}
  1362. A color space encoding specified using the
  1363. encoding end points - the CIE tristimulus
  1364. specification of the intended color of the red,
  1365. green and blue channels in the PNG RGB data.
  1366. The white point is simply the sum of the three
  1367. end points. (PNG_INFO_cHRM)
  1368. png_get_sRGB(png_ptr, info_ptr, &srgb_intent);
  1369. srgb_intent - the rendering intent (PNG_INFO_sRGB)
  1370. The presence of the sRGB chunk
  1371. means that the pixel data is in the
  1372. sRGB color space. This chunk also
  1373. implies specific values of gAMA and
  1374. cHRM.
  1375. png_get_iCCP(png_ptr, info_ptr, &name,
  1376. &compression_type, &profile, &proflen);
  1377. name - The profile name.
  1378. compression_type - The compression type; always
  1379. PNG_COMPRESSION_TYPE_BASE for PNG 1.0.
  1380. You may give NULL to this argument to
  1381. ignore it.
  1382. profile - International Color Consortium color
  1383. profile data. May contain NULs.
  1384. proflen - length of profile data in bytes.
  1385. png_get_sBIT(png_ptr, info_ptr, &sig_bit);
  1386. sig_bit - the number of significant bits for
  1387. (PNG_INFO_sBIT) each of the gray,
  1388. red, green, and blue channels,
  1389. whichever are appropriate for the
  1390. given color type (png_color_16)
  1391. png_get_tRNS(png_ptr, info_ptr, &trans_alpha,
  1392. &num_trans, &trans_color);
  1393. trans_alpha - array of alpha (transparency)
  1394. entries for palette (PNG_INFO_tRNS)
  1395. num_trans - number of transparent entries
  1396. (PNG_INFO_tRNS)
  1397. trans_color - graylevel or color sample values of
  1398. the single transparent color for
  1399. non-paletted images (PNG_INFO_tRNS)
  1400. png_get_eXIf_1(png_ptr, info_ptr, &num_exif, &exif);
  1401. (PNG_INFO_eXIf)
  1402. exif - Exif profile (array of png_byte)
  1403. png_get_hIST(png_ptr, info_ptr, &hist);
  1404. (PNG_INFO_hIST)
  1405. hist - histogram of palette (array of
  1406. png_uint_16)
  1407. png_get_tIME(png_ptr, info_ptr, &mod_time);
  1408. mod_time - time image was last modified
  1409. (PNG_VALID_tIME)
  1410. png_get_bKGD(png_ptr, info_ptr, &background);
  1411. background - background color (of type
  1412. png_color_16p) (PNG_VALID_bKGD)
  1413. valid 16-bit red, green and blue
  1414. values, regardless of color_type
  1415. num_comments = png_get_text(png_ptr, info_ptr,
  1416. &text_ptr, &num_text);
  1417. num_comments - number of comments
  1418. text_ptr - array of png_text holding image
  1419. comments
  1420. text_ptr[i].compression - type of compression used
  1421. on "text" PNG_TEXT_COMPRESSION_NONE
  1422. PNG_TEXT_COMPRESSION_zTXt
  1423. PNG_ITXT_COMPRESSION_NONE
  1424. PNG_ITXT_COMPRESSION_zTXt
  1425. text_ptr[i].key - keyword for comment. Must contain
  1426. 1-79 characters.
  1427. text_ptr[i].text - text comments for current
  1428. keyword. Can be empty.
  1429. text_ptr[i].text_length - length of text string,
  1430. after decompression, 0 for iTXt
  1431. text_ptr[i].itxt_length - length of itxt string,
  1432. after decompression, 0 for tEXt/zTXt
  1433. text_ptr[i].lang - language of comment (empty
  1434. string for unknown).
  1435. text_ptr[i].lang_key - keyword in UTF-8
  1436. (empty string for unknown).
  1437. Note that the itxt_length, lang, and lang_key
  1438. members of the text_ptr structure only exist when the
  1439. library is built with iTXt chunk support. Prior to
  1440. libpng-1.4.0 the library was built by default without
  1441. iTXt support. Also note that when iTXt is supported,
  1442. they contain NULL pointers when the "compression"
  1443. field contains PNG_TEXT_COMPRESSION_NONE or
  1444. PNG_TEXT_COMPRESSION_zTXt.
  1445. num_text - number of comments (same as
  1446. num_comments; you can put NULL here
  1447. to avoid the duplication)
  1448. Note while png_set_text() will accept text, language,
  1449. and translated keywords that can be NULL pointers, the
  1450. structure returned by png_get_text will always contain
  1451. regular zero-terminated C strings. They might be
  1452. empty strings but they will never be NULL pointers.
  1453. num_spalettes = png_get_sPLT(png_ptr, info_ptr,
  1454. &palette_ptr);
  1455. num_spalettes - number of sPLT chunks read.
  1456. palette_ptr - array of palette structures holding
  1457. contents of one or more sPLT chunks
  1458. read.
  1459. png_get_oFFs(png_ptr, info_ptr, &offset_x, &offset_y,
  1460. &unit_type);
  1461. offset_x - positive offset from the left edge
  1462. of the screen (can be negative)
  1463. offset_y - positive offset from the top edge
  1464. of the screen (can be negative)
  1465. unit_type - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER
  1466. png_get_pHYs(png_ptr, info_ptr, &res_x, &res_y,
  1467. &unit_type);
  1468. res_x - pixels/unit physical resolution in
  1469. x direction
  1470. res_y - pixels/unit physical resolution in
  1471. x direction
  1472. unit_type - PNG_RESOLUTION_UNKNOWN,
  1473. PNG_RESOLUTION_METER
  1474. png_get_sCAL(png_ptr, info_ptr, &unit, &width,
  1475. &height)
  1476. unit - physical scale units (an integer)
  1477. width - width of a pixel in physical scale units
  1478. height - height of a pixel in physical scale units
  1479. (width and height are doubles)
  1480. png_get_sCAL_s(png_ptr, info_ptr, &unit, &width,
  1481. &height)
  1482. unit - physical scale units (an integer)
  1483. width - width of a pixel in physical scale units
  1484. (expressed as a string)
  1485. height - height of a pixel in physical scale units
  1486. (width and height are strings like "2.54")
  1487. num_unknown_chunks = png_get_unknown_chunks(png_ptr,
  1488. info_ptr, &unknowns)
  1489. unknowns - array of png_unknown_chunk
  1490. structures holding unknown chunks
  1491. unknowns[i].name - name of unknown chunk
  1492. unknowns[i].data - data of unknown chunk
  1493. unknowns[i].size - size of unknown chunk's data
  1494. unknowns[i].location - position of chunk in file
  1495. The value of "i" corresponds to the order in which the
  1496. chunks were read from the PNG file or inserted with the
  1497. png_set_unknown_chunks() function.
  1498. The value of "location" is a bitwise "or" of
  1499. PNG_HAVE_IHDR (0x01)
  1500. PNG_HAVE_PLTE (0x02)
  1501. PNG_AFTER_IDAT (0x08)
  1502. The data from the pHYs chunk can be retrieved in several convenient
  1503. forms:
  1504. res_x = png_get_x_pixels_per_meter(png_ptr,
  1505. info_ptr)
  1506. res_y = png_get_y_pixels_per_meter(png_ptr,
  1507. info_ptr)
  1508. res_x_and_y = png_get_pixels_per_meter(png_ptr,
  1509. info_ptr)
  1510. res_x = png_get_x_pixels_per_inch(png_ptr,
  1511. info_ptr)
  1512. res_y = png_get_y_pixels_per_inch(png_ptr,
  1513. info_ptr)
  1514. res_x_and_y = png_get_pixels_per_inch(png_ptr,
  1515. info_ptr)
  1516. aspect_ratio = png_get_pixel_aspect_ratio(png_ptr,
  1517. info_ptr)
  1518. Each of these returns 0 [signifying "unknown"] if
  1519. the data is not present or if res_x is 0;
  1520. res_x_and_y is 0 if res_x != res_y
  1521. Note that because of the way the resolutions are
  1522. stored internally, the inch conversions won't
  1523. come out to exactly even number. For example,
  1524. 72 dpi is stored as 0.28346 pixels/meter, and
  1525. when this is retrieved it is 71.9988 dpi, so
  1526. be sure to round the returned value appropriately
  1527. if you want to display a reasonable-looking result.
  1528. The data from the oFFs chunk can be retrieved in several convenient
  1529. forms:
  1530. x_offset = png_get_x_offset_microns(png_ptr, info_ptr);
  1531. y_offset = png_get_y_offset_microns(png_ptr, info_ptr);
  1532. x_offset = png_get_x_offset_inches(png_ptr, info_ptr);
  1533. y_offset = png_get_y_offset_inches(png_ptr, info_ptr);
  1534. Each of these returns 0 [signifying "unknown" if both
  1535. x and y are 0] if the data is not present or if the
  1536. chunk is present but the unit is the pixel. The
  1537. remark about inexact inch conversions applies here
  1538. as well, because a value in inches can't always be
  1539. converted to microns and back without some loss
  1540. of precision.
  1541. For more information, see the
  1542. PNG specification for chunk contents. Be careful with trusting
  1543. rowbytes, as some of the transformations could increase the space
  1544. needed to hold a row (expand, filler, gray_to_rgb, etc.).
  1545. See png_read_update_info(), below.
  1546. A quick word about text_ptr and num_text. PNG stores comments in
  1547. keyword/text pairs, one pair per chunk, with no limit on the number
  1548. of text chunks, and a 2^31 byte limit on their size. While there are
  1549. suggested keywords, there is no requirement to restrict the use to these
  1550. strings. It is strongly suggested that keywords and text be sensible
  1551. to humans (that's the point), so don't use abbreviations. Non-printing
  1552. symbols are not allowed. See the PNG specification for more details.
  1553. There is also no requirement to have text after the keyword.
  1554. Keywords should be limited to 79 Latin-1 characters without leading or
  1555. trailing spaces, but non-consecutive spaces are allowed within the
  1556. keyword. It is possible to have the same keyword any number of times.
  1557. The text_ptr is an array of png_text structures, each holding a
  1558. pointer to a language string, a pointer to a keyword and a pointer to
  1559. a text string. The text string, language code, and translated
  1560. keyword may be empty or NULL pointers. The keyword/text
  1561. pairs are put into the array in the order that they are received.
  1562. However, some or all of the text chunks may be after the image, so, to
  1563. make sure you have read all the text chunks, don't mess with these
  1564. until after you read the stuff after the image. This will be
  1565. mentioned again below in the discussion that goes with png_read_end().
  1566. .SS Input transformations
  1567. After you've read the header information, you can set up the library
  1568. to handle any special transformations of the image data. The various
  1569. ways to transform the data will be described in the order that they
  1570. should occur. This is important, as some of these change the color
  1571. type and/or bit depth of the data, and some others only work on
  1572. certain color types and bit depths.
  1573. Transformations you request are ignored if they don't have any meaning for a
  1574. particular input data format. However some transformations can have an effect
  1575. as a result of a previous transformation. If you specify a contradictory set of
  1576. transformations, for example both adding and removing the alpha channel, you
  1577. cannot predict the final result.
  1578. The color used for the transparency values should be supplied in the same
  1579. format/depth as the current image data. It is stored in the same format/depth
  1580. as the image data in a tRNS chunk, so this is what libpng expects for this data.
  1581. The color used for the background value depends on the need_expand argument as
  1582. described below.
  1583. Data will be decoded into the supplied row buffers packed into bytes
  1584. unless the library has been told to transform it into another format.
  1585. For example, 4 bit/pixel paletted or grayscale data will be returned
  1586. 2 pixels/byte with the leftmost pixel in the high-order bits of the byte,
  1587. unless png_set_packing() is called. 8-bit RGB data will be stored
  1588. in RGB RGB RGB format unless png_set_filler() or png_set_add_alpha()
  1589. is called to insert filler bytes, either before or after each RGB triplet.
  1590. 16-bit RGB data will be returned RRGGBB RRGGBB, with the most significant
  1591. byte of the color value first, unless png_set_scale_16() is called to
  1592. transform it to regular RGB RGB triplets, or png_set_filler() or
  1593. png_set_add alpha() is called to insert two filler bytes, either before
  1594. or after each RRGGBB triplet. Similarly, 8-bit or 16-bit grayscale data can
  1595. be modified with png_set_filler(), png_set_add_alpha(), png_set_strip_16(),
  1596. or png_set_scale_16().
  1597. The following code transforms grayscale images of less than 8 to 8 bits,
  1598. changes paletted images to RGB, and adds a full alpha channel if there is
  1599. transparency information in a tRNS chunk. This is most useful on
  1600. grayscale images with bit depths of 2 or 4 or if there is a multiple-image
  1601. viewing application that wishes to treat all images in the same way.
  1602. if (color_type == PNG_COLOR_TYPE_PALETTE)
  1603. png_set_palette_to_rgb(png_ptr);
  1604. if (png_get_valid(png_ptr, info_ptr,
  1605. PNG_INFO_tRNS)) png_set_tRNS_to_alpha(png_ptr);
  1606. if (color_type == PNG_COLOR_TYPE_GRAY &&
  1607. bit_depth < 8) png_set_expand_gray_1_2_4_to_8(png_ptr);
  1608. The first two functions are actually aliases for png_set_expand(), added
  1609. in libpng version 1.0.4, with the function names expanded to improve code
  1610. readability. In some future version they may actually do different
  1611. things.
  1612. As of libpng version 1.2.9, png_set_expand_gray_1_2_4_to_8() was
  1613. added. It expands the sample depth without changing tRNS to alpha.
  1614. As of libpng version 1.5.2, png_set_expand_16() was added. It behaves as
  1615. png_set_expand(); however, the resultant channels have 16 bits rather than 8.
  1616. Use this when the output color or gray channels are made linear to avoid fairly
  1617. severe accuracy loss.
  1618. if (bit_depth < 16)
  1619. png_set_expand_16(png_ptr);
  1620. PNG can have files with 16 bits per channel. If you only can handle
  1621. 8 bits per channel, this will strip the pixels down to 8-bit.
  1622. if (bit_depth == 16)
  1623. #if PNG_LIBPNG_VER >= 10504
  1624. png_set_scale_16(png_ptr);
  1625. #else
  1626. png_set_strip_16(png_ptr);
  1627. #endif
  1628. (The more accurate "png_set_scale_16()" API became available in libpng version
  1629. 1.5.4).
  1630. If you need to process the alpha channel on the image separately from the image
  1631. data (for example if you convert it to a bitmap mask) it is possible to have
  1632. libpng strip the channel leaving just RGB or gray data:
  1633. if (color_type & PNG_COLOR_MASK_ALPHA)
  1634. png_set_strip_alpha(png_ptr);
  1635. If you strip the alpha channel you need to find some other way of dealing with
  1636. the information. If, instead, you want to convert the image to an opaque
  1637. version with no alpha channel use png_set_background; see below.
  1638. As of libpng version 1.5.2, almost all useful expansions are supported, the
  1639. major ommissions are conversion of grayscale to indexed images (which can be
  1640. done trivially in the application) and conversion of indexed to grayscale (which
  1641. can be done by a trivial manipulation of the palette.)
  1642. In the following table, the 01 means grayscale with depth<8, 31 means
  1643. indexed with depth<8, other numerals represent the color type, "T" means
  1644. the tRNS chunk is present, A means an alpha channel is present, and O
  1645. means tRNS or alpha is present but all pixels in the image are opaque.
  1646. FROM 01 31 0 0T 0O 2 2T 2O 3 3T 3O 4A 4O 6A 6O
  1647. TO
  1648. 01 - [G] - - - - - - - - - - - - -
  1649. 31 [Q] Q [Q] [Q] [Q] Q Q Q Q Q Q [Q] [Q] Q Q
  1650. 0 1 G + . . G G G G G G B B GB GB
  1651. 0T lt Gt t + . Gt G G Gt G G Bt Bt GBt GBt
  1652. 0O lt Gt t . + Gt Gt G Gt Gt G Bt Bt GBt GBt
  1653. 2 C P C C C + . . C - - CB CB B B
  1654. 2T Ct - Ct C C t + t - - - CBt CBt Bt Bt
  1655. 2O Ct - Ct C C t t + - - - CBt CBt Bt Bt
  1656. 3 [Q] p [Q] [Q] [Q] Q Q Q + . . [Q] [Q] Q Q
  1657. 3T [Qt] p [Qt][Q] [Q] Qt Qt Qt t + t [Qt][Qt] Qt Qt
  1658. 3O [Qt] p [Qt][Q] [Q] Qt Qt Qt t t + [Qt][Qt] Qt Qt
  1659. 4A lA G A T T GA GT GT GA GT GT + BA G GBA
  1660. 4O lA GBA A T T GA GT GT GA GT GT BA + GBA G
  1661. 6A CA PA CA C C A T tT PA P P C CBA + BA
  1662. 6O CA PBA CA C C A tT T PA P P CBA C BA +
  1663. Within the matrix,
  1664. "+" identifies entries where 'from' and 'to' are the same.
  1665. "-" means the transformation is not supported.
  1666. "." means nothing is necessary (a tRNS chunk can just be ignored).
  1667. "t" means the transformation is obtained by png_set_tRNS.
  1668. "A" means the transformation is obtained by png_set_add_alpha().
  1669. "X" means the transformation is obtained by png_set_expand().
  1670. "1" means the transformation is obtained by
  1671. png_set_expand_gray_1_2_4_to_8() (and by png_set_expand()
  1672. if there is no transparency in the original or the final
  1673. format).
  1674. "C" means the transformation is obtained by png_set_gray_to_rgb().
  1675. "G" means the transformation is obtained by png_set_rgb_to_gray().
  1676. "P" means the transformation is obtained by
  1677. png_set_expand_palette_to_rgb().
  1678. "p" means the transformation is obtained by png_set_packing().
  1679. "Q" means the transformation is obtained by png_set_quantize().
  1680. "T" means the transformation is obtained by
  1681. png_set_tRNS_to_alpha().
  1682. "B" means the transformation is obtained by
  1683. png_set_background(), or png_strip_alpha().
  1684. When an entry has multiple transforms listed all are required to cause the
  1685. right overall transformation. When two transforms are separated by a comma
  1686. either will do the job. When transforms are enclosed in [] the transform should
  1687. do the job but this is currently unimplemented - a different format will result
  1688. if the suggested transformations are used.
  1689. In PNG files, the alpha channel in an image
  1690. is the level of opacity. If you need the alpha channel in an image to
  1691. be the level of transparency instead of opacity, you can invert the
  1692. alpha channel (or the tRNS chunk data) after it's read, so that 0 is
  1693. fully opaque and 255 (in 8-bit or paletted images) or 65535 (in 16-bit
  1694. images) is fully transparent, with
  1695. png_set_invert_alpha(png_ptr);
  1696. PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as
  1697. they can, resulting in, for example, 8 pixels per byte for 1 bit
  1698. files. This code expands to 1 pixel per byte without changing the
  1699. values of the pixels:
  1700. if (bit_depth < 8)
  1701. png_set_packing(png_ptr);
  1702. PNG files have possible bit depths of 1, 2, 4, 8, and 16. All pixels
  1703. stored in a PNG image have been "scaled" or "shifted" up to the next
  1704. higher possible bit depth (e.g. from 5 bits/sample in the range [0,31]
  1705. to 8 bits/sample in the range [0, 255]). However, it is also possible
  1706. to convert the PNG pixel data back to the original bit depth of the
  1707. image. This call reduces the pixels back down to the original bit depth:
  1708. png_color_8p sig_bit;
  1709. if (png_get_sBIT(png_ptr, info_ptr, &sig_bit))
  1710. png_set_shift(png_ptr, sig_bit);
  1711. PNG files store 3-color pixels in red, green, blue order. This code
  1712. changes the storage of the pixels to blue, green, red:
  1713. if (color_type == PNG_COLOR_TYPE_RGB ||
  1714. color_type == PNG_COLOR_TYPE_RGB_ALPHA)
  1715. png_set_bgr(png_ptr);
  1716. PNG files store RGB pixels packed into 3 or 6 bytes. This code expands them
  1717. into 4 or 8 bytes for windowing systems that need them in this format:
  1718. if (color_type == PNG_COLOR_TYPE_RGB)
  1719. png_set_filler(png_ptr, filler, PNG_FILLER_BEFORE);
  1720. where "filler" is the 8-bit or 16-bit number to fill with, and the location
  1721. is either PNG_FILLER_BEFORE or PNG_FILLER_AFTER, depending upon whether
  1722. you want the filler before the RGB or after. When filling an 8-bit pixel,
  1723. the least significant 8 bits of the number are used, if a 16-bit number is
  1724. supplied. This transformation does not affect images that already have full
  1725. alpha channels. To add an opaque alpha channel, use filler=0xffff and
  1726. PNG_FILLER_AFTER which will generate RGBA pixels.
  1727. Note that png_set_filler() does not change the color type. If you want
  1728. to do that, you can add a true alpha channel with
  1729. if (color_type == PNG_COLOR_TYPE_RGB ||
  1730. color_type == PNG_COLOR_TYPE_GRAY)
  1731. png_set_add_alpha(png_ptr, filler, PNG_FILLER_AFTER);
  1732. where "filler" contains the alpha value to assign to each pixel.
  1733. The png_set_add_alpha() function was added in libpng-1.2.7.
  1734. If you are reading an image with an alpha channel, and you need the
  1735. data as ARGB instead of the normal PNG format RGBA:
  1736. if (color_type == PNG_COLOR_TYPE_RGB_ALPHA)
  1737. png_set_swap_alpha(png_ptr);
  1738. For some uses, you may want a grayscale image to be represented as
  1739. RGB. This code will do that conversion:
  1740. if (color_type == PNG_COLOR_TYPE_GRAY ||
  1741. color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
  1742. png_set_gray_to_rgb(png_ptr);
  1743. Conversely, you can convert an RGB or RGBA image to grayscale or grayscale
  1744. with alpha.
  1745. if (color_type == PNG_COLOR_TYPE_RGB ||
  1746. color_type == PNG_COLOR_TYPE_RGB_ALPHA)
  1747. png_set_rgb_to_gray(png_ptr, error_action,
  1748. double red_weight, double green_weight);
  1749. error_action = 1: silently do the conversion
  1750. error_action = 2: issue a warning if the original
  1751. image has any pixel where
  1752. red != green or red != blue
  1753. error_action = 3: issue an error and abort the
  1754. conversion if the original
  1755. image has any pixel where
  1756. red != green or red != blue
  1757. red_weight: weight of red component
  1758. green_weight: weight of green component
  1759. If either weight is negative, default
  1760. weights are used.
  1761. In the corresponding fixed point API the red_weight and green_weight values are
  1762. simply scaled by 100,000:
  1763. png_set_rgb_to_gray(png_ptr, error_action,
  1764. png_fixed_point red_weight,
  1765. png_fixed_point green_weight);
  1766. If you have set error_action = 1 or 2, you can
  1767. later check whether the image really was gray, after processing
  1768. the image rows, with the png_get_rgb_to_gray_status(png_ptr) function.
  1769. It will return a png_byte that is zero if the image was gray or
  1770. 1 if there were any non-gray pixels. Background and sBIT data
  1771. will be silently converted to grayscale, using the green channel
  1772. data for sBIT, regardless of the error_action setting.
  1773. The default values come from the PNG file cHRM chunk if present; otherwise, the
  1774. defaults correspond to the ITU-R recommendation 709, and also the sRGB color
  1775. space, as recommended in the Charles Poynton's Colour FAQ,
  1776. Copyright (c) 2006-11-28 Charles Poynton, in section 9:
  1777. <http://www.poynton.com/notes/colour_and_gamma/ColorFAQ.html#RTFToC9>
  1778. Y = 0.2126 * R + 0.7152 * G + 0.0722 * B
  1779. Previous versions of this document, 1998 through 2002, recommended a slightly
  1780. different formula:
  1781. Y = 0.212671 * R + 0.715160 * G + 0.072169 * B
  1782. Libpng uses an integer approximation:
  1783. Y = (6968 * R + 23434 * G + 2366 * B)/32768
  1784. The calculation is done in a linear colorspace, if the image gamma
  1785. can be determined.
  1786. The png_set_background() function has been described already; it tells libpng to
  1787. composite images with alpha or simple transparency against the supplied
  1788. background color. For compatibility with versions of libpng earlier than
  1789. libpng-1.5.4 it is recommended that you call the function after reading the file
  1790. header, even if you don't want to use the color in a bKGD chunk, if one exists.
  1791. If the PNG file contains a bKGD chunk (PNG_INFO_bKGD valid),
  1792. you may use this color, or supply another color more suitable for
  1793. the current display (e.g., the background color from a web page). You
  1794. need to tell libpng how the color is represented, both the format of the
  1795. component values in the color (the number of bits) and the gamma encoding of the
  1796. color. The function takes two arguments, background_gamma_mode and need_expand
  1797. to convey this information; however, only two combinations are likely to be
  1798. useful:
  1799. png_color_16 my_background;
  1800. png_color_16p image_background;
  1801. if (png_get_bKGD(png_ptr, info_ptr, &image_background))
  1802. png_set_background(png_ptr, image_background,
  1803. PNG_BACKGROUND_GAMMA_FILE, 1/*needs to be expanded*/, 1);
  1804. else
  1805. png_set_background(png_ptr, &my_background,
  1806. PNG_BACKGROUND_GAMMA_SCREEN, 0/*do not expand*/, 1);
  1807. The second call was described above - my_background is in the format of the
  1808. final, display, output produced by libpng. Because you now know the format of
  1809. the PNG it is possible to avoid the need to choose either 8-bit or 16-bit
  1810. output and to retain palette images (the palette colors will be modified
  1811. appropriately and the tRNS chunk removed.) However, if you are doing this,
  1812. take great care not to ask for transformations without checking first that
  1813. they apply!
  1814. In the first call the background color has the original bit depth and color type
  1815. of the PNG file. So, for palette images the color is supplied as a palette
  1816. index and for low bit greyscale images the color is a reduced bit value in
  1817. image_background->gray.
  1818. If you didn't call png_set_gamma() before reading the file header, for example
  1819. if you need your code to remain compatible with older versions of libpng prior
  1820. to libpng-1.5.4, this is the place to call it.
  1821. Do not call it if you called png_set_alpha_mode(); doing so will damage the
  1822. settings put in place by png_set_alpha_mode(). (If png_set_alpha_mode() is
  1823. supported then you can certainly do png_set_gamma() before reading the PNG
  1824. header.)
  1825. This API unconditionally sets the screen and file gamma values, so it will
  1826. override the value in the PNG file unless it is called before the PNG file
  1827. reading starts. For this reason you must always call it with the PNG file
  1828. value when you call it in this position:
  1829. if (png_get_gAMA(png_ptr, info_ptr, &file_gamma))
  1830. png_set_gamma(png_ptr, screen_gamma, file_gamma);
  1831. else
  1832. png_set_gamma(png_ptr, screen_gamma, 0.45455);
  1833. If you need to reduce an RGB file to a paletted file, or if a paletted
  1834. file has more entries than will fit on your screen, png_set_quantize()
  1835. will do that. Note that this is a simple match quantization that merely
  1836. finds the closest color available. This should work fairly well with
  1837. optimized palettes, but fairly badly with linear color cubes. If you
  1838. pass a palette that is larger than maximum_colors, the file will
  1839. reduce the number of colors in the palette so it will fit into
  1840. maximum_colors. If there is a histogram, libpng will use it to make
  1841. more intelligent choices when reducing the palette. If there is no
  1842. histogram, it may not do as good a job.
  1843. if (color_type & PNG_COLOR_MASK_COLOR)
  1844. {
  1845. if (png_get_valid(png_ptr, info_ptr,
  1846. PNG_INFO_PLTE))
  1847. {
  1848. png_uint_16p histogram = NULL;
  1849. png_get_hIST(png_ptr, info_ptr,
  1850. &histogram);
  1851. png_set_quantize(png_ptr, palette, num_palette,
  1852. max_screen_colors, histogram, 1);
  1853. }
  1854. else
  1855. {
  1856. png_color std_color_cube[MAX_SCREEN_COLORS] =
  1857. { ... colors ... };
  1858. png_set_quantize(png_ptr, std_color_cube,
  1859. MAX_SCREEN_COLORS, MAX_SCREEN_COLORS,
  1860. NULL,0);
  1861. }
  1862. }
  1863. PNG files describe monochrome as black being zero and white being one.
  1864. The following code will reverse this (make black be one and white be
  1865. zero):
  1866. if (bit_depth == 1 && color_type == PNG_COLOR_TYPE_GRAY)
  1867. png_set_invert_mono(png_ptr);
  1868. This function can also be used to invert grayscale and gray-alpha images:
  1869. if (color_type == PNG_COLOR_TYPE_GRAY ||
  1870. color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
  1871. png_set_invert_mono(png_ptr);
  1872. PNG files store 16-bit pixels in network byte order (big-endian,
  1873. ie. most significant bits first). This code changes the storage to the
  1874. other way (little-endian, i.e. least significant bits first, the
  1875. way PCs store them):
  1876. if (bit_depth == 16)
  1877. png_set_swap(png_ptr);
  1878. If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you
  1879. need to change the order the pixels are packed into bytes, you can use:
  1880. if (bit_depth < 8)
  1881. png_set_packswap(png_ptr);
  1882. Finally, you can write your own transformation function if none of
  1883. the existing ones meets your needs. This is done by setting a callback
  1884. with
  1885. png_set_read_user_transform_fn(png_ptr,
  1886. read_transform_fn);
  1887. You must supply the function
  1888. void read_transform_fn(png_structp png_ptr, png_row_infop
  1889. row_info, png_bytep data)
  1890. See pngtest.c for a working example. Your function will be called
  1891. after all of the other transformations have been processed. Take care with
  1892. interlaced images if you do the interlace yourself - the width of the row is the
  1893. width in 'row_info', not the overall image width.
  1894. If supported, libpng provides two information routines that you can use to find
  1895. where you are in processing the image:
  1896. png_get_current_pass_number(png_structp png_ptr);
  1897. png_get_current_row_number(png_structp png_ptr);
  1898. Don't try using these outside a transform callback - firstly they are only
  1899. supported if user transforms are supported, secondly they may well return
  1900. unexpected results unless the row is actually being processed at the moment they
  1901. are called.
  1902. With interlaced
  1903. images the value returned is the row in the input sub-image image. Use
  1904. PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
  1905. find the output pixel (x,y) given an interlaced sub-image pixel (row,col,pass).
  1906. The discussion of interlace handling above contains more information on how to
  1907. use these values.
  1908. You can also set up a pointer to a user structure for use by your
  1909. callback function, and you can inform libpng that your transform
  1910. function will change the number of channels or bit depth with the
  1911. function
  1912. png_set_user_transform_info(png_ptr, user_ptr,
  1913. user_depth, user_channels);
  1914. The user's application, not libpng, is responsible for allocating and
  1915. freeing any memory required for the user structure.
  1916. You can retrieve the pointer via the function
  1917. png_get_user_transform_ptr(). For example:
  1918. voidp read_user_transform_ptr =
  1919. png_get_user_transform_ptr(png_ptr);
  1920. The last thing to handle is interlacing; this is covered in detail below,
  1921. but you must call the function here if you want libpng to handle expansion
  1922. of the interlaced image.
  1923. number_of_passes = png_set_interlace_handling(png_ptr);
  1924. After setting the transformations, libpng can update your png_info
  1925. structure to reflect any transformations you've requested with this
  1926. call.
  1927. png_read_update_info(png_ptr, info_ptr);
  1928. This is most useful to update the info structure's rowbytes
  1929. field so you can use it to allocate your image memory. This function
  1930. will also update your palette with the correct screen_gamma and
  1931. background if these have been given with the calls above. You may
  1932. only call png_read_update_info() once with a particular info_ptr.
  1933. After you call png_read_update_info(), you can allocate any
  1934. memory you need to hold the image. The row data is simply
  1935. raw byte data for all forms of images. As the actual allocation
  1936. varies among applications, no example will be given. If you
  1937. are allocating one large chunk, you will need to build an
  1938. array of pointers to each row, as it will be needed for some
  1939. of the functions below.
  1940. Be sure that your platform can allocate the buffer that you'll need.
  1941. libpng internally checks for oversize width, but you'll need to
  1942. do your own check for number_of_rows*width*pixel_size if you are using
  1943. a multiple-row buffer:
  1944. /* Guard against integer overflow */
  1945. if (number_of_rows > PNG_SIZE_MAX/(width*pixel_size)) {
  1946. png_error(png_ptr,"image_data buffer would be too large");
  1947. }
  1948. Remember: Before you call png_read_update_info(), the png_get_*()
  1949. functions return the values corresponding to the original PNG image.
  1950. After you call png_read_update_info the values refer to the image
  1951. that libpng will output. Consequently you must call all the png_set_
  1952. functions before you call png_read_update_info(). This is particularly
  1953. important for png_set_interlace_handling() - if you are going to call
  1954. png_read_update_info() you must call png_set_interlace_handling() before
  1955. it unless you want to receive interlaced output.
  1956. .SS Reading image data
  1957. After you've allocated memory, you can read the image data.
  1958. The simplest way to do this is in one function call. If you are
  1959. allocating enough memory to hold the whole image, you can just
  1960. call png_read_image() and libpng will read in all the image data
  1961. and put it in the memory area supplied. You will need to pass in
  1962. an array of pointers to each row.
  1963. This function automatically handles interlacing, so you don't
  1964. need to call png_set_interlace_handling() (unless you call
  1965. png_read_update_info()) or call this function multiple times, or any
  1966. of that other stuff necessary with png_read_rows().
  1967. png_read_image(png_ptr, row_pointers);
  1968. where row_pointers is:
  1969. png_bytep row_pointers[height];
  1970. You can point to void or char or whatever you use for pixels.
  1971. If you don't want to read in the whole image at once, you can
  1972. use png_read_rows() instead. If there is no interlacing (check
  1973. interlace_type == PNG_INTERLACE_NONE), this is simple:
  1974. png_read_rows(png_ptr, row_pointers, NULL,
  1975. number_of_rows);
  1976. where row_pointers is the same as in the png_read_image() call.
  1977. If you are doing this just one row at a time, you can do this with
  1978. a single row_pointer instead of an array of row_pointers:
  1979. png_bytep row_pointer = row;
  1980. png_read_row(png_ptr, row_pointer, NULL);
  1981. If the file is interlaced (interlace_type != 0 in the IHDR chunk), things
  1982. get somewhat harder. The only current (PNG Specification version 1.2)
  1983. interlacing type for PNG is (interlace_type == PNG_INTERLACE_ADAM7);
  1984. a somewhat complicated 2D interlace scheme, known as Adam7, that
  1985. breaks down an image into seven smaller images of varying size, based
  1986. on an 8x8 grid. This number is defined (from libpng 1.5) as
  1987. PNG_INTERLACE_ADAM7_PASSES in png.h
  1988. libpng can fill out those images or it can give them to you "as is".
  1989. It is almost always better to have libpng handle the interlacing for you.
  1990. If you want the images filled out, there are two ways to do that. The one
  1991. mentioned in the PNG specification is to expand each pixel to cover
  1992. those pixels that have not been read yet (the "rectangle" method).
  1993. This results in a blocky image for the first pass, which gradually
  1994. smooths out as more pixels are read. The other method is the "sparkle"
  1995. method, where pixels are drawn only in their final locations, with the
  1996. rest of the image remaining whatever colors they were initialized to
  1997. before the start of the read. The first method usually looks better,
  1998. but tends to be slower, as there are more pixels to put in the rows.
  1999. If, as is likely, you want libpng to expand the images, call this before
  2000. calling png_start_read_image() or png_read_update_info():
  2001. if (interlace_type == PNG_INTERLACE_ADAM7)
  2002. number_of_passes
  2003. = png_set_interlace_handling(png_ptr);
  2004. This will return the number of passes needed. Currently, this is seven,
  2005. but may change if another interlace type is added. This function can be
  2006. called even if the file is not interlaced, where it will return one pass.
  2007. You then need to read the whole image 'number_of_passes' times. Each time
  2008. will distribute the pixels from the current pass to the correct place in
  2009. the output image, so you need to supply the same rows to png_read_rows in
  2010. each pass.
  2011. If you are not going to display the image after each pass, but are
  2012. going to wait until the entire image is read in, use the sparkle
  2013. effect. This effect is faster and the end result of either method
  2014. is exactly the same. If you are planning on displaying the image
  2015. after each pass, the "rectangle" effect is generally considered the
  2016. better looking one.
  2017. If you only want the "sparkle" effect, just call png_read_row() or
  2018. png_read_rows() as
  2019. normal, with the third parameter NULL. Make sure you make pass over
  2020. the image number_of_passes times, and you don't change the data in the
  2021. rows between calls. You can change the locations of the data, just
  2022. not the data. Each pass only writes the pixels appropriate for that
  2023. pass, and assumes the data from previous passes is still valid.
  2024. png_read_rows(png_ptr, row_pointers, NULL,
  2025. number_of_rows);
  2026. or
  2027. png_read_row(png_ptr, row_pointers, NULL);
  2028. If you only want the first effect (the rectangles), do the same as
  2029. before except pass the row buffer in the third parameter, and leave
  2030. the second parameter NULL.
  2031. png_read_rows(png_ptr, NULL, row_pointers,
  2032. number_of_rows);
  2033. or
  2034. png_read_row(png_ptr, NULL, row_pointers);
  2035. If you don't want libpng to handle the interlacing details, just call
  2036. png_read_rows() PNG_INTERLACE_ADAM7_PASSES times to read in all the images.
  2037. Each of the images is a valid image by itself; however, you will almost
  2038. certainly need to distribute the pixels from each sub-image to the
  2039. correct place. This is where everything gets very tricky.
  2040. If you want to retrieve the separate images you must pass the correct
  2041. number of rows to each successive call of png_read_rows(). The calculation
  2042. gets pretty complicated for small images, where some sub-images may
  2043. not even exist because either their width or height ends up zero.
  2044. libpng provides two macros to help you in 1.5 and later versions:
  2045. png_uint_32 width = PNG_PASS_COLS(image_width, pass_number);
  2046. png_uint_32 height = PNG_PASS_ROWS(image_height, pass_number);
  2047. Respectively these tell you the width and height of the sub-image
  2048. corresponding to the numbered pass. 'pass' is in in the range 0 to 6 -
  2049. this can be confusing because the specification refers to the same passes
  2050. as 1 to 7! Be careful, you must check both the width and height before
  2051. calling png_read_rows() and not call it for that pass if either is zero.
  2052. You can, of course, read each sub-image row by row. If you want to
  2053. produce optimal code to make a pixel-by-pixel transformation of an
  2054. interlaced image this is the best approach; read each row of each pass,
  2055. transform it, and write it out to a new interlaced image.
  2056. If you want to de-interlace the image yourself libpng provides further
  2057. macros to help that tell you where to place the pixels in the output image.
  2058. Because the interlacing scheme is rectangular - sub-image pixels are always
  2059. arranged on a rectangular grid - all you need to know for each pass is the
  2060. starting column and row in the output image of the first pixel plus the
  2061. spacing between each pixel. As of libpng 1.5 there are four macros to
  2062. retrieve this information:
  2063. png_uint_32 x = PNG_PASS_START_COL(pass);
  2064. png_uint_32 y = PNG_PASS_START_ROW(pass);
  2065. png_uint_32 xStep = 1U << PNG_PASS_COL_SHIFT(pass);
  2066. png_uint_32 yStep = 1U << PNG_PASS_ROW_SHIFT(pass);
  2067. These allow you to write the obvious loop:
  2068. png_uint_32 input_y = 0;
  2069. png_uint_32 output_y = PNG_PASS_START_ROW(pass);
  2070. while (output_y < output_image_height)
  2071. {
  2072. png_uint_32 input_x = 0;
  2073. png_uint_32 output_x = PNG_PASS_START_COL(pass);
  2074. while (output_x < output_image_width)
  2075. {
  2076. image[output_y][output_x] =
  2077. subimage[pass][input_y][input_x++];
  2078. output_x += xStep;
  2079. }
  2080. ++input_y;
  2081. output_y += yStep;
  2082. }
  2083. Notice that the steps between successive output rows and columns are
  2084. returned as shifts. This is possible because the pixels in the subimages
  2085. are always a power of 2 apart - 1, 2, 4 or 8 pixels - in the original
  2086. image. In practice you may need to directly calculate the output coordinate
  2087. given an input coordinate. libpng provides two further macros for this
  2088. purpose:
  2089. png_uint_32 output_x = PNG_COL_FROM_PASS_COL(input_x, pass);
  2090. png_uint_32 output_y = PNG_ROW_FROM_PASS_ROW(input_y, pass);
  2091. Finally a pair of macros are provided to tell you if a particular image
  2092. row or column appears in a given pass:
  2093. int col_in_pass = PNG_COL_IN_INTERLACE_PASS(output_x, pass);
  2094. int row_in_pass = PNG_ROW_IN_INTERLACE_PASS(output_y, pass);
  2095. Bear in mind that you will probably also need to check the width and height
  2096. of the pass in addition to the above to be sure the pass even exists!
  2097. With any luck you are convinced by now that you don't want to do your own
  2098. interlace handling. In reality normally the only good reason for doing this
  2099. is if you are processing PNG files on a pixel-by-pixel basis and don't want
  2100. to load the whole file into memory when it is interlaced.
  2101. libpng includes a test program, pngvalid, that illustrates reading and
  2102. writing of interlaced images. If you can't get interlacing to work in your
  2103. code and don't want to leave it to libpng (the recommended approach), see
  2104. how pngvalid.c does it.
  2105. .SS Finishing a sequential read
  2106. After you are finished reading the image through the
  2107. low-level interface, you can finish reading the file.
  2108. If you want to use a different crc action for handling CRC errors in
  2109. chunks after the image data, you can call png_set_crc_action()
  2110. again at this point.
  2111. If you are interested in comments or time, which may be stored either
  2112. before or after the image data, you should pass the separate png_info
  2113. struct if you want to keep the comments from before and after the image
  2114. separate.
  2115. png_infop end_info = png_create_info_struct(png_ptr);
  2116. if (!end_info)
  2117. {
  2118. png_destroy_read_struct(&png_ptr, &info_ptr,
  2119. (png_infopp)NULL);
  2120. return ERROR;
  2121. }
  2122. png_read_end(png_ptr, end_info);
  2123. If you are not interested, you should still call png_read_end()
  2124. but you can pass NULL, avoiding the need to create an end_info structure.
  2125. If you do this, libpng will not process any chunks after IDAT other than
  2126. skipping over them and perhaps (depending on whether you have called
  2127. png_set_crc_action) checking their CRCs while looking for the IEND chunk.
  2128. png_read_end(png_ptr, (png_infop)NULL);
  2129. If you don't call png_read_end(), then your file pointer will be
  2130. left pointing to the first chunk after the last IDAT, which is probably
  2131. not what you want if you expect to read something beyond the end of
  2132. the PNG datastream.
  2133. When you are done, you can free all memory allocated by libpng like this:
  2134. png_destroy_read_struct(&png_ptr, &info_ptr,
  2135. &end_info);
  2136. or, if you didn't create an end_info structure,
  2137. png_destroy_read_struct(&png_ptr, &info_ptr,
  2138. (png_infopp)NULL);
  2139. It is also possible to individually free the info_ptr members that
  2140. point to libpng-allocated storage with the following function:
  2141. png_free_data(png_ptr, info_ptr, mask, seq)
  2142. mask - identifies data to be freed, a mask
  2143. containing the bitwise OR of one or
  2144. more of
  2145. PNG_FREE_PLTE, PNG_FREE_TRNS,
  2146. PNG_FREE_HIST, PNG_FREE_ICCP,
  2147. PNG_FREE_PCAL, PNG_FREE_ROWS,
  2148. PNG_FREE_SCAL, PNG_FREE_SPLT,
  2149. PNG_FREE_TEXT, PNG_FREE_UNKN,
  2150. or simply PNG_FREE_ALL
  2151. seq - sequence number of item to be freed
  2152. (\-1 for all items)
  2153. This function may be safely called when the relevant storage has
  2154. already been freed, or has not yet been allocated, or was allocated
  2155. by the user and not by libpng, and will in those cases do nothing.
  2156. The "seq" parameter is ignored if only one item of the selected data
  2157. type, such as PLTE, is allowed. If "seq" is not \-1, and multiple items
  2158. are allowed for the data type identified in the mask, such as text or
  2159. sPLT, only the n'th item in the structure is freed, where n is "seq".
  2160. The default behavior is only to free data that was allocated internally
  2161. by libpng. This can be changed, so that libpng will not free the data,
  2162. or so that it will free data that was allocated by the user with png_malloc()
  2163. or png_calloc() and passed in via a png_set_*() function, with
  2164. png_data_freer(png_ptr, info_ptr, freer, mask)
  2165. freer - one of
  2166. PNG_DESTROY_WILL_FREE_DATA
  2167. PNG_SET_WILL_FREE_DATA
  2168. PNG_USER_WILL_FREE_DATA
  2169. mask - which data elements are affected
  2170. same choices as in png_free_data()
  2171. This function only affects data that has already been allocated.
  2172. You can call this function after reading the PNG data but before calling
  2173. any png_set_*() functions, to control whether the user or the png_set_*()
  2174. function is responsible for freeing any existing data that might be present,
  2175. and again after the png_set_*() functions to control whether the user
  2176. or png_destroy_*() is supposed to free the data. When the user assumes
  2177. responsibility for libpng-allocated data, the application must use
  2178. png_free() to free it, and when the user transfers responsibility to libpng
  2179. for data that the user has allocated, the user must have used png_malloc()
  2180. or png_calloc() to allocate it.
  2181. If you allocated your row_pointers in a single block, as suggested above in
  2182. the description of the high level read interface, you must not transfer
  2183. responsibility for freeing it to the png_set_rows or png_read_destroy function,
  2184. because they would also try to free the individual row_pointers[i].
  2185. If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword
  2186. separately, do not transfer responsibility for freeing text_ptr to libpng,
  2187. because when libpng fills a png_text structure it combines these members with
  2188. the key member, and png_free_data() will free only text_ptr.key. Similarly,
  2189. if you transfer responsibility for free'ing text_ptr from libpng to your
  2190. application, your application must not separately free those members.
  2191. The png_free_data() function will turn off the "valid" flag for anything
  2192. it frees. If you need to turn the flag off for a chunk that was freed by
  2193. your application instead of by libpng, you can use
  2194. png_set_invalid(png_ptr, info_ptr, mask);
  2195. mask - identifies the chunks to be made invalid,
  2196. containing the bitwise OR of one or
  2197. more of
  2198. PNG_INFO_gAMA, PNG_INFO_sBIT,
  2199. PNG_INFO_cHRM, PNG_INFO_PLTE,
  2200. PNG_INFO_tRNS, PNG_INFO_bKGD,
  2201. PNG_INFO_eXIf,
  2202. PNG_INFO_hIST, PNG_INFO_pHYs,
  2203. PNG_INFO_oFFs, PNG_INFO_tIME,
  2204. PNG_INFO_pCAL, PNG_INFO_sRGB,
  2205. PNG_INFO_iCCP, PNG_INFO_sPLT,
  2206. PNG_INFO_sCAL, PNG_INFO_IDAT
  2207. For a more compact example of reading a PNG image, see the file example.c.
  2208. .SS Reading PNG files progressively
  2209. The progressive reader is slightly different from the non-progressive
  2210. reader. Instead of calling png_read_info(), png_read_rows(), and
  2211. png_read_end(), you make one call to png_process_data(), which calls
  2212. callbacks when it has the info, a row, or the end of the image. You
  2213. set up these callbacks with png_set_progressive_read_fn(). You don't
  2214. have to worry about the input/output functions of libpng, as you are
  2215. giving the library the data directly in png_process_data(). I will
  2216. assume that you have read the section on reading PNG files above,
  2217. so I will only highlight the differences (although I will show
  2218. all of the code).
  2219. png_structp png_ptr;
  2220. png_infop info_ptr;
  2221. /* An example code fragment of how you would
  2222. initialize the progressive reader in your
  2223. application. */
  2224. int
  2225. initialize_png_reader()
  2226. {
  2227. png_ptr = png_create_read_struct
  2228. (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
  2229. user_error_fn, user_warning_fn);
  2230. if (!png_ptr)
  2231. return ERROR;
  2232. info_ptr = png_create_info_struct(png_ptr);
  2233. if (!info_ptr)
  2234. {
  2235. png_destroy_read_struct(&png_ptr,
  2236. (png_infopp)NULL, (png_infopp)NULL);
  2237. return ERROR;
  2238. }
  2239. if (setjmp(png_jmpbuf(png_ptr)))
  2240. {
  2241. png_destroy_read_struct(&png_ptr, &info_ptr,
  2242. (png_infopp)NULL);
  2243. return ERROR;
  2244. }
  2245. /* This one's new. You can provide functions
  2246. to be called when the header info is valid,
  2247. when each row is completed, and when the image
  2248. is finished. If you aren't using all functions,
  2249. you can specify NULL parameters. Even when all
  2250. three functions are NULL, you need to call
  2251. png_set_progressive_read_fn(). You can use
  2252. any struct as the user_ptr (cast to a void pointer
  2253. for the function call), and retrieve the pointer
  2254. from inside the callbacks using the function
  2255. png_get_progressive_ptr(png_ptr);
  2256. which will return a void pointer, which you have
  2257. to cast appropriately.
  2258. */
  2259. png_set_progressive_read_fn(png_ptr, (void *)user_ptr,
  2260. info_callback, row_callback, end_callback);
  2261. return 0;
  2262. }
  2263. /* A code fragment that you call as you receive blocks
  2264. of data */
  2265. int
  2266. process_data(png_bytep buffer, png_uint_32 length)
  2267. {
  2268. if (setjmp(png_jmpbuf(png_ptr)))
  2269. {
  2270. png_destroy_read_struct(&png_ptr, &info_ptr,
  2271. (png_infopp)NULL);
  2272. return ERROR;
  2273. }
  2274. /* This one's new also. Simply give it a chunk
  2275. of data from the file stream (in order, of
  2276. course). On machines with segmented memory
  2277. models machines, don't give it any more than
  2278. 64K. The library seems to run fine with sizes
  2279. of 4K. Although you can give it much less if
  2280. necessary (I assume you can give it chunks of
  2281. 1 byte, I haven't tried less than 256 bytes
  2282. yet). When this function returns, you may
  2283. want to display any rows that were generated
  2284. in the row callback if you don't already do
  2285. so there.
  2286. */
  2287. png_process_data(png_ptr, info_ptr, buffer, length);
  2288. /* At this point you can call png_process_data_skip if
  2289. you want to handle data the library will skip yourself;
  2290. it simply returns the number of bytes to skip (and stops
  2291. libpng skipping that number of bytes on the next
  2292. png_process_data call).
  2293. return 0;
  2294. }
  2295. /* This function is called (as set by
  2296. png_set_progressive_read_fn() above) when enough data
  2297. has been supplied so all of the header has been
  2298. read.
  2299. */
  2300. void
  2301. info_callback(png_structp png_ptr, png_infop info)
  2302. {
  2303. /* Do any setup here, including setting any of
  2304. the transformations mentioned in the Reading
  2305. PNG files section. For now, you _must_ call
  2306. either png_start_read_image() or
  2307. png_read_update_info() after all the
  2308. transformations are set (even if you don't set
  2309. any). You may start getting rows before
  2310. png_process_data() returns, so this is your
  2311. last chance to prepare for that.
  2312. This is where you turn on interlace handling,
  2313. assuming you don't want to do it yourself.
  2314. If you need to you can stop the processing of
  2315. your original input data at this point by calling
  2316. png_process_data_pause. This returns the number
  2317. of unprocessed bytes from the last png_process_data
  2318. call - it is up to you to ensure that the next call
  2319. sees these bytes again. If you don't want to bother
  2320. with this you can get libpng to cache the unread
  2321. bytes by setting the 'save' parameter (see png.h) but
  2322. then libpng will have to copy the data internally.
  2323. */
  2324. }
  2325. /* This function is called when each row of image
  2326. data is complete */
  2327. void
  2328. row_callback(png_structp png_ptr, png_bytep new_row,
  2329. png_uint_32 row_num, int pass)
  2330. {
  2331. /* If the image is interlaced, and you turned
  2332. on the interlace handler, this function will
  2333. be called for every row in every pass. Some
  2334. of these rows will not be changed from the
  2335. previous pass. When the row is not changed,
  2336. the new_row variable will be NULL. The rows
  2337. and passes are called in order, so you don't
  2338. really need the row_num and pass, but I'm
  2339. supplying them because it may make your life
  2340. easier.
  2341. If you did not turn on interlace handling then
  2342. the callback is called for each row of each
  2343. sub-image when the image is interlaced. In this
  2344. case 'row_num' is the row in the sub-image, not
  2345. the row in the output image as it is in all other
  2346. cases.
  2347. For the non-NULL rows of interlaced images when
  2348. you have switched on libpng interlace handling,
  2349. you must call png_progressive_combine_row()
  2350. passing in the row and the old row. You can
  2351. call this function for NULL rows (it will just
  2352. return) and for non-interlaced images (it just
  2353. does the memcpy for you) if it will make the
  2354. code easier. Thus, you can just do this for
  2355. all cases if you switch on interlace handling;
  2356. */
  2357. png_progressive_combine_row(png_ptr, old_row,
  2358. new_row);
  2359. /* where old_row is what was displayed
  2360. previously for the row. Note that the first
  2361. pass (pass == 0, really) will completely cover
  2362. the old row, so the rows do not have to be
  2363. initialized. After the first pass (and only
  2364. for interlaced images), you will have to pass
  2365. the current row, and the function will combine
  2366. the old row and the new row.
  2367. You can also call png_process_data_pause in this
  2368. callback - see above.
  2369. */
  2370. }
  2371. void
  2372. end_callback(png_structp png_ptr, png_infop info)
  2373. {
  2374. /* This function is called after the whole image
  2375. has been read, including any chunks after the
  2376. image (up to and including the IEND). You
  2377. will usually have the same info chunk as you
  2378. had in the header, although some data may have
  2379. been added to the comments and time fields.
  2380. Most people won't do much here, perhaps setting
  2381. a flag that marks the image as finished.
  2382. */
  2383. }
  2384. .SH IV. Writing
  2385. Much of this is very similar to reading. However, everything of
  2386. importance is repeated here, so you won't have to constantly look
  2387. back up in the reading section to understand writing.
  2388. .SS Setup
  2389. You will want to do the I/O initialization before you get into libpng,
  2390. so if it doesn't work, you don't have anything to undo. If you are not
  2391. using the standard I/O functions, you will need to replace them with
  2392. custom writing functions. See the discussion under Customizing libpng.
  2393. FILE *fp = fopen(file_name, "wb");
  2394. if (!fp)
  2395. return ERROR;
  2396. Next, png_struct and png_info need to be allocated and initialized.
  2397. As these can be both relatively large, you may not want to store these
  2398. on the stack, unless you have stack space to spare. Of course, you
  2399. will want to check if they return NULL. If you are also reading,
  2400. you won't want to name your read structure and your write structure
  2401. both "png_ptr"; you can call them anything you like, such as
  2402. "read_ptr" and "write_ptr". Look at pngtest.c, for example.
  2403. png_structp png_ptr = png_create_write_struct
  2404. (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
  2405. user_error_fn, user_warning_fn);
  2406. if (!png_ptr)
  2407. return ERROR;
  2408. png_infop info_ptr = png_create_info_struct(png_ptr);
  2409. if (!info_ptr)
  2410. {
  2411. png_destroy_write_struct(&png_ptr,
  2412. (png_infopp)NULL);
  2413. return ERROR;
  2414. }
  2415. If you want to use your own memory allocation routines,
  2416. define PNG_USER_MEM_SUPPORTED and use
  2417. png_create_write_struct_2() instead of png_create_write_struct():
  2418. png_structp png_ptr = png_create_write_struct_2
  2419. (PNG_LIBPNG_VER_STRING, (png_voidp)user_error_ptr,
  2420. user_error_fn, user_warning_fn, (png_voidp)
  2421. user_mem_ptr, user_malloc_fn, user_free_fn);
  2422. After you have these structures, you will need to set up the
  2423. error handling. When libpng encounters an error, it expects to
  2424. longjmp() back to your routine. Therefore, you will need to call
  2425. setjmp() and pass the png_jmpbuf(png_ptr). If you
  2426. write the file from different routines, you will need to update
  2427. the png_jmpbuf(png_ptr) every time you enter a new routine that will
  2428. call a png_*() function. See your documentation of setjmp/longjmp
  2429. for your compiler for more information on setjmp/longjmp. See
  2430. the discussion on libpng error handling in the Customizing Libpng
  2431. section below for more information on the libpng error handling.
  2432. if (setjmp(png_jmpbuf(png_ptr)))
  2433. {
  2434. png_destroy_write_struct(&png_ptr, &info_ptr);
  2435. fclose(fp);
  2436. return ERROR;
  2437. }
  2438. ...
  2439. return;
  2440. If you would rather avoid the complexity of setjmp/longjmp issues,
  2441. you can compile libpng with PNG_NO_SETJMP, in which case
  2442. errors will result in a call to PNG_ABORT() which defaults to abort().
  2443. You can #define PNG_ABORT() to a function that does something
  2444. more useful than abort(), as long as your function does not
  2445. return.
  2446. Checking for invalid palette index on write was added at libpng
  2447. 1.5.10. If a pixel contains an invalid (out-of-range) index libpng issues
  2448. a benign error. This is enabled by default because this condition is an
  2449. error according to the PNG specification, Clause 11.3.2, but the error can
  2450. be ignored in each png_ptr with
  2451. png_set_check_for_invalid_index(png_ptr, 0);
  2452. If the error is ignored, or if png_benign_error() treats it as a warning,
  2453. any invalid pixels are written as-is by the encoder, resulting in an
  2454. invalid PNG datastream as output. In this case the application is
  2455. responsible for ensuring that the pixel indexes are in range when it writes
  2456. a PLTE chunk with fewer entries than the bit depth would allow.
  2457. Now you need to set up the output code. The default for libpng is to
  2458. use the C function fwrite(). If you use this, you will need to pass a
  2459. valid FILE * in the function png_init_io(). Be sure that the file is
  2460. opened in binary mode. Again, if you wish to handle writing data in
  2461. another way, see the discussion on libpng I/O handling in the Customizing
  2462. Libpng section below.
  2463. png_init_io(png_ptr, fp);
  2464. If you are embedding your PNG into a datastream such as MNG, and don't
  2465. want libpng to write the 8-byte signature, or if you have already
  2466. written the signature in your application, use
  2467. png_set_sig_bytes(png_ptr, 8);
  2468. to inform libpng that it should not write a signature.
  2469. .SS Write callbacks
  2470. At this point, you can set up a callback function that will be
  2471. called after each row has been written, which you can use to control
  2472. a progress meter or the like. It's demonstrated in pngtest.c.
  2473. You must supply a function
  2474. void write_row_callback(png_structp png_ptr, png_uint_32 row,
  2475. int pass);
  2476. {
  2477. /* put your code here */
  2478. }
  2479. (You can give it another name that you like instead of "write_row_callback")
  2480. To inform libpng about your function, use
  2481. png_set_write_status_fn(png_ptr, write_row_callback);
  2482. When this function is called the row has already been completely processed and
  2483. it has also been written out. The 'row' and 'pass' refer to the next row to be
  2484. handled. For the
  2485. non-interlaced case the row that was just handled is simply one less than the
  2486. passed in row number, and pass will always be 0. For the interlaced case the
  2487. same applies unless the row value is 0, in which case the row just handled was
  2488. the last one from one of the preceding passes. Because interlacing may skip a
  2489. pass you cannot be sure that the preceding pass is just 'pass\-1', if you really
  2490. need to know what the last pass is record (row,pass) from the callback and use
  2491. the last recorded value each time.
  2492. As with the user transform you can find the output row using the
  2493. PNG_ROW_FROM_PASS_ROW macro.
  2494. You now have the option of modifying how the compression library will
  2495. run. The following functions are mainly for testing, but may be useful
  2496. in some cases, like if you need to write PNG files extremely fast and
  2497. are willing to give up some compression, or if you want to get the
  2498. maximum possible compression at the expense of slower writing. If you
  2499. have no special needs in this area, let the library do what it wants by
  2500. not calling this function at all, as it has been tuned to deliver a good
  2501. speed/compression ratio. The second parameter to png_set_filter() is
  2502. the filter method, for which the only valid values are 0 (as of the
  2503. July 1999 PNG specification, version 1.2) or 64 (if you are writing
  2504. a PNG datastream that is to be embedded in a MNG datastream). The third
  2505. parameter is a flag that indicates which filter type(s) are to be tested
  2506. for each scanline. See the PNG specification for details on the specific
  2507. filter types.
  2508. /* turn on or off filtering, and/or choose
  2509. specific filters. You can use either a single
  2510. PNG_FILTER_VALUE_NAME or the bitwise OR of one
  2511. or more PNG_FILTER_NAME masks.
  2512. */
  2513. png_set_filter(png_ptr, 0,
  2514. PNG_FILTER_NONE | PNG_FILTER_VALUE_NONE |
  2515. PNG_FILTER_SUB | PNG_FILTER_VALUE_SUB |
  2516. PNG_FILTER_UP | PNG_FILTER_VALUE_UP |
  2517. PNG_FILTER_AVG | PNG_FILTER_VALUE_AVG |
  2518. PNG_FILTER_PAETH | PNG_FILTER_VALUE_PAETH|
  2519. PNG_ALL_FILTERS | PNG_FAST_FILTERS);
  2520. If an application wants to start and stop using particular filters during
  2521. compression, it should start out with all of the filters (to ensure that
  2522. the previous row of pixels will be stored in case it's needed later),
  2523. and then add and remove them after the start of compression.
  2524. If you are writing a PNG datastream that is to be embedded in a MNG
  2525. datastream, the second parameter can be either 0 or 64.
  2526. The png_set_compression_*() functions interface to the zlib compression
  2527. library, and should mostly be ignored unless you really know what you are
  2528. doing. The only generally useful call is png_set_compression_level()
  2529. which changes how much time zlib spends on trying to compress the image
  2530. data. See the Compression Library (zlib.h and algorithm.txt, distributed
  2531. with zlib) for details on the compression levels.
  2532. #include zlib.h
  2533. /* Set the zlib compression level */
  2534. png_set_compression_level(png_ptr,
  2535. Z_BEST_COMPRESSION);
  2536. /* Set other zlib parameters for compressing IDAT */
  2537. png_set_compression_mem_level(png_ptr, 8);
  2538. png_set_compression_strategy(png_ptr,
  2539. Z_DEFAULT_STRATEGY);
  2540. png_set_compression_window_bits(png_ptr, 15);
  2541. png_set_compression_method(png_ptr, 8);
  2542. png_set_compression_buffer_size(png_ptr, 8192)
  2543. /* Set zlib parameters for text compression
  2544. * If you don't call these, the parameters
  2545. * fall back on those defined for IDAT chunks
  2546. */
  2547. png_set_text_compression_mem_level(png_ptr, 8);
  2548. png_set_text_compression_strategy(png_ptr,
  2549. Z_DEFAULT_STRATEGY);
  2550. png_set_text_compression_window_bits(png_ptr, 15);
  2551. png_set_text_compression_method(png_ptr, 8);
  2552. .SS Setting the contents of info for output
  2553. You now need to fill in the png_info structure with all the data you
  2554. wish to write before the actual image. Note that the only thing you
  2555. are allowed to write after the image is the text chunks and the time
  2556. chunk (as of PNG Specification 1.2, anyway). See png_write_end() and
  2557. the latest PNG specification for more information on that. If you
  2558. wish to write them before the image, fill them in now, and flag that
  2559. data as being valid. If you want to wait until after the data, don't
  2560. fill them until png_write_end(). For all the fields in png_info and
  2561. their data types, see png.h. For explanations of what the fields
  2562. contain, see the PNG specification.
  2563. Some of the more important parts of the png_info are:
  2564. png_set_IHDR(png_ptr, info_ptr, width, height,
  2565. bit_depth, color_type, interlace_type,
  2566. compression_type, filter_method)
  2567. width - holds the width of the image
  2568. in pixels (up to 2^31).
  2569. height - holds the height of the image
  2570. in pixels (up to 2^31).
  2571. bit_depth - holds the bit depth of one of the
  2572. image channels.
  2573. (valid values are 1, 2, 4, 8, 16
  2574. and depend also on the
  2575. color_type. See also significant
  2576. bits (sBIT) below).
  2577. color_type - describes which color/alpha
  2578. channels are present.
  2579. PNG_COLOR_TYPE_GRAY
  2580. (bit depths 1, 2, 4, 8, 16)
  2581. PNG_COLOR_TYPE_GRAY_ALPHA
  2582. (bit depths 8, 16)
  2583. PNG_COLOR_TYPE_PALETTE
  2584. (bit depths 1, 2, 4, 8)
  2585. PNG_COLOR_TYPE_RGB
  2586. (bit_depths 8, 16)
  2587. PNG_COLOR_TYPE_RGB_ALPHA
  2588. (bit_depths 8, 16)
  2589. PNG_COLOR_MASK_PALETTE
  2590. PNG_COLOR_MASK_COLOR
  2591. PNG_COLOR_MASK_ALPHA
  2592. interlace_type - PNG_INTERLACE_NONE or
  2593. PNG_INTERLACE_ADAM7
  2594. compression_type - (must be
  2595. PNG_COMPRESSION_TYPE_DEFAULT)
  2596. filter_method - (must be PNG_FILTER_TYPE_DEFAULT
  2597. or, if you are writing a PNG to
  2598. be embedded in a MNG datastream,
  2599. can also be
  2600. PNG_INTRAPIXEL_DIFFERENCING)
  2601. If you call png_set_IHDR(), the call must appear before any of the
  2602. other png_set_*() functions, because they might require access to some of
  2603. the IHDR settings. The remaining png_set_*() functions can be called
  2604. in any order.
  2605. If you wish, you can reset the compression_type, interlace_type, or
  2606. filter_method later by calling png_set_IHDR() again; if you do this, the
  2607. width, height, bit_depth, and color_type must be the same in each call.
  2608. png_set_PLTE(png_ptr, info_ptr, palette,
  2609. num_palette);
  2610. palette - the palette for the file
  2611. (array of png_color)
  2612. num_palette - number of entries in the palette
  2613. png_set_gAMA(png_ptr, info_ptr, file_gamma);
  2614. png_set_gAMA_fixed(png_ptr, info_ptr, int_file_gamma);
  2615. file_gamma - the gamma at which the image was
  2616. created (PNG_INFO_gAMA)
  2617. int_file_gamma - 100,000 times the gamma at which
  2618. the image was created
  2619. png_set_cHRM(png_ptr, info_ptr, white_x, white_y, red_x, red_y,
  2620. green_x, green_y, blue_x, blue_y)
  2621. png_set_cHRM_XYZ(png_ptr, info_ptr, red_X, red_Y, red_Z, green_X,
  2622. green_Y, green_Z, blue_X, blue_Y, blue_Z)
  2623. png_set_cHRM_fixed(png_ptr, info_ptr, int_white_x, int_white_y,
  2624. int_red_x, int_red_y, int_green_x, int_green_y,
  2625. int_blue_x, int_blue_y)
  2626. png_set_cHRM_XYZ_fixed(png_ptr, info_ptr, int_red_X, int_red_Y,
  2627. int_red_Z, int_green_X, int_green_Y, int_green_Z,
  2628. int_blue_X, int_blue_Y, int_blue_Z)
  2629. {white,red,green,blue}_{x,y}
  2630. A color space encoding specified using the chromaticities
  2631. of the end points and the white point.
  2632. {red,green,blue}_{X,Y,Z}
  2633. A color space encoding specified using the encoding end
  2634. points - the CIE tristimulus specification of the intended
  2635. color of the red, green and blue channels in the PNG RGB
  2636. data. The white point is simply the sum of the three end
  2637. points.
  2638. png_set_sRGB(png_ptr, info_ptr, srgb_intent);
  2639. srgb_intent - the rendering intent
  2640. (PNG_INFO_sRGB) The presence of
  2641. the sRGB chunk means that the pixel
  2642. data is in the sRGB color space.
  2643. This chunk also implies specific
  2644. values of gAMA and cHRM. Rendering
  2645. intent is the CSS-1 property that
  2646. has been defined by the International
  2647. Color Consortium
  2648. (http://www.color.org).
  2649. It can be one of
  2650. PNG_sRGB_INTENT_SATURATION,
  2651. PNG_sRGB_INTENT_PERCEPTUAL,
  2652. PNG_sRGB_INTENT_ABSOLUTE, or
  2653. PNG_sRGB_INTENT_RELATIVE.
  2654. png_set_sRGB_gAMA_and_cHRM(png_ptr, info_ptr,
  2655. srgb_intent);
  2656. srgb_intent - the rendering intent
  2657. (PNG_INFO_sRGB) The presence of the
  2658. sRGB chunk means that the pixel
  2659. data is in the sRGB color space.
  2660. This function also causes gAMA and
  2661. cHRM chunks with the specific values
  2662. that are consistent with sRGB to be
  2663. written.
  2664. png_set_iCCP(png_ptr, info_ptr, name, compression_type,
  2665. profile, proflen);
  2666. name - The profile name.
  2667. compression_type - The compression type; always
  2668. PNG_COMPRESSION_TYPE_BASE for PNG 1.0.
  2669. You may give NULL to this argument to
  2670. ignore it.
  2671. profile - International Color Consortium color
  2672. profile data. May contain NULs.
  2673. proflen - length of profile data in bytes.
  2674. png_set_sBIT(png_ptr, info_ptr, sig_bit);
  2675. sig_bit - the number of significant bits for
  2676. (PNG_INFO_sBIT) each of the gray, red,
  2677. green, and blue channels, whichever are
  2678. appropriate for the given color type
  2679. (png_color_16)
  2680. png_set_tRNS(png_ptr, info_ptr, trans_alpha,
  2681. num_trans, trans_color);
  2682. trans_alpha - array of alpha (transparency)
  2683. entries for palette (PNG_INFO_tRNS)
  2684. num_trans - number of transparent entries
  2685. (PNG_INFO_tRNS)
  2686. trans_color - graylevel or color sample values
  2687. (in order red, green, blue) of the
  2688. single transparent color for
  2689. non-paletted images (PNG_INFO_tRNS)
  2690. png_set_eXIf_1(png_ptr, info_ptr, num_exif, exif);
  2691. exif - Exif profile (array of
  2692. png_byte) (PNG_INFO_eXIf)
  2693. png_set_hIST(png_ptr, info_ptr, hist);
  2694. hist - histogram of palette (array of
  2695. png_uint_16) (PNG_INFO_hIST)
  2696. png_set_tIME(png_ptr, info_ptr, mod_time);
  2697. mod_time - time image was last modified
  2698. (PNG_VALID_tIME)
  2699. png_set_bKGD(png_ptr, info_ptr, background);
  2700. background - background color (of type
  2701. png_color_16p) (PNG_VALID_bKGD)
  2702. png_set_text(png_ptr, info_ptr, text_ptr, num_text);
  2703. text_ptr - array of png_text holding image
  2704. comments
  2705. text_ptr[i].compression - type of compression used
  2706. on "text" PNG_TEXT_COMPRESSION_NONE
  2707. PNG_TEXT_COMPRESSION_zTXt
  2708. PNG_ITXT_COMPRESSION_NONE
  2709. PNG_ITXT_COMPRESSION_zTXt
  2710. text_ptr[i].key - keyword for comment. Must contain
  2711. 1-79 characters.
  2712. text_ptr[i].text - text comments for current
  2713. keyword. Can be NULL or empty.
  2714. text_ptr[i].text_length - length of text string,
  2715. after decompression, 0 for iTXt
  2716. text_ptr[i].itxt_length - length of itxt string,
  2717. after decompression, 0 for tEXt/zTXt
  2718. text_ptr[i].lang - language of comment (NULL or
  2719. empty for unknown).
  2720. text_ptr[i].translated_keyword - keyword in UTF-8 (NULL
  2721. or empty for unknown).
  2722. Note that the itxt_length, lang, and lang_key
  2723. members of the text_ptr structure only exist when the
  2724. library is built with iTXt chunk support. Prior to
  2725. libpng-1.4.0 the library was built by default without
  2726. iTXt support. Also note that when iTXt is supported,
  2727. they contain NULL pointers when the "compression"
  2728. field contains PNG_TEXT_COMPRESSION_NONE or
  2729. PNG_TEXT_COMPRESSION_zTXt.
  2730. num_text - number of comments
  2731. png_set_sPLT(png_ptr, info_ptr, &palette_ptr,
  2732. num_spalettes);
  2733. palette_ptr - array of png_sPLT_struct structures
  2734. to be added to the list of palettes
  2735. in the info structure.
  2736. num_spalettes - number of palette structures to be
  2737. added.
  2738. png_set_oFFs(png_ptr, info_ptr, offset_x, offset_y,
  2739. unit_type);
  2740. offset_x - positive offset from the left
  2741. edge of the screen
  2742. offset_y - positive offset from the top
  2743. edge of the screen
  2744. unit_type - PNG_OFFSET_PIXEL, PNG_OFFSET_MICROMETER
  2745. png_set_pHYs(png_ptr, info_ptr, res_x, res_y,
  2746. unit_type);
  2747. res_x - pixels/unit physical resolution
  2748. in x direction
  2749. res_y - pixels/unit physical resolution
  2750. in y direction
  2751. unit_type - PNG_RESOLUTION_UNKNOWN,
  2752. PNG_RESOLUTION_METER
  2753. png_set_sCAL(png_ptr, info_ptr, unit, width, height)
  2754. unit - physical scale units (an integer)
  2755. width - width of a pixel in physical scale units
  2756. height - height of a pixel in physical scale units
  2757. (width and height are doubles)
  2758. png_set_sCAL_s(png_ptr, info_ptr, unit, width, height)
  2759. unit - physical scale units (an integer)
  2760. width - width of a pixel in physical scale units
  2761. expressed as a string
  2762. height - height of a pixel in physical scale units
  2763. (width and height are strings like "2.54")
  2764. png_set_unknown_chunks(png_ptr, info_ptr, &unknowns,
  2765. num_unknowns)
  2766. unknowns - array of png_unknown_chunk
  2767. structures holding unknown chunks
  2768. unknowns[i].name - name of unknown chunk
  2769. unknowns[i].data - data of unknown chunk
  2770. unknowns[i].size - size of unknown chunk's data
  2771. unknowns[i].location - position to write chunk in file
  2772. 0: do not write chunk
  2773. PNG_HAVE_IHDR: before PLTE
  2774. PNG_HAVE_PLTE: before IDAT
  2775. PNG_AFTER_IDAT: after IDAT
  2776. The "location" member is set automatically according to
  2777. what part of the output file has already been written.
  2778. You can change its value after calling png_set_unknown_chunks()
  2779. as demonstrated in pngtest.c. Within each of the "locations",
  2780. the chunks are sequenced according to their position in the
  2781. structure (that is, the value of "i", which is the order in which
  2782. the chunk was either read from the input file or defined with
  2783. png_set_unknown_chunks).
  2784. A quick word about text and num_text. text is an array of png_text
  2785. structures. num_text is the number of valid structures in the array.
  2786. Each png_text structure holds a language code, a keyword, a text value,
  2787. and a compression type.
  2788. The compression types have the same valid numbers as the compression
  2789. types of the image data. Currently, the only valid number is zero.
  2790. However, you can store text either compressed or uncompressed, unlike
  2791. images, which always have to be compressed. So if you don't want the
  2792. text compressed, set the compression type to PNG_TEXT_COMPRESSION_NONE.
  2793. Because tEXt and zTXt chunks don't have a language field, if you
  2794. specify PNG_TEXT_COMPRESSION_NONE or PNG_TEXT_COMPRESSION_zTXt
  2795. any language code or translated keyword will not be written out.
  2796. Until text gets around a few hundred bytes, it is not worth compressing it.
  2797. After the text has been written out to the file, the compression type
  2798. is set to PNG_TEXT_COMPRESSION_NONE_WR or PNG_TEXT_COMPRESSION_zTXt_WR,
  2799. so that it isn't written out again at the end (in case you are calling
  2800. png_write_end() with the same struct).
  2801. The keywords that are given in the PNG Specification are:
  2802. Title Short (one line) title or
  2803. caption for image
  2804. Author Name of image's creator
  2805. Description Description of image (possibly long)
  2806. Copyright Copyright notice
  2807. Creation Time Time of original image creation
  2808. (usually RFC 1123 format, see below)
  2809. Software Software used to create the image
  2810. Disclaimer Legal disclaimer
  2811. Warning Warning of nature of content
  2812. Source Device used to create the image
  2813. Comment Miscellaneous comment; conversion
  2814. from other image format
  2815. The keyword-text pairs work like this. Keywords should be short
  2816. simple descriptions of what the comment is about. Some typical
  2817. keywords are found in the PNG specification, as is some recommendations
  2818. on keywords. You can repeat keywords in a file. You can even write
  2819. some text before the image and some after. For example, you may want
  2820. to put a description of the image before the image, but leave the
  2821. disclaimer until after, so viewers working over modem connections
  2822. don't have to wait for the disclaimer to go over the modem before
  2823. they start seeing the image. Finally, keywords should be full
  2824. words, not abbreviations. Keywords and text are in the ISO 8859-1
  2825. (Latin-1) character set (a superset of regular ASCII) and can not
  2826. contain NUL characters, and should not contain control or other
  2827. unprintable characters. To make the comments widely readable, stick
  2828. with basic ASCII, and avoid machine specific character set extensions
  2829. like the IBM-PC character set. The keyword must be present, but
  2830. you can leave off the text string on non-compressed pairs.
  2831. Compressed pairs must have a text string, as only the text string
  2832. is compressed anyway, so the compression would be meaningless.
  2833. PNG supports modification time via the png_time structure. Two
  2834. conversion routines are provided, png_convert_from_time_t() for
  2835. time_t and png_convert_from_struct_tm() for struct tm. The
  2836. time_t routine uses gmtime(). You don't have to use either of
  2837. these, but if you wish to fill in the png_time structure directly,
  2838. you should provide the time in universal time (GMT) if possible
  2839. instead of your local time. Note that the year number is the full
  2840. year (e.g. 1998, rather than 98 - PNG is year 2000 compliant!), and
  2841. that months start with 1.
  2842. If you want to store the time of the original image creation, you should
  2843. use a plain tEXt chunk with the "Creation Time" keyword. This is
  2844. necessary because the "creation time" of a PNG image is somewhat vague,
  2845. depending on whether you mean the PNG file, the time the image was
  2846. created in a non-PNG format, a still photo from which the image was
  2847. scanned, or possibly the subject matter itself. In order to facilitate
  2848. machine-readable dates, it is recommended that the "Creation Time"
  2849. tEXt chunk use RFC 1123 format dates (e.g. "22 May 1997 18:07:10 GMT"),
  2850. although this isn't a requirement. Unlike the tIME chunk, the
  2851. "Creation Time" tEXt chunk is not expected to be automatically changed
  2852. by the software. To facilitate the use of RFC 1123 dates, a function
  2853. png_convert_to_rfc1123_buffer(buffer, png_timep) is provided to
  2854. convert from PNG time to an RFC 1123 format string. The caller must provide
  2855. a writeable buffer of at least 29 bytes.
  2856. .SS Writing unknown chunks
  2857. You can use the png_set_unknown_chunks function to queue up private chunks
  2858. for writing. You give it a chunk name, location, raw data, and a size. You
  2859. also must use png_set_keep_unknown_chunks() to ensure that libpng will
  2860. handle them. That's all there is to it. The chunks will be written by the
  2861. next following png_write_info_before_PLTE, png_write_info, or png_write_end
  2862. function, depending upon the specified location. Any chunks previously
  2863. read into the info structure's unknown-chunk list will also be written out
  2864. in a sequence that satisfies the PNG specification's ordering rules.
  2865. Here is an example of writing two private chunks, prVt and miNE:
  2866. #ifdef PNG_WRITE_UNKNOWN_CHUNKS_SUPPORTED
  2867. /* Set unknown chunk data */
  2868. png_unknown_chunk unk_chunk[2];
  2869. strcpy((char *) unk_chunk[0].name, "prVt";
  2870. unk_chunk[0].data = (unsigned char *) "PRIVATE DATA";
  2871. unk_chunk[0].size = strlen(unk_chunk[0].data)+1;
  2872. unk_chunk[0].location = PNG_HAVE_IHDR;
  2873. strcpy((char *) unk_chunk[1].name, "miNE";
  2874. unk_chunk[1].data = (unsigned char *) "MY CHUNK DATA";
  2875. unk_chunk[1].size = strlen(unk_chunk[0].data)+1;
  2876. unk_chunk[1].location = PNG_AFTER_IDAT;
  2877. png_set_unknown_chunks(write_ptr, write_info_ptr,
  2878. unk_chunk, 2);
  2879. /* Needed because miNE is not safe-to-copy */
  2880. png_set_keep_unknown_chunks(png, PNG_HANDLE_CHUNK_ALWAYS,
  2881. (png_bytep) "miNE", 1);
  2882. # if PNG_LIBPNG_VER < 10600
  2883. /* Deal with unknown chunk location bug in 1.5.x and earlier */
  2884. png_set_unknown_chunk_location(png, info, 0, PNG_HAVE_IHDR);
  2885. png_set_unknown_chunk_location(png, info, 1, PNG_AFTER_IDAT);
  2886. # endif
  2887. # if PNG_LIBPNG_VER < 10500
  2888. /* PNG_AFTER_IDAT writes two copies of the chunk prior to libpng-1.5.0,
  2889. * one before IDAT and another after IDAT, so don't use it; only use
  2890. * PNG_HAVE_IHDR location. This call resets the location previously
  2891. * set by assignment and png_set_unknown_chunk_location() for chunk 1.
  2892. */
  2893. png_set_unknown_chunk_location(png, info, 1, PNG_HAVE_IHDR);
  2894. # endif
  2895. #endif
  2896. .SS The high-level write interface
  2897. At this point there are two ways to proceed; through the high-level
  2898. write interface, or through a sequence of low-level write operations.
  2899. You can use the high-level interface if your image data is present
  2900. in the info structure. All defined output
  2901. transformations are permitted, enabled by the following masks.
  2902. PNG_TRANSFORM_IDENTITY No transformation
  2903. PNG_TRANSFORM_PACKING Pack 1, 2 and 4-bit samples
  2904. PNG_TRANSFORM_PACKSWAP Change order of packed
  2905. pixels to LSB first
  2906. PNG_TRANSFORM_INVERT_MONO Invert monochrome images
  2907. PNG_TRANSFORM_SHIFT Normalize pixels to the
  2908. sBIT depth
  2909. PNG_TRANSFORM_BGR Flip RGB to BGR, RGBA
  2910. to BGRA
  2911. PNG_TRANSFORM_SWAP_ALPHA Flip RGBA to ARGB or GA
  2912. to AG
  2913. PNG_TRANSFORM_INVERT_ALPHA Change alpha from opacity
  2914. to transparency
  2915. PNG_TRANSFORM_SWAP_ENDIAN Byte-swap 16-bit samples
  2916. PNG_TRANSFORM_STRIP_FILLER Strip out filler
  2917. bytes (deprecated).
  2918. PNG_TRANSFORM_STRIP_FILLER_BEFORE Strip out leading
  2919. filler bytes
  2920. PNG_TRANSFORM_STRIP_FILLER_AFTER Strip out trailing
  2921. filler bytes
  2922. If you have valid image data in the info structure (you can use
  2923. png_set_rows() to put image data in the info structure), simply do this:
  2924. png_write_png(png_ptr, info_ptr, png_transforms, NULL)
  2925. where png_transforms is an integer containing the bitwise OR of some set of
  2926. transformation flags. This call is equivalent to png_write_info(),
  2927. followed the set of transformations indicated by the transform mask,
  2928. then png_write_image(), and finally png_write_end().
  2929. (The final parameter of this call is not yet used. Someday it might point
  2930. to transformation parameters required by some future output transform.)
  2931. You must use png_transforms and not call any png_set_transform() functions
  2932. when you use png_write_png().
  2933. .SS The low-level write interface
  2934. If you are going the low-level route instead, you are now ready to
  2935. write all the file information up to the actual image data. You do
  2936. this with a call to png_write_info().
  2937. png_write_info(png_ptr, info_ptr);
  2938. Note that there is one transformation you may need to do before
  2939. png_write_info(). In PNG files, the alpha channel in an image is the
  2940. level of opacity. If your data is supplied as a level of transparency,
  2941. you can invert the alpha channel before you write it, so that 0 is
  2942. fully transparent and 255 (in 8-bit or paletted images) or 65535
  2943. (in 16-bit images) is fully opaque, with
  2944. png_set_invert_alpha(png_ptr);
  2945. This must appear before png_write_info() instead of later with the
  2946. other transformations because in the case of paletted images the tRNS
  2947. chunk data has to be inverted before the tRNS chunk is written. If
  2948. your image is not a paletted image, the tRNS data (which in such cases
  2949. represents a single color to be rendered as transparent) won't need to
  2950. be changed, and you can safely do this transformation after your
  2951. png_write_info() call.
  2952. If you need to write a private chunk that you want to appear before
  2953. the PLTE chunk when PLTE is present, you can write the PNG info in
  2954. two steps, and insert code to write your own chunk between them:
  2955. png_write_info_before_PLTE(png_ptr, info_ptr);
  2956. png_set_unknown_chunks(png_ptr, info_ptr, ...);
  2957. png_write_info(png_ptr, info_ptr);
  2958. After you've written the file information, you can set up the library
  2959. to handle any special transformations of the image data. The various
  2960. ways to transform the data will be described in the order that they
  2961. should occur. This is important, as some of these change the color
  2962. type and/or bit depth of the data, and some others only work on
  2963. certain color types and bit depths. Even though each transformation
  2964. checks to see if it has data that it can do something with, you should
  2965. make sure to only enable a transformation if it will be valid for the
  2966. data. For example, don't swap red and blue on grayscale data.
  2967. PNG files store RGB pixels packed into 3 or 6 bytes. This code tells
  2968. the library to strip input data that has 4 or 8 bytes per pixel down
  2969. to 3 or 6 bytes (or strip 2 or 4-byte grayscale+filler data to 1 or 2
  2970. bytes per pixel).
  2971. png_set_filler(png_ptr, 0, PNG_FILLER_BEFORE);
  2972. where the 0 is unused, and the location is either PNG_FILLER_BEFORE or
  2973. PNG_FILLER_AFTER, depending upon whether the filler byte in the pixel
  2974. is stored XRGB or RGBX.
  2975. PNG files pack pixels of bit depths 1, 2, and 4 into bytes as small as
  2976. they can, resulting in, for example, 8 pixels per byte for 1 bit files.
  2977. If the data is supplied at 1 pixel per byte, use this code, which will
  2978. correctly pack the pixels into a single byte:
  2979. png_set_packing(png_ptr);
  2980. PNG files reduce possible bit depths to 1, 2, 4, 8, and 16. If your
  2981. data is of another bit depth, you can write an sBIT chunk into the
  2982. file so that decoders can recover the original data if desired.
  2983. /* Set the true bit depth of the image data */
  2984. if (color_type & PNG_COLOR_MASK_COLOR)
  2985. {
  2986. sig_bit.red = true_bit_depth;
  2987. sig_bit.green = true_bit_depth;
  2988. sig_bit.blue = true_bit_depth;
  2989. }
  2990. else
  2991. {
  2992. sig_bit.gray = true_bit_depth;
  2993. }
  2994. if (color_type & PNG_COLOR_MASK_ALPHA)
  2995. {
  2996. sig_bit.alpha = true_bit_depth;
  2997. }
  2998. png_set_sBIT(png_ptr, info_ptr, &sig_bit);
  2999. If the data is stored in the row buffer in a bit depth other than
  3000. one supported by PNG (e.g. 3 bit data in the range 0-7 for a 4-bit PNG),
  3001. this will scale the values to appear to be the correct bit depth as
  3002. is required by PNG.
  3003. png_set_shift(png_ptr, &sig_bit);
  3004. PNG files store 16-bit pixels in network byte order (big-endian,
  3005. ie. most significant bits first). This code would be used if they are
  3006. supplied the other way (little-endian, i.e. least significant bits
  3007. first, the way PCs store them):
  3008. if (bit_depth > 8)
  3009. png_set_swap(png_ptr);
  3010. If you are using packed-pixel images (1, 2, or 4 bits/pixel), and you
  3011. need to change the order the pixels are packed into bytes, you can use:
  3012. if (bit_depth < 8)
  3013. png_set_packswap(png_ptr);
  3014. PNG files store 3 color pixels in red, green, blue order. This code
  3015. would be used if they are supplied as blue, green, red:
  3016. png_set_bgr(png_ptr);
  3017. PNG files describe monochrome as black being zero and white being
  3018. one. This code would be used if the pixels are supplied with this reversed
  3019. (black being one and white being zero):
  3020. png_set_invert_mono(png_ptr);
  3021. Finally, you can write your own transformation function if none of
  3022. the existing ones meets your needs. This is done by setting a callback
  3023. with
  3024. png_set_write_user_transform_fn(png_ptr,
  3025. write_transform_fn);
  3026. You must supply the function
  3027. void write_transform_fn(png_structp png_ptr, png_row_infop
  3028. row_info, png_bytep data)
  3029. See pngtest.c for a working example. Your function will be called
  3030. before any of the other transformations are processed. If supported
  3031. libpng also supplies an information routine that may be called from
  3032. your callback:
  3033. png_get_current_row_number(png_ptr);
  3034. png_get_current_pass_number(png_ptr);
  3035. This returns the current row passed to the transform. With interlaced
  3036. images the value returned is the row in the input sub-image image. Use
  3037. PNG_ROW_FROM_PASS_ROW(row, pass) and PNG_COL_FROM_PASS_COL(col, pass) to
  3038. find the output pixel (x,y) given an interlaced sub-image pixel (row,col,pass).
  3039. The discussion of interlace handling above contains more information on how to
  3040. use these values.
  3041. You can also set up a pointer to a user structure for use by your
  3042. callback function.
  3043. png_set_user_transform_info(png_ptr, user_ptr, 0, 0);
  3044. The user_channels and user_depth parameters of this function are ignored
  3045. when writing; you can set them to zero as shown.
  3046. You can retrieve the pointer via the function png_get_user_transform_ptr().
  3047. For example:
  3048. voidp write_user_transform_ptr =
  3049. png_get_user_transform_ptr(png_ptr);
  3050. It is possible to have libpng flush any pending output, either manually,
  3051. or automatically after a certain number of lines have been written. To
  3052. flush the output stream a single time call:
  3053. png_write_flush(png_ptr);
  3054. and to have libpng flush the output stream periodically after a certain
  3055. number of scanlines have been written, call:
  3056. png_set_flush(png_ptr, nrows);
  3057. Note that the distance between rows is from the last time png_write_flush()
  3058. was called, or the first row of the image if it has never been called.
  3059. So if you write 50 lines, and then png_set_flush 25, it will flush the
  3060. output on the next scanline, and every 25 lines thereafter, unless
  3061. png_write_flush() is called before 25 more lines have been written.
  3062. If nrows is too small (less than about 10 lines for a 640 pixel wide
  3063. RGB image) the image compression may decrease noticeably (although this
  3064. may be acceptable for real-time applications). Infrequent flushing will
  3065. only degrade the compression performance by a few percent over images
  3066. that do not use flushing.
  3067. .SS Writing the image data
  3068. That's it for the transformations. Now you can write the image data.
  3069. The simplest way to do this is in one function call. If you have the
  3070. whole image in memory, you can just call png_write_image() and libpng
  3071. will write the image. You will need to pass in an array of pointers to
  3072. each row. This function automatically handles interlacing, so you don't
  3073. need to call png_set_interlace_handling() or call this function multiple
  3074. times, or any of that other stuff necessary with png_write_rows().
  3075. png_write_image(png_ptr, row_pointers);
  3076. where row_pointers is:
  3077. png_byte *row_pointers[height];
  3078. You can point to void or char or whatever you use for pixels.
  3079. If you don't want to write the whole image at once, you can
  3080. use png_write_rows() instead. If the file is not interlaced,
  3081. this is simple:
  3082. png_write_rows(png_ptr, row_pointers,
  3083. number_of_rows);
  3084. row_pointers is the same as in the png_write_image() call.
  3085. If you are just writing one row at a time, you can do this with
  3086. a single row_pointer instead of an array of row_pointers:
  3087. png_bytep row_pointer = row;
  3088. png_write_row(png_ptr, row_pointer);
  3089. When the file is interlaced, things can get a good deal more complicated.
  3090. The only currently (as of the PNG Specification version 1.2, dated July
  3091. 1999) defined interlacing scheme for PNG files is the "Adam7" interlace
  3092. scheme, that breaks down an image into seven smaller images of varying
  3093. size. libpng will build these images for you, or you can do them
  3094. yourself. If you want to build them yourself, see the PNG specification
  3095. for details of which pixels to write when.
  3096. If you don't want libpng to handle the interlacing details, just
  3097. use png_set_interlace_handling() and call png_write_rows() the
  3098. correct number of times to write all the sub-images
  3099. (png_set_interlace_handling() returns the number of sub-images.)
  3100. If you want libpng to build the sub-images, call this before you start
  3101. writing any rows:
  3102. number_of_passes = png_set_interlace_handling(png_ptr);
  3103. This will return the number of passes needed. Currently, this is seven,
  3104. but may change if another interlace type is added.
  3105. Then write the complete image number_of_passes times.
  3106. png_write_rows(png_ptr, row_pointers, number_of_rows);
  3107. Think carefully before you write an interlaced image. Typically code that
  3108. reads such images reads all the image data into memory, uncompressed, before
  3109. doing any processing. Only code that can display an image on the fly can
  3110. take advantage of the interlacing and even then the image has to be exactly
  3111. the correct size for the output device, because scaling an image requires
  3112. adjacent pixels and these are not available until all the passes have been
  3113. read.
  3114. If you do write an interlaced image you will hardly ever need to handle
  3115. the interlacing yourself. Call png_set_interlace_handling() and use the
  3116. approach described above.
  3117. The only time it is conceivable that you will really need to write an
  3118. interlaced image pass-by-pass is when you have read one pass by pass and
  3119. made some pixel-by-pixel transformation to it, as described in the read
  3120. code above. In this case use the PNG_PASS_ROWS and PNG_PASS_COLS macros
  3121. to determine the size of each sub-image in turn and simply write the rows
  3122. you obtained from the read code.
  3123. .SS Finishing a sequential write
  3124. After you are finished writing the image, you should finish writing
  3125. the file. If you are interested in writing comments or time, you should
  3126. pass an appropriately filled png_info pointer. If you are not interested,
  3127. you can pass NULL.
  3128. png_write_end(png_ptr, info_ptr);
  3129. When you are done, you can free all memory used by libpng like this:
  3130. png_destroy_write_struct(&png_ptr, &info_ptr);
  3131. It is also possible to individually free the info_ptr members that
  3132. point to libpng-allocated storage with the following function:
  3133. png_free_data(png_ptr, info_ptr, mask, seq)
  3134. mask - identifies data to be freed, a mask
  3135. containing the bitwise OR of one or
  3136. more of
  3137. PNG_FREE_PLTE, PNG_FREE_TRNS,
  3138. PNG_FREE_HIST, PNG_FREE_ICCP,
  3139. PNG_FREE_PCAL, PNG_FREE_ROWS,
  3140. PNG_FREE_SCAL, PNG_FREE_SPLT,
  3141. PNG_FREE_TEXT, PNG_FREE_UNKN,
  3142. or simply PNG_FREE_ALL
  3143. seq - sequence number of item to be freed
  3144. (\-1 for all items)
  3145. This function may be safely called when the relevant storage has
  3146. already been freed, or has not yet been allocated, or was allocated
  3147. by the user and not by libpng, and will in those cases do nothing.
  3148. The "seq" parameter is ignored if only one item of the selected data
  3149. type, such as PLTE, is allowed. If "seq" is not \-1, and multiple items
  3150. are allowed for the data type identified in the mask, such as text or
  3151. sPLT, only the n'th item in the structure is freed, where n is "seq".
  3152. If you allocated data such as a palette that you passed in to libpng
  3153. with png_set_*, you must not free it until just before the call to
  3154. png_destroy_write_struct().
  3155. The default behavior is only to free data that was allocated internally
  3156. by libpng. This can be changed, so that libpng will not free the data,
  3157. or so that it will free data that was allocated by the user with png_malloc()
  3158. or png_calloc() and passed in via a png_set_*() function, with
  3159. png_data_freer(png_ptr, info_ptr, freer, mask)
  3160. freer - one of
  3161. PNG_DESTROY_WILL_FREE_DATA
  3162. PNG_SET_WILL_FREE_DATA
  3163. PNG_USER_WILL_FREE_DATA
  3164. mask - which data elements are affected
  3165. same choices as in png_free_data()
  3166. For example, to transfer responsibility for some data from a read structure
  3167. to a write structure, you could use
  3168. png_data_freer(read_ptr, read_info_ptr,
  3169. PNG_USER_WILL_FREE_DATA,
  3170. PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST)
  3171. png_data_freer(write_ptr, write_info_ptr,
  3172. PNG_DESTROY_WILL_FREE_DATA,
  3173. PNG_FREE_PLTE|PNG_FREE_tRNS|PNG_FREE_hIST)
  3174. thereby briefly reassigning responsibility for freeing to the user but
  3175. immediately afterwards reassigning it once more to the write_destroy
  3176. function. Having done this, it would then be safe to destroy the read
  3177. structure and continue to use the PLTE, tRNS, and hIST data in the write
  3178. structure.
  3179. This function only affects data that has already been allocated.
  3180. You can call this function before calling after the png_set_*() functions
  3181. to control whether the user or png_destroy_*() is supposed to free the data.
  3182. When the user assumes responsibility for libpng-allocated data, the
  3183. application must use
  3184. png_free() to free it, and when the user transfers responsibility to libpng
  3185. for data that the user has allocated, the user must have used png_malloc()
  3186. or png_calloc() to allocate it.
  3187. If you allocated text_ptr.text, text_ptr.lang, and text_ptr.translated_keyword
  3188. separately, do not transfer responsibility for freeing text_ptr to libpng,
  3189. because when libpng fills a png_text structure it combines these members with
  3190. the key member, and png_free_data() will free only text_ptr.key. Similarly,
  3191. if you transfer responsibility for free'ing text_ptr from libpng to your
  3192. application, your application must not separately free those members.
  3193. For a more compact example of writing a PNG image, see the file example.c.
  3194. .SH V. Simplified API
  3195. The simplified API, which became available in libpng-1.6.0, hides the details
  3196. of both libpng and the PNG file format itself.
  3197. It allows PNG files to be read into a very limited number of
  3198. in-memory bitmap formats or to be written from the same formats. If these
  3199. formats do not accommodate your needs then you can, and should, use the more
  3200. sophisticated APIs above - these support a wide variety of in-memory formats
  3201. and a wide variety of sophisticated transformations to those formats as well
  3202. as a wide variety of APIs to manipulate ancillary information.
  3203. To read a PNG file using the simplified API:
  3204. 1) Declare a 'png_image' structure (see below) on the stack, set the
  3205. version field to PNG_IMAGE_VERSION and the 'opaque' pointer to NULL
  3206. (this is REQUIRED, your program may crash if you don't do it.)
  3207. 2) Call the appropriate png_image_begin_read... function.
  3208. 3) Set the png_image 'format' member to the required sample format.
  3209. 4) Allocate a buffer for the image and, if required, the color-map.
  3210. 5) Call png_image_finish_read to read the image and, if required, the
  3211. color-map into your buffers.
  3212. There are no restrictions on the format of the PNG input itself; all valid
  3213. color types, bit depths, and interlace methods are acceptable, and the
  3214. input image is transformed as necessary to the requested in-memory format
  3215. during the png_image_finish_read() step. The only caveat is that if you
  3216. request a color-mapped image from a PNG that is full-color or makes
  3217. complex use of an alpha channel the transformation is extremely lossy and the
  3218. result may look terrible.
  3219. To write a PNG file using the simplified API:
  3220. 1) Declare a 'png_image' structure on the stack and memset()
  3221. it to all zero.
  3222. 2) Initialize the members of the structure that describe the
  3223. image, setting the 'format' member to the format of the
  3224. image samples.
  3225. 3) Call the appropriate png_image_write... function with a
  3226. pointer to the image and, if necessary, the color-map to write
  3227. the PNG data.
  3228. png_image is a structure that describes the in-memory format of an image
  3229. when it is being read or defines the in-memory format of an image that you
  3230. need to write. The "png_image" structure contains the following members:
  3231. png_controlp opaque Initialize to NULL, free with png_image_free
  3232. png_uint_32 version Set to PNG_IMAGE_VERSION
  3233. png_uint_32 width Image width in pixels (columns)
  3234. png_uint_32 height Image height in pixels (rows)
  3235. png_uint_32 format Image format as defined below
  3236. png_uint_32 flags A bit mask containing informational flags
  3237. png_uint_32 colormap_entries; Number of entries in the color-map
  3238. png_uint_32 warning_or_error;
  3239. char message[64];
  3240. In the event of an error or warning the "warning_or_error"
  3241. field will be set to a non-zero value and the 'message' field will contain
  3242. a '\0' terminated string with the libpng error or warning message. If both
  3243. warnings and an error were encountered, only the error is recorded. If there
  3244. are multiple warnings, only the first one is recorded.
  3245. The upper 30 bits of the "warning_or_error" value are reserved; the low two
  3246. bits contain a two bit code such that a value more than 1 indicates a failure
  3247. in the API just called:
  3248. 0 - no warning or error
  3249. 1 - warning
  3250. 2 - error
  3251. 3 - error preceded by warning
  3252. The pixels (samples) of the image have one to four channels whose components
  3253. have original values in the range 0 to 1.0:
  3254. 1: A single gray or luminance channel (G).
  3255. 2: A gray/luminance channel and an alpha channel (GA).
  3256. 3: Three red, green, blue color channels (RGB).
  3257. 4: Three color channels and an alpha channel (RGBA).
  3258. The channels are encoded in one of two ways:
  3259. a) As a small integer, value 0..255, contained in a single byte. For the
  3260. alpha channel the original value is simply value/255. For the color or
  3261. luminance channels the value is encoded according to the sRGB specification
  3262. and matches the 8-bit format expected by typical display devices.
  3263. The color/gray channels are not scaled (pre-multiplied) by the alpha
  3264. channel and are suitable for passing to color management software.
  3265. b) As a value in the range 0..65535, contained in a 2-byte integer, in
  3266. the native byte order of the platform on which the application is running.
  3267. All channels can be converted to the original value by dividing by 65535; all
  3268. channels are linear. Color channels use the RGB encoding (RGB end-points) of
  3269. the sRGB specification. This encoding is identified by the
  3270. PNG_FORMAT_FLAG_LINEAR flag below.
  3271. When the simplified API needs to convert between sRGB and linear colorspaces,
  3272. the actual sRGB transfer curve defined in the sRGB specification (see the
  3273. article at https://en.wikipedia.org/wiki/SRGB) is used, not the gamma=1/2.2
  3274. approximation used elsewhere in libpng.
  3275. When an alpha channel is present it is expected to denote pixel coverage
  3276. of the color or luminance channels and is returned as an associated alpha
  3277. channel: the color/gray channels are scaled (pre-multiplied) by the alpha
  3278. value.
  3279. The samples are either contained directly in the image data, between 1 and 8
  3280. bytes per pixel according to the encoding, or are held in a color-map indexed
  3281. by bytes in the image data. In the case of a color-map the color-map entries
  3282. are individual samples, encoded as above, and the image data has one byte per
  3283. pixel to select the relevant sample from the color-map.
  3284. PNG_FORMAT_*
  3285. The #defines to be used in png_image::format. Each #define identifies a
  3286. particular layout of channel data and, if present, alpha values. There are
  3287. separate defines for each of the two component encodings.
  3288. A format is built up using single bit flag values. All combinations are
  3289. valid. Formats can be built up from the flag values or you can use one of
  3290. the predefined values below. When testing formats always use the FORMAT_FLAG
  3291. macros to test for individual features - future versions of the library may
  3292. add new flags.
  3293. When reading or writing color-mapped images the format should be set to the
  3294. format of the entries in the color-map then png_image_{read,write}_colormap
  3295. called to read or write the color-map and set the format correctly for the
  3296. image data. Do not set the PNG_FORMAT_FLAG_COLORMAP bit directly!
  3297. NOTE: libpng can be built with particular features disabled. If you see
  3298. compiler errors because the definition of one of the following flags has been
  3299. compiled out it is because libpng does not have the required support. It is
  3300. possible, however, for the libpng configuration to enable the format on just
  3301. read or just write; in that case you may see an error at run time.
  3302. You can guard against this by checking for the definition of the
  3303. appropriate "_SUPPORTED" macro, one of:
  3304. PNG_SIMPLIFIED_{READ,WRITE}_{BGR,AFIRST}_SUPPORTED
  3305. PNG_FORMAT_FLAG_ALPHA format with an alpha channel
  3306. PNG_FORMAT_FLAG_COLOR color format: otherwise grayscale
  3307. PNG_FORMAT_FLAG_LINEAR 2-byte channels else 1-byte
  3308. PNG_FORMAT_FLAG_COLORMAP image data is color-mapped
  3309. PNG_FORMAT_FLAG_BGR BGR colors, else order is RGB
  3310. PNG_FORMAT_FLAG_AFIRST alpha channel comes first
  3311. Supported formats are as follows. Future versions of libpng may support more
  3312. formats; for compatibility with older versions simply check if the format
  3313. macro is defined using #ifdef. These defines describe the in-memory layout
  3314. of the components of the pixels of the image.
  3315. First the single byte (sRGB) formats:
  3316. PNG_FORMAT_GRAY
  3317. PNG_FORMAT_GA
  3318. PNG_FORMAT_AG
  3319. PNG_FORMAT_RGB
  3320. PNG_FORMAT_BGR
  3321. PNG_FORMAT_RGBA
  3322. PNG_FORMAT_ARGB
  3323. PNG_FORMAT_BGRA
  3324. PNG_FORMAT_ABGR
  3325. Then the linear 2-byte formats. When naming these "Y" is used to
  3326. indicate a luminance (gray) channel. The component order within the pixel
  3327. is always the same - there is no provision for swapping the order of the
  3328. components in the linear format. The components are 16-bit integers in
  3329. the native byte order for your platform, and there is no provision for
  3330. swapping the bytes to a different endian condition.
  3331. PNG_FORMAT_LINEAR_Y
  3332. PNG_FORMAT_LINEAR_Y_ALPHA
  3333. PNG_FORMAT_LINEAR_RGB
  3334. PNG_FORMAT_LINEAR_RGB_ALPHA
  3335. With color-mapped formats the image data is one byte for each pixel. The byte
  3336. is an index into the color-map which is formatted as above. To obtain a
  3337. color-mapped format it is sufficient just to add the PNG_FOMAT_FLAG_COLORMAP
  3338. to one of the above definitions, or you can use one of the definitions below.
  3339. PNG_FORMAT_RGB_COLORMAP
  3340. PNG_FORMAT_BGR_COLORMAP
  3341. PNG_FORMAT_RGBA_COLORMAP
  3342. PNG_FORMAT_ARGB_COLORMAP
  3343. PNG_FORMAT_BGRA_COLORMAP
  3344. PNG_FORMAT_ABGR_COLORMAP
  3345. PNG_IMAGE macros
  3346. These are convenience macros to derive information from a png_image
  3347. structure. The PNG_IMAGE_SAMPLE_ macros return values appropriate to the
  3348. actual image sample values - either the entries in the color-map or the
  3349. pixels in the image. The PNG_IMAGE_PIXEL_ macros return corresponding values
  3350. for the pixels and will always return 1 for color-mapped formats. The
  3351. remaining macros return information about the rows in the image and the
  3352. complete image.
  3353. NOTE: All the macros that take a png_image::format parameter are compile time
  3354. constants if the format parameter is, itself, a constant. Therefore these
  3355. macros can be used in array declarations and case labels where required.
  3356. Similarly the macros are also pre-processor constants (sizeof is not used) so
  3357. they can be used in #if tests.
  3358. PNG_IMAGE_SAMPLE_CHANNELS(fmt)
  3359. Returns the total number of channels in a given format: 1..4
  3360. PNG_IMAGE_SAMPLE_COMPONENT_SIZE(fmt)
  3361. Returns the size in bytes of a single component of a pixel or color-map
  3362. entry (as appropriate) in the image: 1 or 2.
  3363. PNG_IMAGE_SAMPLE_SIZE(fmt)
  3364. This is the size of the sample data for one sample. If the image is
  3365. color-mapped it is the size of one color-map entry (and image pixels are
  3366. one byte in size), otherwise it is the size of one image pixel.
  3367. PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(fmt)
  3368. The maximum size of the color-map required by the format expressed in a
  3369. count of components. This can be used to compile-time allocate a
  3370. color-map:
  3371. png_uint_16 colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(linear_fmt)];
  3372. png_byte colormap[PNG_IMAGE_MAXIMUM_COLORMAP_COMPONENTS(sRGB_fmt)];
  3373. Alternatively use the PNG_IMAGE_COLORMAP_SIZE macro below to use the
  3374. information from one of the png_image_begin_read_ APIs and dynamically
  3375. allocate the required memory.
  3376. PNG_IMAGE_COLORMAP_SIZE(fmt)
  3377. The size of the color-map required by the format; this is the size of the
  3378. color-map buffer passed to the png_image_{read,write}_colormap APIs. It is
  3379. a fixed number determined by the format so can easily be allocated on the
  3380. stack if necessary.
  3381. Corresponding information about the pixels
  3382. PNG_IMAGE_PIXEL_CHANNELS(fmt)
  3383. The number of separate channels (components) in a pixel; 1 for a
  3384. color-mapped image.
  3385. PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)\
  3386. The size, in bytes, of each component in a pixel; 1 for a color-mapped
  3387. image.
  3388. PNG_IMAGE_PIXEL_SIZE(fmt)
  3389. The size, in bytes, of a complete pixel; 1 for a color-mapped image.
  3390. Information about the whole row, or whole image
  3391. PNG_IMAGE_ROW_STRIDE(image)
  3392. Returns the total number of components in a single row of the image; this
  3393. is the minimum 'row stride', the minimum count of components between each
  3394. row. For a color-mapped image this is the minimum number of bytes in a
  3395. row.
  3396. If you need the stride measured in bytes, row_stride_bytes is
  3397. PNG_IMAGE_ROW_STRIDE(image) * PNG_IMAGE_PIXEL_COMPONENT_SIZE(fmt)
  3398. plus any padding bytes that your application might need, for example
  3399. to start the next row on a 4-byte boundary.
  3400. PNG_IMAGE_BUFFER_SIZE(image, row_stride)
  3401. Return the size, in bytes, of an image buffer given a png_image and a row
  3402. stride - the number of components to leave space for in each row.
  3403. PNG_IMAGE_SIZE(image)
  3404. Return the size, in bytes, of the image in memory given just a png_image;
  3405. the row stride is the minimum stride required for the image.
  3406. PNG_IMAGE_COLORMAP_SIZE(image)
  3407. Return the size, in bytes, of the color-map of this image. If the image
  3408. format is not a color-map format this will return a size sufficient for
  3409. 256 entries in the given format; check PNG_FORMAT_FLAG_COLORMAP if
  3410. you don't want to allocate a color-map in this case.
  3411. PNG_IMAGE_FLAG_*
  3412. Flags containing additional information about the image are held in
  3413. the 'flags' field of png_image.
  3414. PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB == 0x01
  3415. This indicates that the RGB values of the in-memory bitmap do not
  3416. correspond to the red, green and blue end-points defined by sRGB.
  3417. PNG_IMAGE_FLAG_FAST == 0x02
  3418. On write emphasise speed over compression; the resultant PNG file will be
  3419. larger but will be produced significantly faster, particular for large
  3420. images. Do not use this option for images which will be distributed, only
  3421. used it when producing intermediate files that will be read back in
  3422. repeatedly. For a typical 24-bit image the option will double the read
  3423. speed at the cost of increasing the image size by 25%, however for many
  3424. more compressible images the PNG file can be 10 times larger with only a
  3425. slight speed gain.
  3426. PNG_IMAGE_FLAG_16BIT_sRGB == 0x04
  3427. On read if the image is a 16-bit per component image and there is no gAMA
  3428. or sRGB chunk assume that the components are sRGB encoded. Notice that
  3429. images output by the simplified API always have gamma information; setting
  3430. this flag only affects the interpretation of 16-bit images from an
  3431. external source. It is recommended that the application expose this flag
  3432. to the user; the user can normally easily recognize the difference between
  3433. linear and sRGB encoding. This flag has no effect on write - the data
  3434. passed to the write APIs must have the correct encoding (as defined
  3435. above.)
  3436. If the flag is not set (the default) input 16-bit per component data is
  3437. assumed to be linear.
  3438. NOTE: the flag can only be set after the png_image_begin_read_ call,
  3439. because that call initializes the 'flags' field.
  3440. READ APIs
  3441. The png_image passed to the read APIs must have been initialized by setting
  3442. the png_controlp field 'opaque' to NULL (or, better, memset the whole thing.)
  3443. int png_image_begin_read_from_file( png_imagep image,
  3444. const char *file_name)
  3445. The named file is opened for read and the image header
  3446. is filled in from the PNG header in the file.
  3447. int png_image_begin_read_from_stdio (png_imagep image,
  3448. FILE* file)
  3449. The PNG header is read from the stdio FILE object.
  3450. int png_image_begin_read_from_memory(png_imagep image,
  3451. png_const_voidp memory, size_t size)
  3452. The PNG header is read from the given memory buffer.
  3453. int png_image_finish_read(png_imagep image,
  3454. png_colorp background, void *buffer,
  3455. png_int_32 row_stride, void *colormap));
  3456. Finish reading the image into the supplied buffer and
  3457. clean up the png_image structure.
  3458. row_stride is the step, in png_byte or png_uint_16 units
  3459. as appropriate, between adjacent rows. A positive stride
  3460. indicates that the top-most row is first in the buffer -
  3461. the normal top-down arrangement. A negative stride
  3462. indicates that the bottom-most row is first in the buffer.
  3463. background need only be supplied if an alpha channel must
  3464. be removed from a png_byte format and the removal is to be
  3465. done by compositing on a solid color; otherwise it may be
  3466. NULL and any composition will be done directly onto the
  3467. buffer. The value is an sRGB color to use for the
  3468. background, for grayscale output the green channel is used.
  3469. For linear output removing the alpha channel is always done
  3470. by compositing on black.
  3471. void png_image_free(png_imagep image)
  3472. Free any data allocated by libpng in image->opaque,
  3473. setting the pointer to NULL. May be called at any time
  3474. after the structure is initialized.
  3475. When the simplified API needs to convert between sRGB and linear colorspaces,
  3476. the actual sRGB transfer curve defined in the sRGB specification (see the
  3477. article at https://en.wikipedia.org/wiki/SRGB) is used, not the gamma=1/2.2
  3478. approximation used elsewhere in libpng.
  3479. WRITE APIS
  3480. For write you must initialize a png_image structure to describe the image to
  3481. be written:
  3482. version: must be set to PNG_IMAGE_VERSION
  3483. opaque: must be initialized to NULL
  3484. width: image width in pixels
  3485. height: image height in rows
  3486. format: the format of the data you wish to write
  3487. flags: set to 0 unless one of the defined flags applies; set
  3488. PNG_IMAGE_FLAG_COLORSPACE_NOT_sRGB for color format images
  3489. where the RGB values do not correspond to the colors in sRGB.
  3490. colormap_entries: set to the number of entries in the color-map (0 to 256)
  3491. int png_image_write_to_file, (png_imagep image,
  3492. const char *file, int convert_to_8bit, const void *buffer,
  3493. png_int_32 row_stride, const void *colormap));
  3494. Write the image to the named file.
  3495. int png_image_write_to_memory (png_imagep image, void *memory,
  3496. png_alloc_size_t * PNG_RESTRICT memory_bytes,
  3497. int convert_to_8_bit, const void *buffer, ptrdiff_t row_stride,
  3498. const void *colormap));
  3499. Write the image to memory.
  3500. int png_image_write_to_stdio(png_imagep image, FILE *file,
  3501. int convert_to_8_bit, const void *buffer,
  3502. png_int_32 row_stride, const void *colormap)
  3503. Write the image to the given (FILE*).
  3504. With all write APIs if image is in one of the linear formats with
  3505. (png_uint_16) data then setting convert_to_8_bit will cause the output to be
  3506. a (png_byte) PNG gamma encoded according to the sRGB specification, otherwise
  3507. a 16-bit linear encoded PNG file is written.
  3508. With all APIs row_stride is handled as in the read APIs - it is the spacing
  3509. from one row to the next in component sized units (float) and if negative
  3510. indicates a bottom-up row layout in the buffer. If you pass zero, libpng will
  3511. calculate the row_stride for you from the width and number of channels.
  3512. Note that the write API does not support interlacing, sub-8-bit pixels,
  3513. indexed (paletted) images, or most ancillary chunks.
  3514. .SH VI. Modifying/Customizing libpng
  3515. There are two issues here. The first is changing how libpng does
  3516. standard things like memory allocation, input/output, and error handling.
  3517. The second deals with more complicated things like adding new chunks,
  3518. adding new transformations, and generally changing how libpng works.
  3519. Both of those are compile-time issues; that is, they are generally
  3520. determined at the time the code is written, and there is rarely a need
  3521. to provide the user with a means of changing them.
  3522. Memory allocation, input/output, and error handling
  3523. All of the memory allocation, input/output, and error handling in libpng
  3524. goes through callbacks that are user-settable. The default routines are
  3525. in pngmem.c, pngrio.c, pngwio.c, and pngerror.c, respectively. To change
  3526. these functions, call the appropriate png_set_*_fn() function.
  3527. Memory allocation is done through the functions png_malloc(), png_calloc(),
  3528. and png_free(). The png_malloc() and png_free() functions currently just
  3529. call the standard C functions and png_calloc() calls png_malloc() and then
  3530. clears the newly allocated memory to zero; note that png_calloc(png_ptr, size)
  3531. is not the same as the calloc(number, size) function provided by stdlib.h.
  3532. There is limited support for certain systems with segmented memory
  3533. architectures and the types of pointers declared by png.h match this; you
  3534. will have to use appropriate pointers in your application. If you prefer
  3535. to use a different method of allocating and freeing data, you can use
  3536. png_create_read_struct_2() or png_create_write_struct_2() to register your
  3537. own functions as described above. These functions also provide a void
  3538. pointer that can be retrieved via
  3539. mem_ptr=png_get_mem_ptr(png_ptr);
  3540. Your replacement memory functions must have prototypes as follows:
  3541. png_voidp malloc_fn(png_structp png_ptr,
  3542. png_alloc_size_t size);
  3543. void free_fn(png_structp png_ptr, png_voidp ptr);
  3544. Your malloc_fn() must return NULL in case of failure. The png_malloc()
  3545. function will normally call png_error() if it receives a NULL from the
  3546. system memory allocator or from your replacement malloc_fn().
  3547. Your free_fn() will never be called with a NULL ptr, since libpng's
  3548. png_free() checks for NULL before calling free_fn().
  3549. Input/Output in libpng is done through png_read() and png_write(),
  3550. which currently just call fread() and fwrite(). The FILE * is stored in
  3551. png_struct and is initialized via png_init_io(). If you wish to change
  3552. the method of I/O, the library supplies callbacks that you can set
  3553. through the function png_set_read_fn() and png_set_write_fn() at run
  3554. time, instead of calling the png_init_io() function. These functions
  3555. also provide a void pointer that can be retrieved via the function
  3556. png_get_io_ptr(). For example:
  3557. png_set_read_fn(png_structp read_ptr,
  3558. voidp read_io_ptr, png_rw_ptr read_data_fn)
  3559. png_set_write_fn(png_structp write_ptr,
  3560. voidp write_io_ptr, png_rw_ptr write_data_fn,
  3561. png_flush_ptr output_flush_fn);
  3562. voidp read_io_ptr = png_get_io_ptr(read_ptr);
  3563. voidp write_io_ptr = png_get_io_ptr(write_ptr);
  3564. The replacement I/O functions must have prototypes as follows:
  3565. void user_read_data(png_structp png_ptr,
  3566. png_bytep data, size_t length);
  3567. void user_write_data(png_structp png_ptr,
  3568. png_bytep data, size_t length);
  3569. void user_flush_data(png_structp png_ptr);
  3570. The user_read_data() function is responsible for detecting and
  3571. handling end-of-data errors.
  3572. Supplying NULL for the read, write, or flush functions sets them back
  3573. to using the default C stream functions, which expect the io_ptr to
  3574. point to a standard *FILE structure. It is probably a mistake
  3575. to use NULL for one of write_data_fn and output_flush_fn but not both
  3576. of them, unless you have built libpng with PNG_NO_WRITE_FLUSH defined.
  3577. It is an error to read from a write stream, and vice versa.
  3578. Error handling in libpng is done through png_error() and png_warning().
  3579. Errors handled through png_error() are fatal, meaning that png_error()
  3580. should never return to its caller. Currently, this is handled via
  3581. setjmp() and longjmp() (unless you have compiled libpng with
  3582. PNG_NO_SETJMP, in which case it is handled via PNG_ABORT()),
  3583. but you could change this to do things like exit() if you should wish,
  3584. as long as your function does not return.
  3585. On non-fatal errors, png_warning() is called
  3586. to print a warning message, and then control returns to the calling code.
  3587. By default png_error() and png_warning() print a message on stderr via
  3588. fprintf() unless the library is compiled with PNG_NO_CONSOLE_IO defined
  3589. (because you don't want the messages) or PNG_NO_STDIO defined (because
  3590. fprintf() isn't available). If you wish to change the behavior of the error
  3591. functions, you will need to set up your own message callbacks. These
  3592. functions are normally supplied at the time that the png_struct is created.
  3593. It is also possible to redirect errors and warnings to your own replacement
  3594. functions after png_create_*_struct() has been called by calling:
  3595. png_set_error_fn(png_structp png_ptr,
  3596. png_voidp error_ptr, png_error_ptr error_fn,
  3597. png_error_ptr warning_fn);
  3598. If NULL is supplied for either error_fn or warning_fn, then the libpng
  3599. default function will be used, calling fprintf() and/or longjmp() if a
  3600. problem is encountered. The replacement error functions should have
  3601. parameters as follows:
  3602. void user_error_fn(png_structp png_ptr,
  3603. png_const_charp error_msg);
  3604. void user_warning_fn(png_structp png_ptr,
  3605. png_const_charp warning_msg);
  3606. Then, within your user_error_fn or user_warning_fn, you can retrieve
  3607. the error_ptr if you need it, by calling
  3608. png_voidp error_ptr = png_get_error_ptr(png_ptr);
  3609. The motivation behind using setjmp() and longjmp() is the C++ throw and
  3610. catch exception handling methods. This makes the code much easier to write,
  3611. as there is no need to check every return code of every function call.
  3612. However, there are some uncertainties about the status of local variables
  3613. after a longjmp, so the user may want to be careful about doing anything
  3614. after setjmp returns non-zero besides returning itself. Consult your
  3615. compiler documentation for more details. For an alternative approach, you
  3616. may wish to use the "cexcept" facility (see https://cexcept.sourceforge.io/),
  3617. which is illustrated in pngvalid.c and in contrib/visupng.
  3618. Beginning in libpng-1.4.0, the png_set_benign_errors() API became available.
  3619. You can use this to handle certain errors (normally handled as errors)
  3620. as warnings.
  3621. png_set_benign_errors (png_ptr, int allowed);
  3622. allowed: 0: treat png_benign_error() as an error.
  3623. 1: treat png_benign_error() as a warning.
  3624. As of libpng-1.6.0, the default condition is to treat benign errors as
  3625. warnings while reading and as errors while writing.
  3626. .SS Custom chunks
  3627. If you need to read or write custom chunks, you may need to get deeper
  3628. into the libpng code. The library now has mechanisms for storing
  3629. and writing chunks of unknown type; you can even declare callbacks
  3630. for custom chunks. However, this may not be good enough if the
  3631. library code itself needs to know about interactions between your
  3632. chunk and existing `intrinsic' chunks.
  3633. If you need to write a new intrinsic chunk, first read the PNG
  3634. specification. Acquire a first level of understanding of how it works.
  3635. Pay particular attention to the sections that describe chunk names,
  3636. and look at how other chunks were designed, so you can do things
  3637. similarly. Second, check out the sections of libpng that read and
  3638. write chunks. Try to find a chunk that is similar to yours and use
  3639. it as a template. More details can be found in the comments inside
  3640. the code. It is best to handle private or unknown chunks in a generic method,
  3641. via callback functions, instead of by modifying libpng functions. This
  3642. is illustrated in pngtest.c, which uses a callback function to handle a
  3643. private "vpAg" chunk and the new "sTER" chunk, which are both unknown to
  3644. libpng.
  3645. If you wish to write your own transformation for the data, look through
  3646. the part of the code that does the transformations, and check out some of
  3647. the simpler ones to get an idea of how they work. Try to find a similar
  3648. transformation to the one you want to add and copy off of it. More details
  3649. can be found in the comments inside the code itself.
  3650. .SS Configuring for gui/windowing platforms:
  3651. You will need to write new error and warning functions that use the GUI
  3652. interface, as described previously, and set them to be the error and
  3653. warning functions at the time that png_create_*_struct() is called,
  3654. in order to have them available during the structure initialization.
  3655. They can be changed later via png_set_error_fn(). On some compilers,
  3656. you may also have to change the memory allocators (png_malloc, etc.).
  3657. .SS Configuring zlib:
  3658. There are special functions to configure the compression. Perhaps the
  3659. most useful one changes the compression level, which currently uses
  3660. input compression values in the range 0 - 9. The library normally
  3661. uses the default compression level (Z_DEFAULT_COMPRESSION = 6). Tests
  3662. have shown that for a large majority of images, compression values in
  3663. the range 3-6 compress nearly as well as higher levels, and do so much
  3664. faster. For online applications it may be desirable to have maximum speed
  3665. (Z_BEST_SPEED = 1). With versions of zlib after v0.99, you can also
  3666. specify no compression (Z_NO_COMPRESSION = 0), but this would create
  3667. files larger than just storing the raw bitmap. You can specify the
  3668. compression level by calling:
  3669. #include zlib.h
  3670. png_set_compression_level(png_ptr, level);
  3671. Another useful one is to reduce the memory level used by the library.
  3672. The memory level defaults to 8, but it can be lowered if you are
  3673. short on memory (running DOS, for example, where you only have 640K).
  3674. Note that the memory level does have an effect on compression; among
  3675. other things, lower levels will result in sections of incompressible
  3676. data being emitted in smaller stored blocks, with a correspondingly
  3677. larger relative overhead of up to 15% in the worst case.
  3678. #include zlib.h
  3679. png_set_compression_mem_level(png_ptr, level);
  3680. The other functions are for configuring zlib. They are not recommended
  3681. for normal use and may result in writing an invalid PNG file. See
  3682. zlib.h for more information on what these mean.
  3683. #include zlib.h
  3684. png_set_compression_strategy(png_ptr,
  3685. strategy);
  3686. png_set_compression_window_bits(png_ptr,
  3687. window_bits);
  3688. png_set_compression_method(png_ptr, method);
  3689. This controls the size of the IDAT chunks (default 8192):
  3690. png_set_compression_buffer_size(png_ptr, size);
  3691. As of libpng version 1.5.4, additional APIs became
  3692. available to set these separately for non-IDAT
  3693. compressed chunks such as zTXt, iTXt, and iCCP:
  3694. #include zlib.h
  3695. #if PNG_LIBPNG_VER >= 10504
  3696. png_set_text_compression_level(png_ptr, level);
  3697. png_set_text_compression_mem_level(png_ptr, level);
  3698. png_set_text_compression_strategy(png_ptr,
  3699. strategy);
  3700. png_set_text_compression_window_bits(png_ptr,
  3701. window_bits);
  3702. png_set_text_compression_method(png_ptr, method);
  3703. #endif
  3704. .SS Controlling row filtering
  3705. If you want to control whether libpng uses filtering or not, which
  3706. filters are used, and how it goes about picking row filters, you
  3707. can call one of these functions. The selection and configuration
  3708. of row filters can have a significant impact on the size and
  3709. encoding speed and a somewhat lesser impact on the decoding speed
  3710. of an image. Filtering is enabled by default for RGB and grayscale
  3711. images (with and without alpha), but not for paletted images nor
  3712. for any images with bit depths less than 8 bits/pixel.
  3713. The 'method' parameter sets the main filtering method, which is
  3714. currently only '0' in the PNG 1.2 specification. The 'filters'
  3715. parameter sets which filter(s), if any, should be used for each
  3716. scanline. Possible values are PNG_ALL_FILTERS, PNG_NO_FILTERS,
  3717. or PNG_FAST_FILTERS to turn filtering on and off, or to turn on
  3718. just the fast-decoding subset of filters, respectively.
  3719. Individual filter types are PNG_FILTER_NONE, PNG_FILTER_SUB,
  3720. PNG_FILTER_UP, PNG_FILTER_AVG, PNG_FILTER_PAETH, which can be bitwise
  3721. ORed together with '|' to specify one or more filters to use.
  3722. These filters are described in more detail in the PNG specification.
  3723. If you intend to change the filter type during the course of writing
  3724. the image, you should start with flags set for all of the filters
  3725. you intend to use so that libpng can initialize its internal
  3726. structures appropriately for all of the filter types. (Note that this
  3727. means the first row must always be adaptively filtered, because libpng
  3728. currently does not allocate the filter buffers until png_write_row()
  3729. is called for the first time.)
  3730. filters = PNG_NO_FILTERS;
  3731. filters = PNG_ALL_FILTERS;
  3732. filters = PNG_FAST_FILTERS;
  3733. or
  3734. filters = PNG_FILTER_NONE | PNG_FILTER_SUB |
  3735. PNG_FILTER_UP | PNG_FILTER_AVG |
  3736. PNG_FILTER_PAETH;
  3737. png_set_filter(png_ptr, PNG_FILTER_TYPE_BASE,
  3738. filters);
  3739. The second parameter can also be
  3740. PNG_INTRAPIXEL_DIFFERENCING if you are
  3741. writing a PNG to be embedded in a MNG
  3742. datastream. This parameter must be the
  3743. same as the value of filter_method used
  3744. in png_set_IHDR().
  3745. .SS Requesting debug printout
  3746. The macro definition PNG_DEBUG can be used to request debugging
  3747. printout. Set it to an integer value in the range 0 to 3. Higher
  3748. numbers result in increasing amounts of debugging information. The
  3749. information is printed to the "stderr" file, unless another file
  3750. name is specified in the PNG_DEBUG_FILE macro definition.
  3751. When PNG_DEBUG > 0, the following functions (macros) become available:
  3752. png_debug(level, message)
  3753. png_debug1(level, message, p1)
  3754. png_debug2(level, message, p1, p2)
  3755. in which "level" is compared to PNG_DEBUG to decide whether to print
  3756. the message, "message" is the formatted string to be printed,
  3757. and p1 and p2 are parameters that are to be embedded in the string
  3758. according to printf-style formatting directives. For example,
  3759. png_debug1(2, "foo=%d", foo);
  3760. is expanded to
  3761. if (PNG_DEBUG > 2)
  3762. fprintf(PNG_DEBUG_FILE, "foo=%d\en", foo);
  3763. When PNG_DEBUG is defined but is zero, the macros aren't defined, but you
  3764. can still use PNG_DEBUG to control your own debugging:
  3765. #ifdef PNG_DEBUG
  3766. fprintf(stderr, ...
  3767. #endif
  3768. When PNG_DEBUG = 1, the macros are defined, but only png_debug statements
  3769. having level = 0 will be printed. There aren't any such statements in
  3770. this version of libpng, but if you insert some they will be printed.
  3771. .SH VII. MNG support
  3772. The MNG specification (available at http://www.libpng.org/pub/mng) allows
  3773. certain extensions to PNG for PNG images that are embedded in MNG datastreams.
  3774. Libpng can support some of these extensions. To enable them, use the
  3775. png_permit_mng_features() function:
  3776. feature_set = png_permit_mng_features(png_ptr, mask)
  3777. mask is a png_uint_32 containing the bitwise OR of the
  3778. features you want to enable. These include
  3779. PNG_FLAG_MNG_EMPTY_PLTE
  3780. PNG_FLAG_MNG_FILTER_64
  3781. PNG_ALL_MNG_FEATURES
  3782. feature_set is a png_uint_32 that is the bitwise AND of
  3783. your mask with the set of MNG features that is
  3784. supported by the version of libpng that you are using.
  3785. It is an error to use this function when reading or writing a standalone
  3786. PNG file with the PNG 8-byte signature. The PNG datastream must be wrapped
  3787. in a MNG datastream. As a minimum, it must have the MNG 8-byte signature
  3788. and the MHDR and MEND chunks. Libpng does not provide support for these
  3789. or any other MNG chunks; your application must provide its own support for
  3790. them. You may wish to consider using libmng (available at
  3791. https://www.libmng.com/) instead.
  3792. .SH VIII. Changes to Libpng from version 0.88
  3793. It should be noted that versions of libpng later than 0.96 are not
  3794. distributed by the original libpng author, Guy Schalnat, nor by
  3795. Andreas Dilger, who had taken over from Guy during 1996 and 1997, and
  3796. distributed versions 0.89 through 0.96, but rather by another member
  3797. of the original PNG Group, Glenn Randers-Pehrson. Guy and Andreas are
  3798. still alive and well, but they have moved on to other things.
  3799. The old libpng functions png_read_init(), png_write_init(),
  3800. png_info_init(), png_read_destroy(), and png_write_destroy() have been
  3801. moved to PNG_INTERNAL in version 0.95 to discourage their use. These
  3802. functions will be removed from libpng version 1.4.0.
  3803. The preferred method of creating and initializing the libpng structures is
  3804. via the png_create_read_struct(), png_create_write_struct(), and
  3805. png_create_info_struct() because they isolate the size of the structures
  3806. from the application, allow version error checking, and also allow the
  3807. use of custom error handling routines during the initialization, which
  3808. the old functions do not. The functions png_read_destroy() and
  3809. png_write_destroy() do not actually free the memory that libpng
  3810. allocated for these structs, but just reset the data structures, so they
  3811. can be used instead of png_destroy_read_struct() and
  3812. png_destroy_write_struct() if you feel there is too much system overhead
  3813. allocating and freeing the png_struct for each image read.
  3814. Setting the error callbacks via png_set_message_fn() before
  3815. png_read_init() as was suggested in libpng-0.88 is no longer supported
  3816. because this caused applications that do not use custom error functions
  3817. to fail if the png_ptr was not initialized to zero. It is still possible
  3818. to set the error callbacks AFTER png_read_init(), or to change them with
  3819. png_set_error_fn(), which is essentially the same function, but with a new
  3820. name to force compilation errors with applications that try to use the old
  3821. method.
  3822. Support for the sCAL, iCCP, iTXt, and sPLT chunks was added at libpng-1.0.6;
  3823. however, iTXt support was not enabled by default.
  3824. Starting with version 1.0.7, you can find out which version of the library
  3825. you are using at run-time:
  3826. png_uint_32 libpng_vn = png_access_version_number();
  3827. The number libpng_vn is constructed from the major version, minor
  3828. version with leading zero, and release number with leading zero,
  3829. (e.g., libpng_vn for version 1.0.7 is 10007).
  3830. Note that this function does not take a png_ptr, so you can call it
  3831. before you've created one.
  3832. You can also check which version of png.h you used when compiling your
  3833. application:
  3834. png_uint_32 application_vn = PNG_LIBPNG_VER;
  3835. .SH IX. Changes to Libpng from version 1.0.x to 1.2.x
  3836. Support for user memory management was enabled by default. To
  3837. accomplish this, the functions png_create_read_struct_2(),
  3838. png_create_write_struct_2(), png_set_mem_fn(), png_get_mem_ptr(),
  3839. png_malloc_default(), and png_free_default() were added.
  3840. Support for the iTXt chunk has been enabled by default as of
  3841. version 1.2.41.
  3842. Support for certain MNG features was enabled.
  3843. Support for numbered error messages was added. However, we never got
  3844. around to actually numbering the error messages. The function
  3845. png_set_strip_error_numbers() was added (Note: the prototype for this
  3846. function was inadvertently removed from png.h in PNG_NO_ASSEMBLER_CODE
  3847. builds of libpng-1.2.15. It was restored in libpng-1.2.36).
  3848. The png_malloc_warn() function was added at libpng-1.2.3. This issues
  3849. a png_warning and returns NULL instead of aborting when it fails to
  3850. acquire the requested memory allocation.
  3851. Support for setting user limits on image width and height was enabled
  3852. by default. The functions png_set_user_limits(), png_get_user_width_max(),
  3853. and png_get_user_height_max() were added at libpng-1.2.6.
  3854. The png_set_add_alpha() function was added at libpng-1.2.7.
  3855. The function png_set_expand_gray_1_2_4_to_8() was added at libpng-1.2.9.
  3856. Unlike png_set_gray_1_2_4_to_8(), the new function does not expand the
  3857. tRNS chunk to alpha. The png_set_gray_1_2_4_to_8() function is
  3858. deprecated.
  3859. A number of macro definitions in support of runtime selection of
  3860. assembler code features (especially Intel MMX code support) were
  3861. added at libpng-1.2.0:
  3862. PNG_ASM_FLAG_MMX_SUPPORT_COMPILED
  3863. PNG_ASM_FLAG_MMX_SUPPORT_IN_CPU
  3864. PNG_ASM_FLAG_MMX_READ_COMBINE_ROW
  3865. PNG_ASM_FLAG_MMX_READ_INTERLACE
  3866. PNG_ASM_FLAG_MMX_READ_FILTER_SUB
  3867. PNG_ASM_FLAG_MMX_READ_FILTER_UP
  3868. PNG_ASM_FLAG_MMX_READ_FILTER_AVG
  3869. PNG_ASM_FLAG_MMX_READ_FILTER_PAETH
  3870. PNG_ASM_FLAGS_INITIALIZED
  3871. PNG_MMX_READ_FLAGS
  3872. PNG_MMX_FLAGS
  3873. PNG_MMX_WRITE_FLAGS
  3874. PNG_MMX_FLAGS
  3875. We added the following functions in support of runtime
  3876. selection of assembler code features:
  3877. png_get_mmx_flagmask()
  3878. png_set_mmx_thresholds()
  3879. png_get_asm_flags()
  3880. png_get_mmx_bitdepth_threshold()
  3881. png_get_mmx_rowbytes_threshold()
  3882. png_set_asm_flags()
  3883. We replaced all of these functions with simple stubs in libpng-1.2.20,
  3884. when the Intel assembler code was removed due to a licensing issue.
  3885. These macros are deprecated:
  3886. PNG_READ_TRANSFORMS_NOT_SUPPORTED
  3887. PNG_PROGRESSIVE_READ_NOT_SUPPORTED
  3888. PNG_NO_SEQUENTIAL_READ_SUPPORTED
  3889. PNG_WRITE_TRANSFORMS_NOT_SUPPORTED
  3890. PNG_READ_ANCILLARY_CHUNKS_NOT_SUPPORTED
  3891. PNG_WRITE_ANCILLARY_CHUNKS_NOT_SUPPORTED
  3892. They have been replaced, respectively, by:
  3893. PNG_NO_READ_TRANSFORMS
  3894. PNG_NO_PROGRESSIVE_READ
  3895. PNG_NO_SEQUENTIAL_READ
  3896. PNG_NO_WRITE_TRANSFORMS
  3897. PNG_NO_READ_ANCILLARY_CHUNKS
  3898. PNG_NO_WRITE_ANCILLARY_CHUNKS
  3899. PNG_MAX_UINT was replaced with PNG_UINT_31_MAX. It has been
  3900. deprecated since libpng-1.0.16 and libpng-1.2.6.
  3901. The function
  3902. png_check_sig(sig, num)
  3903. was replaced with
  3904. !png_sig_cmp(sig, 0, num)
  3905. It has been deprecated since libpng-0.90.
  3906. The function
  3907. png_set_gray_1_2_4_to_8()
  3908. which also expands tRNS to alpha was replaced with
  3909. png_set_expand_gray_1_2_4_to_8()
  3910. which does not. It has been deprecated since libpng-1.0.18 and 1.2.9.
  3911. .SH X. Changes to Libpng from version 1.0.x/1.2.x to 1.4.x
  3912. Private libpng prototypes and macro definitions were moved from
  3913. png.h and pngconf.h into a new pngpriv.h header file.
  3914. Functions png_set_benign_errors(), png_benign_error(), and
  3915. png_chunk_benign_error() were added.
  3916. Support for setting the maximum amount of memory that the application
  3917. will allocate for reading chunks was added, as a security measure.
  3918. The functions png_set_chunk_cache_max() and png_get_chunk_cache_max()
  3919. were added to the library.
  3920. We implemented support for I/O states by adding png_ptr member io_state
  3921. and functions png_get_io_chunk_name() and png_get_io_state() in pngget.c
  3922. We added PNG_TRANSFORM_GRAY_TO_RGB to the available high-level
  3923. input transforms.
  3924. Checking for and reporting of errors in the IHDR chunk is more thorough.
  3925. Support for global arrays was removed, to improve thread safety.
  3926. Some obsolete/deprecated macros and functions have been removed.
  3927. Typecasted NULL definitions such as
  3928. #define png_voidp_NULL (png_voidp)NULL
  3929. were eliminated. If you used these in your application, just use
  3930. NULL instead.
  3931. The png_struct and info_struct members "trans" and "trans_values" were
  3932. changed to "trans_alpha" and "trans_color", respectively.
  3933. The obsolete, unused pnggccrd.c and pngvcrd.c files and related makefiles
  3934. were removed.
  3935. The PNG_1_0_X and PNG_1_2_X macros were eliminated.
  3936. The PNG_LEGACY_SUPPORTED macro was eliminated.
  3937. Many WIN32_WCE #ifdefs were removed.
  3938. The functions png_read_init(info_ptr), png_write_init(info_ptr),
  3939. png_info_init(info_ptr), png_read_destroy(), and png_write_destroy()
  3940. have been removed. They have been deprecated since libpng-0.95.
  3941. The png_permit_empty_plte() was removed. It has been deprecated
  3942. since libpng-1.0.9. Use png_permit_mng_features() instead.
  3943. We removed the obsolete stub functions png_get_mmx_flagmask(),
  3944. png_set_mmx_thresholds(), png_get_asm_flags(),
  3945. png_get_mmx_bitdepth_threshold(), png_get_mmx_rowbytes_threshold(),
  3946. png_set_asm_flags(), and png_mmx_supported()
  3947. We removed the obsolete png_check_sig(), png_memcpy_check(), and
  3948. png_memset_check() functions. Instead use !png_sig_cmp(), memcpy(),
  3949. and memset(), respectively.
  3950. The function png_set_gray_1_2_4_to_8() was removed. It has been
  3951. deprecated since libpng-1.0.18 and 1.2.9, when it was replaced with
  3952. png_set_expand_gray_1_2_4_to_8() because the former function also
  3953. expanded any tRNS chunk to an alpha channel.
  3954. Macros for png_get_uint_16, png_get_uint_32, and png_get_int_32
  3955. were added and are used by default instead of the corresponding
  3956. functions. Unfortunately,
  3957. from libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
  3958. function) incorrectly returned a value of type png_uint_32.
  3959. We changed the prototype for png_malloc() from
  3960. png_malloc(png_structp png_ptr, png_uint_32 size)
  3961. to
  3962. png_malloc(png_structp png_ptr, png_alloc_size_t size)
  3963. This also applies to the prototype for the user replacement malloc_fn().
  3964. The png_calloc() function was added and is used in place of
  3965. of "png_malloc(); memset();" except in the case in png_read_png()
  3966. where the array consists of pointers; in this case a "for" loop is used
  3967. after the png_malloc() to set the pointers to NULL, to give robust.
  3968. behavior in case the application runs out of memory part-way through
  3969. the process.
  3970. We changed the prototypes of png_get_compression_buffer_size() and
  3971. png_set_compression_buffer_size() to work with size_t instead of
  3972. png_uint_32.
  3973. Support for numbered error messages was removed by default, since we
  3974. never got around to actually numbering the error messages. The function
  3975. png_set_strip_error_numbers() was removed from the library by default.
  3976. The png_zalloc() and png_zfree() functions are no longer exported.
  3977. The png_zalloc() function no longer zeroes out the memory that it
  3978. allocates. Applications that called png_zalloc(png_ptr, number, size)
  3979. can call png_calloc(png_ptr, number*size) instead, and can call
  3980. png_free() instead of png_zfree().
  3981. Support for dithering was disabled by default in libpng-1.4.0, because
  3982. it has not been well tested and doesn't actually "dither".
  3983. The code was not
  3984. removed, however, and could be enabled by building libpng with
  3985. PNG_READ_DITHER_SUPPORTED defined. In libpng-1.4.2, this support
  3986. was re-enabled, but the function was renamed png_set_quantize() to
  3987. reflect more accurately what it actually does. At the same time,
  3988. the PNG_DITHER_[RED,GREEN_BLUE]_BITS macros were also renamed to
  3989. PNG_QUANTIZE_[RED,GREEN,BLUE]_BITS, and PNG_READ_DITHER_SUPPORTED
  3990. was renamed to PNG_READ_QUANTIZE_SUPPORTED.
  3991. We removed the trailing '.' from the warning and error messages.
  3992. .SH XI. Changes to Libpng from version 1.4.x to 1.5.x
  3993. From libpng-1.4.0 until 1.4.4, the png_get_uint_16 macro (but not the
  3994. function) incorrectly returned a value of type png_uint_32.
  3995. The incorrect macro was removed from libpng-1.4.5.
  3996. Checking for invalid palette index on write was added at libpng
  3997. 1.5.10. If a pixel contains an invalid (out-of-range) index libpng issues
  3998. a benign error. This is enabled by default because this condition is an
  3999. error according to the PNG specification, Clause 11.3.2, but the error can
  4000. be ignored in each png_ptr with
  4001. png_set_check_for_invalid_index(png_ptr, allowed);
  4002. allowed - one of
  4003. 0: disable benign error (accept the
  4004. invalid data without warning).
  4005. 1: enable benign error (treat the
  4006. invalid data as an error or a
  4007. warning).
  4008. If the error is ignored, or if png_benign_error() treats it as a warning,
  4009. any invalid pixels are decoded as opaque black by the decoder and written
  4010. as-is by the encoder.
  4011. Retrieving the maximum palette index found was added at libpng-1.5.15.
  4012. This statement must appear after png_read_png() or png_read_image() while
  4013. reading, and after png_write_png() or png_write_image() while writing.
  4014. int max_palette = png_get_palette_max(png_ptr, info_ptr);
  4015. This will return the maximum palette index found in the image, or "\-1" if
  4016. the palette was not checked, or "0" if no palette was found. Note that this
  4017. does not account for any palette index used by ancillary chunks such as the
  4018. bKGD chunk; you must check those separately to determine the maximum
  4019. palette index actually used.
  4020. There are no substantial API changes between the non-deprecated parts of
  4021. the 1.4.5 API and the 1.5.0 API; however, the ability to directly access
  4022. members of the main libpng control structures, png_struct and png_info,
  4023. deprecated in earlier versions of libpng, has been completely removed from
  4024. libpng 1.5, and new private "pngstruct.h", "pnginfo.h", and "pngdebug.h"
  4025. header files were created.
  4026. We no longer include zlib.h in png.h. The include statement has been moved
  4027. to pngstruct.h, where it is not accessible by applications. Applications that
  4028. need access to information in zlib.h will need to add the '#include "zlib.h"'
  4029. directive. It does not matter whether this is placed prior to or after
  4030. the '"#include png.h"' directive.
  4031. The png_sprintf(), png_strcpy(), and png_strncpy() macros are no longer used
  4032. and were removed.
  4033. We moved the png_strlen(), png_memcpy(), png_memset(), and png_memcmp()
  4034. macros into a private header file (pngpriv.h) that is not accessible to
  4035. applications.
  4036. In png_get_iCCP, the type of "profile" was changed from png_charpp
  4037. to png_bytepp, and in png_set_iCCP, from png_charp to png_const_bytep.
  4038. There are changes of form in png.h, including new and changed macros to
  4039. declare parts of the API. Some API functions with arguments that are
  4040. pointers to data not modified within the function have been corrected to
  4041. declare these arguments with const.
  4042. Much of the internal use of C macros to control the library build has also
  4043. changed and some of this is visible in the exported header files, in
  4044. particular the use of macros to control data and API elements visible
  4045. during application compilation may require significant revision to
  4046. application code. (It is extremely rare for an application to do this.)
  4047. Any program that compiled against libpng 1.4 and did not use deprecated
  4048. features or access internal library structures should compile and work
  4049. against libpng 1.5, except for the change in the prototype for
  4050. png_get_iCCP() and png_set_iCCP() API functions mentioned above.
  4051. libpng 1.5.0 adds PNG_ PASS macros to help in the reading and writing of
  4052. interlaced images. The macros return the number of rows and columns in
  4053. each pass and information that can be used to de-interlace and (if
  4054. absolutely necessary) interlace an image.
  4055. libpng 1.5.0 adds an API png_longjmp(png_ptr, value). This API calls
  4056. the application-provided png_longjmp_ptr on the internal, but application
  4057. initialized, longjmp buffer. It is provided as a convenience to avoid
  4058. the need to use the png_jmpbuf macro, which had the unnecessary side
  4059. effect of resetting the internal png_longjmp_ptr value.
  4060. libpng 1.5.0 includes a complete fixed point API. By default this is
  4061. present along with the corresponding floating point API. In general the
  4062. fixed point API is faster and smaller than the floating point one because
  4063. the PNG file format used fixed point, not floating point. This applies
  4064. even if the library uses floating point in internal calculations. A new
  4065. macro, PNG_FLOATING_ARITHMETIC_SUPPORTED, reveals whether the library
  4066. uses floating point arithmetic (the default) or fixed point arithmetic
  4067. internally for performance critical calculations such as gamma correction.
  4068. In some cases, the gamma calculations may produce slightly different
  4069. results. This has changed the results in png_rgb_to_gray and in alpha
  4070. composition (png_set_background for example). This applies even if the
  4071. original image was already linear (gamma == 1.0) and, therefore, it is
  4072. not necessary to linearize the image. This is because libpng has *not*
  4073. been changed to optimize that case correctly, yet.
  4074. Fixed point support for the sCAL chunk comes with an important caveat;
  4075. the sCAL specification uses a decimal encoding of floating point values
  4076. and the accuracy of PNG fixed point values is insufficient for
  4077. representation of these values. Consequently a "string" API
  4078. (png_get_sCAL_s and png_set_sCAL_s) is the only reliable way of reading
  4079. arbitrary sCAL chunks in the absence of either the floating point API or
  4080. internal floating point calculations. Starting with libpng-1.5.0, both
  4081. of these functions are present when PNG_sCAL_SUPPORTED is defined. Prior
  4082. to libpng-1.5.0, their presence also depended upon PNG_FIXED_POINT_SUPPORTED
  4083. being defined and PNG_FLOATING_POINT_SUPPORTED not being defined.
  4084. Applications no longer need to include the optional distribution header
  4085. file pngusr.h or define the corresponding macros during application
  4086. build in order to see the correct variant of the libpng API. From 1.5.0
  4087. application code can check for the corresponding _SUPPORTED macro:
  4088. #ifdef PNG_INCH_CONVERSIONS_SUPPORTED
  4089. /* code that uses the inch conversion APIs. */
  4090. #endif
  4091. This macro will only be defined if the inch conversion functions have been
  4092. compiled into libpng. The full set of macros, and whether or not support
  4093. has been compiled in, are available in the header file pnglibconf.h.
  4094. This header file is specific to the libpng build. Notice that prior to
  4095. 1.5.0 the _SUPPORTED macros would always have the default definition unless
  4096. reset by pngusr.h or by explicit settings on the compiler command line.
  4097. These settings may produce compiler warnings or errors in 1.5.0 because
  4098. of macro redefinition.
  4099. Applications can now choose whether to use these macros or to call the
  4100. corresponding function by defining PNG_USE_READ_MACROS or
  4101. PNG_NO_USE_READ_MACROS before including png.h. Notice that this is
  4102. only supported from 1.5.0; defining PNG_NO_USE_READ_MACROS prior to 1.5.0
  4103. will lead to a link failure.
  4104. Prior to libpng-1.5.4, the zlib compressor used the same set of parameters
  4105. when compressing the IDAT data and textual data such as zTXt and iCCP.
  4106. In libpng-1.5.4 we reinitialized the zlib stream for each type of data.
  4107. We added five png_set_text_*() functions for setting the parameters to
  4108. use with textual data.
  4109. Prior to libpng-1.5.4, the PNG_READ_16_TO_8_ACCURATE_SCALE_SUPPORTED
  4110. option was off by default, and slightly inaccurate scaling occurred.
  4111. This option can no longer be turned off, and the choice of accurate
  4112. or inaccurate 16-to-8 scaling is by using the new png_set_scale_16_to_8()
  4113. API for accurate scaling or the old png_set_strip_16_to_8() API for simple
  4114. chopping. In libpng-1.5.4, the PNG_READ_16_TO_8_ACCURATE_SCALE_SUPPORTED
  4115. macro became PNG_READ_SCALE_16_TO_8_SUPPORTED, and the PNG_READ_16_TO_8
  4116. macro became PNG_READ_STRIP_16_TO_8_SUPPORTED, to enable the two
  4117. png_set_*_16_to_8() functions separately.
  4118. Prior to libpng-1.5.4, the png_set_user_limits() function could only be
  4119. used to reduce the width and height limits from the value of
  4120. PNG_USER_WIDTH_MAX and PNG_USER_HEIGHT_MAX, although this document said
  4121. that it could be used to override them. Now this function will reduce or
  4122. increase the limits.
  4123. Starting in libpng-1.5.22, default user limits were established. These
  4124. can be overridden by application calls to png_set_user_limits(),
  4125. png_set_user_chunk_cache_max(), and/or png_set_user_malloc_max().
  4126. The limits are now
  4127. max possible default
  4128. png_user_width_max 0x7fffffff 1,000,000
  4129. png_user_height_max 0x7fffffff 1,000,000
  4130. png_user_chunk_cache_max 0 (unlimited) 1000
  4131. png_user_chunk_malloc_max 0 (unlimited) 8,000,000
  4132. The png_set_option() function (and the "options" member of the png struct) was
  4133. added to libpng-1.5.15, with option PNG_ARM_NEON.
  4134. The library now supports a complete fixed point implementation and can
  4135. thus be used on systems that have no floating point support or very
  4136. limited or slow support. Previously gamma correction, an essential part
  4137. of complete PNG support, required reasonably fast floating point.
  4138. As part of this the choice of internal implementation has been made
  4139. independent of the choice of fixed versus floating point APIs and all the
  4140. missing fixed point APIs have been implemented.
  4141. The exact mechanism used to control attributes of API functions has
  4142. changed, as described in the INSTALL file.
  4143. A new test program, pngvalid, is provided in addition to pngtest.
  4144. pngvalid validates the arithmetic accuracy of the gamma correction
  4145. calculations and includes a number of validations of the file format.
  4146. A subset of the full range of tests is run when "make check" is done
  4147. (in the 'configure' build.) pngvalid also allows total allocated memory
  4148. usage to be evaluated and performs additional memory overwrite validation.
  4149. Many changes to individual feature macros have been made. The following
  4150. are the changes most likely to be noticed by library builders who
  4151. configure libpng:
  4152. 1) All feature macros now have consistent naming:
  4153. #define PNG_NO_feature turns the feature off
  4154. #define PNG_feature_SUPPORTED turns the feature on
  4155. pnglibconf.h contains one line for each feature macro which is either:
  4156. #define PNG_feature_SUPPORTED
  4157. if the feature is supported or:
  4158. /*#undef PNG_feature_SUPPORTED*/
  4159. if it is not. Library code consistently checks for the 'SUPPORTED' macro.
  4160. It does not, and libpng applications should not, check for the 'NO' macro
  4161. which will not normally be defined even if the feature is not supported.
  4162. The 'NO' macros are only used internally for setting or not setting the
  4163. corresponding 'SUPPORTED' macros.
  4164. Compatibility with the old names is provided as follows:
  4165. PNG_INCH_CONVERSIONS turns on PNG_INCH_CONVERSIONS_SUPPORTED
  4166. And the following definitions disable the corresponding feature:
  4167. PNG_SETJMP_NOT_SUPPORTED disables SETJMP
  4168. PNG_READ_TRANSFORMS_NOT_SUPPORTED disables READ_TRANSFORMS
  4169. PNG_NO_READ_COMPOSITED_NODIV disables READ_COMPOSITE_NODIV
  4170. PNG_WRITE_TRANSFORMS_NOT_SUPPORTED disables WRITE_TRANSFORMS
  4171. PNG_READ_ANCILLARY_CHUNKS_NOT_SUPPORTED disables READ_ANCILLARY_CHUNKS
  4172. PNG_WRITE_ANCILLARY_CHUNKS_NOT_SUPPORTED disables WRITE_ANCILLARY_CHUNKS
  4173. Library builders should remove use of the above, inconsistent, names.
  4174. 2) Warning and error message formatting was previously conditional on
  4175. the STDIO feature. The library has been changed to use the
  4176. CONSOLE_IO feature instead. This means that if CONSOLE_IO is disabled
  4177. the library no longer uses the printf(3) functions, even though the
  4178. default read/write implementations use (FILE) style stdio.h functions.
  4179. 3) Three feature macros now control the fixed/floating point decisions:
  4180. PNG_FLOATING_POINT_SUPPORTED enables the floating point APIs
  4181. PNG_FIXED_POINT_SUPPORTED enables the fixed point APIs; however, in
  4182. practice these are normally required internally anyway (because the PNG
  4183. file format is fixed point), therefore in most cases PNG_NO_FIXED_POINT
  4184. merely stops the function from being exported.
  4185. PNG_FLOATING_ARITHMETIC_SUPPORTED chooses between the internal floating
  4186. point implementation or the fixed point one. Typically the fixed point
  4187. implementation is larger and slower than the floating point implementation
  4188. on a system that supports floating point; however, it may be faster on a
  4189. system which lacks floating point hardware and therefore uses a software
  4190. emulation.
  4191. 4) Added PNG_{READ,WRITE}_INT_FUNCTIONS_SUPPORTED. This allows the
  4192. functions to read and write ints to be disabled independently of
  4193. PNG_USE_READ_MACROS, which allows libpng to be built with the functions
  4194. even though the default is to use the macros - this allows applications
  4195. to choose at app buildtime whether or not to use macros (previously
  4196. impossible because the functions weren't in the default build.)
  4197. .SH XII. Changes to Libpng from version 1.5.x to 1.6.x
  4198. A "simplified API" has been added (see documentation in png.h and a simple
  4199. example in contrib/examples/pngtopng.c). The new publicly visible API
  4200. includes the following:
  4201. macros:
  4202. PNG_FORMAT_*
  4203. PNG_IMAGE_*
  4204. structures:
  4205. png_control
  4206. png_image
  4207. read functions
  4208. png_image_begin_read_from_file()
  4209. png_image_begin_read_from_stdio()
  4210. png_image_begin_read_from_memory()
  4211. png_image_finish_read()
  4212. png_image_free()
  4213. write functions
  4214. png_image_write_to_file()
  4215. png_image_write_to_memory()
  4216. png_image_write_to_stdio()
  4217. Starting with libpng-1.6.0, you can configure libpng to prefix all exported
  4218. symbols, using the PNG_PREFIX macro.
  4219. We no longer include string.h in png.h. The include statement has been moved
  4220. to pngpriv.h, where it is not accessible by applications. Applications that
  4221. need access to information in string.h must add an '#include <string.h>'
  4222. directive. It does not matter whether this is placed prior to or after
  4223. the '#include "png.h"' directive.
  4224. The following API are now DEPRECATED:
  4225. png_info_init_3()
  4226. png_convert_to_rfc1123() which has been replaced
  4227. with png_convert_to_rfc1123_buffer()
  4228. png_malloc_default()
  4229. png_free_default()
  4230. png_reset_zstream()
  4231. The following have been removed:
  4232. png_get_io_chunk_name(), which has been replaced
  4233. with png_get_io_chunk_type(). The new
  4234. function returns a 32-bit integer instead of
  4235. a string.
  4236. The png_sizeof(), png_strlen(), png_memcpy(), png_memcmp(), and
  4237. png_memset() macros are no longer used in the libpng sources and
  4238. have been removed. These had already been made invisible to applications
  4239. (i.e., defined in the private pngpriv.h header file) since libpng-1.5.0.
  4240. The signatures of many exported functions were changed, such that
  4241. png_structp became png_structrp or png_const_structrp
  4242. png_infop became png_inforp or png_const_inforp
  4243. where "rp" indicates a "restricted pointer".
  4244. Dropped support for 16-bit platforms. The support for FAR/far types has
  4245. been eliminated and the definition of png_alloc_size_t is now controlled
  4246. by a flag so that 'small size_t' systems can select it if necessary.
  4247. Error detection in some chunks has improved; in particular the iCCP chunk
  4248. reader now does pretty complete validation of the basic format. Some bad
  4249. profiles that were previously accepted are now accepted with a warning or
  4250. rejected, depending upon the png_set_benign_errors() setting, in particular
  4251. the very old broken Microsoft/HP 3144-byte sRGB profile. Starting with
  4252. libpng-1.6.11, recognizing and checking sRGB profiles can be avoided by
  4253. means of
  4254. #if defined(PNG_SKIP_sRGB_CHECK_PROFILE) && \
  4255. defined(PNG_SET_OPTION_SUPPORTED)
  4256. png_set_option(png_ptr, PNG_SKIP_sRGB_CHECK_PROFILE,
  4257. PNG_OPTION_ON);
  4258. #endif
  4259. It's not a good idea to do this if you are using the "simplified API",
  4260. which needs to be able to recognize sRGB profiles conveyed via the iCCP
  4261. chunk.
  4262. The PNG spec requirement that only grayscale profiles may appear in images
  4263. with color type 0 or 4 and that even if the image only contains gray pixels,
  4264. only RGB profiles may appear in images with color type 2, 3, or 6, is now
  4265. enforced. The sRGB chunk is allowed to appear in images with any color type
  4266. and is interpreted by libpng to convey a one-tracer-curve gray profile or a
  4267. three-tracer-curve RGB profile as appropriate.
  4268. Libpng 1.5.x erroneously used /MD for Debug DLL builds; if you used the debug
  4269. builds in your app and you changed your app to use /MD you will need to
  4270. change it back to /MDd for libpng 1.6.x.
  4271. Prior to libpng-1.6.0 a warning would be issued if the iTXt chunk contained
  4272. an empty language field or an empty translated keyword. Both of these
  4273. are allowed by the PNG specification, so these warnings are no longer issued.
  4274. The library now issues an error if the application attempts to set a
  4275. transform after it calls png_read_update_info() or if it attempts to call
  4276. both png_read_update_info() and png_start_read_image() or to call either
  4277. of them more than once.
  4278. The default condition for benign_errors is now to treat benign errors as
  4279. warnings while reading and as errors while writing.
  4280. The library now issues a warning if both background processing and RGB to
  4281. gray are used when gamma correction happens. As with previous versions of
  4282. the library the results are numerically very incorrect in this case.
  4283. There are some minor arithmetic changes in some transforms such as
  4284. png_set_background(), that might be detected by certain regression tests.
  4285. Unknown chunk handling has been improved internally, without any API change.
  4286. This adds more correct option control of the unknown handling, corrects
  4287. a pre-existing bug where the per-chunk 'keep' setting is ignored, and makes
  4288. it possible to skip IDAT chunks in the sequential reader.
  4289. The machine-generated configure files are no longer included in branches
  4290. libpng16 and later of the GIT repository. They continue to be included
  4291. in the tarball releases, however.
  4292. Libpng-1.6.0 through 1.6.2 used the CMF bytes at the beginning of the IDAT
  4293. stream to set the size of the sliding window for reading instead of using the
  4294. default 32-kbyte sliding window size. It was discovered that there are
  4295. hundreds of PNG files in the wild that have incorrect CMF bytes that caused
  4296. zlib to issue the "invalid distance too far back" error and reject the file.
  4297. Libpng-1.6.3 and later calculate their own safe CMF from the image dimensions,
  4298. provide a way to revert to the libpng-1.5.x behavior (ignoring the CMF bytes
  4299. and using a 32-kbyte sliding window), by using
  4300. png_set_option(png_ptr, PNG_MAXIMUM_INFLATE_WINDOW,
  4301. PNG_OPTION_ON);
  4302. and provide a tool (contrib/tools/pngfix) for rewriting a PNG file while
  4303. optimizing the CMF bytes in its IDAT chunk correctly.
  4304. Libpng-1.6.0 and libpng-1.6.1 wrote uncompressed iTXt chunks with the wrong
  4305. length, which resulted in PNG files that cannot be read beyond the bad iTXt
  4306. chunk. This error was fixed in libpng-1.6.3, and a tool (called
  4307. contrib/tools/png-fix-itxt) has been added to the libpng distribution.
  4308. Starting with libpng-1.6.17, the PNG_SAFE_LIMITS macro was eliminated
  4309. and safe limits are used by default (users who need larger limits
  4310. can still override them at compile time or run time, as described above).
  4311. The new limits are
  4312. default spec limit
  4313. png_user_width_max 1,000,000 2,147,483,647
  4314. png_user_height_max 1,000,000 2,147,483,647
  4315. png_user_chunk_cache_max 128 unlimited
  4316. png_user_chunk_malloc_max 8,000,000 unlimited
  4317. Starting with libpng-1.6.18, a PNG_RELEASE_BUILD macro was added, which allows
  4318. library builders to control compilation for an installed system (a release build).
  4319. It can be set for testing debug or beta builds to ensure that they will compile
  4320. when the build type is switched to RC or STABLE. In essence this overrides the
  4321. PNG_LIBPNG_BUILD_BASE_TYPE definition which is not directly user controllable.
  4322. Starting with libpng-1.6.19, attempting to set an over-length PLTE chunk
  4323. is an error. Previously this requirement of the PNG specification was not
  4324. enforced, and the palette was always limited to 256 entries. An over-length
  4325. PLTE chunk found in an input PNG is silently truncated.
  4326. Starting with libpng-1.6.31, the eXIf chunk is supported. Libpng does not
  4327. attempt to decode the Exif profile; it simply returns a byte array
  4328. containing the profile to the calling application which must do its own
  4329. decoding.
  4330. .SH XIII. Detecting libpng
  4331. The png_get_io_ptr() function has been present since libpng-0.88, has never
  4332. changed, and is unaffected by conditional compilation macros. It is the
  4333. best choice for use in configure scripts for detecting the presence of any
  4334. libpng version since 0.88. In an autoconf "configure.in" you could use
  4335. AC_CHECK_LIB(png, png_get_io_ptr, ...
  4336. .SH XV. Source code repository
  4337. Since about February 2009, version 1.2.34, libpng has been under "git" source
  4338. control. The git repository was built from old libpng-x.y.z.tar.gz files
  4339. going back to version 0.70. You can access the git repository (read only)
  4340. at
  4341. https://github.com/glennrp/libpng or
  4342. https://git.code.sf.net/p/libpng/code.git
  4343. or you can browse it with a web browser at
  4344. https://github.com/glennrp/libpng or
  4345. https://sourceforge.net/p/libpng/code/ci/libpng16/tree/
  4346. Patches can be sent to png-mng-implement at lists.sourceforge.net or
  4347. uploaded to the libpng bug tracker at
  4348. https://libpng.sourceforge.io/
  4349. or as a "pull request" to
  4350. https://github.com/glennrp/libpng/pulls
  4351. We also accept patches built from the tar or zip distributions, and
  4352. simple verbal descriptions of bug fixes, reported either to the
  4353. SourceForge bug tracker, to the png-mng-implement at lists.sf.net
  4354. mailing list, as github issues.
  4355. .SH XV. Coding style
  4356. Our coding style is similar to the "Allman" style
  4357. (See https://en.wikipedia.org/wiki/Indent_style#Allman_style), with curly
  4358. braces on separate lines:
  4359. if (condition)
  4360. {
  4361. action;
  4362. }
  4363. else if (another condition)
  4364. {
  4365. another action;
  4366. }
  4367. The braces can be omitted from simple one-line actions:
  4368. if (condition)
  4369. return 0;
  4370. We use 3-space indentation, except for continued statements which
  4371. are usually indented the same as the first line of the statement
  4372. plus four more spaces.
  4373. For macro definitions we use 2-space indentation, always leaving the "#"
  4374. in the first column.
  4375. #ifndef PNG_NO_FEATURE
  4376. # ifndef PNG_FEATURE_SUPPORTED
  4377. # define PNG_FEATURE_SUPPORTED
  4378. # endif
  4379. #endif
  4380. Comments appear with the leading "/*" at the same indentation as
  4381. the statement that follows the comment:
  4382. /* Single-line comment */
  4383. statement;
  4384. /* This is a multiple-line
  4385. * comment.
  4386. */
  4387. statement;
  4388. Very short comments can be placed after the end of the statement
  4389. to which they pertain:
  4390. statement; /* comment */
  4391. We don't use C++ style ("//") comments. We have, however,
  4392. used them in the past in some now-abandoned MMX assembler
  4393. code.
  4394. Functions and their curly braces are not indented, and
  4395. exported functions are marked with PNGAPI:
  4396. /* This is a public function that is visible to
  4397. * application programmers. It does thus-and-so.
  4398. */
  4399. void PNGAPI
  4400. png_exported_function(png_ptr, png_info, foo)
  4401. {
  4402. body;
  4403. }
  4404. The return type and decorations are placed on a separate line
  4405. ahead of the function name, as illustrated above.
  4406. The prototypes for all exported functions appear in png.h,
  4407. above the comment that says
  4408. /* Maintainer: Put new public prototypes here ... */
  4409. We mark all non-exported functions with "/* PRIVATE */"":
  4410. void /* PRIVATE */
  4411. png_non_exported_function(png_ptr, png_info, foo)
  4412. {
  4413. body;
  4414. }
  4415. The prototypes for non-exported functions (except for those in
  4416. pngtest) appear in pngpriv.h above the comment that says
  4417. /* Maintainer: Put new private prototypes here ^ */
  4418. To avoid polluting the global namespace, the names of all exported
  4419. functions and variables begin with "png_", and all publicly visible C
  4420. preprocessor macros begin with "PNG". We request that applications that
  4421. use libpng *not* begin any of their own symbols with either of these strings.
  4422. We put a space after the "sizeof" operator and we omit the
  4423. optional parentheses around its argument when the argument
  4424. is an expression, not a type name, and we always enclose the
  4425. sizeof operator, with its argument, in parentheses:
  4426. (sizeof (png_uint_32))
  4427. (sizeof array)
  4428. Prior to libpng-1.6.0 we used a "png_sizeof()" macro, formatted as
  4429. though it were a function.
  4430. Control keywords if, for, while, and switch are always followed by a space
  4431. to distinguish them from function calls, which have no trailing space.
  4432. We put a space after each comma and after each semicolon
  4433. in "for" statements, and we put spaces before and after each
  4434. C binary operator and after "for" or "while", and before
  4435. "?". We don't put a space between a typecast and the expression
  4436. being cast, nor do we put one between a function name and the
  4437. left parenthesis that follows it:
  4438. for (i = 2; i > 0; \-\-i)
  4439. y[i] = a(x) + (int)b;
  4440. We prefer #ifdef and #ifndef to #if defined() and #if !defined()
  4441. when there is only one macro being tested. We always use parentheses
  4442. with "defined".
  4443. We express integer constants that are used as bit masks in hex format,
  4444. with an even number of lower-case hex digits, and to make them unsigned
  4445. (e.g., 0x00U, 0xffU, 0x0100U) and long if they are greater than 0x7fff
  4446. (e.g., 0xffffUL).
  4447. We prefer to use underscores rather than camelCase in names, except
  4448. for a few type names that we inherit from zlib.h.
  4449. We prefer "if (something != 0)" and "if (something == 0)" over
  4450. "if (something)" and if "(!something)", respectively, and for pointers
  4451. we prefer "if (some_pointer != NULL)" or "if (some_pointer == NULL)".
  4452. We do not use the TAB character for indentation in the C sources.
  4453. Lines do not exceed 80 characters.
  4454. Other rules can be inferred by inspecting the libpng source.
  4455. .SH NOTE
  4456. Note about libpng version numbers:
  4457. Due to various miscommunications, unforeseen code incompatibilities
  4458. and occasional factors outside the authors' control, version numbering
  4459. on the library has not always been consistent and straightforward.
  4460. The following table summarizes matters since version 0.89c, which was
  4461. the first widely used release:
  4462. source png.h png.h shared-lib
  4463. version string int version
  4464. ------- ------ ----- ----------
  4465. 0.89c "1.0 beta 3" 0.89 89 1.0.89
  4466. 0.90 "1.0 beta 4" 0.90 90 0.90 [should have been 2.0.90]
  4467. 0.95 "1.0 beta 5" 0.95 95 0.95 [should have been 2.0.95]
  4468. 0.96 "1.0 beta 6" 0.96 96 0.96 [should have been 2.0.96]
  4469. 0.97b "1.00.97 beta 7" 1.00.97 97 1.0.1 [should have been 2.0.97]
  4470. 0.97c 0.97 97 2.0.97
  4471. 0.98 0.98 98 2.0.98
  4472. 0.99 0.99 98 2.0.99
  4473. 0.99a-m 0.99 99 2.0.99
  4474. 1.00 1.00 100 2.1.0 [100 should be 10000]
  4475. 1.0.0 (from here on, the 100 2.1.0 [100 should be 10000]
  4476. 1.0.1 png.h string is 10001 2.1.0
  4477. 1.0.1a-e identical to the 10002 from here on, the shared library
  4478. 1.0.2 source version) 10002 is 2.V where V is the source code
  4479. 1.0.2a-b 10003 version, except as noted.
  4480. 1.0.3 10003
  4481. 1.0.3a-d 10004
  4482. 1.0.4 10004
  4483. 1.0.4a-f 10005
  4484. 1.0.5 (+ 2 patches) 10005
  4485. 1.0.5a-d 10006
  4486. 1.0.5e-r 10100 (not source compatible)
  4487. 1.0.5s-v 10006 (not binary compatible)
  4488. 1.0.6 (+ 3 patches) 10006 (still binary incompatible)
  4489. 1.0.6d-f 10007 (still binary incompatible)
  4490. 1.0.6g 10007
  4491. 1.0.6h 10007 10.6h (testing xy.z so-numbering)
  4492. 1.0.6i 10007 10.6i
  4493. 1.0.6j 10007 2.1.0.6j (incompatible with 1.0.0)
  4494. 1.0.7beta11-14 DLLNUM 10007 2.1.0.7beta11-14 (binary compatible)
  4495. 1.0.7beta15-18 1 10007 2.1.0.7beta15-18 (binary compatible)
  4496. 1.0.7rc1-2 1 10007 2.1.0.7rc1-2 (binary compatible)
  4497. 1.0.7 1 10007 (still compatible)
  4498. ...
  4499. 1.0.69 10 10069 10.so.0.69[.0]
  4500. ...
  4501. 1.2.59 13 10259 12.so.0.59[.0]
  4502. ...
  4503. 1.4.20 14 10420 14.so.0.20[.0]
  4504. ...
  4505. 1.5.30 15 10530 15.so.15.30[.0]
  4506. ...
  4507. 1.6.35 16 10635 16.so.16.35[.0]
  4508. Henceforth the source version will match the shared-library minor and
  4509. patch numbers; the shared-library major version number will be used for
  4510. changes in backward compatibility, as it is intended.
  4511. The PNG_PNGLIB_VER macro, which is not used within libpng but is
  4512. available for applications, is an unsigned integer of the form XYYZZ
  4513. corresponding to the source version X.Y.Z (leading zeros in Y and Z).
  4514. Beta versions were given the previous public release number plus a
  4515. letter, until version 1.0.6j; from then on they were given the upcoming
  4516. public release number plus "betaNN" or "rcNN".
  4517. .SH "SEE ALSO"
  4518. .IR libpngpf(3) ", " png(5)
  4519. .LP
  4520. .IR libpng :
  4521. .IP
  4522. https://libpng.sourceforge.io/ (follow the [DOWNLOAD] link)
  4523. http://www.libpng.org/pub/png
  4524. .LP
  4525. .IR zlib :
  4526. .IP
  4527. (generally) at the same location as
  4528. .I libpng
  4529. or at
  4530. .br
  4531. https://zlib.net/
  4532. .LP
  4533. .IR PNG specification: RFC 2083
  4534. .IP
  4535. (generally) at the same location as
  4536. .I libpng
  4537. or at
  4538. .br
  4539. https://www.ietf.org/rfc/rfc2083.txt
  4540. .br
  4541. or (as a W3C Recommendation) at
  4542. .br
  4543. https://www.w3.org/TR/REC-png.html
  4544. .LP
  4545. In the case of any inconsistency between the PNG specification
  4546. and this library, the specification takes precedence.
  4547. .SH AUTHORS
  4548. This man page:
  4549. Initially created by Glenn Randers-Pehrson.
  4550. Maintained by Cosmin Truta.
  4551. The contributing authors would like to thank all those who helped
  4552. with testing, bug fixes, and patience. This wouldn't have been
  4553. possible without all of you.
  4554. Thanks to Frank J. T. Wojcik for helping with the documentation.
  4555. Libpng:
  4556. Initially created in 1995 by Guy Eric Schalnat, then of Group 42, Inc.
  4557. Maintained by Cosmin Truta.
  4558. Supported by the PNG development group
  4559. .br
  4560. png-mng-implement at lists.sourceforge.net (subscription required; visit
  4561. https://lists.sourceforge.net/lists/listinfo/png-mng-implement
  4562. to subscribe).
  4563. .\" end of man page