Add version 1.0.0 and 1.1.0 support for writer

This commit is contained in:
Vadim committed 2023-12-28 22:07:34 +01:00
1 parent 31fd4c5dc7
commit ae4dcd15b9
5 files changed
+136 -76

No files matched your search

@@ -1,6 +1,7 @@
"""Tests for the ultrastar_writer.py module."""
import unittest
from packaging import version
from unittest.mock import patch, mock_open
from src.modules.Ultrastar.ultrastar_writer import create_ultrastar_txt_from_automation
from src.modules.Speech_Recognition.TranscribedData import TranscribedData
@@ -11,11 +12,21 @@ class TestCreateUltrastarTxt(unittest.TestCase):
def test_create_ultrastar_txt_from_automation_default_values(self):
# Arrange
bpm, note_numbers, transcribed_data, ultrastar_file_output = self.arrange()
# Assert default values
class_under_test = UltrastarTxtValue()
expected_calls = self.default_values(class_under_test)
# Act and Assert default values
class_under_test.version = "0.2.0"
expected_calls = self.default_values(class_under_test, class_under_test.version)
self.act_and_assert(bpm, class_under_test, expected_calls, note_numbers, transcribed_data,
ultrastar_file_output)
class_under_test.version = "1.0.0"
expected_calls = self.default_values(class_under_test, class_under_test.version)
self.act_and_assert(bpm, class_under_test, expected_calls, note_numbers, transcribed_data,
ultrastar_file_output)
class_under_test.version = "1.1.0"
expected_calls = self.default_values(class_under_test, class_under_test.version)
self.act_and_assert(bpm, class_under_test, expected_calls, note_numbers, transcribed_data,
ultrastar_file_output)
@@ -23,19 +34,34 @@ class TestCreateUltrastarTxt(unittest.TestCase):
# Arrange
bpm, note_numbers, transcribed_data, ultrastar_file_output = self.arrange()
# Assert full values
class_under_test = UltrastarTxtValue()
class_under_test.artist = "artist"
class_under_test.title = "title"
class_under_test.year = "2023"
class_under_test.language = "de"
class_under_test.genre = "pop, rock"
class_under_test.tags = "pop, rock"
class_under_test.cover = "cover [CO].jpg"
class_under_test.video = "video.mp4"
class_under_test.mp3 = "music.mp3"
class_under_test.audio = "music.mp3"
class_under_test.vocals = "vocals.mp3"
class_under_test.instrumental = "instrumental.mp3"
expected_calls = self.full_values(class_under_test)
# Act and Assert full values
class_under_test.version = "0.2.0"
expected_calls = self.full_values(class_under_test, class_under_test.version)
self.act_and_assert(bpm, class_under_test, expected_calls, note_numbers, transcribed_data,
ultrastar_file_output)
class_under_test.version = "1.0.0"
expected_calls = self.full_values(class_under_test, class_under_test.version)
self.act_and_assert(bpm, class_under_test, expected_calls, note_numbers, transcribed_data,
ultrastar_file_output)
class_under_test.version = "1.1.0"
expected_calls = self.full_values(class_under_test, class_under_test.version)
self.act_and_assert(bpm, class_under_test, expected_calls, note_numbers, transcribed_data,
ultrastar_file_output)
@@ -80,49 +106,58 @@ class TestCreateUltrastarTxt(unittest.TestCase):
self.assertEqual(write_calls, expected_calls_default_values)
@staticmethod
def default_values(default_ultrastar_class):
expected_calls = [
#f"#{UltrastarTxtTag.VERSION}:{default_ultrastar_class.version}\n", # todo: Version definition is in progress
f"#{UltrastarTxtTag.ARTIST}:{default_ultrastar_class.artist}\n",
f"#{UltrastarTxtTag.TITLE}:{default_ultrastar_class.title}\n",
f"#{UltrastarTxtTag.MP3}:{default_ultrastar_class.mp3}\n",
f"#{UltrastarTxtTag.VIDEO}:{default_ultrastar_class.video}\n", # todo: video is optional
f"#{UltrastarTxtTag.BPM}:390.0\n",
f"#{UltrastarTxtTag.GAP}:500\n",
f"#{UltrastarTxtTag.CREATOR}:{default_ultrastar_class.creator}\n",
f"#{UltrastarTxtTag.COMMENT}:{default_ultrastar_class.comment}\n",
": 0 52 1 UltraSinger \n",
"- 52\n",
": 65 39 2 is \n",
"- 104\n",
": 130 52 3 cool! \n",
"E"
]
def default_values(default_ultrastar_class, ver):
expected_calls = []
if version.parse(ver) >= version.parse("1.0.0"):
expected_calls.append(f"#{UltrastarTxtTag.VERSION}:{default_ultrastar_class.version}\n")
expected_calls.append(f"#{UltrastarTxtTag.ARTIST}:{default_ultrastar_class.artist}\n")
expected_calls.append(f"#{UltrastarTxtTag.TITLE}:{default_ultrastar_class.title}\n")
expected_calls.append(f"#{UltrastarTxtTag.MP3}:{default_ultrastar_class.mp3}\n")
if version.parse(ver) >= version.parse("1.1.0"):
expected_calls.append(f"#{UltrastarTxtTag.AUDIO}:{default_ultrastar_class.audio}\n")
expected_calls.append(f"#{UltrastarTxtTag.VIDEO}:{default_ultrastar_class.video}\n") # todo: video is optional
expected_calls.append(f"#{UltrastarTxtTag.BPM}:390.0\n")
expected_calls.append(f"#{UltrastarTxtTag.GAP}:500\n")
expected_calls.append(f"#{UltrastarTxtTag.CREATOR}:{default_ultrastar_class.creator}\n")
expected_calls.append(f"#{UltrastarTxtTag.COMMENT}:{default_ultrastar_class.comment}\n")
expected_calls.append(": 0 52 1 UltraSinger \n")
expected_calls.append("- 52\n")
expected_calls.append(": 65 39 2 is \n")
expected_calls.append("- 104\n")
expected_calls.append(": 130 52 3 cool! \n")
expected_calls.append("E")
return expected_calls
@staticmethod
def full_values(default_ultrastar_class):
expected_calls = [
#f"#{UltrastarTxtTag.VERSION}:{default_ultrastar_class.version}\n", # todo: Version definition is in progress
f"#{UltrastarTxtTag.ARTIST}:{default_ultrastar_class.artist}\n",
f"#{UltrastarTxtTag.TITLE}:{default_ultrastar_class.title}\n",
f"#{UltrastarTxtTag.YEAR}:{default_ultrastar_class.year}\n",
f"#{UltrastarTxtTag.LANGUAGE}:German\n",
f"#{UltrastarTxtTag.GENRE}:{default_ultrastar_class.genre}\n",
f"#{UltrastarTxtTag.COVER}:{default_ultrastar_class.cover}\n",
f"#{UltrastarTxtTag.MP3}:{default_ultrastar_class.mp3}\n",
f"#{UltrastarTxtTag.VIDEO}:{default_ultrastar_class.video}\n",
f"#{UltrastarTxtTag.BPM}:390.0\n",
f"#{UltrastarTxtTag.GAP}:500\n",
f"#{UltrastarTxtTag.CREATOR}:{default_ultrastar_class.creator}\n",
f"#{UltrastarTxtTag.COMMENT}:{default_ultrastar_class.comment}\n",
": 0 52 1 UltraSinger \n",
"- 52\n",
": 65 39 2 is \n",
"- 104\n",
": 130 52 3 cool! \n",
"E"
]
def full_values(default_ultrastar_class, ver):
expected_calls = []
if version.parse(ver) >= version.parse("1.0.0"):
expected_calls.append(f"#{UltrastarTxtTag.VERSION}:{default_ultrastar_class.version}\n")
expected_calls.append(f"#{UltrastarTxtTag.ARTIST}:{default_ultrastar_class.artist}\n")
expected_calls.append(f"#{UltrastarTxtTag.TITLE}:{default_ultrastar_class.title}\n")
expected_calls.append(f"#{UltrastarTxtTag.YEAR}:{default_ultrastar_class.year}\n")
expected_calls.append(f"#{UltrastarTxtTag.LANGUAGE}:German\n")
expected_calls.append(f"#{UltrastarTxtTag.GENRE}:{default_ultrastar_class.genre}\n")
expected_calls.append(f"#{UltrastarTxtTag.COVER}:{default_ultrastar_class.cover}\n")
expected_calls.append(f"#{UltrastarTxtTag.MP3}:{default_ultrastar_class.mp3}\n")
if version.parse(ver) >= version.parse("1.1.0"):
expected_calls.append(f"#{UltrastarTxtTag.AUDIO}:{default_ultrastar_class.audio}\n")
expected_calls.append(f"#{UltrastarTxtTag.VOCALS}:{default_ultrastar_class.vocals}\n")
expected_calls.append(f"#{UltrastarTxtTag.INSTRUMENTAL}:{default_ultrastar_class.instrumental}\n")
expected_calls.append(f"#{UltrastarTxtTag.TAGS}:{default_ultrastar_class.tags}\n")
expected_calls.append(f"#{UltrastarTxtTag.VIDEO}:{default_ultrastar_class.video}\n")
expected_calls.append(f"#{UltrastarTxtTag.BPM}:390.0\n")
expected_calls.append(f"#{UltrastarTxtTag.GAP}:500\n")
expected_calls.append(f"#{UltrastarTxtTag.CREATOR}:{default_ultrastar_class.creator}\n")
expected_calls.append(f"#{UltrastarTxtTag.COMMENT}:{default_ultrastar_class.comment}\n")
expected_calls.append(": 0 52 1 UltraSinger \n")
expected_calls.append("- 52\n")
expected_calls.append(": 65 39 2 is \n")
expected_calls.append("- 104\n")
expected_calls.append(": 130 52 3 cool! \n")
expected_calls.append("E")
return expected_calls
@staticmethod
+2 -1
View File
@@ -23,4 +23,5 @@ isort~=5.12
black~=23.3
pylint~=2.17
pytest~=7.3.1
protobuf==3.20.*
protobuf==3.20.*
packaging~=23.2
@@ -27,6 +27,10 @@ def parse_ultrastar_txt(input_file: str) -> UltrastarTxtValue:
ultrastar_class.title = line.split(":")[1].replace("\n", "")
elif line.startswith(f"#{UltrastarTxtTag.MP3}"):
ultrastar_class.mp3 = line.split(":")[1].replace("\n", "")
elif line.startswith(f"#{UltrastarTxtTag.AUDIO}"):
ultrastar_class.audio = line.split(":")[1].replace("\n", "")
elif line.startswith(f"#{UltrastarTxtTag.VIDEO}"):
ultrastar_class.video = line.split(":")[1].replace("\n", "")
elif line.startswith(f"#{UltrastarTxtTag.GAP}"):
ultrastar_class.gap = line.split(":")[1].replace("\n", "")
elif line.startswith(f"#{UltrastarTxtTag.BPM}"):
+39 -27
View File
@@ -1,4 +1,5 @@
"""Ultrastar TXT"""
from enum import Enum
FILE_ENCODING = "utf-8"
@@ -7,54 +8,61 @@ FILE_ENCODING = "utf-8"
class UltrastarTxtTag(str, Enum):
"""Tags for Ultrastar TXT files."""
VERSION = 'VERSION' # Version of the file format: See https://usdx.eu/format/
# 0.2.0
VERSION = 'VERSION' # Version of the file format: See https://usdx.eu/format/
ARTIST = 'ARTIST'
TITLE = 'TITLE'
MP3 = 'MP3'
MP3 = 'MP3' # Removed in v2.0.0
GAP = 'GAP'
BPM = 'BPM'
LANGUAGE = 'LANGUAGE'
LANGUAGE = 'LANGUAGE' # Multi-language support since v1.1.0
GENRE = 'GENRE' # Multi-language support since v1.1.0
YEAR = 'YEAR' # Multi-language support since v1.1.0
COVER = 'COVER' # Path to cover. Should end with `*[CO].jpg`
CREATOR = 'CREATOR'
CREATOR = 'CREATOR' # Multi-language support since v1.1.0
COMMENT = 'COMMENT'
VIDEO = 'VIDEO'
FILE_END = 'E'
LINEBREAK = '-'
# Unused
# 1.1.0
AUDIO = 'AUDIO' # Its instead of MP3. Just renamed
VOCALS = 'VOCALS' # Vocals only audio
INSTRUMENTAL = 'INSTRUMENTAL' # Instrumental only audio
TAGS = 'TAGS' # Tags for the song. Can be used for filtering
# Unused 0.2.0
BACKGROUND = 'BACKGROUND' # Path to background. Is shown when there is no video. Should end with `*[BG].jpg`
VIDEOGAP = 'VIDEOGAP'
GENRE = 'GENRE'
EDITION = 'EDITION'
YEAR = 'YEAR'
EDITION = 'EDITION' # Multi-language support since v1.1.0
START = 'START'
END = 'END'
PREVIEWSTART = 'PREVIEWSTART'
MEDLEYSTARTBEAT = 'MEDLEYSTARTBEAT'
MEDLEYENDBEAT = 'MEDLEYENDBEAT'
MEDLEYSTARTBEAT = 'MEDLEYSTARTBEAT' # Removed in 2.0.0
MEDLEYENDBEAT = 'MEDLEYENDBEAT' # Removed in v2.0.0
CALCMEDLEY = 'CALCMEDLEY'
P1 = 'P1' # Only for UltraStar Deluxe
P2 = 'P2' # Only for UltraStar Deluxe
DUETSINGERP1 = 'DUETSINGERP1' # Removed in 1.0.0 (Used by UltraStar WorldParty)
DUETSINGERP2 = 'DUETSINGERP2' # Removed in 1.0.0 (Used by UltraStar WorldParty)
RESOLUTION = 'RESOLUTION' # Changes the grid resolution of the editor. Only for the editor and nothing for singing. # Removed in 1.0.0
NOTESGAP = 'NOTESGAP' # Removed in 1.0.0
RELATIVE = 'RELATIVE' # Removed in 1.0.0
ENCODING = 'ENCODING' # Removed in 1.0.0
FIXER = 'FIXER' # Only used in UltraStar World Party
# (Unused) 1.1.0
PROVIDEDBY = 'PROVIDEDBY' # Should the URL from hoster server
# (Unused) deprecated since 1.0.0
DUETSINGERP1 = 'DUETSINGERP1'
DUETSINGERP2 = 'DUETSINGERP2'
RESOLUTION = 'RESOLUTION' # Changes the grid resolution of the editor. Only for the editor and nothing for singing.
NOTESGAP = 'NOTESGAP'
RELATIVE = 'RELATIVE'
ENCODING = 'ENCODING'
# (Unused) New in (unreleased) 1.2.0
AUDIOURL = 'AUDIOURL' # URL to the audio file
COVERURL = 'COVERURL' # URL to the cover file
BACKGROUNDURL = 'BACKGROUNDURL' # URL to the background file
VIDEOURL = 'VIDEOURL' # URL to the video file
# (Unused) New in (unreleased) 2.0.0
MEDLEYSTART = 'MEDLEYSTART' # Rename of MEDLEYSTARTBEAT
MEDLEYEND = 'MEDLEYEND' # Renmame of MEDLEYENDBEAT
# (Unused) New in 1.1.0
AUDIO = 'AUDIO' # Its instead of MP3. Just renamed
VOCALS = 'VOCALS' # Vocals only audio
INSTRUMENTAL = 'INSTRUMENTAL' # Instrumental only audio
ONLINE = 'ONLINE' # URL of the song/video online
MUSICDB = 'MUSICDB' # ID or other of an online DB like musicbrainz
DIFFICULTY = 'DIFFICULTY' # Difficulty of the song
MEDLEYSTART = 'MEDLEYSTART' # Rename of MEDLEYSTARTBEAT
MEDLEYEND = 'MEDLEYEND' # Renmame of MEDLEYENDBEAT
class UltrastarTxtNoteTypeTag(str, Enum):
"""Note types for Ultrastar TXT files."""
@@ -74,11 +82,15 @@ class UltrastarTxtValue:
year = None
genre = ""
mp3 = ""
audio = ""
video = None
gap = ""
bpm = ""
language = None
cover = None
vocals = None
instrumental = None
tags = None
creator = "UltraSinger [GitHub]"
comment = "UltraSinger [GitHub]"
startBeat = []
+11 -3
View File
@@ -1,7 +1,7 @@
"""Ultrastar writer module"""
import re
from packaging import version
import langcodes
from modules.console_colors import ULTRASINGER_HEAD
@@ -47,7 +47,6 @@ def get_multiplier(real_bpm: float) -> int:
multiplier += 1
return multiplier - 2
def get_language_name(language: str) -> str:
"""Creates the language name from the language code"""
@@ -75,7 +74,8 @@ def create_ultrastar_txt_from_automation(
with open(ultrastar_file_output, "w", encoding=FILE_ENCODING) as file:
gap = transcribed_data[0].start
# file.write(f"#{UltrastarTxtTag.VERSION}:{ultrastar_class.version}\n"),
if version.parse(ultrastar_class.version) >= version.parse("1.0.0"):
file.write(f"#{UltrastarTxtTag.VERSION}:{ultrastar_class.version}\n"),
file.write(f"#{UltrastarTxtTag.ARTIST}:{ultrastar_class.artist}\n")
file.write(f"#{UltrastarTxtTag.TITLE}:{ultrastar_class.title}\n")
if ultrastar_class.year is not None:
@@ -87,6 +87,14 @@ def create_ultrastar_txt_from_automation(
if ultrastar_class.cover is not None:
file.write(f"#{UltrastarTxtTag.COVER}:{ultrastar_class.cover}\n")
file.write(f"#{UltrastarTxtTag.MP3}:{ultrastar_class.mp3}\n")
if version.parse(ultrastar_class.version) >= version.parse("1.1.0"):
file.write(f"#{UltrastarTxtTag.AUDIO}:{ultrastar_class.audio}\n")
if ultrastar_class.vocals is not None:
file.write(f"#{UltrastarTxtTag.VOCALS}:{ultrastar_class.vocals}\n")
if ultrastar_class.instrumental is not None:
file.write(f"#{UltrastarTxtTag.INSTRUMENTAL}:{ultrastar_class.instrumental}\n")
if ultrastar_class.tags is not None:
file.write(f"#{UltrastarTxtTag.TAGS}:{ultrastar_class.tags}\n")
file.write(f"#{UltrastarTxtTag.VIDEO}:{ultrastar_class.video}\n")
file.write(f"#{UltrastarTxtTag.BPM}:{round(ultrastar_bpm, 2)}\n") # not the real BPM!
file.write(f"#{UltrastarTxtTag.GAP}:{int(gap * 1000)}\n")