snd_sound.h

Go to the documentation of this file.

// -*- coding: utf-8-unix -*-
/*
 * Copyright (c) 2021-2024 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 SND_SOUND_H_
#define SND_SOUND_H_
 
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
 
#include "snd_i_table.h"
#include "snd_p_table.h"
 
typedef struct snd_SoundAssets snd_SoundAssets;
 
typedef struct snd_Music snd_Music;
 
typedef struct snd_Track snd_Track;
 
typedef struct snd_SpeedTrack snd_SpeedTrack;
 
typedef struct snd_EventTrack snd_EventTrack;
 
typedef struct snd_Pattern snd_Pattern;
 
#define vec(T)                                      \
  struct vec_ ## T {                                \
    vec_fields(T);                                  \
  }
 
#define vec_fields(T)                               \
                         \
  const size_t length;                              \
           \
  const T * data
 
struct snd_SoundAssets {
  vec(snd_PitchBend)  pitchBendTables;
  vec(snd_PeriodBend) periodBendTables;
  vec(snd_Instrument) instruments;
  vec(snd_Music)      musics;
};
 
struct snd_Music {
  const uint8_t       format_version;
  const uint8_t       replayRate;
  // ---------------------------------------------------------------------
  vec(snd_SpeedTrack) speedTracks;
  vec(snd_EventTrack) eventTracks;
  vec(snd_Track)      tracks;
  vec(snd_Pattern)    patterns;
  const uint8_t       initialSpeed;
  const uint8_t       isLoop;
  const uint8_t       loopToIndex;
};
 
struct snd_Track {
  vec_fields(uint8_t);
};
 
struct snd_SpeedTrack {
  vec_fields(uint8_t);
};
 
struct snd_EventTrack {
  vec_fields(uint8_t);
};
 
struct snd_Pattern {
  uint8_t height;               
  struct {
    uint8_t speedTrack;         
    uint8_t eventTrack;         
  } specialChannels;
  struct {
    uint8_t track;              
    int16_t detune;             
  } channels[3];
};
 
#undef vec
#undef vec_fields
 
#endif // SND_SOUND_H_