src/org/ibex/graphics/Font.java

   1 // Copyright 2000-2005 the Contributors, as shown in the revision logs.
   2 // Licensed under the GNU General Public License version 2 ("the License").
   3 // You may not use this file except in compliance with the License.
   4
   5 package org.ibex.graphics;
   6 import org.ibex.util.*;
   7 import java.io.*;
   8 import java.util.Hashtable;
   9 import org.ibex.js.*;
  10 import org.ibex.core.*;
  11 import org.ibex.nestedvm.*;
  12 import org.ibex.plat.*;
  13 import org.ibex.nestedvm.Runtime;
  14
  15 // FEATURE: this could be cleaner
  16 /** encapsulates a single font (a set of Glyphs) */
  17 public class Font {
  18
  19     private Font(JS stream, int pointsize) { this.stream = stream; this.pointsize = pointsize; }
  20
  21     private static boolean glyphRenderingTaskIsScheduled = false;
  22
  23     public final int pointsize;                 ///< the size of the font
  24     public final JS stream;                 ///< the stream from which this font was loaded
  25     public int max_ascent;                      ///< the maximum ascent, in pixels
  26     public int max_descent;                     ///< the maximum descent, in pixels
  27     boolean latinCharsPreloaded = false;        ///< true if a request to preload ASCII 32-127 has begun
  28     public Glyph[] glyphs = new Glyph[65535];          ///< the glyphs that comprise this font
  29
  30     public abstract static class Glyph {
  31         protected Glyph(Font font, char c) { this.font = font; this.c = c; }
  32         public final Font font;
  33         public final char c;
  34         public int baseline;                    ///< within the alphamask, this is the y-coordinate of the baseline
  35         public int advance;                     ///< amount to increment the x-coordinate
  36         public boolean isLoaded = false;        ///< true iff the glyph is loaded
  37         public int width = -1;                  ///< the width of the glyph
  38         public int height = -1;                 ///< the height of the glyph
  39         public byte[] data = null;              ///< the alpha channel samples for this font
  40         public String path = null; // FIXME this should be shared across point sizes
  41         void render() {
  42             if (!isLoaded) try { renderGlyph(this); } catch (IOException e) { Log.info(Font.class, e); }
  43             isLoaded = true;
  44         }
  45     }
  46
  47
  48     // Statics //////////////////////////////////////////////////////////////////////
  49
  50     static final Hashtable glyphsToBeCached = new Hashtable();
  51     static final Hashtable glyphsToBeDisplayed = new Hashtable();
  52     // HACK: replace with Cache<JS, int>
  53     private static Basket.Map fonts = new Basket.HashMap();
  54     public static Font getFont(JS stream, int pointsize) {
  55         Basket.Map m = (Basket.Map)fonts.get(stream);
  56         Font ret = null;
  57         if (m != null) ret = (Font)m.get(new Integer(pointsize));
  58         else fonts.put(stream, m = new Basket.HashMap());
  59         if (ret == null) m.put(new Integer(pointsize), ret = new Font(stream, pointsize));
  60         return ret;
  61     }
  62
  63
  64     // Methods //////////////////////////////////////////////////////////////////////
  65
  66     /**
  67      *  Rasterize the glyphs of <code>text</code>.
  68      *  @returns <code>(width&lt;&lt;32)|height</code>
  69      */
  70     public long rasterizeGlyphs(String text, PixelBuffer pb, int textcolor, int x, int y, int cx1, int cy1, int cx2, int cy2) {
  71         return rasterizeGlyphs(text, pb, textcolor, x, y, cx1, cy1, cx2, cy2, 0); }
  72     public long rasterizeGlyphs(String text, PixelBuffer pb, int textcolor, int x, int y,
  73                                 int cx1, int cy1, int cx2, int cy2, int bg) {
  74         int width = 0, height = 0;
  75         if (!latinCharsPreloaded) {       // preload the Latin-1 charset with low priority (we'll probably want it)
  76             for(int i=48; i<57; i++) if (glyphs[i]==null) glyphsToBeCached.put(glyphs[i]=Platform.createGlyph(this, (char)i),"");
  77             for(int i=32; i<47; i++) if (glyphs[i]==null) glyphsToBeCached.put(glyphs[i]=Platform.createGlyph(this, (char)i),"");
  78             for(int i=57; i<128; i++) if (glyphs[i]==null) glyphsToBeCached.put(glyphs[i]=Platform.createGlyph(this, (char)i),"");
  79             if (!glyphRenderingTaskIsScheduled) {
  80                 Scheduler.add(glyphRenderingTask);
  81                 glyphRenderingTaskIsScheduled = true;
  82             }
  83             latinCharsPreloaded = true;
  84         }
  85         for(int i=0; i<text.length(); i++) {
  86             final char c = text.charAt(i);
  87             Glyph g = glyphs[c];
  88             if (g == null) glyphs[c] = g = Platform.createGlyph(this, c);
  89             g.render();
  90             if (pb != null) pb.drawGlyph(g,
  91                                          x + width,
  92                                          y + g.font.max_ascent - g.baseline,
  93                                          x+width,
  94                                          cy1,
  95                                          x+width+g.advance,
  96                                          cy2,
  97                                          textcolor, bg);
  98             width += g.advance;
  99             height = java.lang.Math.max(height, max_ascent + max_descent);
 100         }
 101         return ((((long)width) << 32) | (long)(height & 0xffffffffL));
 102     }
 103
 104     // FEATURE do we really need to be caching sizes?
 105     private static Cache sizeCache = new Cache(1000, true);
 106     public int textwidth(String s) { return (int)((textsize(s) >>> 32) & 0xffffffff); }
 107     public int textheight(String s) { return (int)(textsize(s) & 0xffffffffL); }
 108     public long textsize(String s) {
 109         Long l = (Long)sizeCache.get(s);
 110         if (l != null) return ((Long)l).longValue();
 111         long ret = rasterizeGlyphs(s, null, 0, 0, 0, 0, 0, 0, 0);
 112         sizeCache.put(s, new Long(ret));
 113         return ret;
 114     }
 115
 116     public Glyph getGlyph(char c) {
 117         rasterizeGlyphs(c+"", null, 0, 0, 0, 0, 0, 0, 0);
 118         Glyph g = glyphs[c];
 119         g.render();
 120         return g;
 121     }
 122
 123     static final Callable glyphRenderingTask = new Callable() { public Object run(Object o) {
 124         // FIXME: this should be a low-priority task
 125         glyphRenderingTaskIsScheduled = false;
 126         if (glyphsToBeCached.isEmpty()) return null;
 127         Glyph g = (Glyph)glyphsToBeCached.keys().nextElement();
 128         if (g == null) return null;
 129         glyphsToBeCached.remove(g);
 130         Log.debug(Font.class, "glyphRenderingTask rendering " + g.c + " of " + g.font);
 131         g.render();
 132         Log.debug(Glyph.class, "   done rendering glyph " + g.c);
 133         glyphRenderingTaskIsScheduled = true;
 134         Scheduler.add(this);
 135         return null;
 136     } };
 137
 138
 139     // FreeType Interface //////////////////////////////////////////////////////////////////////////////
 140
 141     // FEATURE: use streams, not memoryfont's
 142     // FEATURE: kerning pairs
 143     private static final Runtime rt;
 144     private static JS loadedStream;
 145     private static int loadedStreamAddr;
 146
 147     static {
 148         try {
 149             rt = (Runtime)Class.forName("org.ibex.util.MIPSApps").newInstance();
 150         } catch(Exception e) {
 151             throw new Error("Error instantiating freetype: " + e);
 152         }
 153         rt.start(new String[]{"freetype"});
 154         rt.execute();
 155         rtCheck();
 156     }
 157
 158     private static void rtCheck() { if(rt.getState() != Runtime.PAUSED) throw new Error("Freetype exited " + rt.exitStatus()); }
 159
 160     private static void loadFontByteStream(JS res) {
 161         if(loadedStream == res) return;
 162
 163         try {
 164             Log.info(Font.class, "loading font " + JSU.str(res));
 165             InputStream is = res.getInputStream();
 166             byte[] fontstream = InputStreamToByteArray.convert(is);
 167             rt.free(loadedStreamAddr);
 168             loadedStreamAddr = rt.xmalloc(fontstream.length);
 169             rt.copyout(fontstream, loadedStreamAddr, fontstream.length);
 170             if(rt.call("load_font", loadedStreamAddr, fontstream.length) != 0)
 171                 throw new RuntimeException("load_font failed"); // FEATURE: better error
 172             rtCheck();
 173             loadedStream = res;
 174         } catch (Exception e) {
 175             // FEATURE: Better error reporting (thow an exception?)
 176             Log.info(Font.class, e);
 177         }
 178     }
 179
 180     private static synchronized void renderGlyph(Font.Glyph glyph) throws IOException {
 181         try {
 182             Log.debug(Font.class, "rasterizing glyph " + glyph.c + " of font " + glyph.font);
 183             if (loadedStream != glyph.font.stream) loadFontByteStream(glyph.font.stream);
 184
 185             long start = System.currentTimeMillis();
 186
 187             rt.call("render",glyph.c,glyph.font.pointsize);
 188             rtCheck();
 189
 190             glyph.font.max_ascent = rt.getUserInfo(3);
 191             glyph.font.max_descent = rt.getUserInfo(4);
 192             glyph.baseline = rt.getUserInfo(5);
 193             glyph.advance = rt.getUserInfo(6);
 194
 195             glyph.width = rt.getUserInfo(1);
 196             glyph.height = rt.getUserInfo(2);
 197
 198             glyph.data = new byte[glyph.width * glyph.height];
 199             int addr = rt.getUserInfo(0);
 200             rt.copyin(addr, glyph.data, glyph.width * glyph.height);
 201
 202             byte[] path = new byte[rt.getUserInfo(8)];
 203             rt.copyin(rt.getUserInfo(7), path, rt.getUserInfo(8));
 204             glyph.path = new String(path);
 205             glyph.path += " m " + (64 * glyph.advance) + " 0 ";
 206
 207             glyph.isLoaded = true;
 208         } catch (Exception e) {
 209             // FEATURE: Better error reporting (thow an exception?)
 210             Log.info(Font.class, e);
 211         }
 212     }
 213 }