nssprite.c

Go to the documentation of this file.

 /*
 * Copyright 2008 James Shaw <js102@zepler.net>
 *
 * This file is part of NetSurf, http://www.netsurf-browser.org/
 *
 * NetSurf 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; version 2 of the License.
 *
 * NetSurf 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, see <http://www.gnu.org/licenses/>.
 */
 
/**
 * \file
 * librosprite implementation for content image/x-riscos-sprite
 */
 
#include <stdbool.h>
#include <stdlib.h>
#include <string.h>
 
#include <librosprite.h>
 
#include "utils/utils.h"
#include "utils/log.h"
#include "utils/messages.h"
#include "netsurf/plotters.h"
#include "netsurf/bitmap.h"
#include "netsurf/content.h"
#include "content/llcache.h"
#include "content/content_protected.h"
#include "content/content_factory.h"
#include "desktop/gui_internal.h"
#include "desktop/bitmap.h"
 
#include "image/nssprite.h"
 
typedef struct nssprite_content {
        struct content base;
        struct bitmap *bitmap;  /**< Created NetSurf bitmap */
 
        struct rosprite_area* sprite_area;
} nssprite_content;
 
 
#define ERRCHK(x) do { \
        rosprite_error err = x; \
        if (err == ROSPRITE_EOF) { \
                NSLOG(netsurf, INFO, "Got ROSPRITE_EOF when loading sprite file"); \
                goto ro_sprite_error; \
        } else if (err == ROSPRITE_BADMODE) { \
                NSLOG(netsurf, INFO, "Got ROSPRITE_BADMODE when loading sprite file"); \
                goto ro_sprite_error; \
        } else if (err == ROSPRITE_OK) { \
        } else { \
                goto ro_sprite_error; \
        } \
} while(0)
 
 
 
 
static nserror nssprite_create(const content_handler *handler,
                lwc_string *imime_type, const struct http_parameter *params,
                struct llcache_handle *llcache, const char *fallback_charset,
                bool quirks, struct content **c)
{
        nssprite_content *sprite;
        nserror error;
 
        sprite = calloc(1, sizeof(nssprite_content));
        if (sprite == NULL)
                return NSERROR_NOMEM;
 
        error = content__init(&sprite->base, handler, imime_type, params,
                        llcache, fallback_charset, quirks);
        if (error != NSERROR_OK) {
                free(sprite);
                return error;
        }
 
        *c = (struct content *) sprite;
 
        return NSERROR_OK;
}
 
/**
 * Convert a CONTENT_SPRITE for display.
 *
 * No conversion is necessary. We merely read the sprite dimensions.
 */
 
static bool nssprite_convert(struct content *c)
{
        nssprite_content *nssprite = (nssprite_content *) c;
 
        struct rosprite_mem_context* ctx = NULL;
 
        const uint8_t *data;
        size_t size;
        char *title;
 
        data = content__get_source_data(c, &size);
 
        ERRCHK(rosprite_create_mem_context((uint8_t *) data, size, &ctx));
 
        struct rosprite_area* sprite_area;
        ERRCHK(rosprite_load(rosprite_mem_reader, ctx, &sprite_area));
        rosprite_destroy_mem_context(ctx);
        nssprite->sprite_area = sprite_area;
 
        assert(sprite_area->sprite_count > 0);
 
        struct rosprite* sprite = sprite_area->sprites[0];
 
        nssprite->bitmap = guit->bitmap->create(sprite->width, sprite->height, BITMAP_NONE);
        if (!nssprite->bitmap) {
                content_broadcast_error(c, NSERROR_NOMEM, NULL);
                return false;
        }
        uint32_t* imagebuf = (uint32_t *)(void *)guit->bitmap->get_buffer(nssprite->bitmap);
        if (!imagebuf) {
                content_broadcast_error(c, NSERROR_NOMEM, NULL);
                return false;
        }
        unsigned char *spritebuf = (unsigned char *)sprite->image;
 
        memcpy(imagebuf, spritebuf, sprite->width * sprite->height * 4);
 
        c->width = sprite->width;
        c->height = sprite->height;
 
        /* set title text */
        title = messages_get_buff("SpriteTitle",
                        nsurl_access_leaf(llcache_handle_get_url(c->llcache)),
                        c->width, c->height);
        if (title != NULL) {
                content__set_title(c, title);
                free(title);
        }
 
        bitmap_format_to_client(nssprite->bitmap, &(bitmap_fmt_t) {
                .layout = BITMAP_LAYOUT_A8B8G8R8,
        });
        guit->bitmap->modified(nssprite->bitmap);
 
        content_set_ready(c);
        content_set_done(c);
        content_set_status(c, ""); /* Done: update status bar */
 
        return true;
 
ro_sprite_error:
        if (ctx != NULL) {
                rosprite_destroy_mem_context(ctx);
        }
        content_broadcast_error(c, NSERROR_SPRITE_ERROR, NULL);
 
        return false;
}
 
 
/**
 * Destroy a CONTENT_SPRITE and free all resources it owns.
 */
 
static void nssprite_destroy(struct content *c)
{
        nssprite_content *nssprite = (nssprite_content *) c;
 
        if (nssprite->sprite_area != NULL)
                rosprite_destroy_sprite_area(nssprite->sprite_area);
        if (nssprite->bitmap != NULL)
                guit->bitmap->destroy(nssprite->bitmap);
}
 
 
/**
 * Redraw a CONTENT_SPRITE.
 */
 
static bool
nssprite_redraw(struct content *c,
                struct content_redraw_data *data,
                const struct rect *clip,
                const struct redraw_context *ctx)
{
        nssprite_content *nssprite = (nssprite_content *) c;
        bitmap_flags_t flags = BITMAPF_NONE;
 
        if (data->repeat_x) {
                flags |= BITMAPF_REPEAT_X;
        }
        if (data->repeat_y) {
                flags |= BITMAPF_REPEAT_Y;
        }
 
        return (ctx->plot->bitmap(ctx,
                                  nssprite->bitmap,
                                  data->x, data->y,
                                  data->width, data->height,
                                  data->background_colour,
                                  flags) == NSERROR_OK);
}
 
 
static nserror nssprite_clone(const struct content *old, struct content **newc)
{
        nssprite_content *sprite;
        nserror error;
 
        sprite = calloc(1, sizeof(nssprite_content));
        if (sprite == NULL)
                return NSERROR_NOMEM;
 
        error = content__clone(old, &sprite->base);
        if (error != NSERROR_OK) {
                content_destroy(&sprite->base);
                return error;
        }
 
        /* Simply replay convert */
        if (old->status == CONTENT_STATUS_READY ||
                        old->status == CONTENT_STATUS_DONE) {
                if (nssprite_convert(&sprite->base) == false) {
                        content_destroy(&sprite->base);
                        return NSERROR_CLONE_FAILED;
                }
        }
 
        *newc = (struct content *) sprite;
 
        return NSERROR_OK;
}
 
static void *nssprite_get_internal(const struct content *c, void *context)
{
        nssprite_content *nssprite = (nssprite_content *) c;
 
        return nssprite->bitmap;
}
 
static content_type nssprite_content_type(void)
{
        return CONTENT_IMAGE;
}
 
 
static bool nssprite_content_is_opaque(struct content *c)
{
        nssprite_content *nssprite = (nssprite_content *) c;
 
        if (nssprite->bitmap != NULL) {
                return guit->bitmap->get_opaque(nssprite->bitmap);
        }
 
        return false;
}
 
static const content_handler nssprite_content_handler = {
        .create = nssprite_create,
        .data_complete = nssprite_convert,
        .destroy = nssprite_destroy,
        .redraw = nssprite_redraw,
        .clone = nssprite_clone,
        .get_internal = nssprite_get_internal,
        .type = nssprite_content_type,
        .is_opaque = nssprite_content_is_opaque,
        .no_share = false,
};
 
static const char *nssprite_types[] = {
        "image/x-riscos-sprite"
};
 
CONTENT_FACTORY_REGISTER_TYPES(nssprite, nssprite_types, nssprite_content_handler);