cog/Frameworks/GME/gme/Spc_Emu.cpp

465 lines
12 KiB
C++

// Game_Music_Emu $vers. http://www.slack.net/~ant/
#include "Spc_Emu.h"
#include "blargg_endian.h"
/* Copyright (C) 2004-2009 Shay Green. This module is free software; you
can redistribute it and/or modify it under the terms of the GNU Lesser
General Public License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version. This
module 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 Lesser General Public License for more
details. You should have received a copy of the GNU Lesser General Public
License along with this module; if not, write to the Free Software Foundation,
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */
#include "blargg_source.h"
// TODO: support Spc_Filter's bass
Spc_Emu::Spc_Emu()
{
set_type( gme_spc_type );
set_gain( 1.4 );
enable_filter( false );
enable_echo( true );
}
Spc_Emu::~Spc_Emu() { }
// Track info
int const trailer_offset = 0x10200;
inline byte const* Spc_Emu::trailer_() const { return &file_begin() [min( file_size(), trailer_offset )]; }
inline int Spc_Emu::trailer_size_() const { return max( 0, file_size() - trailer_offset ); }
static void get_spc_xid6( byte const begin [], int size, track_info_t* out )
{
// header
byte const* end = begin + size;
if ( size < 8 || memcmp( begin, "xid6", 4 ) )
{
check( false );
return;
}
int info_size = get_le32( begin + 4 );
byte const* in = begin + 8;
if ( end - in > info_size )
{
dprintf( "SPC: Extra data after xid6\n" );
end = in + info_size;
}
int year = 0;
char copyright [256 + 5];
int copyright_len = 0;
int const year_len = 5;
int disc = 0, track = 0;
while ( end - in >= 4 )
{
// header
int id = in [0];
int data = in [3] * 0x100 + in [2];
int type = in [1];
int len = type ? data : 0;
in += 4;
if ( len > end - in )
{
dprintf( "SPC: xid6 goes past end" );
break; // block goes past end of data
}
// handle specific block types
char* field = NULL;
switch ( id )
{
case 0x01: field = out->song; break;
case 0x02: field = out->game; break;
case 0x03: field = out->author; break;
case 0x04: field = out->dumper; break;
case 0x07: field = out->comment; break;
case 0x10: field = out->ost; break;
case 0x11: disc = data; break;
case 0x12: track = data; break;
case 0x14: year = data; break;
//case 0x30: // intro length
// Many SPCs have intro length set wrong for looped tracks, making it useless
/*
case 0x30:
check( len == 4 );
if ( len >= 4 )
{
out->intro_length = get_le32( in ) / 64;
if ( out->length > 0 )
{
int loop = out->length - out->intro_length;
if ( loop >= 2000 )
out->loop_length = loop;
}
}
break;
*/
case 0x33:
check( len == 4 );
if ( len >= 4 )
{
out->fade_length = get_le32( in ) / 64;
}
break;
case 0x13:
copyright_len = min( len, (int) sizeof copyright - year_len );
memcpy( &copyright [year_len], in, copyright_len );
break;
default:
if ( id < 0x01 || (id > 0x07 && id < 0x10) ||
(id > 0x14 && id < 0x30) || id > 0x36 )
dprintf( "SPC: Unknown xid6 block: %X\n", (int) id );
break;
}
if ( field )
{
check( type == 1 );
Gme_File::copy_field_( field, (char const*) in, len );
}
// skip to next block
in += len;
// blocks are supposed to be 4-byte aligned with zero-padding...
byte const* unaligned = in;
while ( (in - begin) & 3 && in < end )
{
if ( *in++ != 0 )
{
// ...but some files have no padding
in = unaligned;
//dprintf( "SPC: xid6 info tag wasn't properly padded to align\n" );
break;
}
}
}
char* p = &copyright [year_len];
if ( year )
{
*--p = ' ';
// avoid using bloated printf
for ( int n = 4; n--; )
{
*--p = char (year % 10 + '0');
year /= 10;
}
copyright_len += year_len;
}
if ( copyright_len )
Gme_File::copy_field_( out->copyright, p, copyright_len );
if ( disc > 0 && disc <= 9 )
{
out->disc [0] = disc + '0';
out->disc [1] = 0;
}
if ( track > 255 && track < ( ( 100 << 8 ) - 1 ) )
{
char* p = &copyright [3];
*p = 0;
if ( track & 255 ) *--p = char (track & 255);
track >>= 8;
for ( int n = 2; n-- && track; )
{
*--p = char (track % 10 + '0');
track /= 10;
}
memcpy( out->track, p, &copyright [4] - p );
}
check( in == end );
}
static void get_spc_info( Spc_Emu::header_t const& h, byte const xid6 [], int xid6_size,
track_info_t* out )
{
// decode length (can be in text or binary format, sometimes ambiguous ugh)
int len_secs = 0;
int i;
for ( i = 0; i < 3; i++ )
{
unsigned n = h.len_secs [i] - '0';
if ( n > 9 )
{
// ignore single-digit text lengths
// (except if author field is present and begins at offset 1, ugh)
if ( i == 1 && (h.author [0] || !h.author [1]) )
len_secs = 0;
break;
}
len_secs *= 10;
len_secs += n;
}
if ( !len_secs || len_secs > 0x1FFF )
len_secs = get_le16( h.len_secs );
if ( len_secs < 0x1FFF )
out->length = len_secs * 1000;
long fade_msec = 0;
for ( i = 0; i < 4; i++ )
{
unsigned n = h.fade_msec [i] - '0';
if ( n > 9 )
{
if ( i == 1 && (h.author [0] || !h.author [1]) )
fade_msec = -1;
break;
}
fade_msec *= 10;
fade_msec += n;
}
if ( i == 4 && unsigned( h.author [0] - '0' ) <= 9 )
fade_msec = fade_msec * 10 + h.author [0] - '0';
if ( fade_msec < 0 || fade_msec > 0x7FFF )
fade_msec = get_le32( h.fade_msec );
if ( fade_msec < 0x7FFF )
out->fade_length = fade_msec;
int offset = (h.author [0] < ' ' || unsigned (h.author [0] - '0') <= 9);
Gme_File::copy_field_( out->author, &h.author [offset], sizeof h.author - offset );
GME_COPY_FIELD( h, out, song );
GME_COPY_FIELD( h, out, game );
GME_COPY_FIELD( h, out, dumper );
GME_COPY_FIELD( h, out, comment );
if ( xid6_size )
get_spc_xid6( xid6, xid6_size, out );
}
static void hash_spc_file( Spc_Emu::header_t const& h, byte const* data, int data_size, Music_Emu::Hash_Function& out )
{
out.hash_( &h.format, sizeof(h.format) );
out.hash_( &h.version, sizeof(h.version) );
out.hash_( &h.pc[0], sizeof(h.pc) );
out.hash_( &h.a, sizeof(h.a) );
out.hash_( &h.x, sizeof(h.x) );
out.hash_( &h.y, sizeof(h.y) );
out.hash_( &h.psw, sizeof(h.psw) );
out.hash_( &h.sp, sizeof(h.sp) );
out.hash_( &h.unused[0], sizeof(h.unused) );
out.hash_( &h.emulator, sizeof(h.emulator) );
out.hash_( &h.unused2[0], sizeof(h.unused2) );
out.hash_( data, data_size );
}
blargg_err_t Spc_Emu::track_info_( track_info_t* out, int ) const
{
get_spc_info( header(), trailer_(), trailer_size_(), out );
return blargg_ok;
}
static blargg_err_t check_spc_header( void const* header )
{
if ( memcmp( header, "SNES-SPC700 Sound File Data", 27 ) )
return blargg_err_file_type;
return blargg_ok;
}
struct Spc_File : Gme_Info_
{
Spc_Emu::header_t header;
blargg_vector<byte> data;
blargg_vector<byte> xid6;
Spc_File() { set_type( gme_spc_type ); }
blargg_err_t load_( Data_Reader& in )
{
int file_size = in.remain();
if ( file_size < 0x10180 )
return blargg_err_file_type;
RETURN_ERR( in.read( &header, header.size ) );
RETURN_ERR( check_spc_header( header.tag ) );
int const xid6_offset = 0x10200;
RETURN_ERR( data.resize( blargg_min( xid6_offset - header.size, file_size - header.size ) ) );
RETURN_ERR( in.read( data.begin(), data.end() - data.begin() ) );
int xid6_size = file_size - xid6_offset;
if ( xid6_size > 0 )
{
RETURN_ERR( xid6.resize( xid6_size ) );
RETURN_ERR( in.read( xid6.begin(), xid6.size() ) );
}
return blargg_ok;
}
blargg_err_t track_info_( track_info_t* out, int ) const
{
get_spc_info( header, xid6.begin(), xid6.size(), out );
return blargg_ok;
}
blargg_err_t hash_( Hash_Function& out ) const
{
hash_spc_file( header, data.begin(), data.end() - data.begin(), out );
return blargg_ok;
}
};
static Music_Emu* new_spc_emu () { return BLARGG_NEW Spc_Emu ; }
static Music_Emu* new_spc_file() { return BLARGG_NEW Spc_File; }
gme_type_t_ const gme_spc_type [1] = {{ "Super Nintendo", 1, &new_spc_emu, &new_spc_file, "SPC", 0 }};
// Setup
blargg_err_t Spc_Emu::set_sample_rate_( int sample_rate )
{
smp.power();
if ( sample_rate != native_sample_rate )
{
RETURN_ERR( resampler.resize_buffer( native_sample_rate / 20 * 2 ) );
RETURN_ERR( resampler.set_rate( (double) native_sample_rate / sample_rate ) ); // 0.9965 rolloff
}
return blargg_ok;
}
void Spc_Emu::mute_voices_( int m )
{
Music_Emu::mute_voices_( m );
for ( int i = 0, j = 1; i < SuperFamicom::SPC_DSP::voice_count; ++i, j <<= 1 )
smp.dsp.channel_enable( i, !( m & j ) );
}
blargg_err_t Spc_Emu::load_mem_( byte const in [], int size )
{
assert( offsetof (header_t,unused2 [46]) == header_t::size );
set_voice_count( SuperFamicom::SPC_DSP::voice_count );
if ( size < 0x10180 )
return blargg_err_file_type;
static const char* const names [ SuperFamicom::SPC_DSP::voice_count ] = {
"DSP 1", "DSP 2", "DSP 3", "DSP 4", "DSP 5", "DSP 6", "DSP 7", "DSP 8"
};
set_voice_names( names );
return check_spc_header( in );
}
// Emulation
void Spc_Emu::set_tempo_( double t )
{
smp.set_tempo( t );
}
blargg_err_t Spc_Emu::start_track_( int track )
{
RETURN_ERR( Music_Emu::start_track_( track ) );
resampler.clear();
filter.clear();
smp.reset();
const byte * ptr = file_begin();
Spc_Emu::header_t & header = *(Spc_Emu::header_t*)ptr;
ptr += sizeof(header);
smp.regs.pc = header.pc[0] + header.pc[1] * 0x100;
smp.regs.a = header.a;
smp.regs.x = header.x;
smp.regs.y = header.y;
smp.regs.p = header.psw;
smp.regs.s = header.sp;
memcpy( smp.apuram, ptr, 0x10000 );
memset( smp.apuram + 0xF4, 0, 4 );
memcpy( smp.sfm_last, ptr + 0xF4, 4 );
static const uint8_t regs_to_copy[][2] = { {0xFC,0xFF}, {0xFB,0xFF}, {0xFA,0xFF}, {0xF9,0xFF}, {0xF8,0xFF}, {0xF2,0xFF}, {0xF1,0x87} };
for (auto n : regs_to_copy) smp.op_buswrite( n[0], ptr[ n[0] ] & n[1] );
smp.timer0.stage3_ticks = ptr[ 0xFD ] & 0x0F;
smp.timer1.stage3_ticks = ptr[ 0xFE ] & 0x0F;
smp.timer2.stage3_ticks = ptr[ 0xFF ] & 0x0F;
ptr += 0x10000;
smp.dsp.spc_dsp.load( ptr );
if ( !(smp.dsp.read( SuperFamicom::SPC_DSP::r_flg ) & 0x20) )
{
int addr = 0x100 * smp.dsp.read( SuperFamicom::SPC_DSP::r_esa );
int end = addr + 0x800 * (smp.dsp.read( SuperFamicom::SPC_DSP::r_edl ) & 0x0F);
if ( end > 0x10000 )
end = 0x10000;
memset( &smp.apuram [addr], 0xFF, end - addr );
}
filter.set_gain( (int) (gain() * Spc_Filter::gain_unit) );
return blargg_ok;
}
blargg_err_t Spc_Emu::play_and_filter( int count, sample_t out [] )
{
smp.render( out, count );
filter.run( out, count );
return blargg_ok;
}
blargg_err_t Spc_Emu::skip_( int count )
{
if ( sample_rate() != native_sample_rate )
{
count = (int) (count * resampler.rate()) & ~1;
count -= resampler.skip_input( count );
}
// TODO: shouldn't skip be adjusted for the 64 samples read afterwards?
if ( count > 0 )
{
smp.skip( count );
filter.clear();
}
// eliminate pop due to resampler
if ( sample_rate() != native_sample_rate )
{
const int resampler_latency = 64;
sample_t buf [resampler_latency];
return play_( resampler_latency, buf );
}
return blargg_ok;
}
blargg_err_t Spc_Emu::play_( int count, sample_t out [] )
{
if ( sample_rate() == native_sample_rate )
return play_and_filter( count, out );
int remain = count;
while ( remain > 0 )
{
remain -= resampler.read( &out [count - remain], remain );
if ( remain > 0 )
{
int n = resampler.buffer_free();
RETURN_ERR( play_and_filter( n, resampler.buffer() ) );
resampler.write( n );
}
}
check( remain == 0 );
return blargg_ok;
}
blargg_err_t Spc_Emu::hash_( Hash_Function& out ) const
{
hash_spc_file( header(), file_begin() + header_t::size, blargg_min( (size_t) ( 0x10200 - header_t::size ), (size_t) ( file_end() - file_begin() - header_t::size ) ), out );
return blargg_ok;
}