2006-07-13 15:07:28 +00:00
|
|
|
/*
|
|
|
|
|
** Nofrendo (c) 1998-2000 Matthew Conte (matt@conte.com)
|
|
|
|
|
**
|
|
|
|
|
**
|
|
|
|
|
** This program is free software; you can redistribute it and/or
|
|
|
|
|
** modify it under the terms of version 2 of the GNU Library General
|
|
|
|
|
** Public License as published by the Free Software Foundation.
|
|
|
|
|
**
|
|
|
|
|
** 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
|
|
|
|
|
** Library General Public License for more details. To obtain a
|
|
|
|
|
** copy of the GNU Library General Public License, write to the Free
|
|
|
|
|
** Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
|
|
|
**
|
|
|
|
|
** Any permitted reproduction of these routines, in whole or in part,
|
|
|
|
|
** must bear this legend.
|
|
|
|
|
**
|
|
|
|
|
**
|
|
|
|
|
** nsf.h
|
|
|
|
|
**
|
|
|
|
|
** NSF loading/saving related defines / prototypes
|
|
|
|
|
** $Id$
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef _NSF_H_
|
|
|
|
|
#define _NSF_H_
|
|
|
|
|
|
|
|
|
|
#include "osd.h"
|
|
|
|
|
#include "nes6502.h"
|
|
|
|
|
#include "nes_apu.h"
|
|
|
|
|
|
|
|
|
|
#define NSF_MAGIC "NESM\x1A"
|
|
|
|
|
|
|
|
|
|
#define NSF_DEDICATED_PAL 0x01
|
|
|
|
|
#define NSF_DUAL_PAL_NTSC 0x02
|
|
|
|
|
|
|
|
|
|
#define EXT_SOUND_NONE 0x00
|
|
|
|
|
#define EXT_SOUND_VRCVI 0x01
|
|
|
|
|
#define EXT_SOUND_VRCVII 0x02
|
|
|
|
|
#define EXT_SOUND_FDS 0x04
|
|
|
|
|
#define EXT_SOUND_MMC5 0x08
|
|
|
|
|
#define EXT_SOUND_NAMCO106 0x10
|
|
|
|
|
#define EXT_SOUND_SUNSOFT_FME07 0x20
|
|
|
|
|
/* bits 6,7: future expansion */
|
|
|
|
|
|
|
|
|
|
#define NSF_HEADER_SIZE 0x80
|
|
|
|
|
|
|
|
|
|
/* 60 Hertz refresh (NTSC) */
|
|
|
|
|
#define NES_MASTER_CLOCK 21477272.7272
|
|
|
|
|
#define NTSC_REFRESH 60
|
|
|
|
|
#define NTSC_SUBCARRIER_DIV 12
|
|
|
|
|
#define NTSC_SCANLINES 262
|
|
|
|
|
|
|
|
|
|
#define NES_FRAME_CYCLES ((NES_MASTER_CLOCK / NTSC_SUBCARRIER_DIV) / NTSC_REFRESH)
|
|
|
|
|
#define NES_SCANLINE_CYCLES (NES_FRAME_CYCLES / NTSC_SCANLINES)
|
|
|
|
|
|
|
|
|
|
/* filter levels */
|
|
|
|
|
enum
|
|
|
|
|
{
|
|
|
|
|
NSF_FILTER_NONE,
|
|
|
|
|
NSF_FILTER_LOWPASS,
|
2008-03-25 15:56:13 +00:00
|
|
|
NSF_FILTER_WEIGHTED,
|
|
|
|
|
NSF_FILTER_MAX, /* $$$ ben : add this one for range chacking */
|
2006-07-13 15:07:28 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
typedef struct nsf_s
|
|
|
|
|
{
|
|
|
|
|
/* NESM header */
|
|
|
|
|
uint8 id[5] ; /* NESM\x1A */
|
|
|
|
|
uint8 version ; /* spec version */
|
|
|
|
|
uint8 num_songs ; /* total num songs */
|
|
|
|
|
uint8 start_song ; /* first song */
|
|
|
|
|
uint16 load_addr __PACKED__; /* loc to load code */
|
|
|
|
|
uint16 init_addr __PACKED__; /* init call address */
|
|
|
|
|
uint16 play_addr __PACKED__; /* play call address */
|
|
|
|
|
uint8 song_name[32] ; /* name of song */
|
|
|
|
|
uint8 artist_name[32] ; /* artist name */
|
|
|
|
|
uint8 copyright[32] ; /* copyright info */
|
|
|
|
|
uint16 ntsc_speed __PACKED__; /* playback speed (if NTSC) */
|
|
|
|
|
uint8 bankswitch_info[8] ; /* initial code banking */
|
|
|
|
|
uint16 pal_speed __PACKED__; /* playback speed (if PAL) */
|
|
|
|
|
uint8 pal_ntsc_bits ; /* NTSC/PAL determination bits */
|
|
|
|
|
uint8 ext_sound_type ; /* type of external sound gen. */
|
|
|
|
|
uint8 reserved[4] ; /* reserved */
|
|
|
|
|
|
|
|
|
|
/* things that the NSF player needs */
|
|
|
|
|
uint8 *data; /* actual NSF data */
|
|
|
|
|
uint32 length; /* length of data */
|
|
|
|
|
uint32 playback_rate; /* current playback rate */
|
|
|
|
|
uint8 current_song; /* current song */
|
|
|
|
|
boolean bankswitched; /* is bankswitched? */
|
|
|
|
|
|
2008-03-25 15:56:13 +00:00
|
|
|
/* $$$ ben : Playing time ... */
|
|
|
|
|
uint32 cur_frame;
|
|
|
|
|
uint32 cur_frame_end;
|
|
|
|
|
uint32 * song_frames;
|
|
|
|
|
|
|
|
|
|
/* $$$ ben : Last error string */
|
|
|
|
|
const char * errstr;
|
|
|
|
|
|
2006-07-13 15:07:28 +00:00
|
|
|
/* CPU and APU contexts */
|
|
|
|
|
nes6502_context *cpu;
|
|
|
|
|
apu_t *apu;
|
|
|
|
|
|
|
|
|
|
/* our main processing routine, calls all external mixing routines */
|
2008-04-10 10:01:48 +00:00
|
|
|
void (*process)(uint8 *buffer, int num_samples);
|
2006-07-13 15:07:28 +00:00
|
|
|
} nsf_t;
|
|
|
|
|
|
2008-03-25 15:56:13 +00:00
|
|
|
/* $$$ ben : Generic loader struct */
|
|
|
|
|
struct nsf_loader_t {
|
|
|
|
|
/* Init and open. */
|
|
|
|
|
int (*open)(struct nsf_loader_t * loader);
|
|
|
|
|
|
|
|
|
|
/* Close and shutdown. */
|
|
|
|
|
void (*close) (struct nsf_loader_t * loader);
|
|
|
|
|
|
|
|
|
|
/* This function should return <0 on error, else the number of byte NOT read.
|
|
|
|
|
* that way a simple 0 test tell us if read was complete.
|
|
|
|
|
*/
|
|
|
|
|
int (*read) (struct nsf_loader_t * loader, void *data, int n);
|
|
|
|
|
|
|
|
|
|
/* Get file length. */
|
|
|
|
|
int (*length) (struct nsf_loader_t * loader);
|
|
|
|
|
|
|
|
|
|
/* Skip n bytes. */
|
|
|
|
|
int (*skip) (struct nsf_loader_t * loader,int n);
|
|
|
|
|
|
|
|
|
|
/* Get filename (for debug). */
|
|
|
|
|
const char * (*fname) (struct nsf_loader_t * loader);
|
|
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
2006-07-13 15:07:28 +00:00
|
|
|
/* Function prototypes */
|
2008-03-25 15:56:13 +00:00
|
|
|
extern int nsf_init(void);
|
2006-07-13 15:07:28 +00:00
|
|
|
|
2008-03-25 15:56:13 +00:00
|
|
|
extern nsf_t * nsf_load_extended(struct nsf_loader_t * loader);
|
|
|
|
|
extern nsf_t *nsf_load(const char *filename, void *source, int length);
|
2006-07-13 15:07:28 +00:00
|
|
|
extern void nsf_free(nsf_t **nsf_info);
|
|
|
|
|
|
2008-03-25 15:56:13 +00:00
|
|
|
extern int nsf_playtrack(nsf_t *nsf, int track, int sample_rate,
|
|
|
|
|
int sample_bits, boolean stereo);
|
2006-07-13 15:07:28 +00:00
|
|
|
extern void nsf_frame(nsf_t *nsf);
|
2008-03-25 15:56:13 +00:00
|
|
|
extern int nsf_setchan(nsf_t *nsf, int chan, boolean enabled);
|
|
|
|
|
extern int nsf_setfilter(nsf_t *nsf, int filter_type);
|
2006-07-13 15:07:28 +00:00
|
|
|
|
|
|
|
|
#endif /* _NSF_H_ */
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
** $Log$
|
2008-04-10 10:01:48 +00:00
|
|
|
** Revision 1.3 2008/04/10 10:01:48 tpm
|
|
|
|
|
** * gst/nsf/nsf.h:
|
|
|
|
|
** Change prototype of process function here too to avoid
|
|
|
|
|
** 'incompatible assignment' warnings.
|
|
|
|
|
**
|
|
|
|
|
** Revision 1.2 2008-03-25 15:56:12 slomo
|
2008-03-25 15:56:13 +00:00
|
|
|
** Patch by: Andreas Henriksson <andreas at fatal dot set>
|
2006-07-13 15:07:28 +00:00
|
|
|
** * gst/nsf/Makefile.am:
|
|
|
|
|
** * gst/nsf/dis6502.h:
|
|
|
|
|
** * gst/nsf/fds_snd.c:
|
|
|
|
|
** * gst/nsf/fds_snd.h:
|
|
|
|
|
** * gst/nsf/fmopl.c:
|
|
|
|
|
** * gst/nsf/fmopl.h:
|
|
|
|
|
** * gst/nsf/gstnsf.c:
|
|
|
|
|
** * gst/nsf/log.c:
|
|
|
|
|
** * gst/nsf/log.h:
|
|
|
|
|
** * gst/nsf/memguard.c:
|
|
|
|
|
** * gst/nsf/memguard.h:
|
|
|
|
|
** * gst/nsf/mmc5_snd.c:
|
|
|
|
|
** * gst/nsf/mmc5_snd.h:
|
|
|
|
|
** * gst/nsf/nes6502.c:
|
|
|
|
|
** * gst/nsf/nes6502.h:
|
|
|
|
|
** * gst/nsf/nes_apu.c:
|
|
|
|
|
** * gst/nsf/nes_apu.h:
|
|
|
|
|
** * gst/nsf/nsf.c:
|
|
|
|
|
** * gst/nsf/nsf.h:
|
|
|
|
|
** * gst/nsf/osd.h:
|
|
|
|
|
** * gst/nsf/types.h:
|
|
|
|
|
** * gst/nsf/vrc7_snd.c:
|
|
|
|
|
** * gst/nsf/vrc7_snd.h:
|
|
|
|
|
** * gst/nsf/vrcvisnd.c:
|
|
|
|
|
** * gst/nsf/vrcvisnd.h:
|
2008-03-25 15:56:13 +00:00
|
|
|
** Update our internal nosefart to nosefart-2.7-mls to fix segfaults
|
|
|
|
|
** on some files. Fixes bug #498237.
|
|
|
|
|
** Remove some // comments, fix some compiler warnings and use pow()
|
|
|
|
|
** instead of a slow, selfmade implementation.
|
|
|
|
|
**
|
|
|
|
|
** Revision 1.3 2003/05/01 22:34:20 benjihan
|
|
|
|
|
** New NSF plugin
|
|
|
|
|
**
|
|
|
|
|
** Revision 1.2 2003/04/09 14:50:32 ben
|
|
|
|
|
** Clean NSF api.
|
|
|
|
|
**
|
|
|
|
|
** Revision 1.1 2003/04/08 20:53:00 ben
|
|
|
|
|
** Adding more files...
|
2006-07-13 15:07:28 +00:00
|
|
|
**
|
|
|
|
|
** Revision 1.11 2000/07/04 04:59:24 matt
|
|
|
|
|
** removed DOS-specific stuff
|
|
|
|
|
**
|
|
|
|
|
** Revision 1.10 2000/07/03 02:19:36 matt
|
|
|
|
|
** dynamic address range handlers, cleaner and faster
|
|
|
|
|
**
|
|
|
|
|
** Revision 1.9 2000/06/23 03:27:58 matt
|
|
|
|
|
** cleaned up external sound inteface
|
|
|
|
|
**
|
|
|
|
|
** Revision 1.8 2000/06/20 04:04:37 matt
|
|
|
|
|
** moved external soundchip struct to apu module
|
|
|
|
|
**
|
|
|
|
|
** Revision 1.7 2000/06/20 00:05:45 matt
|
|
|
|
|
** changed to driver-based external sound generation
|
|
|
|
|
**
|
|
|
|
|
** Revision 1.6 2000/06/13 03:51:54 matt
|
|
|
|
|
** update API to take freq/sample data on nsf_playtrack
|
|
|
|
|
**
|
|
|
|
|
** Revision 1.5 2000/06/12 01:13:00 matt
|
|
|
|
|
** added CPU/APU as members of the nsf struct
|
|
|
|
|
**
|
|
|
|
|
** Revision 1.4 2000/06/09 15:12:26 matt
|
|
|
|
|
** initial revision
|
|
|
|
|
**
|
|
|
|
|
*/
|
