ptttl_parser.h

Go to the documentation of this file.

 
#ifndef PTTTL_PARSER_H
#define PTTTL_PARSER_H
 
 
#include <stdint.h>
 
 
#ifdef __cplusplus
    extern "C" {
#endif
 
#define PTTTL_VERSION "v0.3.0"
 
#ifndef PTTTL_MAX_CHANNELS_PER_FILE
#define PTTTL_MAX_CHANNELS_PER_FILE  (16u)
#endif // PTTTL_MAX_CHANNELS_PER_FILE
 
 
#ifndef PTTTL_MAX_NAME_LEN
#define PTTTL_MAX_NAME_LEN           (256u)
#endif // PTTTL_MAX_NAME_LEN
 
 
// Read vibrato frequency from vibrato settings
#define PTTTL_NOTE_VIBRATO_FREQ(note) (((note)->vibrato_settings) & 0xffffu)
 
// Read vibrato variance from vibrato settings
#define PTTTL_NOTE_VIBRATO_VAR(note)  ((((note)->vibrato_settings) >> 16u) & 0xffffu)
 
// Read the musical note value from note settings
#define PTTTL_NOTE_VALUE(note) (((note)->note_settings) & 0x7fu)
 
/* Read the note duration fraction index from note settings
 * Index maps to note duration: 0=1(whole), 1=2(half), 2=4(quarter),
 * 3=8(8th), 4=16(16th), 5=32(32nd) */
#define PTTTL_NOTE_DURATION_IDX(note) ((((note)->note_settings) >> 7u) & 0x7u)
 
// Read the note dot flag from note settings (1 = dotted, 0 = not dotted)
#define PTTTL_NOTE_DOT(note) ((((note)->note_settings) >> 10u) & 0x1u)
 
 
typedef struct
{
    uint32_t note_settings;
 
    uint32_t vibrato_settings;
} ptttl_output_note_t;
 
 
typedef struct
{
    uint32_t position;       
    uint32_t line;           
    uint32_t column;         
    uint32_t block;          
    uint8_t have_saved_char; 
    char saved_char;         
} ptttl_parser_input_stream_t;
 
 
typedef struct
{
    int (*read)(char *input_char);
 
    int (*seek)(uint32_t position);
 
} ptttl_parser_input_iface_t;
 
 
typedef struct
{
    const char *error_message;  
    int line;                   
    int column;                 
} ptttl_parser_error_t;
 
 
typedef struct
{
    char name[PTTTL_MAX_NAME_LEN];              
    unsigned int bpm;                           
    unsigned int default_duration;              
    unsigned int default_octave;                
    unsigned int default_vibrato_freq;          
    unsigned int default_vibrato_var;           
    ptttl_parser_error_t error;                 
    uint32_t channel_count;                     
    ptttl_parser_input_stream_t *active_stream; 
    ptttl_parser_input_stream_t stream;         
    ptttl_parser_input_stream_t channels[PTTTL_MAX_CHANNELS_PER_FILE];
    ptttl_parser_input_iface_t iface;           
} ptttl_parser_t;
 
 
 
ptttl_parser_error_t ptttl_parser_error(ptttl_parser_t *state);
 
 
int ptttl_parse_init(ptttl_parser_t *parser, ptttl_parser_input_iface_t iface);
 
 
int ptttl_parse_next(ptttl_parser_t *parser, uint32_t channel_idx, ptttl_output_note_t *note);
 
#ifdef __cplusplus
    }
#endif
 
#endif // PTTTL_PARSER_H