/*
 * 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.
 *
 *
 * To find out which control your sound card uses
 *  aplay -l  # Check sndcard name name in between []
 *  amixer -D hw:xx controls # get supported controls
 *  amixer -D "hw:3" cget numid=xx  # get control settings
 *
 */
#define _GNU_SOURCE
#include "hal-interface.h"

// Define few private tag for not standard functions
#define PCM_Volume_Multimedia 1000
#define PCM_Volume_Navigation 1001
#define PCM_Volume_Emergency      1002

// Default Values for MasterVolume Ramping
STATIC halVolRampT volRampMaster= {
    .mode    = RAMP_VOL_NORMAL,
    .slave   = Master_Playback_Volume,
    .delay   = 100*1000, // ramping delay in us
    .stepDown=1,
    .stepUp  =1,
};

//Solvol Ramping Value can be customize by Audio Role and Hardwar card
STATIC halVolRampT volRampGuidance= {
    .slave   = Guidance_Playback_Volume,
    .delay   = 50*1000, // ramping delay in us
    .stepDown= 2,
    .stepUp  = 4,
};

STATIC halVolRampT volRampCommunication= {
    .slave   = Communication_Playback_Volume,
    .delay   = 50*1000, // ramping delay in us
    .stepDown= 6,
    .stepUp  = 4,
};

STATIC halVolRampT volRampEntertainment= {
    .slave   = Entertainment_Playback_Volume,
    .delay   = 100*1000, // ramping delay in us
    .stepDown= 4,
    .stepUp  = 2,
};

STATIC halVolRampT volRampNotification= {
    .slave   = Notification_Playback_Volume,
    .delay   = 50*1000, // ramping delay in us
    .stepDown= 6,
    .stepUp  = 4,
};

STATIC halVolRampT volRampWarning= {
    .slave   = Warning_Playback_Volume,
    .delay   = 10*1000, // ramping delay in us
    .stepDown= 6,
    .stepUp  = 10,
};

STATIC halVolRampT volRampSystem= {
    .slave   = System_Playback_Volume,
    .delay   = 20*100, // ramping delay in us
    .stepDown= 6,
    .stepUp  = 10,
};


STATIC halVolRampT volRampStartup= {
    .slave   = Startup_Playback_Volume,
    .delay   = 20*100, // ramping delay in us
    .stepDown= 6,
    .stepUp  = 10,
};

STATIC halVolRampT volRampShutdown= {
    .slave   = Shutdown_Playback_Volume,
    .delay   = 20*100, // ramping delay in us
    .stepDown= 6,
    .stepUp  = 10,
};



// Map HAL hight sndctl with Alsa numid and optionally with a custom callback for non Alsa supported functionalities.
STATIC alsaHalMapT  alsaHalMap[]= {

  // Sound card does not have hardware volume ramping
  { .tag=Master_Playback_Ramp   , .cb={.callback=volumeRamp, .handle=&volRampMaster}, .info="Master Playback Volume Ramp",
    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER, .count=1, .minval=0, .maxval=100, .step=1, .name="Master_Ramp"}
  },

  // Implement Rampup Volume for Virtual Channels (0-100)
  { .tag=Guidance_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampGuidance}, .info="RampUp Guidance Volume",
    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER,.name="Guidance_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
  },
  { .tag=Entertainment_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampEntertainment}, .info="Rampup Entertainment Volume",
    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER,.name="Entertainment_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
  },
  { .tag=Notification_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampNotification}, .info="Ramp-up Notification Volume",
    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER, .name="Notification_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
  },
  { .tag=Communication_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampCommunication}, .info="RampUp Communication Volume",
    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER,.name="Communication_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
  },
  { .tag=Warning_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampWarning}, .info="Ramp-up Warning Volume",
    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER, .name="Warning_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
  },

  { .tag=System_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampSystem}, .info="Ramp-up System Volume",
    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER, .name="System_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
  },
  { .tag=Startup_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampStartup}, .info="Ramp-up Startup Volume",
    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER, .name="Statup_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
  },
  { .tag=Shutdown_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampShutdown}, .info="Ramp-up Shutdown Volume",
    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER, .name="Shutdown_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
  },

   // Bind with existing ones created by ALSA configuration (and linked to softvol) [0-255]
  { .tag=Guidance_Playback_Volume      , 
     .ctl={.name="Guidance_Volume",.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER,.count=2, .maxval=255, .value=204 } 
  },
  { .tag=Entertainment_Playback_Volume ,
    .ctl={.name="Entertainment_Volume",.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER,.count=2, .maxval=255, .value=204 } 
  },
  { .tag=Notification_Playback_Volume  , 
    .ctl={.name="Notification_Volume",.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER,.count=2, .maxval=255, .value=204 } 
  },
  { .tag=Communication_Playback_Volume , 
    .ctl={.name="Communications_Volume", .numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER,.count=2, .maxval=255, .value=204 } 
  },
  { .tag=Warning_Playback_Volume       , 
    .ctl={.name="Warning_Volume",.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER,.count=2, .maxval=255, .value=204}
  },
  { .tag=System_Playback_Volume        , 
    .ctl={.name="System_Volume", .numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER,.count=2, .maxval=255, .value=204 } 
  },
  { .tag=Startup_Playback_Volume       ,
   .ctl={.name="Startup_Volume", .numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER,.count=2, .maxval=255, .value=204} 
  },
  { .tag=Shutdown_Playback_Volume      , 
    .ctl={.name="Shutdown_Volume",.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER,.count=2, .maxval=255, .value=204 }
  },

  { .tag=EndHalCrlTag}  /* marker for end of the array */
} ;

// HAL sound card mapping info
STATIC alsaHalSndCardT alsaHalSndCard = {
    .name = "USB-Audio", //  Match any USB audio sound card
    .info = "Hardware Abstraction Layer for Generic USB Audio sound card",
    .ctls = alsaHalMap,
};

STATIC int sndServiceInit() {
    int err;
    AFB_DEBUG("USB-Audio HAL Binding Init");
    err = halServiceInit(afbBindingV2.api, &alsaHalSndCard);
    return err;
}

// API prefix should be unique for each snd card
PUBLIC const struct afb_binding_v2 afbBindingV2 = {
    .api = "usb-audio",
    .init = sndServiceInit,
    .verbs = halServiceApi,
    .onevent = halServiceEvent,
};