4coder/4ed_font_provider_freetype.cpp

/*
 * Mr. 4th Dimention - Allen Webster
 *
 * 18.07.2017
 *
 * Freetype implementation of the font provider interface.
 *
 */

// TOP

// NOTE(allen): Thanks to insofaras.  This is copy-pasted from some work he originally did to get free type working on Linux.

#undef internal
#include <ft2build.h>
#include FT_FREETYPE_H
#define internal static

internal u32
font_ft_flags(b32 use_hinting){
    u32 ft_flags = FT_LOAD_RENDER;
    
    if (use_hinting){
        // NOTE(inso): FT_LOAD_TARGET_LIGHT does hinting only vertically, which looks nicer imo
        // maybe it could be exposed as an option for hinting, instead of just on/off.
        ft_flags |= FT_LOAD_FORCE_AUTOHINT | FT_LOAD_TARGET_LIGHT;
    }
    else{
        ft_flags |= (FT_LOAD_NO_AUTOHINT | FT_LOAD_NO_HINTING);
    }
    
    return(ft_flags);
}

internal b32
font_ft_get_face(FT_Library ft, Font_Loadable_Stub *stub, FT_Face *face){
    b32 success = true;
    if (stub->load_from_path){
        FT_Error error = FT_New_Face(ft, stub->name, 0, face);
        success = (error == 0);
    }
    else{
        Font_Raw_Data data = system_font_data(stub->name);
        if (data.size > 0){
            FT_Error error = FT_New_Memory_Face(ft, data.data, data.size, 0, face);
            success = (error == 0);
        }
        else{
            success = false;
        }
        end_temp_memory(data.temp);
    }
    return(success);
}

internal b32
font_load_name(Font_Loadable_Stub *stub, char *buffer, i32 capacity){
    b32 success = false;
    
    // TODO(allen): Stop redoing all this init for each call.
    FT_Library ft;
    FT_Init_FreeType(&ft);
    
    FT_Face face;
    if (font_ft_get_face(ft, stub, &face)){
        char *name = face->family_name;
        i32 name_len = str_size(name);
        if (name_len < capacity){
            memcpy(buffer, name, name_len + 1);
            success = true;
        }
    }
    
    FT_Done_FreeType(ft);
    
    return(success);
}

internal b32
font_load_page_layout(Font_Settings *settings, Font_Metrics *metrics, Glyph_Page *page, u32 page_number){
    Assert(page != 0);
    memset(page, 0, sizeof(*page));
    page->page_number = page_number;
    page->has_layout = true;
    
    u32 pt_size = settings->pt_size;
    b32 use_hinting = settings->use_hinting;
    
    // TODO(allen): Stop redoing all this init for each call.
    FT_Library ft;
    FT_Init_FreeType(&ft);
    
    FT_Face face;
    b32 has_a_good_face = font_ft_get_face(ft, &settings->stub, &face);
    
    if (has_a_good_face){
        FT_Size_RequestRec_ size = {};
        size.type   = FT_SIZE_REQUEST_TYPE_NOMINAL;
        size.height = pt_size << 6;
        FT_Request_Size(face, &size);
        
        // NOTE(allen): Determine glyph layout dimensions
        i32 max_glyph_w = face->size->metrics.x_ppem;
        i32 max_glyph_h = metrics->height;
        i32 pen_y_descent = max_glyph_h + 2;
        i32 tex_width   = 64;
        i32 tex_height  = 0;
        
        do {
            tex_width *= 2;
            f32 glyphs_per_row = ceilf(tex_width/(f32)max_glyph_w);
            f32 rows = ceilf(GLYPHS_PER_PAGE/glyphs_per_row);
            tex_height = ceil32(rows*pen_y_descent);
        }
        while(tex_height > tex_width);
        tex_height = round_up_pot_u32(tex_height);
        
        i32 pen_x = 0;
        i32 pen_y = 0;
        
        // NOTE(allen): Fill the glyph bounds array
        u32 ft_flags = font_ft_flags(use_hinting);
        
        u32 codepoint = (page_number << 8);
        Glyph_Bounds *glyph_out = &page->glyphs[0];
        f32 *advance_out = &page->advance[0];
        for (u32 i = 0; i < GLYPHS_PER_PAGE; ++i, ++codepoint, ++glyph_out, ++advance_out){
            if (FT_Load_Char(face, codepoint, ft_flags) == 0){
                i32 w = face->glyph->bitmap.width;
                i32 h = face->glyph->bitmap.rows;
                i32 ascent = metrics->ascent;
                
                // NOTE(allen): Move to next line if necessary
                if (pen_x + w >= tex_width){
                    pen_x = 0;
                    pen_y += pen_y_descent;
                }
                
                // NOTE(allen): Set all this stuff the renderer needs
                glyph_out->x0 = (f32)(pen_x);
                glyph_out->y0 = (f32)(pen_y);
                glyph_out->x1 = (f32)(pen_x + w);
                glyph_out->y1 = (f32)(pen_y + h + 1);
                
                glyph_out->xoff = (f32)(face->glyph->bitmap_left);
                glyph_out->yoff = (f32)(ascent - face->glyph->bitmap_top);
                glyph_out->xoff2 = glyph_out->xoff + w;
                glyph_out->yoff2 = glyph_out->yoff + h + 1;
                
                // TODO(allen): maybe advance data should be integers?
                *advance_out = (f32)ceil32(face->glyph->advance.x / 64.0f);
                
                pen_x = ceil32(glyph_out->x1 + 1);
            }
        }
        
        // TODO(allen): Not sure setting tex_height here is right... double check.
        tex_height = round_up_pot_u32(pen_y + pen_y_descent);
        
        page->tex_width  = tex_width;
        page->tex_height = tex_height;
    }
    else{
        page->tex_width  = 1;
        page->tex_height = 1;
    }
    
    FT_Done_FreeType(ft);
    
    return(has_a_good_face);
}

internal u32*
font_load_page_pixels(Partition *part, Font_Settings *settings, Glyph_Page *page, u32 page_number, i32 *tex_width_out, i32 *tex_height_out){
    Assert(page != 0);
    Assert(page->has_layout);
    Assert(page->page_number == page_number);
    
    i32 pt_size = settings->pt_size;
    b32 use_hinting = settings->use_hinting;
    
    // TODO(allen): Stop redoing all this init for each call.
    FT_Library ft;
    FT_Init_FreeType(&ft);
    
    FT_Face face;
    b32 has_a_good_face = font_ft_get_face(ft, &settings->stub, &face);
    u32 *pixels = 0;
    
    if (has_a_good_face){
        FT_Size_RequestRec_ size = {};
        size.type   = FT_SIZE_REQUEST_TYPE_NOMINAL;
        size.height = pt_size << 6;
        FT_Request_Size(face, &size);
        
        page->page_number = page_number;
        
        // NOTE(allen): Prepare a pixel buffer.
        i32 tex_width   = page->tex_width;
        i32 tex_height  = page->tex_height;
        
        pixels = push_array(part, u32, tex_width*tex_height);
        
        if (pixels != 0){
            memset(pixels, 0, tex_width*tex_height*sizeof(u32));
            
            // NOTE(allen): Fill the texture
            u32 ft_flags = font_ft_flags(use_hinting);
            
            u32 codepoint = (page_number << 8);
            Glyph_Bounds *glyph_ptr = &page->glyphs[0];
            for (i32 i = 0; i < GLYPHS_PER_PAGE; ++i, ++codepoint, ++glyph_ptr){
                if (FT_Load_Char(face, codepoint, ft_flags) == 0){
                    // NOTE(allen): Extract this glyph's dimensions.
                    i32 x = (i32)glyph_ptr->x0;
                    i32 y = (i32)glyph_ptr->y0;
                    i32 w = (i32)(glyph_ptr->x1 - glyph_ptr->x0);
                    i32 h = (i32)(glyph_ptr->y1 - glyph_ptr->y0 - 1);
                    
                    // NOTE(allen): Write to the pixels.
                    u8 *src = face->glyph->bitmap.buffer;
                    i32 end_x = x + w;
                    i32 end_y = y + h;
                    if (src != 0){
                        i32 pitch = face->glyph->bitmap.pitch;
                        for (i32 Y = y, YY = 0; Y < end_y; ++Y, ++YY){
                            for (i32 X = x, XX = 0; X < end_x; ++X, ++XX){
                                //pixels[Y*tex_width + X] = (0x01010101*src[YY*pitch + XX]);
                                pixels[Y*tex_width + X] = 0x00FFFFFF + (0x01000000*src[YY*pitch + XX]);
                            }
                        }
                    }
                    else{
                        for (i32 Y = y, YY = 0; Y < end_y; ++Y, ++YY){
                            for (i32 X = x, XX = 0; X < end_x; ++X, ++XX){
                                pixels[Y*tex_width + X] = 0xFFFFFFFF;
                            }
                        }
                    }
                }
            }
            
            *tex_width_out = tex_width;
            *tex_height_out = tex_height;
        }
        else{
            pixels = 0;
            *tex_width_out = 1;
            *tex_height_out = 1;
        }
    }
    else{
        // TODO(allen): Fill in white boxes here.
        pixels = 0;
        *tex_width_out = 1;
        *tex_height_out = 1;
    }
    
    FT_Done_FreeType(ft);
    
    return(pixels);
}

internal b32
font_load(System_Functions *system, Font_Settings *settings, Font_Metrics *metrics, Font_Page_Storage *pages){
    i32 pt_size = settings->pt_size;
    
    // TODO(allen): Stop redoing all this init for each call.
    FT_Library ft;
    FT_Init_FreeType(&ft);
    
    FT_Face face;
    b32 success = font_ft_get_face(ft, &settings->stub, &face);
    
    if (success){    
        FT_Size_RequestRec_ size = {};
        size.type   = FT_SIZE_REQUEST_TYPE_NOMINAL;
        size.height = (pt_size << 6);
        FT_Request_Size(face, &size);
        
        // NOTE(allen): Set size and metrics
        char *name = face->family_name;
        if (name != 0){
            i32 name_len = str_size(name);
            name_len = clamp_top(name_len, sizeof(metrics->name)-1);
            memcpy(metrics->name, name, name_len + 1);
            metrics->name_len = name_len;
        }
        else{
            if (!settings->stub.load_from_path){
                i32 name_len = settings->stub.len;
                memcpy(metrics->name, settings->stub.name, name_len + 1);
                metrics->name_len = name_len;
            }
        }
        
        metrics->ascent    = ceil32  (face->size->metrics.ascender    / 64.0f);
        metrics->descent   = floor32 (face->size->metrics.descender   / 64.0f);
        metrics->advance   = ceil32  (face->size->metrics.max_advance / 64.0f);
        metrics->height    = ceil32  (face->size->metrics.height      / 64.0f);
        metrics->line_skip = metrics->height - (metrics->ascent - metrics->descent);
        metrics->height   -= metrics->line_skip;
        metrics->line_skip = 0;
        if (metrics->height > pt_size*4){
            success = false;
        }
        else{
            // NOTE(allen): Set texture and glyph data.
            Assert(font_get_page(pages, 0) == 0);
            Glyph_Page *page = font_allocate_and_hash_new_page(system, pages, 0);
            font_load_page_layout(settings, metrics, page, 0);
            
            // NOTE(allen): Whitespace spacing stuff
            i32 tab_width = 4;
            
            f32 space_adv = page->advance[' '];
            f32 backslash_adv = page->advance['\\'];
            f32 r_adv = page->advance['r'];
            
            page->advance['\n'] = space_adv;
            page->advance['\r'] = backslash_adv + r_adv;
            page->advance['\t'] = space_adv*tab_width;
            
            // NOTE(allen): The rest of the metrics.
            f32 max_hex_advance = 0.f;
            for (u32 i = '0'; i <= '9'; ++i){
                f32 adv = page->advance[i];
                max_hex_advance = Max(max_hex_advance, adv);
            }
            for (u32 i = 'a'; i <= 'f'; ++i){
                f32 adv = page->advance[i];
                max_hex_advance = Max(max_hex_advance, adv);
            }
            for (u32 i = 'A'; i <= 'F'; ++i){
                f32 adv = page->advance[i];
                max_hex_advance = Max(max_hex_advance, adv);
            }
            
            metrics->byte_advance = backslash_adv + max_hex_advance*2;
            metrics->sub_advances[0] = backslash_adv;
            metrics->sub_advances[1] = max_hex_advance;
            metrics->sub_advances[2] = max_hex_advance;
        }
    }
    
    FT_Done_FreeType(ft);
    
    return(success);
}

////////////////////////////////

internal
Sys_Font_Allocate_Sig(system_font_allocate, size){
    umem *size_ptr = 0;
    void *result = system_memory_allocate(size + sizeof(*size_ptr));
    size_ptr = (umem*)result;
    *size_ptr = size + 4;
    return(size_ptr + 1);
}

internal
Sys_Font_Free_Sig(system_font_free, ptr){
    if (ptr != 0){
        umem *size_ptr = ((umem*)ptr) - 1;
        system_memory_free(size_ptr, *size_ptr);
    }
}

internal
Sys_Font_Get_Loadable_Count_Sig(system_font_get_loadable_count){
    return(fontvars.loadable_count);
}

internal
Sys_Font_Get_Loadable_Sig(system_font_get_loadable, i, out){
    if (0 <= i && i < fontvars.loadable_count){
        memcpy(out, &fontvars.loadables[i], sizeof(*out));
    }
    else{
        memset(out, 0, sizeof(*out));
    }
}

internal
Sys_Font_Load_New_Font_Sig(system_font_load_new_font, stub){
    i32 slot_max = fontvars.max_slot_count;
    Font_Slot_Page *page_with_slot = 0;
    
    Assert(fontvars.used_slot_count <= slot_max);
    if (fontvars.used_slot_count == slot_max){
        i32 memsize = l_round_up_i32(SLOT_PAGE_SIZE, KB(4));
        i32 page_count = memsize/SLOT_PAGE_SIZE;
        void *ptr = system_font_allocate(memsize);
        memset(ptr, 0, memsize);
        
        page_with_slot = (Font_Slot_Page*)ptr;
        
        for (i32 i = 0; i < page_count; ++i){
            i32 page_slot_count = SLOT_PER_PAGE;
            
            Font_Slot_Page *page = (Font_Slot_Page*)ptr;
            page->is_active = (u64*)(page + 1);
            page->settings = (Font_Settings*)(page->is_active + (page_slot_count + 63)/64);
            page->metrics = (Font_Metrics*)(page->settings + page_slot_count);
            page->pages = (Font_Page_Storage*)(page->metrics + page_slot_count);
            ptr = page->pages + page_slot_count;
            
            page->used_count = 0;
            page->fill_count = 0;
            page->max = page_slot_count;
            
            dll_insert_back(&fontvars.slot_pages_sentinel, page);
            if (page->prev == &fontvars.slot_pages_sentinel){
                page->first_id = 1;
            }
            else{
                page->first_id = page->prev->first_id + page->prev->max;
            }
            
            // NOTE(allen): Some of the last 64 bits of the is_active array may not line up with actual slots.
            // Set such bits to 1 to simulate the "slot" being filled for allocation purposes.
            // TODO(allen): This could be O(log n) instead of O(n) if I end up making bit manipulation helpers someday.
            u64 last_mask_fill = 0;
            if (page_slot_count%64 != 0){
                last_mask_fill = (1LLU << 63);
                for (i32 spread_step = (page_slot_count%64) - 1;
                     spread_step > 0;
                     --spread_step){
                    last_mask_fill |= (last_mask_fill >> 1);
                }
            }
            
            i32 is_active_max = (page_with_slot->max + 63)/64;
            page->is_active[is_active_max - 1] = last_mask_fill;
        }
        
        fontvars.max_slot_count += page_count*SLOT_PER_PAGE;
    }
    else{
        for (Font_Slot_Page *page = fontvars.slot_pages_sentinel.next;
             page != &fontvars.slot_pages_sentinel;
             page = page->next){
            if (page->used_count < page->max){
                page_with_slot = page;
                break;
            }
        }
    }
    
    if (page_with_slot == 0){
        LOG("Could not get a font slot while loading a font\n");
        return(0);
    }
    
    Assert(page_with_slot->used_count < page_with_slot->max);
    
    // Get a fillable index
    i32 index = -1;
    if (page_with_slot->fill_count < page_with_slot->max){
        index = page_with_slot->fill_count;
    }
    else{
        i32 is_active_max = (page_with_slot->max + 63)/64;
        u64 *is_active_ptr = page_with_slot->is_active;
        for (i32 i = 0; i < is_active_max; ++i){
            u64 is_active_v = is_active_ptr[i];
            if (is_active_v != (~0)){
                i32 j_stop = 64;
                if (i + 1 == is_active_max){
                    j_stop = SLOT_PER_PAGE%64;
                }
                for (i32 j = 0; j < j_stop; ++j){
                    if ((is_active_v & (1LLU << j)) == 0){
                        index = i*64 + j;
                        break;
                    }
                }
                break;
            }
        }
    }
    
    // Get the slot pointers.
    Assert(index != -1);
    
    u64 *is_active_flags = &page_with_slot->is_active[index/64];
    u64 is_active_mask = (1LLU << (index % 64));
    Font_Settings *settings = &page_with_slot->settings[index];
    Font_Metrics *metrics = &page_with_slot->metrics[index];
    Font_Page_Storage *pages = &page_with_slot->pages[index];
    Font_ID new_id = page_with_slot->first_id + index;
    
    Assert(((*is_active_flags) & is_active_mask) == 0);
    
    char *filename = stub->name;
    i32 filename_len = 0;
    for (;filename[filename_len];++filename_len);
    
    // Initialize Font Parameters
    Assert(filename_len <= sizeof(settings->stub.name) - 1);
    memset(settings, 0, sizeof(*settings));
    memcpy(&settings->stub, stub, sizeof(*stub));
    settings->pt_size = fontvars.pt_size;
    settings->use_hinting = fontvars.use_hinting;
    
    memset(metrics, 0, sizeof(*metrics));
    memset(pages, 0, sizeof(*pages));
    b32 success = font_load(&sysfunc, settings, metrics, pages);
    if (success){
        *is_active_flags |= is_active_mask;
        ++fontvars.used_slot_count;
        ++page_with_slot->used_count;
        if (index >= page_with_slot->fill_count){
            page_with_slot->fill_count = index + 1;
        }
    }
    else{
        new_id = 0;
    }
    
    return(new_id);
}

internal
Sys_Font_Get_Count_Sig(system_font_get_count){
    return(fontvars.used_slot_count);
}

internal Font_Slot_Page_And_Index
system_font_get_active_location(Font_ID font_id){
    Font_Slot_Page_And_Index result = {0};
    
    for (Font_Slot_Page *page = fontvars.slot_pages_sentinel.next;
         page != &fontvars.slot_pages_sentinel;
         page = page->next){
        if (page->first_id <= font_id && font_id < page->first_id + SLOT_PER_PAGE){
            i32 index = (i32)(font_id - page->first_id);
            u64 is_active_v = page->is_active[index/64];
            if ((is_active_v & (1LLU << (index%64))) != 0){
                result.page = page;
                result.index = index;
            }
            break;
        }
    }
    
    return(result);
}

internal
Sys_Font_Get_Name_By_ID_Sig(system_font_get_name_by_id, font_id, str_out, capacity){
    i32 length = 0;
    if (font_id == 0){
        return(length);
    }
    
    Font_Slot_Page_And_Index page_and_index = system_font_get_active_location(font_id);
    if (page_and_index.page != 0){
        Font_Metrics *metrics = &page_and_index.page->metrics[page_and_index.index];
        length = metrics->name_len;
        copy_partial_cs(str_out, capacity, make_string(metrics->name, length));
    }
    
    return(length);
}

internal
Sys_Font_Get_Pointers_By_ID_Sig(system_font_get_pointers_by_id, font_id){
    Font_Pointers font = {0};
    if (font_id == 0){
        return(font);
    }
    
    Font_Slot_Page_And_Index page_and_index = system_font_get_active_location(font_id);
    if (page_and_index.page != 0){
        font.valid    = true;
        font.settings = &page_and_index.page->settings[page_and_index.index];
        font.metrics  = &page_and_index.page->metrics[page_and_index.index];
        font.pages    = &page_and_index.page->pages[page_and_index.index];
    }
    
    return(font);
}

internal
Sys_Font_Load_Page_Sig(system_font_load_page, settings, metrics, page, page_number){
    Assert(page_number != 0);
    font_load_page_layout(settings, metrics, page, page_number);
}

////////////////////////////////

internal Font_Setup_List
system_font_get_local_stubs(Partition *part){
    Font_Setup_List list = {0};
    
    u32 dir_max = KB(32);
    u8 *directory = push_array(part, u8, dir_max);
    String dir_str = make_string_cap(directory, 0, dir_max);
    u32 dir_len = dir_str.size = system_get_4ed_path(dir_str.str, dir_str.memory_size);
    Assert(dir_len < dir_max);
    
    set_last_folder_sc(&dir_str, "fonts", SLASH);
    terminate_with_null(&dir_str);
    dir_len = dir_str.size;
    
    partition_reduce(part, dir_max - dir_len - 1);
    partition_align(part, 8);
    
    File_List file_list = {0};
    system_set_file_list(&file_list, (char*)directory, 0, 0, 0);
    
    for (u32 i = 0; i < file_list.count; ++i){
        File_Info *info = &file_list.infos[i];
        
        char *filename = info->filename;
        u32 len = 0;
        for (;filename[len];++len);
        
        if (dir_len + len + 1 <= sizeof(list.first->stub.name)){
            Font_Setup *setup = push_struct(part, Font_Setup);
            memset(setup, 0, sizeof(*setup));
            partition_align(part, 8);
            
            sll_push(list.first, list.last, setup);
            
            setup->stub.load_from_path = true;
            memcpy(&setup->stub.name[0], directory, dir_len);
            memcpy(&setup->stub.name[dir_len], filename, len + 1);
            setup->stub.len = dir_len + len;
        }
    }
    
    system_set_file_list(&file_list, 0, 0, 0, 0);
    
    return(list);
}

internal void
system_font_init(Font_Functions *font_links, u32 pt_size, b32 use_hinting, Font_Setup_List list){
    // Linking
    font_links->get_loadable_count = system_font_get_loadable_count;
    font_links->get_loadable       = system_font_get_loadable;
    font_links->load_new_font      = system_font_load_new_font;
    font_links->get_count          = system_font_get_count;
    font_links->get_name_by_id     = system_font_get_name_by_id;
    font_links->get_pointers_by_id = system_font_get_pointers_by_id;
    font_links->load_page          = system_font_load_page;
    font_links->allocate           = system_font_allocate;
    font_links->free               = system_font_free;
    
    // Initialize fontvars
    memset(&fontvars, 0, sizeof(fontvars));
    dll_init_sentinel(&fontvars.slot_pages_sentinel);
    fontvars.pt_size = pt_size;
    fontvars.use_hinting = use_hinting;
    
    // Filling loadable font descriptions
    for (Font_Setup *ptr = list.first;
         ptr != 0;
         ptr = ptr->next){
        Font_Loadable_Stub *stub = &ptr->stub;
        
        if (fontvars.loadable_count < ArrayCount(fontvars.loadables)){
            Font_Loadable_Description *loadable = &fontvars.loadables[fontvars.loadable_count];
            
            b32 name_good = false;
            i32 capacity = (i32)(sizeof(loadable->display_name));
            
            if (stub->load_from_path){
                if (ptr->has_display_name){
                    name_good = true;
                    memcpy(loadable->display_name, ptr->name, ptr->len);
                }
                else{
                    name_good = font_load_name(stub, loadable->display_name, capacity);
                }
                if (name_good){
                    loadable->display_len = str_size(loadable->display_name);
                }
            }
            else{
                i32 len = str_size(stub->name);
                if (len < capacity){
                    name_good = true;
                    memcpy(loadable->display_name, stub->name, len + 1);
                    loadable->display_len = len;
                }
            }
            
            if (name_good){
                memcpy(&loadable->stub, stub, sizeof(*stub));
                loadable->valid = true;
                ++fontvars.loadable_count;
            }
        }
    }
    
    // Force load one font.
    Font_Setup *first_setup = list.first;
    system_font_load_new_font(&first_setup->stub);
}

// BOTTOM