Add script to convert opus files to wav format

README.md

@@ -1,48 +1,48 @@
 ---
 language:
-- yue
+  - yue
 license: cc0-1.0
 size_categories:
-- 10K<n<100K
+  - 10K<n<100K
 task_categories:
-- automatic-speech-recognition
-- text-to-speech
-- text-generation
-- feature-extraction
-- audio-to-audio
-- audio-classification
-- text-to-audio
+  - automatic-speech-recognition
+  - text-to-speech
+  - text-generation
+  - feature-extraction
+  - audio-to-audio
+  - audio-classification
+  - text-to-audio
 pretty_name: c
 configs:
-- config_name: default
-  data_files:
-  - split: saamgwokjinji
-    path: data/saamgwokjinji-*
-  - split: seoiwuzyun
-    path: data/seoiwuzyun-*
+  - config_name: default
+    data_files:
+      - split: saamgwokjinji
+        path: data/saamgwokjinji-*
+      - split: seoiwuzyun
+        path: data/seoiwuzyun-*
 tags:
-- cantonese
-- audio
-- art
+  - cantonese
+  - audio
+  - art
 dataset_info:
   features:
-  - name: audio
-    dtype: audio
-  - name: id
-    dtype: string
-  - name: episode_id
-    dtype: int64
-  - name: audio_duration
-    dtype: float64
-  - name: transcription
-    dtype: string
+    - name: audio
+      dtype: audio
+    - name: id
+      dtype: string
+    - name: episode_id
+      dtype: int64
+    - name: audio_duration
+      dtype: float64
+    - name: transcription
+      dtype: string
   splits:
-  - name: saamgwokjinji
-    num_bytes: 2398591354.589
-    num_examples: 39173
-  - name: seoiwuzyun
-    num_bytes: 1243416911.25
-    num_examples: 18881
+    - name: saamgwokjinji
+      num_bytes: 2398591354.589
+      num_examples: 39173
+    - name: seoiwuzyun
+      num_bytes: 1243416911.25
+      num_examples: 18881
   download_size: 3690072406
   dataset_size: 3642008265.839
 ---
@@ -73,6 +73,7 @@ TTS 效果演示：https://huggingface.co/spaces/laubonghaudoi/zoengjyutgaai_tts
 - 所有文本都使用全角標點，冇半角標點。
 - 所有文本都用漢字轉寫，無阿拉伯數字無英文字母
 - 所有音頻源都存放喺`/source`，為方便直接用作訓練數據，切分後嘅音頻都放喺 `opus/`
+- 所有 opus 音頻皆為 48000 Hz 採樣率。
 - 所有源字幕 SRT 文件都存放喺 `srt/` 路經下，搭配 `source/` 下嘅音源可以直接作為帶字幕嘅錄音直接欣賞。
 - `cut.py` 係切分腳本，將對應嘅音源根據 srt 切分成短句並生成一個文本轉寫 csv。
 - `stats.py` 係統計腳本，運行佢就會顯示成個數據集嘅各項統計數據。
@@ -152,10 +153,17 @@ ffmpeg -i webm/saamgwokjinji/001.webm -c:a copy source/saamgwokjinji/001.opus
 # 或者轉 mp3
 ffmpeg -i mp3/mouzaakdung/001.mp3 -c:a libopus -map_metadata -1 -b:a 48k -vbr on source/mouzaakdung/001.opus
 # 將 opus 轉成無損 wav
-ffmpeg -i source/saamgwokjinji/001.opus -c:a copy wav/saamgwokjinji/001.wav
+ffmpeg -i source/saamgwokjinji/001.opus wav/saamgwokjinji/001.wav
 ```
 
-本數據集所有 opus 音頻皆為 48000 Hz 採樣率。
+如果想將所有 opus 文件全部轉換成 wav，可以直接運行`to_wav.sh`:
+
+```
+chmod +x to_wav.sh
+./to_wav.sh
+```
+
+跟住就會生成一個 `wav/` 路經，入面都係 `opus/` 對應嘅音頻。注意 wav 格式非常掗埞，成個 `opus/` 轉晒後會佔用至少 500GB 儲存空間，所以轉換之前記得確保有足夠空間。如果你想對音頻重採樣，亦都可以修改 `to_wav.sh` 入面嘅命令順便做重採樣。
 
 # The Zoeng Jyut Gaai Story-telling Speech Dataset
 
@@ -176,6 +184,7 @@ TTS demo: https://huggingface.co/spaces/laubonghaudoi/zoengjyutgaai_tts
 - All transcriptions use full-width punctuations, no half-width punctuations is used.
 - All transcriptions are in Chinese characters, no Arabic numbers or Latin letters.
 - All source audio are stored in `source/`. For the convenice of training, segmented audios are stored in `opus/`.
+- All opus audio are in 48000 Hz sampling rate.
 - All source subtitle SRT files are stored in `srt/`. Use them with the webm files to enjoy subtitled storytelling pieces.
 - `cut.py` is the script for cutting opus audios into senteneces based on the srt, and generates a csv file for transcriptions.
 - `stats.py` is the script for getting stats of this dataset.
@@ -215,3 +224,25 @@ git sparse-checkout set opus
 # Pull the content
 git pull origin main
 ```
+
+### Audio format conversion
+
+Install [ffmpeg](https://www.ffmpeg.org/download.html) first, then run：
+
+```bash
+# convert all webm into opus
+ffmpeg -i webm/saamgwokjinji/001.webm -c:a copy source/saamgwokjinji/001.opus
+# or into mp3
+ffmpeg -i mp3/mouzaakdung/001.mp3 -c:a libopus -map_metadata -1 -b:a 48k -vbr on source/mouzaakdung/001.opus
+# convert all opus into loseless wav
+ffmpeg -i source/saamgwokjinji/001.opus wav/saamgwokjinji/001.wav
+```
+
+If you want to convert all opus to wav, run `to_wav.sh`:
+
+```
+chmod +x to_wav.sh
+./to_wav.sh
+```
+
+It will generate a `wav/` path which contains all audios converted from `opus/`. Be aware the wav format is very space-consuming. A full conversion will take up at least 500GB space so make sure you have enough storage. If you want to resample the audio, modify the line within `to_wav.sh` to resample the audio while doing the conversion.

to_wav.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# Create the wav directory if it doesn't exist
+mkdir -p wav
+
+# Find all .opus files in the opus directory and loop through them
+find opus/ -name "*.opus" -print0 | while IFS= read -r -d $'\0' opus_file; do
+  # Construct the corresponding .wav file path
+  wav_file=$(echo "$opus_file" | sed 's|opus/|wav/|; s|\.opus$|\.wav|')
+
+  # Create the subdirectory in wav/ if it doesn't exist
+  mkdir -p "$(dirname "$wav_file")"
+
+  # Convert the .opus file to .wav using ffmpeg, preserving original quality
+  ffmpeg -i "$opus_file" "$wav_file"
+  # Uncomment the line below to resample to 44100 Hz
+  # ffmpeg -i "$opus_file" -ar 44100 "$wav_file"
+
+  echo "Converted: $opus_file -> $wav_file"
+done
+
+echo "Conversion complete."