]> git.tdb.fi Git - ext/subsurface.git/blob - cochran.c
Fix up Cochran dive header decoding offset
[ext/subsurface.git] / cochran.c
1 #include <stdio.h>
2 #include <string.h>
3 #include <unistd.h>
4 #include <sys/types.h>
5 #include <sys/stat.h>
6 #include <fcntl.h>
7
8 #include "dive.h"
9 #include "file.h"
10
11 /*
12  * The Cochran file format is designed to be annoying to read. It's roughly:
13  *
14  * 0x00000: room for 65534 4-byte words, giving the starting offsets
15  *   of the dives themselves.
16  *
17  * 0x3fff8: the size of the file + 1
18  * 0x3ffff: 0 (high 32 bits of filesize? Bogus: the offsets into the file
19  *   are 32-bit, so it can't be a large file anyway)
20  *
21  * 0x40000: "block 0": the decoding block. The first byte is some random
22  *   value (0x46 in the files I have access to), the next 200+ bytes or so
23  *   are the "scrambling array" that needs to be added into the file
24  *   contents to make sense of them.
25  *
26  * The descrambling array seems to be of some random size which is likely
27  * determinable from the array somehow, the two test files I have it as
28  * 230 bytes and 234 bytes respectively.
29  */
30 static unsigned int partial_decode(unsigned int start, unsigned int end,
31                 const unsigned char *decode, unsigned offset, unsigned mod,
32                 const unsigned char *buf, unsigned int size, unsigned char *dst)
33 {
34         unsigned i, sum = 0;
35
36         for (i = start ; i < end; i++) {
37                 unsigned char d = decode[offset++];
38                 if (i >= size)
39                         break;
40                 if (offset == mod)
41                         offset = 0;
42                 d += buf[i];
43                 if (dst)
44                         dst[i] = d;
45                 sum += d;
46         }
47         return sum;
48 }
49
50 /*
51  * The decode buffer size can be figured out by simply trying our the
52  * decode: we expect that the scrambled contents are largely random, and
53  * thus tend to have half the bits set. Summing over the bytes is going
54  * to give an average of 0x80 per byte.
55  *
56  * The decoded array is mostly full of zeroes, so the sum is lower.
57  *
58  * Works for me.
59  */
60 static int figure_out_modulus(const unsigned char *decode, const unsigned char *dive, unsigned int size)
61 {
62         int mod, best = -1;
63         unsigned int min = ~0u;
64
65         if (size < 0x1000)
66                 return best;
67
68         for (mod = 50; mod < 300; mod++) {
69                 unsigned int sum;
70
71                 sum = partial_decode(0, 0x0fff, decode, 1, mod, dive, size, NULL);
72                 if (sum < min) {
73                         min = sum;
74                         best = mod;
75                 }
76         }
77         return best;
78 }
79
80 #define hexchar(n) ("0123456789abcdef"[(n)&15])
81
82 static int show_line(unsigned offset, const unsigned char *data, unsigned size, int show_empty)
83 {
84         unsigned char bits;
85         int i, off;
86         char buffer[120];
87
88         if (size > 16)
89                 size = 16;
90
91         bits = 0;
92         memset(buffer, ' ', sizeof(buffer));
93         off = sprintf(buffer, "%06x ", offset);
94         for (i = 0; i < size; i++) {
95                 char *hex = buffer + off + 3*i;
96                 char *asc = buffer + off + 50 + i;
97                 unsigned char byte = data[i];
98
99                 hex[0] = hexchar(byte>>4);
100                 hex[1] = hexchar(byte);
101                 bits |= byte;
102                 if (byte < 32 || byte > 126)
103                         byte = '.';
104                 asc[0] = byte;
105                 asc[1] = 0;
106         }
107
108         if (bits) {
109                 puts(buffer);
110                 return 1;
111         }
112         if (show_empty)
113                 puts("...");
114         return 0;
115 }
116
117 static void cochran_debug_write(const char *filename, const unsigned char *data, unsigned size)
118 {
119         int i, show = 1;
120
121         for (i = 0; i < size; i += 16)
122                 show = show_line(i, data + i, size - i, show);
123 }
124
125 static void parse_cochran_header(const char *filename,
126                 const unsigned char *decode, unsigned mod,
127                 const unsigned char *in, unsigned size)
128 {
129         char *buf = malloc(size);
130
131         /* Do the "null decode" using a one-byte decode array of '\0' */
132         partial_decode(0    , 0x0b14, "", 0, 1, in, size, buf);
133
134         /*
135          * The header scrambling is different form the dive
136          * scrambling. Oh yay!
137          */
138         partial_decode(0x010e, 0x0b14, decode, 0, mod, in, size, buf);
139         partial_decode(0x0b14, 0x1b14, decode, 0, mod, in, size, buf);
140         partial_decode(0x1b14, 0x2b14, decode, 0, mod, in, size, buf);
141         partial_decode(0x2b14, 0x3b14, decode, 0, mod, in, size, buf);
142         partial_decode(0x3b14, 0x5414, decode, 0, mod, in, size, buf);
143         partial_decode(0x5414,   size, decode, 0, mod, in, size, buf);
144
145         printf("\n%s, header\n\n", filename);
146         cochran_debug_write(filename, buf, size);
147
148         free(buf);
149 }
150
151 static void parse_cochran_dive(const char *filename, int dive,
152                 const unsigned char *decode, unsigned mod,
153                 const unsigned char *in, unsigned size)
154 {
155         char *buf = malloc(size);
156
157         /*
158          * The scrambling has odd boundaries. I think the boundaries
159          * match some data structure size, but I don't know. They were
160          * discovered the same way we dynamically discover the decode
161          * size: automatically looking for least random output.
162          *
163          * The boundaries are also this confused "off-by-one" thing,
164          * the same way the file size is off by one. It's as if the
165          * cochran software forgot to write one byte at the beginning.
166          */
167         partial_decode(0     , 0x0fff, decode, 1, mod, in, size, buf);
168         partial_decode(0x0fff, 0x1fff, decode, 0, mod, in, size, buf);
169         partial_decode(0x1fff, 0x2fff, decode, 0, mod, in, size, buf);
170         partial_decode(0x2fff, 0x48ff, decode, 0, mod, in, size, buf);
171
172         /*
173          * This is not all the descrambling you need - the above are just
174          * what appears to be the fixed-size blocks. The rest is also
175          * scrambled, but there seems to be size differences in the data,
176          * so this just descrambles part of it:
177          */
178         partial_decode(0x48ff, 0x4a14, decode, 0, mod, in, size, buf);
179         partial_decode(0x4a14, 0xc9bd, decode, 0, mod, in, size, buf);
180         partial_decode(0xc9bd,   size, decode, 0, mod, in, size, buf);
181
182         printf("\n%s, dive %d\n\n", filename, dive);
183         cochran_debug_write(filename, buf, size);
184
185         free(buf);
186 }
187
188 int try_to_open_cochran(const char *filename, struct memblock *mem, GError **error)
189 {
190         unsigned int i;
191         unsigned int mod;
192         unsigned int *offsets, dive1, dive2;
193         unsigned char *decode = mem->buffer + 0x40001;
194
195         if (mem->size < 0x40000)
196                 return 0;
197         offsets = mem->buffer;
198         dive1 = offsets[0];
199         dive2 = offsets[1];
200         if (dive1 < 0x40000 || dive2 < dive1 || dive2 > mem->size)
201                 return 0;
202
203         mod = figure_out_modulus(decode, mem->buffer + dive1, dive2 - dive1);
204
205         parse_cochran_header(filename, decode, mod, mem->buffer + 0x40000, dive1 - 0x40000);
206
207         for (i = 0; i < 65534; i++) {
208                 dive1 = offsets[i];
209                 dive2 = offsets[i+1];
210                 if (dive2 < dive1)
211                         break;
212                 if (dive2 > mem->size)
213                         break;
214                 parse_cochran_dive(filename, i+1, decode, mod, mem->buffer + dive1, dive2 - dive1);
215         }
216
217         exit(0);
218 }