clean up, change name

Author: RepellantMold

CMakeLists.txt

@@ -1,14 +1,14 @@
 cmake_minimum_required(VERSION 3.0)
 
 
-project(S3M2STM)
+project(SCREAMVERTER)
 set(CMAKE_C_STANDARD 99)
 set(CMAKE_C_EXTENSIONS OFF)
 
-add_executable(s3m2stm src/main.c)
+add_executable(screamverter src/main.c)
 # https://stackoverflow.com/a/50882216
 if(MSVC)
-  target_compile_options(s3m2stm PRIVATE /W4)
+  target_compile_options(screamverter PRIVATE /W4)
 else()
-  target_compile_options(s3m2stm PRIVATE -Wall -Wextra -Wpedantic -Werror -march=native)
+  target_compile_options(screamverter PRIVATE -Wall -Wextra -Wpedantic -Werror -march=native)
 endif()

README.md

@@ -1,8 +1,8 @@
-# s3m2stm
+# Screamverter
 
 [![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=plastic)](https://github.com/RichardLitt/standard-readme)
 
-A command line tool to downgrade Scream Tracker 3 modules to Scream Tracker 2 (and Scream Tracker Music Interface Kit) modules, written in C99.
+A command line tool to downgrade (that being a **very heavy keyword**) Scream Tracker 3 modules to Scream Tracker 2 modules, written in C99.
 
 ## Table of Contents
 
@@ -14,7 +14,7 @@ A command line tool to downgrade Scream Tracker 3 modules to Scream Tracker 2 (a
 ## Usage
 
 ```sh
-./s3m2stm input.s3m output.stm
+./screamverter [-s] input.s3m output.stm
 ```
 
 > [!IMPORTANT]
@@ -23,7 +23,7 @@ A command line tool to downgrade Scream Tracker 3 modules to Scream Tracker 2 (a
 > - 4 channels preferably (it only converts the first four channels.)
 > - Sample sizes cannot exceed 65535 (and no 16-bit samples.)
 > - No panning or Adlib, Scream Tracker 2/Scream Tracker Music Interface Kit is mono.
-> - Sample names are gonna be truncated heavily to 8.3 filenames, mainly for the purposes of being able to save it to disk.
+> - Sample names are gonna truncated heavily to 12 characters if its file name field is blank.
 > - You can only use effects A - J, with some caveats with the table shown below.
 > 
 > | Effect | Function in ST2/STMIK - in ST3/others | Notes/Quirks (Effect memory **does not exist** in Scream Tracker 2, so a parameter of 0 will act like a no-op for any effect that normally has it. (e.g. volume slide, portamento slides, vibrato, etc.)) |

src/main.c

@@ -1,5 +1,5 @@
 /*
- * s3m2stm
+ * Screamverter
  * Made by RepellantMold/cs127 under ISC license
  *
  * Written in C99
@@ -27,19 +27,13 @@
 enum FOC_ReturnCode
 {
   FOC_SUCCESS         = 0x00,
-
   FOC_OPEN_FAILURE    = 0x01,
   FOC_NOT_S3M_FILE    = 0x02,
   FOC_MALFORMED_FILE  = 0x04,
   FOC_CONV_FAILURE    = 0x08,
-
   FOC_ALLOC_FAIL      = 0x10,
-
   FOC_NO_INPUT        = 0x20,
-
-
   FOC_NO_FILENAMES    = 0x40,
-
   FOC_CONVERSION_FAIL = 0x80,
 };
 
@@ -60,20 +54,6 @@ u16 fgetw(FILE *fp)
     return (data[1] << 8) | data[0];
 }
 
-/*
-u32 fgetl(FILE *fp)
-{
-    u8 data[4];
-
-    data[0] = (u8)fgetc(fp);
-    data[1] = (u8)fgetc(fp);
-    data[2] = (u8)fgetc(fp);
-    data[3] = (u8)fgetc(fp);
-
-    return (data[3] << 24) | (data[2] << 16) | (data[1] << 8) | data[0];
-}
-*/
-
 void eprintf(const char* format, ...) {
   va_list ap;
 
@@ -119,7 +99,7 @@ void warning_printf(const char* format, ...) {
 }
 
 void print_help(void) {
-  puts("Usage: s3m2stm [options] <inputfile> <outputfile>");
+  puts("Usage: screamverter [options] <inputfile> <outputfile>");
   puts("(C) RepellantMold/cs127, 2024");
   puts("Licensed under ISC");
   puts("");
@@ -128,7 +108,7 @@ void print_help(void) {
   puts("  -v, --verbose    Enable extremely verbose output");
   puts("  -s, --sanitize   Sanitize sample names during conversion, useful for saving them on DOS");
   puts("  -stm             Convert the S3M to STM (default)");
-  puts("  -stx             Convert the S3M to STX");
+  puts("  -stx             Convert the S3M to STX (not implemented yet)");
 }
 
 void handle_sample_headers_s3mtostm(FOC_Context* context, usize sample_count);
@@ -364,6 +344,6 @@ bool check_valid_s3m(FILE *S3Mfile) {
 
 int convert_s3m_to_stx(FOC_Context* context) {
   (void)context;
-  printf("TODO!\n");
+  printf("This is not implemented yet.\n");
   return FOC_SUCCESS;
 }

src/main.h

@@ -31,6 +31,5 @@ void warning_puts(const char* msg);
 void warning_printf(const char* format, ...);
 
 static u16 fgetw(FILE *fp);
-//static u32 fgetl(FILE *fp);
 
 #endif