New: Support background music from folder: MP3, M4A, WEBM, WEBA, OGG,…

… OPUS, WAV, FLAC
ollm · Jan 19, 2024 · 26947a2 · 26947a2
1 parent 7aee55c
commit 26947a2
Show file tree

Hide file tree

Showing 28 changed files with 264 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,7 +8,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ##### 🚀 New Features
 
-- Show error message if continue reading file does not exist
+- Show error message if continue reading file does not exist [`7aee55c`](https://github.com/ollm/OpenComic/commit/7aee55ca5dac6b937824728b7ded116dc00c28df)
+- Support background music from folder: MP3, M4A, WEBM, WEBA, OGG, OPUS, WAV, FLAC
 
 ##### 🐛 Bug Fixes
 

diff --git a/README.md b/README.md
@@ -27,6 +27,7 @@ More [Screenshots 📸](https://github.com/ollm/OpenComic/blob/master/SCREENSHOT
 - 🖼 Support this image formats: `JPG`, `PNG`, `APNG`, `AVIF`, `WEBP`, `GIF`, `SVG`, `BMP`, `ICO`
 - 🗄 Support this compressed formats: `RAR`, `ZIP`, `7Z`, `TAR`, `CBR`, `CBZ`, `CB7`, `CBT`
 - 📄 Support this documents/ebook formats: `PDF`, `EPUB` (Alpha)
+- 🎵 Support background music from folder: `MP3`, `M4A`, `WEBM`, `WEBA`, `OGG`, `OPUS`, `WAV`, `FLAC`
 - 📁 Master folders support
 - ☁️ Server connection support: `smb://`, `ftp://`, `ftps://`, `scp://`, `sftp://`, `ssh://`
 - 🇯🇵 Manga read mode

diff --git a/languages/ca.json b/languages/ca.json
@@ -169,6 +169,10 @@
 			"volumes": "Toms",
 			"volume": "Tom"
 		},
+		"music": {
+			"main": "Música",
+			"volume": "Volum"
+		},
 		"moreOptions": {
 			"main": "Més opcions",
 			"hideBarHeader": "Amaga la barra superior",

diff --git a/languages/cs.json b/languages/cs.json
@@ -169,6 +169,10 @@
 			"volumes": "Svazky",
 			"volume": "Svazek"
 		},
+		"music": {
+			"main": "",
+			"volume": ""
+		},
 		"moreOptions": {
 			"main": "Více nastavení",
 			"hideBarHeader": "Skrýt vrchní panel",

diff --git a/languages/de.json b/languages/de.json
@@ -169,6 +169,10 @@
 			"volumes": "Ausgaben",
 			"volume": "Ausgabe"
 		},
+		"music": {
+			"main": "",
+			"volume": ""
+		},
 		"moreOptions": {
 			"main": "",
 			"hideBarHeader": "",

diff --git a/languages/en.json b/languages/en.json
@@ -169,6 +169,10 @@
 			"volumes": "Volumes",
 			"volume": "Volume"
 		},
+		"music": {
+			"main": "Music",
+			"volume": "Volume"
+		},
 		"moreOptions": {
 			"main": "More options",
 			"hideBarHeader": "Hide header bar",

diff --git a/languages/es.json b/languages/es.json
@@ -169,6 +169,10 @@
 			"volumes": "Tomos",
 			"volume": "Tomo"
 		},
+		"music": {
+			"main": "Música",
+			"volume": "Volumen"
+		},
 		"moreOptions": {
 			"main": "Más opciones",
 			"hideBarHeader": "Ocultar barra superior",

diff --git a/languages/fr.json b/languages/fr.json
@@ -169,6 +169,10 @@
 			"volumes": "Volumes",
 			"volume": "Volume"
 		},
+		"music": {
+			"main": "",
+			"volume": ""
+		},
 		"moreOptions": {
 			"main": "",
 			"hideBarHeader": "",

diff --git a/languages/hu.json b/languages/hu.json
@@ -169,6 +169,10 @@
 			"volumes": "Volumes",
 			"volume": "Volume"
 		},
+		"music": {
+			"main": "",
+			"volume": ""
+		},
 		"moreOptions": {
 			"main": "",
 			"hideBarHeader": "",

diff --git a/languages/it.json b/languages/it.json
@@ -169,6 +169,10 @@
 			"volumes": "",
 			"volume": ""
 		},
+		"music": {
+			"main": "",
+			"volume": ""
+		},
 		"moreOptions": {
 			"main": "",
 			"hideBarHeader": "",

diff --git a/languages/ja.json b/languages/ja.json
@@ -169,6 +169,10 @@
 			"volumes": "巻",
 			"volume": "巻"
 		},
+		"music": {
+			"main": "",
+			"volume": ""
+		},
 		"moreOptions": {
 			"main": "",
 			"hideBarHeader": "",

diff --git a/languages/pt-br.json b/languages/pt-br.json
@@ -169,6 +169,10 @@
 			"volumes": "",
 			"volume": ""
 		},
+		"music": {
+			"main": "",
+			"volume": ""
+		},
 		"moreOptions": {
 			"main": "",
 			"hideBarHeader": "",

diff --git a/languages/ru.json b/languages/ru.json
@@ -169,6 +169,10 @@
 			"volumes": "Тома",
 			"volume": "Том"
 		},
+		"music": {
+			"main": "",
+			"volume": ""
+		},
 		"moreOptions": {
 			"main": "Дополнительные параметры",
 			"hideBarHeader": "Скрыть панель заголовка",

diff --git a/languages/th.json b/languages/th.json
@@ -169,6 +169,10 @@
 			"volumes": "เล่ม",
 			"volume": "เล่ม"
 		},
+		"music": {
+			"main": "",
+			"volume": ""
+		},
 		"moreOptions": {
 			"main": "ตัวเลือกเพิ่มเติม",
 			"hideBarHeader": "ซ่อนแถบส่วนบน",

diff --git a/languages/vi.json b/languages/vi.json
@@ -169,6 +169,10 @@
 			"volumes": "Tập",
 			"volume": "Tập"
 		},
+		"music": {
+			"main": "",
+			"volume": ""
+		},
 		"moreOptions": {
 			"main": "Thêm tùy chọn",
 			"hideBarHeader": "Ẩn thanh công cụ",

diff --git a/languages/zh-hans.json b/languages/zh-hans.json
@@ -169,6 +169,10 @@
 			"volumes": "卷",
 			"volume": "卷"
 		},
+		"music": {
+			"main": "",
+			"volume": ""
+		},
 		"moreOptions": {
 			"main": "更多选项",
 			"hideBarHeader": "隐藏标题栏",

diff --git a/languages/zh-hant.json b/languages/zh-hant.json
@@ -169,6 +169,10 @@
 			"volumes": "",
 			"volume": ""
 		},
+		"music": {
+			"main": "",
+			"volume": ""
+		},
 		"moreOptions": {
 			"main": "",
 			"hideBarHeader": "",

diff --git a/scripts/dom.js b/scripts/dom.js
@@ -362,6 +362,7 @@ async function loadIndexPage(animation = true, path = false, content = false, ke
 	onReading = _onReading = false;
 
 	reading.hideContent();
+	reading.music.pause();
 
 	generateAppMenu();
 
@@ -1904,6 +1905,15 @@ async function openComic(animation = true, path = true, mainPath = true, end = f
 	// Show loadign page
 	headerPath(path, mainPath);
 
+	// Load files
+	let file = fileManager.file(path);
+	let files = await file.read({filtered: false});
+
+	let hasMusic = await reading.music.has(files);
+	handlebarsContext.hasMusic = hasMusic;
+
+	files = fileManager.filtered(files);
+
 	handlebarsContext.comics = [];
 
 	if(fromDeepLoad && Date.now() - fromDeepLoadNow < 200)
@@ -1923,14 +1933,12 @@ async function openComic(animation = true, path = true, mainPath = true, end = f
 
 	template.loadContentLeft('reading.content.left.html', animation);
 
-	// Load files
-	let file = fileManager.file(path);
-	let files = await file.read();
-
 	let isCanvas = false;
 	let isEbook = false;
 	let compressedFile = fileManager.lastCompressedFile(path);
 
+	if(hasMusic) files.push(hasMusic); // Only to make available
+
 	if(compressedFile)
 	{
 		let features = fileManager.fileCompressed(compressedFile);
@@ -1957,6 +1965,8 @@ async function openComic(animation = true, path = true, mainPath = true, end = f
 		await file.makeAvailable(files, false, true);
 	}
 
+	if(hasMusic) files.pop(); // Remove now
+
 	file.destroy();
 
 	skipNextComic = await nextComic(path, mainPath);
@@ -2091,6 +2101,7 @@ async function openComic(animation = true, path = true, mainPath = true, end = f
 
 	reading.read(path, indexStart, end, isCanvas, isEbook, imagePath);
 	reading.hideContent(electronRemote.getCurrentWindow().isFullScreen(), true);
+	reading.music.read(hasMusic);
 
 	generateAppMenu();
 

diff --git a/scripts/file-manager.js b/scripts/file-manager.js
@@ -471,7 +471,7 @@ var file = function(path, config = false) {
 
 		let name = p.parse(path).name;
 
-		let regex = new RegExp('^(?:[\-\s0-9+])?(?:'+pregQuote(name)+(inside ? '|cover|default|folder|series|poster' : '')+')(?:[\-\s0-9+])?\.[a-z0-9]+$');
+		let regex = new RegExp('^(?:[\-\s0-9+])?(?:'+pregQuote(name)+'(?:[_-]?(?:cover|default|folder|series|poster|thumbnail))?'+(inside ? '|cover|default|folder|series|poster|thumbnail' : '')+')(?:[\-\s0-9+])?\.[a-z0-9]+$');
 		let poster = false;
 
 		let len = files.length

diff --git a/scripts/gamepad.js b/scripts/gamepad.js
@@ -704,6 +704,8 @@ function showMenu()
 	else
 		events.activeMenu(query, false, 'gamepad');
 
+	dom.query('.gamepad-reading-music').css({display: !handlebarsContext.hasMusic ? 'none' : ''});
+
 	if(!onReading)
 	{
 		let viewIcon = document.querySelector('.menu-gamepad-view-icon');

diff --git a/scripts/opencomic.js b/scripts/opencomic.js
@@ -321,6 +321,19 @@ var compatibleSpecialExtensions = [
 	'tbn',
 ];
 
+var audioExtensions = {
+	all: [
+		'mp3',
+		'm4a',
+		'webm',
+		'weba',
+		'ogg',
+		'opus',
+		'wav',
+		'flac',
+	],
+};
+
 //console.time('Require time 2');
 
 const app = require(p.join(appDir, 'scripts/app.js')),

diff --git a/scripts/reading.js b/scripts/reading.js
@@ -1,5 +1,6 @@
 const render = require(p.join(appDir, 'scripts/reading/render.js')),
 	filters = require(p.join(appDir, 'scripts/reading/filters.js')),
+	music = require(p.join(appDir, 'scripts/reading/music.js')),
 	readingEbook = require(p.join(appDir, 'scripts/reading/ebook.js'));
 
 var images = {}, imagesData = {}, imagesDataClip = {}, imagesPath = {}, imagesNum = 0, contentNum = 0, imagesNumLoad = 0, currentIndex = 1, imagesPosition = {}, imagesFullPosition = {}, foldersPosition = {}, indexNum = 0, imagesDistribution = [], currentPageXY = {x: 0, y: 0}, currentMousePosition = {pageX: 0, pageY: 0};
@@ -2103,7 +2104,7 @@ function fixBlurOnZoom(scale = 1, index = false)
 		img.style.width = (_width / window.devicePixelRatio)+'px';
 		img.style.height = (_height / window.devicePixelRatio)+'px';
 
-		if(img.classList.contains('blobRender'))
+		if(img.classList.contains('blobRender') || img.classList.contains('zoomOriginalSize') || img.classList.contains('originalSize'))
 			img.style.transform = 'scale('+_scale+') translate(0.001px, 0.001px)';
 		else
 			img.style.transform = 'scale('+_scale+')';
@@ -2120,7 +2121,7 @@ function fixBlurOnZoom(scale = 1, index = false)
 			{
 				let img = images[i];
 
-				if(!img.classList.contains('blobRender'))
+				if(!img.classList.contains('blobRender') && !img.classList.contains('zoomOriginalSize') && !img.classList.contains('originalSize'))
 				{
 					let rect = img.getBoundingClientRect();
 
@@ -5100,5 +5101,6 @@ module.exports = {
 	onLoad: onLoad,
 	ebook: readingEbook,
 	filters: filters,
+	music: music,
 	render: render,
 };