artworks.c

Go to the documentation of this file.

/*
 * Copyright 2005 Adrian Lees <adrianl@users.sourceforge.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
 * Content for image/x-artworks (RISC OS implementation).
 *
 * Uses the ArtworksRenderer module
 */
 
#include "utils/config.h"
#ifdef WITH_ARTWORKS
 
#include <assert.h>
#include <limits.h>
#include <stdlib.h>
#include "swis.h"
#include "oslib/os.h"
#include "oslib/wimp.h"
 
#include "utils/config.h"
#include "utils/log.h"
#include "utils/messages.h"
#include "utils/utils.h"
#include "netsurf/plotters.h"
#include "netsurf/content.h"
#include "content/content.h"
#include "content/content_protected.h"
#include "content/content_factory.h"
#include "content/llcache.h"
 
#include "riscos/content-handlers/artworks.h"
#include "riscos/gui.h"
#include "riscos/wimputils.h"
 
#define AWRender_FileInitAddress 0x46080
#define AWRender_RenderAddress   0x46081
#define AWRender_DocBounds       0x46082
#define AWRender_SendDefs        0x46083
#define AWRender_ClaimVectors    0x46084
#define AWRender_ReleaseVectors  0x46085
#define AWRender_FindFirstFont   0x46086
#define AWRender_FindNextFont    0x46087
 
 
#define INITIAL_BLOCK_SIZE 0x1000
 
typedef struct artworks_content {
        struct content base;
 
        int x0, y0, x1, y1;
 
        void *render_routine;
        void *render_workspace;
 
        /* dynamically-resizable block required by
           ArtWorksRenderer rendering routine */
 
        void *block;
        size_t size;
} artworks_content;
 
struct awinfo_block {
        int ditherx;
        int dithery;
        int clip_x0;
        int clip_y0;
        int clip_x1;
        int clip_y1;
        int print_lowx;
        int print_lowy;
        int print_handle;
        int print_x1;
        int print_y1;
        int bgcolour;
};
 
 
/* Assembler routines for interfacing with the ArtworksRenderer module */
 
extern os_error *awrender_init(const char **doc,
                size_t *doc_size,
                void *routine,
                void *workspace);
 
extern os_error *awrender_render(const char *doc,
                const struct awinfo_block *info,
                const os_trfm *trans,
                const int *vdu_vars,
                void **rsz_block,
                size_t *rsz_size,
                int wysiwyg_setting,
                int output_dest,
                size_t doc_size,
                void *routine,
                void *workspace);
 
static nserror artworks_create(const content_handler *handler,
                lwc_string *imime_type, const struct http_parameter *params,
                llcache_handle *llcache, const char *fallback_charset,
                bool quirks, struct content **c);
static bool artworks_convert(struct content *c);
static void artworks_destroy(struct content *c);
static bool artworks_redraw(struct content *c, struct content_redraw_data *data,
                const struct rect *clip, const struct redraw_context *ctx);
static nserror artworks_clone(const struct content *old, struct content **newc);
static content_type artworks_content_type(void);
 
static const content_handler artworks_content_handler = {
        .create = artworks_create,
        .data_complete = artworks_convert,
        .destroy = artworks_destroy,
        .redraw = artworks_redraw,
        .clone = artworks_clone,
        .type = artworks_content_type,
        .no_share = false,
};
 
static const char *artworks_types[] = {
        "image/x-artworks"
};
 
CONTENT_FACTORY_REGISTER_TYPES(artworks, artworks_types, 
                artworks_content_handler)
 
nserror artworks_create(const content_handler *handler,
                lwc_string *imime_type, const struct http_parameter *params,
                llcache_handle *llcache, const char *fallback_charset,
                bool quirks, struct content **c)
{
        artworks_content *aw;
        nserror error;
 
        aw = calloc(1, sizeof(artworks_content));
        if (aw == NULL)
                return NSERROR_NOMEM;
 
        error = content__init(&aw->base, handler, imime_type, params,
                        llcache, fallback_charset, quirks);
        if (error != NSERROR_OK) {
                free(aw);
                return error;
        }
 
        *c = (struct content *) aw;
 
        return NSERROR_OK;
}
 
/**
 * Convert a CONTENT_ARTWORKS for display.
 *
 * No conversion is necessary. We merely read the ArtWorks
 * bounding box bottom-left.
 */
 
bool artworks_convert(struct content *c)
{
        artworks_content *aw = (artworks_content *) c;
        union content_msg_data msg_data;
        const uint8_t *source_data;
        size_t source_size;
        void *init_workspace;
        void *init_routine;
        os_error *error;
        int used = -1;  /* slightly better with older OSLib versions */
        char *title;
 
        /* check whether AWViewer has been seen and we can therefore
                locate the ArtWorks rendering modules */
        xos_read_var_val_size("Alias$LoadArtWorksModules", 0, os_VARTYPE_STRING,
                                &used, NULL, NULL);
        if (used >= 0) {
                NSLOG(netsurf, INFO, "Alias$LoadArtWorksModules not defined");
                msg_data.errordata.errorcode = NSERROR_UNKNOWN;
                msg_data.errordata.errormsg = messages_get("AWNotSeen");
                content_broadcast(c, CONTENT_MSG_ERROR, &msg_data);
                return false;
        }
 
        /* load the modules, or do nothing if they're already loaded */
        error = xos_cli("LoadArtWorksModules");
        if (error) {
                NSLOG(netsurf, INFO, "xos_cli: 0x%x: %s", error->errnum,
                      error->errmess);
                msg_data.errordata.errorcode = NSERROR_UNKNOWN;
                msg_data.errordata.errormsg = error->errmess;
                content_broadcast(c, CONTENT_MSG_ERROR, &msg_data);
                return false;
        }
 
        /* lookup the addresses of the init and render routines */
        error = (os_error*)_swix(AWRender_FileInitAddress, _OUT(0) | _OUT(1),
                                &init_routine, &init_workspace);
        if (error) {
                NSLOG(netsurf, INFO, "AWRender_FileInitAddress: 0x%x: %s",
                      error->errnum, error->errmess);
                msg_data.errordata.errorcode = NSERROR_UNKNOWN;
                msg_data.errordata.errormsg = error->errmess;
                content_broadcast(c, CONTENT_MSG_ERROR, &msg_data);
                return false;
        }
 
        error = (os_error*)_swix(AWRender_RenderAddress, _OUT(0) | _OUT(1),
                                &aw->render_routine,
                                &aw->render_workspace);
        if (error) {
                NSLOG(netsurf, INFO, "AWRender_RenderAddress: 0x%x: %s",
                      error->errnum, error->errmess);
                msg_data.errordata.errorcode = NSERROR_UNKNOWN;
                msg_data.errordata.errormsg = error->errmess;
                content_broadcast(c, CONTENT_MSG_ERROR, &msg_data);
                return false;
        }
 
        source_data = content__get_source_data(c, &source_size);
 
        /* initialise (convert file to new format if required) */
        error = awrender_init((const char **)&source_data, &source_size,
                        init_routine, init_workspace);
        if (error) {
                NSLOG(netsurf, INFO, "awrender_init: 0x%x : %s",
                      error->errnum, error->errmess);
                msg_data.errordata.errorcode = NSERROR_UNKNOWN;
                msg_data.errordata.errormsg = error->errmess;
                content_broadcast(c, CONTENT_MSG_ERROR, &msg_data);
                return false;
        }
 
        error = (os_error*)_swix(AWRender_DocBounds, 
                        _IN(0) | _OUT(2) | _OUT(3) | _OUT(4) | _OUT(5),
                        source_data,
                        &aw->x0,
                        &aw->y0,
                        &aw->x1,
                        &aw->y1);
 
        if (error) {
                NSLOG(netsurf, INFO, "AWRender_DocBounds: 0x%x: %s",
                      error->errnum, error->errmess);
                msg_data.errordata.errorcode = NSERROR_UNKNOWN;
                msg_data.errordata.errormsg = error->errmess;
                content_broadcast(c, CONTENT_MSG_ERROR, &msg_data);
                return false;
        }
 
        NSLOG(netsurf, INFO, "bounding box: %d,%d,%d,%d", aw->x0, aw->y0,
              aw->x1, aw->y1);
 
        /* create the resizable workspace required by the
                ArtWorksRenderer rendering routine */
 
        aw->size = INITIAL_BLOCK_SIZE;
        aw->block = malloc(INITIAL_BLOCK_SIZE);
        if (!aw->block) {
                NSLOG(netsurf, INFO,
                      "failed to create block for ArtworksRenderer");
                msg_data.errordata.errorcode = NSERROR_NOMEM;
                msg_data.errordata.errormsg = messages_get("NoMemory");
                content_broadcast(c, CONTENT_MSG_ERROR, &msg_data);
                return false;
        }
 
        c->width  = (aw->x1 - aw->x0) / 512;
        c->height = (aw->y1 - aw->y0) / 512;
 
        title = messages_get_buff("ArtWorksTitle",
                        nsurl_access_leaf(llcache_handle_get_url(c->llcache)),
                        c->width, c->height);
        if (title != NULL) {
                content__set_title(c, title);
                free(title);
        }
        content_set_ready(c);
        content_set_done(c);
        /* Done: update status bar */
        content_set_status(c, "");
        return true;
}
 
 
/**
 * Destroy a CONTENT_ARTWORKS and free all resources it owns.
 */
 
void artworks_destroy(struct content *c)
{
        artworks_content *aw = (artworks_content *) c;
 
        free(aw->block);
}
 
 
/**
 * Redraw a CONTENT_ARTWORKS.
 */
 
bool artworks_redraw(struct content *c, struct content_redraw_data *data,
                const struct rect *clip, const struct redraw_context *ctx)
{
        static const ns_os_vdu_var_list vars = {
                os_MODEVAR_XEIG_FACTOR,
                {
                        os_MODEVAR_YEIG_FACTOR,
                        os_MODEVAR_LOG2_BPP,
                        os_VDUVAR_END_LIST
                }
        };
        artworks_content *aw = (artworks_content *) c;
        struct awinfo_block info;
        const uint8_t *source_data;
        size_t source_size;
        os_error *error;
        os_trfm matrix;
        int vals[24];
 
        int clip_x0 = clip->x0;
        int clip_y0 = clip->y0;
        int clip_x1 = clip->x1;
        int clip_y1 = clip->y1;
 
        if (ctx->plot->flush && (ctx->plot->flush(ctx) != NSERROR_OK))
                return false;
 
        /* pick up render addresses again in case they've changed
           (eg. newer AWRender module loaded since we first loaded this file) */
        (void)_swix(AWRender_RenderAddress, _OUT(0) | _OUT(1),
                                &aw->render_routine,
                                &aw->render_workspace);
 
        /* Scaled image. Transform units (65536*OS units) */
        matrix.entries[0][0] = data->width * 65536 / c->width;
        matrix.entries[0][1] = 0;
        matrix.entries[1][0] = 0;
        matrix.entries[1][1] = data->height * 65536 / c->height;
        /* Draw units. (x,y) = bottom left */
        matrix.entries[2][0] = ro_plot_origin_x * 256 + data->x * 512 -
                        aw->x0 * data->width / c->width;
        matrix.entries[2][1] = ro_plot_origin_y * 256 -
                        (data->y + data->height) * 512 -
                        aw->y0 * data->height / c->height;
 
        info.ditherx = ro_plot_origin_x;
        info.dithery = ro_plot_origin_y;
 
        clip_x0 -= data->x;
        clip_y0 -= data->y;
        clip_x1 -= data->x;
        clip_y1 -= data->y;
 
        if (data->scale == 1.0) {
                info.clip_x0 = (clip_x0 * 512) + aw->x0 - 511;
                info.clip_y0 = ((c->height - clip_y1) * 512) + aw->y0 - 511;
                info.clip_x1 = (clip_x1 * 512) + aw->x0 + 511;
                info.clip_y1 = ((c->height - clip_y0) * 512) + aw->y0 + 511;
        }
        else {
                info.clip_x0 = (clip_x0 * 512 / data->scale) + aw->x0 - 511;
                info.clip_y0 = ((c->height - (clip_y1 / data->scale)) * 512) +
                                aw->y0 - 511;
                info.clip_x1 = (clip_x1 * 512 / data->scale) + aw->x0 + 511;
                info.clip_y1 = ((c->height - (clip_y0 / data->scale)) * 512) +
                                aw->y0 + 511;
        }
 
        info.print_lowx = 0;
        info.print_lowy = 0;
        info.print_handle = 0;
        info.bgcolour = 0x20000000 | data->background_colour;
 
        error = xos_read_vdu_variables(PTR_OS_VDU_VAR_LIST(&vars), vals);
        if (error) {
                NSLOG(netsurf, INFO, "xos_read_vdu_variables: 0x%x: %s",
                      error->errnum, error->errmess);
                return false;
        }
 
        error = xwimp_read_palette((os_palette*)&vals[3]);
        if (error) {
                NSLOG(netsurf, INFO, "xwimp_read_palette: 0x%x: %s",
                      error->errnum, error->errmess);
                return false;
        }
 
        source_data = content__get_source_data(c, &source_size);
 
        error = awrender_render((const char *)source_data,
                                &info,
                                &matrix,
                                vals,
                                &aw->block,
                                &aw->size,
                                110,    /* fully anti-aliased */
                                0,
                                source_size,
                                aw->render_routine,
                                aw->render_workspace);
 
        if (error) {
                NSLOG(netsurf, INFO, "awrender_render: 0x%x: %s",
                      error->errnum, error->errmess);
                return false;
        }
 
        return true;
}
 
nserror artworks_clone(const struct content *old, struct content **newc)
{
        artworks_content *aw;
        nserror error;
 
        aw = calloc(1, sizeof(artworks_content));
        if (aw == NULL)
                return NSERROR_NOMEM;
 
        error = content__clone(old, &aw->base);
        if (error != NSERROR_OK) {
                content_destroy(&aw->base);
                return error;
        }
 
        /* Simply re-run convert */
        if (old->status == CONTENT_STATUS_READY || 
                        old->status == CONTENT_STATUS_DONE) {
                if (artworks_convert(&aw->base) == false) {
                        content_destroy(&aw->base);
                        return NSERROR_CLONE_FAILED;
                }
        }
 
        *newc = (struct content *) aw;
 
        return NSERROR_OK;
}
 
content_type artworks_content_type(void)
{
        return CONTENT_IMAGE;
}
 
#endif