Copyright © 2005 Tom Eykens
Copyright © 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Tom Cato Amundsen
Copyright © 2011. Martín Carr (tincarr@gmail.com)
Se garantiza el permiso para copiar, distribuir y/o modificar este documento bajo los términos de la Licencia Pública General GNU, publicada por la Free Software Foundation; ya sea su versión 3 o (a su gusto) cualquier otra posterior. El texto completo de la Licencia está disponible en Apéndice A, GNU General Public License version 3 .
Tabla de contenidos
chordvoicing modulecompareintervals moduledictation moduleelembuilder moduleharmonicinterval moduleidbyname moduleidentifybpm moduleidproperty moduleidtone modulemelodicinterval modulenameinterval modulerhythm modulerhythmtapping modulerhythmtapping2 modulerhythmdictation modulerhythmdictation2 modulesinganswer modulesingchord modulesinginterval moduletoneincontext moduletwelvetone modulempd moduleTabla de contenidos
Solfege es un programa libre para entrenamiento de oído. El programa es parte del Proyecto GNU. Verifique “Recursos en línea” para información sobre listas de discusión y sobre dónde obtener la última versión de Solfege.
Una de las ideas de este programa es que usted pueda ampliarlo sin tener que meterse en el código fuente. Si quiere practicar algunos acordes especiales o dictados con alguna música no incluida, puede escribir archivos de lección y colocarlos en un subdirectorio lessonfiles/ en su directorio personal $HOME. Si creara buenas lecciones, podría considerar compartirlas, enviándolas a la lista de discusión, para que podamos agregarlas en la próxima versión del programa.
Reporte errores al bug tracker en http://bugs.solfege.org. Alternativamente, puede enviar un email a <bug-solfege@gnu.org>. Las preguntas generales y parches deben ser enviados a <solfege-devel@lists.sourceforge.net>.
Por favor, haga detallados sus reportes de error. ''Aparece un mensaje de error en una ventana cuando intento iniciar el programa'' no es útil para mi. Cuando reporte errores:
Dígame qué versión de Solfege está usando. Verifique si está disponible una versión más nueva. Si usted quiere utilizar solamente versiones estables, no necesita probar nuevas versiones de desarrollo.
¿Qué sistema operativo está usando? ¿Qué versión?
Describa exactamente lo que está haciendo cuando ocurre el error.
Envíe una copia exacta de los mensajes de error. Ellos tienen sentido para el autor de Solfege, aunque a usted le parezcan criptográficas.
La página web de Solfege es http://www.solfege.org. Existe también una página más pequeña con más información estática en http://www.gnu.org/software/solfege/.
El código fuente está disponible en http://ftp.gnu.org/gnu/solfege. Si usted es un aventurero, puede probar las versiones inestables (con posibles errores, pero con nuevas características) en http://alpha.gnu.org/gnu/solfege. Estas versiones pueden tener más errores, pero le permiten probar nuevas funcionalidades, encontrar y reportar errores.
El código fuente y algunos binarios pre-compilados están disponibles en http://sourceforge.net/project/showfiles.php?group_id=1465.
Si usted usa Debian puede ejecutar apt-get install solfege para bajar e instalar el programa.
Baja actividad, moderada, y usada para anunciar lanzamientos estables de Solfege. (Subscripción | Archivo)
Si quiere hacer un reporte de problemas al instalar o correr Solfege, o tiene preguntas, comentarios e ideas sobre cómo mejorar Solfege, por favor escriba a esta lista en vez de usar el foro de Sourceforge o contactar directamente al autor. Puede realizar envíos a solfege-devel sin subscribirse. (Subscripción | Archivo)
La dirección normal de GNU para enviar reportes de errores. Esta lista está actualmente redireccionada hacia <solfege-devel@lists.sourceforge.net>
Selecting exercises works like navigating a web page and clicking on links. Press Alt+Left to move to the previous page or F5 to move to the front page.
Define el tempo (golpes por minuto) para la música y arpegios. Estos valores son usados por los ejercicios escritos con los módulos: compareintervals, harmonicintervals, idtone, melodicinterval, singchord, singinterval, twelvetone, rhythm, identifybpm, nameinterval. Los otros ejercicios tendrán o bien el tempo escrito en el archivo de lección o en la página de configuración del ejercicio.
Seleccione el instrumento MIDI y su volumen, que será usado para la mayor parte de los ejercicios.
Solfege puede usar tres instrumentos diferentes para reproducir acordes. Uno para la nota más aguda, otro para las medias y otro para la nota grave. Esto puede ser útil en caso de que tenga dificultades para escuchar notas individuales en los acordes.
Solfege usa esta información en los ejercicios donde el usuario debe cantar.
Estos selectores sirven para que Solfege conozca la nota más grave y la más aguda que el usuario puede cantar. Estos valores son considerados por el programa, pero hasta cierto punto. Si, por ejemplo, se usaran los valores do y do', al realizar un ejercicio de cantar décimas menores y mayores, necesariamente se tendrá que cantar notas fuera del rango aquí especificado.
Solfege buscará el camino para los programas ingresados en esta página. De esta forma, debe colocar el camino completo para programas instalados fuera de la variable PATH.
Por favor verifique la página de descarga www.solfege.org para ver consejos actualizados y enlaces de descarga si utiliza MS Windows y debe bajar e instalar el programa.
Indique líneas de comandos para convertir entre diversos formatos de audio. %(in)s será substituido por el nombre del archivo a convertir, y %(out)s por el nuevo nombre del archivo convertido. No es necesario ingresar %(out)s si el programa guarda el nuevo archivo con la extensión correcta.
Líneas de comando que pueden reproducir diferentes formatos de audio. %s será substituido por el nombre del archivo a ser reproducido. El nombre de archivo será agregado al final de la cadena si no incluye un %s.
Algunos ejercicios usan los programas CSound y MMA. Lilypond-book es necesario para generar hojas de pruebas de entrenamiento para imprimir, y latex es requerido si la hoja debería ser creada en formato DVI. Sin latex, igual puede generar archivos HTML.
Si el archivo ingresado termina en .py, el script será ejecutado por el mismo interpretador Python que Solfege.
Ventana principal modificable: Permite que el usuario modifique el tamaño de la ventana principal de Solfege.
Seleccionar idioma: puede elegir manualmente el idioma si Solfege no lo detecta correctamente, o si desea ejecutar Solfege con un idioma diferente al de su sistema operativo.
Aquí puede cambiar los atajos de teclado para el ejercicio «Identificar tonalidad». Cliquee en una fila para seleccionar la tonalidad que quiere cambiar, y después aprete de nuevo en la segunda columna de esa fila. Finalmente, presione la tecla que quiere utilizar para esa nota.
Los botones «Dvorak» y «ASCII» configuran las teclas de atajo a los valores para los teclados Dvorak e ASCII.
Aquí puede modificar las teclas de atajo para los ejercicios de intervalo, como los de «Intervalo harmónico» o de «Intervalo melódico». Presione en una fila para seleccionar el intervalo cuyo atajo desee modificar, y luego en la segunda columna de la fila. Finalmente, debe apretar la tecla que quiera definir como atajo para ese intervalo.
Los botones «Dvorak» y «ASCII» configuran las teclas de atajo a los valores para los teclados Dvorak e ASCII.
No permitir una nueva pregunta hasta que la anterior esté resuelta: deshabilita el botón 'Nueva...' hasta que la pregunta sea respondida correctamente o el usuario aprete el botón 'Abandonar'.
Repetir la pregunta si la respuesta es incorrecta: reproduce nuevamente el sonido cuando el usuario da una respuesta incorrecta.
Modo experto: al habilitar esta opción en los ejercicios que usan los módulos idbyname e idproperty se permite seleccionar solo un subconjunto de preguntas en el archivo de lección. Practicar en modo avanzado no guarda ninguna estadística.
Los ejercicios que generan sonido tienen diferentes formas de reproducirlo:
Use esto para depuración o cuando está portando Solfege. Ningún sonido es reproducido, los eventos MIDI son mostrados en la salida estándar.
If you have the Python modules for ALSA installed, you can use the ALSA sequencer. If your operating system is GNU/Linux, you have a menu item on the Help menu that can download and compile the modules for you.
La mejor elección aquí es generalmente /dev/music porque tiene mejor soporte para instrumentos de percusión. /dev/sequencer2 es generalmente un enlace simbólico para /dev/music. Si su sistema no posee /dev/music, puede crearlo con el siguiente comando, ejecutado como root (debe poseer un núcleo Linux versión 2.2 o posterior):
cd /dev mknod music u 14 8
En MS Windows esta opción es llamada Salida multimedia de Windows.
Esto puede ser útil para portar a sistemas que no usan OSS, o si usted tiene un mal sintetizador MIDI en su placa de sonido y quiere usar timidity.
Las versiones de Solfege anteriores a 3.16.0 guardaban las estadísticas en pequeños archivos. Solfege 3.16.0 y los más recientes importarán estos archivos a un nuevo archivo de base de datos la primera vez que corra el programa, pero dejará los archivos antiguos en su computadora. Es seguro borrar estos archivos después. Los mismos están guardados en el subdirectorio statistics dentro del directorio application data.
Las estadísticas ahora son guardadas en el archivo statistics.sqlite en el directorio de datos del programa. La ubicación exacta de este directorio puede ser vista seleccionando en el menú . Presione el botón para reiniciar sus estadísticas a partir de un archivo statistics.sqlite vacío.
The training set editor lets you create MIDI/WAV/MP3/OGG files of questions so that you can upload them to your pda, cell phone or MP3 player. A solution sheet will be generated for you to print out. Then you can let the MP3 player play the tracks in random order, and you can use the solution sheet to check if you recognized the music correctly.
Utilice el editor de conjuntos de entrenamiento para definir cuáles ejercicios generar. Puede guardar su definición en un archivo para usarlo después. Cada vez que se presione en , un nuevo conjunto de archivos es generado en el directorio que escoja. Tendrá que subir manualmente los archivos de sonido generados a su dispositivo portátil.
El programa le permite generar preguntas a partir de cuantos archivos quiera, pero lo más usual es generar un gran número de preguntas a partir de uno o solo algunos archivos.
Los programas usados para convertir entre diferentes formatos de archivos son definidos en la página 'Programas externos', de la ventana de preferencias. Verifique las definiciones allí si tiene problemas al convertir los archivos MIDI a los formatos WAV, MP3 u Ogg.
Explicación de los encabezados de tabla
El número de preguntas a generar a partir del archivo de lección.
El número de repeticiones para cada pregunta.
Tiempo de atraso entre preguntas, medido en negras.
Esta herramienta está disponible en el menú . Úsela para crear pruebas de entrenamiento auditivo para ser impresas en papel. Solfege generará dos versiones del documento: una para que complete el estudiante, y otra con las respuestas. Esta herramienta fue agregada a pedido de un usuario, pero no sabemos si es usada en la práctica. Por lo tanto, contáctenos si la utiliza, y díganos si es útil.
El botón hará aparecer un menú con todos los ejercicios a partir de la página principal activa de la cual esta herramienta puede crear ejercicios: ejercicios escritos usando los módulos idbyname, melodicinterval y harmonicinterval. Con archivos de lección escritos para el módulo idbyname, solamente los objetos musicales chord, rvoice e voice son soportados.
abrirá un cuadro de diálogo que le permite seleccionar o crear un directorio vacío. Grabe allí los archivos HTML o LaTex y las imágenes.
Cuando guarda y carga archivos que definen pruebas de entrenamiento de oído, el programa recordará las preguntas aleatorias, de modo que al cargar un archivo y apretar se creará exactamente la misma prueba. Aprete para crear un nuevo conjunto de preguntas aleatorias.
Algunos ejercicios mostrarán estadísticas para diferentes períodos de tiempo: Sesión, Hoy, Últimos 7 días y Total. El programa usa dos tipos diferentes de tablas.
La primera tabla, como muestra la captura de pantalla anterior, tiene una fila para cada pregunta del archivo de lección. Porcentaje es el porcentaje de veces que la pregunta fue respondida correctamente. Cuenta es el número de veces que la pregunta fue realizada.
En el segundo tipo de tabla, las columnas tienen los mismos rótulos que las filas, pero los rótulos no son mostrados porque eso haría muy larga la tabla. Así, en la captura de pantalla anterior, la columna 1 debería tener el rótulo m3↑ y la columna 2 M3↑. Para preguntas identificadas por el rótulo de cada línea, cada columna dice cuántas veces el usuario respondió las diferentes respuestas posibles. El número en negrita es la cantidad de veces que fue dada la respuesta correcta.
El gestor de perfiles permite que varios usuarios de Solfege compartan una misma cuenta de usuario del sistema operativo. Los perfiles compartirán el archivo de configuración, pero tendrán estadísticas y resultados de pruebas independientes.
El gestor de perfiles se mostrará durante el inicio si existe más de un perfil. Usted puede también acceder al mismo seleccionando desde el menú .
Marque No preguntar al inicio si no quiere ver el gestor de perfiles al iniciar. El perfil que seleccione será recordado una vez que el programa inicie.
Tabla de contenidos
Este ejercicio es uno de los que puede usar para practicar intervalos. El concepto es bastante simple: presiona el botón para tocar un intervalo aleatorio, y debe decir de qué intervalo se trata.
Cuando utiliza la interfaz de botones, puede presionar con el botón derecho sobre uno de ellos para escuchar el intervalo que representa.
En la página de configuración del ejercicio hay una caja de selección desde donde puede seleccionar diferentes formas de responder a una pregunta. Actualmente hay piano, guitarra, bajo y algunos tipos de acordeón, además de la interfaz con botones predeterminada. Debajo puede ver una captura de pantalla al utilizar la interfaz de piano.
Este ejercicio crea intervalos aleatorios y usted debe intentar identificarlos.
Cuando utiliza la interfaz de botones, puede presionar con el botón derecho sobre uno de ellos para escuchar el intervalo que representa.
En la página de configuración del ejercicio hay una caja de selección desde donde puede seleccionar diferentes formas de responder a una pregunta. Actualmente hay piano, guitarra, bajo y algunos tipos de acordeón, además de la interfaz con botones predeterminada. Debajo puede ver una captura de pantalla al utilizar la interfaz de piano.
En este ejercicio, Solfege mostrará uno o más intervalos, y usted debe cantarlos. Desafortunadamente, todavía no es posible cantar en un micrófono y hacer que Solfege decida si lo hizo correctamente, por lo que usted mismo (o un tutor) deberá decidir si acertó.
El programa intentará utilizar notas dentro del alcance vocal del usuario, según la configuración en la ventana de preferencias. Algunas veces no es posible mantener la pregunta dentro de este rango, como por ejemplo cuando el ejercicio está configurado para crear muchos intervalos ascendentes.
El propósito de este ejercicio es identificar el acorde que está siendo tocado.
Inicie el ejercicio presionando . Solfege tocará un acorde, y usted deberá identificarlo mediante uno de los dos botones debajo del pentagrama vacío.
Si acierta, el programa mostrará el acorde en el pentagrama y también un mensaje "Correcto" en la barra de estado. Después, puede presionar el botón para mostrar una nueva pregunta.
Si se equivoca, el mensaje "Incorrecto" será mostrado en la barra de estado.
Identifique la cadencia presionando el botón con su nombre. Como consta en error #5, necesitamos ejercicios sobre cadencias en Solfege.
En esta versión de Solfege hay solamente un ejercicio con cadencias mayores. En este ejercicio, una escala mayor es tocada para establecer la tónica. ¿Tal vez sea muy poco? ¿Necesitamos de un ciclo completo I-IV-V-I antes de la pregunta? ¿O tal vez sea mejor escribir música real que termina en la cadencia que queremos practicar? Estas cosas necesitan ser decididas antes de lanzar la versión 3.12.0. Comentarios y músicas pueden ser agregados al error #5.
Esta es una página de ayuda genérica para todos los ejercicios escritos usando el módulo de ejercicios idbyname. Los ejercicios normalmente tienen más texto de ayuda que esto.
Click en el botón que representa la respuesta de la pregunta reproducida o mostrada. Generalmente, los ejercicios mostrarán un encabezado explicando su propósito.
Esta página es de ayuda genérica para todos los ejercicios escritos usando el módulo de ejercicios idproperty. Los ejercicios normalmente tendrán textos de ayuda más específicos que esto.
La siguiente captura de pantalla muestra un ejemplo de cómo puede verse un ejercicio.
Este ejercicio mostrará una pregunta y tocará alguna música; usted tendrá que seleccionar una respuesta a partir de cada columna en la tabla de botones. Cuando usted selecciona la respuesta correcta en una columna, su rótulo se verá en negrita, y el mensaje "Correcto" titilará en la barra de estado.
El ejercicio tendrá un botón si una o más preguntas es del tipo que puede ser reproducido como arpeggio.
Al conducir un coral, tiene que cantar las notas iniciales para las diferentes voces; si usted no tiene un piano cerca, tendrá que usar un diapasón. Si es hombre, cantará las notas para las mujeres una octava más abajo, y viceversa.
El programa reproducirá la nota La (440 Hz), y mostrará un acorde que debe cantar. Solfege todavía no tiene soporte para un micrófono, por lo que usted deberá decidir si su respuesta es correcta o no.
El programa reproduce un ritmo generado aleatoriamente, y el usuario debe reproducir el ritmo. El usuario ingresa el ritmo usando botones que representan diferentes grupos rítmicos.
When you have entered enough rhythm elements, Solfege will check your answer. If everything is correct it will display a happy face, otherwise a sad face, and all wrong rhythms will be marked.
Si parte de su respuesta es incorrecta, todo lo que haya desde el primer elemento erróneo será quitado (preservando los ritmos correctos en el inicio de la respuesta) cuando usted aprete en la carita triste, o cuando aprete en los botones rítmicos arriba en la página.
Puede apretar en el botón 'Tocar' para escuchar su sugerencia.
Actualmente, las preguntas de este ejercicio son realizadas seleccionando los ritmos aleatoriamente. Esta no es la mejor manera, por lo que esperamos generarlas de una manera más inteligente en posteriores versiones.
El programa reproducirá un ritmo generado aleatoriamente, y el usuario deberá repetirlo, ingresando el ritmo tocando en el botón Toque aquí.
Este ejercicio es llamado ejercicio de dictado, pero si los archivos de lección necesarios son escritos, puede ser usado de diferentes formas:
Puede usar Solfege para reproducir alguna melodía para transcribirla en papel. Utilice los botones con una nota para repetir partes menores de la música. Presionando el botón Mostrar, puede verificar si cometió algún error.
Puede usar este ejercicio para practicar solfeo: cuando comienza el ejercicio, presione Mostrar e intente cantar la música. Recién entonces debería usar el botón 'Tocar todo' o los botones con la negra para reproducir la música. Tiene que decidir por usted mismo si lo hizo correctamente.
Las escalas son un asunto complejo. Por ejemplo, el lídio griego (C-D-E-F-G-A-B-C) es diferente del lídio medieval y el moderno (C-D-E-F#-G-A-B-C). Puede leer sobre todas las escalas usadas en GNU Solfege aquí.
Solfege tiene tres variantes de ejercicios de escalas.
Solfege tocará una escala, y usted debería identificarla apretando el botón con el nombre de la escala.
Solfege tocará una escala, y usted debería identificar la estructura de la escala. Se le presentará una colección de botones con los números '1', '2' y '3'. Estos números representan los intervalos de segunda menor, segunda mayor y tercera menor que están entre las notas de la escala.
Solfege reproducirá una escala, y usted debe identificar el grado. Por ejemplo, Solfege puede usar la escala natural menor y tocarla desde cualquiera de sus notas. Usted debe decir en qué nota empezó.
En este ejercicio, Solfege reproducirá un intervalo, y usted deberá decir cómo fue entonado. Puede presionar los botones 'muy pequeño', 'puro' o 'muy largo'. También es posible que falte alguno de los tres botones.
Este es un ejercicio combinado para memorización de notas e intervalos. Algunas personas creen que este tipo de ejercicio puede darle audición perfecta (oído absoluto), pero yo no lo creo.
Lo esencial es: el programa reproduce una nota y usted debe identificarla comparando con la última nota reproducida.
Para comenzar, el programa tocará una nota y mostrará su nombre en la barra de estado. Identifique la nota presionando el teclado del piano o usando los atajos de teclado, que están representados sobre el teclado con una letra.
Presione el botón derecho en el teclado del piano para escuchar una nota sin realmente responder. (Algunos llamarían a esto hacer trampa...)
Solfege have a set of exercises that you can find by clicking “Identify tone” on the front page. You should start with the first exercise, and move to the next each time you can practise from some minutes and still have quite a good score, for example 96% correct.
Usted puede configurar este ejercicio como quiera si selecciona “Personalizado” en la página principal predeterminada.
Hay varias formas de usar este ejercicio. Personalmente, no he usado mucho este ejercicio, y las secciones de abajo son solo sugerencias.
Start with only the notes c-d-e at weight 1. When your score is at least 96% correct, you add the tone f and continue. Add one new tone until you practise with all 12 tones. Doing this is the same as using the predefined exercises and following the instructions in the start of this chapter.
Configuración con la nota La con peso 11 (o mayor) y el resto de las notas con peso 1. De este modo el programa tocará la nota La frecuentemente, de modo que usted recordará el tono, por lo que puede usar esa nota como referencia para identificar las demás notas. Cuando haya practicado un poco, puede reducir el peso de La para hacer más difícil el ejercicio.
Si corre “Personalizado”, en la cima de la página de configuración, puede decirle al programa cuán importante son las diferentes notas. Si por ejemplo le da a la nota La 11 puntos y 1 punto para cada una de las restantes, como (11+11*1)/11*100 = 50%, la mitad de las notas aleatorias serán La.
Abajo usted elige de qué octavas pueden ser las notas aleatorias.
Entonces usted puede elegir si Solfege debería mostrar una nueva pregunta automáticamente al responder la anterior.
En el cuadro siguiente puede elegir algunas opciones auto-explicativas sobre lo que sucede si contesta equivocadamente.
Los atajos de teclado pueden ser configurados desde la ventana de preferencias.
El programa tocará una marcación de tempo, como un metrónomo. Debe intentar adivinar la cantidad de golpes por minuto. Cada botón representa un tempo, y el programa tocará solamente tempos que tengan un botón con texto en negrita. Presione con el botón derecho en los botones para cambiar el estado de una marcación de tempo.
Nota: el ritmo depende de la función gtk timeout_add para ser reproducido, por lo que no es muy preciso.
En este ejercicio, o programa mostrará todas as doce notas de la escala en una ordem aleatória e tocará a primeira. Então usted debe cantar todas e verificar se a última se encaixa. Então eso más parece com un exame de leitura e canto do que un ejercicio para aprender a cantar intervalos. Para eso usted debe tentar alguns dos outros ejercicios de intervalos.
En este ejercicio, Solfege mostrará y tocará un intervalo, y usted deberá identificarlo. Este es un ejercicio de teoría musical, y no un ejercicio de entrenamiento de audición. Para aprender a nombrar intervalos, puede leer “Intervalos”.
Identifica el intervalo apretando un botón que indica el nombre específico y el nombre general.
En este ejercicio, Solfege reproducirá alguna música, y usted deberá contestar con una representación de las progresiones armónicas del ejercicio.
Tabla de contenidos
Davide Bonetti contribuyó con un gran número de ejercicios de escala y algunas páginas describiendo todas las escalas. Puede ver estas páginas aquí.
En teoría musical se utiliza la palabra intervalo cuando hablamos sobre una diferencia de altura entre dos notas. Se le llama intervalo armónico cuando las dos notas suenan simultáneamente y melódicos cuando suenan sucesivamente.
Los nombres de los intervalos consisten de dos partes. Algunos ejemplos son "tercera mayor" y "quinta justa". En el libro "Harmony", de Walter Piston, las dos partes son denominadas nombre específico y nombre general. En Wikipedia podemos encontrarlos con los nombres calidad del intervalo y número de intervalo. He visto personas que hablan del tamaño numérico de un intervalo.
Puede obtener el nombre general contando los pasos en el pentagrama, ignorando cualquier alteración. Por ejemplo, si el intervalo va desde Mi hasta Sol#, primero debe contar hasta 3 (Mi Fa Sol) para descubrir que el nombre general es, entonces, tercera.
El nombre específico representa el tamaño exacto del intervalo. Unísonos, cuartas, quintas y octavas pueden ser disminuidas, justas o aumentadas. Las segundas, terceras, sextas y séptimas pueden ser menores, mayores, disminuidas o aumentadas. Un intervalo menor es un semitono menor que un intervalo mayor. Un intervalo disminuido es un semitono menor que un intervalo puro o menor, y un intervalo aumentado es un semitono mayor que un intervalo puro o mayor.
Las alteraciones modifican el tamaño de los intervalos. Un intervalo crece un semitono si se adiciona un sostenido a la nota más aguda o un bemol a la nota más grave. En cambio, es un semitono menor si se adiciona un bemol a la nota más aguda o un sostenido a la nota más grave. En las siguientes secciones la nomenclatura de los intervalos será mostrada con más detalle.
Las segundas son fáciles de reconocer: las dos notas son vecinas en el pentagrama. Una nota está sobre una línea, y la otra está en el espacio justo encima o debajo. Una segunda menor es un intervalo de un semitono. Una segunda mayor comprende dos semitonos (es decir, un tono).
Para aprender a identificar segundas, tiene que aprender primero qué tipos de segundas hay entre las notas naturales. Como se puede ver en Figura 3.1, “”, solo los intervalos Mi-Fa y Si-Do son segundas menores. El resto son intervalos mayores. Puede verificar que Figura 3.1, “” está correcto observando el piano. Verá que no existen teclas negras entre Mi y Fa y entre Si y Do.
Si la segunda posee alteraciones, es necesario examinarlas para determinar cómo cambió el tamaño del intervalo. He aquí algunos ejemplos.
Al quitar las alteraciones del intervalo en Figura 3.2, “” se puede ver que el intervalo Fa-Sol es de una segunda mayor. Cuando agregamos un bemol a la nota más aguda, el intervalo pasa a ser un semitono menor, es decir, pasa a ser una segunda menor.
Al quitar las alteraciones, puede determinarse que el intervalo La-Si es una segunda mayor. Todavía recuerda Figura 3.1, “”, ¿verdad? Ahora agregamos un bemol a la nota La, con lo que el intervalo se convierte en una segunda aumentada. Al agregar un bemol al Si, el intervalo se convierte en una segunda mayor.
Al quitar las alteraciones, vemos que el intervalo Mi-Fa es una segunda menor. Cuando agregamos un bemol a nota más grave, el intervalo se amplía en un semitono, convirtiéndose en una segunda mayor. Si además agregamos un sostenido a nota más aguda, el intervalo se amplía un semitono más, convirtiéndose en una segunda aumentada.
Una tercera menor es una segunda menor y una segunda mayor, o sea, tres semitonos. Una tercera mayor son dos segundas mayores, o sea, cuatro semitonos. Figura 3.5, “” muestra las terceras entre todas las notas naturales. Puede memorizar los intervalos mayores, Do-Mi, Fa-La y Sol-Si. Entonces sabrá que los otros cuatro intervalos son menores.
Luego examina las alteraciones para ver si cambian el nombre específico. Esto se realiza del mismo modo que con las segundas.
Una cuarta justa tiene 2½ semitonos, o dos segundas mayores y una segunda menor. Figura 3.6, “” muestra todas las cuartas entre notas naturales. Puede memorizar que la cuarta Fa-Si es la única aumentada, dado que las otras seis son justas.
Una quinta justa tiene 3½ semitonos, o tres segundas mayores y una segunda menor. Figura 3.6, “” muestra todas las quintas entre notas naturales. Debe recordar que todos esos intervalos son justos, excepto Si-Fa, que es disminuido.
Si un intervalo posee alteraciones, debemos examinarlas para ver cómo modifican su tamaño. Una quinta disminuida es un semitono menor que una justa, y una aumentada es un semitono mayor. Debajo encontrará algunos ejemplos:
Recordamos de Figura 3.7, “” que el intervalo Si-Fa es una quinta disminuida. La nota más grave en Figura 3.8, “” es precedida de un bemol, lo que hace que el intervalo sea un semitono mayor, por lo que la quinta pasa de disminuida a justa.
Sabemos de Figura 3.7, “” que el intervalo Mi-Si es una quinta justa. En Figura 3.8, “” el Mi posee un bemol, lo que convierte al intervalo en aumentado. Pero el Si es precedido de un doble bemol que hace al intervalo dos semitonos menor y lo deja finalmente en una quinta disminuida.
Las sextas son fácilmente reconocidas al invertir el intervalo e identificar la tercera. La siguiente regla se da:
Si la tercera es menor, entonces la sexta es mayor
Si la tercera es menor, entonces la sexta es mayor
Si la tercera es mayor, entonces la sexta es menor
Si la tercera es mayor, entonces la sexta es menor
Si usted encuentra la inversión de intervalos difícil, puede memorizar que los intervalos Mi-Do, La-Fa y Si-Sol son menores. Los otros cuatro son mayores. De esta forma, puede examinar las alteraciones para ver si cambian su nombre específico. Esto es hecho exactamente de la misma forma que con las segundas.
Las séptimas son identificadas del mismo modo que las sextas. Al invertir una séptima, se obtiene una segunda.
Si usted encuentra la inversión de intervalos difícil, puede memorizar que los intervalos Do-Si y Fa-Mi son mayores. Los otros cinco son menores. De esta forma, puede examinar las alteraciones para ver si cambian su nombre específico. Esto es hecho exactamente de la misma forma que con las segundas.
Al invertir un intervalo se aumenta una octava la nota más grave, o se desciende una octava la nota más aguda. El nombre general del nuevo intervalo cambia de este modo:
Segunda se convierte en séptima.
Tercera se convierte en sexta.
Cuarta se convierte en quinta.
Quinta se convierte en cuarta.
Sexta se convierte en tercera.
Séptima se convierte en segundo.
El nombre específico cambia de esta manera:
Disminuido se convierte en aumentado.
Menor se convierte en mayor.
Perfecto se mantiene perfecto.
Mayor se convierte en menor.
Aumentado se convierte en disminuido.
Debajo hay dos ejemplos, una tercera mayor al ser invertida se convierte en una sexta menor, y una séptima menor al invertirse se convierte en una segunda mayor.
Tabla de contenidos
chordvoicing modulecompareintervals moduledictation moduleelembuilder moduleharmonicinterval moduleidbyname moduleidentifybpm moduleidproperty moduleidtone modulemelodicinterval modulenameinterval modulerhythm modulerhythmtapping modulerhythmtapping2 modulerhythmdictation modulerhythmdictation2 modulesinganswer modulesingchord modulesinginterval moduletoneincontext moduletwelvetone modulempd moduleGNU Solfege is written so that it can easily be extended, even if you do not know any computer programming. The steps are:
Create a lesson file and save it it in the first directory listed when you select from the menu. Create the directory if it does not exist.
Select once again to see the file show up in the list.
Click the link to your lesson file and enjoy!
To get started, you can copy one of the lesson files included in GNU
Solfege. The lesson files are located in the exercises/standard/lesson-files subdirectory of
the installation directory. You can find the installation directory by
selecting from the
menu. It is important to store the lesson files you
create in the directory intended for user created lesson files, and not in the
applications directory. This because all files in the installation directory
may be removed while upgrading the program.
If you create many lesson files, you might want to group them together
in a separate subdirectory and attach them to a front page file. This way you
have a set of files in a subdirectory that you can easily distribute to other students. So create a new directory side by side the user
directory you found by selecting
earlier this article. Your files might be structured like this:
myfiles/myfrontpage.txt myfiles/lesson-files/chords-1 myfiles/lesson-files/chords-2
To create a new front page file, you should select from the menu, and then click on the toolbar of the dialog that pops up.
In “Introduction” we showed you just enough to place your lesson file to get started. This sections give you all the details how files and directories are set up.
We will write INSTALLDIR
whenever we refer to the directory Solfege is installed in. The exact
location differ from operating system to operating system, and can be
found by selecting → and then lookup «Solfege installation directory».
Example of locations:
MS Windows - C:\Program files\GNU Solfege\share\solfege
GNU/Linux - /usr/share/solfege
Please notice that INSTALLDIR is not necessarily the top directory where
all files belonging to Solfege is installed. Different operating system place
files differently. For the purpose of this document INSTALLDIR is the directory
containing the solfege/ subdirectory containing all the
python modules that composes the program and the
exercises/ subdirectory that contains all the lesson
files.
Solfege allow for the user to create exercises (and soon also
exercise modules written in Python). These should not be saved in
INSTALLDIR because then they will be lost on
upgrade.
The directory to save the lesson files you write yourself depends on the operating system you run, and on the locale settings (language). In this document we will write USERDATA whenever we refer to the directory found if you lookup «Solfege user data» by selecting → . Your files should be saved in directories below USERDATA. Example values for USERDATA:
MS Windows 7 - C:\Users\User name\Documents\GNU Solfege
MS Windows XP - C:\Documents and settings\User name\My Documents\GNU Solfege
GNU/Linux - /home/username/.solfege
Lesson files and front page files are grouped together in
subdirectories below USERDATA/exercises. You can have
as many subdirectories as you like in USERDATA/exercises.
Each file that matches USERDATA/exercises/*/* will be
read by the program and used as a front page file if it has the correct
format. Other files will silently be ignored. This means that you can
have more than one front page file in a subdirectory, and extra files,
like README and COPYRIGHT files are ignored.
Lesson files should be saved in a directory named
lesson-files in the same directory as the front page
file is saved. So if you create some exercises with jazz progressions, you
might have this file structure on your computer:
USERDATA/exercises/jazzprog/page.txt USERDATA/exercises/jazzprog/lesson-files/prog1 USERDATA/exercises/jazzprog/lesson-files/prog2 USERDATA/exercises/jazzprog/lesson-files/prog3
There is one folder name below USERDATA/exercises
that is special. In addition to what described above, all lesson files
in USERDATA/exercises/user/lesson-files will be
shown when you select on the
menu. This was done to make it simple to just
write a lesson file, drop it in a directory and use it.
In versions prior to 3.20.3, all lesson files matching
USERDATA/exercises/*/lesson-files/* would be listed.
In GNU Solfege, each exercise is created by a lesson file interpreted by one of the exercise modules.
Deprecated modules: chord, harmonicprogressiondictation,
Missing documentation: chordvoicing, identifybpm, twelvetone
Solfege by default expects the content of lesson files to be in UTF-8 encoding. Modern editors often let you specify the encoding in the "Save As" dialog. One example is gedit. Other programs, like vim and emacs let you specify the encoding inside the text file.
If this sounds complicated, you can safely ignore the whole encoding issue if you restrict yourself to use only standard ascii characters. That is only the letters a to z.
If you create lesson files with a different encoding, you have to declare the encoding in a special comment at the top of the file. This because Solfege and the tools used to translate Solfege cannot guess the encoding safely. We follow the same conventions as the Python language. See PEP-0263 for the details.
What you have to do is add a comment to one of the first two lines
of the lesson file, where part of the line matches coding=encoding or coding: encoding. Extra characters on the
line are ignored, so if you use the emacs or vim editors, you can conveniently
tell the editor about the file encoding. The following example sets
the charset to ISO 8859-1, a charset commonly used in many west-european
languages:
# -*- coding: iso-8859-1 -*-
Russians might want to use koi8-r:
# -*- coding: koi8-r -*-
Same as above, but in a format that works with the vim:
# vim: set fileencoding= koi8-r :
The program use the python libs to convert to unicode, so it should understand almost any encoding you can think of. If you see some characters are missing, for example when the name of questions are displayed on buttons, then most likely you have done something wrong with the encoding.
Unicode has some characters that you might want to use to make labels look more professionally. If your editor use unicode by default, you may copy-and-paste the characters you need from here, if you are viewing this documentation in a web browser. The number is a hexidecimal number.
00F8 LATIN SMALL LETTER O WITH STROKEHalf-diminished seventh chord.
00B0 DEGREE SIGNDiminished seventh chord.
25B3 WHITE UP-POINTING TRIANGLE, Δ 0394 GREEK CAPITAL LETTER DELTAMajor seventh chord. We do not know which character to recommend. Solfege does not care, so you can use the symbol you like.
266D MUSIC FLAT SIGNThis sign can be used instead of the letter 'b' for a flat sign.
266F MUSIC SHARP SIGNThis can be used instead of the letter '#' for the sharp sign.
Everything after # on a line is ignored. Example:
# This line is ignored. The next line is not.
question { bla bla }
Strings are quoted with the " character. Example:
"this is a string"
Use triple quotes for strings that contain line breaks, or
if the string itself has to contain the " character:
description = """<h1>Long desription<h1> This lessonfile need
very much descriptions. Qoutes (") are ok here. bla bla bla"""NB: All strings have to be unicode strings. If you get error messages like this one:
In line 21 of input: does not recognise this string ';lt;' as a valid token.'
(line 20): question {
(line 21): question {
(line 22): name = _("Ionia�)
then you must check the encoding of your file, and maybe you should read “File encoding”. You can change the encoding of a file using the iconv program:
iconv -f YOUR_ENCODING -t utf8 your.file
Global variables can save you a few key strokes.
s = "\score\relative c'{ %s }
question {
# instead of music = music("\score\relative c'{ c d e f g2 g2 }")
music = music(s % "c d e f g2 g")
}
A lesson file consist of one header block and zero or more question blocks:
header {
ASSIGNMENT
ASSIGNMENT
...
}
question {
ASSIGNMENT
...
}
The header block can be placed anywhere in the file, but by convention it should be the first block in the file. And there is a limitation that the header has to be within the first 40000 characters of the file.
Variables shared by many exercise modules
moduleTell what exercise module that will run the lesson file. This
variable is required for all lesson files. (The variable was added in
Solfege 2.9.0 where it replaced the content
variable.). Example:
module = idbyname
replacesA string or list of strings with hash values of lesson files that
this lesson file can replace without dropping the statistics. Use this only when
you know what you are doing. The hash value is calculated by
solfege.lessonfile.hash_of_lessonfile().
tools/hash-of-file.py can be used to get the hash value
of files before modifying them.
replaces = "bf7dd374206451bff43d61fc8191f5fb3e88d007" replaces = "bf7dd374206451bff43d61fc8191f5fb3e88d007", "cdb2f9415171650ee7682028788c1c42c62fdbf"
lesson_idThis variable is deprecated in Solfege 3.15.3. It should remain in existing lesson files because if you remove it, you will have to add a replaces entry to keep the statistics. But it should not be added to new lesson files.
versionTell the version of solfege the lessonfile is known to work with. This variable is not required, but it should be used because it can (but don't guarantee to) help avoid trouble if the lesson file format changes in the future. Example:
version = "3.0.7"
titleShort one-line description that will be used for creating the menu entry for the exercise. You should add this to all lesson files. Example:
title = "Minor and major chords in root position"
lesson_headingA short heading that will be displayed above the exercise. It should say what the purpose of the exercise is. Some modules provide a default value, others leave the string empty. Example:
lesson_heading = _("Identify the chord")helpThis variable say which help file from the user manual will be displayed when the user presses F1. Example:
help = "idbyname-intonation"
By default, Solfege will display the help file that has the same name as the exercise module being used in the lesson file.
theoryThis variable say which help file from the user manual will be displayed when the user presses F3. Pressing F3 should display music theory about the exercise. Don't include this variable if there are no music theory written. Example:
theory = "scales/maj"
random_transposeIn some exercises the program can transpose the music to
create variation. The default value is yes. (The
default value changed from no to
yes in Solfege 3.0.)
Used in modules: chord,
chordvoicing, harmonicprogressiondictation,
idbyname, singanswer,
singchord
Possible values
No transposition will be done.
The exercise will do random transposition. What kind of transposition depends on the exercise, but you get a ok result from this. This is the default value.
Transpose the question by random and make sure the key signature of the question does not get more than a certain number of accidentals. In this context, the number of accidentals can be described by an integer value. A negative value denote a number of flats (b), and a positive number denote a number o sharps (#). Zero mean no accidentals. The integers INTEGER1 and INTEGER2 defines a range of allowed number of accidentals.
For this to work properly the music must
either be in C major or A minor, or the key of the music has
to be set with the
key variable.
Transpose the music INTEGER1 steps down or INTEGER2 steps up the circle of fifth. In this context up is more sharps and down is more flats. This is real transposition where both the key and the notes are transposed.
For this to work properly the music must
either be in C major or A minor, or the key of the music has
to be set with the
key variable.
Transpose the music at most INTEGER1 semitones down or INTEGER2 semitones up. This is real transposition where both the key and the notes are transposed. You will easily end up with music in the keys with LOTS of accidentals.
Transpose the music at most INTEGER1 semitones down or INTEGER2
semitones up. Similar to semitones, but the
notes will be transposed one by one, and the key will not change.
enable_right_click = noBy default, Solfege will let the user right-click on buttons to hear
the music they represent without guessing. Set this variable to
no for lesson files where it does not make sense, for
example in a idbyname lesson file where many questions
have the same name.
Modules: idbyname, chordvoicing
and chord.
disable_unused_intervals
= noBy default, Solfege will make the buttons insensitive for intervals
that are not being asked. Set this variable to no if you
want all buttons to be sensitive.
Modules: harmonicinterval and
melodicinterval.
ask_for_intervals_0Select which intervals to ask for. 1 for minor second, 2 for major
second, 3 or minor third etc. Use a negative number for descending
intervals. To ask for more that one interval create the variables
ask_for_intervals_1,
ask_for_intervals_2 etc. In the following example
Solfege will ask for two intervals. The first will be either a minor second
or a major second, both intervals going up. And the second interval will be
either major second or minor third, both intervals going down.
ask_for_intervals_0 = 1, 2
ask_for_intervals_1 = -2, -3
Modules: melodicinterval and
singinterval.
intervalsThis variable tell which intervals should be asked for in exercises
using the harmonicinterval module. 1 for minor second, 2 for major
second, 3 or minor third etc. Example that will practise thirds:
intervals = 3, 4
Modules: harmonicinterval.
test
This variable defines the test for the exercise. In a test,
Solfege will ask all the questions in the lesson file a number
of times.
This variable is always used together with test_requirement.
In the following example, each question will be asked
3 times:
test = "3x"
Modules: harmonicinterval,
idbyname, melodicinterval
and singinterval.
test_requirementThis variable defines how large percentage of the questions has to be answered correctly to pass the test. Example:
test_requirement = "90%"
Modules: harmonicinterval,
idbyname, melodicinterval
and singinterval.
have_repeat_arpeggio_button
= yesSet to yes if you want the exercise to have a
"Repeat arpeggio" button.
Modules: singanswer.
have_music_displayer
= yesSet to yes if you want the question to have a
music displayer.
In the idbyname module, setting this variable will add a music displayer where the program will display the answer when the user gives up or answers the question correctly. You might also want to read about at_question_start.
In the singanswer module, setting this variable
will add a music displayer where the music will be displayed when
the question is displayed.
Modules: idbyname,
elembuilder and
singanswer.
music_displayer_stafflines
= INTEGERThe number of empty staff lines to display when we have no music to display.
Modules: idbyname and
elembuilder.
at_question_start
This variable changes what happens when the user clicks
. By default, Solfege will play the music when
the user clicks , and only display the music
when the question is answered correctly and the
have_music_displayer variable is set to
yes. Setting this variable will also set
have_music_displayer to yes.
at_question_start = showThe exercise will get a button. When the user clicks the music will be displayed in the music displayer, but no music is played. Click to hear the music.
at_question_start = playThe exercise will get a button. When the user clicks the music is played. Click to see the music.
at_question_start = show, playWhen the user clicks the music is both played and displayed.
Modules: idbyname, elembuilder,
rhythmtapping
and rhythmtapping2.
vmusicThis variable holds a representation of the question intended to be
displayed. This can be necessary if the music is a .wav or .mp3 file. It
will be used when the user clicks Show music or when the question is
answered correctly (if we have a musicdisplayer). Added to
idbyname in Solfege 2.5.1 and to
elembuilder in 3.9.2.
Modules: idbyname and elembuilder.
rhythm_elementsA list of integers (1-34) telling what elements we should use when creating questions. Example:
rhythm_elements = 0, 1, 2, 3, 4
0:
,
1:
,
2:
,
3:
,
4:
,
5:
,
6:
,
7:
,
8:
,
9:
,
10:
,
11:
,
12:
,
13:
,
14:
,
15:
,
16:
,
17:
,
18:
,
19:
,
20:
,
21:
,
22:
,
23:
,
24:
,
25:
,
26:
,
27:
,
28:
,
29:
,
30:
,
31:
,
32:
,
33:
,
34:
Modules: rhythm and rhythmtapping2
statistics_matrices = enabled | disabled | hiddenSet to disabled if the statistics page
of the exercise should not display the matrices showing more details
on how you have answered. Set to hidden if the
matrices should be hidden by an expander button.
Default value: enabled
Variables you can define in the question block
nameQuestions written for the idbyname or elembuilder exercise modules need a name. A name is optional for dictation module.
musicFor most lesson files the music representing the question is assigned to this variable. Note that there is a shortcut. Instead of:
question {
name = "Lisa gikk til skolen"
music = music(...)"
}
you can write:
question {
name = "Lisa gikk til skolen"
music(...)
}
Music objects are documented in “music objects”.
rhythmIf defined in a question, the rhythm of this music object is used when comparing the users answer to the question. This can be useful if the Solfege cannot find the rhythm of the question, for example when the music object is a MP3 file.
Used in modules: rhythmtapping and
rhythmdictation.
tempoSet the tempo for this questions music. The variable is defined "beats per minute" / "notelen per beat". Example:
tempo = 150 / 4
This variable can also be defined globally for the whole lesson file. Do do so you should put it in the beginning of the file, outside any question blocks.
Modules: idbyname, chord,
chordvoicing,
rhythmdictation2 and
rhythmtapping.
countinA music object representing a count-in to be played before
the question. Only music objects that are parsed by the
mpd module can be used as count-in, and only
questions parsed by this module can have count-in. Example:
tempo = rhythm("\time 4/4 d4 d d d")Entering the time signature is not necessary if the time signature is 4/4, but for all other time signatures you must include it.
Modules: rhythmdictation and
rhythmdicatation2
instrumentBy default, Solfege will use the instrument specified on the preferences window when playing questions. This variable let you select a different instrument. Example:
instrument = "cello", 100
The instrument name has to be quoted. The integer is the volume, and it should be in the range 0-127. You can see a list of instrument names in “Midi instrument names”. For lesson files where it makes sense, it is possible to specify three set of instruments. The following example will play bass for the lowest tone, piano in the middle and clarinet on the top tone:
instrument = "bass", 100, "acoustic grand", 100, "clarinet", 100
This variable can also be defined globally for the whole lesson file. Do do so you should put it in the beginning of the file, outside any question blocks.
Modules: idbyname, chord,
singanswer and chordvoicing
setThe set variable is used by some exercise modules to select which question to play when the user right clicks on one of the answer buttons. This can be useful if the lesson file has many questions with the same name, and you want solfege to play the question that is most closely related to the question being asked. You can assign whatever value you want. A good suggestion is to use integers.
In lesson files that does not use the set variable,
solfege will play the first question it can find with
the same name as the button the user right clicks on.
If the lesson file uses the set, or more
precisely, if the question being asked has the variable defined, the
program will first try to find a question where the
set variable matches the question being asked, and the
name matches the button clicked. If no match is found,
the program will select a question to play as if the
set variable was not used at all.
Modules: idbyname and
chordvoicing.
keyNeeded to make some random transposition work properly if the music is not in C major on A minor. Two examples:
key="b \minor" key="g \major"
The import statement will parse a library file and bind it to a
name in the global namespace. You then refer to names defined in the
libarary file using dot notation. In the example below, the
files jazz_progressions and progression_elements are two library files that are part of GNU Solfege and
is located in the INSTALLDIR/exercises/standard/lib/ directory.
import progression_elements import jazz_progressions as j question { elements = progression_elements.I, progression_elements.V } question { elements = j.I, j.V, j.V }
Parse the file and bind it to the same name as the file name:
| |
Parse the |
The program will first search for a library file in
INSTALLDIR/exercises/standard/lib/ and if not found,
in the ../lib/ relative to the location of the
lesson file.
The rimport statement work exactly the same
way as import except that ../lib/
relative to the lesson file is searched before
INSTALLDIR/exercises/standard/lib/.
Include and import works a little differently. One thing is that how they
find the file to parse differs. But also what happens with the file content. If
one idbyname lesson file includes another
idbyname lesson file, when the questions from the included
file will be asked when you practise the including file. But if you copy the
included file to ../lib/ and import it,
the questions in the imported file will not be asked. Only the global
variables in the imported file will be available with dot-notation, as
described in “The import statement”.
Each question in your lesson files will define one or more
music objects.
This is music entered completely following the music format FIXME spec. This means you
have to enter complete code with a \staff command. Example:
variable = music("\staff\relative c' { c' d' }")The music object can be used for music that has 3 or more staffs. It works the same way as music, but if "Use different instruments for chords and harmonic intervals" is checked in the preferences window, the 3 instruments you can select the same place will be used instead of the preferred MIDI instrument.
Enter the tones from the lowest to the highest tone, like this:
variable = chord("c' e' g'")This type of music is used by the singchord exercises. It let you say which tones of a chord the different voices in a choir will sing. Take this, for example:
variable = satb("c''|e'|g|c")The c'' will be sung by the soprano, e' by the alto, g by the tenor and
c by the bass. Please notice that when this music
is played in arpeggio, the tones to be sung by the women, will be played
one octave deeper, of the user is a male. And vice versa if the user
is a female or a child.
This musictype saves some key strokes if you want to enter a melody.
variable = voice("c'4 c' g' g' | a' a' g'2")is the same as
variable = music("\staff{ c'4 c' g' g' | a' a' g'2")rvoice is similar to voice
except that the music is in \relative mode, relative
to the first tone. The following two statements produce the same music:
variable = rvoice("c'4 c g' g | a a g2")
\staff\relative c'{ c4 c g' g' | a a g2 }
This music object provides a simple way to play rhythms with percussion instruments. Each tone represents a percussion instrument as defined in “Percussion instrument names”. In the following example, the tone c is translated to the midi sound Side Stick and d to a Mute triangle.
variable = percussion("d4 d d d c8 c8 c4")
This music object let you write questions that tap rhythms with the
two percussion instruments defined in the preferences window. The tone
c will play with the instrument intended for the
question and d will use the instrument
intended for count off. Example:
rhythm("d4 d d d c8 c8 c4 c c8 c8")You should only use two pitches, c and
d. Other pitches will print a warning, but will still
work in the current implementation. To play real percussion with many
different instruments you should use the percussion music object.
Play a midi file. The path given to the file is relative to the directory the lesson file is stored in. Example:
variable = midifile("share/example.mid")Play a .wav file. The path given to the file
is relative to the directory the lesson file is stored in. Example:
variable = wavfile("share/fifth-small-220.00.wav")Play a MP3 file. Similar to wavfile.
Play an Ogg Vorbis file. Similar to wavfile.
Given a CSound orchestra and score, this music object will generate a WAV file and play it. Example:
csound(load("share/sinus.orc"), """
f1 0 4096 10 1
i1 0 1 220.0
i1 + 1 329.04
""")
Create a music object that use MMA to generate music that it will play. If you create the object
with one argument, mmacode should be a string with
complete MMA code. With two arguments, groove is
a string with the name of the groove, and mmacode is
comple MMA code, except it could be missing the initial
"Groove" instruction. The groove from groove
will be prepended the string.
Run an external program. Example:
cmdline("./bin/csound-play-harmonic-interval.sh 220.000000 320.100000")_(message)
Return the translation of message if it exist.
Return the string unchanged if not.
title = _("Bla bla title")include(filename)
Read the file filename into the lesson file
and parse it as a part of the file.
The program will first search for the file with the filename relative
to the location of the lesson file. If not found, it will search
the exercises/standard/lesson-files directory
of the installation directory of the program.
include("singchord-1")The lesson header variables will be taken from the including lesson file. Only if a variable is only defined in the included lesson file, and not in the including lesson file, then the value will be taken from the included file.
load(filename)
Read the file filename from disk and return
it as a string. The filename is relative to the location
of the lesson file.
orc = load("share/sinus.orc")Label functions
We call these functions label functions because we use them to create the label for some questions in the program. You should only use these functions where they are documented to work.
Return a label that the program can put on a button. The label is created using GTK pangomarkup. Google for "pango markup" to get the markup explained. Notice that you have to use triple qoutes around the string.
pangomarkup("""<span size="xx-large">V</span>""")This function has existed in Solfege for a while, but it has not been documented until now. Should we find a shorter function name? An alias can be added so that the old long function name still works.
Return a label. str is interpreted like
this:
Each letter outside of a parentheses is displayed with a large serif font.
The text inside parentheses is displayed as a superscript: smaller letters above the baseline.
If the text inside the parentheses is divided by a comma, the text before the comma is superscript and after the comma is subscript.
progressionlabel("I-IV-(6,4)V(5,3)-I")
progressionlabel("I-VI-V(6)-I")"
progressionlabel("C(maj7)")
Display a sequence of roman numeral chords. The chords are separated by whitespace and an optional hyphen. The exact implementation of this is still open for discussion. The current developent version of Solfege will divide each chord in 3 parts and give them different font sizes, and also try to make the chord compact, so that it should not take too much space on screen.
The first part of the chord is the roman numberal, including
an optional b, ♭
(unicode character U+266D MUSIC FLAT SIGN),
# or ♯
(unicode character U+266F MUSIC SHARP SIGN).
The second part is the letters (if any) between the first and the third part.
The third part is from the first digit and the rest of the chord.
rnc("Imaj7-IIm7-V9-Imaj7")Spaces are not allowed in the chord name.
New in version 3.11.0.
Display a sequence of chords. The chords are separated by whitespace. Each chord consist of up to four parts, and part two to four are optional:
[notename][txt1][:txt2][/bass]
notename and bass music be
a notename in the format understood by the music parser. You can read
more about this in “The mpd module”. Example:
g:11b9 cm/g ges:Δ besm:7/f
New in version 3.11.1.
Here is a minimal lesson file:
header {
countin_perc = compareintervals
title = "Compare intervals"
}
This file will make an exercise that ask you to compare harmonic intervals. And since you do not say which intervals, it will ask for all intervals from a small second up to a major tenth.
first_interval_type, second_interval_typeLet you select if the intervals you are asked to compare should be a
melodic or a harmonic interval. The default value is
melodic. Possible values:
harmonic and melodic.
first_interval_type = melodic
second_interval_type = harmonic
Modules: compareintervals.
first_interval, last_intervalSelect which intervals to select from when creating the questions. This variable should be defined the same way as ask_for_intervals_0. If these two variables are not defined, then the user will be able to select which intervals to practise from the Config page of the exercise.
Modules: compareintervals.
Example:
header {
module = dictation
title = _("Norwegian children songs")
version = "2.1.10"
}
question {
name = "Bæ, bæ, lille lam"
tempo = 130/4
breakpoints = 2/1, 4/1, 8/1, 10/1, 12/1, 14/1
music = rvoice("""
\time 4/4
c'2 g' | e4 e c2 | d4 d g, g | c1 |
c2 g' | e4 e c2 | d4 d g, g | c1 |
a'4 f f f | g2. e4 | f d d d | e2. c4 |
a'2 f | g e4 e | f b, b b | c1 |
""")
}
question {
# this tempo definition overrides the global
tempo = 160/4
name = "Lisa gikk til skolen"
breakpoints = 2/1, 4/1, 6/1
music = rvoice("""
\time 4/4
c' d e f | g2 g2 | a4 a a a | g1 |
f4 f f f | e2 e | d4 d d d | c1
""")
}
question {
name = "Det satt to katter på et bord..."
tempo = 96/4
music = rvoice("""
\key g \major \time 2/4
d'8 | [g g] [fis e] | [fis g] a4 | [d,16 d d d] [e8 fis] | g2 """)
}
By default, the dictation exercise will show the first column of music, and then the user should write the rest. But if the first column is not good enough, for example if there are only rests on the first beat, these two variables can tell the program how much music to display:
clue_endThe following example will display the music on all staffs in the first quarter note:
clue_end=1/4
clue_music
This is an alternative to clue_end. The music assigned
to clue_music will be shown to the user when he should
start the dictation. You should not use both clue_end
and clue_music in the same question.
breakpointsSet breakpoints in the music, so you can hear the music in parts when doing the dictation.
Here is a minimal lesson file:
element progI { label = "I" }
element progIV { label = "IV" }
element progV { label = "V" }
header {
module = elembuilder
title = "progression test"
elements = auto
# uncomment if you want a music displayer.
# have_music_displayer = yes
}
question {
music = rvoice("<c' e g> <b d g> <c e g>")
elements = progI, progV, progI
name = "I-V-I"
}
question {
music = rvoice("<c' e g> <c f a> <c e g>")
elements = progI, progIV, progI
name = "I-IV-I"
}
This block defines the elements the user can put together to answer the
question. Each block is named by the string between element
and {. The block defines one variable,
label that is the label the button will get.
labellabel can either be a plain string or one
of the label functions.
sortIf defined, the value of sort will be used
to sort the elements when displaying the buttons. If not defined,
the elements will be sorted by their name.
elementsThis variable defines which elements to display. Set this to auto to display all elements that are needed to answer the questions in the lesson file. You can display more elements that needed to make it more difficult for the user. An example:
elements = progI, progIV, progV, progIV, progV_6
music_displayer_stafflinesSet this if you want the music displayer to show more than one empty staff line when the music displayer have no music to display.
See also at_question_start and music_displayer_stafflines.
elementsThis variable defines which elements defines the question. It can be elements, as defined in the example above, or strings or labels defined by the label functions.
tonicThe exercise will have a "Play tonic" button if this variable is defined in a question in the lesson file. The variable should contain some music to play to the user so that he knows the tonic of the question. This can be useful in harmonic progressions that does not start on the tonic. This variable is optional. Example:
tonic = chord("c e g")nameThe name is needed for storing statistics. A string or a label created by the label functions.
See also vmusic.
User documentation is in “Intervalo armónico”.
Here is a minimal lesson file:
header {
module = harmonicinterval
version = "3.1.4"
title = "Seconds"
intervals = 1, 2
test = "3x"
test_requirement = "90%"
}
Additional variables you can put in the header. Click on the link to get an explanation:
This is a very generic exercise. In its most basic form, the program will play some sound, and you have to select among several buttons that in some way represents the music.
Here is a minimal lesson file:
header {
module = idbyname
version = "3.1.4"
title = "Menuitem title"
}
question {
name = "Major"
music = chord("c' e' g'")
}
question {
name = "Minor"
music = chord("c' es' g'")
}
Optional idbyname header variables
filldir = verticTell the direction the buttons are filled. Default value is horiz.
Modules: idbyname.
fillnumTell how many buttons there are in each row or column. The default value is 1.
Modules: idbyname.
labelformat = progressionThe default value is normal.
Set to progression for lesson files where the name of the
questions is a harmonic progression, written in a undocumented, but not
difficult format. Check some existing lesson file to see how it works.
Using this variable is deprecated. Do not use it for new lesson files.
Modules: idbyname
have_repeat_slowly_button
= yesSet to yes if you want the exercise to have a "Repeat slowly" button.
Modules: idbyname.
See also at_question_start and music_displayer_stafflines.
Required question variables
name. Can be a string or a label created by the label functions.
Optional question variables
vmusicSee vmusic.
cuemusicWill be displayed in the music displayer when the user clicks New.
Ignored if at_question_start = play, show or
at_question_start = show, because then the content of
music or vmusic is displayed when the
user clicks New. (Added in Solfege 2.5.1)
The idproperty module let you create exercises where
solfege will play some music and you have to identify different properties
of the music.
Below is a minimal lesson file. It will create an exercise that will play a minor or major chord and the user answers with two buttons labeled "Minor" and "Major" and two buttons representing the inversion. Notice that unused properties, toptone in this example, are hidden.
header {
module = idproperty
flavour = "chord"
title = "Minor and major chords"
}
question {
name = "Major"
music = chord("c' e' g'")
inversion = 0
}
question {
name = "Minor"
music = chord("es' g' c''")
inversion = 1
}
flavour = "chord" will add the following definitions
to the lesson file header, unless if they are missing:
new_button_label = _("_New chord")
lesson_heading = _("Identify the chord")
qprops = "name", "inversion", "toptone"
qprop_labels = _("Name"), _("Inversion"), _("Toptone")
new_button_label is the label to put on the
button. The default value is
_("New").
lesson_heading will set the heading to be displayed
when you practise. The default value is an empty string, that will hide the
heading.
The properties are defined by the props variable in
the lesson file header, and there should be a variable
prop_labels that defines the label to use.
props and prop_labels must be lists of
equal length.
The exercise will have a button
if one or more of the questions can be played arpeggiated. Set the lesson file
header variable have_repeat_arpeggio_button to no to disable hide the button.
If the exercise have a inversion property, it will be
treated special. If assigned integer values, like in the example, the integer values will be replaced with strings. So 0 is replaced with "root position", 1 with "1. inversion" etc.
Here is a minimal lesson file:
header {
module = idtone
title = "Id tone 3"
black_keys_weight = 0, 0, 0, 0, 0
white_keys_weight = 1, 1, 1, 0, 0, 0, 0
}
The 'weight' of a tone tell how big chance is it that the program will select this tone as the next to identify. Think of the weight of a tone as the number of lottery tickets with the name of the tone.
The variable black_keys_weight set the weight of the
tones c#, d#, f#, g# and a#, and white_keys_weight will set
the weight of the tones c, d, e, f, g, a, b. In the example above, the tones c,
d and e get an equal weight of 1, the other tones 0. This mean that the only
tones that will be asked for are c, d and e, and that the three tones share the
same probability to be selected.
User documentation is in “Intervalo melódico”.
Here is a minimal lesson file:
header {
module = melodicinterval
version = "3.1.4"
title = "Seconds and thirds"
ask_for_intervals_0 = 1, 2, 3, 4, -1, -2, -3, -4
test = "3x"
test_requirement = "90%"
}
Additional variables you can put in the header. Click on the link to get an explanation:
Tests are only partially implemented for the
melodicinterval exercise module: tests where each question
is made by more than one interval does not work yet.
Here is a minimal lesson file:
header {
module = nameinterval
title = _("Fifths")
intervals = p5, a5, d5
}
intervalsA list of the intervals to ask for. The intervals are written
in a short form, a letter and a number, like d5
or m7. The letters are telling the interval quality are
'd' for diminished, 'a' for augmented, 'm' for minor, 'M' for major and
'p' for perfect.
tonesThis variable sets the range of tones that can be used when
constructing the intervals. The note names has to be quoted. The
default value is "b", "g''". Example:
tones = "c'", "f''" # valid tones = c', f'' # not valid
accidentalsThis variable defines how many accidentals the tones making the interval can have. The value 0 means no accidentals, 1 means that flats and sharps are allowed, and 2 means that double flats and double sharps are allowed. The default value is 1. Example:
accidentals = 2
clefSet which clef to use. The default value is violin.
Possible values: violin, treble,
subbass, bass,
baritone, varbaritone,
tenor, alto,
mezzosoprano and french.
Example:
clef = bass
A simple rhythm exercise. Solfege will randomly generate rhythm patterns that the user should recreate by clicking on buttons.
Here is a minimal lesson file:
header {
module = rhythm
version = "3.1.4"
title = "Easy rhythms"
rhythm_elements = 1, 2, 3, 4
}
visible_rhythm_elementsDefine this variable if you want more rhythm elements that the one to
be asked for. This variable must include both the rhythm elements defined
in rhythm_elements and the extra elements.
Example:
rhythm_elements = 0, 1, 2, 3, 4, 5, 6
countin_percAn integer value between 35 and 81, representing the percussion instrument used to give you the beat before the question. The default value is 80. Example:
countin_perc = 35
35 Acoustic Bass Drum 51 Ride Cymbal 1 67 High Agoga 36 Bass Drum 52 Chinece Cymbal 68 Agogo Low 37 Side Stick 53 Ride Bell 69 Cabasa 38 Acoustic Snare 54 Tambourine 70 Maracas 39 Hand Clap 55 Splash Cymbal 71 Short Whistle 40 Electric Snare 56 Cowbell 72 Long Whistle 41 Low Floor Tom 57 Crash cymbal 2 73 Short Guiro 42 Closed Hi Hat 58 Vibraslap 74 Long Guiro 43 High Floor Tom 59 Ride Cymbal 2 75 Claves 44 Pedal Hi Hat 60 Hi Bongo 76 Hi Wood Block 45 Low Tom 61 Low Bongo 77 Low Wood Block 46 Open HiHat 62 Mute Hi Conga 78 Mute Cuica 47 Low-Mid Tom 63 Open High Conga 79 Open Cuica 48 Hi-Mid Tom 64 Low Conga 80 Mute Triangle 49 Crash Cymbal 1 65 High Timbale 81 Open Triangle 50 High Tom 66 Low Timbale
Modules: rhythm
rhythm_percSame as countin_perc, but setting the instrument used to play the question. The default value is 37.
Modules: rhythm
count_inThe number of beats as count in. The default value is 2.
Modules: rhythm
bpmThe tempo, in beats per minute. The default value is 60.
Modules: rhythm
num_beatsThe number of elements the question is made of. The default value is 4.
Modules: rhythm
Exercises using this module will play some music and then the user should tap the rhythm. The program will then say if the users rhythm is similar enough to the rhythm played by the computer.
Here is a minimal lesson file:
header {
module = rhythmtapping
version = "3.7.0"
title = "Rhythm tapping test"
}
question {
music = rhythm("c4 c8 c8")
}
question {
music = music("\staff\relative c'{c4 d8 e f4}\addvoice\relative c'{c4 b8 c a4}")
rhythm = rhythm("c4 c8 c c4")
}
The first question in the example is very simple and self explaining.
Solfege will play the rhythm defined in the music variable,
and the user should tap that rhythm.
The second question is a little more complicated. Here Solfege will play
the music defined in the music variable. And when the user
taps the rhythm, Solfege will compare the users rhythm with the rhythm defined
in the rhythm variable. The reason for using two variables
is that Solfege is not smart enough to figure out the rhythm if you enter
polyphonic music. It make no difference if you set the
rhythm variable to be a rhythm music
object, or another single voice type like rvoice. This might
change in the future. You as a lesson file author must make sure the rhythms in
the two variables are in fact the same.
See also at_question_start.
Solfege will play a generated rhythm, and the user should tap the same rhythm.
Here is a minimal lesson file:
header {
module = rhythmtapping2
version = "3.7.0"
title = "Rhythm tapping test"
rhythm_elements = 1, 2, 3, 4
}
See also at_question_start.
Solfege will play some music, and the user should enter the rhythm of the music in the rhythm editor. Below is a small lesson file example.
header {
module = rhythmdictation2
title = "Rhythm dictation"
}
# Tempo for all questions
tempo = 150/4
# Used for all questions that does not set the countin music themselves
countin = rhythm("c4 c c c")
question {
# Tempo set here overrides the global tempo
tempo = 150/4
music = rvoice("d'4 d8 e fis8 fis4.")
}
question {
music = mp3file("musicfile.mp3")
rhythm = rvoice("c4 c4 c8 c8 c4")
}
Solfege will play a generated rhythm, and then the user should enter the rhythm in the rhythm editor. Below is a minimal lesson file. You can have as many question blocks as you like. When the program generates a random question, it will first select one question block by random, and then use it to generate the actual question.
header {
module = rhythmdictation2
title = "Rhythm dictation"
}
# Tempo for all questions that does not specify it.
tempo = 150/4
# Countin for all questions that does not specify it
countin = rhythm("d4 d d d")
question {
bars = 4/4, 3/4, 4/4
elements = "4", "8 8"
# Tempo set here overrides the global tempo
tempo = 150/4
}
question {
bars = 3/4, 3/4
countin = rhythm("d4 d d")
elements = "4", "8 8"
}
Here is a minimal lesson file:
header {
module = singanswer
version = "3.1.4"
title = "Sing the root of the chord"
}
question {
question_text = "Sing the root"
music = chord("c' e' g'")
answer = chord("c'")
}
question {
question_text = "Sing the root"
music = chord("a' c'' e''")
answer = chord("a'")
}
Additional variables you can put in the header. Click on the link to get an explanation:
Questions for this exercise need to have the key variable set if the key signature is anything else than ''c'' major (or ''a'' minor). Example:
header {
module = singchord
version = "3.1.4"
title = "Simple chords"
}
question { music = satb("c''|e'|g|c") }
question { music = satb("a'|e'|c'|a") }
question { key="d \major" music = satb("a'|fis'|d'|d") }
question { key="f \minor" music = satb("as'|f'|c'|f") }
See also “Cantar acorde”.
This is an exercise where the program display an interval and play the first tone. Then the user should sing the interval, and then click a button to hear the correct answer. There is no microphone support yet.
User documentation is in “Cantar el intervalo”.
Here is a minimal lesson file:
header {
module = singinterval
version = "3.1.4"
title = "Thirds"
ask_for_intervals_0 = 3, 4
test = "3x"
test_requirement = "90%"
}
This module is still begin worked on. The lesson file format will most likely change in the next releases. Right now the music in the cadences must be a string with complete mpd code. Using music objects will not work now.
Here is a minimal lesson file:
header {
module = toneincontext
version = "3.21.0"
title = "First 4 scale tones"
tones = 3, 4
}
cadence {
music = "\staff\relative g'{ <g e c> <a f c> <g f d b> <g e c> }"
}
The cadence block should be in C major. The program will select cadence by random if you write more than one cadence block.
If you don't define the tones variable, the program will let you select tones in the config page of the exercise.
Experimental feature. Will most likely change in the next stable branch because we need a failsafe way for exercise module to include other files like graphcis etc.
You can write your own exercise modules in Python and place them in the
modules/ directory parallell to the
lesson-files/ directory containing the
lesson file. So the lesson file
USERDATA/exercises/user/lesson-files/demofile will search
for exercise modules in USERDATA/exercises/user/modules/.
A module below USERDATA can have the
same name as one of the standard modules. The module below USERDATA will be
used when the lesson file is stored in the lesson-files/ directory parallell to the modules/ directory. But the standard lessonfiles
stored in INSTALLDIR and in other
directories willuse the standard module included with Solfege.
The module is not documented yet. The input format is similar to the one used by GNU Lilypond, but only the simplest construct works.
Quick note: Notenames understood by the program are c, d, e, f, g, a, b, with 'is', 'isis', 'es', or 'eses' added. For example 'fis', 'bes', 'gisis'.
acoustic grand contrabass lead 7 (fifths)
bright acoustic tremolo strings lead 8 (bass+lead)
electric grand pizzicato strings pad 1 (new age)
honky-tonk orchestral strings pad 2 (warm)
electric piano 1 timpani pad 3 (polysynth)
electric piano 2 string ensemble 1 pad 4 (choir)
harpsichord string ensemble 2 pad 5 (bowed)
clav synthstrings 1 pad 6 (metallic)
celesta synthstrings 2 pad 7 (halo)
glockenspiel choir aahs pad 8 (sweep)
music box voice oohs fx 1 (rain)
vibraphone synth voice fx 2 (soundtrack)
marimba orchestra hit fx 3 (crystal)
xylophone trumpet fx 4 (atmosphere)
tubular bells trombone fx 5 (brightness)
dulcimer tuba fx 6 (goblins)
drawbar organ muted trumpet fx 7 (echoes)
percussive organ french horn fx 8 (sci-fi)
rock organ brass section sitar
church organ synthbrass 1 banjo
reed organ synthbrass 2 shamisen
accordion soprano sax koto
harmonica alto sax kalimba
concertina tenor sax bagpipe
acoustic guitar (nylon) baritone sax fiddle
acoustic guitar (steel) oboe shanai
electric guitar (jazz) english horn tinkle bell
electric guitar (clean) bassoon agogo
electric guitar (muted) clarinet steel drums
overdriven guitar piccolo woodblock
distorted guitar flute taiko drum
guitar harmonics recorder melodic tom
acoustic bass pan flute synth drum
electric bass (finger) blown bottle reverse cymbal
electric bass (pick) skakuhachi guitar fret noise
fretless bass whistle breath noise
slap bass 1 ocarina seashore
slap bass 2 lead 1 (square) bird tweet
synth bass 1 lead 2 (sawtooth) telephone ring
synth bass 2 lead 3 (calliope) helicopter
violin lead 4 (chiff) applause
viola lead 5 (charang) gunshot
cello lead 6 (voice)
The first column is the integer value for the instrument. The second column tell the name of the note you should enter in the rhythm music object.
35 b,, Acoustic Bass Drum 59 b Ride Cymbal 2 36 c, Bass Drum 1 60 c' Hi Bongo 37 cis, Side Stick 61 cis' Low Bongo 38 d, Acoustic Snare 62 d' Mute Hi Conga 39 dis, Hand Clap 63 dis' Open High Conga 40 e, Electric Snare 64 e' Low Conga 41 f, Low Floor Tom 65 f' High Timbale 42 fis, Closed Hi Hat 66 fis' Low Timbale 43 g, High Floor Tom 67 g' High Agogo 44 gis, Pedal Hi Hat 68 gis' Agogo Low 45 a, Low Tom 69 a' Cabasa 46 ais, Open HiHat 70 ais' Maracas 47 b, Low-Mid Tom 71 b' Short Whistle 48 c Hi-Mid Tom 72 c'' Long Whistle 49 cis Crash Cymbal 1 73 cis'' Short Guiro 50 d High Tom 74 d'' Long Guiro 51 dis Ride Cymbal 1 75 dis'' Claves 52 e Chinese Cymbal 76 e'' Hi Wood Block 53 f Ride Bell 77 f'' Low Wood Block 54 fis Tambourine 78 fis'' Mute Cuica 55 g Splash Cymbal 79 g'' Open Cuica 56 gis Cowbell 80 gis'' Mute Triangle 57 a Crash Cymbal 2 81 a'' Open Triangle 58 ais Vibraslap
Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. http://fsf.org/
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
The GNU General Public License is a free, copyleft license for software and other kinds of works.
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program—to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
For the developers’ and authors’ protection, the GPL clearly explains that there is no warranty for this free software. For both users’ and authors’ sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users’ freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and modification follow.
“This License” refers to version 3 of the GNU General Public License.
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
A “covered work” means either the unmodified Program or a work based on the Program.
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work’s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.
You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
The work must carry prominent notices stating that you modified it, and giving a relevant date.
The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
Limiting the use for publicity purposes of names of licensors or authors of the material; or
Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.
A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient’s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
one line to give the program’s name and a brief idea of what it does.Copyright (C)yearname of authorThis program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
programCopyright (C)yearname of authorThis program comes with ABSOLUTELY NO WARRANTY; for details type ‘show w’. This is free software, and you are welcome to redistribute it under certain conditions; type ‘show c’ for details.
The hypothetical commands ‘show w’ and
‘show c’ should show the appropriate parts of
the General Public License. Of course, your program’s commands might be
different; for a GUI interface, you would use an “about box”.
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see http://www.gnu.org/licenses/.
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read http://www.gnu.org/philosophy/why-not-lgpl.html.