Code refactor and fix for #41 (#42)

Author: bil0u

.gitignore

@@ -1,2 +1,12 @@
-*~
-/m1ddc
+# IDE related files
+.idea/
+.vscode/
+
+# Default C exclusions
+*.o
+*.a
+
+# Project specific files & directories
+.objects/
+library/
+m1ddc

Makefile

@@ -1,2 +1,128 @@
-all: $
-	clang -fmodules -o m1ddc m1ddc.m
+# -- VARIABLES
+
+# Project name
+NAME =		m1ddc
+LIB = 		lib$(NAME)
+
+# Compiler
+CC =		clang
+CFLAGS =	-Wall -Werror -Wextra -fmodules
+CPPFLAGS =	-I $(INC_DIR)
+DEPFLAGS =	-MMD
+
+# Libraries
+LDLIBS =	-framework CoreDisplay
+
+# Commands
+RM =		rm -f
+RMDIR =		rm -rf
+MKDIR =		mkdir -p
+MAKE =		make -C
+AR =		ar -rcs
+
+# Paths
+INC_DIR =	headers
+SRC_DIR =	sources
+LIB_DIR =	library
+BIN_DIR =	/usr/local/bin
+
+# Sources & Objects - Binary
+SOURCES =	i2c \
+			ioregistry \
+			m1ddc \
+
+OBJ_DIR =	.objects
+OBJECTS = 	$(patsubst %,$(OBJ_DIR)/%,$(SOURCES:=.o))
+
+# Sources & Objects - Library
+LIB_SRCS = 	$(filter-out m1ddc, $(SOURCES))
+LIB_OBJS = 	$(patsubst %,$(OBJ_DIR)/%,$(LIB_SRCS:=.o))
+LIB_HDRS = 	$(patsubst %,$(INC_DIR)/%,$(LIB_SRCS:=.h))
+
+# -- IMPLICIT RULES / LINKING
+
+$(OBJ_DIR)/%.o: $(SRC_DIR)/%.m Makefile
+	@$(CC) -c $< -o $@ $(CPPFLAGS) $(CFLAGS) $(DEPFLAGS)
+
+$(OBJ_DIR):
+	@$(MKDIR) $(OBJ_DIR)
+
+$(LIB_DIR):
+	@$(MKDIR) $(LIB_DIR)
+
+$(NAME): $(OBJ_DIR) $(OBJECTS)
+	@$(CC) $(LDLIBS) $(OBJECTS) -o $@
+	@printf "Created binary \"$(NAME)\"\n"
+
+$(LIB).a: $(LIB_DIR) $(OBJ_DIR) $(LIB_OBJS)
+	@$(AR) $(LIB_DIR)/$@ $(LIB_OBJS)
+	@printf "Created library \"$(LIB_DIR)/$@\"\n"
+
+# For each header file, we do the following, using regular expressions:
+# - Ignore the #ifndef _FILE/# define _FILE/#endif directives that begin/end the file
+# - Extract the #import directives
+# - Extract all the remaining # directives
+# - Extract the rest: types and functions declarations.
+# All the extracted lines are then appendend to the final header file.
+$(LIB).h: $(LIB_DIR) $(LIB_HDRS)
+	@imports=""; \
+	directives=""; \
+	declarations=""; \
+	for file in $(LIB_HDRS); do \
+		declarations="$$declarations\n\n/*\n * -- $$(basename $$file .h | tr '[:lower:]' '[:upper:]')\n*/\n"; \
+		fileguard=$$(echo "_$$(basename $$file .h | tr '[:lower:]' '[:upper:]')_H"); \
+		if [ "$$(head -n 1 $$file)" = "#ifndef $$fileguard" ]; then \
+			filecontent=$$(sed -e '1,2d' -e '$$d' $$file); \
+		else \
+			filecontent=$$(cat $$file); \
+		fi; \
+		imports="$$imports\n$$(echo "$$filecontent" | grep -E "^#\s*import" | sort | uniq)"; \
+		directives="$$directives\n$$(echo "$$filecontent" | grep -E "^#" | grep -vE "^#\s*import" | grep -vE "^#\s*include\s*\".*.h\"$$" )"; \
+		declarations="$$declarations\n$$(echo "$$filecontent" | grep -vE "^#" )"; \
+	done; \
+	guard=$$(echo "_$(LIB)_H" | tr '[:lower:]' '[:upper:]'); \
+	printf "#ifndef $$guard\n# define $$guard\n\n" > $(LIB_DIR)/$@; \
+	printf "$$directives\n\n" >> $(LIB_DIR)/$@; \
+	printf "$$imports\n\n" >> $(LIB_DIR)/$@; \
+	printf "$$declarations\n\n" >> $(LIB_DIR)/$@; \
+	printf "#endif" >> $(LIB_DIR)/$@; \
+	sed -i '' -e '/^$$/N;/^\n$$/D' $(LIB_DIR)/$@; \
+
+	@printf "Created header \"$(LIB_DIR)/$@\"\n"
+
+# -- RULES
+
+.DEFAULT_GOAL := binary
+
+all: binary lib
+
+binary: $(NAME)
+
+lib: $(LIB).a $(LIB).h
+
+clean:
+	@if [ -e $(OBJ_DIR) ]; then \
+		$(RMDIR) $(OBJ_DIR); \
+		printf "Objects deleted\n"; \
+	fi;
+
+fclean: clean
+	@if [ -e $(NAME) ]; then \
+		$(RM) $(NAME); \
+		printf "Binary deleted\n"; \
+	fi;
+	@if [ -e $(LIB_DIR) ]; then \
+		$(RMDIR) $(LIB_DIR); \
+		printf "Library deleted\n"; \
+	fi;
+
+re: fclean all
+
+install:
+	/bin/mkdir -p $(BIN_DIR)
+	sudo /usr/bin/install -s -m 0755 $(NAME) $(BIN_DIR)
+
+.PHONY: all lib clean fclean re install
+
+-include $(OBJECTS:.o=.d)
+

README.md

@@ -86,10 +86,28 @@ DisplayPort 1: 15, DisplayPort 2: 16, HDMI 1: 17, HDMI 2: 18.
 
 `display list` - Lists displays.
 
-`display n` - Chooses which display to control (use number 1, 2 etc.)
+`display list detailed` - Lists displays and prints extra display attributes.
+
+`display n` - Chooses which display to control using the number (1, 2 etc.) provided by `display list`
+
+`display (id,uuid,edid,seid,basic,ext,full)=<identifier>` - Chooses which display to control using the number using a specific identification method. (If not set, it defaults to `uuid`). See identications methods for more details.
 
 You can also use 'l', 'v' instead of 'luminance', 'volume' etc.
 
+## Identification methods
+
+The following display identifcation methods are supported, and corresponds to the following strings
+
+- `id`: `<display_id>`
+- `uuid`: `<system_uuid>`
+- `edid`: `<edid_uuid>`
+- `seid`: `<alphnum_serial>:<edid_uuid>`.
+- `basic`: `<vendor>:<model>:<serial>`.
+- `ext`: `<vendor>:<model>:<serial>:<manufacturer>:<alphnum_serial>:<product_name>`.
+- `full`: `<vendor>:<model>:<serial>:<manufacturer>:<alphnum_serial>:<product_name>:<io_location>`.
+
+Required identifiers can be obtained using the `display list detailed` command
+
 ## Example use in a script
 
 Check out the following [hammerspoon](https://github.com/Hammerspoon/hammerspoon) script.

headers/i2c.h

@@ -0,0 +1,53 @@
+#ifndef _I2C_H
+# define _I2C_H
+
+# include "ioregistry.h"
+
+# define DEFAULT_INPUT_ADDRESS		0x51
+# define ALTERNATE_INPUT_ADDRESS	0x50
+
+# define LUMINANCE	0x10
+# define CONTRAST	0x12
+# define VOLUME		0x62
+# define MUTE		0x8D
+# define INPUT		0x60
+# define INPUT_ALT	0xF4			// Alternate address, used for LG exclusively?
+# define STANDBY	0xD6
+# define RED		0x16			// VCP Code - Video Gain (Drive): Red
+# define GREEN		0x18			// VCP Code - Video Gain (Drive): Green
+# define BLUE		0x1A			// VCP Code - Video Gain (Drive): Blue
+# define PBP_INPUT	0xE8
+# define PBP		0xE9
+
+# define DDC_WAIT			10000	// Depending on display this must be set to as high as 50000
+# define DDC_ITERATIONS		2		// Depending on display this must be set higher
+# define DDC_BUFFER_SIZE	256
+
+
+typedef struct {
+	UInt8 data[DDC_BUFFER_SIZE];
+	UInt8 inputAddr;
+} DDCPacket;
+
+typedef struct {
+	signed char curValue;
+	signed char maxValue;
+} DDCValue;
+
+
+DDCPacket	createDDCPacket(UInt8 attrCode);
+
+void		prepareDDCRead(UInt8 *data);
+void		prepareDDCWrite(UInt8 *data, UInt8 setValue);
+
+IOReturn	performDDCWrite(IOAVServiceRef avService, DDCPacket *packet);
+IOReturn	performDDCRead(IOAVServiceRef avService, DDCPacket *packet);
+
+DDCValue	convertI2CtoDDC(char *i2cBytes);
+
+// External functions
+
+extern IOReturn	IOAVServiceReadI2C(IOAVServiceRef service, uint32_t chipAddress, uint32_t offset, void *outputBuffer, uint32_t outputBufferSize);
+extern IOReturn IOAVServiceWriteI2C(IOAVServiceRef service, uint32_t chipAddress, uint32_t dataAddress, void *inputBuffer, uint32_t inputBufferSize);
+
+#endif

headers/ioregistry.h

@@ -0,0 +1,42 @@
+#ifndef _IOREGISTRY_H
+# define _IOREGISTRY_H
+
+# import <CoreGraphics/CoreGraphics.h>
+
+# ifndef MAX_DISPLAYS
+#  define MAX_DISPLAYS   4   // Set this to 2 or 4 depending on the Apple Silicon Mac you're using
+# endif
+
+# define UUID_SIZE      37
+
+// IOAVServiceRef is a private class, so we need to define it here
+typedef CFTypeRef IOAVServiceRef;
+
+// Base structure for display infos
+typedef struct
+{
+    CGDirectDisplayID id;
+    io_service_t adapter;
+    NSString *ioLocation;
+    NSString *uuid;
+    NSString *edid;
+    NSString *productName;
+    NSString *manufacturer;
+    NSString *alphNumSerial;
+    UInt32 serial;
+    UInt32 model;
+    UInt32 vendor;
+} DisplayInfos;
+
+CGDisplayCount  getOnlineDisplayInfos(DisplayInfos* displayInfos);
+DisplayInfos*   selectDisplay(DisplayInfos *displays, int connectedDisplays, char *displayIdentifier);
+
+IOAVServiceRef  getDefaultDisplayAVService();
+IOAVServiceRef  getDisplayAVService(DisplayInfos* displayInfos);
+
+// External functions
+extern IOAVServiceRef   IOAVServiceCreate(CFAllocatorRef allocator);
+extern IOAVServiceRef   IOAVServiceCreateWithService(CFAllocatorRef allocator, io_service_t service);
+extern CFDictionaryRef  CoreDisplay_DisplayCreateInfoDictionary(CGDirectDisplayID);
+
+#endif

headers/utils.h

@@ -0,0 +1,6 @@
+#ifndef _UTILS_H_
+# define _UTILS_H_
+
+# define STR_EQ(s1, s2) (strcmp(s1, s2) == 0)
+
+#endif