khronosfws/openmax_al/src/common/xanvolumeextitf.h
author hgs
Fri, 11 Jun 2010 19:59:23 -0500
changeset 25 6f7ceef7b1d1
parent 19 4a629bc82c5e
permissions -rw-r--r--
201023
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
19
hgs
parents:
diff changeset
     1
/*
25
hgs
parents: 19
diff changeset
     2
 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents: 19
diff changeset
     3
 * All rights reserved.
hgs
parents: 19
diff changeset
     4
 * This component and the accompanying materials are made available
hgs
parents: 19
diff changeset
     5
 * under the terms of "Eclipse Public License v1.0"
hgs
parents: 19
diff changeset
     6
 * which accompanies this distribution, and is available
hgs
parents: 19
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents: 19
diff changeset
     8
 *
hgs
parents: 19
diff changeset
     9
 * Initial Contributors:
hgs
parents: 19
diff changeset
    10
 * Nokia Corporation - initial contribution.
hgs
parents: 19
diff changeset
    11
 *
hgs
parents: 19
diff changeset
    12
 * Contributors:
hgs
parents: 19
diff changeset
    13
 *
hgs
parents: 19
diff changeset
    14
 * Description: 
hgs
parents: 19
diff changeset
    15
 *
hgs
parents: 19
diff changeset
    16
 */
19
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef XANVOLUMEEXTITF_H
hgs
parents:
diff changeset
    19
#define XANVOLUMEEXTITF_H
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#include "openmaxalwrapper.h"
hgs
parents:
diff changeset
    22
#include "xaglobals.h"
hgs
parents:
diff changeset
    23
#include "xaadptbasectx.h"
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
/** MACROS **/
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
/* Max volume level is implementation-dependent but must be at least 0mB
hgs
parents:
diff changeset
    28
 * now used max volume 10 mB
hgs
parents:
diff changeset
    29
 */
hgs
parents:
diff changeset
    30
#define MAX_VOLUME_LEVEL 10
hgs
parents:
diff changeset
    31
#define MAX_VOLUME_AT_LEAST 0
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
/** TYPES **/
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
/** ENUMERATIONS **/
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
/** STRUCTURES **/
hgs
parents:
diff changeset
    38
/* Definition of XANokiaVolumeExtItf implementation */
hgs
parents:
diff changeset
    39
typedef struct XANokiaVolumeExtItfImpl_
25
hgs
parents: 19
diff changeset
    40
    {
19
hgs
parents:
diff changeset
    41
    /* parent interface */
hgs
parents:
diff changeset
    42
    struct XANokiaVolumeExtItf_ itf;
hgs
parents:
diff changeset
    43
    /* pointer to self */
hgs
parents:
diff changeset
    44
    struct XANokiaVolumeExtItfImpl_* self;
hgs
parents:
diff changeset
    45
hgs
parents:
diff changeset
    46
    XAmillibel volumeLevel;
hgs
parents:
diff changeset
    47
    XAboolean mute;
hgs
parents:
diff changeset
    48
    XAboolean enableStereoPos;
hgs
parents:
diff changeset
    49
    XApermille stereoPosition;
25
hgs
parents: 19
diff changeset
    50
    XAuint32 eventFlags;
hgs
parents: 19
diff changeset
    51
    XANokiaVolumeExtItf cbPtrToSelf;
hgs
parents: 19
diff changeset
    52
    xaNokiaVolumeExtCallback callback;
hgs
parents: 19
diff changeset
    53
    void *context;
hgs
parents: 19
diff changeset
    54
19
hgs
parents:
diff changeset
    55
    /*Adaptation variables*/
hgs
parents:
diff changeset
    56
    XAAdaptationBaseCtx *adapCtx;
hgs
parents:
diff changeset
    57
25
hgs
parents: 19
diff changeset
    58
    } XANokiaVolumeExtItfImpl;
19
hgs
parents:
diff changeset
    59
hgs
parents:
diff changeset
    60
/** METHODS **/
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
/* Base interface XANokiaVolumeExtItf implementation */
25
hgs
parents: 19
diff changeset
    63
XAresult XANokiaVolumeExtItfImpl_SetVolumeLevel(XANokiaVolumeExtItf self,
hgs
parents: 19
diff changeset
    64
        XAmillibel level);
19
hgs
parents:
diff changeset
    65
25
hgs
parents: 19
diff changeset
    66
XAresult XANokiaVolumeExtItfImpl_GetVolumeLevel(XANokiaVolumeExtItf self,
hgs
parents: 19
diff changeset
    67
        XAmillibel *pLevel);
19
hgs
parents:
diff changeset
    68
25
hgs
parents: 19
diff changeset
    69
XAresult XANokiaVolumeExtItfImpl_GetMaxVolumeLevel(XANokiaVolumeExtItf self,
hgs
parents: 19
diff changeset
    70
        XAmillibel *pMaxLevel);
19
hgs
parents:
diff changeset
    71
25
hgs
parents: 19
diff changeset
    72
XAresult XANokiaVolumeExtItfImpl_SetMute(XANokiaVolumeExtItf self,
hgs
parents: 19
diff changeset
    73
        XAboolean mute);
19
hgs
parents:
diff changeset
    74
25
hgs
parents: 19
diff changeset
    75
XAresult XANokiaVolumeExtItfImpl_GetMute(XANokiaVolumeExtItf self,
hgs
parents: 19
diff changeset
    76
        XAboolean *pMute);
19
hgs
parents:
diff changeset
    77
25
hgs
parents: 19
diff changeset
    78
XAresult XANokiaVolumeExtItfImpl_EnableStereoPosition(
hgs
parents: 19
diff changeset
    79
        XANokiaVolumeExtItf self, XAboolean enable);
19
hgs
parents:
diff changeset
    80
25
hgs
parents: 19
diff changeset
    81
XAresult XANokiaVolumeExtItfImpl_IsEnabledStereoPosition(
hgs
parents: 19
diff changeset
    82
        XANokiaVolumeExtItf self, XAboolean *pEnable);
19
hgs
parents:
diff changeset
    83
25
hgs
parents: 19
diff changeset
    84
XAresult XANokiaVolumeExtItfImpl_SetStereoPosition(XANokiaVolumeExtItf self,
hgs
parents: 19
diff changeset
    85
        XApermille stereoPosition);
19
hgs
parents:
diff changeset
    86
25
hgs
parents: 19
diff changeset
    87
XAresult XANokiaVolumeExtItfImpl_GetStereoPosition(XANokiaVolumeExtItf self,
hgs
parents: 19
diff changeset
    88
        XApermille *pStereoPosition);
hgs
parents: 19
diff changeset
    89
hgs
parents: 19
diff changeset
    90
XAresult XANokiaVolumeExtItfImpl_RegisterVolumeCallback(
hgs
parents: 19
diff changeset
    91
        XANokiaVolumeExtItf self, xaNokiaVolumeExtCallback callback,
hgs
parents: 19
diff changeset
    92
        void * pContext);
hgs
parents: 19
diff changeset
    93
XAresult XANokiaVolumeExtItfImpl_SetCallbackEventsMask(
hgs
parents: 19
diff changeset
    94
        XANokiaVolumeExtItf self, XAuint32 eventFlags);
hgs
parents: 19
diff changeset
    95
XAresult XANokiaVolumeExtItfImpl_GetCallbackEventsMask(
hgs
parents: 19
diff changeset
    96
        XANokiaVolumeExtItf self, XAuint32 * pEventFlags);
19
hgs
parents:
diff changeset
    97
hgs
parents:
diff changeset
    98
/* XANokiaVolumeExtItfImpl -specific methods */
25
hgs
parents: 19
diff changeset
    99
XANokiaVolumeExtItfImpl* XANokiaVolumeExtItfImpl_Create(
hgs
parents: 19
diff changeset
   100
        XAAdaptationBaseCtx *adapCtx);
19
hgs
parents:
diff changeset
   101
void XANokiaVolumeExtItfImpl_Free(XANokiaVolumeExtItfImpl* self);
25
hgs
parents: 19
diff changeset
   102
void XANokiaVolumeExtItfImpl_AdaptCb(void *pHandlerCtx, XAAdaptEvent *event);
19
hgs
parents:
diff changeset
   103
hgs
parents:
diff changeset
   104
#endif /* XANVOLUMEEXTITF_H */