summaryrefslogtreecommitdiffstats
path: root/src/file_xm.c
blob: f33172efe249355f6078576b71e8f174022753b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
/*

    File: file_xm.c

    Copyright (C) 2007 Christophe GRENIER <grenier@cgsecurity.org>
    Copyright (C) 2007 Christophe GISQUET <christophe.gisquet@free.fr>

    This software 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 2 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, write the Free Software Foundation, Inc., 51
    Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

 */

#if !defined(SINGLE_FORMAT) || defined(SINGLE_FORMAT_xm)
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#ifdef HAVE_STRING_H
#include <string.h>
#endif
#include <stdio.h>
#include "types.h"
#include "common.h"
#include "filegen.h"
#include "log.h"

/*@ requires valid_register_header_check(file_stat); */
static void register_header_check_xm(file_stat_t *file_stat);

const file_hint_t file_hint_xm = {
  .extension = "xm",
  .description = "FastTrackerII Extended Module",
  .max_filesize = PHOTOREC_MAX_FILE_SIZE,
  .recover = 1,
  .enable_by_default = 1,
  .register_header_check = &register_header_check_xm
};

struct xm_hdr
{
  uint16_t patterns;
  uint16_t instrs;
} __attribute__ ((gcc_struct, __packed__));

/*@
  @ requires \valid(fr);
  @ requires valid_file_recovery(fr);
  @ requires \separated(fr, fr->handle, fr->extension, &errno, &Frama_C_entropy_source);
  @ ensures \valid(fr->handle);
  @ assigns *fr->handle, errno, fr->file_size;
  @ assigns Frama_C_entropy_source;
  @*/
static int parse_patterns(file_recovery_t *fr, uint16_t patterns)
{
  /*@
    @ loop assigns *fr->handle, errno, fr->file_size;
    @ loop assigns Frama_C_entropy_source;
    @ loop assigns patterns;
    @*/
  for(; patterns != 0; patterns--)
  {
    char buffer[sizeof(uint32_t)];
    const uint16_t *p16 = (const uint16_t *)&buffer;
    const uint32_t *p32 = (const uint32_t *)&buffer;
    uint32_t header_size;
    uint16_t data_size;
    if(fread(&buffer, sizeof(uint32_t), 1, fr->handle) != 1)
      return -1;
#if defined(__FRAMAC__)
    Frama_C_make_unknown(&buffer, sizeof(uint32_t));
#endif
    header_size = le32(*p32);
#ifndef __FRAMAC__
    log_debug("xm: pattern header of size %u\n", (unsigned int)header_size);
#endif
    /* Never seen any xm having anything but 9 here */
    if(header_size != 9)
      return -1;

    /* Packing type + row count skipped */
    if(fseek(fr->handle, 1 + 2, SEEK_CUR) == -1)
      return -1;
    if(fread(&buffer, sizeof(uint16_t), 1, fr->handle) != 1)
      return -1;
#if defined(__FRAMAC__)
    Frama_C_make_unknown(&buffer, sizeof(uint16_t));
#endif
    data_size = le16(*p16);
#ifndef __FRAMAC__
    log_debug("xm: pattern data of size %u\n", data_size);
#endif

    if(fseek(fr->handle, data_size, SEEK_CUR) == -1)
      return -1;
    fr->file_size += (uint64_t)header_size + data_size;
    if(fr->file_size > PHOTOREC_MAX_FILE_SIZE)
      return -1;
  }
  return 0;
}

/*@
  @ requires \valid(fr);
  @ requires valid_file_recovery(fr);
  @ requires \separated(fr, fr->handle, fr->extension, &errno, &Frama_C_entropy_source);
  @ ensures \valid(fr->handle);
  @ assigns *fr->handle, errno, fr->file_size;
  @ assigns Frama_C_entropy_source;
  @*/
static int parse_instruments(file_recovery_t *fr, uint16_t instrs)
{
  /*@
    @ loop assigns *fr->handle, errno, fr->file_size;
    @ loop assigns Frama_C_entropy_source;
    @ loop assigns instrs;
    @*/
  for(; instrs != 0; instrs--)
  {
    char buffer[sizeof(uint32_t)];
    const uint16_t *p16 = (const uint16_t *)&buffer;
    const uint32_t *p32 = (const uint32_t *)&buffer;
    uint16_t samples;
    uint32_t size;

    if(fread(&buffer, sizeof(uint32_t), 1, fr->handle) != 1)
      return -1;
#if defined(__FRAMAC__)
    Frama_C_make_unknown(&buffer, sizeof(uint32_t));
#endif

    size = le32(*p32);
#ifndef __FRAMAC__
    log_debug("xm: instrument header of size %u\n", (unsigned int)size);
#endif
    if(size < 29)
      return -1;

    /* Fixed string + type skipped               *
     * @todo Verify that fixed string is ASCII ? */
    if(fseek(fr->handle, 22 + 1, SEEK_CUR) == -1)
      return -1;

    if(fread(&buffer, sizeof(uint16_t), 1, fr->handle) != 1)
      return -1;
#if defined(__FRAMAC__)
    Frama_C_make_unknown(&buffer, sizeof(uint16_t));
#endif
    samples = le16(*p16);
#ifndef __FRAMAC__
    log_debug("xm: instrument with %u samples\n", samples);
#endif

    fr->file_size += size;
    if(fr->file_size > PHOTOREC_MAX_FILE_SIZE)
      return -1;
    /* Never seen any xm having anything but 263 when there are samples */
    if(samples > 0)
    {
      if(size != 263)
      {
#ifndef __FRAMAC__
        log_debug("xm: UNEXPECTED HEADER SIZE OF %u, "
                  " PLEASE REPORT THE FILE!\n",
                  (unsigned int)size);
#endif
        return -1;
      }

      /* 2ndary header skipped */
      if(fseek(fr->handle, 234, SEEK_CUR) == -1)
        return -1;

      /*@ loop assigns samples, size, *fr->handle, errno, Frama_C_entropy_source, fr->file_size, buffer[0..3]; */
      for(; samples != 0; samples--)
      {
        if(fread(&buffer, sizeof(uint32_t), 1, fr->handle) != 1)
          return -1;
#if defined(__FRAMAC__)
        Frama_C_make_unknown(&buffer, sizeof(uint32_t));
#endif
        size = le32(*p32);
#ifndef __FRAMAC__
        log_debug("xm: sample with length of %u\n", (unsigned int)size);
#endif

        /* Skip remaining of sample header            *
         * @todo Verify that last 22 bytes are ASCII? */
        if(fseek(fr->handle, (uint64_t)36 + size, SEEK_CUR) == -1)
          return -1;

        fr->file_size += (uint64_t)40 + size;
        if(fr->file_size > PHOTOREC_MAX_FILE_SIZE)
          return -1;
      }
    }
    /* No sample, account for garbage */
    else if(fseek(fr->handle, size - 29, SEEK_CUR) == -1)
      return -1;
  }
  return 0;
}

/*@
  @ requires fr->file_check == &file_check_xm;
  @ requires valid_file_check_param(fr);
  @ ensures  valid_file_check_result(fr);
  @ assigns *fr->handle, fr->file_size, fr->offset_error;
  @ assigns Frama_C_entropy_source, errno;
  @*/
static void file_check_xm(file_recovery_t *fr)
{
  char buffer[4];
  const struct xm_hdr *hdr=(const struct xm_hdr *)&buffer;
  uint16_t patterns, instrs;

  fr->file_size = 0;
  fr->offset_error = 0;

  if(fseek(fr->handle, 70, SEEK_SET) == -1)
    return;
  if(fread(&buffer, sizeof(buffer), 1, fr->handle) != 1)
    return;
#if defined(__FRAMAC__)
  Frama_C_make_unknown(&buffer, sizeof(buffer));
#endif
  instrs = le16(hdr->instrs);
  patterns = le16(hdr->patterns);

#ifndef __FRAMAC__
  log_debug("xm: %u patterns, %u instruments\n", patterns, instrs);
#endif

  /* Skip flags + tempo + bmp + table */
  if(fseek(fr->handle, 2 + 2 + 2 + 256, SEEK_CUR) == -1)
    return;
  fr->file_size = 336;

  /* Parse patterns and next instruments */
  if(parse_patterns(fr, patterns) < 0 || parse_instruments(fr, instrs) < 0)
  {
#ifndef __FRAMAC__
    log_debug("xm: lost sync at pos %li\n", ftell(fr->handle));
#endif
    fr->offset_error = fr->file_size;
    fr->file_size = 0;
    return;
  }
  /* ModPlug may insert additional data but it is of little relevance */
}

/*@
  @ requires separation: \separated(&file_hint_xm, buffer+(..), file_recovery, file_recovery_new);
  @ requires valid_header_check_param(buffer, buffer_size, safe_header_only, file_recovery, file_recovery_new);
  @ ensures  valid_header_check_result(\result, file_recovery_new);
  @ assigns  *file_recovery_new;
  @*/
static int header_check_xm(const unsigned char *buffer, const unsigned int buffer_size, const unsigned int safe_header_only, const file_recovery_t *file_recovery, file_recovery_t *file_recovery_new)
{
  reset_file_recovery(file_recovery_new);
  file_recovery_new->extension = file_hint_xm.extension;
  file_recovery_new->min_filesize = 336 + 29; /* Header + 1 instrument */
  file_recovery_new->file_check = &file_check_xm;
  return 1;
}

static void register_header_check_xm(file_stat_t *file_stat)
{
  static const unsigned char xm_header[17] = { 'E', 'x', 't', 'e', 'n', 'd', 'e', 'd', ' ', 'M', 'o', 'd', 'u', 'l', 'e', ':', ' ' };
  register_header_check(0, xm_header, sizeof(xm_header), &header_check_xm, file_stat);
}
#endif