Merge remote-tracking branch 'upstream/master'

Author: uli42

.travis.yml

@@ -8,6 +8,10 @@ env:
  - CABALVER=1.22 GHCVER=7.10.1
  - CABALVER=head GHCVER=head   # see section about GHC HEAD snapshots
 
+matrix:
+  allow_failures:
+    - env: CABALVER=head GHCVER=head
+
 # Note: the distinction between `before_install` and `install` is not important.
 before_install:
  - travis_retry sudo add-apt-repository -y ppa:hvr/ghc

Changelog.md

@@ -0,0 +1,35 @@
+# Changelog for tttool
+
+## 1.4 (2015-04-29)
+
+ * The `tttool play` command is greatly enhanced:
+   + Audio samples are actually played (On linux, install `sox`).
+   + You can use the name of your scripts instead of the OID codes.
+   + The prompt supports a persistent history (press ↑).
+   + You can tab-complete your input.
+ * `tttool` knows its own version.
+ * `tttool assemble` warns if the comment field is too long for the GME file.
+
+## 1.3 (2015-03-18)
+
+ * The `tttool play` command now supports jump commands.
+
+## 1.2 (2015-03-08)
+
+ * The `language` fields takes arbitrary strings, which will hopefully be
+   understood by the text-to-speak engine.
+
+## 1.1 (2015-02-15)
+
+ * The yaml files support a `language` field, specifying the default language
+   for the text-to-speech feature.
+ * The `speak` section of the yaml file can have subsections with differing
+   languge settings, to allow multi-language files.
+ * The text-to-speech feature will use either pico2wave or espeak, depending on
+   what is available.
+ * The windows release zipfile now comes with espeak and oggenc, so Windows users
+   can use text-to-speech out of the box.
+
+## 1.0 (2015-01-29)
+
+ * Last release without a changelog

Makefile

@@ -1,5 +1,7 @@
-tttool: tttool.hs
-	ghc -O -with-rtsopts=-K100M  tttool.hs
+tttool: src/*.hs
+	# cabal update
+	cabal install --only-dependencies
+	cabal install --bindir=.
 
 all: tttool libtiptoi gameanalyse makegraphic
 

README.md

@@ -15,9 +15,7 @@ you to dissect these files.
 The tool can also be used to generate completely new files from scratch; see
 below for details.
 
-If you want to learn more, here are some relevant links:
- * Discussion about Tip-Toi: http://www.quadrierer.de/geekythinking/blog/?itemid=368 (German)
- * Discussion about Tip-Toi and the related TING pen, including discussion on how to print your own books: http://www.mikrocontroller.net/topic/214479 (German)
+If you want to learn more please have a look into our wiki (https://github.com/entropia/tip-toi-reveng/wiki).
 
 The tttool tool
 ---------------
@@ -58,7 +56,7 @@ supports various subcommands:
            lists all unknown parts of the file.
         explain <file.gme>...
            lists all parts of the file, with description and hexdump.
-        play <file.gme>
+        play <file.gme or file.yaml>
            interactively play: Enter OIDs, and see what happens.
         rewrite <infile.gme> <outfile.gme>
            parses the file and serializes it again (for debugging).
@@ -102,7 +100,7 @@ Otherwise, installation from source is not difficult either:
     `cabal`, and you should run the two commands
 
         cabal update
-        cabal install --dependencies-only
+        cabal install --only-dependencies
 
  3. Now you can build the program using
 
@@ -153,7 +151,7 @@ things you did if you succeded.
 Text to speech
 --------------
 
-If you have libttspico-utils and vorbis-tools installed, you can have tttool
+If you have `libttspico-utils` and `vorbis-tools installed`, you can have tttool
 generate audio files from text for you, which makes developing your yaml file
 much easier. See [text2speech.yaml](text2speech.yaml) for more information.
 
@@ -194,5 +192,5 @@ Other resources in this repository
  * `matlab/` contains scripts to analyse gme files in Matlab
  * `wip/` (work in progess) contains notes about the parts of the gme files that are not
    fully understood yet.
-
+ * `perl-tools` contains a perl based script, to generate a PDF with all OID codes from a yaml-file as well some functions to generate PNG-files, inject pHYs-chunks with resolution hints into GD generated PNG files as result from some testing
 

example.yaml

@@ -5,7 +5,6 @@
 # ./tttool assemble example.yaml example.gme
 
 # The product ID must match that of the book you want to use this with
-# If you generate your own codes, then this corresponds to "tttool oid-code 272".
 product-id: 42
 
 # The media path is optional
@@ -32,7 +31,6 @@ welcome: bing, hello
 scripts:
   # We begin to specify what to do when the area in the book with the OID code
   # 8066 is touched.
-  # This corresponds to "tttool oid-code 3701", and so on for the next few codes.
   8066:
   # The following line means: If register $mode is set to 1, then set it to 2, and
   # increment register $1 by one, and play the sound example/hello.ogg.

gen-windows-release.sh

@@ -1,24 +1,58 @@
 #!/bin/bash
 
 set -e
-wine cabal install --bindir=.
+wine cabal install --distdir=dist-win --bindir=.
 (cd Audio/digits/; ./build.sh)
 
-rev=$(git describe --always)
-zipfile=tttool-win32-$rev.zip 
+rev=$(git describe --tags)
+zipfile=tttool-win32-$rev.zip
 rm -f $zipfile
 
-zip $zipfile \
+# Oggenc
+OGGENC=oggenc2.87-1.3.5-generic.zip
+
+mkdir -p contrib
+test -e contrib/$OGGENC ||
+    wget http://www.rarewares.org/files/ogg/$OGGENC -O contrib/$OGGENC
+unzip -d contrib contrib/$OGGENC oggenc2.exe
+mv contrib/oggenc2.exe contrib/oggenc.exe
+
+#SDL
+SDL=SDL-1.2.15-win32.zip
+SDLMIXER=SDL_mixer-1.2.12-win32.zip
+
+test -e contrib/$SDL ||
+    wget http://libsdl.org/release/$SDL -O contrib/$SDL
+unzip -o -d contrib contrib/$SDL
+test -e contrib/$SDLMIXER ||
+    wget https://www.libsdl.org/projects/SDL_mixer/release/$SDLMIXER -O contrib/$SDLMIXER
+unzip -o -d contrib contrib/$SDLMIXER
+
+cp -v playmus/playmus.exe contrib/playmus.exe
+
+# install espeak first in wine
+cp ~/.wine/drive_c/Programme/eSpeak/command_line/espeak.exe contrib/
+cp -r ~/.wine/drive_c/Programme/eSpeak/espeak-data/ contrib/
+
+zip --recurse-paths $zipfile \
 	tttool.exe \
 	README.md \
+	Changelog.md \
 	oid-decoder.html \
 	example \
 	example.yaml \
-	debug.yaml \
+	Debug.yaml \
 	oid-table.png \
 	templates/README.md \
 	templates/*.yaml \
 	transcript/*.csv \
 	wip/* \
-	Audio/digits/*.ogg
+	Audio/digits/*.ogg \
+        contrib/oggenc.exe \
+        contrib/espeak.exe \
+        contrib/espeak-data \
+        contrib/LICENSE* \
+        contrib/README-SDL.txt \
+	contrib/*.dll \
+	contrib/playmus.exe
 echo Created $zipfile

libtiptoi.c

@@ -186,6 +186,10 @@ GME_AUDIO_FILE_TABLE *createAudioTable(GME_FILE *gme, char *filepath,int useNumb
 		if (useNumbers){
 			sprintf(audioFileName,"%s/%04d.ogg", filepath, i);
 		}else{
+			if (fplist == NULL) {
+				fprintf(stderr,"Could not open file %s\n", filepath);
+				exit(1);
+			}
 			fscanf(fplist, "%s", audioFileName);
 		}
 		aft[i].offset = nextOffset;
@@ -209,10 +213,18 @@ void addAudioFiles(GME_FILE *gme, GME_AUDIO_FILE_TABLE *aft, uint8_t *data, char
 		if (useNumbers){
 			sprintf(audioFileName,"%s/%04d.ogg", filepath, i);
 		}else{
+			if (fplist == NULL) {
+				fprintf(stderr,"Could not open file %s\n", filepath);
+				exit(1);
+			}
 			fscanf(fplist, "%s", audioFileName);
 		}
 
 		fp = fopen(audioFileName, "rb");
+		if (fp == NULL) {
+			fprintf(stderr,"Could not open file %s\n", audioFileName);
+			return;
+		}
 		fread(cpos, 1, aft[i].lenght, fp);
 		fclose(fp);
 		for (j = 0; j < aft[i].lenght; j++){
@@ -259,7 +271,7 @@ GME_AUDIO_SCRIPT *readFilelist(char *filelist, uint32_t firstOffset){
 	fseek(fp, 0, SEEK_SET);
 
 	if ((gas = malloc(sizeof(GME_AUDIO_SCRIPT))) == NULL || (gas->data = malloc(filesize+1)) == NULL){
-		fprintf(stderr, "Could not allocate memory\n", filelist);
+		fprintf(stderr, "Could not allocate memory: %d\n", filesize+1);
 		exit(1);
 	}
 	gas->fileCount = 0;
@@ -316,6 +328,8 @@ GME_AUDIO_SCRIPT *readFilelist(char *filelist, uint32_t firstOffset){
 			}
 		}
 	}
+	
+	return gas;
 }
 
 //Replace audio files with files from given list
@@ -348,13 +362,17 @@ void replaceAudio(char *inputfile, char *outputfile, char *filepath, int useNumb
 	*((uint32_t*)dataPos) = calculateChecksum(data, dataPos-data);
 
 	fp = fopen(outputfile, "wb");
+	if (fp == NULL) {
+		fprintf(stderr,"Could not open file %s for writing\n", outputfile);
+		exit(1);
+	}
 	fwrite(data, 1, dataLength, fp);
 	fclose(fp);
 }
 
 //Exports all audio files and creates a filelist.txt with every filename
 //for use by replace functionality
-int exportAudioFiles(char *inputfile, char *path, int filelistOnly){
+void exportAudioFiles(char *inputfile, char *path, int filelistOnly){
 	GME_FILE *gme = readFile(inputfile);
 	char filename[1024];
 	uint8_t *file;
@@ -368,7 +386,7 @@ int exportAudioFiles(char *inputfile, char *path, int filelistOnly){
 	sprintf(filename, "%sfilelist.txt", path);
 	if ((fplist = fopen(filename, "wb")) == NULL){
 		fprintf(stderr, "Could not open outputfile '%s'", filename);
-		exit(0);
+		exit(1);
 	}
 	for (i = 0; i < gme->audioFileTableEntries; i++){
 		duplicate = 0;
@@ -452,7 +470,7 @@ void printInformation(char *inputfile, FILE *out){
 	uint32_t jumpTableOffset;
 	uint32_t *gjt;
 	uint16_t elements;
-	fprintf(out,"Filesize: %d\n", gme->filesize);
+	fprintf(out,"Filesize: %ld\n", gme->filesize);
 	fprintf(out,"File checksum: 0x%0X\n", gme->checksum);
 	fprintf(out,"Calc checksum: 0x%0X\n", calculateChecksum(gme->data, gme->filesize - 4));
 	fprintf(out,"XOR value: 0x%0X\n", gme->xor);