yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
Classes | Public Member Functions | Private Member Functions | Static Private Member Functions | List of all members
yaze::zelda3::music::AsmImporter Class Reference

Imports music_macros.asm format files into MusicSong. More...

#include <asm_importer.h>

Classes

struct  ParseState
 

Public Member Functions

 AsmImporter ()=default
 
 ~AsmImporter ()=default
 
absl::StatusOr< AsmParseResult > ImportSong (const std::string &asm_source, const AsmImportOptions &options)
 Import a song from ASM string.
 
absl::StatusOr< AsmParseResult > ImportFromFile (const std::string &path, const AsmImportOptions &options)
 Import a song from a file.
 

Private Member Functions

absl::Status ParseLine (const std::string &line, MusicSong &song, ParseState &state, const AsmImportOptions &options)
 
bool ParseLabel (const std::string &line, ParseState &state)
 
bool ParseDirective (const std::string &line, ParseState &state)
 
absl::Status ParseDataBytes (const std::string &line, MusicSong &song, ParseState &state, const AsmImportOptions &options)
 
absl::StatusOr< std::vector< TrackEvent > > ParseMacro (const std::string &macro_call, ParseState &state, const AsmImportOptions &options)
 
absl::StatusOr< uint8_t > ParseNoteName (const std::string &note_name)
 
absl::StatusOr< uint8_t > ParseDurationConstant (const std::string &duration)
 
absl::StatusOr< MusicCommand > ResolveInstrumentMacro (const std::string &macro_name)
 
absl::StatusOr< MusicCommand > ResolveCommandMacro (const std::string &macro_name, const std::vector< uint8_t > &params)
 
bool ParseMacroCall (const std::string &call, std::string &macro_name, std::vector< std::string > &params)
 
absl::StatusOr< uint8_t > ParseHexValue (const std::string &value)
 

Static Private Member Functions

static std::string Trim (const std::string &s)
 

Detailed Description

Imports music_macros.asm format files into MusicSong.

Supports the Oracle of Secrets music_macros.asm conventions:

  • Duration constants (!4th, !8th, etc.)
  • Instrument helper macros (Piano(), Strings(), etc.)
  • N-SPC command macros (SetTempo, SetPan, etc.)
  • ARAM address calculations (!ARAMAddr, !ARAMC)
  • Channel labels (.Channel0, .Channel1, etc.)

Definition at line 47 of file asm_importer.h.

Constructor & Destructor Documentation

◆ AsmImporter()

yaze::zelda3::music::AsmImporter::AsmImporter ( )
default

◆ ~AsmImporter()

yaze::zelda3::music::AsmImporter::~AsmImporter ( )
default

Member Function Documentation

◆ ImportSong()

absl::StatusOr< AsmParseResult > yaze::zelda3::music::AsmImporter::ImportSong ( const std::string & asm_source,
const AsmImportOptions & options )

Import a song from ASM string.

Parameters
asm_sourceThe ASM source code.
optionsImport options.
Returns
Parse result with song and diagnostics.

Definition at line 16 of file asm_importer.cc.

References yaze::zelda3::music::AsmParseResult::bytes_generated, yaze::zelda3::music::AsmImporter::ParseState::bytes_generated, yaze::zelda3::music::AsmParseResult::errors, yaze::zelda3::music::AsmImporter::ParseState::errors, yaze::zelda3::music::AsmImporter::ParseState::line_number, yaze::zelda3::music::AsmParseResult::lines_parsed, yaze::zelda3::music::MusicSong::name, ParseLine(), yaze::zelda3::music::MusicSong::segments, yaze::zelda3::music::AsmParseResult::song, yaze::zelda3::music::AsmImporter::ParseState::song_label, yaze::zelda3::music::AsmImportOptions::strict_mode, yaze::zelda3::music::AsmParseResult::warnings, and yaze::zelda3::music::AsmImporter::ParseState::warnings.

Referenced by yaze::editor::MusicEditor::ImportAsmBufferToSong(), and ImportFromFile().

Here is the call graph for this function:

◆ ImportFromFile()

absl::StatusOr< AsmParseResult > yaze::zelda3::music::AsmImporter::ImportFromFile ( const std::string & path,
const AsmImportOptions & options )

Import a song from a file.

Parameters
pathInput file path.
optionsImport options.
Returns
Parse result with song and diagnostics.

Definition at line 57 of file asm_importer.cc.

References ImportSong().

Here is the call graph for this function:

◆ ParseLine()

absl::Status yaze::zelda3::music::AsmImporter::ParseLine ( const std::string & line,
MusicSong & song,
ParseState & state,
const AsmImportOptions & options )
private

Definition at line 88 of file asm_importer.cc.

References yaze::zelda3::music::AsmImporter::ParseState::current_channel, yaze::zelda3::music::AsmImporter::ParseState::line_number, ParseDataBytes(), ParseDirective(), ParseLabel(), ParseMacro(), yaze::zelda3::music::MusicSong::segments, Trim(), yaze::zelda3::music::AsmImportOptions::verbose_errors, and yaze::zelda3::music::AsmImporter::ParseState::warnings.

Referenced by ImportSong().

◆ ParseLabel()

bool yaze::zelda3::music::AsmImporter::ParseLabel ( const std::string & line,
ParseState & state )
private

Definition at line 150 of file asm_importer.cc.

References yaze::zelda3::music::AsmImporter::ParseState::current_channel, yaze::zelda3::music::AsmImporter::ParseState::label_to_channel, and yaze::zelda3::music::AsmImporter::ParseState::song_label.

Referenced by ParseLine().

◆ ParseDirective()

bool yaze::zelda3::music::AsmImporter::ParseDirective ( const std::string & line,
ParseState & state )
private

Definition at line 196 of file asm_importer.cc.

References yaze::zelda3::music::AsmImporter::ParseState::aram_address, yaze::zelda3::name, ParseHexValue(), and Trim().

Referenced by ParseLine().

Here is the call graph for this function:

◆ ParseDataBytes()

absl::Status yaze::zelda3::music::AsmImporter::ParseDataBytes ( const std::string & line,
MusicSong & song,
ParseState & state,
const AsmImportOptions & options )
private

Definition at line 228 of file asm_importer.cc.

References yaze::zelda3::music::AsmImporter::ParseState::bytes_generated, yaze::zelda3::music::TrackEvent::Command, yaze::zelda3::music::AsmImporter::ParseState::current_channel, yaze::zelda3::music::AsmImporter::ParseState::current_duration, yaze::zelda3::music::TrackEvent::End, yaze::zelda3::music::kNoteMaxPitch, yaze::zelda3::music::kNoteMinPitch, yaze::zelda3::music::kNoteRest, yaze::zelda3::music::kNoteTie, yaze::zelda3::music::kTrackEnd, yaze::zelda3::music::AsmImporter::ParseState::line_number, yaze::zelda3::music::TrackEvent::Note, ParseDurationConstant(), ParseHexValue(), ParseNoteName(), yaze::zelda3::music::MusicSong::segments, Trim(), yaze::zelda3::music::TrackEvent::type, yaze::zelda3::music::AsmImportOptions::verbose_errors, and yaze::zelda3::music::AsmImporter::ParseState::warnings.

Referenced by ParseLine().

Here is the call graph for this function:

◆ ParseMacro()

absl::StatusOr< std::vector< TrackEvent > > yaze::zelda3::music::AsmImporter::ParseMacro ( const std::string & macro_call,
ParseState & state,
const AsmImportOptions & options )
private

Definition at line 328 of file asm_importer.cc.

References yaze::zelda3::music::AsmImporter::ParseState::bytes_generated, yaze::zelda3::music::TrackEvent::Command, yaze::zelda3::music::AsmImporter::ParseState::current_duration, yaze::zelda3::music::AsmImporter::ParseState::line_number, ParseDurationConstant(), ParseHexValue(), ParseMacroCall(), ResolveCommandMacro(), ResolveInstrumentMacro(), yaze::zelda3::music::AsmImportOptions::strict_mode, yaze::zelda3::music::TrackEvent::type, and yaze::zelda3::music::AsmImporter::ParseState::warnings.

Referenced by ParseLine().

◆ ParseNoteName()

absl::StatusOr< uint8_t > yaze::zelda3::music::AsmImporter::ParseNoteName ( const std::string & note_name)
private

Definition at line 401 of file asm_importer.cc.

References yaze::zelda3::music::kAsmNoteNames.

Referenced by ParseDataBytes().

◆ ParseDurationConstant()

absl::StatusOr< uint8_t > yaze::zelda3::music::AsmImporter::ParseDurationConstant ( const std::string & duration)
private

Definition at line 410 of file asm_importer.cc.

References yaze::zelda3::music::kDurationConstants, and yaze::zelda3::name.

Referenced by ParseDataBytes(), and ParseMacro().

◆ ResolveInstrumentMacro()

absl::StatusOr< MusicCommand > yaze::zelda3::music::AsmImporter::ResolveInstrumentMacro ( const std::string & macro_name)
private

Definition at line 430 of file asm_importer.cc.

References yaze::zelda3::music::kInstrumentMacroImport, yaze::zelda3::music::MusicCommand::opcode, and yaze::zelda3::music::MusicCommand::params.

Referenced by ParseMacro().

◆ ResolveCommandMacro()

absl::StatusOr< MusicCommand > yaze::zelda3::music::AsmImporter::ResolveCommandMacro ( const std::string & macro_name,
const std::vector< uint8_t > & params )
private

Definition at line 443 of file asm_importer.cc.

References yaze::zelda3::music::kCommandMacros, yaze::zelda3::music::MusicCommand::opcode, and yaze::zelda3::music::MusicCommand::params.

Referenced by ParseMacro().

◆ ParseMacroCall()

bool yaze::zelda3::music::AsmImporter::ParseMacroCall ( const std::string & call,
std::string & macro_name,
std::vector< std::string > & params )
private

Definition at line 458 of file asm_importer.cc.

References Trim().

Referenced by ParseMacro().

Here is the call graph for this function:

◆ ParseHexValue()

absl::StatusOr< uint8_t > yaze::zelda3::music::AsmImporter::ParseHexValue ( const std::string & value)
private

Definition at line 491 of file asm_importer.cc.

Referenced by ParseDataBytes(), ParseDirective(), and ParseMacro().

◆ Trim()

std::string yaze::zelda3::music::AsmImporter::Trim ( const std::string & s)
staticprivate

Definition at line 513 of file asm_importer.cc.

Referenced by ParseDataBytes(), ParseDirective(), ParseLine(), and ParseMacroCall().

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