/*
 * Copyright (C) 2016 "IoT.bzh"
 * Author Fulup Ar Foll <fulup@iot.bzh>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * reference:
 *   amixer contents; amixer controls;
 *   http://www.tldp.org/HOWTO/Alsa-sound-6.html
 */

#ifndef HAL_STATIC_H
#define HAL_STATIC_H

// Soft control have dynamically allocated numid
#define CTL_AUTO -1

#ifndef PUBLIC
  #define PUBLIC
#endif
#define STATIC static

typedef enum {
  QUERY_QUIET   =0,
  QUERY_COMPACT =1,
  QUERY_VERBOSE =2,
  QUERY_FULL    =3,
} halQueryMode;

// Most controls are MIXER but some vendor specific are possible
typedef enum {
    OUTVOL,
    PCMVOL,
    INVOL,
    SWITCH,
    ROUTE,
    CARD,
    ENUM,
} halGroupEnumT;

typedef enum {
    READ,
    WRITE,
    RW,
} halAclEnumT;

typedef enum {
    StartHalCrlTag=0,

    // volume RAMP
    Vol_Ramp_Set_Mode,
    Vol_Ramp_Set_Delay,
    Vol_Ramp_Set_Down,
    Vol_Ramp_Set_Up,
    Vol_Ramp_Set_Slave,

    // Hardware Audio Control List,
    Master_Playback_Volume,
    Master_Playback_Ramp,
    PCM_Playback_Volume,
    PCM_Playback_Switch,
    Capture_Volume,
    Master_OnOff_Switch,

    // HighLevel Audio Role Control List,
    Emergency_Playback_Volume,
    Emergency_Playback_Ramp,
    Emergency_Playback_Switch,
    Warning_Playback_Volume,
    Warning_Playback_Ramp,
    Warning_Playback_Switch,
    CustomHigh_Playback_Volume,
    CustomHigh_Playback_Ramp,
    CustomHigh_Playback_Switch,
    Phone_Playback_Volume,
    Phone_Playback_Ramp,
    Phone_Playback_Switch,
    Navigation_Playback_Volume,
    Navigation_Playback_Ramp,
    Navigation_Playback_Switch,
    CustomMedium_Playback_Volume,
    CustomMedium_Playback_Ramp,
    CustomMedium_Playback_Switch,
    Video_Playback_Volume,
    Video_Playback_Ramp,
    Video_Playback_Switch,
    Streaming_Playback_Volume,
    Streaming_Playback_Ramp,
    Streaming_Playback_Switch,
    Multimedia_Playback_Volume,
    Multimedia_Playback_Ramp,
    Multimedia_Playback_Switch,
    Radio_Playback_Volume,
    Radio_Playback_Ramp,
    Radio_Playback_Switch,
    CustomLow_Playback_Volume,
    CustomLow_Playback_Ramp,
    CustomLow_Playback_Switch,
    Fallback_Playback_Volume,
    Fallback_Playback_Ramp,
    Fallback_Playback_Switch,
   EndHalCrlTag // used to compute number of ctls
} halCtlsTagT;


typedef enum {
   RAMP_VOL_NONE      = 0,
   RAMP_VOL_NORMAL    = 1,
   RAMP_VOL_SMOOTH    = 2,
   RAMP_VOL_EMERGENCY = 3,

   EndHalVolMod

} halRampEnumT;

extern const char *halVolRampModes[];
extern const char *halCtlsLabels[];

#endif /* HAL_STATIC_H */