rockbox/apps/plugins/xworld/sfxplayer.h
Franklin Wei 33cb13dee5 Xworld - Another World interpreter for Rockbox
Co-conspirators: Franklin Wei, Benjamin Brown

--------------------------------------------------------------------
This work is based on:
- Fabien Sanglard's "Fabother World" based on
- Piotr Padkowski's newRaw interpreter which was based on
- Gregory Montoir's reverse engineering of
- Eric Chahi's assembly code

--------------------------------------------------------------------
Progress:

* The plugin runs pretty nicely (with sound!) on most color targets
* Keymaps for color LCD targets are complete
* The manual entry is finished
* Grayscale/monochrome support is NOT PLANNED
  - the game looks horrible in grayscale! :p

--------------------------------------------------------------------
Notes:

* The original game strings were built-in to the executable, and
  were copyrighted and could not be used.
* This port ships with an alternate set of strings by default, but
  can load the "official" strings from a file at runtime.

--------------------------------------------------------------------
To be done (in descending order of importance):

* vertical stride compatibility                          <30% done>
* optimization                                           <10% done>

Change-Id: I3155b0d97c2ac470cb8a2040f40d4139ddcebfa5
Reviewed-on: http://gerrit.rockbox.org/1077
Reviewed-by: Michael Giacomelli <giac2000@hotmail.com>
2014-12-23 23:48:12 +01:00

88 lines
2.6 KiB
C

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2014 Franklin Wei, Benjamin Brown
* Copyright (C) 2004 Gregory Montoir
*
* This program 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 software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
***************************************************************************/
#ifndef __SFXPLAYER_H__
#define __SFXPLAYER_H__
#include "intern.h"
struct SfxInstrument {
uint8_t *data;
uint16_t volume;
};
struct SfxModule {
const uint8_t *data;
uint16_t curPos;
uint8_t curOrder;
uint8_t numOrder;
uint8_t orderTable[0x80];
struct SfxInstrument samples[15];
};
struct SfxPattern {
uint16_t note_1;
uint16_t note_2;
uint16_t sampleStart;
uint8_t *sampleBuffer;
uint16_t sampleLen;
uint16_t loopPos;
uint8_t *loopData;
uint16_t loopLen;
uint16_t sampleVolume;
};
struct Mixer;
struct Resource;
struct Serializer;
struct System;
struct SfxPlayer {
struct Mixer *mixer;
struct Resource *res;
struct System *sys;
void *_mutex;
void *_timerId;
uint16_t _delay;
uint16_t _resNum;
struct SfxModule _sfxMod;
int16_t *_markVar;
};
void player_create(struct SfxPlayer*, struct Mixer *mix, struct Resource *res, struct System *stub);
void player_init(struct SfxPlayer*);
void player_free(struct SfxPlayer*);
void player_setEventsDelay(struct SfxPlayer*, uint16_t delay);
void player_loadSfxModule(struct SfxPlayer*, uint16_t resNum, uint16_t delay, uint8_t pos);
void player_prepareInstruments(struct SfxPlayer*, const uint8_t *p);
void player_start(struct SfxPlayer*);
void player_stop(struct SfxPlayer*);
void player_handleEvents(struct SfxPlayer*);
void player_handlePattern(struct SfxPlayer*, uint8_t channel, const uint8_t *patternData);
uint32_t player_eventsCallback(uint32_t interval, void *param);
void player_saveOrLoad(struct SfxPlayer*, struct Serializer *ser);
#endif