# Kytarová ladička (Python)

Jak použít GTK+ a GStreamer k sestavení jednoduché aplikace pro GNOME fungující jako kytarová ladička. Předvedeme si, jako používat návrhář rozhraní.
Dokumentační projekt GNOME
gnome-doc-list@gnome.org
Johannes Schmid
jhs@gnome.org
Marta Maria Casetti
mmcasetti@gmail.com 2013
Marta Maria Casetti
mmcasetti@gmail.com 2013

# Kytarová ladička

      V této lekci vytvoříme program, který přehrává tóny, které můžete použít k ladění kytary. Naučíte se, jak udělat tyto věci:

        Vytvořit základní projekt ve studiu Anjuta.
        Vytvořit jednoduché GUI v návrháři GUI ve studiu Anjuta.
        Použít GStreamer k přehrání zvuku.

      Abyste mohli pokračovat v této lekci, budete potřebovat následující:

        Nainstalovanou kopii IDE Anjuta
        Základní znalosti programovacího jazyka Python

# Vytvoření projektu ve studiu Anjuta

Než začnete s kódováním, musíte ve studiu Anjuta vytvořit nový projekt. Tím se vytvoří všechny soubory, které budete později potřebovat k sestavení a spuštění kódu. Je to také užitečné kvůli udržení všeho pohromadě.

Spusťte IDE Anjuta a klikněte na Soubor Nový Projekt, aby se otevřel průvodce projektem.

Na kartě Python zvolte PyGTK (automake), klikněte na Pokračovat a na několika následujících stránkách vyplňte své údaje. Jako název projektu a složky použijte guitar-tuner.

Klikněte na Použít a vytvoří se vám projekt. Otevřete src/guitar_tuner.py na kartě Projekt nebo Soubor. Měli byste vidět kód, který začíná řádky:

from gi.repository import Gtk, GdkPixbuf, Gdk import os, sys

# Spuštění kódu poprvé

Většina toho je kód šablony. Načte (prázdné) okno ze souboru s popisem uživatelského rozhraní a zobrazí jej. Dále to podrobněji rozebereme. Pokud jste již pochopili základy, tak tento seznam můžete přeskočit:

Řádky `import` na začátku říkají interpretru jazyka Pyton, aby načetl uživatelské rozhraní a potřebné systémové knihovny.

Zde deklarovaná třída bude hlavní třídou pro naši aplikaci. V metodě `__init__` se načte hlavní okno ze souboru GtkBuilder (src/guitar-tuner.ui) a napojí se signály.

Napojení signálu je způsob, jak definovat, co se má stát, když zmáčknete tlačítko nebo se prostě něco přihodí. Zde je zavolána metoda `destroy` (a ukončení aplikace) při zavření okna.

Funkce `main` se spustí jako výchozí, když spustíte aplikaci v jazyce Python. Vytvoří instanci hlavní třídy a spustí hlavní smyčku, aby se zobrazilo okno.

Kód je připraven k použití, takže jej můžete spustit kliknutím na Spustit Spustit.

# Vytvoření uživatelského rozhraní

Popis uživatelského rozhraní se nachází v souboru GtkBuilder. Když chcete uživatelské rozhraní upravit, otevřete src/guitar_tuner.ui. Přepnete se tím do návrháře rozhraní. Navrhované okno je uprostřed, widgety a jejich vlastnosti jsou napravo a paleta dostupných widgetů je nalevo.

Rozvržení každého uživatelského rozhraní v GTK+ je provedeno pomocí boxů a mřížek. Zde použijeme svislý `GtkButtonBox`, do kterého přiřadíme šest `GtkButtons`, jedno pro každou z kytarových strun.

Vyberte GtkButtonBox z oddílu Kontejnery v Paletě napravo a vložte jej do okna. V panelu Vlastnosti nastavte počet prvků na 6 (pro 6 strun) a orientaci na svislou.

Nyní v paletě zvolte GtkButton a vložte jej do první části boxu.

Zatímco je tlačítko stále vybráno, změňte vlastnost Popisek na kartě Widgety na E. Bude se jednat o spodní strunu E.

Přepněte se na kartu Signál (uvnitř karty Widgety) a podívejte se po signálu `clicked` tlačítka. Můžete jej použít k napojení na obsluhu signálu, která bude volána, když uživatel na tlačítko klikne. Provede se to kliknutím na signál a vepsáním `on_button_clicked` do sloupce Obslužná rutina a zmáčknutím Enter.

Zopakujte předchozí kroky pro ostatní tlačítka, takže přidáte následujících 5 strun s názvy A, D, G, B a e.

Návrh uživatelského rozhraní uložte (kliknutím na Soubor Uložit) a ponechte jej otevřený.

# Psaní obsluhy signálu

V návrháři uživatelského rozhraní můžete nastavit to, že všechna tlačítka budou při kliknutí volat stejnou funkci on_button_clicked. Tuto funkci musíme přidat do zdrojového kódu.

K tomu otevřete guitar_tuner.py a soubor s uživatelským rozhraním při tom ponechte stále otevřený. Přepněte se na kartu Signály, kterou jste již použili pro nastavení názvu signálu. Nyní chytněte řádek, na kterém jste nastavili signál clicked a přetáhněte jej do zdrojového kódu dovnitř třídy. Do zdrojového kódu se přidá následující kód:

def on_button_clicked (self, button):

Tato obsluha signálu má dva argumenty: ukazatel na běžnou třídu jazyka Python a `Gtk.Button`, které funkci zavolalo.

Prozatím ponecháme obsluhu signálu prázdnou a budeme pracovat na psaní kódu pro vyluzování zvuků.

# Roury systému GStreamer

GStreamer je základní multimediální rámec GNOME. Můžete jej použít k přehrávání, nahrávání a zpracování videa, zvuku, vysílání z webové kamery a podobně. Zde jej použijeme ke generování tónu s jednou frekvencí.

Koncepčně GStreamer funguje následovně: Vytvoříte rouru (pipeline) obsahující různé prvky zpracující směrem od zdroje (source) do cíle (sink), tj. výstupu. Zdrojem může být například soubor s obrázkem, videosoubor nebo hudební soubor, výstupem pak widget nebo zvuková karta.

Na cestě mezi zdrojem a cílem můžete použít různé filtry a převodníky k vytvoření efektů, převodníky formátů atd. Každý prvek roury má vlastnosti, které můžete použít ke změně jeho chování.

Příklad roury systému GStreamer.

# Vytvoření roury

V tomto příkladu použijeme jako zdroj tónový generátor nazývaný `audiotestsrc` a výstup pošleme do výchozího systémového zvukového zařízení `autoaudiosink`. Nastavit potřebujeme jen frekvenci tónového generátoru. Ta je přístupná přes vlastnost `freq` zmíněného `audiotestsrc`.

Změňte řádek s `import` v guitar_tuner.py, aby začínal:

from gi.repository import Gtk, Gst, GObject

`Gst` vloží knihovnu GStreamer. Musíte ji také správně inicializovat, což je uděláno v metodě `main()` tímto voláním přidaným nad řádek `app = GUI()`:

Gst.init_check(sys.argv)

Potom nakopírujte následující funkci kamkoliv do třídy guitar_tuner.py:

def play_sound(self, frequency): pipeline = Gst.Pipeline(name='note') source = Gst.ElementFactory.make('audiotestsrc', 'src') sink = Gst.ElementFactory.make('autoaudiosink', 'output')

source.set_property('freq', frequency) pipeline.add(source) pipeline.add(sink) source.link(sink) pipeline.set_state(Gst.State.PLAYING)

GObject.timeout_add(self.LENGTH, self.pipeline_stop, pipeline)

První tři řádky vytvoří prvky GStreamer typu zdroj a cíl a prvek typu roura (který bude použit jako kontejner pro první dva prvky). Roura dostane název „note“. Zdroj je pojmenován „source“ a je nastaven jako `audiotestsrc`. Cíl je pojmenován „output“ a je nastaven jako `autoaudiosink` (výchozí výstup zvukové karty).

Volání `source.set_property` nastaví vlastnost `freq` prvku `source` na frekvenci `frequency`, která je předána jako argument do funkce `play_sound`. Jedná se o frekvenci v Hertzích. Správné frekvence nadefinujeme později.

Následující dva řádky volají `pipeline.add`, čímž se vloží zdroj a cíl do roury. Roura může obsahovat více dalších prvků GStreamer. Obecně můžete přidat tolik prvků, kolik chcete, tak, že zavoláte metodu `add` opakovaně.

Následující `pipeline.set_state` je použito ke spuštění přehrávání tím, že se nastaví stav roury na přehrávání (`Gst.State.PLAYING`).

# Zastavení přehrávání

Nechceme ale hrát nějaký tón navždycky, takže poslední věcí, kterou `play_sound` udělá, je že zavolá `GObject.timeout_add`. Tím se nastaví časový limit pro zastavení zvuku. Čeká v délce `LENGTH` milisekund a pak zavolá funkci `pipeline_stop`, která vrátí `False`, jinak by se v jejím volání pokračovalo.

Nyní napíšeme funkci `pipeline_stop`, která je volána z `GObject.timeout_add`. Vložte následující kód nad funkci `play_sound`:

def pipeline_stop(self, pipeline): pipeline.set_state(Gst.State.NULL) return False

Konstantu `LENGTH` je třeba definovat uvnitř třídy, takže tento kód přidáme na začátek třídy main:

LENGTH = 500

Zavolání `pipeline.set_state` zastaví přehrávání roury.

# Definice tónů

Když uživatel klikne na tlačítko, chceme zahrát správný zvuk. Ze všeho nejdříve potřebujeme vědět frekvence pro šest kytarových strun, které jsou definovány (na začátku třídy main) ve slovníku, který můžeme jednoduše mapovat na názvy těchto strun:

# Řetězce pro frekvence frequencies = { 'E': 329.63, 'A': 440, 'D': 587.33, 'G': 783.99, 'B': 987.77, 'e': 1318.5 }

Nyní oživíme obsluhu signálu, kterou jsme zadeklarovali již dříve po názvem `on_button_clicked`. Mohli bychom mít napojená všechna tlačítka na různé obslužné funkce, ale to by vedlo ke zbytečné duplicitě kódu. Místo toho použijeme popisek každého z tlačítek ke zjištění, na které tlačítko bylo kliknuto:

def on_button_clicked(self, button): label = button.get_child() text = label.get_label()

self.play_sound (self.frequencies[text])

Tlačítko, na které bylo kliknuto, je předáno jako argument `tlačítko` do `on_button_clicked`. Pomocí `button.get_child` můžeme získat popisek tohoto tlačítka a následně pomocí `label.get_label` získat text z tohoto popisku.

Text popisku je použit jako klíč do slovníku a funkce `play_sound` je zavolána s příslušnou frekvencí pro tuto notu. Tím se zahraje tón – máme funkční kytarovou ladičku!

# Spuštění aplikace

Všechen kód je nyní připravený k použití. Klikněte na Spustit Spustit, aby se aplikace spustila a užijte si ji!

# Ukázková implementace

Pokud v této lekci narazíte na nějaké problémy, porovnejte si svůj kód s tímto ukázkovým kódem.

# Další postup

Zde je pár nápadů, jak byste mohli tuto jednoduchou ukázku rozšířit:

Přidat do programu možnost cyklicky procházet tóny.

Naučit program přehrávat nahrávky vybrnkání jednotlivých reálných kytarových strun.

Abychom to mohli udělat, potřebujeme sestavit mnohem složitější rouru GStreamer, která umožní načíst a přehrát hudební soubory. Budete muset zvolit prvky GStreamer typu dekodér a demultiplexor podle formátu souborů s vašimi zvukovými nahrávkami – například MP3 používá jiné prvky než Ogg Vorbis.

Můžete také potřebovat prvky propojit mnohem komplikovanějším způsobem. Toho lze dosáhnout pomocí konceptů GStreamer, které jsme v této lekci neprobírali. Mezi ně patří například přípojné body. Hodit se vám může také příkaz gst-inspect.

Automaticky analyzovat tóny, které uživatel zahraje.

Mohli byste připojit mikrofón a nahrávat z něj zvuky pomocí vstupního zdroje. Zjistit, který tón je přehráván, by vám možná pomohla spektrální analýza.