Skip to content

Fix DPI 16 callback PlayString and PlayEvents #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LexiconCode wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix DPI 16 callback PlayString and PlayEvents #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 63 additions & 27 deletions NatlinkSource/DragonCode.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1728,6 +1728,15 @@ BOOL CDragonCode::natConnect( IServiceProvider * pIDgnSite, BOOL bUseThreads )
__uuidof(IDgnSREngineControl), (void**)&m_pIDgnSREngineControl );
RETURNIFERROR( rc, "ISRCentral::QueryInterface(IDgnSREngineControl)" );

// Detect Dragon version — DNS 16 has different COM calling conventions.
{
WORD wMajor = 0, wMinor = 0, wBuild = 0;
rc = m_pIDgnSREngineControl->GetVersion(&wMajor, &wMinor, &wBuild);
if (SUCCEEDED(rc)) {
m_dragonMajorVersion = wMajor;
}
}

// get the speech services interfaces

IDgnSpeechServicesPtr pSpchSvc;
Expand Down Expand Up @@ -2015,32 +2024,37 @@ BOOL CDragonCode::playString( const char * pszKeys, DWORD dwFlags )
DWORD dwClientCode = ++dwUnique;

DWORD dwNumUndo=0;


#ifdef UNICODE


rc = m_pIDgnSSvcOutputEventA->PlayString(
pszKeys, // string to send
dwFlags, // flags
0xFFFFFFFF, // delay (-1 for app specific delay)
dwClientCode, // to identify which WM_PLAYBACK is ours
&dwNumUndo );

int const inputCodePage = CP_UTF8;
int const outputCodePage = 1252;



if (m_dragonMajorVersion >= 16) {
// DNS 16 added a 6th parameter to PlayString that controls whether
// the PlaybackDone callback fires. Passing 0 = fire-and-forget
// (no callback), non-zero = notify via PlaybackDone.
// The callee does ret 28 (this + 6 params), so we must use raw
// vtable calls to avoid ESP corruption with the 5-param header.
void** vtable = *(void***)((IUnknown*)m_pIDgnSSvcOutputEvent);
void* pfnPlayString = vtable[4]; // slot 4 = PlayString
void* pThis = (void*)m_pIDgnSSvcOutputEvent;
DWORD* pNumUndo = &dwNumUndo;
HRESULT comRc;

__asm {
push 1 // [5] DWORD dwNotify — non-zero for PlaybackDone
push pNumUndo // [4] DWORD* pNumUndo
push dwClientCode // [3] DWORD dwClientCode
push 0xFFFFFFFF // [2] DWORD dwDelay (-1)
push dwFlags // [1] DWORD dwFlags
push pszKeys // [0] const char* pszKeys
push pThis // this
call pfnPlayString
mov comRc, eax
}

#else
rc = comRc;
} else {
// DNS 13/15: standard 5-param COM call
rc = m_pIDgnSSvcOutputEvent->PlayString(
pszKeys, // string to send
dwFlags, // flags
0xFFFFFFFF, // delay (-1 for app specific delay)
dwClientCode, // to identify which WM_PLAYBACK is ours
&dwNumUndo ); // not used (number of backspaces needed to undo)
#endif
pszKeys, dwFlags, 0xFFFFFFFF, dwClientCode, &dwNumUndo );
}


RETURNIFERROR( rc, "IDgnSSvcOutputEvent::PlayString" );
Expand Down Expand Up @@ -2586,10 +2600,32 @@ BOOL CDragonCode::playEvents( DWORD dwCount, HOOK_EVENTMSG * pEvents )
static DWORD dwUnique = 1;
DWORD dwClientCode = ++dwUnique;

rc = m_pIDgnSSvcOutputEvent->PlayEvents(
dwCount, pEvents,
0xFFFFFFFF, // delay (-1 for app specific delay)
dwClientCode ); // to identify which WM_PLAYBACK is ours
if (m_dragonMajorVersion >= 16) {
// DNS 16 added a 5th parameter to PlayEvents that controls whether
// the PlaybackDone callback fires (same as PlayString's 6th param).
// The callee does ret 24 (this + 5 params), so raw vtable call needed.
void** vtable = *(void***)((IUnknown*)m_pIDgnSSvcOutputEvent);
void* pfnPlayEvents = vtable[6]; // slot 6 = PlayEvents
void* pThis = (void*)m_pIDgnSSvcOutputEvent;
HRESULT comRc;

__asm {
push 1 // [4] DWORD dwNotify — non-zero for PlaybackDone
push dwClientCode // [3] DWORD dwClientCode
push 0xFFFFFFFF // [2] DWORD dwDelay (-1)
push pEvents // [1] const HOOK_EVENTMSG*
push dwCount // [0] DWORD dwCount
push pThis // this
call pfnPlayEvents
mov comRc, eax
}

rc = comRc;
} else {
// DNS 13/15: standard 4-param COM call
rc = m_pIDgnSSvcOutputEvent->PlayEvents(
dwCount, pEvents, 0xFFFFFFFF, dwClientCode );
}
RETURNIFERROR( rc, "IDgnSSvcOutputEvent::PlayEvents" );

// Now we want to wait until the playback finishes or is aborted
Expand Down
6 changes: 6 additions & 0 deletions NatlinkSource/DragonCode.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ class CDragonCode
CDragonCode() {
m_hMsgWnd = NULL;
m_dwKey = 0;
Copy link
Member Author

@LexiconCode LexiconCode Feb 26, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will need to be tweaked instead of 13

Copy link
Member

@drmfinlay drmfinlay Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-1 will do.

m_dragonMajorVersion = 13;
m_pBeginCallback = NULL;
m_pChangeCallback = NULL;
m_pFirstGramObj = NULL;
Expand Down Expand Up @@ -189,6 +190,11 @@ class CDragonCode
// the key for unregistering our engine sink (a SAPI thing)
DWORD m_dwKey;

// Dragon major version (e.g. 13, 15, 16). Detected at connect time
// via IDgnSREngineControl::GetVersion. DNS 16 has different COM
// calling conventions for PlayString and PlayEvents.
DWORD m_dragonMajorVersion;

// the name of the log file (or en empty string if not known). We
// assume that this will be less than the maximum path and file name
// under Windows.
Expand Down