2014-02-10 01:10:30 +00:00
|
|
|
/*************************************************************************/
|
|
|
|
/* cp_loader_s3m.h */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 12:11:45 +00:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 01:10:30 +00:00
|
|
|
/*************************************************************************/
|
2019-06-04 09:41:49 +00:00
|
|
|
/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */
|
2014-02-10 01:10:30 +00:00
|
|
|
/* */
|
|
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
|
|
/* a copy of this software and associated documentation files (the */
|
|
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
|
|
/* the following conditions: */
|
|
|
|
/* */
|
|
|
|
/* The above copyright notice and this permission notice shall be */
|
|
|
|
/* included in all copies or substantial portions of the Software. */
|
|
|
|
/* */
|
|
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
|
|
/*************************************************************************/
|
|
|
|
|
|
|
|
#ifndef CP_LOADER_S3M_H
|
|
|
|
#define CP_LOADER_S3M_H
|
|
|
|
|
|
|
|
#include "cp_loader.h"
|
|
|
|
|
|
|
|
/**
|
|
|
|
*@author Juan Linietsky
|
|
|
|
*/
|
|
|
|
/******************************
|
|
|
|
loader_s3m.h
|
|
|
|
----------
|
|
|
|
Scream Tracker Module CPLoader!
|
|
|
|
It lacks support for
|
|
|
|
individual sample loading
|
|
|
|
and reorganizing the columns.
|
|
|
|
********************************/
|
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
class CPLoader_S3M : public CPLoader {
|
2014-02-10 01:10:30 +00:00
|
|
|
|
|
|
|
struct S3M_Header {
|
2017-03-18 23:36:26 +00:00
|
|
|
char songname[28];
|
|
|
|
uint8_t t1a;
|
|
|
|
uint8_t type;
|
|
|
|
uint8_t unused1[2];
|
|
|
|
uint16_t ordnum;
|
|
|
|
uint16_t insnum;
|
|
|
|
uint16_t patnum;
|
|
|
|
uint16_t flags;
|
|
|
|
uint16_t tracker;
|
|
|
|
uint16_t fileformat;
|
|
|
|
char scrm[5];
|
|
|
|
uint8_t mastervol;
|
|
|
|
uint8_t initspeed;
|
|
|
|
uint8_t inittempo;
|
|
|
|
uint8_t mastermult;
|
|
|
|
uint8_t ultraclick;
|
|
|
|
uint8_t pantable;
|
|
|
|
uint8_t unused2[8];
|
|
|
|
uint16_t special;
|
|
|
|
uint8_t channels[32];
|
2014-02-10 01:10:30 +00:00
|
|
|
uint8_t pannings[32];
|
|
|
|
uint8_t orderlist[300];
|
|
|
|
};
|
|
|
|
|
|
|
|
int sample_parapointers[CPSong::MAX_SAMPLES];
|
|
|
|
int pattern_parapointers[CPSong::MAX_PATTERNS];
|
2017-03-18 23:36:26 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
Error load_header();
|
|
|
|
void set_header();
|
|
|
|
Error load_sample(CPSample *p_sample);
|
|
|
|
Error load_pattern(CPPattern *p_pattern);
|
|
|
|
Error load_patterns();
|
|
|
|
|
|
|
|
Error load_samples();
|
2017-03-18 23:36:26 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
S3M_Header header;
|
2017-03-18 23:36:26 +00:00
|
|
|
int sample_count;
|
2014-02-10 01:10:30 +00:00
|
|
|
int pattern_count;
|
2017-03-18 23:36:26 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
CPFileAccessWrapper *file;
|
|
|
|
CPSong *song;
|
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
public:
|
2014-02-10 01:10:30 +00:00
|
|
|
bool can_load_song() { return true; }
|
|
|
|
bool can_load_sample() { return false; }
|
|
|
|
bool can_load_instrument() { return false; }
|
2017-03-18 23:36:26 +00:00
|
|
|
|
|
|
|
Error load_song(const char *p_file, CPSong *p_song, bool p_sampleset);
|
|
|
|
Error load_sample(const char *p_file, CPSample *p_sample);
|
|
|
|
Error load_instrument(const char *p_file, CPSong *p_song, int p_instr_idx);
|
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
CPLoader_S3M(CPFileAccessWrapper *p_file);
|
|
|
|
~CPLoader_S3M();
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|