Garrapatea Library Documentation

Functions Review

Garrapateahas its divided in three parts.

• The canvas "partitura"- formed by a growing number of 38 pixels canvas.
• The array "almacen"- stores the objects and the position on the canvas "partitura".
• The buttons or controllers- for creating objects.

We have several methods that intercat between this parts.

almacena (objet, canvasStaveId)

This method is used for save an object and the position into the canvas. Recieve a musical object like a note, cleff, rythm or bar and the respective position into the canvas "partitura".

overriteAlmacen (objet, canvasStaveId)

Substite an object with another object.

nuevaArmadura (counter, canvasStaveId)

Creates a newer key signature. Recieve a counter, for control the number of clicks on the canvas and the canvasId for a correct saving on "almacen".

testArmadura (note, keySignature)

Checks if one note is sharped or flatted for the effect of some key signature.

almacenaTonalidad (key, canvasStaveId)

Save the key signature in the array.

dibujaArmadura (key, canvasStaveId, a)

Control the key signature drawing on the canvas. The "a" object is a variable passed to this function for a better control the drawing. If exist paint on two canvas.

browserCatch ()

Function for control the browsers differences.

trySound ()

Test if the browser support the different APIs supported by Garrapatea Sound

tryAPIsound ()

Function created for trySound(). Test only if the APIsound is supported in the user's browser.

tryHTMLsound ()

Function created for trySound(). Test only if the HTML audio tag si supported by the user's browser. It's called only if the previous function(tryAPIsound) is false.

tryJasmid ()

Return true or false if the browser supports or not the jasmid library.

clickeoEnCanvas (event, canvasStaveId)

Function that works as a dynamic onclick listener. Get the context of the canvas.

obtenPixelColor (canvas_x, canvas_y, contexToPixel, canvasStaveId)

Tell us if the user click on the object. Objects in canvas are allways black in Garrapatea. If- it's black, call redibujaCanvas(), to redraw the canvas. Else- call repartoAcciones().

repartoAcciones (canvas_x, canvas_y, canvasStaveId)

Check the controlls and decide what acction is going to do.

coordenadasRatonCanvas (event, canvasStavedId)

Return the coordinates over the clicked canvas. X, Y and canvasStaveId.

imprimirPartitura ()

Print with the javascript print() function.

aMidi (arrayAlmacen)

Run over the array "almacen" and translate objects calling to the apropiate midiMessage function.

midiNota (objet)

translate teh objct Obnota, a note stored in the array, to the correct midiMessage and add it to the Miditrack. Use a series of calls to the MidiSketch library.

midiSilencio (objet)

The same as midiNota() but with silence objects.

midiArray (objetArray)

Called by aMidi() if the there are more than one object in the same canvas.

polifonia (notesMidi)

Used for create simple chords when midiArray call it.

aFile ()

Creates a blob and put inside the binary midi file, then call the native downloadad function for each browser.

loadAudio (directory)

Loads audio from sonidosmin DIRECETORY if you doesn't pass a path to a new directory. Load the audio only for webAudioAPI.

loadNote (pitch, url)

Called by previous function, loads every mp3 file to the buffer. Uses https request.

ejecutaNota (number)

Play the note from the buffer when recieve a Number (name) of the file

bypassAudio (directory)

Called when the Web Audio API is not supported and loads audio files from directory.

loadHTMLnote (pitch, url)

Do the same as loadNote but with HTML audio API.

ejecutaNotaHTML(number)

Do the same as ejecutaNota but with HTML audio API.

nuevaBarra (canvas_x, canvasStaveId)

Creates, stores and paints the bars for the staves.

nuevaClave (kind, canvasStaveID)

Creates, stores and paints the cleff on the canvas.

nuevaNota (canvas_y, canvasStaveId)

controls the new note creation. Check what note controlers the user has clicked and call the apropiate function.

createObNota ()

called by nuevaNota(), this function return a new note object.

dibujaGrupoNotas (startnotegroup, endnotegroup, notesarray, notesdurationarray, notesaccidentalarray, arraydots)

Function for correct drawing beam notes. Recieve groups of arrays for localize and paint over the canvas.

alturaNota (canvas_y)

Recieve the Y clicked coordinate over the canvas, and return the name of the note to nuevaNota().

dibujaNota (note, duration)

Draw a simply note, with no neighbours.

dibujaNotaAlterada (note, duration, accidental)

Draw the simply note and the accident selected by the user.

nuevoCanvas ()

Introduce a new canvas on the DOM of the HTML.

nuevoCompas (canvasId)

Draw the 5 lines of the stave on the canvas.

nuevoRitmo (rythmnumber, canvasStaveId)

Draw a new Rythm 2/4, 3/4, etc., on the stave.

nuevoSilencio (canvasStaveId)

Control the creation of a new Silence.

dibujaSilencio (duration)

Draw the correct silence. This function is called by the nuevoSilencio function.

aReproducir (SketchObject)

This function recieve a MidiSketch object. This object, created by the MidiSketch library and interactuate with this fuction as a bypass. It calls the native midi support for each browser.

aJasmid ()

The online call to play jasmid for opera, chrome and firefox.

aBgSound ()

Internet Explorer midi support.

muestraImagenPartitura ()

Controlls the creation of a PNG image frome the canvas objects.

redibujaCanvas (canvasStaveId, pixelcontext)

Redraw the canvas if the pixel is black. It works with colaboration of nuevoCompas().

borraCanvasAndRedibuja (canvasStaveId)

Make the same as redibujaCanvas() but without call other function.

borraCanvasDom ()

Delte the last canvas from the DOM tree.

playNOte (ObNote, soundCkecked)

Call to get the midi note number, check the sound browser support and call the correct function for playing the feedback mp3 sounds.

getMidiNoteNumber (Obnota)

Recieve the Obnote object and return the correct midi note number.