pngwriter.h 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762
  1. /********************************* PNGwriter **********************************
  2. *
  3. * Website: Main: http://pngwriter.sourceforge.net/
  4. * GitHub.com: https://github.com/pngwriter/pngwriter
  5. * Sourceforge.net: http://sourceforge.net/projects/pngwriter/
  6. *
  7. *
  8. * Author: Paul Blackburn https://github.com/individual61
  9. * Axel Huebl https://github.com/ax3l
  10. *
  11. * Email: individual61@users.sourceforge.net
  12. *
  13. * Version: 0.7.0 (January 2018)
  14. *
  15. * Description: Library that allows plotting a 48 bit
  16. * PNG image pixel by pixel, which can
  17. * then be opened with a graphics program.
  18. *
  19. * License: GNU General Public License
  20. * (C) 2002-2018 Paul Blackburn
  21. * (C) 2013-2018 Axel Huebl
  22. *
  23. ******************************************************************************/
  24. /*
  25. * This program is free software; you can redistribute it and/or modify
  26. * it under the terms of the GNU General Public License as published by
  27. * the Free Software Foundation; either version 2 of the License, or
  28. * (at your option) any later version.
  29. *
  30. * This program is distributed in the hope that it will be useful,
  31. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  32. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  33. * GNU General Public License for more details.
  34. *
  35. * You should have received a copy of the GNU General Public License
  36. * along with this program; if not, write to the Free Software
  37. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  38. *
  39. * */
  40. #ifndef PNGWRITER_H
  41. #define PNGWRITER_H 1
  42. #define PNGWRITER_VERSION_MAJOR 0
  43. #define PNGWRITER_VERSION_MINOR 7
  44. #define PNGWRITER_VERSION_PATCH 0
  45. /* deprecated old define in style MAJOR.MINORREVISION, e.g., 0.56 for 0.5.6 */
  46. #define PNGWRITER_PASTE(x,y,z) x ## . ## y ## z
  47. #define PNGWRITER_EVALUATE(x,y,z) PNGWRITER_PASTE(x,y,z)
  48. #define PNGWRITER_VERSION PNGWRITER_EVALUATE(PNGWRITER_VERSION_MAJOR, PNGWRITER_VERSION_MINOR, PNGWRITER_VERSION_PATCH)
  49. /* includes */
  50. #include <png.h>
  51. #if (PNG_LIBPNG_VER >= 10500)
  52. #include <zlib.h>
  53. #endif
  54. // REMEMBER TO ADD -DNO_FREETYPE TO YOUR COMPILATION FLAGS IF PNGwriter WAS
  55. // COMPILED WITHOUT FREETYPE SUPPORT!!!
  56. //
  57. // <png.h> must be included before FreeType headers.
  58. #ifndef NO_FREETYPE
  59. #include <ft2build.h>
  60. #include FT_FREETYPE_H
  61. #endif
  62. #include <iostream>
  63. #include <string>
  64. #include <ios>
  65. #include <cmath>
  66. #include <cwchar>
  67. #include <cstring>
  68. #include <cstdlib>
  69. #include <cstdio>
  70. #include <csetjmp>
  71. #define PNG_BYTES_TO_CHECK (4)
  72. #define PNGWRITER_DEFAULT_COMPRESSION (6)
  73. class pngwriterfont
  74. {
  75. public:
  76. pngwriterfont(const char *path, std::string& error);
  77. ~pngwriterfont();
  78. class LoadingError: public std::exception
  79. {
  80. };
  81. FT_Face& getFontFace();
  82. bool ready() const;
  83. private:
  84. FT_Library library;
  85. FT_Face face;
  86. bool loaded;
  87. };
  88. class pngwriter
  89. {
  90. private:
  91. std::string filename_;
  92. std::string textauthor_;
  93. std::string textdescription_;
  94. std::string texttitle_;
  95. std::string textsoftware_;
  96. int height_;
  97. int width_;
  98. int backgroundcolour_;
  99. int bit_depth_;
  100. int colortype_;
  101. int compressionlevel_;
  102. bool transformation_; // Required by Mikkel's patch
  103. unsigned char * * graph_;
  104. double filegamma_;
  105. double screengamma_;
  106. void circle_aux(int xcentre, int ycentre, int x, int y, int red, int green, int blue);
  107. void circle_aux_blend(int xcentre, int ycentre, int x, int y, double opacity, int red, int green, int blue);
  108. int static check_if_png(char *file_name, FILE **fp);
  109. int static read_png_info(FILE *fp, png_structp *png_ptr, png_infop *info_ptr);
  110. int static read_png_image(FILE *fp, png_structp png_ptr, png_infop info_ptr,
  111. png_bytepp *image, png_uint_32& width, png_uint_32& height);
  112. void flood_fill_internal( int xstart, int ystart, double start_red, double start_green, double start_blue, double fill_red, double fill_green, double fill_blue);
  113. void flood_fill_internal_blend( int xstart, int ystart, double opacity, double start_red, double start_green, double start_blue, double fill_red, double fill_green, double fill_blue);
  114. #ifndef NO_FREETYPE
  115. void my_draw_bitmap( FT_Bitmap * bitmap, int x, int y, double red, double green, double blue);
  116. void my_draw_bitmap_blend( FT_Bitmap * bitmap, int x, int y,double opacity, double red, double green, double blue);
  117. #endif
  118. /* The algorithms HSVtoRGB and RGBtoHSV were found at http://www.cs.rit.edu/~ncs/
  119. * which is a page that belongs to Nan C. Schaller, though
  120. * these algorithms appear to be the work of Eugene Vishnevsky.
  121. * */
  122. void static HSVtoRGB( double *r, double *g, double *b, double h, double s, double v );
  123. void static RGBtoHSV( float r, float g, float b, float *h, float *s, float *v );
  124. /* drwatop(), drawbottom() and filledtriangle() were contributed by Gurkan Sengun
  125. * ( <gurkan@linuks.mine.nu>, http://www.linuks.mine.nu/ )
  126. * */
  127. void drawtop(long x1,long y1,long x2,long y2,long x3, int red, int green, int blue);
  128. void drawbottom(long x1,long y1,long x2,long x3,long y3, int red, int green, int blue);
  129. void drawbottom_blend(long x1,long y1,long x2,long x3,long y3, double opacity, int red, int green, int blue);
  130. void drawtop_blend(long x1,long y1,long x2,long y2,long x3, double opacity, int red, int green, int blue);
  131. /* free up memory of member variables and reset internal pointers to NULL */
  132. void deleteMembers();
  133. public:
  134. /* General Notes
  135. * It is important to remember that all functions that accept an argument of type "const char *" will also
  136. * accept "char *", this is done so you can have a changing filename (to make many PNG images in series
  137. * with a different name, for example), and to allow you to use string type objects which can be easily
  138. * turned into const char * (if theString is an object of type string, then it can be used as a const char *
  139. * by saying theString.c_str()).
  140. * It is also important to remember that whenever a function has a colour coeffiecient as its argument,
  141. * that argument can be either an int from 0 to 65535 or a double from 0.0 to 1.0.
  142. * It is important to make sure that you are calling the function with the type that you want.
  143. * Remember that 1 is an int, while 1.0 is a double, and will thus determine what version of the function
  144. * will be used. Similarly, do not make the mistake of calling for example plot(x, y, 0.0, 0.0, 65535),
  145. * because
  146. * there is no plot(int, int, double, double, int).
  147. * Also, please note that plot() and read() (and the functions that use them internally)
  148. * are protected against entering, for example, a colour coefficient that is over 65535
  149. * or over 1.0. Similarly, they are protected against negative coefficients. read() will return 0
  150. * when called outside the image range. This is actually useful as zero-padding should you need it.
  151. * */
  152. /* Compilation
  153. * A typical compilation would look like this:
  154. *
  155. * g++ my_program.cc -o my_program freetype-config --cflags \
  156. * -I/usr/local/include -L/usr/local/lib -lpng -lpngwriter -lz -lfreetype
  157. *
  158. * If you did not compile PNGwriter with FreeType support, then remove the
  159. * FreeType-related flags and add -DNO_FREETYPE above.
  160. * */
  161. /* Constructor
  162. * The constructor requires the width and the height of the image, the background colour for the
  163. * image and the filename of the file (a pointer or simple "myfile.png"). The background colour
  164. * can only be initialized to a shade of grey (once the object has been created you can do whatever
  165. * you want, though), because generally one wants either a white (65535 or 1.0) or a black (0 or 0.0)
  166. * background to start with.
  167. * The default constructor creates a PNGwriter instance that is 250x250, white background,
  168. * and filename "out.png".
  169. * Tip: The filename can be given as easily as:
  170. * pngwriter mypng(300, 300, 0.0, "myfile.png");
  171. * Tip: If you are going to create a PNGwriter instance for reading in a file that already exists,
  172. * then width and height can be 1 pixel, and the size will be automatically adjusted once you use
  173. * readfromfile().
  174. * */
  175. pngwriter();
  176. pngwriter(const pngwriter &rhs);
  177. pngwriter(int width, int height, int backgroundcolour, char * filename);
  178. pngwriter(int width, int height, double backgroundcolour, char * filename);
  179. pngwriter(int width, int height, int backgroundcolour, const char * filename);
  180. pngwriter(int width, int height, double backgroundcolour, const char * filename);
  181. /* Destructor
  182. * */
  183. ~pngwriter();
  184. /* Assignment Operator
  185. * */
  186. pngwriter & operator = (const pngwriter & rhs);
  187. /* Plot
  188. * With this function a pixel at coordinates (x, y) can be set to the desired colour.
  189. * The pixels are numbered starting from (1, 1) and go to (width, height).
  190. * As with most functions in PNGwriter, it has been overloaded to accept either int arguments
  191. * for the colour coefficients, or those of type double. If they are of type int,
  192. * they go from 0 to 65535. If they are of type double, they go from 0.0 to 1.0.
  193. * Tip: To plot using red, then specify plot(x, y, 1.0, 0.0, 0.0). To make pink,
  194. * just add a constant value to all three coefficients, like this:
  195. * plot(x, y, 1.0, 0.4, 0.4).
  196. * Tip: If nothing is being plotted to your PNG file, make sure that you remember
  197. * to close() the instance before your program is finished, and that the x and y position
  198. * is actually within the bounds of your image. If either is not, then PNGwriter will
  199. * not complain-- it is up to you to check for this!
  200. * Tip: If you try to plot with a colour coefficient out of range, a maximum or minimum
  201. * coefficient will be assumed, according to the given coefficient. For example, attempting
  202. * to plot plot(x, y, 1.0,-0.2,3.7) will set the green coefficient to 0 and the red coefficient
  203. * to 1.0.
  204. * */
  205. void plot(int x, int y, int red, int green, int blue);
  206. void plot(int x, int y, double red, double green, double blue);
  207. /* Plot HSV
  208. * With this function a pixel at coordinates (x, y) can be set to the desired colour,
  209. * but with the colour coefficients given in the Hue, Saturation, Value colourspace.
  210. * This has the advantage that one can determine the colour that will be plotted with
  211. * only one parameter, the Hue. The colour coefficients must go from 0 to 65535 and
  212. * be of type int, or be of type double and go from 0.0 to 1.0.
  213. * */
  214. void plotHSV(int x, int y, double hue, double saturation, double value);
  215. void plotHSV(int x, int y, int hue, int saturation, int value);
  216. /* Read
  217. * With this function we find out what colour the pixel (x, y) is. If "colour" is 1,
  218. * it will return the red coefficient, if it is set to 2, the green one, and if
  219. * it set to 3, the blue colour coefficient will be returned,
  220. * and this returned value will be of type int and be between 0 and 65535.
  221. * Note that if you call read() on a pixel outside the image range, the value returned
  222. * will be 0.
  223. * */
  224. int read(int x, int y, int colour) const;
  225. /* Read, Average
  226. * Same as the above, only that the average of the three colour coefficients is returned.
  227. */
  228. int read(int x, int y) const;
  229. /* dRead
  230. * With this function we find out what colour the pixel (x, y) is. If "colour" is 1,
  231. * it will return the red coefficient, if it is set to 2, the green one, and if
  232. * it set to 3, the blue colour coefficient will be returned,
  233. * and this returned value will be of type double and be between 0.0 and 1.0.
  234. * Note that if you call dread() outside the image range, the value returned will be 0.0
  235. * */
  236. double dread(int x, int y, int colour) const;
  237. /* dRead, Average
  238. * Same as the above, only that the average of the three colour coefficients is returned.
  239. */
  240. double dread(int x, int y) const;
  241. /* Read HSV
  242. * With this function we find out what colour the pixel (x, y) is, but in the Hue,
  243. * Saturation, Value colourspace. If "colour" is 1,
  244. * it will return the Hue coefficient, if it is set to 2, the Saturation one, and if
  245. * it set to 3, the Value colour coefficient will be returned, and this returned
  246. * value will be of type int and be between 0 and 65535. Important: If you attempt
  247. * to read the Hue of a pixel that is a shade of grey, the value returned will be
  248. * nonsensical or even NaN. This is just the way the RGB -> HSV algorithm works:
  249. * the Hue of grey is not defined. You might want to check whether the pixel
  250. * you are reading is grey before attempting a readHSV().
  251. * Tip: This is especially useful for categorizing sections of the image according
  252. * to their colour.
  253. * */
  254. int readHSV(int x, int y, int colour) const;
  255. /* dRead HSV
  256. * With this function we find out what colour the pixel (x, y) is, but in the Hue,
  257. * Saturation, Value colourspace. If "colour" is 1,
  258. * it will return the Hue coefficient, if it is set to 2, the Saturation one, and if
  259. * it set to 3, the Value colour coefficient will be returned,
  260. * and this returned value will be of type double and be between 0.0 and 1.0.
  261. * */
  262. double dreadHSV(int x, int y, int colour) const;
  263. /* Clear
  264. * The whole image is set to black.
  265. * */
  266. void clear(void);
  267. /* Close
  268. * Close the instance of the class, and write the image to disk.
  269. * Tip: If you do not call this function before your program ends, no image
  270. * will be written to disk.
  271. * */
  272. void close(void);
  273. /* Rename
  274. * To rename the file once an instance of pngwriter has been created.
  275. * Useful for assigning names to files based upon their content.
  276. * Tip: This is as easy as calling pngwriter_rename("newname.png")
  277. * If the argument is a long unsigned int, for example 77, the filename will be changed to
  278. * 0000000077.png
  279. * Tip: Use this to create sequences of images for movie generation.
  280. * */
  281. void pngwriter_rename(char * newname);
  282. void pngwriter_rename(const char * newname);
  283. void pngwriter_rename(long unsigned int index);
  284. /* Figures
  285. * These functions draw basic shapes. Available in both int and double versions.
  286. * The line functions use the fast Bresenham algorithm. Despite the name,
  287. * the square functions draw rectangles. The circle functions use a fast
  288. * integer math algorithm. The filled circle functions make use of sqrt().
  289. * */
  290. void line(int xfrom, int yfrom, int xto, int yto, int red, int green,int blue);
  291. void line(int xfrom, int yfrom, int xto, int yto, double red, double green,double blue);
  292. void triangle(int x1, int y1, int x2, int y2, int x3, int y3, int red, int green, int blue);
  293. void triangle(int x1, int y1, int x2, int y2, int x3, int y3, double red, double green, double blue);
  294. void square(int xfrom, int yfrom, int xto, int yto, int red, int green,int blue);
  295. void square(int xfrom, int yfrom, int xto, int yto, double red, double green,double blue);
  296. void filledsquare(int xfrom, int yfrom, int xto, int yto, int red, int green,int blue);
  297. void filledsquare(int xfrom, int yfrom, int xto, int yto, double red, double green,double blue);
  298. void circle(int xcentre, int ycentre, int radius, int red, int green, int blue);
  299. void circle(int xcentre, int ycentre, int radius, double red, double green, double blue);
  300. void filledcircle(int xcentre, int ycentre, int radius, int red, int green, int blue);
  301. void filledcircle(int xcentre, int ycentre, int radius, double red, double green, double blue);
  302. /* Read From File
  303. * Open the existing PNG image, and copy it into this instance of the class. It is important to mention
  304. * that PNG variants are supported. Very generally speaking, most PNG files can now be read (as of version 0.5.4),
  305. * but if they have an alpha channel it will be completely stripped. If the PNG file uses GIF-style transparency
  306. * (where one colour is chosen to be transparent), PNGwriter will not read the image properly, but will not
  307. * complain. Also, if any ancillary chunks are included in the PNG file (chroma, filter, etc.), it will render
  308. * with a slightly different tonality. For the vast majority of PNGs, this should not be an issue. Note:
  309. * If you read an 8-bit PNG, the internal representation of that instance of PNGwriter will be 8-bit (PNG
  310. * files of less than 8 bits will be upscaled to 8 bits). To convert it to 16-bit, just loop over all pixels,
  311. * reading them into a new instance of PNGwriter. New instances of PNGwriter are 16-bit by default.
  312. * */
  313. bool readfromfile(char * name);
  314. bool readfromfile(const char * name);
  315. /* Get Height
  316. * When you open a PNG with readfromfile() you can find out its height with this function.
  317. * */
  318. int getheight(void) const;
  319. /* Get Width
  320. * When you open a PNG with readfromfile() you can find out its width with this function.
  321. * */
  322. int getwidth(void) const;
  323. /* Set Compression Level
  324. * Set the compression level that will be used for the image. -1 is to use the default,
  325. * 0 is none, 9 is best compression.
  326. * Remember that this will affect how long it will take to close() the image. A value of 2 or 3
  327. * is good enough for regular use, but for storage or transmission you might want to take the time
  328. * to set it at 9.
  329. * */
  330. void setcompressionlevel(int level);
  331. /* Get Bit Depth
  332. * When you open a PNG with readfromfile() you can find out its bit depth with this function.
  333. * Mostly for troubleshooting uses.
  334. * */
  335. int getbitdepth(void) const;
  336. /* Get Colour Type
  337. * When you open a PNG with readfromfile() you can find out its colour type (libpng categorizes
  338. * different styles of image data with this number).
  339. * Mostly for troubleshooting uses.
  340. * */
  341. int getcolortype(void) const;
  342. /* Set Gamma Coeff
  343. * Set the image's gamma (file gamma) coefficient. This is experimental, but use it if your image's colours seem too bright
  344. * or too dark. The default value of 0.5 should be fine. The standard disclaimer about Mac and PC gamma
  345. * settings applies.
  346. * */
  347. void setgamma(double gamma);
  348. /* Get Gamma Coeff
  349. * Get the image's gamma coefficient. This is experimental.
  350. * */
  351. double getgamma(void) const;
  352. /* Bezier Curve
  353. * (After Frenchman Pierre Bezier from Regie Renault)
  354. * A collection of formulae for describing curved lines
  355. * and surfaces, first used in 1972 to model automobile surfaces.
  356. * (from the The Free On-line Dictionary of Computing)
  357. * See http://www.moshplant.com/direct-or/bezier/ for one of many
  358. * available descriptions of bezier curves.
  359. * There are four points used to define the curve: the two endpoints
  360. * of the curve are called the anchor points, while the other points,
  361. * which define the actual curvature, are called handles or control points.
  362. * Moving the handles lets you modify the shape of the curve.
  363. * */
  364. void bezier( int startPtX, int startPtY,
  365. int startControlX, int startControlY,
  366. int endPtX, int endPtY,
  367. int endControlX, int endControlY,
  368. double red, double green, double blue);
  369. void bezier( int startPtX, int startPtY,
  370. int startControlX, int startControlY,
  371. int endPtX, int endPtY,
  372. int endControlX, int endControlY,
  373. int red, int green, int blue);
  374. /* Set Text
  375. * Sets the text information in the PNG header. If it is not called, the default is used.
  376. */
  377. void settext(char * title, char * author, char * description, char * software);
  378. void settext(const char * title, const char * author, const char * description, const char * software);
  379. /* Version Number
  380. * Returns the PNGwriter version number.
  381. */
  382. static double version(void);
  383. /* Write PNG
  384. * Writes the PNG image to disk. You can still change the PNGwriter instance after this.
  385. * Tip: This is exactly the same as close(), but easier to remember.
  386. * Tip: To make a sequence of images using only one instance of PNGwriter, alter the image, change its name,
  387. * write_png(), then alter the image, change its name, write_png(), etc.
  388. */
  389. void write_png(void);
  390. /* Plot Text
  391. * Uses the Freetype2 library to set text in the image. face_path is the file path to a
  392. * TrueType font file (.ttf) (FreeType2 can also handle other types). fontsize specifices the approximate
  393. * height of the rendered font in pixels. x_start and y_start specify the placement of the
  394. * lower, left corner of the text string. angle is the text angle in radians. text is the text to be rendered.
  395. * The colour coordinates can be doubles from 0.0 to 1.0 or ints from 0 to 65535.
  396. * Tip: PNGwriter installs a few fonts in /usr/local/share/pngwriter/fonts to get you started.
  397. * Tip: Remember to add -DNO_FREETYPE to your compilation flags if PNGwriter was compiled without FreeType support.
  398. * */
  399. void plot_text(pngwriterfont& font, int fontsize, int x_start, int y_start, double angle, char * text, double red, double green, double blue);
  400. void plot_text(pngwriterfont& font, int fontsize, int x_start, int y_start, double angle, char * text, int red, int green, int blue);
  401. void plot_text(char * face_path, int fontsize, int x_start, int y_start, double angle, char * text, double red, double green, double blue);
  402. void plot_text(char * face_path, int fontsize, int x_start, int y_start, double angle, char * text, int red, int green, int blue);
  403. /* Plot UTF-8 Text
  404. * Same as the above, but the text to be plotted is encoded in UTF-8. Why would you want this? To be able to plot
  405. * all characters available in a large TrueType font, for example: for rendering Japenese, Chinese and other
  406. * languages not restricted to the standard 128 character ASCII space.
  407. * Tip: The quickest way to get a string into UTF-8 is to write it in an adequate text editor, and save it as a file
  408. * in UTF-8 encoding, which can then be read in in binary mode.
  409. * */
  410. void plot_text_utf8(char * face_path, int fontsize, int x_start, int y_start, double angle, char * text, double red, double green, double blue);
  411. void plot_text_utf8(char * face_path, int fontsize, int x_start, int y_start, double angle, char * text, int red, int green, int blue);
  412. /* Bilinear Interpolation of Image
  413. * Given a floating point coordinate (x from 0.0 to width, y from 0.0 to height),
  414. * this function will return the interpolated colour intensity specified by
  415. * colour (where red = 1, green = 2, blue = 3).
  416. * bilinear_interpolate_read() returns an int from 0 to 65535, and
  417. * bilinear_interpolate_dread() returns a double from 0.0 to 1.0.
  418. * Tip: Especially useful for enlarging an image.
  419. * */
  420. int bilinear_interpolation_read(double x, double y, int colour) const;
  421. double bilinear_interpolation_dread(double x, double y, int colour) const;
  422. /* Plot Blend
  423. * Plots the colour given by red, green blue, but blended with the existing pixel
  424. * value at that position. opacity is a double that goes from 0.0 to 1.0.
  425. * 0.0 will not change the pixel at all, and 1.0 will plot the given colour.
  426. * Anything in between will be a blend of both pixel levels. Please note: This is neither
  427. * alpha channel nor PNG transparency chunk support. This merely blends the plotted pixels.
  428. * */
  429. void plot_blend(int x, int y, double opacity, int red, int green, int blue);
  430. void plot_blend(int x, int y, double opacity, double red, double green, double blue);
  431. /* Invert
  432. * Inverts the image in RGB colourspace.
  433. * */
  434. void invert(void);
  435. /* Resize Image
  436. * Resizes the PNGwriter instance. Note: All image data is set to black (this is
  437. * a resizing, not a scaling, of the image).
  438. * */
  439. void resize(int width, int height);
  440. /* Boundary Fill
  441. * All pixels adjacent to the start pixel will be filled with the fill colour, until the boundary colour is encountered.
  442. * For example, calling boundary_fill() with the boundary colour set to red, on a pixel somewhere inside a red circle,
  443. * will fill the entire circle with the desired fill colour. If, on the other hand, the circle is not the boundary colour,
  444. * the rest of the image will be filled.
  445. * The colour components are either doubles from 0.0 to 1.0 or ints from 0 to 65535.
  446. * */
  447. void boundary_fill(int xstart, int ystart, double boundary_red,double boundary_green,double boundary_blue,double fill_red, double fill_green, double fill_blue) ;
  448. void boundary_fill(int xstart, int ystart, int boundary_red,int boundary_green,int boundary_blue,int fill_red, int fill_green, int fill_blue) ;
  449. /* Flood Fill
  450. * All pixels adjacent to the start pixel will be filled with the fill colour, if they are the same colour as the
  451. * start pixel. For example, calling flood_fill() somewhere in the interior of a solid blue rectangle will colour
  452. * the entire rectangle the fill colour. The colour components are either doubles from 0.0 to 1.0 or ints from 0 to 65535.
  453. * */
  454. void flood_fill(int xstart, int ystart, double fill_red, double fill_green, double fill_blue) ;
  455. void flood_fill(int xstart, int ystart, int fill_red, int fill_green, int fill_blue) ;
  456. /* Polygon
  457. * This function takes an array of integer values containing the coordinates of the vertexes of a polygon.
  458. * Note that if you want a closed polygon, you must repeat the first point's coordinates for the last point.
  459. * It also requires the number of points contained in the array. For example, if you wish to plot a triangle,
  460. * the array will contain 6 elements, and the number of points is 3. Be very careful about this; if you specify the wrong number
  461. * of points, your program will either segfault or produce points at nonsensical coordinates.
  462. * The colour components are either doubles from 0.0 to 1.0 or ints from 0 to 65535.
  463. * */
  464. void polygon(int * points, int number_of_points, double red, double green, double blue);
  465. void polygon(int * points, int number_of_points, int red, int green, int blue);
  466. /* Plot CMYK
  467. * Plot a point in the Cyan, Magenta, Yellow, Black colourspace. Please note that this colourspace is
  468. * lossy, i.e. it cannot reproduce all colours on screen that RGB can. The difference, however, is
  469. * barely noticeable. The algorithm used is a standard one. The colour components are either
  470. * doubles from 0.0 to 1.0 or ints from 0 to 65535.
  471. * */
  472. void plotCMYK(int x, int y, double cyan, double magenta, double yellow, double black);
  473. void plotCMYK(int x, int y, int cyan, int magenta, int yellow, int black);
  474. /* Read CMYK, Double version
  475. * Get a pixel in the Cyan, Magenta, Yellow, Black colourspace. if 'colour' is 1, the Cyan component will be returned
  476. * as a double from 0.0 to 1.0. If 'colour is 2, the Magenta colour component will be returned, and so on, up to 4.
  477. * */
  478. double dreadCMYK(int x, int y, int colour) const;
  479. /* Read CMYK
  480. * Same as the above, but the colour components returned are an int from 0 to 65535.
  481. * */
  482. int readCMYK(int x, int y, int colour) const;
  483. /* Scale Proportional
  484. * Scale the image using bilinear interpolation. If k is greater than 1.0, the image will be enlarged.
  485. * If k is less than 1.0, the image will be shrunk. Negative or null values of k are not allowed.
  486. * The image will be resized and the previous content will be replaced by the scaled image.
  487. * Tip: use getheight() and getwidth() to find out the new width and height of the scaled image.
  488. * Note: After scaling, all images will have a bit depth of 16, even if the original image had
  489. * a bit depth of 8.
  490. * */
  491. void scale_k(double k);
  492. /* Scale Non-Proportional
  493. * Scale the image using bilinear interpolation, with different horizontal and vertical scale factors.
  494. * */
  495. void scale_kxky(double kx, double ky);
  496. /* Scale To Target Width and Height
  497. * Scale the image in such a way as to meet the target width and height.
  498. * Tip: if you want to keep the image proportional, scale_k() might be more appropriate.
  499. * */
  500. void scale_wh(int finalwidth, int finalheight);
  501. /* Blended Functions
  502. * All these functions are identical to their non-blended types. They take an extra argument, opacity, which is
  503. * a double from 0.0 to 1.0 and represents how much of the original pixel value is retained when plotting the
  504. * new pixel. In other words, if opacity is 0.7, then after plotting, the new pixel will be 30% of the
  505. * original colour the pixel was, and 70% of the new colour, whatever that may be. As usual, each function
  506. * is available in int or double versions. Please note: This is neither alpha channel nor PNG transparency chunk support. This merely blends the plotted pixels.
  507. * */
  508. // Start Blended Functions
  509. void plotHSV_blend(int x, int y, double opacity, double hue, double saturation, double value);
  510. void plotHSV_blend(int x, int y, double opacity, int hue, int saturation, int value);
  511. void line_blend(int xfrom, int yfrom, int xto, int yto, double opacity, int red, int green,int blue);
  512. void line_blend(int xfrom, int yfrom, int xto, int yto, double opacity, double red, double green,double blue);
  513. void square_blend(int xfrom, int yfrom, int xto, int yto, double opacity, int red, int green,int blue);
  514. void square_blend(int xfrom, int yfrom, int xto, int yto, double opacity, double red, double green,double blue);
  515. void filledsquare_blend(int xfrom, int yfrom, int xto, int yto, double opacity, int red, int green,int blue);
  516. void filledsquare_blend(int xfrom, int yfrom, int xto, int yto, double opacity, double red, double green,double blue);
  517. void circle_blend(int xcentre, int ycentre, int radius, double opacity, int red, int green, int blue);
  518. void circle_blend(int xcentre, int ycentre, int radius, double opacity, double red, double green, double blue);
  519. void filledcircle_blend(int xcentre, int ycentre, int radius, double opacity, int red, int green, int blue);
  520. void filledcircle_blend(int xcentre, int ycentre, int radius, double opacity, double red, double green, double blue);
  521. void bezier_blend( int startPtX, int startPtY,
  522. int startControlX, int startControlY,
  523. int endPtX, int endPtY,
  524. int endControlX, int endControlY,
  525. double opacity,
  526. double red, double green, double blue);
  527. void bezier_blend( int startPtX, int startPtY,
  528. int startControlX, int startControlY,
  529. int endPtX, int endPtY,
  530. int endControlX, int endControlY,
  531. double opacity,
  532. int red, int green, int blue);
  533. void plot_text_blend(char * face_path, int fontsize, int x_start, int y_start, double angle, char * text, double opacity, double red, double green, double blue);
  534. void plot_text_blend(char * face_path, int fontsize, int x_start, int y_start, double angle, char * text, double opacity, int red, int green, int blue);
  535. void plot_text_utf8_blend(char * face_path, int fontsize, int x_start, int y_start, double angle, char * text, double opacity, double red, double green, double blue);
  536. void plot_text_utf8_blend(char * face_path, int fontsize, int x_start, int y_start, double angle, char * text, double opacity, int red, int green, int blue);
  537. void boundary_fill_blend(int xstart, int ystart, double opacity, double boundary_red,double boundary_green,double boundary_blue,double fill_red, double fill_green, double fill_blue) ;
  538. void boundary_fill_blend(int xstart, int ystart, double opacity, int boundary_red,int boundary_green,int boundary_blue,int fill_red, int fill_green, int fill_blue) ;
  539. void flood_fill_blend(int xstart, int ystart, double opacity, double fill_red, double fill_green, double fill_blue) ;
  540. void flood_fill_blend(int xstart, int ystart, double opacity, int fill_red, int fill_green, int fill_blue) ;
  541. void polygon_blend(int * points, int number_of_points, double opacity, double red, double green, double blue);
  542. void polygon_blend(int * points, int number_of_points, double opacity, int red, int green, int blue);
  543. void plotCMYK_blend(int x, int y, double opacity, double cyan, double magenta, double yellow, double black);
  544. void plotCMYK_blend(int x, int y, double opacity, int cyan, int magenta, int yellow, int black);
  545. // End of Blended Functions
  546. /* Laplacian
  547. * This function applies a discrete laplacian to the image, multiplied by a constant factor.
  548. * The kernel used in this case is:
  549. * 1.0 1.0 1.0
  550. * 1.0 -8.0 1.0
  551. * 1.0 1.0 1.0
  552. * Basically, this works as an edge detector. The current pixel is assigned the sum of all neighbouring
  553. * pixels, multiplied by the corresponding kernel element. For example, imagine a pixel and its 8 neighbours:
  554. * 1.0 1.0 0.0 0.0
  555. * 1.0 ->1.0<- 0.0 0.0
  556. * 1.0 1.0 0.0 0.0
  557. * This represents a border between white and black, black is on the right. Applying the laplacian to
  558. * the pixel specified above pixel gives:
  559. * 1.0*1.0 + 1.0*1.0 + 0.0*1.0 +
  560. * 1.0*1.0 + 1.0*-8.0 + 0.0*1.0 +
  561. * 1.0*1.0 + 1.0*1.0 + 0.0*1.0 = -3.0
  562. * Applying this to the pixel to the right of the pixel considered previously, we get a sum of 3.0.
  563. * That is, after passing over an edge, we get a high value for the pixel adjacent to the edge. Since
  564. * PNGwriter limits the colour components if they are off-scale, and the result of the laplacian
  565. * may be negative, a scale factor and an offset value are included. This might be useful for
  566. * keeping things within range or for bringing out more detail in the edge detection. The
  567. * final pixel value will be given by:
  568. * final value = laplacian(original pixel)*k + offset
  569. * Tip: Try a value of 1.0 for k to start with, and then experiment with other values.
  570. * */
  571. void laplacian(double k, double offset);
  572. /* Filled Triangle
  573. * Draws the triangle specified by the three pairs of points in the colour specified
  574. * by the colour coefficients. The colour components are either doubles from 0.0 to
  575. * 1.0 or ints from 0 to 65535.
  576. * */
  577. void filledtriangle(int x1,int y1,int x2,int y2,int x3,int y3, int red, int green, int blue);
  578. void filledtriangle(int x1,int y1,int x2,int y2,int x3,int y3, double red, double green, double blue);
  579. /* Filled Triangle, Blended
  580. * Draws the triangle specified by the three pairs of points in the colour specified
  581. * by the colour coefficients, and blended with the background. See the description for Blended Functions.
  582. * The colour components are either doubles from 0.0 to 1.0 or ints from 0 to 65535.
  583. * */
  584. void filledtriangle_blend(int x1,int y1,int x2,int y2,int x3,int y3, double opacity, int red, int green, int blue);
  585. void filledtriangle_blend(int x1,int y1,int x2,int y2,int x3,int y3, double opacity, double red, double green, double blue);
  586. /* Arrow, Filled Arrow
  587. * Plots an arrow from (x1, y1) to (x2, y2) with the arrowhead at the second point, given the size in pixels
  588. * and the angle in radians of the arrowhead. The plotted arrow consists of one main line, and two smaller
  589. * lines originating from the second point. Filled Arrow plots the same, but the arrowhead is a solid triangle.
  590. * Tip: An angle of 10 to 30 degrees looks OK.
  591. * */
  592. void arrow( int x1,int y1,int x2,int y2,int size, double head_angle, double red, double green, double blue);
  593. void arrow( int x1,int y1,int x2,int y2,int size, double head_angle, int red, int green, int blue);
  594. void filledarrow( int x1,int y1,int x2,int y2,int size, double head_angle, double red, double green, double blue);
  595. void filledarrow( int x1,int y1,int x2,int y2,int size, double head_angle, int red, int green, int blue);
  596. /* Cross, Maltese Cross
  597. * Plots a simple cross at x, y, with the specified height and width, and in the specified colour.
  598. * Maltese cross plots a cross, as before, but adds bars at the end of each arm of the cross.
  599. * The size of these bars is specified with x_bar_height and y_bar_width.
  600. * The cross will look something like this:
  601. *
  602. * ----- <-- ( y_bar_width)
  603. * |
  604. * |
  605. * |-------| <-- ( x_bar_height )
  606. * |
  607. * |
  608. * -----
  609. * */
  610. void cross( int x, int y, int xwidth, int yheight, double red, double green, double blue);
  611. void cross( int x, int y, int xwidth, int yheight, int red, int green, int blue);
  612. void maltesecross( int x, int y, int xwidth, int yheight, int x_bar_height, int y_bar_width, double red, double green, double blue);
  613. void maltesecross( int x, int y, int xwidth, int yheight, int x_bar_height, int y_bar_width, int red, int green, int blue);
  614. /* Diamond and filled diamond
  615. * Plots a diamond shape, given the x, y position, the width and height, and the colour.
  616. * Filled diamond plots a filled diamond.
  617. * */
  618. void filleddiamond( int x, int y, int width, int height, int red, int green, int blue);
  619. void diamond(int x, int y, int width, int height, int red, int green, int blue);
  620. void filleddiamond( int x, int y, int width, int height, double red, double green, double blue);
  621. void diamond(int x, int y, int width, int height, double red, double green, double blue);
  622. /* Get Text Width, Get Text Width UTF8
  623. * Returns the approximate width, in pixels, of the specified *unrotated* text. It is calculated by adding
  624. * each letter's width and kerning value (as specified in the TTF file). Note that this will not
  625. * give the position of the farthest pixel, but it will give a pretty good idea of what area the
  626. * text will occupy. Tip: The text, when plotted unrotated, will fit approximately in a box with its lower left corner at
  627. * (x_start, y_start) and upper right at (x_start + width, y_start + size), where width is given by get_text_width()
  628. * and size is the specified size of the text to be plotted. Tip: Text plotted at position
  629. * (x_start, y_start), rotated with a given 'angle', and of a given 'size'
  630. * whose width is 'width', will fit approximately inside a rectangle whose corners are at
  631. * 1 (x_start, y_start)
  632. * 2 (x_start + width*cos(angle), y_start + width*sin(angle))
  633. * 3 (x_start + width*cos(angle) - size*sin(angle), y_start + width*sin(angle) + size*cos(angle))
  634. * 4 (x_start - size*sin(angle), y_start + size*cos(angle))
  635. * */
  636. int static get_text_width(pngwriterfont &font, int fontsize, char * text);
  637. int static get_text_width(char * face_path, int fontsize, char * text);
  638. int static get_text_width_utf8(char * face_path, int fontsize, char * text);
  639. };
  640. #endif