audio_engine.h

/*
 *  Copyright (C) 2005-2019 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#ifndef C_API_AUDIO_ENGINE_H
#define C_API_AUDIO_ENGINE_H

#include <stdbool.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */

  //¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  // "C" Definitions, structures and enumerators of audio engine
  //{{{

  //============================================================================
  typedef enum AudioEngineStreamOptions
  {
    AUDIO_STREAM_FORCE_RESAMPLE = 1 << 0,
    AUDIO_STREAM_PAUSED = 1 << 1,
    AUDIO_STREAM_AUTOSTART = 1 << 2,
  } AudioEngineStreamOptions;
  //----------------------------------------------------------------------------

  //============================================================================
  enum AudioEngineChannel
  {
    AUDIOENGINE_CH_NULL = -1,
    AUDIOENGINE_CH_RAW,
    AUDIOENGINE_CH_FL,
    AUDIOENGINE_CH_FR,
    AUDIOENGINE_CH_FC,
    AUDIOENGINE_CH_LFE,
    AUDIOENGINE_CH_BL,
    AUDIOENGINE_CH_BR,
    AUDIOENGINE_CH_FLOC,
    AUDIOENGINE_CH_FROC,
    AUDIOENGINE_CH_BC,
    AUDIOENGINE_CH_SL,
    AUDIOENGINE_CH_SR,
    AUDIOENGINE_CH_TFL,
    AUDIOENGINE_CH_TFR,
    AUDIOENGINE_CH_TFC,
    AUDIOENGINE_CH_TC,
    AUDIOENGINE_CH_TBL,
    AUDIOENGINE_CH_TBR,
    AUDIOENGINE_CH_TBC,
    AUDIOENGINE_CH_BLOC,
    AUDIOENGINE_CH_BROC,
    AUDIOENGINE_CH_MAX
  };
  //----------------------------------------------------------------------------

  //============================================================================
  enum AudioEngineDataFormat
  {
    AUDIOENGINE_FMT_INVALID = -1,

    AUDIOENGINE_FMT_U8,

    AUDIOENGINE_FMT_S16BE,
    AUDIOENGINE_FMT_S16LE,
    AUDIOENGINE_FMT_S16NE,

    AUDIOENGINE_FMT_S32BE,
    AUDIOENGINE_FMT_S32LE,
    AUDIOENGINE_FMT_S32NE,

    AUDIOENGINE_FMT_S24BE4,
    AUDIOENGINE_FMT_S24LE4,
    AUDIOENGINE_FMT_S24NE4,
    AUDIOENGINE_FMT_S24NE4MSB,

    AUDIOENGINE_FMT_S24BE3,
    AUDIOENGINE_FMT_S24LE3,
    AUDIOENGINE_FMT_S24NE3,

    AUDIOENGINE_FMT_DOUBLE,
    AUDIOENGINE_FMT_FLOAT,

    AUDIOENGINE_FMT_RAW,

    AUDIOENGINE_FMT_U8P,
    AUDIOENGINE_FMT_S16NEP,
    AUDIOENGINE_FMT_S32NEP,
    AUDIOENGINE_FMT_S24NE4P,
    AUDIOENGINE_FMT_S24NE4MSBP,
    AUDIOENGINE_FMT_S24NE3P,
    AUDIOENGINE_FMT_DOUBLEP,
    AUDIOENGINE_FMT_FLOATP,

    AUDIOENGINE_FMT_MAX
  };
  //----------------------------------------------------------------------------

  struct AUDIO_ENGINE_FORMAT
  {
    enum AudioEngineDataFormat m_dataFormat;

    unsigned int m_sampleRate;

    unsigned int m_encodedRate;

    unsigned int m_channelCount;

    enum AudioEngineChannel m_channels[AUDIOENGINE_CH_MAX];

    unsigned int m_frames;

    unsigned int m_frameSize;
  };

  /* A stream handle pointer, which is only used internally by the addon stream handle */
  typedef void AEStreamHandle;

  //}}}

  //¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  // "C" Internal interface tables for intercommunications between addon and kodi
  //{{{

  /*
   * Function address structure, not need to visible on dev kit doxygen
   * documentation
   */
  typedef struct AddonToKodiFuncTable_kodi_audioengine
  {
    AEStreamHandle* (*make_stream)(void* kodiBase,
                                   struct AUDIO_ENGINE_FORMAT* format,
                                   unsigned int options);
    void (*free_stream)(void* kodiBase, AEStreamHandle* stream);
    bool (*get_current_sink_format)(void* kodiBase, struct AUDIO_ENGINE_FORMAT* sink_format);

    // Audio Engine Stream definitions
    unsigned int (*aestream_get_space)(void* kodiBase, AEStreamHandle* handle);
    unsigned int (*aestream_add_data)(void* kodiBase,
                                      AEStreamHandle* handle,
                                      uint8_t* const* data,
                                      unsigned int offset,
                                      unsigned int frames,
                                      double pts,
                                      bool hasDownmix,
                                      double centerMixLevel);
    double (*aestream_get_delay)(void* kodiBase, AEStreamHandle* handle);
    bool (*aestream_is_buffering)(void* kodiBase, AEStreamHandle* handle);
    double (*aestream_get_cache_time)(void* kodiBase, AEStreamHandle* handle);
    double (*aestream_get_cache_total)(void* kodiBase, AEStreamHandle* handle);
    void (*aestream_pause)(void* kodiBase, AEStreamHandle* handle);
    void (*aestream_resume)(void* kodiBase, AEStreamHandle* handle);
    void (*aestream_drain)(void* kodiBase, AEStreamHandle* handle, bool wait);
    bool (*aestream_is_draining)(void* kodiBase, AEStreamHandle* handle);
    bool (*aestream_is_drained)(void* kodiBase, AEStreamHandle* handle);
    void (*aestream_flush)(void* kodiBase, AEStreamHandle* handle);
    float (*aestream_get_volume)(void* kodiBase, AEStreamHandle* handle);
    void (*aestream_set_volume)(void* kodiBase, AEStreamHandle* handle, float volume);
    float (*aestream_get_amplification)(void* kodiBase, AEStreamHandle* handle);
    void (*aestream_set_amplification)(void* kodiBase, AEStreamHandle* handle, float amplify);
    unsigned int (*aestream_get_frame_size)(void* kodiBase, AEStreamHandle* handle);
    unsigned int (*aestream_get_channel_count)(void* kodiBase, AEStreamHandle* handle);
    unsigned int (*aestream_get_sample_rate)(void* kodiBase, AEStreamHandle* handle);
    enum AudioEngineDataFormat (*aestream_get_data_format)(void* kodiBase, AEStreamHandle* handle);
    double (*aestream_get_resample_ratio)(void* kodiBase, AEStreamHandle* handle);
    void (*aestream_set_resample_ratio)(void* kodiBase, AEStreamHandle* handle, double ratio);
  } AddonToKodiFuncTable_kodi_audioengine;

  //}}}

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* !C_API_AUDIO_ENGINE_H */