summaryrefslogtreecommitdiffstats
path: root/src/file_wv.c
blob: 091ed7d25f55fef054c4e066f18ffb0d42d0cc0a (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
/*

    File: file_wv.c

    Copyright (C) 2008 Christophe GRENIER <grenier@cgsecurity.org>
  
    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_wv)
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#ifdef HAVE_STRING_H
#include <string.h>
#endif
#include <stdio.h>
#include "types.h"
#include "filegen.h"
#include "common.h"

/*@ requires \valid(file_stat); */
static void register_header_check_wv(file_stat_t *file_stat);

const file_hint_t file_hint_wv = {
  .extension = "wv",
  .description = "WavPack, Hybrid Lossless Wavefile Compressor",
  .max_filesize = 100 * 1024 * 1024,
  .recover = 1,
  .enable_by_default = 1,
  .register_header_check = &register_header_check_wv
};

/* See http://www.wavpack.com/file_format.txt for file format description */

static const unsigned char wv_header[4] = { 'w', 'v', 'p', 'k' };
typedef struct
{
  char ckID[4];           // "wvpk"
  uint32_t ckSize;        // size of entire block (minus 8, of course)
  uint16_t version;       // 0x402 to 0x410 are currently valid for decode
  unsigned char track_no; // track number (0 if not used, like now)
  unsigned char index_no; // track sub-index (0 if not used, like now)
  uint32_t total_samples; // total samples for entire file, but this is
                          // only valid if block_index == 0 and a value of
                          // -1 indicates unknown length
  uint32_t block_index;   // index of first sample in block relative to
                          // beginning of file (normally this would start
                          // at 0 for the first block)
  uint32_t block_samples; // number of samples in this block (0 = no audio)
  uint32_t flags;         // various flags for id and decoding
  uint32_t crc;           // crc for actual decoded data
} WavpackHeader;

/*@
  @ requires buffer_size > 0;
  @ requires (buffer_size&1)==0;
  @ requires \valid_read(buffer+(0..buffer_size-1));
  @ requires \valid(file_recovery);
  @ requires file_recovery->data_check==&data_check_wv;
  @ requires \separated(buffer + (..), file_recovery);
  @ ensures \result == DC_CONTINUE || \result == DC_STOP;
  @ assigns file_recovery->calculated_file_size;
  @*/
static data_check_t data_check_wv(const unsigned char *buffer, const unsigned int buffer_size, file_recovery_t *file_recovery)
{
  /*@ loop assigns file_recovery->calculated_file_size; */
  while(file_recovery->calculated_file_size + buffer_size / 2 >= file_recovery->file_size && file_recovery->calculated_file_size + 16 <= file_recovery->file_size + buffer_size / 2)
  {
    const unsigned int i = file_recovery->calculated_file_size + buffer_size / 2 - file_recovery->file_size;
    /*@ assert 0 <= i <= buffer_size - 16; */
    const WavpackHeader *wv = (const WavpackHeader *)&buffer[i];
    if(memcmp(wv, wv_header, sizeof(wv_header)) == 0)
    {
      file_recovery->calculated_file_size += (uint64_t)8 + le32(wv->ckSize);
    }
    else if(buffer[i] == 'A' && buffer[i + 1] == 'P' && buffer[i + 2] == 'E' && buffer[i + 3] == 'T' && buffer[i + 4] == 'A' && buffer[i + 5] == 'G' && buffer[i + 6] == 'E' && buffer[i + 7] == 'X')
    { /* APE Tagv2 (APE Tagv1 has no header) http://wiki.hydrogenaudio.org/index.php?title=APE_Tags_Header */
      const uint64_t ape_tag_size = (buffer[i + 12] + (buffer[i + 13] << 8) + (buffer[i + 14] << 16) + ((uint64_t)buffer[i + 15] << 24)) + 32;
      file_recovery->calculated_file_size += ape_tag_size;
    }
    else if(buffer[i] == 'T' && buffer[i + 1] == 'A' && buffer[i + 2] == 'G')
    { /* http://www.id3.org/ID3v1 TAGv1 size = 128 bytes with header "TAG" */
      file_recovery->calculated_file_size += 128;
    }
    else if(file_recovery->calculated_file_size > file_recovery->file_size)
    {
      return DC_CONTINUE;
    }
    else
    {
      return DC_STOP;
    }
  }
  return DC_CONTINUE;
}

/*@
  @ requires buffer_size >= sizeof(WavpackHeader);
  @ requires \valid_read(buffer+(0..buffer_size-1));
  @ requires valid_file_recovery(file_recovery);
  @ requires \valid(file_recovery_new);
  @ requires file_recovery_new->blocksize > 0;
  @ requires separation: \separated(&file_hint_wv, buffer+(..), file_recovery, file_recovery_new);
  @ ensures  \result!=0 ==> valid_file_recovery(file_recovery_new);
  @ assigns  *file_recovery_new;
  @*/
static int header_check_wv(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)
{
  const WavpackHeader *wv = (const WavpackHeader *)buffer;
  const uint32_t ckSize = le32(wv->ckSize);
  if(le32(wv->block_index) != 0)
    return 0;
  if(sizeof(WavpackHeader) > (uint64_t)ckSize + 8)
    return 0;
  reset_file_recovery(file_recovery_new);
  file_recovery_new->extension = file_hint_wv.extension;
  file_recovery_new->min_filesize = (uint64_t)ckSize + 8;
  if(file_recovery_new->blocksize < 8)
    return 1;
  file_recovery_new->data_check = &data_check_wv;
  file_recovery_new->file_check = &file_check_size;
  return 1;
}

static void register_header_check_wv(file_stat_t *file_stat)
{
  register_header_check(0, wv_header, sizeof(wv_header), &header_check_wv, file_stat);
}
#endif