audiocapturemgr_iarm.h

/*
 * If not stated otherwise in this file or this component's Licenses.txt file the
 * following copyright and licenses apply:
 *
 * Copyright 2016 RDK Management
 *
 * 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.
*/
#ifndef _AUDIOCAPTUREMGR_IARM_H_
#define _AUDIOCAPTUREMGR_IARM_H_
#include "basic_types.h"
 
/**
 * @addtogroup AUDIO_CAPTURE_MANAGER_API
 * @{
 */
 
#define IARMBUS_AUDIOCAPTUREMGR_NAME "audiocapturemgr"
/*Original API list*/
#define IARMBUS_AUDIOCAPTUREMGR_ENABLE "enableCapture"
#define IARMBUS_AUDIOCAPTUREMGR_REQUEST_SAMPLE "requestSample"
 
/*New API list*/
#define IARMBUS_AUDIOCAPTUREMGR_OPEN "open"
#define IARMBUS_AUDIOCAPTUREMGR_CLOSE "close"
#define IARMBUS_AUDIOCAPTUREMGR_START "start"
#define IARMBUS_AUDIOCAPTUREMGR_STOP "stop"
#define IARMBUS_AUDIOCAPTUREMGR_GET_DEFAULT_AUDIO_PROPS "getDefaultAudioProperties"
#define IARMBUS_AUDIOCAPTUREMGR_GET_AUDIO_PROPS "getAudioProperties"
#define IARMBUS_AUDIOCAPTUREMGR_GET_OUTPUT_PROPS "getOutputProperties"
#define IARMBUS_AUDIOCAPTUREMGR_SET_AUDIO_PROPERTIES "setAudioProperties"
#define IARMBUS_AUDIOCAPTUREMGR_SET_OUTPUT_PROPERTIES "setOutputProperties"
 
/*End API list*/
 
#define AUDIOCAPTUREMGR_FILENAME_PREFIX "audio_sample"
#define AUDIOCAPTUREMGR_FILE_PATH "/opt/"
 
#ifdef __cplusplus
namespace audiocapturemgr
{
#endif
 
        typedef enum
        {
                BUFFERED_FILE_OUTPUT = 0,
                REALTIME_SOCKET,
                MAX_SUPPORTED_OUTPUT_TYPES
        }iarmbus_output_type_t;
 
        typedef int session_id_t;
        typedef enum
        {
                DATA_CAPTURE_IARM_EVENT_AUDIO_CLIP_READY = 0,
                IARMBUS_MAX_ACM_EVENT
        }iarmbus_events_t;
 
        typedef enum
        {
                ACM_RESULT_SUCCESS = 0,
                ACM_RESULT_UNSUPPORTED_API,
                ACM_RESULT_STREAM_UNAVAILABLE,
                ACM_RESULT_DURATION_OUT_OF_BOUNDS,
                ACM_RESULT_BAD_SESSION_ID,
                ACM_RESULT_INVALID_ARGUMENTS,
                ACM_RESULT_GENERAL_FAILURE,
                ACM_RESULT_PRECAPTURE_DURATION_TOO_LONG = 254,
                ACM_RESULT_PRECAPTURE_NOT_SUPPORTED = 255
        }iarmbus_audiocapturemgr_result_t;
 
 
    typedef enum {
        acmFormate16BitStereo,    /* !< Stereo, 16 bits per sample interleaved into a 32-bit word. */
        acmFormate24BitStereo,    /* !< Stereo, 24 bits per sample.  The data is aligned to 32-bits,
                                                 left-justified.  Left and right channels will interleave
                                                 one sample per 32-bit word.  */
        acmFormate16BitMonoLeft,  /* !< Mono, 16 bits per sample interleaved into a 32-bit word. Left channel samples only. */
        acmFormate16BitMonoRight, /* !< Mono, 16 bits per sample interleaved into a 32-bit word. Right channel samples only. */
        acmFormate16BitMono,      /* !< Mono, 16 bits per sample interleaved into a 32-bit word. Left and Right channels mixed. */
        acmFormate24Bit5_1,       /* !< 5.1 Multichannel, 24 bits per sample.  The data is aligned to 32-bits,
                                                 left-justified.  Channels will interleave
                                                 one sample per 32-bit word, ordered L,R,Ls,Rs,C,LFE.  */
        acmFormateMax
    } iarmbus_acm_format;
 
 
        typedef enum {
                acmFreqe16000,         /*!< 16KHz    */
                acmFreqe24000,         /*!< 24kHz    */
                acmFreqe32000,         /*!< 32KHz    */
                acmFreqe44100,         /*!< 44.1KHz  */
                acmFreqe48000,         /*!< 48KHz    */
                acmFreqeMax
        } iarmbus_acm_freq;
 
 
        typedef struct
        {
                unsigned int result;
                float max_duration;
        }iarmbus_enable_payload_t;
 
    typedef struct
    {
        iarmbus_acm_format  format;
        iarmbus_acm_freq    sampling_frequency;
        size_t              fifo_size;
        size_t              threshold;
        unsigned int        delay_compensation_ms;
    }audio_properties_ifce_t;
 
 
 
        typedef struct
        {
                float duration;
                bool is_precapture;
        }iarmbus_request_payload_t;
 
        typedef struct
        {
                char dataLocator[64];
        }iarmbus_notification_payload_t;
 
        #define MAX_OUTPUT_PATH_LEN 256
        typedef struct
        {
                union
                {
                        char file_path[MAX_OUTPUT_PATH_LEN]; //!< get unix domain socket name (ip out) 
                        unsigned int buffer_duration; //!< set precapture duration (music id)
                        unsigned int max_buffer_duration; //!< get max supported buffer duration (music id)
                }output;
        }iarmbus_delivery_props_t;
 
        typedef struct
        {
                int source;//!< 0 for primary, increasing by 1 for each new source.
                iarmbus_output_type_t output_type;
        }iarmbus_open_args;
 
        typedef struct
        {
                session_id_t session_id;
                int result;
                union
                {
                        iarmbus_open_args arg_open;
                        audio_properties_ifce_t arg_audio_properties;
                        iarmbus_request_payload_t arg_sample_request;
                        iarmbus_delivery_props_t arg_output_props;
                }details;
        }iarmbus_acm_arg_t;
 
 
#ifdef __cplusplus
}
#endif
 
#endif //_AUDIOCAPTUREMGR_IARM_H_
 
/**
 * @}
 */