/*  output.h - Common routines for raster/vector */
/*
    libzint - the open source barcode library
    Copyright (C) 2020-2025 Robin Stuart <rstuart114@gmail.com>

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:

    1. Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.
    2. 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.
    3. Neither the name of the project 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 THE COPYRIGHT OWNER OR CONTRIBUTORS 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.
 */
/* SPDX-License-Identifier: BSD-3-Clause */

#ifndef Z_OUTPUT_H
#define Z_OUTPUT_H

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#include <stdio.h> /* For FILE */

/* EAN/UPC types */
#define OUT_UPCEANFLAG_EAN2     2
#define OUT_UPCEANFLAG_EAN5     5
#define OUT_UPCEANFLAG_UPCE     6
#define OUT_UPCEANFLAG_EAN8     8
#define OUT_UPCEANFLAG_UPCA     12
#define OUT_UPCEANFLAG_EAN13    13

/* Alignment flags `textflags` */
#define OUT_HALIGN_CENTRE       0
#define OUT_HALIGN_LEFT         1
#define OUT_HALIGN_RIGHT        2

/* Check colour options are good (`symbol->fgcolour`, `symbol->bgcolour`) */
INTERNAL int zint_out_check_colour_options(struct zint_symbol *symbol);

/* Return RGB(A) from (well-formed) colour string. Returns 0 if RGB or converted CMYK, 1 if RGBA */
INTERNAL int zint_out_colour_get_rgb(const char *colour, unsigned char *red, unsigned char *green,
                unsigned char *blue, unsigned char *alpha);
/* Return CMYK from (well-formed) colour string. Returns 0 if CMYK, 1 if converted RBG, 2 if converted RGBA */
INTERNAL int zint_out_colour_get_cmyk(const char *colour, int *cyan, int *magenta, int *yellow, int *black,
                unsigned char *rgb_alpha);

/* Convert internal colour chars "WCBMRYGK" to RGB. Returns 1 on success, else 0 */
INTERNAL int zint_out_colour_char_to_rgb(const unsigned char ch, unsigned char *red, unsigned char *green,
                unsigned char *blue);

/* Set left (x), top (y), right and bottom offsets for whitespace, also right quiet zone */
INTERNAL void zint_out_set_whitespace_offsets(const struct zint_symbol *symbol, const int hide_text,
                const int comp_xoffset, float *p_xoffset, float *p_yoffset, float *p_roffset, float *p_boffset,
                float *p_qz_right, const float scaler, int *p_xoffset_si, int *p_yoffset_si, int *p_roffset_si,
                int *p_boffset_si, int *p_qz_right_si);

/* Set composite offset and main width excluding add-on (for start of add-on calc) and add-on text, returning
   EAN/UPC type */
INTERNAL int zint_out_process_upcean(const struct zint_symbol *symbol, const int comp_xoffset, int *p_main_width,
                unsigned char addon[6], int *p_addon_len, int *p_addon_gap);

/* Calculate large bar height i.e. linear bars with zero row height that respond to the symbol height.
   If scaler `si` non-zero (raster), then large_bar_height if non-zero or else row heights will be rounded
   to nearest pixel and symbol height adjusted */
INTERNAL float zint_out_large_bar_height(struct zint_symbol *symbol, const int si, int *row_heights_si,
                int *symbol_height_si);

/* Whether output will be in 8-bit grayscale or not */
INTERNAL int zint_out_grayscale(const struct zint_symbol *symbol);

/* Create output file, creating sub-directories if necessary. Returns `fopen()` FILE pointer */
INTERNAL FILE *zint_out_fopen(char filename[256], const char *mode);

#ifdef _WIN32
/* Do `fopen()` on Windows, assuming `filename` is UTF-8 encoded. Props Marcel, ticket #288 */
INTERNAL FILE *zint_out_win_fopen(const char *filename, const char *mode);
#endif

/* Little-endian output */
#define zint_out_le_u16(b, n) do { \
        unsigned char *bp = (unsigned char *) &(b); \
        uint16_t u16 = (uint16_t) (n); \
        bp[0] = (unsigned char) (u16 & 0xFF); \
        bp[1] = (unsigned char) ((u16 >> 8) & 0xFF); \
    } while (0)

#define zint_out_le_u32(b, n) do { \
        unsigned char *bp = (unsigned char *) &(b); \
        uint32_t u32 = (uint32_t) (n); \
        bp[0] = (unsigned char) (u32 & 0xFF); \
        bp[1] = (unsigned char) ((u32 >> 8) & 0xFF); \
        bp[2] = (unsigned char) ((u32 >> 16) & 0xFF); \
        bp[3] = (unsigned char) ((u32 >> 24) & 0xFF); \
    } while (0)

#define zint_out_le_i32(b, n) do { \
        unsigned char *bp = (unsigned char *) &(b); \
        int32_t i32 = (int32_t) (n); \
        bp[0] = (unsigned char) (i32 & 0xFF); \
        bp[1] = (unsigned char) ((i32 >> 8) & 0xFF); \
        bp[2] = (unsigned char) ((i32 >> 16) & 0xFF); \
        bp[3] = (unsigned char) ((i32 >> 24) & 0xFF); \
    } while (0)

#define zint_out_le_float(b, n) do { \
        unsigned char *bp = (unsigned char *) &(b); \
        float f = (float) (n); \
        uint32_t *p_u32 = (uint32_t *) &f; \
        bp[0] = (unsigned char) (*p_u32 & 0xFF); \
        bp[1] = (unsigned char) ((*p_u32 >> 8) & 0xFF); \
        bp[2] = (unsigned char) ((*p_u32 >> 16) & 0xFF); \
        bp[3] = (unsigned char) ((*p_u32 >> 24) & 0xFF); \
    } while (0)

/* If `#pragma pack()` not supported, try per-type packed attribute */
#ifdef __COMPCERT__
/* Can't use `__attribute__` as may be defined to be no-op by libc if not GNU C or Clang (e.g. glibc does this) */
#  define OUT_PACK __attribute((__packed__)) /* CompCert C workaround extension `__attribute` */
#else
#  define OUT_USE_PRAGMA_PACK
#  define OUT_PACK
#endif

#ifdef __cplusplus
}
#endif /* __cplusplus */

/* vim: set ts=4 sw=4 et : */
#endif /* Z_OUTPUT_H */
