image.c

Go to the documentation of this file.

const char * const rcsid_gtk2_image_c =
    "$Id: image.c 11043 2008-12-21 04:44:14Z kbulgrien $";
/*
    Crossfire client, a client program for the crossfire program.

    Copyright (C) 2005 Mark Wedel & Crossfire Development Team

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

    The author can be reached via e-mail to crossfire@metalforge.org
*/

#include <config.h>
#include <stdlib.h>
#include <sys/stat.h>
#ifndef WIN32
#include <unistd.h>
#endif
#include <png.h>

/* Pick up the gtk headers we need */
#include <gtk/gtk.h>
#include <glade/glade.h>
#ifndef WIN32
#include <gdk/gdkx.h>
#else
#include <gdk/gdkwin32.h>
#endif
#include <gdk/gdkkeysyms.h>

#ifdef HAVE_SDL
#include <SDL.h>
#include <SDL_image.h>
#endif

#include "client-types.h"
#include "client.h"
#include "image.h"
#include "main.h"
#include "mapdata.h"
#include "gtk2proto.h"

extern GtkWidget *window_root; 
int image_size=DEFAULT_IMAGE_SIZE;

struct {
    char    *name;
    uint32  checksum;
    uint8   *png_data;
    uint32  width, height;
} private_cache[MAXPIXMAPNUM];

#define BPP 4

PixmapInfo *pixmaps[MAXPIXMAPNUM];

int last_face_num=0;

/*
 * this is used to rescale big images that will be drawn in the inventory/look
 * lists.  What the code further below basically does is figure out how big the
 * object is (in squares), and this looks at the icon_rescale_factor to figure
 * what scale factor it gives.  Not that the icon_rescale_factor values are
 * passed directly to the rescale routines.  These represent percentages - so
 * even taking into account that the values diminish as the table grows, they
 * will still appear larger if the location in the table times the factor is
 * greater than 100.  We find the largest dimension that the image has.  The
 * values in the comment is the effective scaling compared to the base image
 * size that this big image will appear as.  Using a table makes it easier to
 * adjust the values so things look right.
 */

#define MAX_ICON_SPACES     10
static const int icon_rescale_factor[MAX_ICON_SPACES] = {
100, 100,           80 /* 2 = 160 */,   60 /* 3 = 180 */,
50 /* 4 = 200 */,   45 /* 5 = 225 */,   40 /* 6 = 240 */,
35 /* 7 = 259 */,   35 /* 8 = 280 */,   33 /* 9 = 300 */
};

/******************************************************************************
 *
 * Code related to face caching.
 *
 *****************************************************************************/

/* Does not appear to be used anywhere
typedef struct Keys {
    uint8       flags;
    sint8       direction;
    KeySym      keysym;
    char        *command;
    struct Keys *next;
} Key_Entry;
*/

/* Rotate right from bsd sum. */
#define ROTATE_RIGHT(c) if ((c) & 01) (c) = ((c) >>1) + 0x80000000; else (c) >>= 1;

/*#define CHECKSUM_DEBUG*/

static void create_icon_image(uint8 *data, PixmapInfo *pi, int pixmap_num)
{
    pi->icon_mask = NULL;
    if (rgba_to_gdkpixbuf(data, pi->icon_width, pi->icon_height,
                (GdkPixbuf**)&pi->icon_image))
                    LOG (LOG_ERROR,"gtk::create_icon_image","Unable to create scaled image, dest num = %d\n", pixmap_num);
}

static void create_map_image(uint8 *data, PixmapInfo *pi)
{
    pi->map_image = NULL;
    pi->map_mask = NULL;

    if (use_config[CONFIG_DISPLAYMODE]==CFG_DM_SDL) {
#if defined(HAVE_SDL)
        int i;
        SDL_Surface *fog;
        uint32 g,*p;
        uint8 *l;

#if SDL_BYTEORDER == SDL_LIL_ENDIAN
        pi->map_image = SDL_CreateRGBSurfaceFrom(data, pi->map_width,
                pi->map_height, 32, pi->map_width * 4,  0xff,
                        0xff00, 0xff0000, 0xff000000);

        fog = SDL_CreateRGBSurface(SDL_SRCALPHA | SDL_HWSURFACE,
                pi->map_width,  pi->map_height, 32, 0xff,
                        0xff00, 0xff0000, 0xff000000);
        SDL_LockSurface(fog);

        for (i=0; i < pi->map_width * pi->map_height; i++) {
            l = (uint8 *) (data + i*4);
#if 1
            g = MAX(*l, *(l+1));
            g = MAX(g, *(l+2));
#else
            g = ( *l +  *(l+1) + *(l+2)) / 3;
#endif
            p = (uint32*) fog->pixels + i;
            *p = g | (g << 8) | (g << 16) | (*(l + 3) << 24);
        }

        SDL_UnlockSurface(fog);
        pi->fog_image = fog;
    #else
        /* Big endian */
        pi->map_image = SDL_CreateRGBSurfaceFrom(data, pi->map_width,
                pi->map_height, 32, pi->map_width * 4,  0xff000000,
                        0xff0000, 0xff00, 0xff);

        fog = SDL_CreateRGBSurface(SDL_SRCALPHA | SDL_HWSURFACE,
                pi->map_width,  pi->map_height, 32, 0xff000000,
                        0xff0000, 0xff00, 0xff);
        SDL_LockSurface(fog);

        /*
         * I think this works out, but haven't tried it on a big endian machine
         * as my recollection is that the png data would be in the same order,
         * just the bytes for it to go on the screen are reversed.
         */
        for (i=0; i < pi->map_width * pi->map_height; i++) {
            l = (uint8 *) (data + i*4);
#if 1
            g = MAX(*l, *(l+1));
            g = MAX(g, *(l+2));
#else
            g = ( *l +  *(l+1) + *(l+2)) / 3;
#endif
            p = (uint32*) fog->pixels + i;
            *p = (g << 8) | (g << 16) | (g << 24) | *(l + 3);
        }

        for (i=0; i < pi->map_width * pi->map_height; i+= 4) {
            uint32 *tmp;

            /*
             * The pointer arithemtic below looks suspicious, but it is a patch
             * that is submitted, so just putting it in as submitted.  MSW
             * 2004-05-11
             */
            p = (uint32*) (fog->pixels + i);
            g = ( ((*p >> 24) & 0xff)  + ((*p >> 16) & 0xff) + ((*p >> 8) & 0xff)) / 3;
            tmp = (uint32*) fog->pixels + i;
            *tmp = (g << 24) | (g << 16) | (g << 8) | (*p & 0xff);
        }

        SDL_UnlockSurface(fog);
        pi->fog_image = fog;
    #endif

#endif
    }
    else if (use_config[CONFIG_DISPLAYMODE] == CFG_DM_OPENGL){
#ifdef HAVE_OPENGL
        create_opengl_map_image(data, pi);
#endif
    }

    else if (use_config[CONFIG_DISPLAYMODE] == CFG_DM_PIXMAP){
        rgba_to_gdkpixmap(window_root->window, data, pi->map_width, pi->map_height,
                (GdkPixmap**)&pi->map_image, (GdkBitmap**)&pi->map_mask,
                gtk_widget_get_colormap(window_root));
    }
}

static void free_pixmap(PixmapInfo *pi)
{
    if (pi->icon_image) g_object_unref(pi->icon_image);
    if (pi->icon_mask) g_object_unref(pi->icon_mask);
    if (pi->map_mask) gdk_pixmap_unref(pi->map_mask);
        if (use_config[CONFIG_DISPLAYMODE]==CFG_DM_SDL) {
#ifdef HAVE_SDL
            if (pi->map_image) {
                SDL_FreeSurface(pi->map_image);
                free(((SDL_Surface*)pi->map_image)->pixels);
                SDL_FreeSurface(pi->fog_image);
                /*
                 * Minor memory leak here - SDL_FreeSurface() frees the pixel
                 * data _unless_ SDL_CreateRGBSurfaceFrom() was used to create
                 * the surface.  SDL_CreateRGBSurfaceFrom() is used to create
                 * the map data, which is why we need the free there.  The
                 * reason this is a minor memory leak is because
                 * SDL_CreateRGBSurfaceFrom() is used to create the question
                 * mark image, and without this free, that data is not freed.
                 * However, with this, client crashes after disconnecting from
                 * server with double free.
                 */
    /*          free(((SDL_Surface*)pi->fog_image)->pixels);*/
            }
#endif
        }
        else if (use_config[CONFIG_DISPLAYMODE]==CFG_DM_OPENGL) {
#ifdef HAVE_OPENGL
            opengl_free_pixmap(pi);
#endif
        }
    else if (use_config[CONFIG_DISPLAYMODE]==CFG_DM_PIXMAP) {
        if (pi->map_image) {
            gdk_pixmap_unref(pi->map_image);
        }
    }
}

int create_and_rescale_image_from_data(Cache_Entry *ce, int pixmap_num, uint8 *rgba_data, int width, int height)
{
    int nx, ny, iscale, factor;
    uint8 *png_tmp;
    PixmapInfo  *pi;

    if (pixmap_num <= 0 || pixmap_num >= MAXPIXMAPNUM)
        return 1;

    if (pixmaps[pixmap_num] != pixmaps[0]) {
        free_pixmap(pixmaps[pixmap_num]);
        free(pixmaps[pixmap_num]);
        pixmaps[pixmap_num] = pixmaps[0];
    }

    pi = calloc(1, sizeof(PixmapInfo));

    iscale = use_config[CONFIG_ICONSCALE];

    /*
     * If the image is big, figure out what we should scale it to so it fits
     * better display
     */
    if (width > DEFAULT_IMAGE_SIZE || height>DEFAULT_IMAGE_SIZE) {
        int ts = 100;

        factor = width / DEFAULT_IMAGE_SIZE;
        if (factor >= MAX_ICON_SPACES) factor = MAX_ICON_SPACES - 1;
        if (icon_rescale_factor[factor] < ts) ts = icon_rescale_factor[factor];

        factor = height / DEFAULT_IMAGE_SIZE;
        if (factor >= MAX_ICON_SPACES) factor = MAX_ICON_SPACES - 1;
        if (icon_rescale_factor[factor] < ts) ts = icon_rescale_factor[factor];

        iscale = ts * use_config[CONFIG_ICONSCALE] / 100;
    }

    /* In all cases, the icon images are in native form. */
    if (iscale != 100) {
        nx=width;
        ny=height;
        png_tmp = rescale_rgba_data(rgba_data, &nx, &ny, iscale);
        pi->icon_width = nx;
        pi->icon_height = ny;
        create_icon_image(png_tmp, pi, pixmap_num);
        free(png_tmp);
    }
    else {
        pi->icon_width = width;
        pi->icon_height = height;
        create_icon_image(rgba_data, pi, pixmap_num);
    }

    /*
     * If icon_scale matched use_config[CONFIG_MAPSCALE], we could try to be
     * more intelligent, but this should not be called too often, and this
     * keeps the code simpler.
     */
    if (use_config[CONFIG_MAPSCALE] != 100) {
        nx=width;
        ny=height;
        png_tmp = rescale_rgba_data(rgba_data, &nx, &ny, use_config[CONFIG_MAPSCALE]);
        pi->map_width = nx;
        pi->map_height = ny;
        create_map_image(png_tmp, pi);
        /*
         * pixmap mode and opengl don't need the rgba data after they have
         * created the image, so we can free it.  SDL uses the raw rgba data,
         * so it can't be freed.
         */
        if (use_config[CONFIG_DISPLAYMODE]==CFG_DM_PIXMAP ||
            use_config[CONFIG_DISPLAYMODE]==CFG_DM_OPENGL) free(png_tmp);
    } else {
        pi->map_width = width;
        pi->map_height = height;
        /*
         * If using SDL mode, a copy of the rgba data needs to be stored away.
         */
        if (use_config[CONFIG_DISPLAYMODE]==CFG_DM_SDL) {
            png_tmp = malloc(width * height * BPP);
            memcpy(png_tmp, rgba_data, width * height * BPP);
        } else
            png_tmp = rgba_data;
        create_map_image(png_tmp, pi);
    }
    /*
     * Not ideal, but if it is missing the map or icon image, presume something
     * failed.  However, opengl doesn't set the map_image, so if using that
     * display mode, don't make this check.
     */
    if (!pi->icon_image || (!pi->map_image && use_config[CONFIG_DISPLAYMODE]!=CFG_DM_OPENGL)) {
        free_pixmap(pi);
        free(pi);
        return 1;
    }
    if (ce) {
        ce->image_data = pi;
    }
    pixmaps[pixmap_num] = pi;
    return 0;
}

void addsmooth(uint16 face, uint16 smooth_face)
{
    pixmaps[face]->smooth_face = smooth_face;
}

int associate_cache_entry(Cache_Entry *ce, int pixnum)
{
    pixmaps[pixnum] = ce->image_data;
    return 0;
}

void reset_image_data(void)
{
    int i;

    reset_image_cache_data();
    /*
     * The entries in the pixmaps array are also tracked in the image cache in
     * the common area.  We will try to recycle those images that we can.
     * Thus, if we connect to a new server, we can just re-use the images we
     * have already rendered.
     */
    for (i=1; i<MAXPIXMAPNUM; i++) {
        if (!want_config[CONFIG_CACHE] && pixmaps[i] != pixmaps[0]) {
            free_pixmap(pixmaps[i]);
            free(pixmaps[i]);
            pixmaps[i] = pixmaps[0];
        }
    }
}

static GtkWidget     *pbar=NULL;
static GtkWidget     *pbar_window=NULL;
static GtkAdjustment *padj=NULL;

void image_update_download_status(int start, int end, int total)
{
    int x, y, wx, wy, w, h;

    if (start == 1) {
        padj = (GtkAdjustment*) gtk_adjustment_new (0, 1, total, 0, 0, 0);

        pbar = gtk_progress_bar_new_with_adjustment(padj);
        gtk_progress_set_format_string(GTK_PROGRESS(pbar), "Downloading image %v of %u (%p%% complete)");
        gtk_progress_bar_set_bar_style(GTK_PROGRESS_BAR(pbar), GTK_PROGRESS_CONTINUOUS);
        gtk_progress_set_show_text(GTK_PROGRESS(pbar), TRUE);
        get_window_coord(window_root, &x,&y, &wx,&wy,&w,&h);

        pbar_window = gtk_window_new(GTK_WINDOW_POPUP);
        gtk_window_set_policy(GTK_WINDOW(pbar_window), TRUE, TRUE, FALSE);
        gtk_window_set_transient_for(GTK_WINDOW(pbar_window), GTK_WINDOW (window_root));
        /*
         * We more or less want this window centered on the main crossfire
         * window, and not necessarily centered on the screen or in the upper
         * left corner.
         */
        gtk_widget_set_uposition(pbar_window, (wx + w)/2, (wy + h) / 2);

        gtk_container_add(GTK_CONTAINER(pbar_window), pbar);
        gtk_widget_show(pbar);
        gtk_widget_show(pbar_window);
    }
    if (start == total) {
        gtk_widget_destroy(pbar_window);
        pbar = NULL;
        pbar_window = NULL;
        padj = NULL;
        return;
    }

    gtk_progress_set_value(GTK_PROGRESS(pbar), start);
    while ( gtk_events_pending() ) {
        gtk_main_iteration();
    }
}

void get_map_image_size(int face, uint8 *w, uint8 *h)
{
    /* We want to calculate the number of spaces this image
     * uses it.  By adding the image size but substracting one,
     * we cover the cases where the image size is not an even
     * increment.  EG, if the map_image_size is 32, and an image
     * is 33 wide, we want that to register as two spaces.  By
     * adding 31, that works out.
     */
    if ( face < 0 || face >= MAXPIXMAPNUM) {
        *w = 1;
        *h = 1;
    } else {
        *w = (pixmaps[face]->map_width + map_image_size - 1)/ map_image_size;
        *h = (pixmaps[face]->map_height + map_image_size - 1)/ map_image_size;
    }
}

/******************************************************************************
 *
 * Code related to face caching.
 *
 *****************************************************************************/

void init_cache_data(void)
{
    int i;
    GtkStyle *style;
#include "../../pixmaps/question.xpm"


    LOG(LOG_INFO,"gtk::init_cache_data","Init Cache");

    style = gtk_widget_get_style(window_root);
    pixmaps[0] = malloc(sizeof(PixmapInfo));
    pixmaps[0]->icon_image = gdk_pixmap_create_from_xpm_d(window_root->window,
                                                        (GdkBitmap**)&pixmaps[0]->icon_mask,
                                                        &style->bg[GTK_STATE_NORMAL],
                                                        (gchar **)question_xpm);
#ifdef HAVE_SDL
    if (use_config[CONFIG_DISPLAYMODE]==CFG_DM_SDL) {
        /*
         * Make a semi-transparent question mark symbol to use for the cached
         * images.
         */
#include "../../pixmaps/question.sdl"
        pixmaps[0]->map_image = SDL_CreateRGBSurfaceFrom(question_sdl,
                32, 32, 1, 4, 1, 1, 1, 1);
        SDL_SetAlpha(pixmaps[0]->map_image, SDL_SRCALPHA, 70);
        pixmaps[0]->fog_image = SDL_CreateRGBSurfaceFrom(question_sdl,
                32, 32, 1, 4, 1, 1, 1, 1);
        SDL_SetAlpha(pixmaps[0]->fog_image, SDL_SRCALPHA, 70);
    }
    else
#endif
    if (use_config[CONFIG_DISPLAYMODE]==CFG_DM_PIXMAP)
    {
        pixmaps[0]->map_image =  pixmaps[0]->icon_image;
        pixmaps[0]->fog_image =  pixmaps[0]->icon_image;
        pixmaps[0]->map_mask =  pixmaps[0]->icon_mask;
    }
#ifdef HAVE_OPENGL
    else if (use_config[CONFIG_DISPLAYMODE]==CFG_DM_OPENGL) {
        create_opengl_question_mark();
    }
#endif

    pixmaps[0]->icon_width = pixmaps[0]->icon_height = pixmaps[0]->map_width = pixmaps[0]->map_height = map_image_size;
    pixmaps[0]->smooth_face = 0;

    /* Don't do anything special for SDL image - rather, that drawing
     * code will check to see if there is no data
     */

    /* Initialize all the images to be of the same value. */
    for (i=1; i<MAXPIXMAPNUM; i++)  {
        pixmaps[i] = pixmaps[0];
    }

    init_common_cache_data();
}