Update SILK code using the CELT range coder
[opus.git] / interface / SKP_Silk_SDK_API.h
index cb31db2..e266780 100644 (file)
@@ -39,7 +39,7 @@ extern "C"
 \r
 #define SILK_MAX_FRAMES_PER_PACKET  5\r
 \r
-/* Struct for TOC (Table Of Contents) */\r
+/* Struct for TOC (Table of Contents) */\r
 typedef struct {\r
     SKP_int     framesInPacket;                             /* Number of 20 ms frames in packet     */\r
     SKP_int     fs_kHz;                                     /* Sampling frequency in packet         */\r
@@ -56,14 +56,14 @@ typedef struct {
 /***********************************************/\r
 /* Get size in bytes of the Silk encoder state */\r
 /***********************************************/\r
-SKP_int SKP_Silk_SDK_Get_Encoder_Size( \r
+SKP_int SKP_Silk_SDK_Get_Encoder_Size(                  /* O:   Returns error code                              */\r
     SKP_int32                           *encSizeBytes   /* O:   Number of bytes in SILK encoder state           */\r
 );\r
 \r
 /*************************/\r
 /* Init or reset encoder */\r
 /*************************/\r
-SKP_int SKP_Silk_SDK_InitEncoder(\r
+SKP_int SKP_Silk_SDK_InitEncoder(                       /* O:   Returns error code                              */\r
     void                                *encState,      /* I/O: State                                           */\r
     SKP_SILK_SDK_EncControlStruct       *encStatus      /* O:   Encoder Status                                  */\r
 );\r
@@ -71,7 +71,7 @@ SKP_int SKP_Silk_SDK_InitEncoder(
 /***************************************/\r
 /* Read control structure from encoder */\r
 /***************************************/\r
-SKP_int SKP_Silk_SDK_QueryEncoder(\r
+SKP_int SKP_Silk_SDK_QueryEncoder(                      /* O:   Returns error code                              */\r
     const void                          *encState,      /* I:   State                                           */\r
     SKP_SILK_SDK_EncControlStruct       *encStatus      /* O:   Encoder Status                                  */\r
 );\r
@@ -79,13 +79,13 @@ SKP_int SKP_Silk_SDK_QueryEncoder(
 /**************************/\r
 /* Encode frame with Silk */\r
 /**************************/\r
-SKP_int SKP_Silk_SDK_Encode( \r
+SKP_int SKP_Silk_SDK_Encode(                            /* O:   Returns error code                              */\r
     void                                *encState,      /* I/O: State                                           */\r
     const SKP_SILK_SDK_EncControlStruct *encControl,    /* I:   Control status                                  */\r
     const SKP_int16                     *samplesIn,     /* I:   Speech sample input vector                      */\r
     SKP_int                             nSamplesIn,     /* I:   Number of samples in input vector               */\r
     SKP_uint8                           *outData,       /* O:   Encoded output vector                           */\r
-    SKP_int16                           *nBytesOut      /* I/O: Number of Bytes in outData (input: Max Bytes)   */\r
+    SKP_int16                           *nBytesOut      /* I/O: Number of bytes in outData (input: Max bytes)   */\r
 );\r
 \r
 /****************************************/\r
@@ -95,26 +95,26 @@ SKP_int SKP_Silk_SDK_Encode(
 /***********************************************/\r
 /* Get size in bytes of the Silk decoder state */\r
 /***********************************************/\r
-SKP_int SKP_Silk_SDK_Get_Decoder_Size( \r
+SKP_int SKP_Silk_SDK_Get_Decoder_Size(                  /* O:   Returns error code                              */\r
     SKP_int32                           *decSizeBytes   /* O:   Number of bytes in SILK decoder state           */\r
 );\r
 \r
 /*************************/\r
 /* Init or Reset decoder */\r
 /*************************/\r
-SKP_int SKP_Silk_SDK_InitDecoder( \r
+SKP_int SKP_Silk_SDK_InitDecoder(                       /* O:   Returns error code                              */\r
     void                                *decState       /* I/O: State                                           */\r
 );\r
 \r
 /******************/\r
 /* Decode a frame */\r
 /******************/\r
-SKP_int SKP_Silk_SDK_Decode(\r
+SKP_int SKP_Silk_SDK_Decode(                            /* O:   Returns error code                              */\r
     void*                               decState,       /* I/O: State                                           */\r
     SKP_SILK_SDK_DecControlStruct*      decControl,     /* I/O: Control Structure                               */\r
     SKP_int                             lostFlag,       /* I:   0: no loss, 1 loss                              */\r
     const SKP_uint8                     *inData,        /* I:   Encoded input vector                            */\r
-    const SKP_int                       nBytesIn,       /* I:   Number of input Bytes                           */\r
+    const SKP_int                       nBytesIn,       /* I:   Number of input bytes                           */\r
     SKP_int16                           *samplesOut,    /* O:   Decoded output speech vector                    */\r
     SKP_int16                           *nSamplesOut    /* I/O: Number of samples (vector/decoded)              */\r
 );\r
@@ -123,22 +123,20 @@ SKP_int SKP_Silk_SDK_Decode(
 /* Find Low Bit Rate Redundancy (LBRR) information in a packet */\r
 /***************************************************************/\r
 void SKP_Silk_SDK_search_for_LBRR(\r
-    void                                *decState,      /* I:   Decoder state, to select bitstream version only */\r
     const SKP_uint8                     *inData,        /* I:   Encoded input vector                            */\r
-    const SKP_int16                     nBytesIn,       /* I:   Number of input Bytes                           */\r
+    const SKP_int16                     nBytesIn,       /* I:   Number of input bytes                           */\r
     SKP_int                             lost_offset,    /* I:   Offset from lost packet                         */\r
     SKP_uint8                           *LBRRData,      /* O:   LBRR payload                                    */\r
     SKP_int16                           *nLBRRBytes     /* O:   Number of LBRR Bytes                            */\r
 );\r
 \r
-/************************************/\r
-/* Get type of content for a packet */\r
-/************************************/\r
+/**************************************/\r
+/* Get table of contents for a packet */\r
+/**************************************/\r
 void SKP_Silk_SDK_get_TOC(\r
-    void                                       *decState,      /* I:   Decoder state, to select bitstream version only */\r
     const SKP_uint8                     *inData,        /* I:   Encoded input vector                            */\r
     const SKP_int16                     nBytesIn,       /* I:   Number of input bytes                           */\r
-    SKP_Silk_TOC_struct                 *Silk_TOC       /* O:   Type of content                                 */\r
+    SKP_Silk_TOC_struct                 *Silk_TOC       /* O:   Table of contents                               */\r
 );\r
 \r
 /**************************/\r