diff --git a/README.md b/README.md index 4788c75..fa0a49b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ # servicepoint_binding_c +[![Release](https://git.berlin.ccc.de/servicepoint/servicepoint_binding_c/badges/release.svg)](https://git.berlin.ccc.de/servicepoint/servicepoint_binding_c/releases) [![crates.io](https://img.shields.io/crates/v/servicepoint_binding_c.svg)](https://crates.io/crates/servicepoint) [![Crates.io Total Downloads](https://img.shields.io/crates/d/servicepoint_binding_c)](https://crates.io/crates/servicepoint) [![docs.rs](https://img.shields.io/docsrs/servicepoint_binding_c)](https://docs.rs/servicepoint/latest/servicepoint/) [![GPLv3 licensed](https://img.shields.io/crates/l/servicepoint_binding_c)](./LICENSE) +[![CI](https://git.berlin.ccc.de/servicepoint/servicepoint_binding_c/badges/workflows/rust.yml/badge.svg)](https://git.berlin.ccc.de/servicepoint/servicepoint_binding_c) In [CCCB](https://berlin.ccc.de/), there is a big pixel matrix hanging on the wall. It is called "Service Point Display" or "Airport Display". @@ -12,7 +14,7 @@ This crate contains C bindings for the [servicepoint](https://git.berlin.ccc.de/ ## Examples -```c++ +```c #include #include "servicepoint.h" diff --git a/cbindgen.toml b/cbindgen.toml index 221e915..7841755 100644 --- a/cbindgen.toml +++ b/cbindgen.toml @@ -32,11 +32,11 @@ features = ["full"] [export] include = [] -exclude = [] +exclude = ["BitVec"] [export.rename] -"SpBitVec" = "BitVec" -"SpByteSlice" = "ByteSlice" +"SPCommand" = "Command" +"DisplayBitVec" = "BitVec" [enum] rename_variants = "QualifiedScreamingSnakeCase" diff --git a/example/src/brightness_tester.c b/example/src/brightness_tester.c index c3e42ba..21d814d 100644 --- a/example/src/brightness_tester.c +++ b/example/src/brightness_tester.c @@ -1,30 +1,44 @@ #include "servicepoint.h" -int main(void) { - UdpSocket *connection = sp_udp_open_ipv4(172, 23, 42, 29, 2342); - //UdpSocket *connection = sp_udp_open_ipv4(127, 0, 0, 1, 2342); - if (connection == NULL) - return -1; +static UdpSocket *connection = NULL; +void enable_all_pixels(void) { Bitmap *all_on = sp_bitmap_new_max_sized(); sp_bitmap_fill(all_on, true); - Packet *packet = sp_bitmap_into_packet(all_on, 0, 0, COMPRESSION_CODE_UNCOMPRESSED); - if (packet == NULL) - return -1; - - sp_udp_send_packet(connection, packet); - - BrightnessGrid *grid = sp_brightness_grid_new(TILE_WIDTH, TILE_HEIGHT); + BitmapCommand *bitmapCommand = sp_cmd_bitmap_from_bitmap(all_on); + Packet *packet = sp_cmd_bitmap_try_into_packet(bitmapCommand); + if (packet != NULL) + sp_udp_send_packet(connection, packet); +} +void make_brightness_pattern(BrightnessGrid *grid) { ByteSlice slice = sp_brightness_grid_unsafe_data_ref(grid); for (size_t index = 0; index < slice.length; index++) { slice.start[index] = (uint8_t) (index % ((size_t) Brightness_MAX)); } +} - packet = sp_brightness_grid_into_packet(grid, 0, 0); - sp_udp_send_packet(connection, packet); - +void run_at_exit() { sp_udp_free(connection); +} + +int main(void) { + //UdpSocket *connection = sp_udp_open_ipv4(172, 23, 42, 29, 2342); + connection = sp_udp_open_ipv4(127, 0, 0, 1, 2342); + if (connection == NULL) + return -1; + atexit(run_at_exit); + + enable_all_pixels(); + + BrightnessGrid *grid = sp_brightness_grid_new(TILE_WIDTH, TILE_HEIGHT); + make_brightness_pattern(grid); + + Packet *packet = sp_cmd_brightness_grid_into_packet(sp_cmd_brightness_grid_from_grid(grid)); + if (packet == NULL) + return -2; + + sp_udp_send_packet(connection, packet); return 0; } diff --git a/include/servicepoint.h b/include/servicepoint.h index 5863ef5..d5b0199 100644 --- a/include/servicepoint.h +++ b/include/servicepoint.h @@ -125,6 +125,32 @@ enum CommandCode typedef uint16_t CommandCode; #endif // __cplusplus +/** + * Specifies the kind of command struct. + * + * This is _not_ equivalent to the [servicepoint::CommandCode]s. + */ +enum CommandTag +#ifdef __cplusplus + : uint8_t +#endif // __cplusplus + { + COMMAND_TAG_INVALID = 0, + COMMAND_TAG_BITMAP, + COMMAND_TAG_BIT_VEC, + COMMAND_TAG_BRIGHTNESS_GRID, + COMMAND_TAG_CHAR_GRID, + COMMAND_TAG_CP437_GRID, + COMMAND_TAG_GLOBAL_BRIGHTNESS, + COMMAND_TAG_CLEAR, + COMMAND_TAG_HARD_RESET, + COMMAND_TAG_FADE_OUT, + COMMAND_TAG_BITMAP_LEGACY, +}; +#ifndef __cplusplus +typedef uint8_t CommandTag; +#endif // __cplusplus + /** * Specifies the kind of compression to use. Availability depends on features. * @@ -179,6 +205,22 @@ enum CompressionCode typedef uint16_t CompressionCode; #endif // __cplusplus +/** + * Set pixel data starting at the pixel offset on screen. + * + * The screen will continuously overwrite more pixel data without regarding the offset, meaning + * once the starting row is full, overwriting will continue on column 0. + * + * The [`BinaryOperation`] will be applied on the display comparing old and sent bit. + * + * `new_bit = old_bit op sent_bit` + * + * For example, [`BinaryOperation::Or`] can be used to turn on some pixels without affecting other pixels. + * + * The contained [`DisplayBitVec`] is always uncompressed. + */ +typedef struct BitVecCommand BitVecCommand; + /** * A fixed-size 2D grid of booleans. * @@ -196,6 +238,160 @@ typedef uint16_t CompressionCode; */ typedef struct Bitmap Bitmap; +/** + * Overwrites a rectangular region of pixels. + * + * Origin coordinates must be divisible by 8. + * + * # Examples + * + * ```rust + * # use servicepoint::*; + * # let connection = FakeConnection; + * # + * let mut bitmap = Bitmap::max_sized(); + * // draw something to the pixels here + * # bitmap.set(2, 5, true); + * + * // create command to send pixels + * let command = BitmapCommand { + * bitmap, + * origin: Origin::ZERO, + * compression: CompressionCode::Uncompressed + * }; + * + * connection.send_command(command).expect("send failed"); + * ``` + */ +typedef struct BitmapCommand BitmapCommand; + +/** + * Legacy command code, gets ignored by the real display. + * + * Might be useful as a noop package. + * + * # Examples + * + * ```rust + * # use servicepoint::*; + * # let connection = FakeConnection; + * // this sends a packet that does nothing + * # #[allow(deprecated)] + * connection.send_command(BitmapLegacyCommand).unwrap(); + * ``` + */ +typedef struct BitmapLegacyCommand BitmapLegacyCommand; + +/** + * Set the brightness of individual tiles in a rectangular area of the display. + */ +typedef struct BrightnessGridCommand BrightnessGridCommand; + +/** + * Show text on the screen. + * + * The text is sent in the form of a 2D grid of UTF-8 encoded characters (the default encoding in rust). + * + * # Examples + * + * ```rust + * # use servicepoint::*; + * # let connection = FakeConnection; + * let grid = CharGrid::from("Hello,\nWorld!"); + * connection.send_command(CharGridCommand { origin: Origin::ZERO, grid }).expect("send failed"); + * ``` + */ +typedef struct CharGridCommand CharGridCommand; + +/** + * Set all pixels to the off state. Does not affect brightness. + * + * # Examples + * + * ```rust + * # use servicepoint::*; + * # let connection = FakeConnection; + * connection.send_command(ClearCommand).unwrap(); + * ``` + */ +typedef struct ClearCommand ClearCommand; + +/** + * Show text on the screen. + * + * The text is sent in the form of a 2D grid of [CP-437] encoded characters. + * + *
You probably want to use [Command::Utf8Data] instead
+ * + * # Examples + * + * ```rust + * # use servicepoint::*; + * # let connection = FakeConnection; + * let grid = CharGrid::from("Hello,\nWorld!"); + * let grid = Cp437Grid::from(&grid); + * connection.send_command(Cp437GridCommand{ origin: Origin::ZERO, grid }).expect("send failed"); + * ``` + * + * ```rust + * # use servicepoint::*; + * # let connection = FakeConnection; + * let grid = Cp437Grid::load_ascii("Hello\nWorld", 5, false).unwrap(); + * connection.send_command(Cp437GridCommand{ origin: Origin::new(2, 2), grid }).unwrap(); + * ``` + * [CP-437]: https://en.wikipedia.org/wiki/Code_page_437 + */ +typedef struct Cp437GridCommand Cp437GridCommand; + +/** + * This is a type only used by cbindgen to have a type for pointers. + */ +typedef struct BitVec BitVec; + +/** + *
Untested
+ * + * Slowly decrease brightness until off or something like that? + * + * # Examples + * + * ```rust + * # use servicepoint::*; + * # let connection = FakeConnection; + * connection.send_command(FadeOutCommand).unwrap(); + * ``` + */ +typedef struct FadeOutCommand FadeOutCommand; + +/** + * Set the brightness of all tiles to the same value. + * + * # Examples + * + * ```rust + * # use servicepoint::*; + * # let connection = FakeConnection; + * let command = GlobalBrightnessCommand { brightness: Brightness::MAX }; + * connection.send_command(command).unwrap(); + * ``` + */ +typedef struct GlobalBrightnessCommand GlobalBrightnessCommand; + +/** + * Kills the udp daemon on the display, which usually results in a restart. + * + * Please do not send this in your normal program flow. + * + * # Examples + * + * ```rust + * # use servicepoint::*; + * # let connection = FakeConnection; + * connection.send_command(HardResetCommand).unwrap(); + * ``` + */ +typedef struct HardResetCommand HardResetCommand; + /** * The raw packet. * @@ -205,26 +401,6 @@ typedef struct Bitmap Bitmap; */ typedef struct Packet Packet; -/** - * A vector of bits - * - * # Examples - * ```C - * SPBitVec vec = sp_bitvec_new(8); - * sp_bitvec_set(vec, 5, true); - * sp_bitvec_free(vec); - * ``` - */ -typedef struct SPBitVec SPBitVec; - -/** - * This enum contains all commands provided by the library. - * This is useful in case you want one data type for all kinds of commands without using `dyn`. - * - * Please look at the contained structs for documentation per command. - */ -typedef struct TypedCommand TypedCommand; - /** * This is a type only used by cbindgen to have a type for pointers. */ @@ -348,6 +524,11 @@ typedef uint8_t Brightness; */ typedef ValueGrid_char CharGrid; +/** + * Type alias for documenting the meaning of the u16 in enum values + */ +typedef size_t Offset; + /** * A grid containing codepage 437 characters. * @@ -355,6 +536,41 @@ typedef ValueGrid_char CharGrid; */ typedef ValueGrid_u8 Cp437Grid; +/** + * Pointer to one of the available command structs. + */ +typedef union { + uint8_t *null; + BitmapCommand */*notnull*/ bitmap; + BitVecCommand */*notnull*/ bitvec; + BrightnessGridCommand */*notnull*/ brightness_grid; + CharGridCommand */*notnull*/ char_grid; + Cp437GridCommand */*notnull*/ cp437_grid; + GlobalBrightnessCommand */*notnull*/ global_brightness; + ClearCommand */*notnull*/ clear; + BitmapLegacyCommand */*notnull*/ bitmap_legacy; + HardResetCommand */*notnull*/ hard_reset; + FadeOutCommand */*notnull*/ fade_out; +} CommandUnion; + +/** + * This struct represents a pointer to one of the possible command structs. + * + * Only ever access `data` with the correct data type as specified by `tag`! + * + * Rust equivalent: [TypedCommand]. + */ +typedef struct { + /** + * Specifies which kind of command struct is contained in `data` + */ + CommandTag tag; + /** + * The pointer to the command struct + */ + CommandUnion data; +} Command; + /** * A raw header. * @@ -421,7 +637,7 @@ void sp_bitmap_free(Bitmap */*notnull*/ bitmap); * * Returns NULL in case of error. */ -Bitmap *sp_bitmap_from_bitvec(size_t width, SPBitVec */*notnull*/ bitvec); +Bitmap *sp_bitmap_from_bitvec(size_t width, BitVec */*notnull*/ bitvec); /** * Gets the current value at the specified position in the [Bitmap]. @@ -449,7 +665,7 @@ size_t sp_bitmap_height(Bitmap */*notnull*/ bitmap); /** * Consumes the Bitmap and returns the contained BitVec */ -SPBitVec */*notnull*/ sp_bitmap_into_bitvec(Bitmap */*notnull*/ bitmap); +BitVec */*notnull*/ sp_bitmap_into_bitvec(Bitmap */*notnull*/ bitmap); /** * Creates a [BitmapCommand] and immediately turns that into a [Packet]. @@ -553,27 +769,27 @@ ByteSlice sp_bitmap_unsafe_data_ref(Bitmap */*notnull*/ bitmap); size_t sp_bitmap_width(Bitmap */*notnull*/ bitmap); /** - * Clones a [SPBitVec]. + * Clones a [DisplayBitVec]. */ -SPBitVec */*notnull*/ sp_bitvec_clone(SPBitVec */*notnull*/ bit_vec); +BitVec */*notnull*/ sp_bitvec_clone(BitVec */*notnull*/ bit_vec); /** - * Sets the value of all bits in the [SPBitVec]. + * Sets the value of all bits in the [DisplayBitVec]. * * # Arguments * * - `bit_vec`: instance to write to * - `value`: the value to set all bits to */ -void sp_bitvec_fill(SPBitVec */*notnull*/ bit_vec, bool value); +void sp_bitvec_fill(BitVec */*notnull*/ bit_vec, bool value); /** - * Deallocates a [SPBitVec]. + * Deallocates a [DisplayBitVec]. */ -void sp_bitvec_free(SPBitVec */*notnull*/ bit_vec); +void sp_bitvec_free(BitVec */*notnull*/ bit_vec); /** - * Gets the value of a bit from the [SPBitVec]. + * Gets the value of a bit from the [DisplayBitVec]. * * # Arguments * @@ -586,16 +802,16 @@ void sp_bitvec_free(SPBitVec */*notnull*/ bit_vec); * * - when accessing `index` out of bounds */ -bool sp_bitvec_get(SPBitVec */*notnull*/ bit_vec, size_t index); +bool sp_bitvec_get(BitVec */*notnull*/ bit_vec, size_t index); /** * Creates a [BitVecCommand] and immediately turns that into a [Packet]. * - * The provided [SPBitVec] gets consumed. + * The provided [DisplayBitVec] gets consumed. * * Returns NULL in case of an error. */ -Packet *sp_bitvec_into_packet(SPBitVec */*notnull*/ bitvec, +Packet *sp_bitvec_into_packet(BitVec */*notnull*/ bitvec, size_t offset, BinaryOperation operation, CompressionCode compression); @@ -607,41 +823,41 @@ Packet *sp_bitvec_into_packet(SPBitVec */*notnull*/ bitvec, * * - `bit_vec`: instance to write to */ -bool sp_bitvec_is_empty(SPBitVec */*notnull*/ bit_vec); +bool sp_bitvec_is_empty(BitVec */*notnull*/ bit_vec); /** - * Gets the length of the [SPBitVec] in bits. + * Gets the length of the [DisplayBitVec] in bits. * * # Arguments * * - `bit_vec`: instance to write to */ -size_t sp_bitvec_len(SPBitVec */*notnull*/ bit_vec); +size_t sp_bitvec_len(BitVec */*notnull*/ bit_vec); /** - * Interpret the data as a series of bits and load then into a new [SPBitVec] instance. + * Interpret the data as a series of bits and load then into a new [DisplayBitVec] instance. * - * returns: [SPBitVec] instance containing data. + * returns: [DisplayBitVec] instance containing data. */ -SPBitVec */*notnull*/ sp_bitvec_load(ByteSlice data); +BitVec */*notnull*/ sp_bitvec_load(ByteSlice data); /** - * Creates a new [SPBitVec] instance. + * Creates a new [DisplayBitVec] instance. * * # Arguments * * - `size`: size in bits. * - * returns: [SPBitVec] with all bits set to false. + * returns: [DisplayBitVec] with all bits set to false. * * # Panics * * - when `size` is not divisible by 8. */ -SPBitVec */*notnull*/ sp_bitvec_new(size_t size); +BitVec */*notnull*/ sp_bitvec_new(size_t size); /** - * Sets the value of a bit in the [SPBitVec]. + * Sets the value of a bit in the [DisplayBitVec]. * * # Arguments * @@ -653,10 +869,10 @@ SPBitVec */*notnull*/ sp_bitvec_new(size_t size); * * - when accessing `index` out of bounds */ -void sp_bitvec_set(SPBitVec */*notnull*/ bit_vec, size_t index, bool value); +void sp_bitvec_set(BitVec */*notnull*/ bit_vec, size_t index, bool value); /** - * Gets an unsafe reference to the data of the [SPBitVec] instance. + * Gets an unsafe reference to the data of the [DisplayBitVec] instance. * * The returned memory is valid for the lifetime of the bitvec. * @@ -664,12 +880,12 @@ void sp_bitvec_set(SPBitVec */*notnull*/ bit_vec, size_t index, bool value); * * - `bit_vec`: instance to write to */ -ByteSlice sp_bitvec_unsafe_data_ref(SPBitVec */*notnull*/ bit_vec); +ByteSlice sp_bitvec_unsafe_data_ref(BitVec */*notnull*/ bit_vec); /** * Clones a [BrightnessGrid]. */ -BrightnessGrid */*notnull*/ sp_brightness_grid_clone(BrightnessGrid */*notnull*/ brightness_grid); +BrightnessGrid */*notnull*/ sp_brightness_grid_clone(BrightnessGrid */*notnull*/ grid); /** * Sets the value of all cells in the [BrightnessGrid]. @@ -744,15 +960,15 @@ BrightnessGrid *sp_brightness_grid_load(size_t width, * * # Examples * ```C - * UdpConnection connection = sp_udp_open("127.0.0.1:2342"); + * UdpSocket *connection = sp_udp_open("127.0.0.1:2342"); * if (connection == NULL) * return 1; * - * BrightnessGrid grid = sp_brightness_grid_new(2, 2); + * BrightnessGrid *grid = sp_brightness_grid_new(2, 2); * sp_brightness_grid_set(grid, 0, 0, 0); * sp_brightness_grid_set(grid, 1, 1, 10); * - * TypedCommand command = sp_command_char_brightness(grid); + * TypedCommand *command = sp_command_char_brightness(grid); * sp_udp_free(connection); * ``` */ @@ -805,7 +1021,7 @@ size_t sp_brightness_grid_width(BrightnessGrid */*notnull*/ brightness_grid); /** * Clones a [CharGrid]. */ -CharGrid */*notnull*/ sp_char_grid_clone(CharGrid */*notnull*/ char_grid); +CharGrid */*notnull*/ sp_char_grid_clone(CharGrid */*notnull*/ grid); /** * Sets the value of all cells in the [CharGrid]. @@ -908,17 +1124,117 @@ void sp_char_grid_set(CharGrid */*notnull*/ char_grid, */ size_t sp_char_grid_width(CharGrid */*notnull*/ char_grid); +/** + * Clones an [BitmapCommand] instance. + * + * returns: a new [BitmapCommand] instance. + */ +BitmapCommand */*notnull*/ sp_cmd_bitmap_clone(BitmapCommand */*notnull*/ command); + +/** + * Deallocates a [BitmapCommand] instance. + */ +void sp_cmd_bitmap_free(BitmapCommand */*notnull*/ command); + +/** + * Move the provided [Bitmap] into a new [BitmapCommand], + * leaving other fields as their default values. + * + * Rust equivalent: `BitmapCommand::from(bitmap)` + */ +BitmapCommand */*notnull*/ sp_cmd_bitmap_from_bitmap(Bitmap */*notnull*/ bitmap); + +/** + * Returns a pointer to the provided `BitmapCommand`. + * + * # Safety + * + * - The returned bitmap inherits the lifetime of the command in which it is contained. + * - The returned pointer may not be used in a function that consumes the instance, e.g. to create a command. + */ +Bitmap */*notnull*/ sp_cmd_bitmap_get(BitmapCommand */*notnull*/ command); + +/** + * Reads the compression kind of the [BitmapCommand]. + */ +CompressionCode sp_cmd_bitmap_get_compression(BitmapCommand */*notnull*/ command); + +/** + * Reads the origin field of the [BitmapCommand]. + */ +void sp_cmd_bitmap_get_origin(BitmapCommand */*notnull*/ command, + size_t */*notnull*/ origin_x, + size_t */*notnull*/ origin_y); + /** * Sets a window of pixels to the specified values. * * The passed [Bitmap] gets consumed. * - * Returns: a new [servicepoint::BitmapCommand] instance. + * Returns: a new [BitmapCommand] instance. */ -TypedCommand *sp_command_bitmap(size_t x, - size_t y, - Bitmap */*notnull*/ bitmap, - CompressionCode compression); +BitmapCommand */*notnull*/ sp_cmd_bitmap_new(Bitmap */*notnull*/ bitmap, + size_t origin_x, + size_t origin_y, + CompressionCode compression); + +/** + * Moves the provided [Bitmap] to be contained in the [BitmapCommand]. + */ +void sp_cmd_bitmap_set(BitmapCommand */*notnull*/ command, + Bitmap */*notnull*/ bitmap); + +/** + * Overwrites the compression kind of the [BitmapCommand]. + */ +void sp_cmd_bitmap_set_compression(BitmapCommand */*notnull*/ command, + CompressionCode compression); + +/** + * Overwrites the origin field of the [BitmapCommand]. + */ +void sp_cmd_bitmap_set_origin(BitmapCommand */*notnull*/ command, + size_t origin_x, + size_t origin_y); + +/** + * Tries to turn a [BitmapCommand] into a [Packet]. + * + * Returns: NULL or a [Packet] containing the command. + */ +Packet *sp_cmd_bitmap_try_into_packet(BitmapCommand */*notnull*/ command); + +/** + * Clones an [BitVecCommand] instance. + * + * returns: a new [BitVecCommand] instance. + */ +BitVecCommand */*notnull*/ sp_cmd_bitvec_clone(BitVecCommand */*notnull*/ command); + +/** + * Deallocates a [BitVecCommand]. + */ +void sp_cmd_bitvec_free(BitVecCommand */*notnull*/ command); + +/** + * Returns a pointer to the [BitVec] contained in the [BitVecCommand]. + */ +BitVec *sp_cmd_bitvec_get(BitVecCommand */*notnull*/ command); + +/** + * Reads the compression kind of the [BitVecCommand]. + */ +CompressionCode sp_cmd_bitvec_get_compression(BitVecCommand */*notnull*/ command); + +/** + * Reads the offset field of the [BitVecCommand]. + */ +Offset sp_cmd_bitvec_get_offset(BitVecCommand */*notnull*/ command); + +/** + * Returns the [BinaryOperation] of the command. + */ +BinaryOperation sp_cmd_bitvec_get_operation(BitVecCommand */*notnull*/ command); /** * Set pixel data starting at the pixel offset on screen. @@ -932,116 +1248,344 @@ TypedCommand *sp_command_bitmap(size_t x, * * For example, [`BinaryOperation::Or`] can be used to turn on some pixels without affecting other pixels. * - * The contained [`BitVecU8Msb0`] is always uncompressed. + * The contained [`DisplayBitVec`] is always uncompressed. */ -TypedCommand *sp_command_bitvec(size_t offset, - SPBitVec */*notnull*/ bit_vec, - CompressionCode compression, - BinaryOperation operation); +BitVecCommand */*notnull*/ sp_cmd_bitvec_new(BitVec */*notnull*/ bitvec, + size_t offset, + BinaryOperation operation, + CompressionCode compression); + +/** + * Moves the provided [BitVec] to be contained in the [BitVecCommand]. + */ +void sp_cmd_bitvec_set(BitVecCommand */*notnull*/ command, + BitVec */*notnull*/ bitvec); + +/** + * Overwrites the compression kind of the [BitVecCommand]. + */ +void sp_cmd_bitvec_set_compression(BitVecCommand */*notnull*/ command, + CompressionCode compression); + +/** + * Overwrites the offset field of the [BitVecCommand]. + */ +void sp_cmd_bitvec_set_offset(BitVecCommand */*notnull*/ command, + Offset offset); + +/** + * Overwrites the [BinaryOperation] of the command. + */ +void sp_cmd_bitvec_set_operation(BitVecCommand */*notnull*/ command, + BinaryOperation operation); + +/** + * Tries to turn a [BitVecCommand] into a [Packet]. + * + * Returns: NULL or a [Packet] containing the command. + */ +Packet *sp_cmd_bitvec_try_into_packet(BitVecCommand */*notnull*/ command); + +/** + * Clones an [GlobalBrightnessCommand] instance. + * + * returns: a new [GlobalBrightnessCommand] instance. + */ +GlobalBrightnessCommand */*notnull*/ sp_cmd_brightness_global_clone(GlobalBrightnessCommand */*notnull*/ command); + +void sp_cmd_brightness_global_free(BitmapCommand */*notnull*/ command); + +Brightness *sp_cmd_brightness_global_get(GlobalBrightnessCommand */*notnull*/ command); + +Packet */*notnull*/ sp_cmd_brightness_global_into_packet(GlobalBrightnessCommand */*notnull*/ command); + +/** + * Set the brightness of all tiles to the same value. + * + * Returns: a new [GlobalBrightnessCommand] instance. + */ +GlobalBrightnessCommand */*notnull*/ sp_cmd_brightness_global_new(Brightness brightness); + +/** + * Moves the provided bitmap to be contained in the command. + */ +void sp_cmd_brightness_global_set(GlobalBrightnessCommand */*notnull*/ command, + Brightness brightness); + +/** + * Clones an [BrightnessGridCommand] instance. + * + * returns: a new [BrightnessGridCommand] instance. + */ +BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_clone(BrightnessGridCommand */*notnull*/ command); + +/** + * Deallocates a [BitmapCommand]. + */ +void sp_cmd_brightness_grid_free(BitmapCommand */*notnull*/ command); + +/** + * Moves the provided [BrightnessGrid] into a new [BrightnessGridCommand], + * leaving other fields as their default values. + */ +BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_from_grid(BrightnessGrid */*notnull*/ grid); + +/** + * Returns a pointer to the [BrightnessGrid] contained in the [BrightnessGridCommand]. + */ +BrightnessGrid *sp_cmd_brightness_grid_get(BrightnessGridCommand */*notnull*/ command); + +/** + * Overwrites the origin field of the [BrightnessGridCommand]. + */ +void sp_cmd_brightness_grid_get_origin(BrightnessGridCommand */*notnull*/ command, + size_t */*notnull*/ origin_x, + size_t */*notnull*/ origin_y); + +/** + * Tries to turn a [BrightnessGridCommand] into a [Packet]. + * + * Returns: NULL or a [Packet] containing the command. + */ +Packet *sp_cmd_brightness_grid_into_packet(BrightnessGridCommand */*notnull*/ command); /** * Set the brightness of individual tiles in a rectangular area of the display. * * The passed [BrightnessGrid] gets consumed. * - * Returns: a new [servicepoint::Command::CharBrightness] instance. + * Returns: a new [BrightnessGridCommand] instance. */ -TypedCommand */*notnull*/ sp_command_brightness_grid(size_t x, - size_t y, - BrightnessGrid */*notnull*/ grid); +BrightnessGridCommand */*notnull*/ sp_cmd_brightness_grid_new(BrightnessGrid */*notnull*/ grid, + size_t origin_x, + size_t origin_y); + +/** + * Moves the provided [BrightnessGrid] to be contained in the [BrightnessGridCommand]. + */ +void sp_cmd_brightness_grid_set(BrightnessGridCommand */*notnull*/ command, + BrightnessGrid */*notnull*/ grid); + +/** + * Reads the origin field of the [BrightnessGridCommand]. + */ +void sp_cmd_brightness_grid_set_origin(BrightnessGridCommand */*notnull*/ command, + size_t origin_x, + size_t origin_y); + +/** + * Clones an [CharGridCommand] instance. + * + * returns: a new [CharGridCommand] instance. + */ +CharGridCommand */*notnull*/ sp_cmd_char_grid_clone(CharGridCommand */*notnull*/ command); + +/** + * Deallocates a [BitmapCommand]. + */ +void sp_cmd_char_grid_free(BitmapCommand */*notnull*/ command); + +/** + * Moves the provided [CharGrid] into a new [CharGridCommand], + * leaving other fields as their default values. + */ +CharGridCommand */*notnull*/ sp_cmd_char_grid_from_grid(CharGrid */*notnull*/ grid); + +/** + * Returns a pointer to the [CharGrid] contained in the [CharGridCommand]. + */ +CharGrid *sp_cmd_char_grid_get(CharGridCommand */*notnull*/ command); + +/** + * Reads the origin field of the [CharGridCommand]. + */ +void sp_cmd_char_grid_get_origin(CharGridCommand */*notnull*/ command, + size_t */*notnull*/ origin_x, + size_t */*notnull*/ origin_y); /** * Show UTF-8 encoded text on the screen. * * The passed [CharGrid] gets consumed. * - * Returns: a new [servicepoint::CharGridCommand] instance. + * Returns: a new [CharGridCommand] instance. */ -TypedCommand */*notnull*/ sp_command_char_grid(size_t x, - size_t y, - CharGrid */*notnull*/ grid); +CharGridCommand */*notnull*/ sp_cmd_char_grid_new(CharGrid */*notnull*/ grid, + size_t origin_x, + size_t origin_y); + +/** + * Moves the provided [CharGrid] to be contained in the [CharGridCommand]. + */ +void sp_cmd_char_grid_set(CharGridCommand */*notnull*/ command, + CharGrid */*notnull*/ grid); + +/** + * Overwrites the origin field of the [CharGridCommand]. + */ +void sp_cmd_char_grid_set_origin(CharGridCommand */*notnull*/ command, + size_t origin_x, + size_t origin_y); + +/** + * Tries to turn a [CharGridCommand] into a [Packet]. + * + * Returns: NULL or a [Packet] containing the command. + */ +Packet *sp_cmd_char_grid_try_into_packet(CharGridCommand */*notnull*/ command); + +/** + * Deallocates a [ClearCommand]. + */ +void sp_cmd_clear_free(ClearCommand */*notnull*/ command); /** * Set all pixels to the off state. * * Does not affect brightness. * - * Returns: a new [servicepoint::Command::Clear] instance. - * - * # Examples - * - * ```C - * sp_udp_send_command(connection, sp_command_clear()); - * ``` + * Returns: a new [ClearCommand] instance. */ -TypedCommand */*notnull*/ sp_command_clear(void); +ClearCommand */*notnull*/ sp_cmd_clear_new(void); /** - * Clones a [TypedCommand] instance. + * Clones an [Cp437GridCommand] instance. * - * returns: new [TypedCommand] instance. + * returns: a new [Cp437GridCommand] instance. */ -TypedCommand */*notnull*/ sp_command_clone(TypedCommand */*notnull*/ command); +Cp437GridCommand */*notnull*/ sp_cmd_cp437_grid_clone(Cp437GridCommand */*notnull*/ command); /** - * Show codepage 437 encoded text on the screen. - * - * The passed [Cp437Grid] gets consumed. - * - * Returns: a new [servicepoint::Cp437GridCommand] instance. + * Deallocates a [Cp437GridCommand]. */ -TypedCommand */*notnull*/ sp_command_cp437_grid(size_t x, - size_t y, - Cp437Grid */*notnull*/ grid); +void sp_cmd_cp437_grid_free(BitmapCommand */*notnull*/ command); + +/** + * Moves the provided [Cp437Grid] into a new [Cp437GridCommand], + * leaving other fields as their default values. + */ +Cp437GridCommand */*notnull*/ sp_cmd_cp437_grid_from_grid(Cp437Grid */*notnull*/ grid); + +/** + * Show text on the screen. + * + * The text is sent in the form of a 2D grid of [CP-437] encoded characters. + * For sending UTF-8 encoded characters, see [servicepoint::CharGridCommand]. + * + * [CP-437]: https://en.wikipedia.org/wiki/Code_page_437 + */ +Cp437Grid *sp_cmd_cp437_grid_get(Cp437GridCommand */*notnull*/ command); + +/** + * Gets the origin field of the [Cp437GridCommand]. + * + * Rust equivalent: `cp437_command.origin` + */ +void sp_cmd_cp437_grid_get_origin(Cp437GridCommand */*notnull*/ command, + size_t */*notnull*/ origin_x, + size_t */*notnull*/ origin_y); + +/** + * Show text on the screen. + * + * The text is sent in the form of a 2D grid of [CP-437] encoded characters. + * + * The origin is relative to the top-left of the display. + */ +Cp437GridCommand */*notnull*/ sp_cmd_cp437_grid_new(Cp437Grid */*notnull*/ grid, + size_t origin_x, + size_t origin_y); + +/** + * Moves the provided bitmap into the provided command. + * + * This drops the previously contained [Cp437Grid]. + */ +void sp_cmd_cp437_grid_set(Cp437GridCommand */*notnull*/ command, + Cp437Grid */*notnull*/ grid); + +/** + * Sets the origin field of the [Cp437GridCommand]. + * + * Rust equivalent: `cp437_command.origin = Origin::new(origin_x, origin_y)` + */ +void sp_cmd_cp437_grid_set_origin(Cp437GridCommand */*notnull*/ command, + size_t origin_x, + size_t origin_y); + +/** + * Tries to turn a [Cp437GridCommand] into a [Packet]. + * + * Returns: NULL or a [Packet] containing the command. + */ +Packet *sp_cmd_cp437_grid_try_into_packet(Cp437GridCommand */*notnull*/ command); + +/** + * Deallocates a [FadeOutCommand]. + */ +void sp_cmd_fade_out_free(ClearCommand */*notnull*/ command); /** * A yet-to-be-tested command. * - * Returns: a new [servicepoint::Command::FadeOut] instance. + * Returns: a new [FadeOutCommand] instance. */ -TypedCommand */*notnull*/ sp_command_fade_out(void); +FadeOutCommand */*notnull*/ sp_cmd_fade_out_new(void); /** - * Deallocates a [TypedCommand]. + * Clones an [SPCommand] instance. + * + * returns: a new [SPCommand] instance. + */ +Command sp_cmd_generic_clone(Command command); + +/** + * Deallocates an [SPCommand]. * * # Examples * * ```C - * TypedCommand c = sp_command_clear(); + * SPCommand c = sp_cmd_clear_into_generic(sp_cmd_clear_new()); * sp_command_free(c); * ``` */ -void sp_command_free(TypedCommand */*notnull*/ command); +void sp_cmd_generic_free(Command command); /** - * Set the brightness of all tiles to the same value. + * Tries to turn a [SPCommand] into a [Packet]. + * The [SPCommand] gets consumed. * - * Returns: a new [servicepoint::Command::Brightness] instance. + * Returns tag [CommandTag::Invalid] in case of an error. */ -TypedCommand */*notnull*/ sp_command_global_brightness(Brightness brightness); +Packet *sp_cmd_generic_into_packet(Command command); + +/** + * Tries to turn a [Packet] into a [SPCommand]. + * + * The packet is dropped in the process. + * + * Returns: pointer to new [SPCommand] instance or NULL if parsing failed. + */ +Command *sp_cmd_generic_try_from_packet(Packet */*notnull*/ packet); + +/** + * Deallocates a [HardResetCommand]. + */ +void sp_cmd_hard_reset_free(ClearCommand */*notnull*/ command); /** * Kills the udp daemon on the display, which usually results in a restart. * * Please do not send this in your normal program flow. * - * Returns: a new [servicepoint::Command::HardReset] instance. + * Returns: a new [HardResetCommand] instance. */ -TypedCommand */*notnull*/ sp_command_hard_reset(void); - -/** - * Tries to turn a [Packet] into a [TypedCommand]. - * - * The packet is deallocated in the process. - * - * Returns: pointer to new [TypedCommand] instance or NULL if parsing failed. - */ -TypedCommand *sp_command_try_from_packet(Packet */*notnull*/ packet); +HardResetCommand */*notnull*/ sp_cmd_hard_reset_new(void); /** * Clones a [Cp437Grid]. */ -Cp437Grid */*notnull*/ sp_cp437_grid_clone(Cp437Grid */*notnull*/ cp437_grid); +Cp437Grid */*notnull*/ sp_cp437_grid_clone(Cp437Grid */*notnull*/ grid); /** * Sets the value of all cells in the [Cp437Grid]. @@ -1144,6 +1688,8 @@ size_t sp_cp437_grid_width(Cp437Grid */*notnull*/ cp437_grid); /** * Clones a [Packet]. + * + * returns: a new [Packet] instance. */ Packet */*notnull*/ sp_packet_clone(Packet */*notnull*/ packet); @@ -1152,14 +1698,6 @@ Packet */*notnull*/ sp_packet_clone(Packet */*notnull*/ packet); */ void sp_packet_free(Packet */*notnull*/ packet); -/** - * Turns a [TypedCommand] into a [Packet]. - * The [TypedCommand] gets consumed. - * - * Returns NULL in case of an error. - */ -Packet *sp_packet_from_command(TypedCommand */*notnull*/ command); - /** * Creates a raw [Packet] from parts. * @@ -1214,19 +1752,19 @@ bool sp_u16_to_command_code(uint16_t code, CommandCode *result); /** - * Closes and deallocates a [UdpConnection]. + * Closes and deallocates a [UdpSocket]. */ void sp_udp_free(UdpSocket */*notnull*/ connection); /** - * Creates a new instance of [UdpConnection]. + * Creates a new instance of [UdpSocket]. * * returns: NULL if connection fails, or connected instance * * # Examples * * ```C - * UdpConnection connection = sp_udp_open("172.23.42.29:2342"); + * UdpSocket connection = sp_udp_open("172.23.42.29:2342"); * if (connection != NULL) * sp_udp_send_command(connection, sp_command_clear()); * ``` @@ -1234,14 +1772,14 @@ void sp_udp_free(UdpSocket */*notnull*/ connection); UdpSocket *sp_udp_open(char */*notnull*/ host); /** - * Creates a new instance of [UdpConnection]. + * Creates a new instance of [UdpSocket]. * * returns: NULL if connection fails, or connected instance * * # Examples * * ```C - * UdpConnection connection = sp_udp_open_ipv4(172, 23, 42, 29, 2342); + * UdpSocket connection = sp_udp_open_ipv4(172, 23, 42, 29, 2342); * if (connection != NULL) * sp_udp_send_command(connection, sp_command_clear()); * ``` @@ -1253,7 +1791,7 @@ UdpSocket *sp_udp_open_ipv4(uint8_t ip1, uint16_t port); /** - * Sends a [TypedCommand] to the display using the [UdpConnection]. + * Sends a [SPCommand] to the display using the [UdpSocket]. * * The passed `command` gets consumed. * @@ -1265,11 +1803,10 @@ UdpSocket *sp_udp_open_ipv4(uint8_t ip1, * sp_udp_send_command(connection, sp_command_brightness(5)); * ``` */ -bool sp_udp_send_command(UdpSocket */*notnull*/ connection, - TypedCommand */*notnull*/ command); +bool sp_udp_send_command(UdpSocket */*notnull*/ connection, Command command); /** - * Sends a [Header] to the display using the [UdpConnection]. + * Sends a [Header] to the display using the [UdpSocket]. * * returns: true in case of success * @@ -1282,7 +1819,7 @@ bool sp_udp_send_command(UdpSocket */*notnull*/ connection, bool sp_udp_send_header(UdpSocket */*notnull*/ udp_connection, Header header); /** - * Sends a [Packet] to the display using the [UdpConnection]. + * Sends a [Packet] to the display using the [UdpSocket]. * * The passed `packet` gets consumed. * diff --git a/src/bitvec.rs b/src/bitvec.rs deleted file mode 100644 index 0e7ee5e..0000000 --- a/src/bitvec.rs +++ /dev/null @@ -1,174 +0,0 @@ -use crate::{heap_drop, heap_move, heap_move_nonnull, heap_remove, ByteSlice}; -use servicepoint::{ - BinaryOperation, BitVecCommand, CompressionCode, DisplayBitVec, Packet, -}; -use std::ptr::NonNull; - -/// A vector of bits -/// -/// # Examples -/// ```C -/// SPBitVec vec = sp_bitvec_new(8); -/// sp_bitvec_set(vec, 5, true); -/// sp_bitvec_free(vec); -/// ``` -pub struct SPBitVec(pub(crate) DisplayBitVec); - -impl Clone for SPBitVec { - fn clone(&self) -> Self { - SPBitVec(self.0.clone()) - } -} - -/// Creates a new [SPBitVec] instance. -/// -/// # Arguments -/// -/// - `size`: size in bits. -/// -/// returns: [SPBitVec] with all bits set to false. -/// -/// # Panics -/// -/// - when `size` is not divisible by 8. -#[no_mangle] -pub unsafe extern "C" fn sp_bitvec_new(size: usize) -> NonNull { - heap_move_nonnull(SPBitVec(DisplayBitVec::repeat(false, size))) -} - -/// Interpret the data as a series of bits and load then into a new [SPBitVec] instance. -/// -/// returns: [SPBitVec] instance containing data. -#[no_mangle] -pub unsafe extern "C" fn sp_bitvec_load(data: ByteSlice) -> NonNull { - let data = unsafe { data.as_slice() }; - heap_move_nonnull(SPBitVec(DisplayBitVec::from_slice(data))) -} - -/// Clones a [SPBitVec]. -#[no_mangle] -pub unsafe extern "C" fn sp_bitvec_clone( - bit_vec: NonNull, -) -> NonNull { - heap_move_nonnull(unsafe { bit_vec.as_ref().clone() }) -} - -/// Deallocates a [SPBitVec]. -#[no_mangle] -pub unsafe extern "C" fn sp_bitvec_free(bit_vec: NonNull) { - unsafe { heap_drop(bit_vec) } -} - -/// Gets the value of a bit from the [SPBitVec]. -/// -/// # Arguments -/// -/// - `bit_vec`: instance to read from -/// - `index`: the bit index to read -/// -/// returns: value of the bit -/// -/// # Panics -/// -/// - when accessing `index` out of bounds -#[no_mangle] -pub unsafe extern "C" fn sp_bitvec_get( - bit_vec: NonNull, - index: usize, -) -> bool { - unsafe { *bit_vec.as_ref().0.get(index).unwrap() } -} - -/// Sets the value of a bit in the [SPBitVec]. -/// -/// # Arguments -/// -/// - `bit_vec`: instance to write to -/// - `index`: the bit index to edit -/// - `value`: the value to set the bit to -/// -/// # Panics -/// -/// - when accessing `index` out of bounds -#[no_mangle] -pub unsafe extern "C" fn sp_bitvec_set( - bit_vec: NonNull, - index: usize, - value: bool, -) { - unsafe { (*bit_vec.as_ptr()).0.set(index, value) } -} - -/// Sets the value of all bits in the [SPBitVec]. -/// -/// # Arguments -/// -/// - `bit_vec`: instance to write to -/// - `value`: the value to set all bits to -#[no_mangle] -pub unsafe extern "C" fn sp_bitvec_fill( - bit_vec: NonNull, - value: bool, -) { - unsafe { (*bit_vec.as_ptr()).0.fill(value) } -} - -/// Gets the length of the [SPBitVec] in bits. -/// -/// # Arguments -/// -/// - `bit_vec`: instance to write to -#[no_mangle] -pub unsafe extern "C" fn sp_bitvec_len(bit_vec: NonNull) -> usize { - unsafe { bit_vec.as_ref().0.len() } -} - -/// Returns true if length is 0. -/// -/// # Arguments -/// -/// - `bit_vec`: instance to write to -#[no_mangle] -pub unsafe extern "C" fn sp_bitvec_is_empty( - bit_vec: NonNull, -) -> bool { - unsafe { bit_vec.as_ref().0.is_empty() } -} - -/// Gets an unsafe reference to the data of the [SPBitVec] instance. -/// -/// The returned memory is valid for the lifetime of the bitvec. -/// -/// # Arguments -/// -/// - `bit_vec`: instance to write to -#[no_mangle] -pub unsafe extern "C" fn sp_bitvec_unsafe_data_ref( - bit_vec: NonNull, -) -> ByteSlice { - unsafe { ByteSlice::from_slice((*bit_vec.as_ptr()).0.as_raw_mut_slice()) } -} - -/// Creates a [BitVecCommand] and immediately turns that into a [Packet]. -/// -/// The provided [SPBitVec] gets consumed. -/// -/// Returns NULL in case of an error. -#[no_mangle] -pub unsafe extern "C" fn sp_bitvec_into_packet( - bitvec: NonNull, - offset: usize, - operation: BinaryOperation, - compression: CompressionCode, -) -> *mut Packet { - let bitvec = unsafe { heap_remove(bitvec) }.0; - match Packet::try_from(BitVecCommand { - bitvec, - offset, - operation, - compression, - }) { - Ok(packet) => heap_move(packet), - Err(_) => std::ptr::null_mut(), - } -} diff --git a/src/commands/bitmap_command.rs b/src/commands/bitmap_command.rs new file mode 100644 index 0000000..286a6f1 --- /dev/null +++ b/src/commands/bitmap_command.rs @@ -0,0 +1,130 @@ +use crate::mem::{ + heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, +}; +use servicepoint::{Bitmap, BitmapCommand, CompressionCode, Origin, Packet}; +use std::ptr::NonNull; + +/// Sets a window of pixels to the specified values. +/// +/// The passed [Bitmap] gets consumed. +/// +/// Returns: a new [BitmapCommand] instance. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitmap_new( + bitmap: NonNull, + origin_x: usize, + origin_y: usize, + compression: CompressionCode, +) -> NonNull { + heap_move_nonnull(BitmapCommand { + bitmap: unsafe { heap_remove(bitmap) }, + origin: Origin::new(origin_x, origin_y), + compression, + }) +} + +/// Move the provided [Bitmap] into a new [BitmapCommand], +/// leaving other fields as their default values. +/// +/// Rust equivalent: `BitmapCommand::from(bitmap)` +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitmap_from_bitmap( + bitmap: NonNull, +) -> NonNull { + heap_move_nonnull(unsafe { heap_remove(bitmap) }.into()) +} + +/// Tries to turn a [BitmapCommand] into a [Packet]. +/// +/// Returns: NULL or a [Packet] containing the command. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitmap_try_into_packet( + command: NonNull, +) -> *mut Packet { + heap_move_ok(unsafe { heap_remove(command) }.try_into()) +} + +/// Clones an [BitmapCommand] instance. +/// +/// returns: a new [BitmapCommand] instance. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitmap_clone( + command: NonNull, +) -> NonNull { + unsafe { heap_clone(command) } +} + +/// Deallocates a [BitmapCommand] instance. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitmap_free(command: NonNull) { + unsafe { heap_drop(command) } +} + +/// Returns a pointer to the provided `BitmapCommand`. +/// +/// # Safety +/// +/// - The returned bitmap inherits the lifetime of the command in which it is contained. +/// - The returned pointer may not be used in a function that consumes the instance, e.g. to create a command. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitmap_get( + mut command: NonNull, +) -> NonNull { + unsafe { NonNull::from(&mut (command.as_mut().bitmap)) } +} + +/// Moves the provided [Bitmap] to be contained in the [BitmapCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitmap_set( + mut command: NonNull, + bitmap: NonNull, +) { + unsafe { + command.as_mut().bitmap = heap_remove(bitmap); + } +} + +/// Reads the origin field of the [BitmapCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitmap_get_origin( + command: NonNull, + origin_x: NonNull, + origin_y: NonNull, +) { + unsafe { + let origin = &command.as_ref().origin; + *origin_x.as_ptr() = origin.x; + *origin_y.as_ptr() = origin.y; + } +} + +/// Overwrites the origin field of the [BitmapCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitmap_set_origin( + mut command: NonNull, + origin_x: usize, + origin_y: usize, +) { + unsafe { + command.as_mut().origin = Origin::new(origin_x, origin_y); + } +} + +/// Overwrites the compression kind of the [BitmapCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitmap_set_compression( + mut command: NonNull, + compression: CompressionCode, +) { + unsafe { + command.as_mut().compression = compression; + } +} + +/// Reads the compression kind of the [BitmapCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitmap_get_compression( + command: NonNull, +) -> CompressionCode { + unsafe { command.as_ref().compression } +} diff --git a/src/commands/bitvec_command.rs b/src/commands/bitvec_command.rs new file mode 100644 index 0000000..617e3af --- /dev/null +++ b/src/commands/bitvec_command.rs @@ -0,0 +1,137 @@ +use crate::mem::{ + heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, +}; +use servicepoint::{ + BinaryOperation, BitVecCommand, CompressionCode, DisplayBitVec, Offset, + Packet, +}; +use std::ptr::NonNull; + +/// Set pixel data starting at the pixel offset on screen. +/// +/// The screen will continuously overwrite more pixel data without regarding the offset, meaning +/// once the starting row is full, overwriting will continue on column 0. +/// +/// The [`BinaryOperation`] will be applied on the display comparing old and sent bit. +/// +/// `new_bit = old_bit op sent_bit` +/// +/// For example, [`BinaryOperation::Or`] can be used to turn on some pixels without affecting other pixels. +/// +/// The contained [`DisplayBitVec`] is always uncompressed. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitvec_new( + bitvec: NonNull, + offset: usize, + operation: BinaryOperation, + compression: CompressionCode, +) -> NonNull { + heap_move_nonnull(BitVecCommand { + bitvec: unsafe { heap_remove(bitvec) }, + offset, + operation, + compression, + }) +} + +/// Tries to turn a [BitVecCommand] into a [Packet]. +/// +/// Returns: NULL or a [Packet] containing the command. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitvec_try_into_packet( + command: NonNull, +) -> *mut Packet { + heap_move_ok(unsafe { heap_remove(command) }.try_into()) +} + +/// Clones an [BitVecCommand] instance. +/// +/// returns: a new [BitVecCommand] instance. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitvec_clone( + command: NonNull, +) -> NonNull { + unsafe { heap_clone(command) } +} + +/// Deallocates a [BitVecCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitvec_free(command: NonNull) { + unsafe { heap_drop(command) } +} + +/// Returns a pointer to the [BitVec] contained in the [BitVecCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitvec_get( + mut command: NonNull, +) -> *mut DisplayBitVec { + &mut unsafe { command.as_mut() }.bitvec +} + +/// Moves the provided [BitVec] to be contained in the [BitVecCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitvec_set( + mut command: NonNull, + bitvec: NonNull, +) { + unsafe { + command.as_mut().bitvec = heap_remove(bitvec); + } +} + +/// Reads the offset field of the [BitVecCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitvec_get_offset( + command: NonNull, +) -> Offset { + unsafe { command.as_ref().offset } +} + +/// Overwrites the offset field of the [BitVecCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitvec_set_offset( + mut command: NonNull, + offset: Offset, +) { + unsafe { + command.as_mut().offset = offset; + } +} + +/// Returns the [BinaryOperation] of the command. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitvec_get_operation( + command: NonNull, +) -> BinaryOperation { + unsafe { command.as_ref().operation.clone() } // TODO remove clone +} + +/// Overwrites the [BinaryOperation] of the command. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitvec_set_operation( + mut command: NonNull, + operation: BinaryOperation, +) { + unsafe { + command.as_mut().operation = operation; + } +} + +/// Overwrites the compression kind of the [BitVecCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitvec_set_compression( + mut command: NonNull, + compression: CompressionCode, +) { + unsafe { + command.as_mut().compression = compression; + } +} + +/// Reads the compression kind of the [BitVecCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_bitvec_get_compression( + command: NonNull, +) -> CompressionCode { + unsafe { command.as_ref().compression } +} diff --git a/src/commands/brightness_grid_command.rs b/src/commands/brightness_grid_command.rs new file mode 100644 index 0000000..80e1b89 --- /dev/null +++ b/src/commands/brightness_grid_command.rs @@ -0,0 +1,106 @@ +use crate::mem::{ + heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, +}; +use servicepoint::{ + BitmapCommand, BrightnessGrid, BrightnessGridCommand, Origin, Packet, +}; +use std::ptr::NonNull; + +/// Set the brightness of individual tiles in a rectangular area of the display. +/// +/// The passed [BrightnessGrid] gets consumed. +/// +/// Returns: a new [BrightnessGridCommand] instance. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_brightness_grid_new( + grid: NonNull, + origin_x: usize, + origin_y: usize, +) -> NonNull { + heap_move_nonnull(BrightnessGridCommand { + grid: unsafe { heap_remove(grid) }, + origin: Origin::new(origin_x, origin_y), + }) +} + +/// Moves the provided [BrightnessGrid] into a new [BrightnessGridCommand], +/// leaving other fields as their default values. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_brightness_grid_from_grid( + grid: NonNull, +) -> NonNull { + heap_move_nonnull(unsafe { heap_remove(grid) }.into()) +} + +/// Tries to turn a [BrightnessGridCommand] into a [Packet]. +/// +/// Returns: NULL or a [Packet] containing the command. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_brightness_grid_into_packet( + command: NonNull, +) -> *mut Packet { + heap_move_ok(unsafe { heap_remove(command) }.try_into()) +} + +/// Clones an [BrightnessGridCommand] instance. +/// +/// returns: a new [BrightnessGridCommand] instance. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_brightness_grid_clone( + command: NonNull, +) -> NonNull { + unsafe { heap_clone(command) } +} + +/// Deallocates a [BitmapCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_brightness_grid_free( + command: NonNull, +) { + unsafe { heap_drop(command) } +} + +/// Moves the provided [BrightnessGrid] to be contained in the [BrightnessGridCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_brightness_grid_set( + mut command: NonNull, + grid: NonNull, +) { + unsafe { + command.as_mut().grid = heap_remove(grid); + } +} + +/// Returns a pointer to the [BrightnessGrid] contained in the [BrightnessGridCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_brightness_grid_get( + mut command: NonNull, +) -> *mut BrightnessGrid { + &mut unsafe { command.as_mut() }.grid +} + +/// Overwrites the origin field of the [BrightnessGridCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_brightness_grid_get_origin( + command: NonNull, + origin_x: NonNull, + origin_y: NonNull, +) { + unsafe { + let origin = &command.as_ref().origin; + *origin_x.as_ptr() = origin.x; + *origin_y.as_ptr() = origin.y; + } +} + +/// Reads the origin field of the [BrightnessGridCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_brightness_grid_set_origin( + mut command: NonNull, + origin_x: usize, + origin_y: usize, +) { + unsafe { + command.as_mut().origin = Origin::new(origin_x, origin_y); + } +} diff --git a/src/commands/cc_only_commands.rs b/src/commands/cc_only_commands.rs new file mode 100644 index 0000000..2a48c12 --- /dev/null +++ b/src/commands/cc_only_commands.rs @@ -0,0 +1,51 @@ +use crate::mem::{heap_drop, heap_move_nonnull}; +use servicepoint::{ClearCommand, FadeOutCommand, HardResetCommand}; +use std::ptr::NonNull; + +/// Set all pixels to the off state. +/// +/// Does not affect brightness. +/// +/// Returns: a new [ClearCommand] instance. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_clear_new() -> NonNull { + heap_move_nonnull(ClearCommand) +} + +/// Deallocates a [ClearCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_clear_free(command: NonNull) { + unsafe { heap_drop(command) } +} + +/// Kills the udp daemon on the display, which usually results in a restart. +/// +/// Please do not send this in your normal program flow. +/// +/// Returns: a new [HardResetCommand] instance. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_hard_reset_new() -> NonNull { + heap_move_nonnull(HardResetCommand) +} + +/// Deallocates a [HardResetCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_hard_reset_free( + command: NonNull, +) { + unsafe { heap_drop(command) } +} + +/// A yet-to-be-tested command. +/// +/// Returns: a new [FadeOutCommand] instance. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_fade_out_new() -> NonNull { + heap_move_nonnull(FadeOutCommand) +} + +/// Deallocates a [FadeOutCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_fade_out_free(command: NonNull) { + unsafe { heap_drop(command) } +} diff --git a/src/commands/char_grid_command.rs b/src/commands/char_grid_command.rs new file mode 100644 index 0000000..8a220a5 --- /dev/null +++ b/src/commands/char_grid_command.rs @@ -0,0 +1,104 @@ +use crate::mem::{ + heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, +}; +use servicepoint::{BitmapCommand, CharGrid, CharGridCommand, Origin, Packet}; +use std::ptr::NonNull; + +/// Show UTF-8 encoded text on the screen. +/// +/// The passed [CharGrid] gets consumed. +/// +/// Returns: a new [CharGridCommand] instance. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_char_grid_new( + grid: NonNull, + origin_x: usize, + origin_y: usize, +) -> NonNull { + heap_move_nonnull(CharGridCommand { + grid: unsafe { heap_remove(grid) }, + origin: Origin::new(origin_x, origin_y), + }) +} + +/// Moves the provided [CharGrid] into a new [CharGridCommand], +/// leaving other fields as their default values. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_char_grid_from_grid( + grid: NonNull, +) -> NonNull { + heap_move_nonnull(unsafe { heap_remove(grid) }.into()) +} + +/// Tries to turn a [CharGridCommand] into a [Packet]. +/// +/// Returns: NULL or a [Packet] containing the command. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_char_grid_try_into_packet( + command: NonNull, +) -> *mut Packet { + heap_move_ok(unsafe { heap_remove(command) }.try_into()) +} + +/// Clones an [CharGridCommand] instance. +/// +/// returns: a new [CharGridCommand] instance. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_char_grid_clone( + command: NonNull, +) -> NonNull { + unsafe { heap_clone(command) } +} + +/// Deallocates a [BitmapCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_char_grid_free( + command: NonNull, +) { + unsafe { heap_drop(command) } +} + +/// Moves the provided [CharGrid] to be contained in the [CharGridCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_char_grid_set( + mut command: NonNull, + grid: NonNull, +) { + unsafe { + command.as_mut().grid = heap_remove(grid); + } +} + +/// Returns a pointer to the [CharGrid] contained in the [CharGridCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_char_grid_get( + mut command: NonNull, +) -> *mut CharGrid { + &mut unsafe { command.as_mut() }.grid +} + +/// Reads the origin field of the [CharGridCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_char_grid_get_origin( + command: NonNull, + origin_x: NonNull, + origin_y: NonNull, +) { + unsafe { + let origin = &command.as_ref().origin; + *origin_x.as_ptr() = origin.x; + *origin_y.as_ptr() = origin.y; + } +} + +/// Overwrites the origin field of the [CharGridCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_char_grid_set_origin( + mut command: NonNull, + origin_x: usize, + origin_y: usize, +) { + unsafe { + command.as_mut().origin = Origin::new(origin_x, origin_y); + } +} diff --git a/src/commands/cp437_grid_command.rs b/src/commands/cp437_grid_command.rs new file mode 100644 index 0000000..f653ef5 --- /dev/null +++ b/src/commands/cp437_grid_command.rs @@ -0,0 +1,117 @@ +use crate::mem::{ + heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, +}; +use servicepoint::{ + BitmapCommand, Cp437Grid, Cp437GridCommand, Origin, Packet, +}; +use std::ptr::NonNull; + +/// Show text on the screen. +/// +/// The text is sent in the form of a 2D grid of [CP-437] encoded characters. +/// +/// The origin is relative to the top-left of the display. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_cp437_grid_new( + grid: NonNull, + origin_x: usize, + origin_y: usize, +) -> NonNull { + heap_move_nonnull(Cp437GridCommand { + grid: unsafe { heap_remove(grid) }, + origin: Origin::new(origin_x, origin_y), + }) +} + +/// Moves the provided [Cp437Grid] into a new [Cp437GridCommand], +/// leaving other fields as their default values. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_cp437_grid_from_grid( + grid: NonNull, +) -> NonNull { + heap_move_nonnull(unsafe { heap_remove(grid) }.into()) +} + +/// Tries to turn a [Cp437GridCommand] into a [Packet]. +/// +/// Returns: NULL or a [Packet] containing the command. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_cp437_grid_try_into_packet( + command: NonNull, +) -> *mut Packet { + heap_move_ok(unsafe { heap_remove(command) }.try_into()) +} + +/// Clones an [Cp437GridCommand] instance. +/// +/// returns: a new [Cp437GridCommand] instance. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_cp437_grid_clone( + command: NonNull, +) -> NonNull { + unsafe { heap_clone(command) } +} + +/// Deallocates a [Cp437GridCommand]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_cp437_grid_free( + command: NonNull, +) { + unsafe { heap_drop(command) } +} + +/// Moves the provided bitmap into the provided command. +/// +/// This drops the previously contained [Cp437Grid]. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_cp437_grid_set( + mut command: NonNull, + grid: NonNull, +) { + unsafe { + command.as_mut().grid = heap_remove(grid); + } +} + +/// Show text on the screen. +/// +/// The text is sent in the form of a 2D grid of [CP-437] encoded characters. +/// For sending UTF-8 encoded characters, see [servicepoint::CharGridCommand]. +/// +/// [CP-437]: https://en.wikipedia.org/wiki/Code_page_437 +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_cp437_grid_get( + mut command: NonNull, +) -> *mut Cp437Grid { + &mut unsafe { command.as_mut() }.grid +} + +/// Gets the origin field of the [Cp437GridCommand]. +/// +/// Rust equivalent: `cp437_command.origin` +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_cp437_grid_get_origin( + command: NonNull, + origin_x: NonNull, + origin_y: NonNull, +) { + unsafe { + let origin = &command.as_ref().origin; + *origin_x.as_ptr() = origin.x; + *origin_y.as_ptr() = origin.y; + } +} + +/// Sets the origin field of the [Cp437GridCommand]. +/// +/// Rust equivalent: `cp437_command.origin = Origin::new(origin_x, origin_y)` +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_cp437_grid_set_origin( + mut command: NonNull, + origin_x: usize, + origin_y: usize, +) { + unsafe { + command.as_mut().origin = Origin::new(origin_x, origin_y); + } +} diff --git a/src/commands/generic_command.rs b/src/commands/generic_command.rs new file mode 100644 index 0000000..bdeab5e --- /dev/null +++ b/src/commands/generic_command.rs @@ -0,0 +1,293 @@ +use crate::mem::{ + heap_clone, heap_drop, heap_move, heap_move_nonnull, heap_move_ok, + heap_remove, +}; +use servicepoint::{ + BitVecCommand, BitmapCommand, BrightnessGridCommand, CharGridCommand, + ClearCommand, Cp437GridCommand, FadeOutCommand, GlobalBrightnessCommand, + HardResetCommand, Packet, TypedCommand, +}; +use std::ptr::{null_mut, NonNull}; + +/// Pointer to one of the available command structs. +#[repr(C)] +#[allow(missing_docs)] +pub union CommandUnion { + pub null: *mut u8, + pub bitmap: NonNull, + pub bitvec: NonNull, + pub brightness_grid: NonNull, + pub char_grid: NonNull, + pub cp437_grid: NonNull, + pub global_brightness: NonNull, + pub clear: NonNull, + #[allow(deprecated)] + pub bitmap_legacy: NonNull, + pub hard_reset: NonNull, + pub fade_out: NonNull, +} + +/// Specifies the kind of command struct. +/// +/// This is _not_ equivalent to the [servicepoint::CommandCode]s. +#[repr(u8)] +#[allow(missing_docs)] +pub enum CommandTag { + Invalid = 0, + Bitmap, + BitVec, + BrightnessGrid, + CharGrid, + Cp437Grid, + GlobalBrightness, + Clear, + HardReset, + FadeOut, + BitmapLegacy, +} + +/// This struct represents a pointer to one of the possible command structs. +/// +/// Only ever access `data` with the correct data type as specified by `tag`! +/// +/// Rust equivalent: [TypedCommand]. +#[repr(C)] +pub struct SPCommand { + /// Specifies which kind of command struct is contained in `data` + pub tag: CommandTag, + /// The pointer to the command struct + pub data: CommandUnion, +} + +impl SPCommand { + const INVALID: SPCommand = SPCommand { + tag: CommandTag::Invalid, + data: CommandUnion { null: null_mut() }, + }; +} + +/// Tries to turn a [Packet] into a [SPCommand]. +/// +/// The packet is dropped in the process. +/// +/// Returns: pointer to new [SPCommand] instance or NULL if parsing failed. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_generic_try_from_packet( + packet: NonNull, +) -> *mut SPCommand { + let packet = *unsafe { Box::from_raw(packet.as_ptr()) }; + heap_move_ok(servicepoint::TypedCommand::try_from(packet).map(|value| { + match value { + TypedCommand::Clear(clear) => SPCommand { + tag: CommandTag::Clear, + data: CommandUnion { + clear: heap_move_nonnull(clear), + }, + }, + TypedCommand::CharGrid(char_grid) => SPCommand { + tag: CommandTag::CharGrid, + data: CommandUnion { + char_grid: heap_move_nonnull(char_grid), + }, + }, + TypedCommand::Cp437Grid(cp437_grid) => SPCommand { + tag: CommandTag::Cp437Grid, + data: CommandUnion { + cp437_grid: heap_move_nonnull(cp437_grid), + }, + }, + TypedCommand::Bitmap(bitmap) => SPCommand { + tag: CommandTag::Bitmap, + data: CommandUnion { + bitmap: heap_move_nonnull(bitmap), + }, + }, + TypedCommand::Brightness(global_brightness) => SPCommand { + tag: CommandTag::GlobalBrightness, + data: CommandUnion { + global_brightness: heap_move_nonnull(global_brightness), + }, + }, + TypedCommand::BrightnessGrid(brightness_grid) => SPCommand { + tag: CommandTag::BrightnessGrid, + data: CommandUnion { + brightness_grid: heap_move_nonnull(brightness_grid), + }, + }, + TypedCommand::BitVec(bitvec) => SPCommand { + tag: CommandTag::BitVec, + data: CommandUnion { + bitvec: heap_move_nonnull(bitvec), + }, + }, + TypedCommand::HardReset(hard_reset) => SPCommand { + tag: CommandTag::HardReset, + data: CommandUnion { + hard_reset: heap_move_nonnull(hard_reset), + }, + }, + TypedCommand::FadeOut(fade_out) => SPCommand { + tag: CommandTag::FadeOut, + data: CommandUnion { + fade_out: heap_move_nonnull(fade_out), + }, + }, + #[allow(deprecated)] + TypedCommand::BitmapLegacy(bitmap_legacy) => SPCommand { + tag: CommandTag::BitmapLegacy, + data: CommandUnion { + bitmap_legacy: heap_move_nonnull(bitmap_legacy), + }, + }, + } + })) +} + +/// Clones an [SPCommand] instance. +/// +/// returns: a new [SPCommand] instance. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_generic_clone(command: SPCommand) -> SPCommand { + unsafe { + match command.tag { + CommandTag::Clear => SPCommand { + tag: CommandTag::Clear, + data: CommandUnion { + clear: heap_clone(command.data.clear), + }, + }, + CommandTag::CharGrid => SPCommand { + tag: CommandTag::CharGrid, + data: CommandUnion { + char_grid: heap_clone(command.data.char_grid), + }, + }, + CommandTag::Cp437Grid => SPCommand { + tag: CommandTag::Cp437Grid, + data: CommandUnion { + cp437_grid: heap_clone(command.data.cp437_grid), + }, + }, + CommandTag::Bitmap => SPCommand { + tag: CommandTag::Bitmap, + data: CommandUnion { + bitmap: heap_clone(command.data.bitmap), + }, + }, + CommandTag::GlobalBrightness => SPCommand { + tag: CommandTag::GlobalBrightness, + data: CommandUnion { + global_brightness: heap_clone( + command.data.global_brightness, + ), + }, + }, + CommandTag::BrightnessGrid => SPCommand { + tag: CommandTag::BrightnessGrid, + data: CommandUnion { + brightness_grid: heap_clone(command.data.brightness_grid), + }, + }, + CommandTag::BitVec => SPCommand { + tag: CommandTag::BitVec, + data: CommandUnion { + bitvec: heap_clone(command.data.bitvec), + }, + }, + CommandTag::HardReset => SPCommand { + tag: CommandTag::HardReset, + data: CommandUnion { + hard_reset: heap_clone(command.data.hard_reset), + }, + }, + CommandTag::FadeOut => SPCommand { + tag: CommandTag::FadeOut, + data: CommandUnion { + fade_out: heap_clone(command.data.fade_out), + }, + }, + #[allow(deprecated)] + CommandTag::BitmapLegacy => SPCommand { + tag: CommandTag::BitmapLegacy, + data: CommandUnion { + bitmap_legacy: heap_clone(command.data.bitmap_legacy), + }, + }, + CommandTag::Invalid => SPCommand::INVALID, + } + } +} + +/// Deallocates an [SPCommand]. +/// +/// # Examples +/// +/// ```C +/// SPCommand c = sp_cmd_clear_into_generic(sp_cmd_clear_new()); +/// sp_command_free(c); +/// ``` +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_generic_free(command: SPCommand) { + unsafe { + match command.tag { + CommandTag::Invalid => (), + CommandTag::Bitmap => heap_drop(command.data.bitmap), + CommandTag::BitVec => heap_drop(command.data.bitvec), + CommandTag::BrightnessGrid => { + heap_drop(command.data.brightness_grid) + } + CommandTag::CharGrid => heap_drop(command.data.char_grid), + CommandTag::Cp437Grid => heap_drop(command.data.cp437_grid), + CommandTag::GlobalBrightness => { + heap_drop(command.data.global_brightness) + } + CommandTag::Clear => heap_drop(command.data.clear), + CommandTag::HardReset => heap_drop(command.data.hard_reset), + CommandTag::FadeOut => heap_drop(command.data.fade_out), + CommandTag::BitmapLegacy => heap_drop(command.data.bitmap_legacy), + } + } +} + +/// Tries to turn a [SPCommand] into a [Packet]. +/// The [SPCommand] gets consumed. +/// +/// Returns tag [CommandTag::Invalid] in case of an error. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_generic_into_packet( + command: SPCommand, +) -> *mut Packet { + match command.tag { + CommandTag::Invalid => null_mut(), + CommandTag::Bitmap => { + heap_move_ok(unsafe { heap_remove(command.data.bitmap).try_into() }) + } + CommandTag::BitVec => { + heap_move_ok(unsafe { heap_remove(command.data.bitvec).try_into() }) + } + CommandTag::BrightnessGrid => heap_move_ok(unsafe { + heap_remove(command.data.brightness_grid).try_into() + }), + CommandTag::CharGrid => heap_move_ok(unsafe { + heap_remove(command.data.char_grid).try_into() + }), + CommandTag::Cp437Grid => heap_move_ok(unsafe { + heap_remove(command.data.cp437_grid).try_into() + }), + CommandTag::GlobalBrightness => heap_move(unsafe { + heap_remove(command.data.global_brightness).into() + }), + CommandTag::Clear => { + heap_move(unsafe { heap_remove(command.data.clear).into() }) + } + CommandTag::HardReset => { + heap_move(unsafe { heap_remove(command.data.hard_reset).into() }) + } + CommandTag::FadeOut => { + heap_move(unsafe { heap_remove(command.data.fade_out).into() }) + } + CommandTag::BitmapLegacy => { + heap_move(unsafe { heap_remove(command.data.bitmap_legacy).into() }) + } + } +} diff --git a/src/commands/global_brightness_command.rs b/src/commands/global_brightness_command.rs new file mode 100644 index 0000000..063dea7 --- /dev/null +++ b/src/commands/global_brightness_command.rs @@ -0,0 +1,57 @@ +use crate::mem::{heap_clone, heap_drop, heap_move_nonnull, heap_remove}; +use servicepoint::{ + BitmapCommand, Brightness, GlobalBrightnessCommand, Packet, +}; +use std::ptr::NonNull; + +/// Set the brightness of all tiles to the same value. +/// +/// Returns: a new [GlobalBrightnessCommand] instance. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_brightness_global_new( + brightness: Brightness, +) -> NonNull { + heap_move_nonnull(GlobalBrightnessCommand::from(brightness)) +} + +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_brightness_global_into_packet( + command: NonNull, +) -> NonNull { + heap_move_nonnull(unsafe { heap_remove(command) }.into()) +} + +/// Clones an [GlobalBrightnessCommand] instance. +/// +/// returns: a new [GlobalBrightnessCommand] instance. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_brightness_global_clone( + command: NonNull, +) -> NonNull { + unsafe { heap_clone(command) } +} + +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_brightness_global_free( + command: NonNull, +) { + unsafe { heap_drop(command) } +} + +/// Moves the provided bitmap to be contained in the command. +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_brightness_global_set( + mut command: NonNull, + brightness: Brightness, +) { + unsafe { + command.as_mut().brightness = brightness; + } +} + +#[no_mangle] +pub unsafe extern "C" fn sp_cmd_brightness_global_get( + mut command: NonNull, +) -> *mut Brightness { + &mut unsafe { command.as_mut() }.brightness +} diff --git a/src/commands/mod.rs b/src/commands/mod.rs new file mode 100644 index 0000000..3cbb99a --- /dev/null +++ b/src/commands/mod.rs @@ -0,0 +1,15 @@ +mod bitmap_command; +mod bitvec_command; +mod brightness_grid_command; +mod cc_only_commands; +mod char_grid_command; +mod cp437_grid_command; +mod generic_command; +mod global_brightness_command; + +pub use bitmap_command::*; +pub use bitvec_command::*; +pub use brightness_grid_command::*; +pub use char_grid_command::*; +pub use cp437_grid_command::*; +pub use generic_command::*; diff --git a/src/bitmap.rs b/src/containers/bitmap.rs similarity index 84% rename from src/bitmap.rs rename to src/containers/bitmap.rs index 5db4af0..7a1b633 100644 --- a/src/bitmap.rs +++ b/src/containers/bitmap.rs @@ -1,7 +1,13 @@ -use crate::byte_slice::ByteSlice; -use crate::{heap_drop, heap_move, heap_move_nonnull, heap_remove, SPBitVec}; +use crate::{ + containers::ByteSlice, + mem::{ + heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_move_some, + heap_remove, + }, +}; use servicepoint::{ - Bitmap, BitmapCommand, CompressionCode, DataRef, Grid, Origin, Packet, + Bitmap, BitmapCommand, CompressionCode, DataRef, DisplayBitVec, Grid, + Origin, Packet, }; use std::ptr::NonNull; @@ -33,11 +39,7 @@ pub unsafe extern "C" fn sp_bitmap_new( width: usize, height: usize, ) -> *mut Bitmap { - if let Some(bitmap) = Bitmap::new(width, height) { - heap_move(bitmap) - } else { - std::ptr::null_mut() - } + heap_move_some(Bitmap::new(width, height)) } /// Creates a new [Bitmap] with a size matching the screen. @@ -63,11 +65,7 @@ pub unsafe extern "C" fn sp_bitmap_load( data: ByteSlice, ) -> *mut Bitmap { let data = unsafe { data.as_slice() }; - if let Ok(bitmap) = Bitmap::load(width, height, data) { - heap_move(bitmap) - } else { - std::ptr::null_mut() - } + heap_move_ok(Bitmap::load(width, height, data)) } /// Tries to convert the BitVec to a Bitmap. @@ -78,14 +76,10 @@ pub unsafe extern "C" fn sp_bitmap_load( #[no_mangle] pub unsafe extern "C" fn sp_bitmap_from_bitvec( width: usize, - bitvec: NonNull, + bitvec: NonNull, ) -> *mut Bitmap { let bitvec = unsafe { heap_remove(bitvec) }; - if let Ok(bitmap) = Bitmap::from_bitvec(width, bitvec.0) { - heap_move(bitmap) - } else { - std::ptr::null_mut() - } + heap_move_ok(Bitmap::from_bitvec(width, bitvec)) } /// Clones a [Bitmap]. @@ -93,7 +87,7 @@ pub unsafe extern "C" fn sp_bitmap_from_bitvec( pub unsafe extern "C" fn sp_bitmap_clone( bitmap: NonNull, ) -> NonNull { - heap_move_nonnull(unsafe { bitmap.as_ref().clone() }) + unsafe { heap_clone(bitmap) } } /// Deallocates a [Bitmap]. @@ -197,9 +191,9 @@ pub unsafe extern "C" fn sp_bitmap_unsafe_data_ref( #[no_mangle] pub unsafe extern "C" fn sp_bitmap_into_bitvec( bitmap: NonNull, -) -> NonNull { +) -> NonNull { let bitmap = unsafe { heap_remove(bitmap) }; - heap_move_nonnull(SPBitVec(bitmap.into())) + heap_move_nonnull(bitmap.into()) } /// Creates a [BitmapCommand] and immediately turns that into a [Packet]. @@ -215,12 +209,9 @@ pub unsafe extern "C" fn sp_bitmap_into_packet( compression: CompressionCode, ) -> *mut Packet { let bitmap = unsafe { heap_remove(bitmap) }; - match Packet::try_from(BitmapCommand { + heap_move_ok(Packet::try_from(BitmapCommand { bitmap, origin: Origin::new(x, y), compression, - }) { - Ok(packet) => heap_move(packet), - Err(_) => std::ptr::null_mut(), - } + })) } diff --git a/src/containers/bitvec.rs b/src/containers/bitvec.rs new file mode 100644 index 0000000..e9eeb68 --- /dev/null +++ b/src/containers/bitvec.rs @@ -0,0 +1,164 @@ +use crate::{ + containers::ByteSlice, + mem::{ + heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, + }, +}; +use servicepoint::{ + BinaryOperation, BitVecCommand, CompressionCode, DisplayBitVec, Packet, +}; +use std::ptr::NonNull; + +/// Creates a new [DisplayBitVec] instance. +/// +/// # Arguments +/// +/// - `size`: size in bits. +/// +/// returns: [DisplayBitVec] with all bits set to false. +/// +/// # Panics +/// +/// - when `size` is not divisible by 8. +#[no_mangle] +pub unsafe extern "C" fn sp_bitvec_new(size: usize) -> NonNull { + heap_move_nonnull(DisplayBitVec::repeat(false, size)) +} + +/// Interpret the data as a series of bits and load then into a new [DisplayBitVec] instance. +/// +/// returns: [DisplayBitVec] instance containing data. +#[no_mangle] +pub unsafe extern "C" fn sp_bitvec_load( + data: ByteSlice, +) -> NonNull { + let data = unsafe { data.as_slice() }; + heap_move_nonnull(DisplayBitVec::from_slice(data)) +} + +/// Clones a [DisplayBitVec]. +#[no_mangle] +pub unsafe extern "C" fn sp_bitvec_clone( + bit_vec: NonNull, +) -> NonNull { + unsafe { heap_clone(bit_vec) } +} + +/// Deallocates a [DisplayBitVec]. +#[no_mangle] +pub unsafe extern "C" fn sp_bitvec_free(bit_vec: NonNull) { + unsafe { heap_drop(bit_vec) } +} + +/// Gets the value of a bit from the [DisplayBitVec]. +/// +/// # Arguments +/// +/// - `bit_vec`: instance to read from +/// - `index`: the bit index to read +/// +/// returns: value of the bit +/// +/// # Panics +/// +/// - when accessing `index` out of bounds +#[no_mangle] +pub unsafe extern "C" fn sp_bitvec_get( + bit_vec: NonNull, + index: usize, +) -> bool { + unsafe { *bit_vec.as_ref().get(index).unwrap() } +} + +/// Sets the value of a bit in the [DisplayBitVec]. +/// +/// # Arguments +/// +/// - `bit_vec`: instance to write to +/// - `index`: the bit index to edit +/// - `value`: the value to set the bit to +/// +/// # Panics +/// +/// - when accessing `index` out of bounds +#[no_mangle] +pub unsafe extern "C" fn sp_bitvec_set( + bit_vec: NonNull, + index: usize, + value: bool, +) { + unsafe { (*bit_vec.as_ptr()).set(index, value) } +} + +/// Sets the value of all bits in the [DisplayBitVec]. +/// +/// # Arguments +/// +/// - `bit_vec`: instance to write to +/// - `value`: the value to set all bits to +#[no_mangle] +pub unsafe extern "C" fn sp_bitvec_fill( + bit_vec: NonNull, + value: bool, +) { + unsafe { (*bit_vec.as_ptr()).fill(value) } +} + +/// Gets the length of the [DisplayBitVec] in bits. +/// +/// # Arguments +/// +/// - `bit_vec`: instance to write to +#[no_mangle] +pub unsafe extern "C" fn sp_bitvec_len( + bit_vec: NonNull, +) -> usize { + unsafe { bit_vec.as_ref().len() } +} + +/// Returns true if length is 0. +/// +/// # Arguments +/// +/// - `bit_vec`: instance to write to +#[no_mangle] +pub unsafe extern "C" fn sp_bitvec_is_empty( + bit_vec: NonNull, +) -> bool { + unsafe { bit_vec.as_ref().is_empty() } +} + +/// Gets an unsafe reference to the data of the [DisplayBitVec] instance. +/// +/// The returned memory is valid for the lifetime of the bitvec. +/// +/// # Arguments +/// +/// - `bit_vec`: instance to write to +#[no_mangle] +pub unsafe extern "C" fn sp_bitvec_unsafe_data_ref( + bit_vec: NonNull, +) -> ByteSlice { + unsafe { ByteSlice::from_slice((*bit_vec.as_ptr()).as_raw_mut_slice()) } +} + +/// Creates a [BitVecCommand] and immediately turns that into a [Packet]. +/// +/// The provided [DisplayBitVec] gets consumed. +/// +/// Returns NULL in case of an error. +#[no_mangle] +pub unsafe extern "C" fn sp_bitvec_into_packet( + bitvec: NonNull, + offset: usize, + operation: BinaryOperation, + compression: CompressionCode, +) -> *mut Packet { + let bitvec = unsafe { heap_remove(bitvec) }; + heap_move_ok(Packet::try_from(BitVecCommand { + bitvec, + offset, + operation, + compression, + })) +} diff --git a/src/brightness_grid.rs b/src/containers/brightness_grid.rs similarity index 86% rename from src/brightness_grid.rs rename to src/containers/brightness_grid.rs index 1099be0..3a7ae5f 100644 --- a/src/brightness_grid.rs +++ b/src/containers/brightness_grid.rs @@ -1,4 +1,10 @@ -use crate::{heap_drop, heap_move, heap_move_nonnull, heap_remove, ByteSlice}; +use crate::{ + containers::ByteSlice, + mem::{ + heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_move_some, + heap_remove, + }, +}; use servicepoint::{ Brightness, BrightnessGrid, BrightnessGridCommand, ByteGrid, DataRef, Grid, Origin, Packet, @@ -12,15 +18,15 @@ use std::ptr::NonNull; /// /// # Examples /// ```C -/// UdpConnection connection = sp_udp_open("127.0.0.1:2342"); +/// UdpSocket *connection = sp_udp_open("127.0.0.1:2342"); /// if (connection == NULL) /// return 1; /// -/// BrightnessGrid grid = sp_brightness_grid_new(2, 2); +/// BrightnessGrid *grid = sp_brightness_grid_new(2, 2); /// sp_brightness_grid_set(grid, 0, 0, 0); /// sp_brightness_grid_set(grid, 1, 1, 10); /// -/// TypedCommand command = sp_command_char_brightness(grid); +/// TypedCommand *command = sp_command_char_brightness(grid); /// sp_udp_free(connection); /// ``` #[no_mangle] @@ -43,21 +49,18 @@ pub unsafe extern "C" fn sp_brightness_grid_load( data: ByteSlice, ) -> *mut BrightnessGrid { let data = unsafe { data.as_slice() }; - - match ByteGrid::load(width, height, data) - .map(move |grid| grid.map(Brightness::saturating_from)) - { - None => std::ptr::null_mut(), - Some(grid) => heap_move(grid), - } + heap_move_some( + ByteGrid::load(width, height, data) + .map(move |grid| grid.map(Brightness::saturating_from)), + ) } /// Clones a [BrightnessGrid]. #[no_mangle] pub unsafe extern "C" fn sp_brightness_grid_clone( - brightness_grid: NonNull, + grid: NonNull, ) -> NonNull { - heap_move_nonnull(unsafe { brightness_grid.as_ref().clone() }) + unsafe { heap_clone(grid) } } /// Deallocates a [BrightnessGrid]. @@ -187,11 +190,8 @@ pub unsafe extern "C" fn sp_brightness_grid_into_packet( y: usize, ) -> *mut Packet { let grid = unsafe { heap_remove(grid) }; - match Packet::try_from(BrightnessGridCommand { + heap_move_ok(Packet::try_from(BrightnessGridCommand { grid, origin: Origin::new(x, y), - }) { - Ok(packet) => heap_move(packet), - Err(_) => std::ptr::null_mut(), - } + })) } diff --git a/src/byte_slice.rs b/src/containers/byte_slice.rs similarity index 100% rename from src/byte_slice.rs rename to src/containers/byte_slice.rs diff --git a/src/char_grid.rs b/src/containers/char_grid.rs similarity index 88% rename from src/char_grid.rs rename to src/containers/char_grid.rs index bfb2585..3363d43 100644 --- a/src/char_grid.rs +++ b/src/containers/char_grid.rs @@ -1,4 +1,9 @@ -use crate::{heap_drop, heap_move, heap_move_nonnull, heap_remove, ByteSlice}; +use crate::{ + containers::ByteSlice, + mem::{ + heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_remove, + }, +}; use servicepoint::{CharGrid, CharGridCommand, Grid, Origin, Packet}; use std::ptr::NonNull; @@ -32,19 +37,15 @@ pub unsafe extern "C" fn sp_char_grid_load( data: ByteSlice, ) -> *mut CharGrid { let data = unsafe { data.as_slice() }; - if let Ok(grid) = CharGrid::load_utf8(width, height, data.to_vec()) { - heap_move(grid) - } else { - std::ptr::null_mut() - } + heap_move_ok(CharGrid::load_utf8(width, height, data.to_vec())) } /// Clones a [CharGrid]. #[no_mangle] pub unsafe extern "C" fn sp_char_grid_clone( - char_grid: NonNull, + grid: NonNull, ) -> NonNull { - heap_move_nonnull(unsafe { char_grid.as_ref().clone() }) + unsafe { heap_clone(grid) } } /// Deallocates a [CharGrid]. @@ -145,11 +146,8 @@ pub unsafe extern "C" fn sp_char_grid_into_packet( y: usize, ) -> *mut Packet { let grid = unsafe { heap_remove(grid) }; - match Packet::try_from(CharGridCommand { + heap_move_ok(Packet::try_from(CharGridCommand { grid, origin: Origin::new(x, y), - }) { - Ok(packet) => heap_move(packet), - Err(_) => std::ptr::null_mut(), - } + })) } diff --git a/src/cp437_grid.rs b/src/containers/cp437_grid.rs similarity index 88% rename from src/cp437_grid.rs rename to src/containers/cp437_grid.rs index ff70d2b..a636295 100644 --- a/src/cp437_grid.rs +++ b/src/containers/cp437_grid.rs @@ -1,4 +1,10 @@ -use crate::{heap_drop, heap_move, heap_move_nonnull, heap_remove, ByteSlice}; +use crate::{ + containers::ByteSlice, + mem::{ + heap_clone, heap_drop, heap_move_nonnull, heap_move_ok, heap_move_some, + heap_remove, + }, +}; use servicepoint::{ Cp437Grid, Cp437GridCommand, DataRef, Grid, Origin, Packet, }; @@ -23,20 +29,15 @@ pub unsafe extern "C" fn sp_cp437_grid_load( data: ByteSlice, ) -> *mut Cp437Grid { let data = unsafe { data.as_slice() }; - let grid = Cp437Grid::load(width, height, data); - if let Some(grid) = grid { - heap_move(grid) - } else { - std::ptr::null_mut() - } + heap_move_some(Cp437Grid::load(width, height, data)) } /// Clones a [Cp437Grid]. #[no_mangle] pub unsafe extern "C" fn sp_cp437_grid_clone( - cp437_grid: NonNull, + grid: NonNull, ) -> NonNull { - heap_move_nonnull(unsafe { cp437_grid.as_ref().clone() }) + unsafe { heap_clone(grid) } } /// Deallocates a [Cp437Grid]. @@ -147,11 +148,8 @@ pub unsafe extern "C" fn sp_cp437_grid_into_packet( y: usize, ) -> *mut Packet { let grid = unsafe { heap_remove(grid) }; - match Packet::try_from(Cp437GridCommand { + heap_move_ok(Packet::try_from(Cp437GridCommand { grid, origin: Origin::new(x, y), - }) { - Ok(packet) => heap_move(packet), - Err(_) => std::ptr::null_mut(), - } + })) } diff --git a/src/containers/mod.rs b/src/containers/mod.rs new file mode 100644 index 0000000..62d51d0 --- /dev/null +++ b/src/containers/mod.rs @@ -0,0 +1,13 @@ +mod bitmap; +mod bitvec; +mod brightness_grid; +mod byte_slice; +mod char_grid; +mod cp437_grid; + +pub use bitmap::*; +pub use bitvec::*; +pub use brightness_grid::*; +pub use byte_slice::*; +pub use char_grid::*; +pub use cp437_grid::*; diff --git a/src/lib.rs b/src/lib.rs index 60c42ab..377b2a0 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -9,7 +9,7 @@ //! #include "servicepoint.h" //! //! int main(void) { -//! UdpConnection *connection = sp_udp_open("172.23.42.29:2342"); +//! UdpSocket *connection = sp_udp_open("172.23.42.29:2342"); //! if (connection == NULL) //! return 1; //! @@ -25,48 +25,23 @@ //! } //! ``` -pub use crate::bitmap::*; -pub use crate::bitvec::*; -pub use crate::brightness_grid::*; -pub use crate::byte_slice::*; -pub use crate::char_grid::*; -pub use crate::cp437_grid::*; -pub use crate::packet::*; -pub use crate::typed_command::*; -pub use crate::udp::*; -pub use servicepoint::CommandCode; -use std::ptr::NonNull; - -mod bitmap; -mod bitvec; -mod brightness_grid; -mod byte_slice; -mod char_grid; -mod cp437_grid; -mod packet; -mod typed_command; -mod udp; +/// Functions related to commands. +pub mod commands; +/// Functions related to [servicepoint::Bitmap], [servicepoint::CharGrid] and friends. +pub mod containers; +pub(crate) mod mem; +/// Functions related to [Packet]. +pub mod packet; +/// Functions related to [UdpSocket]. +pub mod udp; use std::time::Duration; /// Actual hardware limit is around 28-29ms/frame. Rounded up for less dropped packets. pub const SP_FRAME_PACING_MS: u128 = Duration::from_millis(30).as_millis(); -pub(crate) fn heap_move(x: T) -> *mut T { - Box::into_raw(Box::new(x)) -} - -pub(crate) fn heap_move_nonnull(x: T) -> NonNull { - NonNull::from(Box::leak(Box::new(x))) -} - -pub(crate) unsafe fn heap_drop(x: NonNull) { - drop(unsafe { heap_remove(x) }); -} - -pub(crate) unsafe fn heap_remove(x: NonNull) -> T { - unsafe { *Box::from_raw(x.as_ptr()) } -} - /// This is a type only used by cbindgen to have a type for pointers. pub struct UdpSocket; + +/// This is a type only used by cbindgen to have a type for pointers. +pub struct DisplayBitVec; diff --git a/src/mem.rs b/src/mem.rs new file mode 100644 index 0000000..6555999 --- /dev/null +++ b/src/mem.rs @@ -0,0 +1,29 @@ +use std::ptr::NonNull; + +pub(crate) fn heap_move(x: T) -> *mut T { + Box::into_raw(Box::new(x)) +} + +pub(crate) fn heap_move_nonnull(x: T) -> NonNull { + NonNull::from(Box::leak(Box::new(x))) +} + +pub(crate) fn heap_move_ok(x: Result) -> *mut T { + x.map(|x| heap_move(x)).unwrap_or(std::ptr::null_mut()) +} + +pub(crate) fn heap_move_some(x: Option) -> *mut T { + x.map(|x| heap_move(x)).unwrap_or(std::ptr::null_mut()) +} + +pub(crate) unsafe fn heap_drop(x: NonNull) { + drop(unsafe { heap_remove(x) }); +} + +pub(crate) unsafe fn heap_remove(x: NonNull) -> T { + unsafe { *Box::from_raw(x.as_ptr()) } +} + +pub(crate) unsafe fn heap_clone(source: NonNull) -> NonNull { + heap_move_nonnull(unsafe { source.as_ref().clone() }) +} diff --git a/src/packet.rs b/src/packet.rs index d8b1579..e9593c9 100644 --- a/src/packet.rs +++ b/src/packet.rs @@ -1,33 +1,17 @@ -use crate::{heap_drop, heap_move, heap_move_nonnull, heap_remove, ByteSlice}; -use servicepoint::{CommandCode, Header, Packet, TypedCommand}; +use crate::{ + containers::ByteSlice, + mem::{heap_clone, heap_drop, heap_move_nonnull, heap_move_ok}, +}; +use servicepoint::{CommandCode, Header, Packet}; use std::ptr::NonNull; -/// Turns a [TypedCommand] into a [Packet]. -/// The [TypedCommand] gets consumed. -/// -/// Returns NULL in case of an error. -#[no_mangle] -pub unsafe extern "C" fn sp_packet_from_command( - command: NonNull, -) -> *mut Packet { - let command = unsafe { heap_remove(command) }; - if let Ok(packet) = command.try_into() { - heap_move(packet) - } else { - std::ptr::null_mut() - } -} - /// Tries to load a [Packet] from the passed array with the specified length. /// /// returns: NULL in case of an error, pointer to the allocated packet otherwise #[no_mangle] pub unsafe extern "C" fn sp_packet_try_load(data: ByteSlice) -> *mut Packet { let data = unsafe { data.as_slice() }; - match servicepoint::Packet::try_from(data) { - Err(_) => std::ptr::null_mut(), - Ok(packet) => heap_move(packet), - } + heap_move_ok(servicepoint::Packet::try_from(data)) } /// Creates a raw [Packet] from parts. @@ -95,11 +79,13 @@ pub unsafe extern "C" fn sp_packet_serialize_to( } /// Clones a [Packet]. +/// +/// returns: a new [Packet] instance. #[no_mangle] pub unsafe extern "C" fn sp_packet_clone( packet: NonNull, ) -> NonNull { - heap_move_nonnull(unsafe { packet.as_ref().clone() }) + unsafe { heap_clone(packet) } } /// Deallocates a [Packet]. diff --git a/src/typed_command.rs b/src/typed_command.rs deleted file mode 100644 index 9e27540..0000000 --- a/src/typed_command.rs +++ /dev/null @@ -1,201 +0,0 @@ -use crate::{heap_drop, heap_move, heap_move_nonnull, SPBitVec}; -use servicepoint::{ - BinaryOperation, Bitmap, Brightness, BrightnessGrid, CharGrid, - CompressionCode, Cp437Grid, GlobalBrightnessCommand, Packet, TypedCommand, -}; -use std::ptr::NonNull; - -/// Tries to turn a [Packet] into a [TypedCommand]. -/// -/// The packet is deallocated in the process. -/// -/// Returns: pointer to new [TypedCommand] instance or NULL if parsing failed. -#[no_mangle] -pub unsafe extern "C" fn sp_command_try_from_packet( - packet: NonNull, -) -> *mut TypedCommand { - let packet = *unsafe { Box::from_raw(packet.as_ptr()) }; - match servicepoint::TypedCommand::try_from(packet) { - Err(_) => std::ptr::null_mut(), - Ok(command) => heap_move(command), - } -} - -/// Clones a [TypedCommand] instance. -/// -/// returns: new [TypedCommand] instance. -#[no_mangle] -pub unsafe extern "C" fn sp_command_clone( - command: NonNull, -) -> NonNull { - heap_move_nonnull(unsafe { command.as_ref().clone() }) -} - -/// Set all pixels to the off state. -/// -/// Does not affect brightness. -/// -/// Returns: a new [servicepoint::Command::Clear] instance. -/// -/// # Examples -/// -/// ```C -/// sp_udp_send_command(connection, sp_command_clear()); -/// ``` -#[no_mangle] -pub unsafe extern "C" fn sp_command_clear() -> NonNull { - heap_move_nonnull(servicepoint::ClearCommand.into()) -} - -/// Kills the udp daemon on the display, which usually results in a restart. -/// -/// Please do not send this in your normal program flow. -/// -/// Returns: a new [servicepoint::Command::HardReset] instance. -#[no_mangle] -pub unsafe extern "C" fn sp_command_hard_reset() -> NonNull { - heap_move_nonnull(servicepoint::HardResetCommand.into()) -} - -/// A yet-to-be-tested command. -/// -/// Returns: a new [servicepoint::Command::FadeOut] instance. -#[no_mangle] -pub unsafe extern "C" fn sp_command_fade_out() -> NonNull { - heap_move_nonnull(servicepoint::FadeOutCommand.into()) -} - -/// Set the brightness of all tiles to the same value. -/// -/// Returns: a new [servicepoint::Command::Brightness] instance. -#[no_mangle] -pub unsafe extern "C" fn sp_command_global_brightness( - brightness: Brightness, -) -> NonNull { - heap_move_nonnull(GlobalBrightnessCommand::from(brightness).into()) -} - -/// Set the brightness of individual tiles in a rectangular area of the display. -/// -/// The passed [BrightnessGrid] gets consumed. -/// -/// Returns: a new [servicepoint::Command::CharBrightness] instance. -#[no_mangle] -pub unsafe extern "C" fn sp_command_brightness_grid( - x: usize, - y: usize, - grid: NonNull, -) -> NonNull { - let grid = unsafe { *Box::from_raw(grid.as_ptr()) }; - let result = servicepoint::BrightnessGridCommand { - origin: servicepoint::Origin::new(x, y), - grid, - } - .into(); - heap_move_nonnull(result) -} - -/// Set pixel data starting at the pixel offset on screen. -/// -/// The screen will continuously overwrite more pixel data without regarding the offset, meaning -/// once the starting row is full, overwriting will continue on column 0. -/// -/// The [`BinaryOperation`] will be applied on the display comparing old and sent bit. -/// -/// `new_bit = old_bit op sent_bit` -/// -/// For example, [`BinaryOperation::Or`] can be used to turn on some pixels without affecting other pixels. -/// -/// The contained [`BitVecU8Msb0`] is always uncompressed. -#[no_mangle] -pub unsafe extern "C" fn sp_command_bitvec( - offset: usize, - bit_vec: NonNull, - compression: CompressionCode, - operation: BinaryOperation, -) -> *mut TypedCommand { - let bit_vec = unsafe { *Box::from_raw(bit_vec.as_ptr()) }; - let command = servicepoint::BitVecCommand { - offset, - operation, - bitvec: bit_vec.0, - compression, - } - .into(); - heap_move(command) -} - -/// Show codepage 437 encoded text on the screen. -/// -/// The passed [Cp437Grid] gets consumed. -/// -/// Returns: a new [servicepoint::Cp437GridCommand] instance. -#[no_mangle] -pub unsafe extern "C" fn sp_command_cp437_grid( - x: usize, - y: usize, - grid: NonNull, -) -> NonNull { - let grid = *unsafe { Box::from_raw(grid.as_ptr()) }; - let result = servicepoint::Cp437GridCommand { - origin: servicepoint::Origin::new(x, y), - grid, - } - .into(); - heap_move_nonnull(result) -} - -/// Show UTF-8 encoded text on the screen. -/// -/// The passed [CharGrid] gets consumed. -/// -/// Returns: a new [servicepoint::CharGridCommand] instance. -#[no_mangle] -pub unsafe extern "C" fn sp_command_char_grid( - x: usize, - y: usize, - grid: NonNull, -) -> NonNull { - let grid = unsafe { *Box::from_raw(grid.as_ptr()) }; - let result = servicepoint::CharGridCommand { - origin: servicepoint::Origin::new(x, y), - grid, - } - .into(); - heap_move_nonnull(result) -} - -/// Sets a window of pixels to the specified values. -/// -/// The passed [Bitmap] gets consumed. -/// -/// Returns: a new [servicepoint::BitmapCommand] instance. -#[no_mangle] -pub unsafe extern "C" fn sp_command_bitmap( - x: usize, - y: usize, - bitmap: NonNull, - compression: CompressionCode, -) -> *mut TypedCommand { - let bitmap = unsafe { *Box::from_raw(bitmap.as_ptr()) }; - let command = servicepoint::BitmapCommand { - origin: servicepoint::Origin::new(x, y), - bitmap, - compression, - } - .into(); - heap_move(command) -} - -/// Deallocates a [TypedCommand]. -/// -/// # Examples -/// -/// ```C -/// TypedCommand c = sp_command_clear(); -/// sp_command_free(c); -/// ``` -#[no_mangle] -pub unsafe extern "C" fn sp_command_free(command: NonNull) { - unsafe { heap_drop(command) } -} diff --git a/src/udp.rs b/src/udp.rs index f68aa16..7c2ab2f 100644 --- a/src/udp.rs +++ b/src/udp.rs @@ -1,17 +1,22 @@ -use crate::{heap_drop, heap_move, heap_remove}; -use servicepoint::{Header, Packet, TypedCommand, UdpSocketExt}; -use std::ffi::{c_char, CStr}; -use std::net::{Ipv4Addr, SocketAddrV4, UdpSocket}; -use std::ptr::NonNull; +use crate::{ + commands::{CommandTag, SPCommand}, + mem::{heap_drop, heap_move_ok, heap_remove}, +}; +use servicepoint::{Header, Packet, UdpSocketExt}; +use std::{ + ffi::{c_char, CStr}, + net::{Ipv4Addr, SocketAddrV4, UdpSocket}, + ptr::NonNull, +}; -/// Creates a new instance of [UdpConnection]. +/// Creates a new instance of [UdpSocket]. /// /// returns: NULL if connection fails, or connected instance /// /// # Examples /// /// ```C -/// UdpConnection connection = sp_udp_open("172.23.42.29:2342"); +/// UdpSocket connection = sp_udp_open("172.23.42.29:2342"); /// if (connection != NULL) /// sp_udp_send_command(connection, sp_command_clear()); /// ``` @@ -20,22 +25,18 @@ pub unsafe extern "C" fn sp_udp_open(host: NonNull) -> *mut UdpSocket { let host = unsafe { CStr::from_ptr(host.as_ptr()) } .to_str() .expect("Bad encoding"); - let connection = match UdpSocket::bind_connect(host) { - Err(_) => return std::ptr::null_mut(), - Ok(value) => value, - }; - heap_move(connection) + heap_move_ok(UdpSocket::bind_connect(host)) } -/// Creates a new instance of [UdpConnection]. +/// Creates a new instance of [UdpSocket]. /// /// returns: NULL if connection fails, or connected instance /// /// # Examples /// /// ```C -/// UdpConnection connection = sp_udp_open_ipv4(172, 23, 42, 29, 2342); +/// UdpSocket connection = sp_udp_open_ipv4(172, 23, 42, 29, 2342); /// if (connection != NULL) /// sp_udp_send_command(connection, sp_command_clear()); /// ``` @@ -48,14 +49,10 @@ pub unsafe extern "C" fn sp_udp_open_ipv4( port: u16, ) -> *mut UdpSocket { let addr = SocketAddrV4::new(Ipv4Addr::from([ip1, ip2, ip3, ip4]), port); - let connection = match UdpSocket::bind_connect(addr) { - Err(_) => return std::ptr::null_mut(), - Ok(value) => value, - }; - heap_move(connection) + heap_move_ok(UdpSocket::bind_connect(addr)) } -/// Sends a [Packet] to the display using the [UdpConnection]. +/// Sends a [Packet] to the display using the [UdpSocket]. /// /// The passed `packet` gets consumed. /// @@ -69,7 +66,7 @@ pub unsafe extern "C" fn sp_udp_send_packet( unsafe { connection.as_ref().send(&Vec::from(packet)) }.is_ok() } -/// Sends a [TypedCommand] to the display using the [UdpConnection]. +/// Sends a [SPCommand] to the display using the [UdpSocket]. /// /// The passed `command` gets consumed. /// @@ -83,13 +80,47 @@ pub unsafe extern "C" fn sp_udp_send_packet( #[no_mangle] pub unsafe extern "C" fn sp_udp_send_command( connection: NonNull, - command: NonNull, + command: SPCommand, ) -> bool { - let command = unsafe { heap_remove(command) }; - unsafe { connection.as_ref().send_command(command) }.is_some() + unsafe { + match command.tag { + CommandTag::Invalid => return false, + CommandTag::Bitmap => connection + .as_ref() + .send_command(heap_remove(command.data.bitmap)), + CommandTag::BitVec => connection + .as_ref() + .send_command(heap_remove(command.data.bitvec)), + CommandTag::BrightnessGrid => connection + .as_ref() + .send_command(heap_remove(command.data.brightness_grid)), + CommandTag::CharGrid => connection + .as_ref() + .send_command(heap_remove(command.data.char_grid)), + CommandTag::Cp437Grid => connection + .as_ref() + .send_command(heap_remove(command.data.cp437_grid)), + CommandTag::GlobalBrightness => connection + .as_ref() + .send_command(heap_remove(command.data.global_brightness)), + CommandTag::Clear => connection + .as_ref() + .send_command(heap_remove(command.data.clear)), + CommandTag::HardReset => connection + .as_ref() + .send_command(heap_remove(command.data.hard_reset)), + CommandTag::FadeOut => connection + .as_ref() + .send_command(heap_remove(command.data.fade_out)), + CommandTag::BitmapLegacy => connection + .as_ref() + .send_command(heap_remove(command.data.bitmap_legacy)), + } + } + .is_some() } -/// Sends a [Header] to the display using the [UdpConnection]. +/// Sends a [Header] to the display using the [UdpSocket]. /// /// returns: true in case of success /// @@ -112,7 +143,7 @@ pub unsafe extern "C" fn sp_udp_send_header( .is_ok() } -/// Closes and deallocates a [UdpConnection]. +/// Closes and deallocates a [UdpSocket]. #[no_mangle] pub unsafe extern "C" fn sp_udp_free(connection: NonNull) { unsafe { heap_drop(connection) }