/*
 *@@sourcefile media.h:
 *      shared header file for XWorkplace multimedia support.
 *
 *@@include #include <wpobject.h>           // for SOM support functions
 *@@include #include "media\media.h"
 */

/*
 *      Copyright (C) 1997-2003 Ulrich M”ller.
 *
 *      This file is part of the XWorkplace source package.
 *      XWorkplace is free software; you can redistribute it and/or modify
 *      it under the terms of the GNU General Public License as published
 *      by the Free Software Foundation, in version 2 as it comes in the
 *      "COPYING" file of the XWorkplace main distribution.
 *      This program is distributed in the hope that it will be useful,
 *      but WITHOUT ANY WARRANTY; without even the implied warranty of
 *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *      GNU General Public License for more details.
 */

#ifndef MEDIA_HEADER_INCLUDED
    #define MEDIA_HEADER_INCLUDED

    /********************************************************************
     *
     *   Media thread messages
     *
     ********************************************************************/

    // flags for XMM_CDPLAYER mp1
    /* #define XMMCD_PLAY                  1
    #define XMMCD_STOP                  2
    #define XMMCD_PAUSE                 3
    #define XMMCD_TOGGLEPLAY            4
    #define XMMCD_NEXTTRACK             5
    #define XMMCD_PREVTRACK             6
    #define XMMCD_EJECT                 7 */

    #define XMM_PLAYSOUND                (WM_USER+251)

    #define XMM_PLAYSYSTEMSOUND          (WM_USER+252)

    // #define XMM_CDPLAYER                 (WM_USER+253)

    // MMPM/2 status flags in KERNELGLOBALS.ulMMPM2Working;
    // these reflect the status of SOUND.DLL.
    // If this is anything other than MMSTAT_WORKING, sounds
    // are disabled.
    #define MMSTAT_UNKNOWN             0        // initial value
    #define MMSTAT_WORKING             1        // SOUND.DLL is working
    #define MMSTAT_MMDIRNOTFOUND       2        // MMPM/2 directory not found
    #define MMSTAT_DLLNOTFOUND         3        // MMPM/2 DLLs not found
    #define MMSTAT_IMPORTSFAILED       4        // MMPM/2 imports failed
    #define MMSTAT_CRASHED             5        // SOUND.DLL crashed, sounds disabled
    #define MMSTAT_DISABLED            6        // explicitly disabled in startup panic dlg

    /* ******************************************************************
     *
     *   Device manager
     *
     ********************************************************************/

    BOOL xmmLockDevicesList(VOID);

    VOID xmmUnlockDevicesList(VOID);

    ULONG xmmOpenDevice(HWND hwndNotify,
                        USHORT usDeviceTypeID,
                        USHORT usDeviceIndex,
                        PUSHORT pusDeviceID);

    ULONG xmmCloseDevice(PUSHORT pusDeviceID);

    VOID xmmCleanup(VOID);

    /* ******************************************************************
     *
     *   Sound helpers
     *
     ********************************************************************/

    ULONG xmmOpenWaveDevice(HWND hwndObject,
                            PUSHORT pusDeviceID);

    ULONG xmmPlaySound(HWND hwndObject,
                       PUSHORT pusDeviceID,
                       PCSZ pcszFile,
                       ULONG ulVolume);

    ULONG xmmStopSound(PUSHORT pusDeviceID);

    /* ******************************************************************
     *
     *   CD player helpers
     *
     ********************************************************************/

    #ifdef INCL_MCIOS2

        /*
         *@@ XMMCDPLAYER:
         *
         *@@added V0.9.7 (2000-12-21) [umoeller]
         */

        typedef struct _XMMCDPLAYER
        {
            USHORT      usDeviceID;
            ULONG       ulStatus;
                            // -- 0: invalid device.
                            // -- MCI_MODE_NOT_READY (1)
                            // -- MCI_MODE_PAUSE (2)
                            // -- MCI_MODE_PLAY (3)
                            // -- MCI_MODE_STOP (4)

            USHORT      cTracks;
                        // usCurrentTrack;     // removed V0.9.13 (2001-06-14) [umoeller]
            ULONG       ulTotalTime;

            // CD's table of contents
            MCI_TOC_REC *aTocEntries;
            USHORT      cTocEntries;

            BOOL        fPositionAdvising;
                    // TRUE if position advise is currently running

            // current time, if fPositionAdvising is TRUE
            HWND        hwndNotify;
            ULONG       ulNotifyMsg;
            ULONG       ulMMTime;
            ULONG       ulTrack;
            ULONG       ulSecondsInTrack;

            HWND        hwndObject;         // private object window

        } XMMCDPLAYER, *PXMMCDPLAYER;

        ULONG xmmCDOpenDevice(PXMMCDPLAYER *ppPlayer,
                              ULONG ulDeviceIndex);

        ULONG xmmCDCloseDevice(PXMMCDPLAYER *ppPlayer);

        ULONG xmmCDGetTOC(PXMMCDPLAYER pPlayer);

        ULONG xmmCDQueryCurrentTrack(PXMMCDPLAYER pPlayer);

        ULONG xmmCDPlay(PXMMCDPLAYER pPlayer,
                        BOOL fShowWaitPointer);

        ULONG xmmCDPlayTrack(PXMMCDPLAYER pPlayer,
                             USHORT usTrack,
                             BOOL fShowWaitPointer);

        ULONG xmmCDCalcTrack(PXMMCDPLAYER pPlayer,
                             ULONG ulMMTime,
                             PULONG pulSecondsInTrack);

        ULONG xmmCDPositionAdvise(PXMMCDPLAYER pPlayer,
                                  HWND hwndNotify,
                                  ULONG ulNotifyMsg);

        ULONG xmmCDPause(PXMMCDPLAYER pPlayer);

        ULONG xmmCDStop(PXMMCDPLAYER *ppPlayer);

        ULONG xmmCDEject(PXMMCDPLAYER *ppPlayer);

    #endif // MCIOS2

    /* ******************************************************************
     *
     *   Master volume helpers
     *
     ********************************************************************/

    ULONG xmmQueryMasterVolume(PULONG pulVolume);

    BOOL xmmSetMasterVolume(ULONG ulVolume);

    /* ******************************************************************
     *
     *   Media thread interface
     *
     ********************************************************************/

    BOOL xmmInit(VOID);

    VOID xmmDisable(VOID);

    ULONG xmmQueryStatus(VOID);

    BOOL xmmPostPartyMsg(ULONG msg, MPARAM mp1, MPARAM mp2);

    BOOL xmmIsBusy(VOID);

    /* ******************************************************************
     *
     *   MMPM/2 configuration queries
     *
     ********************************************************************/

    #ifndef MCI_DEVTYPE_FILTER
        #define MCI_DEVTYPE_FILTER              18
    #endif
    #ifndef MCI_DEVTYPE_TTS
        #define MCI_DEVTYPE_TTS                 19
    #endif

    #ifndef MAX_DEVICE_NAME
        #define MAX_DEVICE_NAME                 20
    #endif

    #ifndef MAX_ALIAS_NAME
        #define MAX_ALIAS_NAME                  20
    #endif

    /*
     *@@ XMMDEVICE:
     *      describes a single MMPM/2 device returned
     *      by xmmQueryDevices.
     *
     *@@added V0.9.3 (2000-04-29) [umoeller]
     */

    typedef struct _XMMDEVICE
    {
        ULONG   ulDeviceType;       // MCI_DEVTYPE_* identifier
        PCSZ pcszDeviceType; // NLS description (composed by xmmQueryDevices)
        ULONG   ulDeviceIndex;      // index (1 or higher); if 0, it's the last entry

        CHAR    szInstallName[MAX_DEVICE_NAME];
        CHAR    szLogicalName[MAX_DEVICE_NAME];
        CHAR    szAliasName[MAX_ALIAS_NAME];

        PSZ     pszInfo;            // driver info (malloc'd)
    } XMMDEVICE, *PXMMDEVICE;

    PXMMDEVICE xmmQueryDevices(PULONG pcDevices);

    BOOL xmmFreeDevices(PXMMDEVICE paDevices);

    /* ******************************************************************
     *
     *   CD player (mmcdplay.c)
     *
     ********************************************************************/

    #ifdef SOM_WPObject_h
        HWND xmmCreateCDPlayerView(WPObject *somSelf,
                                   HWND hwndCnr,
                                   ULONG ulView);
    #endif

    #define WC_CDPLAYER_CLIENT      "XMMCDPlayerClient"

    #define CDM_POSITIONUPDATE      WM_USER

    /* ******************************************************************
     *
     *   Volume control (mmvolume.c)
     *
     ********************************************************************/

    #ifdef SOM_WPObject_h
        HWND xmmCreateVolumeView(WPObject *somSelf,
                                 HWND hwndCnr,
                                 ULONG ulView);
    #endif

#endif