NDP.h

Go to the documentation of this file.

// -*- coding: utf-8-unix -*-
/*
 * Copyright (c) 2021-2025 Daishi Mori (mori0091)
 *
 * This software is released under the MIT License.\n
 * See https://github.com/mori0091/libmsx/blob/main/LICENSE
 *
 * GitHub libmsx project\n
 * https://github.com/mori0091/libmsx
 */
#ifndef NDP_H_
#define NDP_H_
 
#include <memfile.h>
 
void NDP_init(void);
 
uint16_t NDP_version(void);
 
void NDP_play(void);
 
#if defined(LIBMSX_MEGAROM)
/*
 * An alternative version of `NDP_play()` that allows direct playback of song
 * data in MegaROM.
 */
void NDP_play_bmem(void);
#define NDP_play NDP_play_bmem
#endif
 
void NDP_start(void);
 
#if defined(LIBMSX_MEGAROM)
/*
 * An alternative version of `NDP_start()` that allows direct playback of song
 * data in MegaROM.
 */
void NDP_start_bmem(void);
#define NDP_start NDP_start_bmem
#endif
 
void NDP_pause(void);
bool NDP_is_paused(void);
 
void NDP_stop(void);
 
void NDP_set_volume(uint8_t vol);
 
void NDP_fadeout(uint8_t wait);
 
void NDP_fadein(uint8_t wait);
 
bool NDP_is_playing(void);
 
uint8_t NDP_get_track_status(void);
 
uint8_t NDP_get_loop_counter(void);
 
// ----------------------------------------------------------------------
typedef struct NDPFile {
  MemFile mf;
} NDPFile;
 
int NDP_open_mem(NDPFile * ndp, const uint8_t * loc, size_t size);
 
int NDP_open_bmem(NDPFile * ndp, bmemptr_t loc, uint32_t size);
 
int NDP_open_resource(NDPFile * ndp, const char * path);
 
bool NDP_set_bgm(NDPFile * ndp);
 
bool NDP_load_bgm(NDPFile * ndp, uint8_t * buf, size_t buf_size);
 
bool NDP_has_metadata(NDPFile * ndp);
 
size_t NDP_read_metadata(NDPFile * ndp, uint8_t * buf, size_t buf_size);
 
#endif // NDP_H_