image.c

Go to the documentation of this file.

const char * const rcsid_gtk_image_c =
    "$Id: image.c 9201 2008-06-01 17:32:45Z anmaster $";
/*
    Crossfire client, a client program for the crossfire program.

    Copyright (C) 2001 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-devel@real-time.com
*/

/*
 * This file contains image related functions - this is a higher level up -
 * it mostly deals with the caching of the images, processing the image commands
 * from the server, etc.  This file is gtk specific - at least it returns
 * gtk pixmaps.
 */

#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>
#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 "gx11.h"
#include "client.h"

#include "gtkproto.h"

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

#define BPP 4

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 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.
 *
 *****************************************************************************/

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*/

/* These little helper functions just make the code below much more readable */
static void create_icon_image(uint8 *data, PixmapInfo *pi, int pixmap_num)
{
    if (rgba_to_gdkpixmap(gtkwin_root->window, data, pi->icon_width, pi->icon_height,
                (GdkPixmap**)&pi->icon_image, (GdkBitmap**)&pi->icon_mask,
                gtk_widget_get_colormap(gtkwin_root)))
                    LOG (LOG_ERROR,"gtk::create_icon_image","Unable to create scaled image, dest num = %d\n", pixmap_num);
}

/* These little helper functions just make the code below much more readable */
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);
            /* The effective luminance of a pixel is calculated with the following formula:
             *      Y=0.3RED+0.59GREEN+0.11Blue
             * This is the way you are supposed to convert color to grayscale
             * for best 'natural' results. Using maxes, mins or simple mean is
             * gives awfull results with darkness code.
             * For speed reason i work here in integers
             *      (77RED+151GREEN+28BLUE)>>8
             *
             *                          Tchize 22 May 2004
             */
            g=(77*(*l)+151*(*(l+1))+28*(*(l+2)))>>8;
            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 - my recollection is that the png data
         * would be in the same order, just the bytes for it to go
         * on teh screen are reversed.
         */
        for (i=0; i < pi->map_width * pi->map_height; i++) {
            l = (uint8 *) (data + i*4);
            /* The effective luminance of a pixel is calculated with the following formula:
             *      Y=0.3RED+0.59GREEN+0.11Blue
             * This is the way you are supposed to convert color to grayscale
             * for best 'natural' results. Using maxes, mins or simple mean is
             * gives awfull results with darkness code.
             * For speed reason i work here in integers
             *      (77RED+151GREEN+28BLUE)>>8
             *
             *                          Tchize 22 May 2004
             */
            g=(77*(*l)+151*(*(l+1))+28*(*(l+2)))>>8;
            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 {
        rgba_to_gdkpixmap(gtkwin_root->window, data, pi->map_width, pi->map_height,
                (GdkPixmap**)&pi->map_image, (GdkBitmap**)&pi->map_mask,
                gtk_widget_get_colormap(gtkwin_root));
    }
}

static void free_pixmap(PixmapInfo *pi)
{
    if (pi->icon_image) gdk_pixmap_unref(pi->icon_image);
    if (pi->icon_mask) gdk_pixmap_unref(pi->icon_mask);
    if (pi->map_mask) gdk_pixmap_unref(pi->map_mask);
    if (pi->map_image) {
#ifdef HAVE_SDL
        if (use_config[CONFIG_DISPLAYMODE]==CFG_DM_SDL) {
            free(((SDL_Surface*)pi->map_image)->pixels);
            SDL_FreeSurface(pi->map_image);
            SDL_FreeSurface(pi->fog_image);
/*          free(((SDL_Surface*)pi->fog_image)->pixels);*/
        }
        else
#endif
        {
            gdk_pixmap_unref(pi->map_image);
        }
    }
}

/* Takes the pixmap to put the data into, as well as the rgba
 * data (ie, already loaded with png_to_data).  Scales and
 * stores the relevant data into the pixmap structure.
 * returns 1 on failure.
 * ce can be NULL
 */

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);
    }

    /* We could try to be more intelligent if icon_scale matched use_config[CONFIG_MAPSCALE],
     * but this shouldn't be called too often, and this keeps the code
     * simpler.
     *
     *  maybe, but it uses graphical resources, and takes time (don't laugh, some people use
     *   slow old comps! :p)
     *  Ryo 2005-09-05
     *
     * Maybe, but only if were using PIXMAP mode - otherwise, SDL doesn't know how to
     * draw GDK pixmaps.
     * MSW 2006-11-05
     */
    if (iscale == use_config[CONFIG_MAPSCALE] && use_config[CONFIG_DISPLAYMODE]==CFG_DM_PIXMAP) {
        pi->map_height = pi->icon_height;
        pi->map_width = pi->icon_width;
        pi->map_mask = pi->icon_mask;
        pi->map_image = pi->icon_image;
        gdk_pixmap_ref(pi->map_image);
        if (pi->map_mask)
            gdk_pixmap_ref(pi->map_mask);
    } else 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);
        if (use_config[CONFIG_DISPLAYMODE]==CFG_DM_PIXMAP) 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 basically, if it is missing the map or icon image, presume
     * something failed.
     */
    if (!pi->icon_image || !pi->map_image) {
        free_pixmap(pi);
        free(pi);
        return 1;
    }
    if (ce) {
        ce->image_data = pi;
        redraw_needed=1;
    }
    pixmaps[pixmap_num] = pi;
    return 0;
}

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

/* This functions associates the image_data in the cache entry
 * with the specific pixmap number.  Returns 0 on success, -1
 * on failure.  Currently, there is no failure condition, but
 * there is the potential that in the future, we want to more
 * closely look at the data and if it isn't valid, return
 * the failure code.
 */
int associate_cache_entry(Cache_Entry *ce, int pixnum)
{

    pixmaps[pixnum] = ce->image_data;
    return 0;
}

/* We can now connect to different servers, so we need to clear out
 * any old images.  We try to free the data also to prevent memory
 * leaks.
 * This could be more clever, ie, if we're caching images and go to
 * a new server and get a name, we should try to re-arrange our cache
 * or the like.
 */

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 recyle 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];
    }
}


/* This function draws a little status bar showing where we our
 * in terms of downloading all the image data.
 * start is the start value just sent to the server, end is the end
 * value.  total is the total number of images.
 * A few hacks:
 * If start is 1, this is the first batch, so it means we need to
 * create the appropriate status window.
 * if start = end = total, it means were finished, so destroy
 * the gui element.
 */
static GtkWidget        *pbar=NULL, *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(gtkwin_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 (gtkwin_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;
    }
}