chiark / gitweb /
Some of these interface comments are out of date
[ypp-sc-tools.db-test.git] / pctb / ocr.h
index 26bccbc..df6aaf8 100644 (file)
@@ -1,34 +1,71 @@
+/*
+ * ocr.c forms a mostly-self-contained bit
+ * so we put its declarations in this separate file
+ */
+/*
+ *  This is part of ypp-sc-tools, a set of third-party tools for assisting
+ *  players of Yohoho Puzzle Pirates.
+ * 
+ *  Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+ * 
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ * 
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ * 
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ *  Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
+ *  are used without permission.  This program is not endorsed or
+ *  sponsored by Three Rings.
+ */
+
 #ifndef OCR_H
 #define OCR_H
 
-#include <pam.h>
-#include <stdint.h>
-#include <inttypes.h>
-#include <assert.h>
+#include "common.h"
+
 #include <string.h>
+#include <stdio.h>
+#include <errno.h>
+#include <assert.h>
+#include <stdint.h>
 #include <stdlib.h>
-#include <sys/types.h>
+#include <unistd.h>
+#include <inttypes.h>
+
 #include <sys/wait.h>
 
+
 typedef uint32_t Pixcol;
 #define PSPIXCOL(priscan) priscan##32
 
 typedef struct {
   const char *s; /* valid until next call to ocr() */
   int l,r; /* column numbers */
-  int ctx; /* match context index */
+  unsigned ctxmap; /* match context index */
 } OcrResultGlyph;
 
-OcrResultGlyph *ocr(int w, int h, Pixcol cols[]);
+
+typedef const struct OcrCellTypeInfo *OcrCellType;
+extern const struct OcrCellTypeInfo ocr_celltype_text;
+extern const struct OcrCellTypeInfo ocr_celltype_number;
+const char *ocr_celltype_name(OcrCellType ct);
+
+
+typedef struct OcrReader OcrReader;
+OcrReader *ocr_init(int h);
+
+OcrResultGlyph *ocr(OcrReader *rd, OcrCellType, int w, Pixcol cols[]);
   /* return value is array terminated by {0,-1,-1}
    * array is valid until next call to ocr()
    */
 
-void ocr_init(void);
-
-void debug_flush(void);
-
-#define eassert assert
-#define debug stdout
 
 #endif /*OCR_H*/