fbgraphics.h

Go to the documentation of this file.

/*
    Copyright (c) 2018, 2019, 2020 Julien Verneuil
    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
        * Redistributions of source code must retain the above copyright
        notice, this list of conditions and the following disclaimer.
        * Redistributions in binary form must reproduce the above copyright
        notice, this list of conditions and the following disclaimer in the
        documentation and/or other materials provided with the distribution.
        * Neither the name of the organization nor the
        names of its contributors may be used to endorse or promote products
        derived from this software without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
    ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL Julien Verneuil BE LIABLE FOR ANY
    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef FB_GRAPHICS_H
#define FB_GRAPHICS_H

    #include <time.h>
    #include <sys/time.h>
    #include <stdint.h>
    #include <math.h>

#ifdef FBG_PARALLEL
    #include <stdatomic.h>
    #include <pthread.h>

// compatibility layer for liblfds 711 version (because 720 was unreleased at the time of writing this)
#ifdef FBG_LFDS
#ifdef LFDS711
    #include "liblfds711.h"

    #define lfds720_freelist_n_element lfds711_freelist_element
    #define lfds720_ringbuffer_n_element lfds711_ringbuffer_element
    #define lfds720_ringbuffer_n_state lfds711_ringbuffer_state
    #define lfds720_freelist_n_state lfds711_freelist_state
    #define LFDS720_PAL_ATOMIC_ISOLATION_LENGTH_IN_BYTES LFDS711_PAL_ATOMIC_ISOLATION_IN_BYTES
    #define lfds720_ringbuffer_n_init_valid_on_current_logical_core lfds711_ringbuffer_init_valid_on_current_logical_core
    #define lfds720_freelist_n_init_valid_on_current_logical_core lfds711_freelist_init_valid_on_current_logical_core
    #define LFDS720_FREELIST_N_SET_VALUE_IN_ELEMENT LFDS711_FREELIST_SET_VALUE_IN_ELEMENT
    #define LFDS720_FREELIST_N_GET_VALUE_FROM_ELEMENT LFDS711_FREELIST_GET_VALUE_FROM_ELEMENT
    #define lfds720_freelist_n_threadsafe_push lfds711_freelist_push
    #define lfds720_freelist_n_threadsafe_pop lfds711_freelist_pop
    #define lfds720_ringbuffer_n_cleanup lfds711_ringbuffer_cleanup
    #define lfds720_freelist_n_cleanup lfds711_freelist_cleanup
    #define lfds720_ringbuffer_n_read lfds711_ringbuffer_read
    #define lfds720_ringbuffer_n_write lfds711_ringbuffer_write
    #define lfds720_misc_flag lfds711_misc_flag
    #define LFDS720_MISC_FLAG_RAISED LFDS711_MISC_FLAG_RAISED
    #define LFDS720_MISC_MAKE_VALID_ON_CURRENT_LOGICAL_CORE_INITS_COMPLETED_BEFORE_NOW_ON_ANY_OTHER_PHYSICAL_CORE LFDS711_MISC_MAKE_VALID_ON_CURRENT_LOGICAL_CORE_INITS_COMPLETED_BEFORE_NOW_ON_ANY_OTHER_LOGICAL_CORE
    #define lfds720_pal_uint_t lfds711_pal_uint_t
#else
    #include "liblfds720.h"
#endif
#endif
#endif

// ### Library structures


    struct _fbg_rgb {
        unsigned char r;
        unsigned char g;
        unsigned char b;
        unsigned char a;
    };


    struct _fbg_hsl {
        int h;
        float s;
        float l;
    };


    struct _fbg_img {
        unsigned char *data;

        unsigned int width;
        unsigned int height;
    };


    struct _fbg_font {
        int *glyph_coord_x;
        int *glyph_coord_y;

        int glyph_width;
        int glyph_height;

        unsigned char first_char;

        struct _fbg_img *bitmap;
    };


    struct _fbg {
        int size;

        unsigned char *disp_buffer;

        unsigned char *back_buffer;
        unsigned char *temp_buffer;

        int allow_resizing;

        int initialize_buffers;


        struct _fbg_rgb fill_color;


        struct _fbg_rgb text_color;


        struct _fbg_rgb text_background;


        unsigned char text_colorkey;


        int text_alpha;


        struct _fbg_font current_font;


        int compositing;

        int width;
        int height;
        int width_n_height;
        int components;
        int comp_offset;
        int line_length;

        int new_width;
        int new_height;

#ifdef FBG_PARALLEL
        atomic_uint_fast16_t fps;
#else
        int16_t fps;
#endif

        char fps_char[10];

        struct timeval fps_start;
        struct timeval fps_stop;

        int frame;

        int bgr;

        void (*backend_resize)(struct _fbg *fbg, unsigned int new_width, unsigned int new_height);
        void (*user_resize)(struct _fbg *fbg, unsigned int new_width, unsigned int new_height);
        void (*user_flip)(struct _fbg *fbg);
        void (*user_draw)(struct _fbg *fbg);
        void (*user_free)(struct _fbg *fbg);
        void *user_context;

        //unsigned char *curr_task_buffer;

#ifdef FBG_PARALLEL
        unsigned int parallel_tasks;

        pthread_t *tasks;

        struct _fbg_fragment **fragments;

        pthread_barrier_t *sync_barrier;

        int task_id;

        atomic_int state;

        unsigned int fragment_queue_size;
#endif
    };

#ifdef FBG_PARALLEL
#ifdef FBG_LFDS

    struct _fbg_freelist_data {
        struct lfds720_freelist_n_element freelist_element;

        unsigned char *buffer;
    };
  #endif


    struct _fbg_fragment {
        atomic_int state;

        struct _fbg *fbg;

#ifdef FBG_LFDS
        struct lfds720_ringbuffer_n_element *ringbuffer_element;
        struct lfds720_ringbuffer_n_state *ringbuffer_state;

        struct lfds720_freelist_n_state *freelist_state;

        struct _fbg_freelist_data *fbg_freelist_data;

        struct _fbg_freelist_data *tmp_fbg_freelist_data; 
#endif

        atomic_int sync_wait;

        void *(*user_fragment_start)(struct _fbg *fbg);
        void (*user_fragment)(struct _fbg *fbg, void *user_data);
        void (*user_fragment_stop)(struct _fbg *fbg, void *user_data);

        void *user_data;
    };
#endif

// ### Library functions


    extern struct _fbg *fbg_customSetup(int width, int height, int components, int initialize_buffers, int allow_resizing, void *user_context, void (*user_draw)(struct _fbg *fbg), void (*user_flip)(struct _fbg *fbg), void (*backend_resize)(struct _fbg *fbg, unsigned int new_width, unsigned int new_height), void (*user_free)(struct _fbg *fbg));


    extern void fbg_close(struct _fbg *fbg);


    void fbg_setResizeCallback(struct _fbg *fbg, void (*user_resize)(struct _fbg *fbg, unsigned int new_width, unsigned int new_height));


    extern void fbg_resize(struct _fbg *fbg, int new_width, int new_height);


    extern void fbg_pushResize(struct _fbg *fbg, int new_width, int new_height);


    extern void fbg_fadeDown(struct _fbg *fbg, unsigned char rgb_fade_amount);


    extern void fbg_fadeUp(struct _fbg *fbg, unsigned char rgb_fade_amount);


    extern void fbg_clear(struct _fbg *fbg, unsigned char brightness);


    extern void fbg_fill(struct _fbg *fbg, unsigned char r, unsigned char g, unsigned char b);


    extern void fbg_getPixel(struct _fbg *fbg, int x, int y, struct _fbg_rgb *color);


    extern void fbg_pixel(struct _fbg *fbg, int x, int y, unsigned char r, unsigned char g, unsigned char b);


    extern void fbg_pixela(struct _fbg *fbg, int x, int y, unsigned char r, unsigned char g, unsigned char b, unsigned char a);


    extern void fbg_fpixel(struct _fbg *fbg, int x, int y);


    extern void fbg_plot(struct _fbg *fbg, int index, unsigned char value);


    extern void fbg_rect(struct _fbg *fbg, int x, int y, int w, int h, unsigned char r, unsigned char g, unsigned char b);


    extern void fbg_recta(struct _fbg *fbg, int x, int y, int w, int h, unsigned char r, unsigned char g, unsigned char b, unsigned char a);


    extern void fbg_frect(struct _fbg *fbg, int x, int y, int w, int h);


    extern void fbg_hline(struct _fbg *fbg, int x, int y, int w, unsigned char r, unsigned char g, unsigned char b);


    extern void fbg_vline(struct _fbg *fbg, int x, int y, int h, unsigned char r, unsigned char g, unsigned char b);


    extern void fbg_line(struct _fbg *fbg, int x1, int y1, int x2, int y2, unsigned char r, unsigned char g, unsigned char b);


    extern void fbg_polygon(struct _fbg *fbg, int num_vertices, int *vertices, unsigned char r, unsigned char g, unsigned char b);


    extern void fbg_background(struct _fbg *fbg, unsigned char r, unsigned char g, unsigned char b);


    extern void fbg_hslToRGB(struct _fbg_rgb *color, float h, float s, float l);


    extern void fbg_rgbToHsl(struct _fbg_hsl *color, float r, float g, float b);

#ifdef FBG_PARALLEL

    extern void fbg_draw(struct _fbg *fbg, void (*user_mixing)(struct _fbg *fbg, unsigned char *buffer, int task_id));
#else

    extern void fbg_draw(struct _fbg *fbg);
#endif


    extern void fbg_flip(struct _fbg *fbg);


    extern struct _fbg_img *fbg_createImage(struct _fbg *fbg, unsigned int width, unsigned int height);


#ifndef WITHOUT_PNG
    extern struct _fbg_img *fbg_loadPNG(struct _fbg *fbg, const char *filename);
#endif


#ifndef WITHOUT_JPEG
    extern struct _fbg_img *fbg_loadJPEG(struct _fbg *fbg, const char *filename);
#endif


    extern struct _fbg_img *fbg_loadImage(struct _fbg *fbg, const char *filename);


    extern void fbg_image(struct _fbg *fbg, struct _fbg_img *img, int x, int y);


    extern void fbg_imageColorkey(struct _fbg *fbg, struct _fbg_img *img, int x, int y, int cr, int cg, int cb);


    extern void fbg_imageClip(struct _fbg *fbg, struct _fbg_img *img, int x, int y, int cx, int cy, int cw, int ch);


    extern void fbg_imageFlip(struct _fbg_img *img);


    extern void fbg_imageEx(struct _fbg *fbg, struct _fbg_img *img, int x, int y, float sx, float sy, int cx, int cy, int cw, int ch);


    extern void fbg_freeImage(struct _fbg_img *img);


    extern struct _fbg_font *fbg_createFont(struct _fbg *fbg, struct _fbg_img *img, int glyph_width, int glyph_height, unsigned char first_char);


    extern void fbg_textFont(struct _fbg *fbg, struct _fbg_font *font);


    extern void fbg_textColor(struct _fbg *fbg, unsigned char r, unsigned char g, unsigned char b);


    extern void fbg_textBackground(struct _fbg *fbg, int r, int g, int b, int a);


    extern void fbg_textColorKey(struct _fbg *fbg, unsigned char v);


    extern void fbg_text(struct _fbg *fbg, struct _fbg_font *fnt, char *text, int x, int y, int r, int g, int b);


    extern void fbg_freeFont(struct _fbg_font *font);


    extern void fbg_drawFramerate(struct _fbg *fbg, struct _fbg_font *fnt, int task, int x, int y, int r, int g, int b);


    extern int fbg_getFramerate(struct _fbg *fbg, int task);


    extern void fbg_drawInto(struct _fbg *fbg, unsigned char *buffer);


    extern float fbg_randf(float min, float max);

#ifdef FBG_PARALLEL

    extern void fbg_createFragment(struct _fbg *fbg, void *(*fragment_start)(struct _fbg *fbg), void (*fragment)(struct _fbg *fbg, void *user_data), void (*fragment_stop)(struct _fbg *fbg, void *user_data), unsigned int parallel_tasks);
#endif

// ### Helper functions

    #define fbg_fade(fbg, fade_amount) fbg_fadeDown(fbg, fade_amount)


    #define fbg_write(fbg, text, x, y) fbg_text(fbg, &fbg->current_font, text, x, y, fbg->text_color.r, fbg->text_color.g, fbg->text_color.b)


    #define fbg_imageScale(fbg, img, x, y, sx, sy) fbg_imageEx(fbg, img, x, y, sx, sy, 0, 0, img->width, img->height)

    #define _FBG_MAX(a,b) ((a) > (b) ? a : b)
    #define _FBG_MIN(a,b) ((a) < (b) ? a : b)
    #define _FBG_SGN(x) ((x<0)?-1:((x>0)?1:0))

    #define _FBG_DEGTORAD(angle_degree) ((angle_degree) * M_PI / 180.0)
    #define _FBG_RADTODEG(angle_radians) ((angle_radians) * 180.0 / M_PI)

    #define _FBG_SOURCE_OVER(a,b,c) (c * a + b * (1.f - a))
#endif