DIRECTORY BasicTime USING [ GMT ], RefQ USING [ Queue ], Rope USING [ ROPE ], RPC USING [ EncryptionKey ], Thrush USING [ CallUrgency, ConversationHandle, ConvEventBody, EncryptionKey, EventSequence, IntervalSpec, IntervalSpecs, NB, newTune, nullConvHandle, nullHandle, PartyHandle, ProseSpec, ProseSpecs, Reason, ROPE, SHHH, SmartsHandle, StateInConv, ThHandle, Tune, VoiceInterval ], ThSmartsRpcControl ; FinchSmarts: CEDAR DEFINITIONS = { ConversationHandle: TYPE = Thrush.ConversationHandle; nullConvHandle: Thrush.ConversationHandle = Thrush.nullConvHandle; NB: TYPE = Thrush.NB; nullHandle: Thrush.ThHandle = Thrush.nullHandle; Orig: TYPE = { unknown, us, them }; PartyHandle: TYPE = Thrush.PartyHandle; Reason: TYPE = Thrush.Reason; ROPE: TYPE = Thrush.ROPE; SHHH: TYPE = Thrush.SHHH; FinchInfo: TYPE = REF FinchInfoBody; FinchInfoBody: TYPE = MONITORED RECORD [ smartsID: Thrush.SmartsHandle_Thrush.nullHandle, partyID: Thrush.PartyHandle _ Thrush.nullHandle, shh: SHHH_NIL, conversations: RefQ.Queue -- of ConvDescs --, currentConvID: ConversationHandle _ nullConvHandle, thProcess: PROCESS_NIL, thAction: CONDITION, apprise: BOOL_FALSE, myName: ThSmartsRpcControl.InterfaceName _ [], myRName: ROPE _ NIL, myPassword: RPC.EncryptionKey _ NULL, serverInstance: ROPE_NIL, ReportSystemState: PROC[ on: BOOL ], ReportConversationState: PROC[ nb: NB, cDesc: ConvDesc, remark: ROPE_NIL ] ]; ConvDesc: TYPE = REF ConvDescBody; ConvDescBody: TYPE = RECORD [ cState: Thrush.ConvEventBody, -- amalgam of useful info from reported events desiredState: Thrush.StateInConv_any, -- what we're aiming for desiredPartyID: PartyHandle_NULL, desiredReason: Reason_wontSay, desiredComment: ROPE_NIL, requestedIntervals: Thrush.IntervalSpecs_NIL, pendingIntervals: Thrush.IntervalSpecs_NIL, -- a tail of requestedIntervals, to be started requestedProses: Thrush.ProseSpecs_NIL, pendingProses: Thrush.ProseSpecs_NIL, -- a tail of requestedProses, to be started newEvent, newSpec, newKeys, newAddress: BOOL _FALSE, descValid: BOOL_FALSE, clientData: REF _ NIL, otherPartyID: PartyHandle _ nullHandle, otherPartyDesc: ROPE_ NIL, startTime: BasicTime.GMT_NULL, originator: Orig _ unknown, ultimateState: Thrush.StateInConv _ idle, -- last state reached (except for idle) weOriginated: BOOL_FALSE, -- This Finch originated the call bluejayConnection: BOOL_FALSE, proseConnection: BOOL_FALSE, conference: BOOL_FALSE, failed: BOOL_FALSE ]; InitFinchSmarts: PROC [ thrushInstance: Thrush.ROPE_NIL, ReportSystemState: PROC[ on: BOOL ], ReportConversationState: PROC[ nb: NB, cDesc: ConvDesc, remark: ROPE_NIL ] ]; FinchIsRunning: PROC RETURNS [finchIsRunning: BOOL]; UninitFinchSmarts: PROC[problem: Thrush.ROPE_NIL]; PlaceCall: PROC [ convID: Thrush.ConversationHandle _ Thrush.nullConvHandle, rName: ROPE_NIL, number: ROPE_NIL, urgency: Thrush.CallUrgency_normal, useNumber: BOOL_FALSE]; AnswerCall: PROC[convID: Thrush.ConversationHandle]; DisconnectCall: PROC[ convID: Thrush.ConversationHandle, reason: Thrush.Reason_terminating, comment: ROPE_NIL ]; GetHistory: PROC[ convID: Thrush.ConversationHandle, toState: INT_0 -- i.e., all-- ] RETURNS [ s: Thrush.EventSequence ]; GetRname: PROC[partyID: Thrush.PartyHandle] RETURNS [ rName: ROPE]; RecordReason: TYPE = { ok, abandoned, failed, hopeless }; RecordTuneProc: TYPE = PROC[ useTune: Thrush.Tune_Thrush.newTune, useInterval: Thrush.VoiceInterval_[], queueIt: BOOL_FALSE ] RETURNS[ reason: RecordReason, -- << wouldn't need if only "ok" and "failed/hopeless" are supported.>> tune: Thrush.Tune, interval: Thrush.VoiceInterval_NULL, key: Thrush.EncryptionKey_NULL ]; RecordTune: RecordTuneProc; StopTuneProc: TYPE = PROC[ reason: RecordReason_ok -- other valid value: abandon (recording only: supported?) ]; StopTune: StopTuneProc; PlaybackTuneProc: TYPE = PROC [ tune: Thrush.Tune, interval: Thrush.VoiceInterval_[], key: Thrush.EncryptionKey, queueIt: BOOL_TRUE, failOK: BOOL_FALSE, -- playing is optional; leave connection open if tune doesn't exist. wait: BOOL _ FALSE -- wait until things appear to be started properly, or have failed ] RETURNS [ started: BOOL_FALSE ]; PlaybackTune: PlaybackTuneProc; TextToSpeechProc: TYPE = PROC [text: Rope.ROPE, queueIt: BOOL_TRUE, proseTranslateProc: ProseTranslateProc_NIL] RETURNS [reason: RecordReason_ok]; ProseTranslateProc: TYPE = PROC [inText: Rope.ROPE] RETURNS [outText: Rope.ROPE]; TextToSpeech: TextToSpeechProc; RegisterTranslateProcType: TYPE = PROC [translate: ProseTranslateProc_NIL]; RegisterTranslateProc: RegisterTranslateProcType; StopSpeechProc: TYPE = PROC [reason: RecordReason_ok]; StopSpeech: StopSpeechProc; ResetProse: StopSpeechProc; GetConvDesc: PROC[convID: ConversationHandle] RETURNS [cDesc: ConvDesc]; GetCurrentConvID: PROC RETURNS [convID: ConversationHandle]; DequeueInterval: PROC[cDesc: ConvDesc] RETURNS [ int: Thrush.IntervalSpec_NIL ]; Feep: PROC[feepString: ROPE]; FinchState: TYPE = { unknown, running, stopped }; Procs: TYPE = REF ProcsRecord; ProcsRecord: TYPE = RECORD [ playbackTune: PlaybackTuneProc, recordTune: RecordTuneProc, stopTune: StopTuneProc, textToSpeech: TextToSpeechProc, registerTranslateProc: RegisterTranslateProcType, stopSpeech: StopSpeechProc, resetProse: StopSpeechProc, finchIsRunning: PROC RETURNS [isRunning: BOOL] ]; Register: PROC [finchSmartsProcs: Procs]; GetProcs: PROC RETURNS [Procs]; CurrentFinchState: PROC RETURNS [finchState: FinchState]; }. &FinchSmarts.mesa Copyright c 1985 by Xerox Corporation. All rights reserved. Last Edited by: Swinehart, May 19, 1986 9:26:29 am PDT Polle Zellweger (PTZ) December 13, 1985 3:04:16 pm PST Types Call backs Switching data Client Data ReportConversationState implementation can store client-dependent pointers here; but this field is cleared once the ConvDesc leaves the FinchInfo.conversations Queue. 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 Initialization 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) Expect ReportSystemState, followed by some number of ReportConversationStates, soon. No more than one client should call this procedure, at present. 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. Recording and Playback ok: something was recorded abandoned: user or client program asked to abandon the recording (supported?) failed: something went wrong, but may not next time. hopeless: will continue to fail until somebody does something creative. convID: Thrush.ConversationHandle _ Thrush.nullConvHandle, --vestigial until I figger it out This procedure waits until the recording is complete. While it is running, calls to the registered procedures may occur to inform the user of what's happening. Client is responsible for arranging process structures so that there is a process available to call StopTune while a call to RecordTune is still pending. convID should be defaulted convID: Thrush.ConversationHandle _ Thrush.nullConvHandle, --vestigial until I figger it out Terminates recording or playback of tune, if any. Causes any pending RecordTune to terminate and return. convID: Thrush.ConversationHandle _ Thrush.nullConvHandle, --vestigial until I figger it out Text-to-speech server A translate proc is used to modify the text rope to make it more intelligible. Examples: 1) words that the Prose doesn't pronounce correctly could be respelled or given as phonemes, and 2) Prose commands to alter speech speed or pitch could be added. Send rope to text-tospeech server. Called with rope = the current selection by FinchTool's SpeakText button. Input rope will be modified by the translate proc if (a) one is specified with this call or (b) one has previously been specified via RegisterTranslateProc[proc] below. Register default translate procedure to be used by TextToSpeech to make the text rope more intelligible. Most useful as a way to modify the action of the FinchTool's SpeakText button. Flushes text-to-speech server queues, halts current speech. Flushes text-to-speech server queues, initiates Prose self-test, and resets all speech parameters. Intended as an escape hatch. Conversation Access <> Registration This is like the WalnutRegistry. Finch registers its procedures here, and clients of Finch obtain and use them. FinchRegistryImpl implements these procedures. Finch runs FinchRegistryImpl if it's not already running, and so do its applications. Multiple instances of FinchRegistryImpl produce multiple registrations, though, so be careful with configs. Unlike WalnutRegistry, this one is presently set up to deal with only one set of registered procs at a time. Created for use by WalnutVoice, which wants to be able to run with or without Finch running. Register a set of procedures to be invoked when the appropriate database changes occur. Return a registration that can be used to name the set Get the current registered set, or NIL a quick and safe way to find out if Finch has been loaded and if it is active or not 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 Polle Zellweger (PTZ) December 13, 1985 2:50:51 pm PST New function for FinchToolImpl to use for managing selections in conversation log. changes to: GetCurrentConvID Êh˜šœ™Icodešœ Ïmœ1™Jšœžœ˜!J˜Jšœžœžœ˜Jšœ)žœ˜-Jšœ'žœŸ.˜ZJšœ#žœ˜'Jšœ!žœŸ+˜QJšœ(žœž˜4Jšœ žœžœ˜J˜J™ šœ žœžœ˜JšœP™PJšœV™V—Jšœ'˜'Jšœžœžœ˜Jšœžœžœ˜J˜šœ*Ÿ'˜QJšœ™Jšœ2™2Jšœ3™3JšœB™B—JšœžœžœŸ!˜;Jšœžœžœ˜Jšœžœžœ˜Jšœ žœžœ˜Jšœžœž˜J˜—J™—™J˜š œžœ˜Jšœžœžœ˜ š œžœžœ˜$J™1—š  œžœžœžœžœ˜JJšœ˜™˜—Jšœ˜JšœT™TJ™?—J˜Jš œžœžœžœ˜4J˜Jš œžœžœžœ˜3J˜—™J˜š  œžœ˜Jšœ:˜:Jšœžœžœ˜Jšœžœ˜Jšœ#˜#Jšœ žœžœ˜J™_™IJ™YJ™9J™%J™FJ™—J˜—š  œžœ$˜4J˜—š œžœ˜Jšœ"˜"J˜"Jšœ žœž˜Jšœ˜—J˜š  œžœ.žœŸœ˜TJšžœ˜$—J˜Jš œžœžœ žœ˜CJ˜—™J˜šœžœ'˜9J™J™MJ™4J™G—J˜š œžœžœ˜Jšœ\™\J˜$J˜%Jšœ žœž˜Jšœ˜Jšžœ˜JšœŸG˜]J˜Jšœžœ˜$Jšœž˜J˜Jšœ†Ïbœ  œ™»Jš¡œ™—Jš  œ˜J˜š  œžœžœ˜Jšœ\™\JšœŸ:˜RJšœ˜J™i—Jš œ˜J˜š œž œ˜Jšœ\™\Jšœ˜J˜"J˜Jšœ žœž˜JšœžœžœŸD˜XJšœž ŸB˜UJšœžœ žœžœ˜"—Jš  œ˜J˜—™Kš œžœžœ žœ žœžœ)žœžœ˜’š  œžœžœžœžœžœ˜QK™û—š  œ˜Kšœ˜™˜—Kš œžœžœ žœ˜Kš œ˜1K™¸—J˜Jš œžœžœ˜6š  œ˜J™;—š  œ˜J™€—J˜—™Jš  œžœžœ˜HJ˜Jš œžœžœ˜