DIRECTORY Atom USING [ PropList ], BasicTime USING [ GMT ], GVBasics USING [ Password ], LarkFeepRpcControl USING [ InterfaceRecord ], MBQueue USING [ Queue ], RefID USING [ ID ], Rope USING [ ROPE ], RPC USING [ EncryptionKey ], ThParty USING [ PartyInfo ], Thrush USING [ ActionReport, ConversationID, ConvEventBody, InterfaceSpec, NB, nullConvID, nullID, PartyID, Reason, ROPE, SHHH, SmartsID, StateInConv ], ThSmartsRpcControl ; FinchSmarts: CEDAR DEFINITIONS = { ConversationID: TYPE = Thrush.ConversationID; nullConvID: ConversationID = Thrush.nullConvID; NB: TYPE = Thrush.NB; nullID: RefID.ID = Thrush.nullID; WhoOriginated: TYPE = { unknown, us, them }; PartyID: TYPE = Thrush.PartyID; Reason: TYPE = Thrush.Reason; ROPE: TYPE = Thrush.ROPE; SHHH: TYPE = Thrush.SHHH; FinchInfo: TYPE = REF FinchInfoBody; FinchInfoBody: TYPE = MONITORED RECORD [ smartsID: Thrush.SmartsID_nullID, partyID: PartyID _ nullID, shh: SHHH_NIL, conversations: LIST OF ConvDesc -- of ConvDescs --, requests: MBQueue.Queue, stateChange: CONDITION, myName: ThSmartsRpcControl.InterfaceName _ [], myRName: ROPE _ NIL, myPassword: RPC.EncryptionKey _ NULL, prevThrushInstance: ROPE _ NIL ]; ConvDesc: TYPE = REF ConvDescBody; ConvDescBody: TYPE = RECORD [ situation: Thrush.ConvEventBody, -- amalgam of useful info from last-reported event whoOriginated: WhoOriginated _ unknown, ultimateState: Thrush.StateInConv _ idle, -- last state reached (except for idle) startTime: BasicTime.GMT_NULL, subject: ROPE_NIL, numParties: NAT_0, numActive: NAT_0, numIdle: NAT_0, partyInfo: ThParty.PartyInfo_NIL, -- Complete description as of some recent time feepInterfaceSpec: Thrush.InterfaceSpec, feepInterface: LarkFeepRpcControl.InterfaceRecord, clientData: REF _ NIL, props: Atom.PropList _ NIL, originatorRecorded: BOOL_FALSE, reportComplete: BOOL_FALSE ]; InitFinchSmarts: PROC [thrushInstance: Thrush.ROPE_NIL]; FinchIsRunning: PROC RETURNS [finchIsRunning: BOOL]; UninitFinchSmarts: PROC[problem: Thrush.ROPE_NIL, nb: Thrush.NB_NIL]; PlaceCall: PROC [ convID: Thrush.ConversationID _ nullConvID, rName: ROPE_NIL, number: ROPE_NIL, useNumber: BOOL_FALSE]; AnswerCall: PROC[convID: ConversationID]; DisconnectCall: PROC[ convID: ConversationID, reason: Thrush.Reason_$terminating, comment: ROPE_NIL, newState: Thrush.StateInConv _ $idle -- Can also be $failed, to terminate with fast-busy and such. ]; Feep: PROC[convID: ConversationID, feepString: ROPE]; GetNumbersForRName: PROC[rName: ROPE] RETURNS [fullRName: ROPE, number: ROPE, homeNumber: ROPE]; VoiceConnect: PROC [ serviceName: ROPE, convID: Thrush.ConversationID _ nullConvID ] RETURNS [ nb: NB_$success, cDesc: ConvDesc_NIL ]; LookupServiceInterface: PROC [ serviceName: ROPE, interfaceName: ROPE, cDesc: ConvDesc_NIL ] RETURNS [ nb: NB_$success, shhh: Thrush.SHHH, interfaceSpec: Thrush.InterfaceSpec ]; IdentifyVisitor: PROC[visitor, password: Rope.ROPE, complain: BOOL _ TRUE] RETURNS [nb: NB_$success]; ReleaseVisitor: PROC[visitor, password: Rope.ROPE]; ReportSystemStateProc: TYPE = PROC[ on: BOOL ]; ReportConversationStateProc: TYPE = PROC[ nb: NB, cDesc: ConvDesc, remark: ROPE_NIL ]; ReportRequestStateProc: TYPE = PROC[ cDesc: ConvDesc, actionReport: Thrush.ActionReport, actionRequest: REF ] RETURNS [betterActionRequest: REF]; RegisterForReports: PROC [s: ReportSystemStateProc _ NIL, c: ReportConversationStateProc _ NIL, r: ReportRequestStateProc _ NIL, before: BOOL _ TRUE]; UnRegisterForReports: PROC [s: ReportSystemStateProc _ NIL, c: ReportConversationStateProc _ NIL, r: ReportRequestStateProc _ NIL]; ReportConversationState: PROC [nb: NB, cDesc: ConvDesc, remark: Rope.ROPE]; }. ¨FinchSmarts.mesa Copyright c 1985, 1986 by Xerox Corporation. All rights reserved. Last Edited by: Swinehart, November 12, 1986 1:06:35 pm PST Doug Terry, September 5, 1986 3:44:36 pm PDT Polle Zellweger (PTZ) February 27, 1987 5:15:11 pm PST Types Switching data Data of use to clients, maintained by FinchSmarts Maintained by SmartsImpl: For calls that were completed, this will be active For attempted outgoing calls, this is perhaps maybe For incoming calls that were not answered, this is perhaps ringing Client-maintained data ReportConversationState implementation can store client-dependent pointers here; but this field is cleared once the ConvDesc leaves the FinchInfo.conversations Queue. Client-specific values, such as information used by synthesizer code and such. Placed here as a convenience for such services. Initialization Call Management Uses specified conversation, creates a new one or uses one that's in a sufficiently idle state. Interpretation of rName and number -- evaluate until action can be taken: rName exists in switching system (has an Etherphone, usually) and ~use#: call that party. number#NIL: rName is simply a description; call by number rName=NIL or use#: invalid parameters rName exists in obsolete directory and ~use#: use the resulting number all tests fail: no such party. If the other party is willing to do it (trunk parties only, at present), generate touchtones corresponding to the characters in feepString. For talking to feep-controlled services. Alphabetic characters in feepString are translated to their corresponding digits, based ont he mapping found on most telephone touchpads and dials. Management of services Establishes an active conversation with the named voice service, e.g. "recording". Uses specified conversation, creates a new one, or uses one that's in a sufficiently idle state. Looks up the interface for the named voice service, e.g. the "VoiceRopeServer" interface for the "recording" service. Clients can then import this interface directly. Visiting Will complain about invalid passwords iff complain=TRUE. Reporting Clients of Finch can register callback procedures to receive reports concerning the state of conversations, actions taken by the recording service, etc. Expect ReportSystemState, followed by some number of ReportConversationStates, soon. Whenever a toggle occurs, so does this procedure. Client-relevant changes in conversation state are reported in gory detail; FinchSmarts is allowed to invent parts of it (e.g., reason and remark fields) ThSmarts.ReportAction was called; we are willing to pass the report on to this routine. FinchSmarts implementation will locate the relevant action request (e.g., an IntervalSpec) and pass it on with the action report. N.B.!!! Each registered ReportRequestStateProc must either return actionReport, or return a better value for it. The intended use is for an upstream registered proc. to compute the request value as a function of actionReport and some local state. Downstream procedures get the augmented report. Care must be taken to register these procedures (with the help of the before hint (see RegisterForReports), so that the right thing happens. If before is true, procs go at front of list, else they go at end of list. Remove procs from the list of report subscribers. Distributes a report to all subscribers. Swinehart, July 18, 1985 3:31:34 pm PDT Created FinchSmarts.Register and friends -- easier for WalnutVoice to deal with Finch. changes to: InitFinchSmarts, RecordTuneProc, RecordTune, StopTuneProc, StopTune, PlaybackTuneProc, PlaybackTune, PlayNoiseProc, PlayNoise, Feep, FinchState, Procs, CurrentFinchState, Procs, Register, FinchIsRunning, UninitFinchSmarts, GetProcs Polle Zellweger (PTZ) July 13, 1985 5:20:26 pm PDT adding Text-to-Speech server Changes to: DIRECTORY, FinchInfoBody, ConvDescBody Added: TextToSpeech, StopSpeech Swinehart, August 6, 1985 4:19:33 pm PDT Merge PTZ Prose changes changes to: DIRECTORY, FinchInfoBody, ConvDescBody, PlayNoise, TextToSpeech, StopSpeechProc, StopSpeech, ProcsRecord Polle Zellweger (PTZ) August 29, 1985 5:06:29 pm PDT changes to: TextToSpeechProc, ProseTranslateProc, TextToSpeech, StopSpeechProc, StopSpeech, ResetProse, ProcsRecord Polle Zellweger (PTZ) September 3, 1985 6:17:21 pm PDT Allow registration of proseTranslateProc. changes to: ProseTranslateProc, TextToSpeech, RegisterTranslateProcType, RegisterTranslateProc, ProcsRecord Polle Zellweger (PTZ) October 24, 1985 4:56:25 pm PDT Move bluejayConnection and proseConnection from FinchInfo to ConvDesc. changes to: FinchInfoBody, ConvDescBody Doug Terry, August 28, 1986 4:22:57 pm PDT Created FinchSmarts.RegisterForReports; removed all routines dealing with record or playback of tunes and removed record/play stuff from FinchInfo and ConvDesc; retired FinchSmarts.Register and friends. changes to: ReportSystemStateProc, ReportConversationStateProc, ReportRequestStateProc, RegisterForReports, DIRECTORY, FinchInfoBody, ConvDescBody, InitFinchSmarts, UnRegisterForReports Doug Terry, August 29, 1986 12:06:10 pm PDT New interface procedures for FinchSmarts clients to get at voice services: VoiceConnect and LookupServiceInterface. changes to: VoiceConnect, LookupServiceInterface Swinehart, September 25, 1986 11:12:43 am PDT Add props field to ConvDesc, in order to allow per-conversation application-specific data. changes to: ConvDescBody Polle Zellweger (PTZ) February 19, 1987 10:31:24 pm PST changes to: FinchInfoBody, VisitorInfo, VisitorInfoBody, ConvDesc, DIRECTORY, IdentifyVisitor, ReleaseVisitor Polle Zellweger (PTZ) February 23, 1987 2:15:25 pm PST changes to: FinchInfoBody Polle Zellweger (PTZ) February 27, 1987 4:23:24 pm PST changes to: IdentifyVisitor, ReleaseVisitor, FinchInfoBody Κϋ˜šœ™Icodešœ Οmœ7™BJšœ;™;K™,Kšœ6™6—J˜šΟk ˜ Jšœžœ˜J˜Jšœ žœ˜Jšœžœ˜-J˜Jšœžœžœ˜Jšœžœžœ˜Jšžœžœ˜J˜šœž˜ Jšœgžœ ˜‹—J˜J˜J˜—šœ žœ˜"J˜—™J™˜-J˜/—Jšžœžœ žœ˜Jšœžœ˜!Jšœžœ˜,Jšœ˜J˜Jšžœžœ˜Jšžœžœ žœ˜J˜Jšœ žœžœ˜$šœžœž œžœ˜(Jšœ!˜!Jšœ˜Jšœžœžœ˜J˜Jšœžœžœ Οcœ˜3Jšœ˜Jšœ ž œ˜J˜Jšœ.˜.Jšœ žœžœ˜Jšœ žœžœ˜%Jšœžœž˜J˜J˜—Jšœ žœžœ˜"šœžœžœ˜J™Jšœ!Ÿ2˜SJ˜J™1J˜'šœ*Ÿ'˜QJšœ™Jšœ2™2Jšœ3™3JšœB™B—Jšœžœžœ˜Jšœ žœžœ˜Jšœ žœ˜Jšœ žœ˜Jšœ žœ˜JšœžœŸ/˜QJ˜(J˜2J˜J™šœ žœžœ˜JšœP™PJšœV™V—šœžœ˜Jšœ€™€—Jšœžœžœ˜Jšœžœž˜J˜—J™—™J˜JšΟnœžœžœžœ˜8J˜Jš œžœžœžœ˜4J˜Jš  œžœžœžœ žœžœ˜FJ˜—™J˜š  œžœ˜Jšœ+˜+Jšœžœžœ˜Jšœžœ˜Jšœ žœžœ˜J™_™IJ™YJ™9J™%J™FJ™—J˜—š  œžœ˜)J˜—š œžœ˜Jšœ˜J˜#Jšœ žœž˜Jšœ%Ÿ=˜bJšœ˜J˜—™΅J™“—Jš œžœ%žœ˜5J˜š œžœžœ˜%Jšžœ žœ žœžœ˜:—J˜J˜—™J™š  œžœ˜Jšœ žœ˜Jšœ*˜*Jšœžœ˜ Jšœžœ ˜Jšœž˜J˜Jšœ΄™΄J˜—š œžœ˜Jšœ žœ˜Jšœžœ˜Jšœž˜Jšœžœ˜ Jšœžœ ˜Jšœ žœ˜J˜#J˜Jšœ§™§J˜—J™š  œžœžœ žœžœ˜JJšžœžœ ˜J™8—Jš œžœžœ˜3J˜J˜—™ J™J™˜JšœT™TJ˜šœžœžœžœ˜/J™1—J˜š œžœžœžœžœžœ˜VJšœ˜™˜—J˜š œžœžœEžœžœžœ˜‘J™ΪJšΟbœω œ#™Ά—J™š œžœžœ#žœžœ žœžœ˜–K™JK™—š  œžœžœ#žœžœ˜ƒK™1—J™š œžœžœ žœ˜KJ™(——J˜J™™'K™VKšœ Οrη™σ—™2K™Kšœ ’&™2Kšœ’™—™(K™Kšœ ’h™t—™4Kšœ ’g™s—™6Kšœ’œ™)Kšœ ’_™k—šœ5™5KšœF™FKšœ ’™'—™*KšœΚ™ΚKšœ ’­™Ή—™+Kšœs™sKšœ ’$™0—™-K™ZKšœ ’ ™—™7Kšœ ’a™m—K™K™™6Kšœ ’ ™—™6Kšœ ’.™:—K™K™—…—X+ϋ