Lyrics Import
=============

Overview
--------

In addition to KBP files, kbp2video is able to import two other types of lyrics files:

* Doblon full timings export (.txt)
* Enhanced LRC

The way these are handled is they are immediately converted to .kbp format so they can be processed further. The settings for this import process are listed under :menuselection:`Edit --> Lyrics Import Options`.

Doblon full timings export
--------------------------

If you are using any Doblon/Power Karaoke karaoke creation software (Karaoke Video Creator or Karaoke CD+G Creator, or the more recent AI versions), there is functionality to export lyric timings. It should be under :menuselection:`Tools --> Export Lyrics --> Export lyrics with timing`. For the export mode, select :menuselection:`Lyrics and full time`. This ensures each syllable has the start and end time. The "Use Unicode" option is recommended. Make sure :menuselection:`New line` is left as "\\n".

This will export a .txt file with all your syllable timings (but no project settings).

Enhanced LRC
------------

Enhanced LRC is a format supported by multiple pieces of software. It includes line and syllable start times, and an end time for the last syllable, though depending on the exporter sometimes the line timings are not trustworthy, and sometimes the first syllable timing is omitted. For this reason, only syllable timings are considered, unless the first syllable timing is missing, in which case that line's timing is interpreted as a syllable timing.

Two examples of software that support exporting to this format are Karaoke Builder Studio itself and Karaoke Lyric Editor.

It's probably pointless to use the KBS export since kbp2video supports the .kbp format natively, but if you wanted to, click the Lyrics button, select the :menuselection:`LRC - Lyrics` tab, ensure :menuselection:`LRC Enhanced` is selected, then click :menuselection:`Save As...`.

In Karaoke Lyric Editor, select :menuselection:`Project --> Export lyric file...`. In the save dialog, ensure the save format is set to :menuselection:`LRC version 2`.

Note that the MidiCo LRC format is not currently supported. It uses its own variant of the LRC format, placing each syllable on a line and also including duet part info. It may be supported at a later time.

Settings
--------

Since these formats do not include any formatting information, some options are provided in :menuselection:`Edit --> Lyrics Import Options`.

* :menuselection:`max_lines_per_page` - This is the most lines that should be on any page.
* :menuselection:`min_gap_for_new_page` - This is the amount of time in ms between the removal of a line and the display of the next before a page break is added.
* :menuselection:`display_before_wipe` - This is the amount of time in ms that a line is displayed before it starts wiping. It's sort of like the :menuselection:`Lines are displayed X seconds before wiping` setting in KBS Studio Settings, but it is followed strictly, not dynamically based on pages.
* :menuselection:`remove_after_wipe` - This is the amount of time in ms that a line is removed after it finishes wiping, like the :menuselection:`Lines are removed X seconds after wiping` setting in KBS Studio Settings.
* :menuselection:`template_file` - This is a KBS template or project file (.kbt or .kbp) containing the styles and project settings to use. If not specified, KBS defaults are used.
* :menuselection:`comments` - This is what to put in the Comments field for the project.

Note that all lyric text is set to style 1. If MidiCo LRC is supported someday, it will likely use style 1 and 2 for duets.

The way max lines per page and min gap per new page work together is that the lyrics are first split into pages by manual breaks (empty lines), then by gaps between lines (using the min gap for new page setting). Finally, if any pages still have more lines than the max lines per page, they are split evenly across as many pages are needed to get below that value. E.g. if a page would be 15 lines, but max lines per page is 6, it will be split into 3 pages (15/6 rounded up). Since there are 3 pages, each page will have 5 lines (as opposed to e.g. 6, 6, 3).

Since the line display/remove times are calculated in a pretty simple way, and collisions are not detected/mitigated at all, opening in KBS is recommended to fix up the formatting a bit. It would at least be a good idea to hit the reset button and check for any of the dreaded yellow bars in the wipe or display/remove tabs.