Added LLPractice beatmap support

Author: MikuAuahDark

docs/How_To_Setup.md

@@ -0,0 +1,135 @@
+#How To Setup
+
+This page will guide you step-by-step how to run DEPLS2 for the first time. The key of getting DEPLS2 run is not hard, but not easy either.
+
+##System Requirements
+
+Before you proceed, make sure your device comply these requirements
+
+* At least 1.3GHz dual core. More complex storyboard system requires more power and RAM
+
+* At least 256MB of free RAM.
+
+* OpenGL 2.1 (or OpenGLES 2 for Android) capable graphics card
+
+* Windows: Windows Vista or above (sorry Windows XP users)
+
+* Ubuntu: Ubuntu 14.04 - 16.10
+
+* Mac OS X: Mac OS X v10.7 or above.
+
+* Android: Android v2.3 or above.
+
+* **iOS: Not supported!**
+
+##Getting LOVE2D and run DEPLS
+
+If your device comply with requirements above, then proceed. DEPLS2 requires LOVE2D v0.10.0 (or later) game framework. Below are steps to get LOVE2D installed.
+
+###Windows
+
+1. Clone this repository with git or download it as zip. Make sure you extract the zip.
+
+2. Download LOVE2D [here](https://love2d.org/). Zip file is recommended.
+
+3. Extract it somewhere and open command prompt in location where you extracted LOVE2D.
+
+4. Now, type `lovec <DEPLS2 folder>`. If it works correctly, you'll see DEPLS2 main menu.
+
+> `lovec` is available in LOVE2D v0.10.2 and later. It's not hard to create one for older version if you have VS command prompt. To create `lovec`, run `copy love.exe lovec.exe && editbin /SUBSYSTEM:CONSOLE lovec.exe` in VS command prompt.
+
+###Ubuntu
+
+1. Clone this repository with git or download it as zip. Make sure you extract the zip.
+
+2. Add [this PPA](https://launchpad.net/~bartbes/+archive/love-stable) to your apt repository.
+
+3. Type `sudo apt-get update` and `sudo apt-get install love`.
+
+4. Type `love <DEPLS2 folder>`. If it works correctly, you'll see DEPLS2 main menu
+
+###Mac OS X
+
+*TODO: Add Mac OS X instructions*
+
+###Android
+
+1. Clone this repository or download zip. Push all files to somewhere in your phone in `DEPLS-DEPLS2` folder if you download it as ZIP, or simply push all files to your phone except `.git` folder (might be hidden).
+
+2. Download LOVE2D APK from [LOVE2D](https://love2d.org/) website, or from Play Store.
+
+3. Find DEPLS2 `main.lua` in your phone, and open it with LOVE2D
+
+4. If it works, you'll see DEPLS2 main menu, but to play beatmaps, you have to specify it **in command-line**. Well, you can't pass the beatmap name in command-line because there is no such thing in Android, so special steps is required for Android. See below
+
+##Determining DEPLS R/W directory
+
+It's necessary so that you can add beatmaps. If you're under Windows, Ubuntu, or Mac OS X, look at the terminal output (in Windows, use `lovec` instead of `love`). It will write `R/W Directory: <DEPLS2 R/W directory>`. Example in Windows: `R/W Directory: C:/Users/User/AppData/Roaming/LOVE/DEPLS`.
+
+If you're under Android, most of the time it's in `/sdcard/Android/data/org.love2d.android/files/save/DEPLS`. If you didn't see that folder, open a new issue specifying your device. It is because if you run it for the first time, DEPLS will create it's own R/W directory, and guaranteed to be created.
+
+##Adding beatmaps
+
+DEPLS2 supports these beatmap formats:
+
+* DEPLS beatmap folder. It combines CBF format and raw SIF format. Additionaly with storyboard support.
+
+* raw SIF beatmap, without score information. Stripped from SIF response data. This is beatmap format internally used by DEPLS, without any modification. The extension is `.json`
+
+* yuyu live simulator beatmap, the one with `.txt` extension (not `.ssp` one)
+
+* Custom Beatmap Festival project folder. CBF to SIF beatmap conversion will be done, and actually converts it to DEPLS beatmap folder.
+
+* Specialized MIDI file. The extension is `.mid`
+
+* LLPractice beatmap. The extension is `.llp` (make sure to rename it to prevent confusion)
+
+* SIFTrain beatmap. The extension is `.rs`. **Currently disabled due to processing bug**. There's problem in SIFTrain beatmap which causes JSON parse error. This is SIFTrain fault, since DEPLS2 uses JSON library which comply with JSON standards. To fix it, open the beatmap with text editor and add double quote the value in the `music_file`.
+
+DEPLS supports these audio formats
+
+* Raw PCM in WAV container
+
+* Vorbis in OGG container
+
+* MPEG Audio Layer 3/MP3
+
+DEPLS also uses that order to load audio files. So if you have `beatmap.ogg` and `beatmap.wav`, `beatmap.wav` will be loaded because it has higher priority.
+
+Add the beatmap file/folder in `<DEPLS2 R/W directory>/beatmap` and the optionally the audio in `<DEPLS2 R/W directory>/audio`. The audio name must same with the beatmap name, or explictly specify the used audio in the command-line (discussed later).
+
+##Starting beatmap
+
+Note: Beatmap name and audio file is relative to `<DEPLS2 R/W dir>/beatmap/` and `<DEPLS2 R/W dir>/audio/` folder respectively. Specifying audio file argument is optional, and DEPLS will try to load audio in beatmap folder (if it's DEPLS/CBF beatmap folder) or in audio folder with the audio filename same as the beatmap name (and will try to load WAV or OGG audio).
+
+###Android
+
+In Android, write file named `command_line.txt` in DEPLS2 R/W directory with this contents
+
+	livesim
+    <beatmap name without extension>
+    <used audio with extension (optional)>
+
+Then start DEPLS like the way described above.
+
+###Desktop (Windows, Ubuntu, Mac OS X)
+
+Start LOVE2D with this command-line arguments
+
+    love <DEPLS2 folder> livesim <beatmap name without extension> [audio filename with extension]
+
+Note: in windows, use `lovec` instead of `love` to keep the terminal waits for love to exits.
+
+##Example Beatmap
+
+To run example beatmap, the beatmap name must be start with two colons then followed by the example beatmap ID. So it will be
+
+    love <DEPLS2 folder> livesim ::<id>
+
+Here is example beatmap IDs:
+
+1. [Daydream Warrior beatmap](https://www.youtube.com/watch?v=PpZqNjv0HUw)
+
+2. [MOMENT RING beatmap](https://www.youtube.com/watch?v=u76q9x7lOzA)
+
+As times goes on, I might add more exampe beatmaps.

docs/Storyborad.md

@@ -0,0 +1,110 @@
+Lua Storyboard
+==============
+
+Lua storyboard is simply a Lua script which controls how objects shown behind the simulator.
+Please note that Lua script running as Lua storyboard is sandboxed, which means most of `love`
+functions doesn't exist in here or modified to prevent alteration of the rendering state, and
+to prevent malicious Lua storyboard script writing anywhere.
+
+Storyboard Functions
+====================
+
+This function only exist on storyboard lua script.
+
+*************************************************
+
+### `void SetLiveOpacity (number opacity)`
+
+Sets the Live Show! image opacity. This includes unit, header, notes, and more.
+
+Parameters:
+
+* `opacity` - The opacity, range from 0-255. 0 for invisible, 255 for opaque (fully visible)
+
+Returns: *none*
+
+*************************************************
+
+### `void SetBackgroundDimOpacity(number opacity)`
+
+Sets background blackness (but not entirely black)
+
+Parameters:
+
+* `opacity` - Background blackness, from 0-255. 0 for full black (approx. 190 blackness), 255 for full bright
+
+Returns: *none*
+
+*************************************************
+
+### `number GetCurrentElapsedTime()`
+
+Get current elapsed time in DEPLS.
+
+Returns: Elapsed time, in milliseconds. Negative value means simulator is not started yet
+
+*************************************************
+
+### `number GetLiveSimulatorDelay()`
+
+Get live simulator delay. Delay before live simulator is shown
+
+Returns: Live simulator delay, in milliseconds
+
+*************************************************
+
+### `void SpawnCircleTapEffect(number pos [, number r = 255 [, number g = 255 [, number b = 255]]])`
+
+Show circletap effect in the specificed idol position and with specificed color
+
+Parameters:
+
+* `pos` - The idol position. 1 is rightmost, 9 is leftmost
+
+* `r` - Red color component of the circletap (defaults to 255)
+
+* `g` - Green color component of the circletap (defaults to 255)
+
+* `b` - Blue color component of the circletap (defaults to 255)
+
+Returns: *none*
+
+*************************************************
+
+### `Video|nil LoadVideo(string path)`
+
+Load video file. Directory is relative to current beatmap folder
+
+Parameters:
+
+* `path` - Video filename
+
+Returns: love2d `Video` object or `nil` on failure
+
+> For additional sandboxing and compatibility, this is synonym of `love.graphics.newVideo`
+
+*************************************************
+
+### `Image|nil LoadImage(string path)`
+
+Load image. Directory is relative to current beatmap folder
+
+Parameters:
+
+* `path` - Image filename
+
+Returns: love2d `Image` object or `nil` on failure
+
+> For additional sandboxing and compatibility, this is synonym of `love.graphics.newImage`
+
+*************************************************
+
+### `string|nil ReadFile(string path)`
+
+Reads the contents of file. Directory is relative to current beatmap folder
+
+Parameters:
+
+* `path` - File to get it's contents
+
+Returns: The contents of the file, or `nil` on failure

llp2sif.lua

@@ -0,0 +1,38 @@
+-- LLPractice to SIF beatmap converter
+
+--! @brief Converts LLPractice beatmap to SIF beatmap
+--! @param llp The LLPractice JSON decoded data to table
+--! @returns SIF-compilant beatmap in table
+--! @note Modify `LLP_SIFT_DEFATTR` to change default attribute
+local llp2sif = function(llp)
+	local DEPLS = _G.DEPLS
+	local attribute = DEPLS.LoadConfig("LLP_SIFT_DEFATTR", 1)	-- Smile is default
+	local offset = (llp.offsettime or 0) / 1000	-- In seconds
+	local sif_map = {}
+	
+	for n, v in pairs(llp.lane) do
+		for a, b in pairs(v) do
+			local new_effect = 1
+			local new_effect_val = 2
+			
+			if b.longnote then
+				new_effect = 3
+				new_effect_val = (b.endtime - b.starttime) / 1000
+			end
+			
+			sif_map[#sif_map + 1] = {
+				timing_sec = b.starttime / 1000,
+				notes_attribute = attribute or 1,
+				notes_level = 1,
+				effect = new_effect,
+				effect_value = new_effect_val,
+				position = 9 - b.lane
+			}
+		end
+	end
+	
+	table.sort(sif_map, function(a, b) return a.timing_sec < b.timing_sec end)
+	return sif_map
+end
+
+return llp2sif

luastoryboard.lua

@@ -88,6 +88,7 @@ local isolated_love = {
 	timer = love.timer
 }
 
+-- List of whitelisted libraries for storyboard
 local allowed_libs = {
 	JSON = require("JSON"),
 	List = require("List"),
@@ -126,6 +127,7 @@ function LuaStoryboard.Load(file)
 	env.dofile = nil
 	env.package = nil
 	env.love = isolated_love
+	env.file_get_contents = nil
 	env.require = function(libname)
 		if allowed_libs[libname] then
 			return allowed_libs[libname]

note_loader.lua

@@ -132,7 +132,6 @@ noteloader = function(path)
 		-- SifSimu beatmap
 		local sifsimu2sif = require("sifsimu2sif")
 
-		-- No longer creates additional JSON
 		output.notes_list = sifsimu2sif(love.filesystem.getSaveDirectory().."/beatmap/"..path..".txt", love.filesystem.getSaveDirectory().."/beatmap/"..path..".json")
 	elseif love.filesystem.isFile("beatmap/"..path..".mid") then
 		-- MIDI beatmap
@@ -143,6 +142,37 @@ noteloader = function(path)
 		f:close()
 
 		output.notes_list = ndata
+	elseif love.filesystem.isFile("beatmap/"..path..".llp") then
+		-- LLPractice beatmap
+		local llp2sif = require("llp2sif")
+		local ndata = JSON:decode(assert(love.filesystem.newFileData("beatmap/"..path..".llp")):getString())
+		
+		output.notes_list = llp2sif(ndata)
+		
+		if ndata.audiofile and #ndata.audiofile > 0 then
+			output.song_file = DEPLS.LoadAudio("audio/"..ndata.audiofile..".wav")
+		end
+	elseif love.filesystem.isFile("beatmap/"..path..".rs") then
+		-- SIFTrain beatmap
+		error("SIFTrain beatmap format is currently disabled")
+		
+		local rs2sif = require("rs2sif")
+		local ndata = JSON:decode(assert(love.filesystem.newFileData("beatmap/"..path..".rs")):getString())
+		
+		output.notes_list = rs2sif(ndata)
+		
+		if ndata.music_file and #ndata.music_file > 0 then
+			output.song_file = DEPLS.LoadAudio("audio/"..ndata.music_file..".wav")
+		end
+		
+		if ndata.rank_info then
+			output.score = {
+				ndata.rank_info[1].rank_max,
+				ndata.rank_info[2].rank_max,
+				ndata.rank_info[3].rank_max,
+				ndata.rank_info[4].rank_max
+			}
+		end
 	else
 		-- Unsupported beatmap
 		error("Cannot open beatmap \""..path.."\"")

rs2sif.lua

@@ -0,0 +1,41 @@
+-- SIFTrain to SIF beatmap convert
+
+local function hasbit(a, b)
+	return a % (b * 2) >= b
+end
+
+--! @brief Converts SIFTrain beatmap to SIF beatmap
+--! @param rs_map The SIFTrain JSON decoded data to table
+--! @returns SIF-compilant beatmap in table
+--! @note Modify `LLP_SIFT_DEFATTR` to change default attribute
+local function rs2sif(rs_map)
+	local DEPLS = _G.DEPLS
+	local attribute = DEPLS.LoadConfig("LLP_SIFT_DEFATTR", 1)
+	local sif_map = {}
+	
+	rs_map = rs_map.song_info[1].notes
+	
+	for n, v in pairs(rs_map) do
+		local new_effect = 1
+		
+		if hasbit(v.effect, 3) then
+			new_effect = 3
+		elseif hasbit(v.effect, 4) then
+			new_effect = 4
+		end
+		
+		table.insert(sif_map, {
+			timing_sec = v.timing_sec,
+			notes_attribute = attribute or 1,
+			notes_level = 1,
+			effect = new_effect,
+			effect_value = v.effect_value,
+			position = v.position
+		})
+	end
+	
+	table.sort(sif_map, function(a, b) return a.timing_sec < b.timing_sec end)
+	return sif_map
+end
+
+return rs2sif