Telepítési és Használati Útmutató

Átírás

1 Budapesti Műszaki és Gazdaságtudományi Egyetem Villamosmérnöki és Informatikai Kar Méréstechnika és Információs Rendszerek Tanszék Telepítési és Használati Útmutató MATLAB keretrendszer és Módszerek zeneszámok automatikus felismeréséhez Készítette Fülöp Tibor Konzulens Bank Balázs Program Verzió: Készült: május :39.

2 Tartalomjegyzék 1. A melléklet könyvtárai és fájljai 2 2. A program futtatásához szükséges konfiguráció 2 3. A telepítés és futtatás menete 2 4. Tesztfájlok típusai és futtatási módok Automatikus mód Manuális mód Tesztfájlok hozzáadása A tesztfájl-részletek kezeléséről A találati eredmények elérési útjai 4 6. Elérhetőség és felhasználási feltételek 4 1

3 1. A melléklet könyvtárai és fájljai A CD melléklet és a diplomaportálra feltöltött ZIP fájl a következő fájlokat és mappákat tartalmazza: - Program: A megvalósított keretrendszert, algoritmusokat és tesztfájl-részleteket 1 tartalmazó könyvtár - users_manual.pdf: Használati Útmutató - thesis.pdf: A teljes szakdolgozat PDF formátumban (csak CD-n) 2. A program futtatásához szükséges konfiguráció - (Legalább) MATLAB (R2008b) - LaTeX - Memória: Legalább 2GB RAM - Merevlemez: >200 MB szabad terület (A tesztadatbázis teljes analizálása minden segédfájllal és generált jegyzőkönyvvel együtt kb 160MB szabad helyet igényel) 3. A telepítés és futtatás menete A szakdolgozat részletesen leírja a könyvtárak, függvények és változók jelentéseit és lehetséges értékeit, ezért itt csak a főbb lépések és minimális magyarázat szerepel. A telepítés és futtatás menete: 1. A Program könyvtárat másoljuk át a saját merevlemezünkre 2. A Program könyvtárban a parameters.ini fájlon belül bármilyen szövegszerkesztő program segítségével lehetőségünk van a paraméterek értékeit beállítani 3. A futtatáshoz a MATLAB munkamappáját (Current Directory) állítsuk át a merevlemezre másolt Program könyvtár elérési útjára (pl: C:\Program) 4. Futtassuk a programot a main függvény segítségével 1 A teljes tesztfájl-részketeket tartalmazó adatbázis csak a CD-n található meg, a webes melléklet pedig 1 példafájlt tartalmaz. 2

4 4. Tesztfájlok típusai és futtatási módok A program az algoritmusok tesztelésére készült, ezért konkrét zeneszámok hangnemének felismeréséhez a zenefájlokat elő kell készíteni. A programot lehet manuális és automatikus módban használni Automatikus mód Kiválasztjuk a tesztfájlok típusát (small, big) a parameters.ini fájlban, és a program az előre előkészített információsfájlok feldolgozása után - a beállításoktól függően - legenerálja a jegyzőkönyveket és az összefoglalást, vagy számonként megjeleníti a detektálási eredményeket a MAT- LAB konzolján és létrehozza a grafikonokat Manuális mód A mód eléréséhez a megadott tesztfájl típusához (parameters.ini-ben testfile_type) nem kell írni semmilyen paramétert 2. Manuális mód esetén egy zeneszám analizálására van lehetőség. Ilyenkor a program bekéri a tesztfájl adatait: - Elérési út: A WAV fájl helye a merevlemezen (pl: C:\Zene\01_testfile.wav) - Előadó: A dal előadója (Jegyzőkönyv generálásához) - Dalcím: A dal címe (Jegyzőkönyv generálásához) - Album: A dal albuma (Jegyzőkönyv generálásához, nem kötelező megadni) - Valós hangnem: A dal hangneme az eredmények összehasonlításához (A hangnem megadása ajánlott a valós eredmények kiszámításához, és a formátum szerint nagybetűvel kell jelölni az alaphangot. példák: A, Cm, F#m, Eb) - Rapid Evolution detektált hangem: A célszoftver által detektált hangnem (nem kötelező, de ha rendelkezésre áll, az eredmények értékelésénél szempont, formátuma megegyezik a valós hangnemével) A beállításoktól függően a program meghatározza a dal hangnemét, létrehozza a jegyzőkönyvet, megjeleníti a detektálási eredményeket a MATLAB konzolján, és létrehozza a grafikonokat Tesztfájlok hozzáadása A dalokat WAV formátumban el kell helyezni a testfiles_small 3, vagy testfiles_big mappában, egy - stílusra utaló névvel ellátott - mappában. A WAV file-ok nevét célszerű úgy megválasztani, hogy ne tartalmazzon speciális karaktereket és szóközt. Az általam használt formátum például egy sorszám, és egy-két szó, amely utal az előadóra vagy a dalcímre, _ karakterrel elválasztva 4. 2 A program automatikusan ilyen módba kerül akkor is, ha a megadott mappa nem tartalmaz infromációsfájlt. 3 A gyorsabb analizálási folyamat érdekében a testfiles_small mappába a választott dal egy jellegzetes másodperces részletét (Például: intro, szövegrész, refrén... stb) érdemes elhelyezni, amely bármilyen erre alkalmas zenevágó szoftverrel létrehozható. 4 pl: 02_blink.wav 3

5 Minden tesztfájlhoz tartozik egy TXT formátumú információs fájl, melyet a WAV fájl analizálásához a fájl mellett el kell helyezni. Ez a fájl tartalmazza a jegyzőkönyv generáláshoz és a hangnemek összehasonlításához szükséges információkat. Az információs fájl felépítése (egy példán keresztül): Filename = 06_avril.wav Artist = Avril Lavigne Title = My happy ending Album = Under My Skin Key = Bm RE_key = D Az egyenlőségjel után a megfelelő értékek kitöltésével bármilyen zeneszámhoz könnyen létrehozható az információs fájl. Célszerű, hogy a TXT fájl neve megegyezzen a WAV fájl nevével, a könnyebb azonosíthatóság érdekében A tesztfájl-részletek kezeléséről A szerzői jog évi LXXVI. törvény kimondja: A szabad felhasználás esetei Szjt. 34. (2) Nyilvánosságra hozott irodalmi vagy zenei mű, film részlete, vagy kisebb terjedelmű ilyen önálló mű, továbbá képzőművészeti, építészeti, iparművészeti és ipari tervezőművészeti alkotás képe, valamint fotóművészeti alkotás szemléltetés érdekében iskolai oktatási célra, valamint tudományos kutatás céljára a forrás és az ott megjelölt szerző megnevezésével a cél által indokolt terjedelemben átvehető, feltéve, hogy az átvevő művet nem használják fel üzletszerűen. Átvételnek minősül a mű olyan mértékű felhasználása más műben, amely az idézést meghaladja. A törvényben leírtaknak megfelelően a CD-mellékleten és diplomaportálon felhasznált zeneszámrészleteket a szerzői jog védi, és csak az algoritmusok tesztelésére szabad őket felhasználni. 5. A találati eredmények elérési útjai Az analizálás után az időbélyeges munkamappában található az összefoglalás fájl (summary.pdf), és TXT formátumban az algoritmusok futási idői (elapsed_times.txt), a találati eredmények (key_summary.txt) és a statisztikák (statistics.txt). A Reports mappa tartalmazza az összes tesztfájl jegyzőkönyvét PDF formátumban. A tesztfájlok mappájában megtalálhatóak a fájl paraméterei és a módszerenként detektált hangnemek nevei a data.txt fájlban. Módszerenként a hangnemekhez rendelt találati eredmények a módszer mappáján belül a keys.txt fájlban, a legenerált grafikonok fájljai mellett találhatóak. 6. Elérhetőség és felhasználási feltételek A programmal, algoritmusokkal, keretrendszerrel kapcsolatban bármilyen kérdést, észrevételt, tanácsot, ötletet szívesen várok a fultibor@gmail.com címre. A teljes program, vagy bármely részlete szabadon felhasználható a készítő nevének és elérhetőségének feltüntetésével. 4