Update README.md

README.md

@@ -18,8 +18,135 @@ In [CLaMP: Contrastive Language-Music Pre-training for Cross-Modal Symbolic Musi
 
 WikiMT is a unique resource to support the evaluation of semantic search and music classification. However, it is important to acknowledge that the dataset was curated from publicly available sources, and there may be limitations concerning the accuracy and completeness of the genre and description information. Further research is needed to explore the potential biases and limitations of the dataset and to develop strategies to address them. Therefore, to support additional investigations, we also provide the [source files](https://github.com/microsoft/muzic/blob/main/clamp/wikimusictext/source_files.zip) of WikiMT, including the MusicXML files from Wikifonia and the original entries from Wikipedia.
 
+## Obtaining ABC Notation Music Scores
+
+To access ABC notation music scores from the WikiMT dataset, you will need to follow these steps:
+
+1. **Find the Wikifonia Data Link:** The code provided does not offer a direct link to download Wikifonia.zip. To obtain the Wikifonia dataset, you must first locate a download link for the ABC notation data. You can search for it on the internet or on Wikifonia-related websites.
+
+2. **Run the Provided Code:** After finding the download link for the Wikifonia ABC notation data, you can execute the provided Python code. The code will prompt you to input the URL from which to fetch the ABC notation data. 
+
+   For example, you will be prompted to enter the URL as follows:
+   
+   ```python
+   Enter the Wikifonia URL: [Paste your URL here]
+   ```
+
+   Paste the URL to the Wikifonia.zip file and press Enter. The code will then proceed to download, process, and extract the musical content, making it accessible for your research or applications.
+
+By following these steps, you can successfully obtain ABC notation music scores from the WikiMT dataset after providing the necessary download link.
+
+```python
+import subprocess
+import os
+import json
+import zipfile
+import io
+
+# Install the required packages if they are not installed
+try:
+    from unidecode import unidecode
+except ImportError:
+    subprocess.check_call(["python", '-m', 'pip', 'install', 'unidecode'])
+    from unidecode import unidecode
+
+try:
+    from tqdm import tqdm
+except ImportError:
+    subprocess.check_call(["python", '-m', 'pip', 'install', 'tqdm'])
+    from tqdm import tqdm
+
+try:
+    import requests
+except ImportError:
+    subprocess.check_call(["python", '-m', 'pip', 'install', 'requests'])
+    import requests
+
+def filter(lines):
+    # Filter out all lines that include language information
+    music = ""
+    for line in lines:
+        if line[:2] in ['A:', 'B:', 'C:', 'D:', 'F:', 'G', 'H:', 'I:', 'N:', 'O:', 'R:', 'r:', 'S:', 'T:', 'W:', 'w:', 'X:', 'Z:'] \
+        or line=='\n' \
+        or (line.startswith('%') and not line.startswith('%%score')):
+            continue
+        else:
+            if "%" in line and not line.startswith('%%score'):
+                line = "%".join(line.split('%')[:-1])
+                music += line[:-1] + '\n'
+            else:
+                music += line + '\n'
+    return music
+
+def load_music(filename):
+    # Convert the file to ABC notation
+    p = subprocess.Popen(
+        f'cmd /u /c python xml2abc_145/xml2abc.py -m 2 -c 6 -x "{filename}"',
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        shell=True
+    )
+    out, err = p.communicate()
+
+    output = out.decode('utf-8').replace('\r', '')  # Capture standard output
+    music = unidecode(output).split('\n')
+    music = filter(music).strip()
+
+    return music
+
+def download_and_extract(url):
+    print(f"Downloading {url}")
+
+    # Send an HTTP GET request to the URL and get the response
+    response = requests.get(url, stream=True)
+
+    if response.status_code == 200:
+        # Create a BytesIO object and write the HTTP response content into it
+        zip_data = io.BytesIO()
+        total_size = int(response.headers.get('content-length', 0))
+        
+        with tqdm(total=total_size, unit='B', unit_scale=True) as pbar:
+            for data in response.iter_content(chunk_size=1024):
+                pbar.update(len(data))
+                zip_data.write(data)
+
+        # Use the zipfile library to extract the file
+        print("Extracting the zip file...")
+        with zipfile.ZipFile(zip_data, "r") as zip_ref:
+            zip_ref.extractall("")
+        
+        print("Done!")
+
+    else:
+        print("Failed to download the file. HTTP response code:", response.status_code)
+
+# Special thanks to Wim Vree for xml2abc.py
+download_and_extract("https://wim.vree.org/svgParse/xml2abc.py-145.zip")
+
+# Download the Wikifonia dataset
+wikifonia_url = input("Enter the Wikifonia URL: ")
+download_and_extract(wikifonia_url)
+
+wikimusictext = []
+with open("wikimusictext.jsonl", "r", encoding="utf-8") as f:
+    for line in f.readlines():
+        wikimusictext.append(json.loads(line))
+
+updated_wikimusictext = []
+
+for song in tqdm(wikimusictext):
+    filename = song["artist"] + " - " + song["title"] + ".mxl"
+    filepath = os.path.join("Wikifonia", filename)
+    song["music"] = load_music(filepath)
+    updated_wikimusictext.append(song)
+
+with open("wikimusictext.jsonl", "w", encoding="utf-8") as f:
+    for song in updated_wikimusictext:
+        f.write(json.dumps(song, ensure_ascii=False)+"\n")
+```
+
 ## Copyright Disclaimer
-WikiMT was curated from publicly available sources and is believed to be in the public domain. However, it is important to acknowledge that copyright issues cannot be entirely ruled out. Therefore, users of the dataset should exercise caution when using it. The authors of WikiMT do not assume any legal responsibility for the use of the dataset. If you have any questions or concerns regarding the dataset's copyright status, please contact the authors at shangda@mail.ccom.edu.cn.
+WikiMT was curated from publicly available sources, and all rights to the original content and data remain with their respective copyright holders. The dataset is made available for research and educational purposes, and any use, distribution, or modification of the dataset should comply with the terms and conditions set forth by the original data providers.
 
 ## BibTeX entry and citation info
 ```