Csound Csound-dev Csound-tekno Search About

[Cs-dev] Some API documentation points

Date2005-05-05 22:03
FromIain Duncan
Subject[Cs-dev] Some API documentation points
Few things I found going through the csound.h notes and the manual ( 
current html manual online on csounds.com ):

- the csoundKeyPress() entry in csound.h mentions the 'keypress' opcode, 
which does not have an entry in the manual

- in the Control and Events section of csound.h there is an incomplete 
sentence:
* numerical channel names into text, so if the orchestra contains
  */

- in the manual, the entries for invalue and outvalue don't mention the 
api functions, I think if one were to just read those manual entries one 
would wonder what on earth they are for!

- in csound.h, csoundScoreEvent mentions types i,f, or e. Does this mean 
these are the only types that will be permitted, currently work, etc? I 
think this could be a bit clearer, ( ie "only i,f, and e are currently 
implemented" or some such thing. )

Thanks
Iain






-------------------------------------------------------
This SF.Net email is sponsored by: NEC IT Guy Games.
Get your fingers limbered up and give it your best shot. 4 great events, 4
opportunities to win big! Highest score wins.NEC IT Guy Games. Play to
win an NEC 61 plasma display. Visit http://www.necitguy.com/?r=20
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2005-05-06 12:09
FromIstvan Varga
SubjectRe: [Cs-dev] Some API documentation points
Iain Duncan wrote:

> - the csoundKeyPress() entry in csound.h mentions the 'keypress' opcode, 
> which does not have an entry in the manual

As far as I know, csoundKeyPress() does nothing but stores a character in
csound->inChar_ which is then never used. So, in its current state the
function is useless.

> - in the Control and Events section of csound.h there is an incomplete 
> sentence:
> * numerical channel names into text, so if the orchestra contains
>  */
> 
> - in the manual, the entries for invalue and outvalue don't mention the 
> api functions, I think if one were to just read those manual entries one 
> would wonder what on earth they are for!

invalue and outvalue were written by Matt Ingalls, however, he does not
seem to be interested in developing Csound5 these days, and thus the opcodes
and related functions have been abandoned and not changed for a long time.
I do not really know how invalue/outvalue are intended to be used, so you
can consider them generally useless at this time.
Unfortunately the Csound API does contain several stubs of ideas that were
never really worked out.

> - in csound.h, csoundScoreEvent mentions types i,f, or e. Does this mean 
> these are the only types that will be permitted, currently work, etc? I 
> think this could be a bit clearer, ( ie "only i,f, and e are currently 
> implemented" or some such thing. )

csoundScoreEvent has no specific restrictions on the score opcode being used,
so you may or may not have luck with 'q' and 'a'; the best way to find out is
to actually try using them. However, other than these five opcodes, anything
else will most probably not work, because these are really the only ones that
make sense at performance time rather than only when sorting the score file.


-------------------------------------------------------
This SF.Net email is sponsored by: NEC IT Guy Games.
Get your fingers limbered up and give it your best shot. 4 great events, 4
opportunities to win big! Highest score wins.NEC IT Guy Games. Play to
win an NEC 61 plasma display. Visit http://www.necitguy.com/?r=20
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2005-05-06 14:38
Fromjpff@cs.bath.ac.uk
SubjectRe: [Cs-dev] Some API documentation points
> As far as I know, csoundKeyPress() does nothing but stores a
> character in csound->inChar_ which is then never used. So, in its
> current state the function is useless.

It used to do something but it was API'ed and broken.

==John ffitch


-------------------------------------------------------
This SF.Net email is sponsored by: NEC IT Guy Games.
Get your fingers limbered up and give it your best shot. 4 great events, 4
opportunities to win big! Highest score wins.NEC IT Guy Games. Play to
win an NEC 61 plasma display. Visit http://www.necitguy.com/?r=20
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2005-05-06 19:20
Frommatt
SubjectRe: [Cs-dev] Some API documentation points
csoundKeyPress, Invalue, Outvalue, and ScoreEvent are all things i added
and use frequently.  they are for HOST applications communicating with
a csound library and are VERY useful to me.  they are pretty worthless 
for
opcode plugins though.

it has been suggested a few times to make separate api's for hosts and 
plugins, which
i would not object to..

>> - the csoundKeyPress() entry in csound.h mentions the 'keypress' 
>> opcode, which does not have an entry in the manual

i think thats a typo, it should say the 'sensekey' opcode [ not 
'keypress' ]



-------------------------------------------------------
This SF.Net email is sponsored by: NEC IT Guy Games.
Get your fingers limbered up and give it your best shot. 4 great events, 4
opportunities to win big! Highest score wins.NEC IT Guy Games. Play to
win an NEC 61 plasma display. Visit http://www.necitguy.com/?r=20
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2005-05-06 22:41
FromIain Duncan
SubjectRe: [Cs-dev] Some API documentation points
> csoundKeyPress, Invalue, Outvalue, and ScoreEvent are all things i added
> and use frequently.  they are for HOST applications communicating with
> a csound library and are VERY useful to me.  they are pretty worthless for
> opcode plugins though.

As I am moving my gig user interface to a host app, they will be 
extremely useful to me too! My point about invalue and outvalue is that 
there is no mention in the manual entry at all that they are meant to be 
used with the api and a host app. The entries would be very confusing to 
anyone who didn't read the api header file first.

>>> - the csoundKeyPress() entry in csound.h mentions the 'keypress' 
>>> opcode, which does not have an entry in the manual
> 
> 
> i think thats a typo, it should say the 'sensekey' opcode [ not 
> 'keypress' ]

Aha, that clears that one up!

Thanks
iain


-------------------------------------------------------
This SF.Net email is sponsored by: NEC IT Guy Games.
Get your fingers limbered up and give it your best shot. 4 great events, 4
opportunities to win big! Highest score wins.NEC IT Guy Games. Play to
win an NEC 61 plasma display. Visit http://www.necitguy.com/?r=20
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net