jar_xm.h File Reference

#include <stdint.h>

Include dependency graph for jar_xm.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	JAR_XM_DEBUG   0
#define	JAR_XM_DEFENSIVE   1
#define	JARXM_MALLOC(sz)   malloc(sz)
#define	JARXM_FREE(p)   free(p)

Typedefs
typedef struct jar_xm_context_s	jar_xm_context_t

Functions
int	jar_xm_create_context_from_file (jar_xm_context_t **ctx, uint32_t rate, const char *filename)
int	jar_xm_create_context (jar_xm_context_t **ctx, const char *moddata, uint32_t rate)
int	jar_xm_create_context_safe (jar_xm_context_t **ctx, const char *moddata, size_t moddata_length, uint32_t rate)
void	jar_xm_free_context (jar_xm_context_t *ctx)
void	jar_xm_generate_samples (jar_xm_context_t *ctx, float *output, size_t numsamples)
void	jar_xm_generate_samples_16bit (jar_xm_context_t *ctx, short *output, size_t numsamples)
void	jar_xm_generate_samples_8bit (jar_xm_context_t *ctx, char *output, size_t numsamples)
void	jar_xm_set_max_loop_count (jar_xm_context_t *ctx, uint8_t loopcnt)
uint8_t	jar_xm_get_loop_count (jar_xm_context_t *ctx)
bool	jar_xm_mute_channel (jar_xm_context_t *ctx, uint16_t, bool)
bool	jar_xm_mute_instrument (jar_xm_context_t *ctx, uint16_t, bool)
const char *	jar_xm_get_module_name (jar_xm_context_t *ctx)
const char *	jar_xm_get_tracker_name (jar_xm_context_t *ctx)
uint16_t	jar_xm_get_number_of_channels (jar_xm_context_t *ctx)
uint16_t	jar_xm_get_module_length (jar_xm_context_t *)
uint16_t	jar_xm_get_number_of_patterns (jar_xm_context_t *ctx)
uint16_t	jar_xm_get_number_of_rows (jar_xm_context_t *ctx, uint16_t)
uint16_t	jar_xm_get_number_of_instruments (jar_xm_context_t *ctx)
uint16_t	jar_xm_get_number_of_samples (jar_xm_context_t *ctx, uint16_t)
void	jar_xm_get_playing_speed (jar_xm_context_t *ctx, uint16_t *bpm, uint16_t *tempo)
void	jar_xm_get_position (jar_xm_context_t *ctx, uint8_t *pattern_index, uint8_t *pattern, uint8_t *row, uint64_t *samples)
uint64_t	jar_xm_get_latest_trigger_of_instrument (jar_xm_context_t *ctx, uint16_t)
uint64_t	jar_xm_get_latest_trigger_of_sample (jar_xm_context_t *ctx, uint16_t instr, uint16_t sample)
uint64_t	jar_xm_get_latest_trigger_of_channel (jar_xm_context_t *ctx, uint16_t)
uint64_t	jar_xm_get_remaining_samples (jar_xm_context_t *ctx)

Macro Definition Documentation

JAR_XM_DEBUG

#define JAR_XM_DEBUG   0

Definition at line 61 of file jar_xm.h.

JAR_XM_DEFENSIVE

#define JAR_XM_DEFENSIVE   1

Definition at line 62 of file jar_xm.h.

JARXM_FREE

#define JARXM_FREE

(

p

)

free(p)

Definition at line 70 of file jar_xm.h.

JARXM_MALLOC

#define JARXM_MALLOC

(

sz

)

malloc(sz)

Definition at line 67 of file jar_xm.h.

Typedef Documentation

jar_xm_context_t

typedef struct jar_xm_context_s jar_xm_context_t

Definition at line 75 of file jar_xm.h.

Function Documentation

jar_xm_create_context()

int jar_xm_create_context	(	jar_xm_context_t **	ctx,
		const char *	moddata,
		uint32_t	rate
	)

jar_xm_create_context_from_file()

int jar_xm_create_context_from_file	(	jar_xm_context_t **	ctx,
		uint32_t	rate,
		const char *	filename
	)

Here is the caller graph for this function:

jar_xm_create_context_safe()

int jar_xm_create_context_safe	(	jar_xm_context_t **	ctx,
		const char *	moddata,
		size_t	moddata_length,
		uint32_t	rate
	)

Here is the caller graph for this function:

jar_xm_free_context()

void jar_xm_free_context

(

jar_xm_context_t *

ctx

)

Here is the caller graph for this function:

jar_xm_generate_samples()

void jar_xm_generate_samples	(	jar_xm_context_t *	ctx,
		float *	output,
		size_t	numsamples
	)

Here is the caller graph for this function:

jar_xm_generate_samples_16bit()

void jar_xm_generate_samples_16bit	(	jar_xm_context_t *	ctx,
		short *	output,
		size_t	numsamples
	)

Definition at line 125 of file jar_xm.h.

Here is the call graph for this function:

Here is the caller graph for this function:

jar_xm_generate_samples_8bit()

void jar_xm_generate_samples_8bit	(	jar_xm_context_t *	ctx,
		char *	output,
		size_t	numsamples
	)

Definition at line 138 of file jar_xm.h.

Here is the call graph for this function:

Here is the caller graph for this function:

jar_xm_get_latest_trigger_of_channel()

uint64_t jar_xm_get_latest_trigger_of_channel	(	jar_xm_context_t *	ctx,
		uint16_t
	)

jar_xm_get_latest_trigger_of_instrument()

uint64_t jar_xm_get_latest_trigger_of_instrument	(	jar_xm_context_t *	ctx,
		uint16_t
	)

jar_xm_get_latest_trigger_of_sample()

uint64_t jar_xm_get_latest_trigger_of_sample	(	jar_xm_context_t *	ctx,
		uint16_t	instr,
		uint16_t	sample
	)

jar_xm_get_loop_count()

uint8_t jar_xm_get_loop_count

(

jar_xm_context_t *

ctx

)

jar_xm_get_module_length()

uint16_t jar_xm_get_module_length

(

jar_xm_context_t *

)

jar_xm_get_module_name()

const char * jar_xm_get_module_name

(

jar_xm_context_t *

ctx

)

jar_xm_get_number_of_channels()

uint16_t jar_xm_get_number_of_channels

(

jar_xm_context_t *

ctx

)

jar_xm_get_number_of_instruments()

uint16_t jar_xm_get_number_of_instruments

(

jar_xm_context_t *

ctx

)

jar_xm_get_number_of_patterns()

uint16_t jar_xm_get_number_of_patterns

(

jar_xm_context_t *

ctx

)

jar_xm_get_number_of_rows()

uint16_t jar_xm_get_number_of_rows	(	jar_xm_context_t *	ctx,
		uint16_t
	)

jar_xm_get_number_of_samples()

uint16_t jar_xm_get_number_of_samples	(	jar_xm_context_t *	ctx,
		uint16_t
	)

jar_xm_get_playing_speed()

void jar_xm_get_playing_speed	(	jar_xm_context_t *	ctx,
		uint16_t *	bpm,
		uint16_t *	tempo
	)

jar_xm_get_position()

void jar_xm_get_position	(	jar_xm_context_t *	ctx,
		uint8_t *	pattern_index,
		uint8_t *	pattern,
		uint8_t *	row,
		uint64_t *	samples
	)

Here is the caller graph for this function:

jar_xm_get_remaining_samples()

uint64_t jar_xm_get_remaining_samples

(

jar_xm_context_t *

ctx

)

Here is the caller graph for this function:

jar_xm_get_tracker_name()

const char * jar_xm_get_tracker_name

(

jar_xm_context_t *

ctx

)

jar_xm_mute_channel()

bool jar_xm_mute_channel	(	jar_xm_context_t *	ctx,
		uint16_t	,
		bool
	)

jar_xm_mute_instrument()

bool jar_xm_mute_instrument	(	jar_xm_context_t *	ctx,
		uint16_t	,
		bool
	)

jar_xm_set_max_loop_count()

void jar_xm_set_max_loop_count	(	jar_xm_context_t *	ctx,
		uint8_t	loopcnt
	)

Here is the caller graph for this function: