#include "meta.h" #include "../coding/coding.h" static STREAMFILE* setup_jade_streamfile(STREAMFILE *streamFile, off_t subfile_offset, size_t subfile_size, const char* fake_ext); static int get_loop_points(STREAMFILE *streamFile, int *out_loop_start, int *out_loop_end); /* Jade RIFF - from Ubisoft Jade engine games [Beyond Good & Evil (multi), Rayman Raving Rabbids 1/2 (multi)] */ VGMSTREAM * init_vgmstream_ubi_jade(STREAMFILE *streamFile) { VGMSTREAM * vgmstream = NULL; off_t start_offset, first_offset = 0xc; off_t fmt_offset, data_offset; size_t fmt_size, data_size; int loop_flag, channel_count, sample_rate, codec, block_size; int loop_start = 0, loop_end = 0; int is_jade_v2 = 0; /* checks */ /* .waa: ambiances, .wam: music, .wac: sfx, .wad: dialogs (usually) * .wav: Beyond Good & Evil HD (PS3), .psw: fake/badly extracted names [ex. Rayman Raving Rabbids (PS2)] */ if (!check_extensions(streamFile,"waa,wac,wad,wam,wav,lwav,psw")) goto fail; /* a slightly twisted RIFF with custom codecs */ if (read_32bitBE(0x00,streamFile) != 0x52494646 || /* "RIFF" */ read_32bitBE(0x08,streamFile) != 0x57415645) /* "WAVE" */ goto fail; if (check_extensions(streamFile,"psw")) { /* .psw are incorrectly extracted missing 0x04 at the end */ if (read_32bitLE(0x04,streamFile)+0x04 != get_streamfile_size(streamFile)) goto fail; } else { if (read_32bitLE(0x04,streamFile)+0x04+0x04 != get_streamfile_size(streamFile)) goto fail; } if (!find_chunk(streamFile, 0x666d7420,first_offset,0, &fmt_offset,&fmt_size, 0, 0)) /* "fmt " */ goto fail; if (!find_chunk(streamFile, 0x64617461,first_offset,0, &data_offset,&data_size, 0, 0)) /* "data" */ goto fail; /* ignore LyN RIFF (needed as codec 0xFFFE is reused) */ { off_t fact_offset; size_t fact_size; if (find_chunk(streamFile, 0x66616374,first_offset,0, &fact_offset,&fact_size, 0, 0)) { /* "fact" */ if (fact_size == 0x10 && read_32bitBE(fact_offset+0x04, streamFile) == 0x4C794E20) /* "LyN " */ goto fail; /* parsed elsewhere */ /* Jade doesn't use "fact", though */ } } /* parse format */ { if (fmt_size < 0x10) goto fail; codec = (uint16_t)read_16bitLE(fmt_offset+0x00,streamFile); channel_count = read_16bitLE(fmt_offset+0x02,streamFile); sample_rate = read_32bitLE(fmt_offset+0x04,streamFile); block_size = (uint16_t)read_16bitLE(fmt_offset+0x0c,streamFile); /* 0x08: average bytes, 0x0e: bps, etc */ /* autodetect Jade "v2", uses a different interleave [Rayman Raving Rabbids (PS2/Wii)] */ switch(codec) { case 0xFFFF: { /* PS2 */ int i; /* half interleave check as there is no flag (ends with the PS-ADPCM stop frame) */ for (i = 0; i < channel_count; i++) { off_t end_frame = data_offset + (data_size / channel_count) * (i+1) - 0x10; if (read_32bitBE(end_frame+0x00,streamFile) != 0x07007777 || read_32bitBE(end_frame+0x04,streamFile) != 0x77777777 || read_32bitBE(end_frame+0x08,streamFile) != 0x77777777 || read_32bitBE(end_frame+0x0c,streamFile) != 0x77777777) { is_jade_v2 = 1; break; } } break; } case 0xFFFE: /* GC/Wii */ is_jade_v2 = (read_16bitLE(fmt_offset+0x10,streamFile) == 0); /* extra data size (0x2e*channels) */ break; } /* hopefully catches PC Rabbids */ if (find_chunk(streamFile, 0x63756520,first_offset,0, NULL,NULL, 0, 0)) { /* "cue " */ is_jade_v2 = 1; } } /* get loop points */ if (is_jade_v2) { loop_flag = get_loop_points(streamFile, &loop_start, &loop_end); /* loops in "LIST" */ } else { /* BG&E files don't contain looping information, so the looping is done by extension. * wam and waa contain ambient sounds and music, so often they contain looped music. * Later, if the file is too short looping will be disabled. */ loop_flag = check_extensions(streamFile,"waa,wam"); } start_offset = data_offset; /* build the VGMSTREAM */ vgmstream = allocate_vgmstream(channel_count,loop_flag); if (!vgmstream) goto fail; vgmstream->sample_rate = sample_rate; vgmstream->meta_type = meta_UBI_JADE; if (is_jade_v2) { vgmstream->loop_start_sample = loop_start; vgmstream->loop_end_sample = loop_end; } switch(codec) { case 0x0069: /* Xbox */ /* Peter Jackson's King Kong uses 0x14 (other versions don't) */ if (fmt_size != 0x12 && fmt_size != 0x14) goto fail; if (block_size != 0x24*channel_count) goto fail; vgmstream->coding_type = coding_XBOX_IMA; vgmstream->layout_type = layout_none; vgmstream->num_samples = xbox_ima_bytes_to_samples(data_size, channel_count); if (!is_jade_v2) { vgmstream->loop_start_sample = 0; vgmstream->loop_end_sample = vgmstream->num_samples; } break; case 0xFFFF: /* PS2 */ if (fmt_size != 0x12) goto fail; if (block_size != 0x10) goto fail; vgmstream->coding_type = coding_PSX; vgmstream->layout_type = layout_interleave; if (is_jade_v2) { vgmstream->interleave_block_size = 0x6400; if (vgmstream->interleave_block_size) vgmstream->interleave_last_block_size = (data_size % (vgmstream->interleave_block_size*vgmstream->channels)) / vgmstream->channels; } else { vgmstream->interleave_block_size = data_size / channel_count; } vgmstream->num_samples = ps_bytes_to_samples(data_size, channel_count); if (!is_jade_v2) { vgmstream->loop_start_sample = 0; vgmstream->loop_end_sample = vgmstream->num_samples; } break; case 0xFFFE: /* GC/Wii */ if (fmt_size != 0x12) goto fail; if (block_size != 0x08) goto fail; vgmstream->coding_type = coding_NGC_DSP; vgmstream->layout_type = layout_interleave; vgmstream->num_samples = dsp_bytes_to_samples(data_size, channel_count); if (!is_jade_v2) { vgmstream->loop_start_sample = 0; vgmstream->loop_end_sample = vgmstream->num_samples; } /* coefs / interleave */ if (is_jade_v2) { vgmstream->interleave_block_size = 0x6400; if (vgmstream->interleave_block_size) vgmstream->interleave_last_block_size = ((data_size % (vgmstream->interleave_block_size*vgmstream->channels))/2+7)/8*8; { static const int16_t coef[16] = { /* default Ubisoft coefs, from ELF */ 0x04ab,0xfced,0x0789,0xfedf,0x09a2,0xfae5,0x0c90,0xfac1, 0x084d,0xfaa4,0x0982,0xfdf7,0x0af6,0xfafa,0x0be6,0xfbf5 }; int i, ch; for (ch = 0; ch < channel_count; ch++) { for (i = 0; i < 16; i++) { vgmstream->ch[ch].adpcm_coef[i] = coef[i]; } } } } else { /* has extra 0x2e coefs before each channel, not counted in data_size */ vgmstream->interleave_block_size = (data_size + 0x2e*channel_count) / channel_count; dsp_read_coefs_be(vgmstream, streamFile, start_offset+0x00, vgmstream->interleave_block_size); dsp_read_hist_be (vgmstream, streamFile, start_offset+0x20, vgmstream->interleave_block_size); start_offset += 0x2e; } break; case 0x0002: /* PC */ if (fmt_size != 0x12) goto fail; if (block_size != 0x24*channel_count) goto fail; vgmstream->coding_type = coding_MSADPCM; vgmstream->layout_type = layout_none; vgmstream->interleave_block_size = 0x24*channel_count; vgmstream->num_samples = msadpcm_bytes_to_samples(data_size, vgmstream->interleave_block_size, channel_count); if (!is_jade_v2) { vgmstream->loop_start_sample = 0; vgmstream->loop_end_sample = vgmstream->num_samples; } break; case 0x0001: { /* PS3 */ VGMSTREAM *temp_vgmstream = NULL; STREAMFILE *temp_streamFile = NULL; if (fmt_size != 0x10) goto fail; if (block_size != 0x02*channel_count) goto fail; /* a MSF (usually ATRAC3) masquerading as PCM */ if (read_32bitBE(start_offset, streamFile) != 0x4D534643) /* "MSF\43" */ goto fail; temp_streamFile = setup_jade_streamfile(streamFile, start_offset, data_size, "msf"); if (!temp_streamFile) goto fail; temp_vgmstream = init_vgmstream_ps3_msf(temp_streamFile); close_streamfile(temp_streamFile); if (!temp_vgmstream) goto fail; temp_vgmstream->meta_type = vgmstream->meta_type; close_vgmstream(vgmstream); return temp_vgmstream; } default: /* X360 uses .XMA */ goto fail; } /* V1 loops by extension, try to detect incorrectly looped jingles (too short) */ if (!is_jade_v2) { if(loop_flag && vgmstream->num_samples < 15*sample_rate) { /* in seconds */ vgmstream->loop_flag = 0; } } if ( !vgmstream_open_stream(vgmstream,streamFile,start_offset) ) goto fail; return vgmstream; fail: close_vgmstream(vgmstream); return NULL; } /* extract loops from "cue /LIST", returns if loops (info from Droolie) */ static int get_loop_points(STREAMFILE *streamFile, int *out_loop_start, int *out_loop_end) { off_t cue_offset, list_offset; size_t cue_size, list_size; off_t offset, first_offset = 0x0c; int i, cue_count, loop_id = 0, loop_start = 0, loop_end = 0; /* unlooped files may contain LIST, but also may not */ if (!find_chunk(streamFile, 0x63756520,first_offset,0, &cue_offset,&cue_size, 0, 0)) /* "cue " */ goto fail; if (!find_chunk(streamFile, 0x4C495354,first_offset,0, &list_offset,&list_size, 0, 0)) /* "LIST" */ goto fail; offset = list_offset + 0x04; while (offset < list_offset + list_size) { uint32_t chunk_id = read_32bitBE(offset+0x00, streamFile); uint32_t chunk_size = read_32bitLE(offset+0x04, streamFile); offset += 0x08; switch(chunk_id) { case 0x6C61626C: /* "labl" */ if (read_32bitBE(offset+0x04, streamFile) == 0x6C6F6F70) /* "loop", actually an string tho */ loop_id = read_32bitLE(offset+0x00, streamFile); chunk_size += (chunk_size % 2) ? 1 : 0; /* string is even-padded after size */ break; case 0x6C747874: /* "ltxt" */ if (loop_id == read_32bitLE(offset+0x00, streamFile)) loop_end = read_32bitLE(offset+0x04, streamFile); break; default: VGM_LOG("Jade: unknown LIST chunk\n"); goto fail; } offset += chunk_size; } if (!loop_end) return 0; cue_count = read_32bitLE(cue_offset+0x00, streamFile); for (i = 0; i < cue_count; i++) { if (loop_id == read_32bitLE(cue_offset+0x04 + i*0x18 + 0x00, streamFile)) { loop_start = read_32bitLE(cue_offset+0x04 + i*0x18 + 0x04, streamFile); loop_end += loop_start; break; } } *out_loop_start = loop_start; *out_loop_end = loop_end; return 1; fail: return 0; } /* Jade RIFF in containers */ VGMSTREAM * init_vgmstream_ubi_jade_container(STREAMFILE *streamFile) { VGMSTREAM *vgmstream = NULL; STREAMFILE *temp_streamFile = NULL; off_t subfile_offset; size_t subfile_size; /* Jade packs files in bigfiles, and once extracted the sound files have extra engine data before * the RIFF + padding after. Most extractors don't remove the padding correctly, so here we add support. */ /* checks */ /* standard Jade exts + .xma for padded XMA used in Beyond Good & Evil HD (X360) */ if (!check_extensions(streamFile,"waa,wac,wad,wam,wav,lwav,xma")) goto fail; if (read_32bitBE(0x04,streamFile) == 0x52494646 && read_32bitLE(0x00,streamFile)+0x04 == get_streamfile_size(streamFile)) { /* data size + RIFF + padding */ subfile_offset = 0x04; } else if (read_32bitBE(0x00,streamFile) == 0x52494646 && read_32bitLE(0x04,streamFile)+0x04+0x04 < get_streamfile_size(streamFile) && (get_streamfile_size(streamFile) + 0x04) % 0x800 == 0) { /* RIFF + padding with data size removed (bad extraction) */ subfile_offset = 0x00; } else if (read_32bitBE(0x04,streamFile) == 0x52494646 && read_32bitLE(0x00,streamFile) == get_streamfile_size(streamFile)) { /* data_size + RIFF + padding - 0x04 (bad extraction) */ subfile_offset = 0x04; } else { goto fail; } subfile_size = read_32bitLE(subfile_offset+0x04,streamFile) + 0x04+0x04; temp_streamFile = setup_jade_streamfile(streamFile, subfile_offset,subfile_size, NULL); if (!temp_streamFile) goto fail; if (check_extensions(streamFile,"xma")) { vgmstream = init_vgmstream_xma(temp_streamFile); } else { vgmstream = init_vgmstream_ubi_jade(temp_streamFile); } close_streamfile(temp_streamFile); return vgmstream; fail: close_streamfile(temp_streamFile); close_vgmstream(vgmstream); return NULL; } static STREAMFILE* setup_jade_streamfile(STREAMFILE *streamFile, off_t subfile_offset, size_t subfile_size, const char* fake_ext) { STREAMFILE *temp_streamFile = NULL, *new_streamFile = NULL; /* setup subfile */ new_streamFile = open_wrap_streamfile(streamFile); if (!new_streamFile) goto fail; temp_streamFile = new_streamFile; new_streamFile = open_clamp_streamfile(temp_streamFile, subfile_offset,subfile_size); if (!new_streamFile) goto fail; temp_streamFile = new_streamFile; if (fake_ext) { new_streamFile = open_fakename_streamfile(temp_streamFile, NULL,fake_ext); if (!new_streamFile) goto fail; temp_streamFile = new_streamFile; } return temp_streamFile; fail: close_streamfile(temp_streamFile); return NULL; }