Gme_File Struct Reference

#include <Gme_File.h>

Inheritance diagram for Gme_File:

Public Types
enum	{ max_field_ = 255 }

Public Member Functions
blargg_err_t	load_file (const char *path)
blargg_err_t	load (Data_Reader &)
blargg_err_t	load_mem (void const *data, long size)
blargg_err_t	load_m3u (const char *path)
blargg_err_t	load_m3u (Data_Reader &in)
void	clear_playlist ()
gme_type_t	type () const
const char *	warning ()
int	track_count () const
blargg_err_t	track_info (track_info_t *out, int track) const
void	set_user_data (void *p)
void *	user_data () const
void	set_user_cleanup (gme_user_cleanup_t func)
int	error_count () const
	Gme_File ()
virtual	~Gme_File ()
blargg_err_t	remap_track_ (int *track_io) const

Static Public Member Functions
static void	copy_field_ (char *out, const char *in)
static void	copy_field_ (char *out, const char *in, int len)

Public Attributes
BLARGG_DISABLE_NOTHROW typedef uint8_t	byte

Protected Member Functions
void	set_track_count (int n)
void	set_warning (const char *s)
void	set_type (gme_type_t t)
blargg_err_t	load_remaining_ (void const *header, long header_size, Data_Reader &remaining)
virtual void	unload ()
virtual blargg_err_t	load_ (Data_Reader &)
virtual blargg_err_t	load_mem_ (byte const *data, long size)
virtual blargg_err_t	track_info_ (track_info_t *out, int track) const =0
virtual void	pre_load ()
virtual void	post_load_ ()
virtual void	clear_playlist_ ()

Private Member Functions
	Gme_File (const Gme_File &)
Gme_File &	operator= (const Gme_File &)
blargg_err_t	load_m3u_ (blargg_err_t)
blargg_err_t	post_load (blargg_err_t err)

Private Attributes
gme_type_t	type_
int	track_count_
int	raw_track_count_
const char *	warning_
void *	user_data_
gme_user_cleanup_t	user_cleanup_
M3u_Playlist	playlist
char	playlist_warning [64]
blargg_vector< byte >	file_data

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
max_field_

Constructor & Destructor Documentation

Gme_File() [1/2]

Gme_File::Gme_File

(

)

~Gme_File()

Gme_File::~Gme_File ( )

virtual

Gme_File() [2/2]

Gme_File::Gme_File ( const Gme_File & )

private

Member Function Documentation

clear_playlist()

void Gme_File::clear_playlist

(

)

clear_playlist_()

virtual void Gme_File::clear_playlist_ ( )

inlineprotectedvirtual

Reimplemented in Nsfe_Emu.

copy_field_() [1/2]

void Gme_File::copy_field_ ( char * out, const char * in )

static

copy_field_() [2/2]

void Gme_File::copy_field_ ( char * out, const char * in, int len )

static

error_count()

int Gme_File::error_count ( ) const

inline

load()

blargg_err_t Gme_File::load

(

Data_Reader &

in

)

load_()

blargg_err_t Gme_File::load_ ( Data_Reader & in )

protectedvirtual

Reimplemented in Gbs_Emu, Gbs_File, Hes_Emu, Hes_File, Kss_Emu, Kss_File, Nsf_Emu, Nsf_File, Nsfe_Emu, Nsfe_File, Spc_File, and Vgm_File.

load_file()

blargg_err_t Gme_File::load_file

(

const char *

path

)

load_m3u() [1/2]

blargg_err_t Gme_File::load_m3u

(

const char *

path

)

load_m3u() [2/2]

blargg_err_t Gme_File::load_m3u

(

Data_Reader &

in

)

load_m3u_()

blargg_err_t Gme_File::load_m3u_ ( blargg_err_t err )

private

load_mem()

blargg_err_t Gme_File::load_mem	(	void const *	data,
		long	size )

load_mem_()

blargg_err_t Gme_File::load_mem_ ( byte const * data, long size )

protectedvirtual

Reimplemented in Ay_Emu, Ay_File, Gym_Emu, Gym_File, Sap_Emu, Sap_File, Spc_Emu, and Vgm_Emu.

load_remaining_()

blargg_err_t Gme_File::load_remaining_ ( void const * header, long header_size, Data_Reader & remaining )

protected

operator=()

Gme_File & Gme_File::operator= ( const Gme_File & )

private

post_load()

blargg_err_t Gme_File::post_load ( blargg_err_t err )

private

post_load_()

void Gme_File::post_load_ ( )

protectedvirtual

Reimplemented in Gme_Info_, and Music_Emu.

pre_load()

void Gme_File::pre_load ( )

protectedvirtual

Reimplemented in Gme_Info_, and Music_Emu.

remap_track_()

blargg_err_t Gme_File::remap_track_

(

int *

track_io

)

const

set_track_count()

void Gme_File::set_track_count ( int n )

inlineprotected

set_type()

void Gme_File::set_type ( gme_type_t t )

inlineprotected

set_user_cleanup()

void Gme_File::set_user_cleanup ( gme_user_cleanup_t func )

inline

set_user_data()

void Gme_File::set_user_data ( void * p )

inline

set_warning()

void Gme_File::set_warning ( const char * s )

inlineprotected

track_count()

int Gme_File::track_count ( ) const

inline

track_info()

blargg_err_t Gme_File::track_info	(	track_info_t *	out,
		int	track ) const

track_info_()

virtual blargg_err_t Gme_File::track_info_ ( track_info_t * out, int track ) const

protectedpure virtual

Implemented in Ay_Emu, Ay_File, Gbs_Emu, Gbs_File, Gym_Emu, Gym_File, Hes_Emu, Hes_File, Kss_Emu, Kss_File, Nsf_Emu, Nsf_File, Nsfe_Emu, Nsfe_File, Sap_Emu, Sap_File, Spc_Emu, Spc_File, Vgm_Emu, and Vgm_File.

type()

gme_type_t Gme_File::type ( ) const

inline

unload()

void Gme_File::unload ( )

protectedvirtual

Reimplemented in Gbs_Emu, Hes_Emu, Kss_Emu, Music_Emu, Nsf_Emu, and Nsfe_Emu.

user_data()

void * Gme_File::user_data ( ) const

inline

warning()

const char * Gme_File::warning ( )

inline

Member Data Documentation

byte

BLARGG_DISABLE_NOTHROW typedef uint8_t Gme_File::byte

file_data

blargg_vector<byte> Gme_File::file_data

private

playlist

M3u_Playlist Gme_File::playlist

private

playlist_warning

char Gme_File::playlist_warning[64]

private

raw_track_count_

int Gme_File::raw_track_count_

private

track_count_

int Gme_File::track_count_

private

type_

gme_type_t Gme_File::type_

private

user_cleanup_

gme_user_cleanup_t Gme_File::user_cleanup_

private

user_data_

void* Gme_File::user_data_

private

warning_

const char* Gme_File::warning_

private

---

The documentation for this struct was generated from the following files:

• /home/runner/work/lmms-fork/lmms-fork/plugins/FreeBoy/game-music-emu/gme/Gme_File.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/FreeBoy/game-music-emu/gme/Gme_File.cpp
• /home/runner/work/lmms-fork/lmms-fork/plugins/FreeBoy/game-music-emu/gme/M3u_Playlist.cpp