From c73c5ba7f5fcd78fc68417f500dbfac0f228f52a Mon Sep 17 00:00:00 2001 From: untir_l <87096069+untir-l@users.noreply.github.com> Date: Fri, 18 Feb 2022 15:45:06 +0530 Subject: Initial commit --- .gitmodules | 3 ++ Makefile | 21 ++++++++ README.md | 25 +++++++++ getopt | 1 + hitomezashi.c | 85 +++++++++++++++++++++++++++++ hitomezashi.h | 46 ++++++++++++++++ hitomezashi_cli.c | 158 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ hitomezashi_cli.h | 20 +++++++ 8 files changed, 359 insertions(+) create mode 100644 .gitmodules create mode 100644 Makefile create mode 100644 README.md create mode 160000 getopt create mode 100644 hitomezashi.c create mode 100644 hitomezashi.h create mode 100644 hitomezashi_cli.c create mode 100644 hitomezashi_cli.h diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..0aa3466 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "getopt"] + path = getopt + url = https://github.com/skeeto/getopt.git diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..0bdde87 --- /dev/null +++ b/Makefile @@ -0,0 +1,21 @@ +.POSIX: + +CC = gcc +CFLAGS = -std=c11 -Wall -Wpedantic -O3 `sdl2-config --cflags` +LDLIBS = `sdl2-config --libs` +AR = ar +ARFLAGS = rcs + +all: libhitomezashi.a hitomezashi_cli + +libhitomezashi.a: hitomezashi.o + $(AR) $(ARFLAGS) libhitomezashi.a hitomezashi.o + +hitomezashi.o: hitomezashi.c hitomezashi.h + +hitomezashi_cli: hitomezashi_cli.o libhitomezashi.a + +hitomezashi_cli.o: hitomezashi_cli.c hitomezashi_cli.h + +clean: + rm -f *.a *.o hitomezashi_cli diff --git a/README.md b/README.md new file mode 100644 index 0000000..2d0b4df --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Hitomezashi + +Library and CLI app to generate hitomezashi patterns like the following: + +*pending addition of image* + +Inspired by [Numberphile's video](https://www.youtube.com/watch?v=JbfhzlMk2eY) on hitomezashi stitch patterns. + +Written in C11 with SDL2. + +## Usage + +`hitomezashi.c` and `hitomezashi.h` are the library portion; running `make` will build `libhitomezashi.a` from these. See `hitomezashi_cli.c` for an example of how to use it (all relevant code is in `main()`; most of the rest of the file is cumbersome argument parsing). + +`hitomezashi_cli.c` and corresponding header file are the CLI app. `make` will build it; run `./hitomezashi_cli -h` for help. + +Output of the CLI app is a BMP image; you can convert it to something nicer like a PNG with ffmpeg or similar. + +Additionally, the output is black and white - you can replace these colours using your tool of choice if desired. + +## Todos/potential future additions +- Add documentation using Doxygen to both the library and CLI app +- Implement nicer argument parsing (I hear there are some nice Rust libraries for this; maybe rewrite the CLI app in that?) +- Add support for output to PNG/other formats to the CLI app +- Add support for choosing foreground and background colours diff --git a/getopt b/getopt new file mode 160000 index 0000000..55d8fef --- /dev/null +++ b/getopt @@ -0,0 +1 @@ +Subproject commit 55d8fefe680d9b7e68ab80eb46e1bd4ad324fc29 diff --git a/hitomezashi.c b/hitomezashi.c new file mode 100644 index 0000000..c1c581e --- /dev/null +++ b/hitomezashi.c @@ -0,0 +1,85 @@ +#include "hitomezashi.h" +#include "SDL.h" +#include + +SDL_Color HITOMEZASHI_FG_COLOUR = { .r = 0, .g = 0, .b = 0 }; +SDL_Color HITOMEZASHI_BG_COLOUR = { .r = 255, .g = 255, .b = 255 }; + +enum Hitomezashi_State_Init_Result +hitomezashi_state_init( + struct Hitomezashi_State *state, + int x_pattern_len, int y_pattern_len, + char *x_pattern, char *y_pattern, + int gap, int line_thickness) { + assert(x_pattern_len >= 0); + assert(y_pattern_len >= 0); + assert(gap >= 0); + assert(line_thickness > 0); + + state->y_pattern_len = y_pattern_len; + state->x_pattern_len = x_pattern_len; + state->x_pattern = x_pattern; + state->y_pattern = y_pattern; + state->gap = gap; + state->line_thickness = line_thickness; + state->output_width = x_pattern_len * gap; + state->output_height = y_pattern_len * gap; + + state->surface = SDL_CreateRGBSurface(0, state->output_width, state->output_height, 32, 0, 0, 0, 0); + if (!state->surface) { + return Hitomezashi_State_Init_Result_Err_Create_Surface; + } + return Hitomezashi_State_Init_Result_Success; +} + +enum Hitomezashi_Draw_Result +hitomezashi_draw(struct Hitomezashi_State *state) { + if (SDL_LockSurface(state->surface) != 0) { + return Hitomezashi_Draw_Result_Err_Lock_Surface; + } + + Uint32 bg_colour = SDL_MapRGB(state->surface->format, HITOMEZASHI_BG_COLOUR.r, HITOMEZASHI_BG_COLOUR.g, HITOMEZASHI_BG_COLOUR.b); + Uint32 fg_colour = SDL_MapRGB(state->surface->format, HITOMEZASHI_FG_COLOUR.r, HITOMEZASHI_FG_COLOUR.g, HITOMEZASHI_FG_COLOUR.b); + + SDL_FillRect(state->surface, NULL, bg_colour); + + SDL_Rect rect; + // Draw y pattern (horizontal) lines + for (int i = 0; i < state->y_pattern_len; ++i) { + for (int j = 0; j < state->x_pattern_len; ++j) { + if (j % 2 == state->y_pattern[i]) { + rect.x = j * state->gap; + rect.y = i * state->gap; + rect.w = state->gap; + rect.h = state->line_thickness; + SDL_FillRect(state->surface, &rect, fg_colour); + } + } + } + // Draw x pattern (vertical) lines + for (int i = 0; i < state->x_pattern_len; ++i) { + for (int j = 0; j < state->y_pattern_len; ++j) { + if (j % 2 == state->x_pattern[i]) { + rect.x = i * state->gap; + rect.y = j * state->gap; + rect.w = state->line_thickness; + rect.h = state->gap; + SDL_FillRect(state->surface, &rect, fg_colour); + } + } + } + // Join up the lines to avoid leaving holes at the intersections + for (int x = state->gap; x < state->output_width; x += state->gap) { + for (int y = state->gap; y < state->output_height; y += state->gap) { + rect.x = x; + rect.y = y; + rect.w = state->line_thickness; + rect.h = state->line_thickness; + SDL_FillRect(state->surface, &rect, fg_colour); + + } + } + + SDL_UnlockSurface(state->surface); + return Hitomezashi_Draw_Result_Success; +} diff --git a/hitomezashi.h b/hitomezashi.h new file mode 100644 index 0000000..acd8ab9 --- /dev/null +++ b/hitomezashi.h @@ -0,0 +1,46 @@ +#ifndef HITOMEZASHI_HITOMEZASHI_H +#define HITOMEZASHI_HITOMEZASHI_H + +#include "SDL.h" + +struct Hitomezashi_State { + int x_pattern_len; + int y_pattern_len; + + char *x_pattern; + char *y_pattern; + + int gap; + + int line_thickness; + + int output_width; + int output_height; + + SDL_Surface *surface; +}; + +enum Hitomezashi_State_Init_Result { + Hitomezashi_State_Init_Result_Success, + Hitomezashi_State_Init_Result_Err_Create_Surface, +}; + + +enum Hitomezashi_Draw_Result { + Hitomezashi_Draw_Result_Success, + Hitomezashi_Draw_Result_Err_Lock_Surface, +}; + + +enum Hitomezashi_State_Init_Result +hitomezashi_state_init( + struct Hitomezashi_State *state, + int x_pattern_len, int y_pattern_len, + char *x_pattern, char *y_pattern, + int gap, int line_thickness); + + +enum Hitomezashi_Draw_Result +hitomezashi_draw(struct Hitomezashi_State *state); + +#endif // HITOMEZASHI_HITOMEZASHI_H diff --git a/hitomezashi_cli.c b/hitomezashi_cli.c new file mode 100644 index 0000000..24f488f --- /dev/null +++ b/hitomezashi_cli.c @@ -0,0 +1,158 @@ +#include "hitomezashi_cli.h" +#include "hitomezashi.h" +#include "getopt/xgetopt.h" +#include "SDL.h" +#include +#include +#include +#include +#include + +int main(int argc, char **argv) { + if (SDL_Init(SDL_INIT_VIDEO) != 0) { + SDL_LogCritical(SDL_LOG_CATEGORY_ERROR, "Failed to initialise SDL: %s", SDL_GetError()); + return Hitomezashi_Cli_Exit_Code_Err_Sdl_Init; + } + + char *out_file_path; + int x_pattern_len; + int y_pattern_len; + char *x_pattern; + char *y_pattern; + int gap; + int thickness; + hitomezashi_cli_handle_args(&out_file_path, &x_pattern_len, &y_pattern_len, &x_pattern, &y_pattern, &gap, &thickness, argc, argv); + + struct Hitomezashi_State state; + if (hitomezashi_state_init(&state, x_pattern_len, y_pattern_len, x_pattern, y_pattern, gap, thickness) != 0) { + return Hitomezashi_Cli_Exit_Code_Err_State_Init; + } + + hitomezashi_draw(&state); + + if (SDL_SaveBMP(state.surface, out_file_path) != 0) { + SDL_LogCritical(SDL_LOG_CATEGORY_ERROR, "Failed to save image"); + return Hitomezashi_Cli_Exit_Code_Err_Save_Image; + } + + SDL_FreeSurface(state.surface); + free(state.x_pattern); + free(state.y_pattern); + + SDL_Quit(); +} + +// Attempts to prints help. Exits 0 on success, 2 on failure. +void hitomezashi_cli_help(void) { + if (puts( + "hitomezashi_cli - generate hitomezashi patterns\n" + "Options:\n" + "-o - specify the output image (BMP) path\n" + "-x - specify the x pattern as a string of zeroes and ones (eg. 0101)\n" + "-y - specify the y pattern, as with -x\n" + "-g - specify the gap between lines as an integer\n" + "-t - specify the line thickness as an integer\n" + "-h - print this help and exit" + ) < 0) { + exit(Hitomezashi_Cli_Exit_Code_Err_Print_Help); + } + exit(Hitomezashi_Cli_Exit_Code_Success); +} + +char *hitomezashi_cli_ascii_binary_str_to_ints(char *ascii_str, size_t n) { + char *res = malloc(n); + for (int i = 0; i < n; ++i) { + switch(ascii_str[i]) { + case '0':; + res[i] = 0; + break; + case '1':; + res[i] = 1; + break; + default:; + free(res); + printf("%d\n", ascii_str[i]); + return NULL; + } + } + return res; +} + +// Parses arguments with xgetopt, ensures they are valid, initialises various variables based on them. +// Prints and exits if it encounters an error. +void hitomezashi_cli_handle_args(char **out_file_path, int *x_pattern_len, int *y_pattern_len, char **x_pattern, char **y_pattern, int *gap, int *thickness, int argc, char **argv) { + bool out_file_path_specified = false; + bool x_pattern_specified = false; + bool y_pattern_specified = false; + bool gap_specified = false; + bool thickness_specified = false; + + struct xgetopt xgetopt_state = XGETOPT_INIT; + int option; + while ((option = xgetopt(&xgetopt_state, argc, argv, "o:x:y:g:t:h") != -1)) { + switch (xgetopt_state.optopt) { + case 'o':; + *out_file_path = xgetopt_state.optarg; + out_file_path_specified = true; + break; + case 'x':; + size_t x_pattern_len_l = strlen(xgetopt_state.optarg); + if (x_pattern_len_l >= INT_MAX) { + SDL_LogCritical(SDL_LOG_CATEGORY_ERROR, "X pattern length must be shorter than %d", INT_MAX); + exit(Hitomezashi_Cli_Exit_Code_Err_Handle_Args); + } + *x_pattern_len = x_pattern_len_l; + *x_pattern = hitomezashi_cli_ascii_binary_str_to_ints(xgetopt_state.optarg, *x_pattern_len); + if (!*x_pattern) { + SDL_LogCritical(SDL_LOG_CATEGORY_ERROR, "Invalid x pattern; see -h"); + exit(Hitomezashi_Cli_Exit_Code_Err_Handle_Args); + } + x_pattern_specified = true; + break; + case 'y':; + size_t y_pattern_len_l = strlen(xgetopt_state.optarg); + if (y_pattern_len_l >= INT_MAX) { + SDL_LogCritical(SDL_LOG_CATEGORY_ERROR, "Y pattern length must be shorter than %d", INT_MAX); + exit(Hitomezashi_Cli_Exit_Code_Err_Handle_Args); + } + *y_pattern_len = y_pattern_len_l; + *y_pattern = hitomezashi_cli_ascii_binary_str_to_ints(xgetopt_state.optarg, *y_pattern_len); + if (!*y_pattern) { + SDL_LogCritical(SDL_LOG_CATEGORY_ERROR, "Invalid y pattern; see -h"); + exit(Hitomezashi_Cli_Exit_Code_Err_Handle_Args); + } + y_pattern_specified = true; + break; + case 'g':; + long gap_l = strtol(xgetopt_state.optarg, NULL, 0); + if (gap_l >= INT_MAX) { + SDL_LogCritical(SDL_LOG_CATEGORY_ERROR, "Value for gap must be less than %d", INT_MAX); + exit(Hitomezashi_Cli_Exit_Code_Err_Handle_Args); + } + *gap = gap_l; + gap_specified = true; + break; + case 't':; + long thickness_l = strtol(xgetopt_state.optarg, NULL, 0); + if (thickness_l >= INT_MAX) { + SDL_LogCritical(SDL_LOG_CATEGORY_ERROR, "Value for line thickness must be less than %d", INT_MAX); + exit(Hitomezashi_Cli_Exit_Code_Err_Handle_Args); + } + *thickness = thickness_l; + thickness_specified = true; + break; + case 'h':; + hitomezashi_cli_help(); + break; + default:; + SDL_LogCritical(SDL_LOG_CATEGORY_ERROR, "Invalid argument: run with -h for help"); + exit(Hitomezashi_Cli_Exit_Code_Err_Handle_Args); + } + } + if (!(out_file_path_specified && x_pattern_specified && y_pattern_specified && gap_specified && thickness_specified)) { + SDL_LogCritical(SDL_LOG_CATEGORY_ERROR, "-o, -x, -y, -g, -t *must* be specified; run with -h for help"); + exit(Hitomezashi_Cli_Exit_Code_Err_Handle_Args); + } +} + + diff --git a/hitomezashi_cli.h b/hitomezashi_cli.h new file mode 100644 index 0000000..0147e41 --- /dev/null +++ b/hitomezashi_cli.h @@ -0,0 +1,20 @@ +#ifndef HITOMEZASHI_CLI_H +#define HITOMEZASHI_CLI_H + +#include + +enum Hitomezashi_Cli_Exit_Code { + Hitomezashi_Cli_Exit_Code_Success = 0, + Hitomezashi_Cli_Exit_Code_Err_Handle_Args = 1, + Hitomezashi_Cli_Exit_Code_Err_Print_Help = 2, + Hitomezashi_Cli_Exit_Code_Err_Sdl_Init = 3, + Hitomezashi_Cli_Exit_Code_Err_State_Init = 4, + Hitomezashi_Cli_Exit_Code_Err_Save_Image = 5, +}; + +void hitomezashi_cli_handle_args(char **out_file_path, int *x_pattern_len, int *y_pattern_len, char **x_pattern, char **y_pattern, int *gap, int *thickness, int argc, char **argv); +void hitomezashi_cli_help(void); +char *hitomezashi_cli_ascii_binary_str_to_ints(char *ascii_str, size_t n); + + +#endif // HITOMEZASHI_CLI_H -- cgit v1.2.3-57-g22cb