libpng.3 267 KB

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