Renesas / Sound_Generator

Sound Generator Library

Fork of Sound_Generator by GR-PEACH_producer_meeting

Sound Generator

What is this?

Driver library for Sound Generator that is function of RZ/A1H.

API

Driver Wrapper API

You can use music playback function to call following APIs.

void piano4int_start( const int8_t *scores[SDG_CH_TOTAL], PIANO4INT_CB callback )

void piano4int_stop( bool force )

bool piano4int_status( void )

typedef void (*PIANO4INT_CB)( uint32_t channel, uint32_t value )

Driver API

int32_t R_SDG_Open( uint32_t channel, R_SDG_CLOCK clock )

int32_t R_SDG_Close( uint32_t channel )

int32_t R_SDG_Tone( uint32_t channel, NOTE *note )

User Definition Functions

int32_t Userdef_SDG0_Open( void )

int32_t Userdef_SDG1_Open( void )

int32_t Userdef_SDG2_Open( void )

int32_t Userdef_SDG3_Open( void )

int32_t Userdef_SDG0_Close( void )

int32_t Userdef_SDG1_Close( void )

int32_t Userdef_SDG2_Close( void )

int32_t Userdef_SDG3_Close( void )

structures

typedef struct {
    UINT8_T TONE;		/* TONE VALUE ( 0 < TONE <= 127 )	*/
    UINT8_T SFS;		/* SFS VALUE ( 0 < SFS <= 255 )		*/
    UINT8_T LOUD;		/* LD VALUE ( 0 <= LD <= 255 )		*/
    UINT8_T ATTENUATION;	/* ATTENUATION VALUE			*/
} NOTE;

This structure specifies single tone.This structure is used in argument of R_SDG_Tone().

enumerate

typedef enum {
    R_SDG_CLOCK_2  = 0,
    R_SDG_CLOCK_4  = 1,
    R_SDG_CLOCK_8  = 2,
    R_SDG_CLOCK_16 = 3,
} R_SDG_CLOCK;

Selects the operating clock.

typedef enum {
    R_SDG_ATT_OFF = 0,
    R_SDG_ATT_1	  = 1,
    R_SDG_ATT_2	  = 2,
    R_SDG_ATT_4	  = 3,
    R_SDG_ATT_8	  = 4,
    R_SDG_ATT_16  = 5,
    R_SDG_ATT_32  = 6,
} R_SDG_ATTENUATION;

Turns the attenuator function on and off, and select the attenuation cycle.

サウンドジェネレータ

概要

RZ/A1Hに搭載されているサウンドジェネレータを使用するためのライブラリです。

API

Driver Wrapper API

下記に示すAPIはDriver APIをコールすることで楽曲再生機能を実現します。

void piano4int_start( const int8_t *scores[SDG_CH_TOTAL], PIANO4INT_CB callback )

void piano4int_stop( bool force )

bool piano4int_status( void )

typedef void (*PIANO4INT_CB)( uint32_t channel, uint32_t value )

Driver API

int32_t R_SDG_Open( uint32_t channel, R_SDG_CLOCK clock )

int32_t R_SDG_Close( uint32_t channel )

int32_t R_SDG_Tone( uint32_t channel, NOTE *note )

ユーザ定義関数

int32_t Userdef_SDG0_Open( void )

int32_t Userdef_SDG1_Open( void )

int32_t Userdef_SDG2_Open( void )

int32_t Userdef_SDG3_Open( void )

int32_t Userdef_SDG0_Close( void )

int32_t Userdef_SDG1_Close( void )

int32_t Userdef_SDG2_Close( void )

int32_t Userdef_SDG3_Close( void )

構造体

typedef struct {
    UINT8_T TONE;		/* TONE VALUE ( 0 < TONE <= 127 )	*/
    UINT8_T SFS;		/* SFS VALUE ( 0 < SFS <= 255 )		*/
    UINT8_T LOUD;		/* LD VALUE ( 0 <= LD <= 255 )		*/
    UINT8_T ATTENUATION;	/* ATTENUATION VALUE			*/
} NOTE;

単音を表す構造体です。R_SDG_Tone( )の引数で使用します。意味と設定するビットを次に示します。

列挙型

typedef enum {
    R_SDG_CLOCK_2  = 0,
    R_SDG_CLOCK_4  = 1,
    R_SDG_CLOCK_8  = 2,
    R_SDG_CLOCK_16 = 3,
} R_SDG_CLOCK;

動作クロックを表す列挙型です。それぞれ、次の意味をもちます。

typedef enum {
    R_SDG_ATT_OFF = 0,
    R_SDG_ATT_1	  = 1,
    R_SDG_ATT_2	  = 2,
    R_SDG_ATT_4	  = 3,
    R_SDG_ATT_8	  = 4,
    R_SDG_ATT_16  = 5,
    R_SDG_ATT_32  = 6,
} R_SDG_ATTENUATION;

減衰率を表す列挙型です。それぞれ、次の意味をもちます。

Sound Generator Sample