4.02 - Lyric File .lp3 format

  • admin
  • Topic Author
  • Offline
  • Administrator
  • Administrator
More
4 years 3 months ago #721 by admin
4.02 - Lyric File .lp3 format was created by admin
All of the song data that is not part of the display text is stored in a .LP3 file.
An LP3 file is a special xml file.

This topic will discuss the formatting of the lp3 file.
Unless noted otherwise, only one of each field is allowable in the file

Header
The top line of every xml file must be this header.
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>

Title
The title of the song that gets displayed in Lyric Pad
<Title>All I Want Is You</Title>

Titleb
An alternate title for the song which also gets displayed in Lyric Pad song lists (Perfect for songs starting with The
<Titleb>Want Is You</Titleb>

Artist
The artist of the song
<Artist>U2</Artist>

Custom
Notes that can be stored about the song
<Custom>notes go here</Custom>

Genre
The genre of the song. Songs are allowed to have multiple Genre tags
<Genre>Mellow</Genre>

Category
The category group that the song belongs too. Songs are allowed to have multiple Category tags.
<Category>edited</Category>

BPM
Beats Per Minute. Used to set the BPM for the metronome. (Not used for automation at all)
<BPM>120</BPM>

BeatsPerBar
Beats Per Bar. Used to set the beats per bar for the metronome.
<BeatsPerBar>4</BeatsPerBar>

Duration
The duration time for display in setlists and for calculation of intelligent automation
<Duration>7:19</Duration>

DurationDelta
Added to the duration to adjust the overall time used to calculate intelligent automation. Can be positive or negative.
<DurationDelta>50</DurationDelta>

AutoSpeed
Used to set the automation speed for basic automation. (If set will force this song to use basic automation)
<AutoSpeed>5</AutoSpeed>

AutoDelay
Used to set the automation start delay for basic automation. (If set will force this song to use basic automation)
<AutoDelay>10</AutoDelay>

MP3Track
Used to specify the backing track file to link to the song. (file must exist in the backing track directory)
<MP3Track>Test.mp3</MP3Track>

Automation
Automation events come in six types and need to have at least a Type and one of three triggers specified. Some Automation types also have additional data that needs to be specified. Multiple automation tags are allowed in a song and they are triggered in order.
  • Pause - Stops automation for a set time. Requires additional field of Duration
  • Stop - Stops automation
  • StartDown - Starts automation down the page
  • StartUp - Starts automation up the page
  • Speed - Changes the scrolling speed. Requires additional field of Speed
  • Jump - Jumps to a particular target position of the page. Requires additional field of TargetY

Automation tags can be triggered in three ways
  • Time - Trigger at specified seconds from start of song play time
  • Line - Trigger when the specified line number reaches the top of the screen
  • Perc - Trigger when the pecentage of the document reaches the top of the screen

Examples
<Automation Type="Pause" Time="10" Duration="10" />
<Automation Type="Stop" Time="20" />
<Automation Type="StartDown" Time="25" />
<Automation Type="Speed" Line="20" Speed="40" />
<Automation Type="Jump" Perc="70" TargetY="30" />

SideBar
Contains all text that will be included in the side bar
<SideBar>Sidebar text goes here</SideBar>

Scale
Sets the scale of the text generated on screen. This is like a preset pinch zoom.
<Scale>1.0</Scale>

Format
Format tags handle all text formatting including font style, font size, bold, italics, underline, colours, etc
They would be nearly impossible to edit by hand so I dont recommend trying.


Full Example
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
<Title>All I Want Is You</Title>
<Titleb>Want Is You</Titleb>
<Artist>U2</Artist>
<Custom>notes go here</Custom>
<Genre>Mellow</Genre>
<Genre>Pop</Genre>
<Category>test</Category>
<Category>edited</Category>
<BPM>120</BPM>
<BeatsPerBar>4</BeatsPerBar>
<Duration>7:19</Duration>
<AutoSpeed>5</AutoSpeed>
<AutoDelay>10</AutoDelay>
<MP3Track>Test.mp3</MP3Track>
<Automation Type="Pause" Time="10" Duration="10" />
<Automation Type="Stop" Time="20" />
<Automation Type="StartDown" Time="25" />
<Automation Type="Speed" Line="20" Speed="40" />
<Automation Type="Jump" Perc="70" TargetY="30" />
<Format Type="7" Start="797" End="802" Data="0" />
<Format Type="7" Start="911" End="918" Data="0" />
<Format Type="7" Start="1150" End="1158" Data="0" />
<Format Type="7" Start="1467" End="1474" Data="0" />
<Format Type="7" Start="2075" End="2083" Data="0" />
<Format Type="7" Start="2321" End="2327" Data="0" />
<Format Type="7" Start="2431" End="2438" Data="0" />
<Format Type="7" Start="2951" End="2959" Data="0" />
<Format Type="7" Start="3194" End="3200" Data="0" />
<Format Type="7" Start="3295" End="3301" Data="0" />
<Format Type="7" Start="3465" End="3469" Data="0" />
<Format Type="7" Start="3655" End="3660" Data="0" />
<SideBar></SideBar>
<Scale>1.0</Scale>

Please Log in or Create an account to join the conversation.

Time to create page: 0.088 seconds