VoiceMarkersImpl.mesa
Copyright Ó 1987 by Xerox Corporation. All rights reserved.
Ades, May 1, 1986 10:39:24 am PDT
Swinehart, April 9, 1987 10:32:10 am PDT
Polle Zellweger (PTZ) July 21, 1987 12:13:02 pm PDT
DIRECTORY
Commander USING [CommandProc, Register],
CommandTool USING [ArgumentVector, Parse, Failed],
Convert USING [RopeFromInt, IntFromRope],
Imager USING [Context, Move, ShowChar, SetStrokeWidth, SetStrokeJoint, MaskStroke, SetXY, ShowRope, SetFont, black, SetColor],
ImagerFont USING [Extents, Find, Font, Escapement],
ImagerPath USING [PathProc],
Jukebox USING [bytesPerChirp],
MBQueue USING [CreateMenuEntry],
Menus USING [MenuProc, MenuEntry, InsertMenuEntry, GetLine, SetLine, ChangeNumberOfLines],
MessageWindow USING [Append, Blink],
NodeStyle USING [Ref],
NodeStyleOps USING [OfStyle],
Real USING [Fix],
Rope USING [ROPE, Length, Substr, Concat, Fetch, Cat, Find],
RopeEdit USING [AlphaNumericChar],
TEditFormat USING [CharacterArtwork, CharacterArtworkRep, CharacterArtworkClass, CharacterArtworkClassRep, RegisterCharacterArtwork, GetFont],
TextEdit USING [CharSet, FetchChar, GetCharProp, PutCharProp],
TextNode USING [Location, Ref],
TiogaButtons USING [TextNodeRef],
TiogaOps USING [GetRope, GetSelection, FirstChild, ViewerDoc, CallWithLocks, SaveSelA, RestoreSelA],
TiogaOpsDefs USING [Location, Ref],
TiogaVoicePrivate USING [ CancelPlayBack, ChangeMenu, GetCurrentPlayBackPos, GetVoiceLock, GetVoiceViewerInfoList, IntPair, LastSilenceInSoundList, MakeVoiceEdited, PlayBackInProgress, PlaySlabSection, RecordInPlaceOfSelection, RedrawViewer, ReplaceSelectionWithSavedInterval, Selection, SelectionRec, SetVoiceViewerEditStatus, SoundChars, SoundInterval, soundRopeCharLength, StopRecording, TextMarkEntry, TextMarkRec, thrushHandle, voiceButtonQueue, voiceCharDescent, voiceCharHeight, voiceCharSet, voiceCharWidth, VoiceViewerInfo, VoiceViewerInfoList, voiceViewerMenu ],
Vector2 USING [VEC],
ViewerClasses USING [Viewer],
ViewerOps USING [FetchProp, PaintViewer],
VoiceRope USING [Stop, VoiceRopeInterval]
;
VoiceMarkersImpl: CEDAR PROGRAM IMPORTS Commander, CommandTool, Convert, Imager, ImagerFont, MBQueue, Menus, MessageWindow, Real, Rope, RopeEdit, TEditFormat, TextEdit, TiogaButtons, TiogaOps, TiogaVoicePrivate, ViewerOps, VoiceRope EXPORTS TiogaVoicePrivate = {
TiogaVoicePrivate
Handle markers in voice, of two types
i) a special character which the user can place at a selection and remove using button-pushes
ii) annotation of voice with text [if I get round to it]
at present, when selections are used to delete/add markers, selections do not change - fix!
[char marks manually before calling VoicePlayback.Redraw, text marks manually]
Character markers: these are transitory and do not form part of the contents of the viewer
AddCharMark: PUBLIC Menus.MenuProc = {
SELECT mouseButton FROM
red, blue => AddMarksAtSelection[];
yellow => AddMarkAtPlayBackLocation[];
ENDCASE;
};
AddMarkAtPlayBackLocation: PROC = {
adds a mark at the position of the current playback cursor
viewer: ViewerClasses.Viewer ← NIL;
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo;
display: BOOLEAN ← FALSE;
currentPos: INT ← -1;
IF TiogaVoicePrivate.PlayBackInProgress[] THEN {
[display, viewer, currentPos] ← TiogaVoicePrivate.GetCurrentPlayBackPos[];
};
IF currentPos = -1 THEN {
MessageWindow.Append["No current playback to mark (possibly abort in progress)", TRUE];
MessageWindow.Blink[];
RETURN;
};
viewerInfo ← NARROW[ViewerOps.FetchProp[viewer, $voiceViewerInfo], TiogaVoicePrivate.VoiceViewerInfo];
IF (NOT display) OR (viewerInfo = NIL) THEN {
MessageWindow.Append["No voice viewer to mark for current playback", TRUE];
MessageWindow.Blink[];
RETURN;
};
IF TiogaVoicePrivate.GetVoiceLock[viewerInfo] THEN {
MarkChar[viewerInfo, currentPos];
{ trueContents: Rope.ROPE ← TiogaVoicePrivate.SoundChars[viewerInfo].soundRope;
[] ← TiogaVoicePrivate.RedrawViewer[viewer, trueContents, 0, 0, 0, viewerInfo.remnant, FALSE, unAltered];
TiogaVoicePrivate.SetVoiceViewerEditStatus[viewer];
viewerInfo.editInProgress ← FALSE
}
};
};
AddMarksAtSelection: PROC = {
adds marks to the selected voice viewer at each end of the selection if pending delete, otherwise at the position of the caret
viewer: ViewerClasses.Viewer;
start, end: TiogaOpsDefs.Location;
pendingDelete, caretBefore: BOOLEAN;
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo;
[viewer: viewer, start: start, end: end, pendingDelete: pendingDelete, caretBefore: caretBefore] ← TiogaOps.GetSelection[];
viewerInfo ← NARROW[ViewerOps.FetchProp[viewer, $voiceViewerInfo], TiogaVoicePrivate.VoiceViewerInfo];
IF viewerInfo = NIL THEN
{ MessageWindow.Append["Make a selection in a voice viewer first", TRUE];
MessageWindow.Blink[];
RETURN
};
IF TiogaVoicePrivate.GetVoiceLock[viewerInfo] THEN
{
IF NOT ((start.node = end.node) AND
(start.node = TiogaOps.FirstChild[TiogaOps.ViewerDoc[viewer]]))
THEN ERROR;
IF pendingDelete OR caretBefore THEN MarkChar[viewerInfo, start.where];
IF pendingDelete OR ~caretBefore THEN MarkChar[viewerInfo, end.where];
{ trueContents: Rope.ROPE ← TiogaVoicePrivate.SoundChars[viewerInfo].soundRope;
[] ← TiogaVoicePrivate.RedrawViewer[viewer, trueContents, 0, 0, 0, viewerInfo.remnant, FALSE, unAltered];
TiogaVoicePrivate.SetVoiceViewerEditStatus[viewer];
viewerInfo.editInProgress ← FALSE
}
}
};
MarkChar: PROC [
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo, position: INT] = {
restOfList: LIST OF INT;
IF viewerInfo.charMarkList = NIL THEN viewerInfo.charMarkList ← CONS [position, NIL]
ELSE
{ IF viewerInfo.charMarkList.first >= position THEN
{ IF viewerInfo.charMarkList.first > position THEN viewerInfo.charMarkList ← CONS [position, viewerInfo.charMarkList] }
ELSE
{
FOR restOfList ← viewerInfo.charMarkList, restOfList.rest WHILE restOfList.rest # NIL DO IF restOfList.rest.first >= position THEN
{
IF restOfList.rest.first > position THEN restOfList.rest ← CONS [position, restOfList.rest];
RETURN
}
ENDLOOP;
restOfList.rest ← CONS [position, NIL]
}
}
};
LockedAddCharMark: PUBLIC PROC [viewer: ViewerClasses.Viewer, position: INT] = {
called when a viewer is known to be a voice viewer with at least position+1 characters in it: the caller should aready hold the VoiceLock
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo ← NARROW[ViewerOps.FetchProp[viewer, $voiceViewerInfo], TiogaVoicePrivate.VoiceViewerInfo];
IF viewerInfo = NIL THEN ERROR;
MarkChar[viewerInfo, position];
{ trueContents: Rope.ROPE ← TiogaVoicePrivate.SoundChars[viewerInfo].soundRope;
[] ← TiogaVoicePrivate.RedrawViewer[viewer, trueContents, 0, 0, 0, viewerInfo.remnant, FALSE, unAltered];
TiogaVoicePrivate.SetVoiceViewerEditStatus[viewer];
}
};
DeleteCharMarks: PUBLIC Menus.MenuProc = {
viewer: ViewerClasses.Viewer;
start, end: TiogaOpsDefs.Location;
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo;
RemoveMarkChars: PROC [from, to: INT] = {
WHILE viewerInfo.charMarkList # NIL AND viewerInfo.charMarkList.first IN [from..to] DO viewerInfo.charMarkList ← viewerInfo.charMarkList.rest ENDLOOP;
IF viewerInfo.charMarkList # NIL THEN FOR l: LIST OF INT ← viewerInfo.charMarkList, l.rest WHILE l # NIL AND l.rest # NIL DO IF l.rest.first IN [from..to] THEN l.rest ← l.rest.rest ENDLOOP -- the dual WHILE condition is because we can delete the next entry and it could be the last
};
IF mouseButton = blue THEN -- right click means delete all marks in the viewer
{ viewer ← NARROW[parent, ViewerClasses.Viewer];
viewerInfo ← NARROW[ViewerOps.FetchProp[viewer, $voiceViewerInfo], TiogaVoicePrivate.VoiceViewerInfo];
IF TiogaVoicePrivate.GetVoiceLock[viewerInfo] THEN
{ viewerInfo.charMarkList ← NIL;
{ trueContents: Rope.ROPE ← TiogaVoicePrivate.SoundChars[viewerInfo].soundRope;
[] ← TiogaVoicePrivate.RedrawViewer[viewer, trueContents, 0, 0, 0, viewerInfo.remnant, FALSE, unAltered];
TiogaVoicePrivate.SetVoiceViewerEditStatus[viewer];
viewerInfo.editInProgress ← FALSE
}
}
}
ELSE -- both other clicks mean delete all marks from selection
{ [viewer: viewer, start: start, end: end] ← TiogaOps.GetSelection[];
viewerInfo ← NARROW[ViewerOps.FetchProp[viewer, $voiceViewerInfo], TiogaVoicePrivate.VoiceViewerInfo];
IF viewerInfo = NIL
THEN
{ MessageWindow.Append["Make a selection in a voice viewer first", TRUE];
MessageWindow.Blink[];
RETURN
};
IF TiogaVoicePrivate.GetVoiceLock[viewerInfo] THEN
{
IF ~ (start.node = end.node AND start.node = TiogaOps.FirstChild[TiogaOps.ViewerDoc[viewer]]) THEN ERROR;
RemoveMarkChars[start.where, end.where];
{ trueContents: Rope.ROPE ← TiogaVoicePrivate.SoundChars[viewerInfo].soundRope;
[] ← TiogaVoicePrivate.RedrawViewer[viewer, trueContents, 0, 0, 0, viewerInfo.remnant, FALSE, unAltered];
TiogaVoicePrivate.SetVoiceViewerEditStatus[viewer];
viewerInfo.editInProgress ← FALSE
}
}
}
};
DisplayCharMarks: PUBLIC PROC [
unMarkedRope: Rope.ROPE, charMarkList: LIST OF INT, skipChars: INT] RETURNS [markedRope: Rope.ROPE] = {
this gets called by TiogaVoicePrivate.SoundChars, which has been called to build the viewer contents corresponding to some soundlist, the first skipChars omitted: takes that rope and replaces normal characters with marker characters as appropriate
endChar: INT ← unMarkedRope.Length - 1;
lastMark: INT ← -1;
nextMark: INT;
markedRope ← NIL;
WHILE charMarkList # NIL AND charMarkList.first < skipChars DO charMarkList ← charMarkList.rest ENDLOOP;
DO
nextMark ← IF charMarkList = NIL THEN endChar + 1 ELSE charMarkList.first - skipChars;
markedRope ← markedRope.Concat[unMarkedRope.Substr[lastMark+1, nextMark-lastMark-1]];
IF nextMark = endChar + 1 THEN RETURN;
markedRope ← markedRope.Concat["@"]; -- the marker character
lastMark ← nextMark;
charMarkList ← charMarkList.rest
ENDLOOP
};
ExtractCharMarks: PUBLIC PROC [
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo, soundInterval: TiogaVoicePrivate.SoundInterval] = {
return as selection.charMarkList a copy [n.b.] of the section of the character mark list in viewerInfo falling in to the region of selection.ropeInterval
currLastInList: LIST OF INT;
soughtStart: INT ← soundInterval.ropeInterval.start/TiogaVoicePrivate.soundRopeCharLength;
soughtEnd: INT ← (soundInterval.ropeInterval.start + soundInterval.ropeInterval.length)/TiogaVoicePrivate.soundRopeCharLength;
soundInterval.charMarkList ← NIL; -- should be already so, but . . .
FOR l: LIST OF INT ← viewerInfo.charMarkList, l.rest WHILE l # NIL AND l.first < soughtEnd DO
IF l.first >= soughtStart THEN
{ IF soundInterval.charMarkList = NIL
THEN
{ soundInterval.charMarkList ← CONS [l.first - soughtStart, NIL];
currLastInList ← soundInterval.charMarkList;
}
ELSE
{ currLastInList.rest ← CONS [l.first - soughtStart, NIL];
currLastInList ← currLastInList.rest
}
}
ENDLOOP
};
EditCharMarks: PUBLIC PROC [
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo, unchangedHead, deleteChars, insertChars: INT, soundInterval: TiogaVoicePrivate.SoundInterval] = {
this gets called when an edit is made to the contents of the viewer: it keeps the charMarkList in step with the edit
it is not a very efficient implementation - better ones are an exercise for the reader
atHead: BOOLEANTRUE;
l: LIST OF INT;
WHILE atHead AND viewerInfo.charMarkList # NIL DO
SELECT viewerInfo.charMarkList.first FROM
>= unchangedHead+deleteChars => {viewerInfo.charMarkList.first ← viewerInfo.charMarkList.first + insertChars - deleteChars; atHead ← FALSE};
>= unchangedHead => viewerInfo.charMarkList ← viewerInfo.charMarkList.rest;
ENDCASE => atHead ← FALSE;
ENDLOOP;
IF viewerInfo.charMarkList # NIL THEN
{ l ← viewerInfo.charMarkList;
WHILE l # NIL AND l.rest # NIL DO --the dual WHILE condition is because we can delete the next entry and it could be the last
SELECT l.rest.first FROM
>= unchangedHead+deleteChars =>
{l.rest.first ← l.rest.first + insertChars - deleteChars;
l ← l.rest};
>= unchangedHead => l.rest ← l.rest.rest;
ENDCASE => l ← l.rest
ENDLOOP
};
IF soundInterval # NIL AND soundInterval.charMarkList # NIL
THEN -- now put the character marks from the soundInterval into the list at the appropriate point
{
beforeInsert, afterInsert: LIST OF INTNIL;
newSection, endNewSection: LIST OF INT;
IF viewerInfo.charMarkList # NIL THEN
{ IF viewerInfo.charMarkList.first >= unchangedHead
THEN afterInsert ← viewerInfo.charMarkList
ELSE
{ l ← viewerInfo.charMarkList;
WHILE l.rest # NIL AND l.rest.first < unchangedHead DO l ← l.rest ENDLOOP;
beforeInsert ← l; afterInsert ← l.rest
}
};
{ insertMarks: LIST OF INT ← soundInterval.charMarkList.rest;
newSection ← CONS [soundInterval.charMarkList.first + unchangedHead, NIL];
endNewSection ← newSection;
WHILE insertMarks # NIL DO
endNewSection.rest ← CONS [soundInterval.charMarkList.first + unchangedHead, NIL];
endNewSection ← endNewSection.rest;
insertMarks ← insertMarks.rest
ENDLOOP
};
endNewSection.rest ← afterInsert;
IF beforeInsert = NIL THEN viewerInfo.charMarkList ← newSection ELSE beforeInsert.rest ← newSection
}
};
Textual markers: these markers are really a part of the viewer contents. They are saved when the voice is saved and altering them makes the window status 'edited'
TextInput: PUBLIC PROC [viewer: ViewerClasses.Viewer, input: Rope.ROPE] = {
node: TextNode.Ref;
textEntry: TiogaVoicePrivate.TextMarkEntry;
AddArtwork: PROC [root: TiogaOpsDefs.Ref] = {
TextEdit.PutCharProp[node, textEntry.position, $Artwork, NARROW["VoiceMarker", Rope.ROPE]]; -- the NARROW prevents a REF TEXT being created
TextEdit.PutCharProp[node, textEntry.position, $VoiceMark, textEntry.text.Substr[0, textEntry.displayChars]];
};
selectionViewer: ViewerClasses.Viewer;
start, end, char: TiogaOpsDefs.Location;
insertPosition: INT;
caretBefore: BOOLEAN;
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo;
charsAlreadyDisplayed: INT ← 0;
redraw: BOOLEANFALSE;
[viewer: selectionViewer, start: start, end: end, caretBefore: caretBefore] ← TiogaOps.GetSelection[];
IF selectionViewer # viewer THEN ERROR;
viewerInfo ← NARROW[ViewerOps.FetchProp[viewer, $voiceViewerInfo], TiogaVoicePrivate.VoiceViewerInfo];
IF ~TiogaVoicePrivate.GetVoiceLock[viewerInfo] THEN RETURN;
char ← IF caretBefore THEN start ELSE end;
node ← TiogaButtons.TextNodeRef[char.node];
insertPosition ← char.where;
IF viewerInfo.textMarkList = NIL OR viewerInfo.textMarkList.first.position > insertPosition
THEN
{ textEntry ← NEW [TiogaVoicePrivate.TextMarkRec ← [insertPosition, input, 0, 0]];
viewerInfo.textMarkList ← CONS [textEntry, viewerInfo.textMarkList];
LimitText[textEntry, IF viewerInfo.textMarkList.rest = NIL THEN LAST[INT] ELSE viewerInfo.textMarkList.rest.first.position - insertPosition];
TiogaOps.CallWithLocks[AddArtwork];
redraw ← TRUE
}
ELSE
{ IF viewerInfo.textMarkList.first.position = insertPosition
THEN
{ textEntry ← viewerInfo.textMarkList.first;
charsAlreadyDisplayed ← textEntry.displayChars;
textEntry.text ← textEntry.text.Concat[input];
LimitText[textEntry, IF viewerInfo.textMarkList.rest = NIL THEN LAST[INT] ELSE viewerInfo.textMarkList.rest.first.position - insertPosition];
IF textEntry.displayChars # charsAlreadyDisplayed
THEN {TiogaOps.CallWithLocks[AddArtwork]; redraw ← TRUE}
}
ELSE
{ l: LIST OF TiogaVoicePrivate.TextMarkEntry ← viewerInfo.textMarkList;
WHILE l.rest # NIL AND l.rest.first.position < insertPosition DO l ← l.rest ENDLOOP;
IF l.rest = NIL OR l.rest.first.position > insertPosition
THEN -- insert a new entry: previous entry may need trimming
{ oldWidth: INT ← l.first.width;
textEntry ← l.first;
LimitText[textEntry, insertPosition - textEntry.position];
IF textEntry.width # oldWidth THEN {TiogaOps.CallWithLocks[AddArtwork]; redraw ← TRUE};
textEntry ← NEW [TiogaVoicePrivate.TextMarkRec ← [insertPosition, input, 0, 0]];
l.rest ← CONS [textEntry, l.rest]
}
ELSE -- appending text to an entry already there
{ textEntry ← l.rest.first;
textEntry.text ← textEntry.text.Concat[input];
charsAlreadyDisplayed ← textEntry.displayChars
};
l ← l.rest; -- point at the new/modified entry
LimitText[textEntry, IF l.rest = NIL THEN LAST[INT] ELSE l.rest.first.position - insertPosition];
IF textEntry.displayChars # charsAlreadyDisplayed
THEN {TiogaOps.CallWithLocks[AddArtwork]; redraw ← TRUE}
}
};
**** a Plass-bug: shouldn't be necessary and he says he'll have a look at it
IF redraw THEN ViewerOps.PaintViewer[viewer: viewer, hint: client, clearClient: TRUE, whatChanged: NIL];
TiogaVoicePrivate.MakeVoiceEdited[viewer];
viewerInfo.editInProgress ← FALSE
};
LimitText: PROC [entry: TiogaVoicePrivate.TextMarkEntry, maxLength: INT] = {
entry potentially contains the supplied entry.text: this may only extend over maxLength voice characters, so it may not be possible to display all of it. Set entry.displayChars appropriately and set entry.width to say how much space is taken up by the text actually on display
maxEscapement: REALREAL[maxLength]*TiogaVoicePrivate.voiceCharWidth;
textLength: INT ← entry.text.Length[];
currPos: INT ← 0;
currEscapement: REAL ← 0.0;
WHILE currPos < textLength DO
newEscapement: REAL ← currEscapement + ImagerFont.Escapement[voiceMarkerFont, [TiogaVoicePrivate.voiceCharSet, entry.text.Fetch[currPos]-'\000]].x;
IF newEscapement > maxEscapement THEN EXIT;
currPos ← currPos + 1;
currEscapement ← newEscapement
ENDLOOP;
text limiting is currently accomplished by preserving all the text but only displaying that part which can be displayed: this means that when text obscuring other text is deleted the obscured text reappears for example. It could be arranged that the obscured text was actually eradicated: this would be done by inserting the following line and deleting the displayChars field of the TextMarkEntry and all the code that accesses it
IF currPos # textLength THEN entry.text ← entry.text.Substr[0, currPos];
entry.width ← Real.Fix[(currEscapement+TiogaVoicePrivate.voiceCharWidth-1.0)/ TiogaVoicePrivate.voiceCharWidth];
entry.displayChars ← currPos;
};
Back: PROC [viewer: ViewerClasses.Viewer, findNewLen: BackProc] = {
if there is a textual marker at the selection, do the work to remove its last character or its last word
node: TextNode.Ref;
textEntry: TiogaVoicePrivate.TextMarkEntry;
AddArtwork: PROC [root: TiogaOpsDefs.Ref] = {
TextEdit.PutCharProp[node, textEntry.position, $Artwork, IF textEntry.text = NIL THEN NIL ELSE NARROW["VoiceMarker", Rope.ROPE]]; -- the NARROW prevents a REF TEXT being created
TextEdit.PutCharProp[node, textEntry.position, $VoiceMark, IF textEntry.text = NIL THEN NIL ELSE textEntry.text.Substr[0, textEntry.displayChars]];
};
selectionViewer: ViewerClasses.Viewer;
start, end, char: TiogaOpsDefs.Location;
deletePosition, charsToNextPosition: INT;
prevptr: LIST OF TiogaVoicePrivate.TextMarkEntry ← NIL;
caretBefore: BOOLEAN;
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo;
[viewer: selectionViewer, start: start, end: end, caretBefore: caretBefore] ← TiogaOps.GetSelection[];
IF selectionViewer # viewer THEN ERROR;
viewerInfo ← NARROW[ViewerOps.FetchProp[viewer, $voiceViewerInfo], TiogaVoicePrivate.VoiceViewerInfo];
IF ~TiogaVoicePrivate.GetVoiceLock[viewerInfo] THEN RETURN;
char ← IF caretBefore THEN start ELSE end;
node ← TiogaButtons.TextNodeRef[char.node];
deletePosition ← char.where;
textEntry ← NIL;
FOR l: LIST OF TiogaVoicePrivate.TextMarkEntry ← viewerInfo.textMarkList, l.rest WHILE l # NIL DO
IF l.first.position >= deletePosition THEN
{ IF l.first.position = deletePosition THEN
{ textEntry ← l.first;
charsToNextPosition ← IF l.rest = NIL THEN LAST[INT] ELSE l.rest.first.position - deletePosition
};
EXIT
};
prevptr ← l;
ENDLOOP;
IF textEntry = NIL
THEN MessageWindow.Append["No textual annotation at point of selection", TRUE]
ELSE {
charsOnDisplay: INT ← textEntry.displayChars;
len: INT ← findNewLen[textEntry];
textEntry.text ← IF len<=0 THEN NIL ELSE textEntry.text.Substr[0, len];
DO
LimitText[textEntry, charsToNextPosition];
IF charsOnDisplay # textEntry.displayChars THEN {
TiogaOps.CallWithLocks[AddArtwork];
**** a Plass-bug: shouldn't be necessary and he says he'll have a look at it
ViewerOps.PaintViewer[viewer: viewer, hint: client, clearClient: TRUE, whatChanged: NIL]
};
IF textEntry.text=NIL THEN -- remove this marker from textMarkList
IF prevptr=NIL THEN
viewerInfo.textMarkList ← viewerInfo.textMarkList.rest
ELSE { -- also need to repaint previous text marker
prevptr.rest ← prevptr.rest.rest;
IF charsToNextPosition # LAST[INT] THEN
charsToNextPosition ← charsToNextPosition + textEntry.position - prevptr.first.position;
textEntry ← prevptr.first;
LOOP;
};
EXIT;
ENDLOOP;
TiogaVoicePrivate.MakeVoiceEdited[selectionViewer];
};
viewerInfo.editInProgress ← FALSE
};
BackProc: TYPE = PROC [textEntry: TiogaVoicePrivate.TextMarkEntry] RETURNS [len: INT];
BackSpaceProc: BackProc ~ {
len ← textEntry.text.Length[] - 1;
};
BackWordProc: BackProc ~ {
len ← textEntry.text.Length[];
WHILE len>0 AND NOT RopeEdit.AlphaNumericChar[textEntry.text.Fetch[len-1]] DO
len ← len-1;
ENDLOOP;
WHILE len>0 AND RopeEdit.AlphaNumericChar[textEntry.text.Fetch[len-1]] DO
len ← len-1;
ENDLOOP;
};
BackSpace: PUBLIC PROC [viewer: ViewerClasses.Viewer] = {
if there is a textual marker at the selection then remove its last character
Back[viewer, BackSpaceProc];
};
BackWord: PUBLIC PROC [viewer: ViewerClasses.Viewer] = {
if there is a textual marker at the selection then remove its last word
Back[viewer, BackWordProc];
};
RemoveTextMarkers: PUBLIC PROC [viewer: ViewerClasses.Viewer] = {
if there are textual markers within the selection then remove them completely
node: TextNode.Ref;
textEntry: TiogaVoicePrivate.TextMarkEntry;
AddArtwork: PROC [root: TiogaOpsDefs.Ref] = {
TextEdit.PutCharProp[node, textEntry.position, $Artwork, IF textEntry.text = NIL THEN NIL ELSE NARROW["VoiceMarker", Rope.ROPE]]; -- the NARROW prevents a REF TEXT being created
TextEdit.PutCharProp[node, textEntry.position, $VoiceMark, IF textEntry.text = NIL THEN NIL ELSE textEntry.text.Substr[0, textEntry.displayChars]];
};
selectionViewer: ViewerClasses.Viewer;
start, end: TiogaOpsDefs.Location;
textRemoved: BOOLEANFALSE;
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo;
[viewer: selectionViewer, start: start, end: end] ← TiogaOps.GetSelection[];
IF selectionViewer # viewer THEN ERROR;
IF start.node # end.node THEN ERROR;
viewerInfo ← NARROW[ViewerOps.FetchProp[viewer, $voiceViewerInfo], TiogaVoicePrivate.VoiceViewerInfo];
node ← TiogaButtons.TextNodeRef[start.node];
IF ~TiogaVoicePrivate.GetVoiceLock[viewerInfo] THEN RETURN;
IF viewerInfo.textMarkList = NIL THEN
{ viewerInfo.editInProgress ← FALSE;
RETURN
};
IF viewerInfo.textMarkList.first.position >= start.where
THEN -- any text to remove is at the head of the list
WHILE viewerInfo.textMarkList # NIL AND viewerInfo.textMarkList.first.position <= end.where DO
textEntry ← viewerInfo.textMarkList.first;
textEntry.text ← NIL;
TiogaOps.CallWithLocks[AddArtwork];
textRemoved ← TRUE;
viewerInfo.textMarkList ← viewerInfo.textMarkList.rest
ENDLOOP
ELSE
{ l: LIST OF TiogaVoicePrivate.TextMarkEntry ← viewerInfo.textMarkList;
WHILE l.rest # NIL AND l.rest.first.position < start.where DO l ← l.rest ENDLOOP;
WHILE l.rest # NIL AND l.rest.first.position <= end.where DO
textEntry ← l.rest.first;
textEntry.text ← NIL;
TiogaOps.CallWithLocks[AddArtwork];
textRemoved ← TRUE;
l.rest ← l.rest.rest
ENDLOOP;
IF textRemoved THEN
{ currChars: INT;
textEntry ← l.first;
This is the last text BEFORE the first deleted text. We are guaranteed that this text exists because of the special case made above for the head of the textMarkList.
currChars ← textEntry.displayChars;
LimitText[textEntry, IF l.rest = NIL THEN LAST[INT] ELSE l.rest.first.position - textEntry.position];
IF currChars # textEntry.displayChars THEN TiogaOps.CallWithLocks[AddArtwork]
}
};
IF textRemoved THEN
{ TiogaVoicePrivate.MakeVoiceEdited[selectionViewer];
**** a Plass-bug: shouldn't be necessary and he says he'll have a look at it
ViewerOps.PaintViewer[viewer: viewer, hint: client, clearClient: TRUE, whatChanged: NIL]
};
viewerInfo.editInProgress ← FALSE
};
RedrawTextMarkers: PUBLIC PROC [
viewer: ViewerClasses.Viewer, voiceCharNode: TiogaOpsDefs.Ref] = {
called by voicePlayBack's redraw procedure [under a voice lock] to place all the textual markers back in a voice viewer
AddArtwork: PROC [root: TiogaOpsDefs.Ref] = {
textEntry: TiogaVoicePrivate.TextMarkEntry ← l.first;
TextEdit.PutCharProp[node, textEntry.position, $Artwork, NARROW["VoiceMarker", Rope.ROPE]]; -- the NARROW prevents a REF TEXT being created
TextEdit.PutCharProp[node, textEntry.position, $VoiceMark, textEntry.text.Substr[0, textEntry.displayChars]];
};
node: TextNode.Ref ← TiogaButtons.TextNodeRef[voiceCharNode];
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo ← NARROW[ViewerOps.FetchProp[viewer, $voiceViewerInfo], TiogaVoicePrivate.VoiceViewerInfo];
l: LIST OF TiogaVoicePrivate.TextMarkEntry;
FOR l ← viewerInfo.textMarkList, l.rest WHILE l # NIL DO TiogaOps.CallWithLocks[AddArtwork, TiogaOps.ViewerDoc[viewer]] ENDLOOP
};
ExtractTextMarks: PUBLIC PROC [
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo, soundInterval: TiogaVoicePrivate.SoundInterval] = {
return as selection.textMarkList a copy [n.b.] of the section of the textual mark list in viewerInfo falling in to the region of selection.ropeInterval
currLastInList: LIST OF TiogaVoicePrivate.TextMarkEntry;
soughtStart: INT ← soundInterval.ropeInterval.start/TiogaVoicePrivate.soundRopeCharLength;
soughtEnd: INT ← (soundInterval.ropeInterval.start + soundInterval.ropeInterval.length)/TiogaVoicePrivate.soundRopeCharLength;
soundInterval.textMarkList ← NIL; -- should be already so, but . . .
FOR l: LIST OF TiogaVoicePrivate.TextMarkEntry ← viewerInfo.textMarkList, l.rest WHILE l # NIL AND l.first.position < soughtEnd DO
IF l.first.position >= soughtStart THEN
{ newEntry: TiogaVoicePrivate.TextMarkEntry ← NEW [TiogaVoicePrivate.TextMarkRec ← l.first^];
newEntry.position ← newEntry.position - soughtStart;
IF soundInterval.textMarkList = NIL
THEN
{ soundInterval.textMarkList ← CONS [newEntry, NIL];
currLastInList ← soundInterval.textMarkList;
}
ELSE
{ currLastInList.rest ← CONS [newEntry, NIL];
currLastInList ← currLastInList.rest
}
}
ENDLOOP
};
EditTextMarks: PUBLIC PROC [
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo, unchangedHead, deleteChars, insertChars: INT, soundInterval: TiogaVoicePrivate.SoundInterval] = {
this gets called when an edit is made to the contents of the viewer: it keeps the textMarkList in step with the edit
it is not a very efficient implementation - better ones are an exercise for the reader
atHead: BOOLEANTRUE;
l: LIST OF TiogaVoicePrivate.TextMarkEntry;
first alter the old list to remove the text in the deleted area and move text after that area
WHILE atHead AND viewerInfo.textMarkList # NIL DO
SELECT viewerInfo.textMarkList.first.position FROM
>= unchangedHead+deleteChars =>
{viewerInfo.textMarkList.first.position ← viewerInfo.textMarkList.first.position + insertChars - deleteChars; atHead ← FALSE};
>= unchangedHead => viewerInfo.textMarkList ← viewerInfo.textMarkList.rest;
ENDCASE => atHead ← FALSE;
ENDLOOP;
IF viewerInfo.textMarkList # NIL THEN
{ l ← viewerInfo.textMarkList;
WHILE l # NIL AND l.rest # NIL DO --the dual WHILE condition is because we can delete the next entry and it could be the last
SELECT l.rest.first.position FROM
>= unchangedHead+deleteChars =>
{l.rest.first.position ← l.rest.first.position + insertChars - deleteChars;
l ← l.rest};
>= unchangedHead => l.rest ← l.rest.rest;
ENDCASE => l ← l.rest
ENDLOOP
};
IF soundInterval # NIL AND soundInterval.textMarkList # NIL
THEN -- now put the textual marks from the soundInterval into the list at the appropriate point
{
beforeInsert, afterInsert: LIST OF TiogaVoicePrivate.TextMarkEntry ← NIL;
newSection, endNewSection: LIST OF TiogaVoicePrivate.TextMarkEntry;
IF viewerInfo.textMarkList # NIL THEN
{ IF viewerInfo.textMarkList.first.position >= unchangedHead
THEN afterInsert ← viewerInfo.textMarkList
ELSE
{ l ← viewerInfo.textMarkList;
WHILE l.rest # NIL AND l.rest.first.position < unchangedHead DO l ← l.rest ENDLOOP;
beforeInsert ← l; afterInsert ← l.rest
}
};
{ insertMarks: LIST OF TiogaVoicePrivate.TextMarkEntry ← soundInterval.textMarkList.rest;
newSection ← CONS [NEW [TiogaVoicePrivate.TextMarkRec ← soundInterval.textMarkList.first^], NIL];
newSection.first.position ← newSection.first.position + unchangedHead;
endNewSection ← newSection;
WHILE insertMarks # NIL DO
endNewSection.rest ← CONS [NEW [TiogaVoicePrivate.TextMarkRec ← soundInterval.textMarkList.first^], NIL];
endNewSection ← endNewSection.rest;
insertMarks ← insertMarks.rest;
endNewSection.first.position ← endNewSection.first.position + unchangedHead
ENDLOOP
};
endNewSection.rest ← afterInsert;
LimitText[endNewSection.first, IF endNewSection.rest = NIL THEN LAST[INT] ELSE endNewSection.rest.first.position - endNewSection.first.position];
IF beforeInsert = NIL
THEN viewerInfo.textMarkList ← newSection
ELSE
{ beforeInsert.rest ← newSection;
LimitText[beforeInsert.first, newSection.first.position - beforeInsert.first.position]
}
}
ELSE -- no new entries to be inserted, but we must LimitText on the entry previous to the cut
{IF viewerInfo.textMarkList # NIL AND viewerInfo.textMarkList.first.position < unchangedHead THEN
{ beforeCut: LIST OF TiogaVoicePrivate.TextMarkEntry ← viewerInfo.textMarkList;
WHILE beforeCut.rest # NIL AND beforeCut.rest.first.position < unchangedHead DO beforeCut ← beforeCut.rest ENDLOOP;
LimitText[beforeCut.first, IF beforeCut.rest = NIL THEN LAST[INT] ELSE beforeCut.rest.first.position - beforeCut.first.position]
}
}
};
RopeFromTextList: PUBLIC PROC [
l: LIST OF TiogaVoicePrivate.TextMarkEntry] RETURNS [r: Rope.ROPENIL] = {
convert the list of text markers in a voice viewer into a rope suitable for saving in a textual document at the position of a talks bubble
WHILE l # NIL DO
textEntry: Rope.ROPE ← l.first.text;
positionInSamples: INT ← l.first.position*TiogaVoicePrivate.soundRopeCharLength;
r ← r.Cat[Convert.RopeFromInt[positionInSamples], ":", Convert.RopeFromInt[textEntry.Length], ":"];
r ← r.Concat[textEntry];
l ← l.rest
ENDLOOP
};
TextListFromRope: PUBLIC PROC [r: Rope.ROPE]
RETURNS [l: LIST OF TiogaVoicePrivate.TextMarkEntry ← NIL] = {
and go the other way
endOfList: LIST OF TiogaVoicePrivate.TextMarkEntry;
WHILE r.Length > 0 DO
nextColon: INT ← r.Find[":"];
newEntry: TiogaVoicePrivate.TextMarkEntry ← NEW [TiogaVoicePrivate.TextMarkRec ← [Convert.IntFromRope[r.Substr[0, nextColon]]/TiogaVoicePrivate.soundRopeCharLength, NIL, 0, 0]];
textLength: INT;
r ← r.Substr[nextColon+1];
nextColon ← r.Find[":"];
textLength ← Convert.IntFromRope[r.Substr[0, nextColon]];
r ← r.Substr[nextColon+1];
newEntry.text ← r.Substr[0, textLength];
r ← r.Substr[textLength];
IF l = NIL
THEN
{ l ← CONS [newEntry, NIL];
endOfList ← l
}
ELSE
{ endOfList.rest ← CONS [newEntry, NIL];
endOfList ← endOfList.rest
}
ENDLOOP;
FOR list: LIST OF TiogaVoicePrivate.TextMarkEntry ← l, list.rest WHILE list # NIL DO
LimitText[list.first, IF list.rest = NIL THEN LAST[INT] ELSE list.rest.first.position - list.first.position]
ENDLOOP
};
voiceMarkerFont: PUBLIC ImagerFont.Font ← ImagerFont.Find["xerox/tiogafonts/tioga10"];
TextInVoice
it's all getting so recursive !!!! - routines which draw the artwork around voice viewers; that artwork is actually a textual display
although the extents and positions of text in artworks are given in terms of constants from TiogaVoicePrivate, note that the line spacing is set up independently by VoiceProfile.Style
VoiceMarkerDataRep: TYPE ~ RECORD [
letter: CHAR,
label: Rope.ROPE,
charHeight: REAL,
charWidth: REAL
];
VoiceMarkerPaint: PROC [
self: TEditFormat.CharacterArtwork, context: Imager.Context] ~ {
data: REF VoiceMarkerDataRep ~ NARROW[self.data];
DrawArrow: ImagerPath.PathProc = {
moveTo[[0.0, 2.0*data.charHeight]];
lineTo[[0.0, data.charHeight]];
lineTo[[3.0, 4.0*data.charHeight/3.0]];
lineTo[[-2.0, 4.0*data.charHeight/3.0]];
lineTo[[0.0, data.charHeight]]
};
Imager.Move[context];
Imager.ShowChar[context, data.letter];
Imager.SetColor[context, Imager.black];
Imager.SetStrokeWidth[context, 1.0];
Imager.SetStrokeJoint[context, round];
Imager.MaskStroke[context, DrawArrow, TRUE];
Imager.SetXY[context, [2.0, 3.0*data.charHeight/2.0]];
Imager.SetFont[context, voiceMarkerFont];
Imager.ShowRope[context, data.label];
};
VoiceMarkerFormat: PROC [
class: TEditFormat.CharacterArtworkClass, loc: TextNode.Location, style: NodeStyle.Ref, kind: NodeStyleOps.OfStyle] RETURNS [TEditFormat.CharacterArtwork] ~ {
voiceCharSet: TextEdit.CharSet ← TextEdit.FetchChar[loc.node, loc.where].charSet;
letter: CHAR ← TextEdit.FetchChar[loc.node, loc.where].char;
label: Rope.ROPENARROW[TextEdit.GetCharProp[loc.node, loc.where, $VoiceMark], Rope.ROPE];
escapement: Vector2.VEC ← ImagerFont.Escapement[TEditFormat.GetFont[style], [set: TiogaVoicePrivate.voiceCharSet, code: letter-'\000]];
charWidth: REAL ← escapement.x;
data: REF VoiceMarkerDataRep ~ NEW[VoiceMarkerDataRep ← [
letter: letter,
label: label,
charHeight: TiogaVoicePrivate.voiceCharHeight,
charWidth: charWidth
]];
extents: ImagerFont.Extents ← [leftExtent: 0.0, rightExtent: 20.0, ascent: 5.0*data.charHeight/2.0, descent: TiogaVoicePrivate.voiceCharDescent];
RETURN [NEW[TEditFormat.CharacterArtworkRep ← [paint: VoiceMarkerPaint, extents: extents, escapement: escapement, data: data]]]
};
voiceMarkerClass: TEditFormat.CharacterArtworkClass ~
NEW[TEditFormat.CharacterArtworkClassRep ← [
name: $VoiceMarker,
format: VoiceMarkerFormat,
data: NIL
]];
VoiceAging
Adds colors to and ages colors in voice viewers: the dictation ops buttons in voice viewers may use the ages of sections of a viewer to determine where to delete/playback/resume recording
in each voice viewer is a list of ages: these are pairs of INTs and give the starting position for the age and its value. The age lasts until the next age entry's position or the end if last in the list.
in each voice viewer is a list of ages: these are pairs of INTs and give the starting position for the age and its value. The age lasts until the next age entry's position or the end if last in the list.
when age lists are edited, adjacent entries with the same age values can clearly be merged. The valid ages are [oldest..youngest] as given below. youngest-1 is a transitory value used before a call to AgeAllViewers when voice is inserted. oldest+1 is used to mean "this viewer didn't age at all in the last call to AgeAllViewers: oldest+1 may only appear as a single element age list with a position of 0
the following values may be changed to anything you care for, so long as oldest>youngest
oldest: PUBLIC INT ← 5;
youngest: PUBLIC INT ← 1;
and provided you manually supply the correct number of colors required for this array -- see end of this module
ageColors: ARRAY [1..6] OF Rope.ROPE;
ReColorViewer: PUBLIC PROC [
viewer: ViewerClasses.Viewer, voiceViewerInfo: TiogaVoicePrivate.VoiceViewerInfo ← NIL, repaint: BOOLEANFALSE] = {
a viewer has been edited and the age list for it has been updated appropriately: redo the color looks so that the age marks are once more in the correct places
node: TextNode.Ref ← TiogaButtons.TextNodeRef[TiogaOps.FirstChild[TiogaOps.ViewerDoc[viewer]]];
nodeLength: INT ← TiogaOps.GetRope[TiogaOps.FirstChild[TiogaOps.ViewerDoc[viewer]]].Length;
IF voiceViewerInfo = NIL THEN voiceViewerInfo ← NARROW[ViewerOps.FetchProp[viewer, $voiceViewerInfo], TiogaVoicePrivate.VoiceViewerInfo];
voiceViewerInfo.color ← viewer.column = color;
IF voiceViewerInfo.ageList = NIL OR ~voiceViewerInfo.color THEN RETURN;
TextEdit.PutCharProp[node, 0, $Postfix, NIL, nodeLength]; -- may not be necessary
FOR l: LIST OF TiogaVoicePrivate.IntPair ← voiceViewerInfo.ageList, l.rest WHILE l # NIL DO
TextEdit.PutCharProp[node, l.first.position, $Postfix, ageColors[l.first.age], IF l.rest # NIL THEN MIN[l.rest.first.position, nodeLength]-l.first.position ELSE nodeLength-l.first.position]
ENDLOOP;
TiogaVoicePrivate.SetVoiceViewerEditStatus[viewer];
**** I still haven't got right when to repaint and when not
ViewerOps.PaintViewer[viewer: viewer, hint: client, clearClient: TRUE, whatChanged: NIL]
};
AgeAllViewers: PUBLIC PROC [youngestViewer: ViewerClasses.Viewer] = {
an editing event has occured which ages all the voice viewers
FOR vList: TiogaVoicePrivate.VoiceViewerInfoList ← TiogaVoicePrivate.GetVoiceViewerInfoList[], vList.rest WHILE vList # NIL DO
currInfo: TiogaVoicePrivate.VoiceViewerInfo ← vList.first;
l: LIST OF TiogaVoicePrivate.IntPair ← currInfo.ageList;
IF l # NIL THEN
IF ~(l.rest = NIL AND l.first.age = oldest+1) THEN
{ IF (l.rest = NIL AND l.first.age = oldest)
THEN
{ ReColorViewer[currInfo.viewer, currInfo, currInfo.viewer # youngestViewer];
l.first.age ← oldest+1 -- special treatment because this list may be the result of having cut out some newer voice in the most recent edit, in which case the colors need redrawing
}
ELSE
{ --in all other cases the ages are only allowed to be incremented to oldest
WHILE l # NIL DO
l.first.age ← MIN[l.first.age+1, oldest];
l ← l.rest
ENDLOOP;
l ← currInfo.ageList;
WHILE l # NIL AND l.rest # NIL DO --the dual WHILE condition is because we can delete the next entry and it could be the last
IF l.first.age = l.rest.first.age THEN l.rest ← l.rest.rest ELSE l ← l.rest
ENDLOOP;
ReColorViewer[currInfo.viewer, currInfo]
}
}
ENDLOOP
};
EditAges: PUBLIC PROC [
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo, unchangedHead, deleteChars, insertChars: INT] = {
this gets called when an edit is made to the contents of the viewer: it keeps the ageList in step with the edit. If insertChars # 0 then the new position is made of age youngest-1 so that it will become the youngest when the next call to AgeAllViewers is made
ageAtEndOfCut: INT;
atHead: BOOLEANTRUE;
l: LIST OF TiogaVoicePrivate.IntPair ← viewerInfo.ageList;
IF l = NIL THEN ERROR; 
WHILE l.rest # NIL AND l.rest.first.position < unchangedHead + deleteChars DO l ← l.rest ENDLOOP;
ageAtEndOfCut ← l.first.age;
WHILE atHead AND viewerInfo.ageList # NIL DO
SELECT viewerInfo.ageList.first.position FROM
>= unchangedHead+deleteChars => {viewerInfo.ageList.first.position ← viewerInfo.ageList.first.position + insertChars - deleteChars; atHead ← FALSE};
>= unchangedHead => viewerInfo.ageList ← viewerInfo.ageList.rest;
ENDCASE => atHead ← FALSE;
ENDLOOP;
IF viewerInfo.ageList # NIL THEN
{ l ← viewerInfo.ageList;
WHILE l # NIL AND l.rest # NIL DO --the dual WHILE condition is because we can delete the next entry and it could be the last
SELECT l.rest.first.position FROM
>= unchangedHead+deleteChars =>
{l.rest.first.position ← l.rest.first.position + insertChars - deleteChars;
l ← l.rest};
>= unchangedHead => l.rest ← l.rest.rest;
ENDCASE => l ← l.rest
ENDLOOP
};
IF viewerInfo.ageList = NIL OR viewerInfo.ageList.first.position >= unchangedHead + insertChars
THEN
{ IF viewerInfo.ageList = NIL OR viewerInfo.ageList.first.position # unchangedHead + insertChars THEN viewerInfo.ageList ← CONS [[unchangedHead + insertChars, ageAtEndOfCut], viewerInfo.ageList];
IF insertChars # 0 THEN viewerInfo.ageList ← CONS [[unchangedHead, youngest-1], viewerInfo.ageList]
}
ELSE
{ l ← viewerInfo.ageList;
WHILE l.rest # NIL AND l.rest.first.position < unchangedHead + insertChars DO l ← l.rest ENDLOOP;
IF l.rest = NIL OR l.rest.first.position # unchangedHead + insertChars THEN l.rest ← CONS [[unchangedHead + insertChars, ageAtEndOfCut], l.rest];
IF insertChars # 0 THEN l.rest ← CONS [[unchangedHead, youngest-1], l.rest]
};
FOR l ← viewerInfo.ageList, l.rest WHILE l # NIL DO IF l.first.age > oldest THEN l.first.age ← oldest ENDLOOP;
l ← viewerInfo.ageList;
WHILE l # NIL AND l.rest # NIL DO --the dual WHILE condition is because we can delete the next entry and it could be the last
IF l.first.age = l.rest.first.age THEN l.rest ← l.rest.rest ELSE l ← l.rest
ENDLOOP
};
DictationOps
special ops provided to support the "stop, listen, [erase,] resume" model of a dictation machine, also to compress silence periods after such a dictation session
all of the dictation operations stand apart from the normal rules for playback/recording, which are that one must be stopped manually before the other can be requested. A playback or record request in this module implicitly cancels any already in progress.
the dictation machine works differently for color and monochrome viewers: the end point for playback/resume and delete to-/record from is the end of the viewer for monochrome and the end of the youngest sound for the color
DictationOps: PUBLIC Menus.MenuProc = {
the button to toggle the dictation menu on and off the screen
TiogaVoicePrivate.ChangeMenu[NARROW[parent], dictationMenu] };
ToggleDictationMenu: PUBLIC PROC [viewer: ViewerClasses.Viewer] = {
manual version of same thing
TiogaVoicePrivate.ChangeMenu[viewer, dictationMenu] };
FindEnd: PROC [viewerInfo: TiogaVoicePrivate.VoiceViewerInfo] RETURNS [sample: INT] = {
procedure to interpret 'end' for monochrome/color viewers
IF viewerInfo.ropeInterval.start # 0 THEN ERROR;
there should be a 'real rope' in this viewer!!
IF ~viewerInfo.color THEN RETURN [viewerInfo.ropeInterval.length]
ELSE
{ minAge: INT ← oldest+2;
endOfAge: INTLAST[INT];
FOR l: LIST OF TiogaVoicePrivate.IntPair ← viewerInfo.ageList, l.rest WHILE l # NIL DO
IF l.first.age <= minAge THEN
{ endOfAge ← IF l.rest=NIL THEN LAST[INT] ELSE l.rest.first.position;
minAge ← l.first.age
}
ENDLOOP;
RETURN [IF endOfAge = LAST[INT] THEN viewerInfo.ropeInterval.length ELSE endOfAge*TiogaVoicePrivate.soundRopeCharLength]
}
};
StillInVoiceViewerList: PROC [viewerInfo: TiogaVoicePrivate.VoiceViewerInfo] RETURNS [BOOLEAN] = {
if the supplied viewerInfo does not represent an existing voice viewer (having been deleted due to being empty) display an error message and return FALSE
FOR vList: TiogaVoicePrivate.VoiceViewerInfoList ← TiogaVoicePrivate.GetVoiceViewerInfoList[], vList.rest WHILE vList # NIL DO
IF vList.first = viewerInfo THEN RETURN[TRUE];
ENDLOOP;
MessageWindow.Append["Voice viewer has been deleted (contents NIL): dictation operation therefore invalid", TRUE];
MessageWindow.Blink[];
RETURN[FALSE];
};
PlayFromSelection: Menus.MenuProc = {
viewer: ViewerClasses.Viewer;
start: TiogaOpsDefs.Location;
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo;
node: TiogaOpsDefs.Ref;
from, to: INT;
[viewer: viewer, start: start] ← TiogaOps.GetSelection[];
IF viewer = NIL
THEN
{ MessageWindow.Append["Make a selection first", TRUE];
MessageWindow.Blink[];
RETURN
};
viewerInfo ← NARROW[ViewerOps.FetchProp[viewer, $voiceViewerInfo], TiogaVoicePrivate.VoiceViewerInfo];
IF viewerInfo = NIL
THEN
{ MessageWindow.Append["Make a selection in a voice viewer first", TRUE];
MessageWindow.Blink[];
RETURN
};
VoiceRope.Stop[TiogaVoicePrivate.thrushHandle];
TiogaVoicePrivate.CancelPlayBack[];
TiogaVoicePrivate.StopRecording[];
IF ~StillInVoiceViewerList[viewerInfo] THEN RETURN;
**** need to take the voice lock before performing the following!
node ← TiogaOps.FirstChild[TiogaOps.ViewerDoc[viewer]];
from ← start.where;
to ← FindEnd[viewerInfo]/TiogaVoicePrivate.soundRopeCharLength;
IF to >= from
THEN TiogaVoicePrivate.PlaySlabSection[viewer, node, from, to]
ELSE
{ MessageWindow.Append["Make a selection before the end of the most recent edit", TRUE];
MessageWindow.Blink[]
};
};
ResumeFromSelection: Menus.MenuProc = {
viewer: ViewerClasses.Viewer;
start: TiogaOpsDefs.Location;
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo;
node: TiogaOpsDefs.Ref;
replaceRopeInterval: VoiceRope.VoiceRopeInterval;
startDelete, endDelete: INT;
[viewer: viewer, start: start] ← TiogaOps.GetSelection[];
IF viewer = NIL THEN
{ MessageWindow.Append["Make a selection first", TRUE];
MessageWindow.Blink[];
RETURN
};
viewerInfo ← NARROW[ViewerOps.FetchProp[viewer, $voiceViewerInfo], TiogaVoicePrivate.VoiceViewerInfo];
IF viewerInfo = NIL THEN
{ MessageWindow.Append["Make a selection in a voice viewer first", TRUE];
MessageWindow.Blink[];
RETURN
};
VoiceRope.Stop[TiogaVoicePrivate.thrushHandle];
TiogaVoicePrivate.CancelPlayBack[];
TiogaVoicePrivate.StopRecording[];
IF ~StillInVoiceViewerList[viewerInfo] THEN RETURN;
IF ~TiogaVoicePrivate.GetVoiceLock[viewerInfo] THEN RETURN;
node ← TiogaOps.FirstChild[TiogaOps.ViewerDoc[viewer]];
startDelete ← start.where*TiogaVoicePrivate.soundRopeCharLength;
endDelete ← FindEnd[viewerInfo];
IF startDelete>endDelete THEN
{ MessageWindow.Append["Make a selection before the end of the most recent edit", TRUE];
MessageWindow.Blink[];
viewerInfo.editInProgress ← FALSE;
RETURN
};
replaceRopeInterval ← [ropeID: viewerInfo.ropeInterval.ropeID, start: startDelete, length: endDelete - startDelete];
TiogaVoicePrivate.RecordInPlaceOfSelection[NEW[TiogaVoicePrivate.SelectionRec ← [viewer: viewer, voiceViewerInfo: viewerInfo, ropeInterval: replaceRopeInterval, displayNode: node]]]
};
ResumeFromEnd: Menus.MenuProc = {
viewer: ViewerClasses.Viewer ← NARROW[parent, ViewerClasses.Viewer];
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo ← NARROW[ViewerOps.FetchProp[viewer, $voiceViewerInfo], TiogaVoicePrivate.VoiceViewerInfo];
node: TiogaOpsDefs.Ref;
replaceRopeInterval: VoiceRope.VoiceRopeInterval;
VoiceRope.Stop[TiogaVoicePrivate.thrushHandle];
TiogaVoicePrivate.CancelPlayBack[];
TiogaVoicePrivate.StopRecording[];
IF ~StillInVoiceViewerList[viewerInfo] THEN RETURN;
IF ~TiogaVoicePrivate.GetVoiceLock[viewerInfo] THEN RETURN;
node ← TiogaOps.FirstChild[TiogaOps.ViewerDoc[viewer]];
replaceRopeInterval ← [ropeID: viewerInfo.ropeInterval.ropeID, start: FindEnd[viewerInfo], length: 0];
TiogaVoicePrivate.RecordInPlaceOfSelection[NEW[TiogaVoicePrivate.SelectionRec ← [viewer: viewer, voiceViewerInfo: viewerInfo, ropeInterval: replaceRopeInterval, displayNode: node]]]
};
routines which allow the lengths of silent portions within a rope to be adjusted
criticalSilenceLength: INT ← Jukebox.bytesPerChirp/2;
SetCriticalSilenceLength: Commander.CommandProc = {
argv: CommandTool.ArgumentVector ← CommandTool.Parse[cmd ! CommandTool.Failed => {msg ← errorMsg; GOTO Quit}];
IF argv.argc # 2 THEN {
msg ← "Usage: SetCriticalSilenceLength lengthInMilliseconds";
GOTO Quit
};
criticalSilenceLength ← Convert.IntFromRope[argv[1]]*8;
RETURN
EXITS
Quit => RETURN [$Failure, msg]
};
AdjustSilences: Menus.MenuProc = {
viewer: ViewerClasses.Viewer;
viewerInfo: TiogaVoicePrivate.VoiceViewerInfo;
selectionToRemove: TiogaVoicePrivate.Selection;
startOfSilence, lengthOfSilence: INT;
viewer ← NARROW [parent, ViewerClasses.Viewer];
viewerInfo ← NARROW[ViewerOps.FetchProp[viewer, $voiceViewerInfo], TiogaVoicePrivate.VoiceViewerInfo];
IF ~TiogaVoicePrivate.GetVoiceLock[viewerInfo] THEN
{
MessageWindow.Append["Unable to examine silences in viewer - editing operation already in progress", TRUE];
MessageWindow.Blink[];
RETURN
};
TiogaOps.SaveSelA[];
DO
[startsAt: startOfSilence, lasts: lengthOfSilence] ← TiogaVoicePrivate.LastSilenceInSoundList[soundList: viewerInfo.soundList, lengthGreaterThan: criticalSilenceLength];
IF lengthOfSilence = -1 THEN
{ viewerInfo.editInProgress ← FALSE;
TiogaOps.RestoreSelA[];
RETURN
};
selectionToRemove ← NEW[TiogaVoicePrivate.SelectionRec ← [viewer: viewer, voiceViewerInfo: viewerInfo, ropeInterval: [ropeID: viewerInfo.ropeInterval.ropeID, start: startOfSilence+criticalSilenceLength, length: lengthOfSilence-criticalSilenceLength], displayNode: TiogaOps.FirstChild[TiogaOps.ViewerDoc[viewer]]]];
[] ← TiogaVoicePrivate.ReplaceSelectionWithSavedInterval[selection: selectionToRemove, soundInterval: NIL, leaveSelected: FALSE];
not interested in any of the returned values from this routine - in particular the viewer will not have been deleted by this call since we have only deleted one portion of one silent interval
this action really ought not to age the voice viewers - this requires an extra parameter to ReplaceSelectionWithSavedInterval. See the implementation of that routine - the call to TiogaVoicePrivate.RedrawViewer can take a don't age option, which we currently don't exploit
TiogaVoicePrivate.MakeVoiceEdited[viewer];
ENDLOOP
};
dictationMenu: Menus.MenuEntry;
Initialization
TEditFormat.RegisterCharacterArtwork[voiceMarkerClass];
ageColors[1] ← "0.13 0.97 0.96 textColor";
ageColors[2] ← "0.06 0.94 1.00 textColor";
ageColors[3] ← "0.99 1.00 1.00 textColor";
ageColors[4] ← "0.99 1.00 0.65 textColor";
ageColors[5] ← ageColors[6] ← "0.97 1.00 0.28 textColor"; -- last two must be the same
these are HSV values: colors can be generated experimentally using the ColorTool program
Menus.InsertMenuEntry[TiogaVoicePrivate.voiceViewerMenu, MBQueue.CreateMenuEntry[TiogaVoicePrivate.voiceButtonQueue, "AdjustSilences", AdjustSilences], 1];
Menus.InsertMenuEntry[TiogaVoicePrivate.voiceViewerMenu, MBQueue.CreateMenuEntry[TiogaVoicePrivate.voiceButtonQueue, "ResumeFromEnd", ResumeFromEnd], 1];
Menus.InsertMenuEntry[TiogaVoicePrivate.voiceViewerMenu, MBQueue.CreateMenuEntry[TiogaVoicePrivate.voiceButtonQueue, "ResumeFromSelection", ResumeFromSelection], 1];
Menus.InsertMenuEntry[TiogaVoicePrivate.voiceViewerMenu, MBQueue.CreateMenuEntry[TiogaVoicePrivate.voiceButtonQueue, "PlayFromSelection", PlayFromSelection], 1];
dictationMenu ← Menus.GetLine[TiogaVoicePrivate.voiceViewerMenu, 1];
Menus.SetLine[TiogaVoicePrivate.voiceViewerMenu, 1, NIL];
Menus.ChangeNumberOfLines[TiogaVoicePrivate.voiceViewerMenu, 1];
Commander.Register["SetCriticalSilenceLength", SetCriticalSilenceLength, "SetCriticalSilenceLength lengthInMilliseconds - when the AdjustSilences button is bugged for any voice viewer, all silences of more than this length will be reduced to this length"];
}.
Polle Zellweger (PTZ) May 28, 1987 4:37:10 pm PDT
Red button `Mark' => mark the current playback spot; otherwise mark the selection as before.
changes to: AddCharMark, AddMarkAtPlaybackLocation (new), AddMarksAtSelection (new)
Polle Zellweger (PTZ) June 4, 1987 11:18:46 am PDT
Make BackSpace and BackWord have their normal Tioga functions for text markers, removing the text marker completely whenever its length goes to 0. [BackWord (^W) was being used to remove text markers completely rather than for its usual purpose.] The RemoveTextMarkers function is available to remove all text markers quickly from a voice selection (no current user interface access).
changes to: DIRECTORY, VoiceMarkersImpl, Back, AddArtwork (local of Back), BackProc, BackSpaceProc, BackWordProc, BackSpace, BackWord, RemoveTextMarkers
Polle Zellweger (PTZ) June 4, 1987 11:27:47 am PDT
Try going without ViewerOps.PaintViewer (maybe the Plass-bug is fixed now).
changes to: TextInput, Back, RemoveTextMarkers
Polle Zellweger (PTZ) June 7, 1987 7:40:05 pm PDT
Always call TiogaVoicePrivate.SetVoiceViewerEditStatus now that ViewerOps.PaintViewer has been removed. Sets the icon to dirty.
changes to: TextInput, Back, RemoveTextMarkers
Polle Zellweger (PTZ) June 17, 1987 3:28:06 pm PDT
Call TiogaVoicePrivate.MakeVoiceEdited to set the icon to dirty, etc. whenever voice viewer contents have been edited.
changes to: DIRECTORY, TextInput, Back, RemoveTextMarkers, AdjustSilences
Polle Zellweger (PTZ) July 10, 1987 5:48:48 pm PDT
Make voiceViewerInfoList into a real list; make private to VoiceViewersImpl.
changes to: DIRECTORY, AgeAllViewers
Polle Zellweger (PTZ) July 20, 1987 5:09:26 pm PDT
Change UI: yellow button Mark = add at playback loc; red, blue = add at selection; minor logic improvement.
changes to: AddCharMark, AddMarkAtPlayBackLocation
Polle Zellweger (PTZ) July 21, 1987 12:13:02 pm PDT
changes to: AddCharMark