PitchCreate a pitch
\nBooleanTest if an object is a pitch
\nEncode a pitch
\nArrayDecode a pitch
\nStringGet pitch type
\nBooleanTest if is a pitch note (with or without octave)
\nBooleanTest if is an interval
\nBooleanTest if is a pitch class (a pitch note without octave)
\nIntegerGet direction of a pitch (even for notes)
\nIntegerGet encoded fifths from pitch.
\nIntegerGet encoded octaves from pitch.
\nIntegerGet height of a pitch.
\nIntegerGet chroma of a pitch. The chroma is a number between 0 and 11 to represent\nthe position of a pitch inside an octave. Is the numeric equivlent of a\npitch class.
\nPitchParse a note
\nPitchParse an interval
\nPitchParse a note or an interval
\nPitchEnsure the given object is a note pitch. If is a string, it will be\nparsed. If not a note pitch or valid note string, it returns null.
\nPitchEnsure the given object is a interval pitch. If is a string, it will be\nparsed. If not a interval pitch or valid interval string, it returns null.
\nPitchEnsure the given object is a pitch. If is a string, it will be\nparsed. If not a pitch or valid pitch string, it returns null.
\nStringConvert a note pitch to string representation
\nStringConvert a interval pitch to string representation
\nStringConvert a pitch to string representation (either notes or intervals)
\nfunctionDecorate a function to work internally with note pitches, even if the\nparameters are provided as strings. Also it converts back the result\nto string if a note pitch is returned.
\nfunctionDecorate a function to work internally with interval pitches, even if the\nparameters are provided as strings. Also it converts back the result\nto string if a interval pitch is returned.
\nfunctionDecorate a function to work internally with pitches, even if the\nparameters are provided as strings. Also it converts back the result\nto string if a pitch is returned.
\nPitch\nCreate a pitch\n\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| fifths | Integer | the number of fifths from C or from P1 |\n| focts | Integer | the number of encoded octaves |\n| dir | Integer | (Optional) Only required for intervals. Can be 1 or -1 |\n\n\n\n## isPitch(p) ⇒ Boolean\nTest if an object is a pitch\n\n\n\n| Param | Type |\n| --- | --- |\n| p | Pitch |\n\n\n\n## encode(step, alt, oct, dir)\nEncode a pitch\n\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| step | Integer | |\n| alt | Integer | |\n| oct | Integer | |\n| dir | Integer | (Optional) |\n\n\n\n## decode(the) ⇒ Array\nDecode a pitch\n\n\n**Returns**: Array - An array with [step, alt, oct] \n\n| Param | Type | Description |\n| --- | --- | --- |\n| the | Pitch | pitch |\n\n\n\n## pType(p) ⇒ String\nGet pitch type\n\n\n**Returns**: String - 'ivl' or 'note' or null if not a pitch \n\n| Param | Type |\n| --- | --- |\n| p | Pitch |\n\n\n\n## isNotePitch(p) ⇒ Boolean\nTest if is a pitch note (with or without octave)\n\n\n\n| Param | Type |\n| --- | --- |\n| p | Pitch |\n\n\n\n## isIvlPitch(p) ⇒ Boolean\nTest if is an interval\n\n\n\n| Param | Type |\n| --- | --- |\n| p | Pitch |\n\n\n\n## isPC(p) ⇒ Boolean\nTest if is a pitch class (a pitch note without octave)\n\n\n\n| Param | Type |\n| --- | --- |\n| p | Pitch |\n\n\n\n## dir(p) ⇒ Integer\nGet direction of a pitch (even for notes)\n\n\n**Returns**: Integer - 1 or -1 \n\n| Param | Type |\n| --- | --- |\n| p | Pitch |\n\n\n\n## fifths(p) ⇒ Integer\nGet encoded fifths from pitch.\n\n\n\n| Param | Type |\n| --- | --- |\n| p | Pitch |\n\n\n\n## focts(p) ⇒ Integer\nGet encoded octaves from pitch.\n\n\n\n| Param | Type |\n| --- | --- |\n| p | Pitch |\n\n\n\n## height(p) ⇒ Integer\nGet height of a pitch.\n\n\n\n| Param | Type |\n| --- | --- |\n| p | Pitch |\n\n\n\n## chr(p) ⇒ Integer\nGet chroma of a pitch. The chroma is a number between 0 and 11 to represent\nthe position of a pitch inside an octave. Is the numeric equivlent of a\npitch class.\n\n\n\n| Param | Type |\n| --- | --- |\n| p | Pitch |\n\n\n\n## parseNote(str) ⇒ Pitch\nParse a note\n\n\n**Returns**: Pitch - the pitch or null if not valid note string \n\n| Param | Type |\n| --- | --- |\n| str | String |\n\n\n\n## parseIvl(str) ⇒ Pitch\nParse an interval\n\n\n**Returns**: Pitch - the pitch or null if not valid interval string \n\n| Param | Type |\n| --- | --- |\n| str | String |\n\n\n\n## parsePitch(str) ⇒ Pitch\nParse a note or an interval\n\n\n**Returns**: Pitch - the pitch or null if not valid pitch string \n\n| Param | Type |\n| --- | --- |\n| str | String |\n\n\n\n## asNotePitch(p) ⇒ Pitch\nEnsure the given object is a note pitch. If is a string, it will be\nparsed. If not a note pitch or valid note string, it returns null.\n\n\n\n| Param | Type |\n| --- | --- |\n| p | Pitch | String |\n\n\n\n## asIvlPitch(p) ⇒ Pitch\nEnsure the given object is a interval pitch. If is a string, it will be\nparsed. If not a interval pitch or valid interval string, it returns null.\n\n\n\n| Param | Type |\n| --- | --- |\n| p | Pitch | String |\n\n\n\n## asPitch(p) ⇒ Pitch\nEnsure the given object is a pitch. If is a string, it will be\nparsed. If not a pitch or valid pitch string, it returns null.\n\n\n\n| Param | Type |\n| --- | --- |\n| p | Pitch | String |\n\n\n\n## strNote(p) ⇒ String\nConvert a note pitch to string representation\n\n\n\n| Param | Type |\n| --- | --- |\n| p | Pitch |\n\n\n\n## strIvl(p) ⇒ String\nConvert a interval pitch to string representation\n\n\n\n| Param | Type |\n| --- | --- |\n| p | Pitch |\n\n\n\n## strPitch(p) ⇒ String\nConvert a pitch to string representation (either notes or intervals)\n\n\n\n| Param | Type |\n| --- | --- |\n| p | Pitch |\n\n\n\n## noteFn(fn) ⇒ function\nDecorate a function to work internally with note pitches, even if the\nparameters are provided as strings. Also it converts back the result\nto string if a note pitch is returned.\n\n\n**Returns**: function - the decorated function \n\n| Param | Type |\n| --- | --- |\n| fn | function |\n\n\n\n## ivlFn(fn) ⇒ function\nDecorate a function to work internally with interval pitches, even if the\nparameters are provided as strings. Also it converts back the result\nto string if a interval pitch is returned.\n\n\n**Returns**: function - the decorated function \n\n| Param | Type |\n| --- | --- |\n| fn | function |\n\n\n\n## pitchFn(fn) ⇒ function\nDecorate a function to work internally with pitches, even if the\nparameters are provided as strings. Also it converts back the result\nto string if a pitch is returned.\n\n\n**Returns**: function - the decorated function \n\n| Param | Type |\n| --- | --- |\n| fn | function |\n","maintainers":[{"name":"danigb","email":"danigb@gmail.com"}],"time":{"modified":"2022-06-27T18:18:05.375Z","created":"2016-05-07T14:26:20.090Z","0.50.0":"2016-05-07T14:26:20.090Z","0.50.1":"2016-05-08T04:35:57.577Z","0.50.2":"2016-05-08T05:24:12.745Z","0.50.3":"2016-05-08T07:08:30.502Z","0.51.0":"2016-07-14T17:02:04.006Z","0.51.1":"2016-07-14T17:04:27.797Z","0.60.0":"2016-11-15T15:08:01.297Z","0.61.0":"2016-11-16T00:44:06.166Z","0.64.0":"2016-11-16T11:30:01.299Z","0.65.0":"2016-11-17T18:28:38.468Z","0.66.0":"2016-11-20T18:50:17.090Z","0.69.0":"2017-02-16T23:04:47.921Z","0.69.2":"2017-04-04T20:50:39.913Z","0.69.3":"2017-04-04T21:10:27.975Z","0.69.4":"2017-04-04T21:49:15.677Z","0.69.6":"2017-05-05T17:22:11.080Z","0.69.7":"2017-07-08T10:51:37.935Z"},"keywords":["music","theory","pitch","tonal"],"author":{"name":"danigb"},"license":"MIT","readmeFilename":"README.md","users":{"rchk":true}}