/* * libcucul Canvas for ultrafast compositing of Unicode letters * Copyright (c) 2002-2006 Sam Hocevar * 2006 Jean-Yves Lamoureux * All Rights Reserved * * $Id$ * * This library is free software; you can redistribute it and/or * modify it under the terms of the Do What The Fuck You Want To * Public License, Version 2, as published by Sam Hocevar. See * http://sam.zoy.org/wtfpl/COPYING for more details. */ /* * This file contains various export functions */ #include "config.h" #include "common.h" #if !defined(__KERNEL__) # if defined(HAVE_ERRNO_H) # include # endif # include # include # include #endif #include "cucul.h" #include "cucul_internals.h" static int export_caca(cucul_canvas_t *, cucul_buffer_t *); static int export_ansi(cucul_canvas_t *, cucul_buffer_t *); static int export_utf8(cucul_canvas_t *, cucul_buffer_t *); static int export_html(cucul_canvas_t *, cucul_buffer_t *); static int export_html3(cucul_canvas_t *, cucul_buffer_t *); static int export_irc(cucul_canvas_t *, cucul_buffer_t *); static int export_ps(cucul_canvas_t *, cucul_buffer_t *); static int export_svg(cucul_canvas_t *, cucul_buffer_t *); static int export_tga(cucul_canvas_t *, cucul_buffer_t *); /** \brief Export a canvas into a foreign format. * * This function exports a libcucul canvas into various foreign formats such * as ANSI art, HTML, IRC colours, etc. One should use cucul_get_buffer_data() * and cucul_get_buffer_size() to access the buffer contents. The allocated * data is valid until cucul_free_buffer() is called. * * Valid values for \c format are: * - \c "caca": export native libcaca files. * - \c "ansi": export ANSI art (CP437 charset with ANSI colour codes). * - \c "html": export an HTML page with CSS information. * - \c "html3": export an HTML table that should be compatible with * most navigators, including textmode ones. * - \c "irc": export UTF-8 text with mIRC colour codes. * - \c "ps": export a PostScript document. * - \c "svg": export an SVG vector image. * - \c "tga": export a TGA image. * * If an error occurs, NULL is returned and \b errno is set accordingly: * - \c EINVAL Unsupported format requested. * - \c ENOMEM Not enough memory to allocate output buffer. * * \param cv A libcucul canvas * \param format A string describing the requested output format. * \return A libcucul buffer, or NULL in case of error. */ cucul_buffer_t * cucul_export_canvas(cucul_canvas_t *cv, char const *format) { cucul_buffer_t *ex; int ret = -1; ex = malloc(sizeof(cucul_buffer_t)); if(!ex) { #if defined(HAVE_ERRNO_H) errno = ENOMEM; #endif return NULL; } ex->size = 0; ex->data = NULL; ex->user_data = 0; if(!strcasecmp("caca", format)) ret = export_caca(cv, ex); else if(!strcasecmp("ansi", format)) ret = export_ansi(cv, ex); else if(!strcasecmp("utf8", format)) ret = export_utf8(cv, ex); else if(!strcasecmp("html", format)) ret = export_html(cv, ex); else if(!strcasecmp("html3", format)) ret = export_html3(cv, ex); else if(!strcasecmp("irc", format)) ret = export_irc(cv, ex); else if(!strcasecmp("ps", format)) ret = export_ps(cv, ex); else if(!strcasecmp("svg", format)) ret = export_svg(cv, ex); else if(!strcasecmp("tga", format)) ret = export_tga(cv, ex); if(ret < 0) { free(ex); #if defined(HAVE_ERRNO_H) errno = EINVAL; #endif return NULL; } return ex; } /** \brief Get available export formats * * Return a list of available export formats. The list is a NULL-terminated * array of strings, interleaving a string containing the internal value for * the export format, to be used with cucul_export_canvas(), and a string * containing the natural language description for that export format. * * This function never fails. * * \return An array of strings. */ char const * const * cucul_get_export_list(void) { static char const * const list[] = { "caca", "native libcaca format", "ansi", "ANSI", "utf8", "UTF-8 with ANSI escape codes", "html", "HTML", "html3", "backwards-compatible HTML", "irc", "IRC with mIRC colours", "ps", "PostScript document", "svg", "SVG vector image", "tga", "TGA image", NULL, NULL }; return list; } /* * XXX: the following functions are local. */ /* Generate a native libcaca canvas file. */ static int export_caca(cucul_canvas_t *cv, cucul_buffer_t *ex) { uint32_t *attr = cv->attr; uint32_t *chars = cv->chars; char *cur; uint32_t w, h; unsigned int n; /* 16 bytes for the canvas, 8 bytes for each character cell. */ ex->size = 16 + 8 * cv->width * cv->height; ex->data = malloc(ex->size); cur = ex->data; w = cv->width; h = cv->height; cur += sprintf(cur, "CACACANV%c%c%c%c%c%c%c%c", (unsigned char)(w >> 24), (unsigned char)((w >> 16) & 0xff), (unsigned char)((w >> 8) & 0xff), (unsigned char)(w & 0xff), (unsigned char)(h >> 24), (unsigned char)((h >> 16) & 0xff), (unsigned char)((h >> 8) & 0xff), (unsigned char)(h & 0xff)); for(n = cv->height * cv->width; n--; ) { uint32_t ch = *chars++; uint32_t a = *attr++; *cur++ = ch >> 24; *cur++ = (ch >> 16) & 0xff; *cur++ = (ch >> 8) & 0xff; *cur++ = ch & 0xff; *cur++ = a >> 24; *cur++ = (a >> 16) & 0xff; *cur++ = (a >> 8) & 0xff; *cur++ = a & 0xff; } return 0; } /* Generate UTF-8 representation of current canvas. */ static int export_utf8(cucul_canvas_t *cv, cucul_buffer_t *ex) { static uint8_t const palette[] = { 0, 4, 2, 6, 1, 5, 3, 7, 8, 12, 10, 14, 9, 13, 11, 15 }; char *cur; unsigned int x, y; /* 23 bytes assumed for max length per pixel ('\e[5;1;3x;4y;9x;10ym' plus * 4 max bytes for a UTF-8 character). * Add height*9 to that (zeroes color at the end and jump to next line) */ ex->size = (cv->height * 9) + (cv->width * cv->height * 23); ex->data = malloc(ex->size); cur = ex->data; for(y = 0; y < cv->height; y++) { uint32_t *lineattr = cv->attr + y * cv->width; uint32_t *linechar = cv->chars + y * cv->width; uint8_t prevfg = 0x10; uint8_t prevbg = 0x10; for(x = 0; x < cv->width; x++) { uint32_t attr = lineattr[x]; uint32_t ch = linechar[x]; uint8_t fg, bg; if(ch == CUCUL_MAGIC_FULLWIDTH) continue; fg = ((attr & 0xffff) == CUCUL_COLOR_DEFAULT) ? 0x10 : palette[_cucul_argb32_to_ansi4fg(attr)]; bg = ((attr >> 16) == CUCUL_COLOR_TRANSPARENT) ? 0x10 : palette[_cucul_argb32_to_ansi4bg(attr)]; /* TODO: the [0 could be omitted in some cases */ if(fg != prevfg || bg != prevbg) { cur += sprintf(cur, "\033[0"); if(fg < 8) cur += sprintf(cur, ";3%d", fg); else if(fg < 16) cur += sprintf(cur, ";1;3%d;9%d", fg - 8, fg - 8); if(bg < 8) cur += sprintf(cur, ";4%d", bg); else if(bg < 16) cur += sprintf(cur, ";5;4%d;10%d", bg - 8, bg - 8); cur += sprintf(cur, "m"); } cur += cucul_utf32_to_utf8(cur, ch); prevfg = fg; prevbg = bg; } if(prevfg != 0x10 || prevbg != 0x10) cur += sprintf(cur, "\033[0m"); cur += sprintf(cur, "\n"); } /* Crop to really used size */ ex->size = (uintptr_t)(cur - ex->data); ex->data = realloc(ex->data, ex->size); return 0; } /* Generate ANSI representation of current canvas. */ static int export_ansi(cucul_canvas_t *cv, cucul_buffer_t *ex) { static uint8_t const palette[] = { 0, 4, 2, 6, 1, 5, 3, 7, 8, 12, 10, 14, 9, 13, 11, 15 }; char *cur; unsigned int x, y; uint8_t prevfg = -1; uint8_t prevbg = -1; /* 16 bytes assumed for max length per pixel ('\e[5;1;3x;4ym' plus * 1 byte for a CP437 character). * Add height*9 to that (zeroes color at the end and jump to next line) */ ex->size = (cv->height * 9) + (cv->width * cv->height * 16); ex->data = malloc(ex->size); cur = ex->data; for(y = 0; y < cv->height; y++) { uint32_t *lineattr = cv->attr + y * cv->width; uint32_t *linechar = cv->chars + y * cv->width; for(x = 0; x < cv->width; x++) { uint8_t fg = palette[_cucul_argb32_to_ansi4fg(lineattr[x])]; uint8_t bg = palette[_cucul_argb32_to_ansi4bg(lineattr[x])]; uint32_t ch = linechar[x]; if(ch == CUCUL_MAGIC_FULLWIDTH) ch = '?'; if(fg != prevfg || bg != prevbg) { cur += sprintf(cur, "\033[0;"); if(fg < 8) if(bg < 8) cur += sprintf(cur, "3%d;4%dm", fg, bg); else cur += sprintf(cur, "5;3%d;4%dm", fg, bg - 8); else if(bg < 8) cur += sprintf(cur, "1;3%d;4%dm", fg - 8, bg); else cur += sprintf(cur, "5;1;3%d;4%dm", fg - 8, bg - 8); } *cur++ = cucul_utf32_to_cp437(ch); prevfg = fg; prevbg = bg; } if(cv->width == 80) { cur += sprintf(cur, "\033[s\n\033[u"); } else { cur += sprintf(cur, "\033[0m\r\n"); prevfg = -1; prevbg = -1; } } /* Crop to really used size */ ex->size = (uintptr_t)(cur - ex->data); ex->data = realloc(ex->data, ex->size); return 0; } /* Generate HTML representation of current canvas. */ static int export_html(cucul_canvas_t *cv, cucul_buffer_t *ex) { char *cur; unsigned int x, y, len; /* The HTML header: less than 1000 bytes * A line: 7 chars for "
\n" * A glyph: 47 chars for "" * up to 9 chars for "&#xxxxxx;", far less for pure ASCII * 7 chars for "" */ ex->size = 1000 + cv->height * (7 + cv->width * (47 + 9 + 7)); ex->data = malloc(ex->size); cur = ex->data; /* HTML header */ cur += sprintf(cur, "\n"); cur += sprintf(cur, "Generated by libcaca %s\n", VERSION); cur += sprintf(cur, "\n"); cur += sprintf(cur, "
\n", "font-family: monospace, fixed; font-weight: bold;"); for(y = 0; y < cv->height; y++) { uint32_t *lineattr = cv->attr + y * cv->width; uint32_t *linechar = cv->chars + y * cv->width; for(x = 0; x < cv->width; x += len) { cur += sprintf(cur, "", _cucul_argb32_to_rgb12fg(lineattr[x]), _cucul_argb32_to_rgb12bg(lineattr[x])); for(len = 0; x + len < cv->width && lineattr[x + len] == lineattr[x]; len++) { if(linechar[x + len] == CUCUL_MAGIC_FULLWIDTH) ; else if(linechar[x + len] <= 0x00000020) cur += sprintf(cur, " "); else if(linechar[x + len] < 0x00000080) cur += sprintf(cur, "%c", (unsigned char)linechar[x + len]); else cur += sprintf(cur, "&#%i;", (unsigned int)linechar[x + len]); } cur += sprintf(cur, ""); } /* New line */ cur += sprintf(cur, "
\n"); } cur += sprintf(cur, "
\n"); /* Crop to really used size */ ex->size = strlen(ex->data) + 1; ex->data = realloc(ex->data, ex->size); return 0; } /* Export an HTML3 document. This function is way bigger than export_html(), * but permits viewing in old browsers (or limited ones such as links). It * will not work under gecko (mozilla rendering engine) unless you set a * correct header. */ static int export_html3(cucul_canvas_t *cv, cucul_buffer_t *ex) { char *cur; unsigned int x, y, len; /* The HTML table markup: less than 1000 bytes * A line: 10 chars for "\n" * A glyph: 40 chars for "" * up to 9 chars for "&#xxxxxx;", far less for pure ASCII * 12 chars for "" */ ex->size = 1000 + cv->height * (10 + cv->width * (40 + 9 + 12)); ex->data = malloc(ex->size); cur = ex->data; /* Table */ cur += sprintf(cur, "\n", cv->height); for(y = 0; y < cv->height; y++) { uint32_t *lineattr = cv->attr + y * cv->width; uint32_t *linechar = cv->chars + y * cv->width; cur += sprintf(cur, ""); for(x = 0; x < cv->width; x += len) { unsigned int i; /* Use colspan option to factor cells with same attributes * (see below) */ len = 1; while(x + len < cv->width && lineattr[x + len] == lineattr[x]) len++; cur += sprintf(cur, ""); } cur += sprintf(cur, "\n"); } /* Footer */ cur += sprintf(cur, "
1) cur += sprintf(cur, " colspan=%d", len); cur += sprintf(cur, ">", (unsigned long int) _cucul_argb32_to_rgb24fg(lineattr[x])); for(i = 0; i < len; i++) { if(linechar[x + i] == CUCUL_MAGIC_FULLWIDTH) ; else if(linechar[x + i] <= 0x00000020) cur += sprintf(cur, " "); else if(linechar[x + i] < 0x00000080) cur += sprintf(cur, "%c", (unsigned char)linechar[x + i]); else cur += sprintf(cur, "&#%i;", (unsigned int)linechar[x + i]); } cur += sprintf(cur, "
\n"); /* Crop to really used size */ ex->size = (uintptr_t)(cur - ex->data); ex->data = realloc(ex->data, ex->size); return 0; } /* Export a text file with IRC colours */ static int export_irc(cucul_canvas_t *cv, cucul_buffer_t *ex) { static uint8_t const palette[] = { 1, 2, 3, 10, 5, 6, 7, 15, /* Dark */ 14, 12, 9, 11, 4, 13, 8, 0, /* Light */ }; char *cur; unsigned int x, y; /* 16 bytes assumed for max length per pixel. Worst case scenario: * ^Cxx,yy 6 bytes * ^B^B 2 bytes * ch 6 bytes * \r\n 2 bytes * In real life, the average bytes per pixel value will be around 5. */ ex->size = 2 + (cv->width * cv->height * 16); ex->data = malloc(ex->size); cur = ex->data; for(y = 0; y < cv->height; y++) { uint32_t *lineattr = cv->attr + y * cv->width; uint32_t *linechar = cv->chars + y * cv->width; uint8_t prevfg = 0x10; uint8_t prevbg = 0x10; for(x = 0; x < cv->width; x++) { uint32_t attr = lineattr[x]; uint8_t fg = palette[_cucul_argb32_to_ansi4fg(attr)]; uint8_t bg = palette[_cucul_argb32_to_ansi4bg(attr)]; uint32_t ch = linechar[x]; if(ch == CUCUL_MAGIC_FULLWIDTH) continue; if((attr & 0xffff) == CUCUL_COLOR_DEFAULT) fg = 0x10; if((attr >> 16) == CUCUL_COLOR_TRANSPARENT) bg = 0x10; /* TODO: optimise series of same fg / same bg * don't change fg value if ch == ' ' * make sure the \x03,%d trick works everywhere */ if(bg != prevbg || fg != prevfg) { int need_escape = 0; if(bg == 0x10) { if(fg == 0x10) cur += sprintf(cur, "\x0f"); else { if(prevbg == 0x10) cur += sprintf(cur, "\x03%d", fg); else cur += sprintf(cur, "\x0f\x03%d", fg); if(ch == (uint32_t)',') need_escape = 1; } } else { if(fg == 0x10) cur += sprintf(cur, "\x0f\x03,%d", bg); else cur += sprintf(cur, "\x03%d,%d", fg, bg); } if(ch >= (uint32_t)'0' && ch <= (uint32_t)'9') need_escape = 1; if(need_escape) cur += sprintf(cur, "\x02\x02"); } cur += cucul_utf32_to_utf8(cur, ch); prevfg = fg; prevbg = bg; } *cur++ = '\r'; *cur++ = '\n'; } /* Crop to really used size */ ex->size = (uintptr_t)(cur - ex->data); ex->data = realloc(ex->data, ex->size); return 0; } /* Export a PostScript document. */ static int export_ps(cucul_canvas_t *cv, cucul_buffer_t *ex) { static char const *ps_header = "%!\n" "%% libcaca PDF export\n" "%%LanguageLevel: 2\n" "%%Pages: 1\n" "%%DocumentData: Clean7Bit\n" "/csquare {\n" " newpath\n" " 0 0 moveto\n" " 0 1 rlineto\n" " 1 0 rlineto\n" " 0 -1 rlineto\n" " closepath\n" " setrgbcolor\n" " fill\n" "} def\n" "/S {\n" " Show\n" "} bind def\n" "/Courier-Bold findfont\n" "8 scalefont\n" "setfont\n" "gsave\n" "6 10 scale\n"; char *cur; unsigned int x, y; /* 200 is arbitrary but should be ok */ ex->size = strlen(ps_header) + 100 + cv->height * (32 + cv->width * 200); ex->data = malloc(ex->size); cur = ex->data; /* Header */ cur += sprintf(cur, "%s", ps_header); cur += sprintf(cur, "0 %d translate\n", cv->height); /* Background, drawn using csquare macro defined in header */ for(y = cv->height; y--; ) { uint32_t *lineattr = cv->attr + y * cv->width; for(x = 0; x < cv->width; x++) { uint8_t argb[8]; _cucul_argb32_to_argb4(*lineattr++, argb); cur += sprintf(cur, "1 0 translate\n %f %f %f csquare\n", (float)argb[1] * (1.0 / 0xf), (float)argb[2] * (1.0 / 0xf), (float)argb[3] * (1.0 / 0xf)); } /* Return to beginning of the line, and jump to the next one */ cur += sprintf(cur, "-%d 1 translate\n", cv->width); } cur += sprintf(cur, "grestore\n"); /* Restore transformation matrix */ cur += sprintf(cur, "0 %d translate\n", cv->height*10); for(y = cv->height; y--; ) { uint32_t *lineattr = cv->attr + (cv->height - y - 1) * cv->width; uint32_t *linechar = cv->chars + (cv->height - y - 1) * cv->width; for(x = 0; x < cv->width; x++) { uint8_t argb[8]; uint32_t ch = *linechar++; _cucul_argb32_to_argb4(*lineattr++, argb); cur += sprintf(cur, "newpath\n"); cur += sprintf(cur, "%d %d moveto\n", (x + 1) * 6, y * 10 + 2); cur += sprintf(cur, "%f %f %f setrgbcolor\n", (float)argb[5] * (1.0 / 0xf), (float)argb[6] * (1.0 / 0xf), (float)argb[7] * (1.0 / 0xf)); if(ch < 0x00000020) cur += sprintf(cur, "(?) show\n"); else if(ch >= 0x00000080) cur += sprintf(cur, "(?) show\n"); else switch((uint8_t)(ch & 0x7f)) { case '\\': case '(': case ')': cur += sprintf(cur, "(\\%c) show\n", (unsigned char)ch); break; default: cur += sprintf(cur, "(%c) show\n", (unsigned char)ch); break; } } } cur += sprintf(cur, "showpage\n"); /* Crop to really used size */ ex->size = (uintptr_t)(cur - ex->data); ex->data = realloc(ex->data, ex->size); return 0; } /* Export an SVG vector image */ static int export_svg(cucul_canvas_t *cv, cucul_buffer_t *ex) { static char const svg_header[] = "\n" "\n"; char *cur; unsigned int x, y; /* 200 is arbitrary but should be ok */ ex->size = strlen(svg_header) + 128 + cv->width * cv->height * 200; ex->data = malloc(ex->size); cur = ex->data; /* Header */ cur += sprintf(cur, svg_header, cv->width * 6, cv->height * 10, cv->width * 6, cv->height * 10); cur += sprintf(cur, " \n"); /* Background */ for(y = 0; y < cv->height; y++) { uint32_t *lineattr = cv->attr + y * cv->width; for(x = 0; x < cv->width; x++) { cur += sprintf(cur, "\n", _cucul_argb32_to_rgb12bg(*lineattr++), x * 6, y * 10); } } /* Text */ for(y = 0; y < cv->height; y++) { uint32_t *lineattr = cv->attr + y * cv->width; uint32_t *linechar = cv->chars + y * cv->width; for(x = 0; x < cv->width; x++) { uint32_t ch = *linechar++; if(ch == ' ' || ch == CUCUL_MAGIC_FULLWIDTH) { lineattr++; continue; } cur += sprintf(cur, "", _cucul_argb32_to_rgb12fg(*lineattr++), x * 6, (y * 10) + 8); if(ch < 0x00000020) *cur++ = '?'; else if(ch > 0x0000007f) cur += cucul_utf32_to_utf8(cur, ch); else switch((uint8_t)ch) { case '>': cur += sprintf(cur, ">"); break; case '<': cur += sprintf(cur, "<"); break; case '&': cur += sprintf(cur, "&"); break; default: *cur++ = ch; break; } cur += sprintf(cur, "\n"); } } cur += sprintf(cur, " \n"); cur += sprintf(cur, "\n"); /* Crop to really used size */ ex->size = (uintptr_t)(cur - ex->data); ex->data = realloc(ex->data, ex->size); return 0; } /* Export a TGA image */ static int export_tga(cucul_canvas_t *cv, cucul_buffer_t *ex) { char const * const *fontlist; char * cur; cucul_font_t *f; unsigned int i, w, h; fontlist = cucul_get_font_list(); if(!fontlist[0]) return -1; f = cucul_load_font(fontlist[0], 0); w = cucul_get_canvas_width(cv) * cucul_get_font_width(f); h = cucul_get_canvas_height(cv) * cucul_get_font_height(f); ex->size = w * h * 4 + 18; /* 32 bpp + 18 bytes for the header */ ex->data = malloc(ex->size); cur = ex->data; /* ID Length */ cur += sprintf(cur, "%c", 0); /* Color Map Type: no colormap */ cur += sprintf(cur, "%c", 0); /* Image Type: uncompressed truecolor */ cur += sprintf(cur, "%c", 2); /* Color Map Specification: no color map */ memset(cur, 0, 5); cur += 5; /* Image Specification */ cur += sprintf(cur, "%c%c", 0, 0); /* X Origin */ cur += sprintf(cur, "%c%c", 0, 0); /* Y Origin */ cur += sprintf(cur, "%c%c", w & 0xff, w >> 8); /* Width */ cur += sprintf(cur, "%c%c", h & 0xff, h >> 8); /* Height */ cur += sprintf(cur, "%c", 32); /* Pixel Depth */ cur += sprintf(cur, "%c", 40); /* Image Descriptor */ /* Image ID: no ID */ /* Color Map Data: no colormap */ /* Image Data */ cucul_render_canvas(cv, f, cur, w, h, 4 * w); /* Swap bytes. What a waste of time. */ for(i = 0; i < w * h * 4; i += 4) { char w; w = cur[i]; cur[i] = cur[i + 3]; cur[i + 3] = w; w = cur[i + 1]; cur[i + 1] = cur[i + 2]; cur[i + 2] = w; } cucul_free_font(f); return 0; }