codecs API: Added description of API usage

Added API description clarifies when bytes/samples are used. New variable names
proposed and all existing codecs are adapted to it. Change is just renaming...

Change-Id: I75dba64a49eb3f4369ec7160cb793dda4b44c810
Reviewed-on: https://code.wireshark.org/review/35576
Reviewed-by: Michael Mann <mmann78@netscape.net>
Petri-Dish: Michael Mann <mmann78@netscape.net>
Tested-by: Petri Dish Buildbot
Reviewed-by: Pascal Quantin <pascal@wireshark.org>

5 files changed, 49 insertions, 48 deletions

diff --git a/plugins/codecs/G711/G711decode.c b/plugins/codecs/G711/G711decode.c
index a7d59c552b..0cb794518d 100644
--- a/plugins/codecs/G711/G711decode.c
+++ b/plugins/codecs/G711/G711decode.c
@@ -110,24 +110,24 @@ codec_g711u_get_frequency(void *ctx _U_)
 }
 
 static size_t
-codec_g711u_decode(void *ctx _U_, const void *input, size_t inputSizeBytes, void *output,
-        size_t *outputSizeBytes)
+codec_g711u_decode(void *ctx _U_, const void *inputBytes, size_t inputBytesSize,
+        void *outputSamples, size_t *outputSamplesSize)
 {
-    const guint8 *dataIn = (const guint8 *) input;
-    gint16       *dataOut = (gint16 *) output;
+    const guint8 *dataIn = (const guint8 *) inputBytes;
+    gint16       *dataOut = (gint16 *) outputSamples;
     size_t       i;
 
-    if (!output || !outputSizeBytes) {
-        return inputSizeBytes * 2;
+    if (!outputSamples || !outputSamplesSize) {
+        return inputBytesSize * 2;
     }
 
-    for (i = 0; i < inputSizeBytes; i++)
+    for (i = 0; i < inputBytesSize; i++)
     {
         dataOut[i] = ulaw_exp_table[dataIn[i]];
     }
 
-    *outputSizeBytes = inputSizeBytes * 2;
-    return inputSizeBytes * 2;
+    *outputSamplesSize = inputBytesSize * 2;
+    return inputBytesSize * 2;
 }
 
 static void *
@@ -155,24 +155,24 @@ codec_g711a_get_frequency(void *ctx _U_)
 }
 
 static size_t
-codec_g711a_decode(void *ctx _U_, const void *input, size_t inputSizeBytes, void *output,
-        size_t *outputSizeBytes)
+codec_g711a_decode(void *ctx _U_, const void *inputBytes, size_t inputBytesSize,
+        void *outputSamples, size_t *outputSamplesSize)
 {
-    const guint8 *dataIn = (const guint8 *) input;
-    gint16       *dataOut = (gint16 *) output;
+    const guint8 *dataIn = (const guint8 *) inputBytes;
+    gint16       *dataOut = (gint16 *) outputSamples;
     size_t       i;
 
-    if (!output || !outputSizeBytes) {
-        return inputSizeBytes * 2;
+    if (!outputSamples || !outputSamplesSize) {
+        return inputBytesSize * 2;
     }
 
-    for (i = 0; i < inputSizeBytes; i++)
+    for (i = 0; i < inputBytesSize; i++)
     {
         dataOut[i] = alaw_exp_table[dataIn[i]];
     }
 
-    *outputSizeBytes = inputSizeBytes * 2;
-    return inputSizeBytes * 2;
+    *outputSamplesSize = inputBytesSize * 2;
+    return inputBytesSize * 2;
 }
 
 void
diff --git a/plugins/codecs/G722/G722decode.c b/plugins/codecs/G722/G722decode.c
index bee613438f..c36fcecf90 100644
--- a/plugins/codecs/G722/G722decode.c
+++ b/plugins/codecs/G722/G722decode.c
@@ -57,8 +57,8 @@ codec_g722_get_frequency(void *ctx _U_)
 }
 
 static size_t
-codec_g722_decode(void *ctx, const void *input, size_t inputSizeBytes, void *output,
-        size_t *outputSizeBytes)
+codec_g722_decode(void *ctx, const void *inputBytes, size_t inputBytesSize,
+        void *outputSamples, size_t *outputSamplesSize)
 {
     g722_decode_state_t *state = (g722_decode_state_t *)ctx;
 
@@ -66,13 +66,14 @@ codec_g722_decode(void *ctx, const void *input, size_t inputSizeBytes, void *out
         return 0;  /* out-of-memory; */
     }
 
-    if (!output || !outputSizeBytes) {
-        return 4 * inputSizeBytes;
+    if (!outputSamples || !outputSamplesSize) {
+        return 4 * inputBytesSize;
     }
 
     /* g722_decode returns the number of 16-bit samples. */
-    *outputSizeBytes = 2 * g722_decode(state, (int16_t *)output, (const uint8_t *)input, (int)inputSizeBytes);
-    return *outputSizeBytes;
+    *outputSamplesSize = 2 * g722_decode(state, (int16_t *)outputSamples,
+        (const uint8_t *)inputBytes, (int)inputBytesSize);
+    return *outputSamplesSize;
 }
 
 void
diff --git a/plugins/codecs/G726/G726decode.c b/plugins/codecs/G726/G726decode.c
index 439e9a039c..8fe2c98c52 100644
--- a/plugins/codecs/G726/G726decode.c
+++ b/plugins/codecs/G726/G726decode.c
@@ -73,8 +73,8 @@ codec_g726_get_frequency(void *ctx _U_)
 }
 
 static size_t
-codec_g726_decode(void *ctx, const void *input, size_t inputSizeBytes, void *output,
-        size_t *outputSizeBytes)
+codec_g726_decode(void *ctx, const void *inputBytes, size_t inputBytesSize,
+        void *outputSamples, size_t *outputSamplesSize)
 {
     g726_codec_ctx *state = (g726_codec_ctx *)ctx;
 
@@ -82,7 +82,7 @@ codec_g726_decode(void *ctx, const void *input, size_t inputSizeBytes, void *out
         return 0;  /* out-of-memory; */
     }
 
-    if (!output || !outputSizeBytes) {
+    if (!outputSamples || !outputSamplesSize) {
         /*
          * sample rate 8kHz, for bitrate 16kHz we have 16/8 = 2 bits/sample, so
          * 1 input byte (8 bits) will expand to four 16-bit samples. Likewise,
@@ -90,12 +90,12 @@ codec_g726_decode(void *ctx, const void *input, size_t inputSizeBytes, void *out
          * bitsPerSample = bitRate / sampleRate (8kHz).
          * outputBytes = (inputBits / bitsPerSample) * sizeof(sample)
          */
-        return inputSizeBytes * 8 / (state->bit_rate / 8000) * 2;
+        return inputBytesSize * 8 / (state->bit_rate / 8000) * 2;
     }
 
     /* g726_decode returns the number of 16-bit samples. */
-    *outputSizeBytes = 2 * g726_decode(state->state, (int16_t *)output, (const uint8_t *) input, (int)inputSizeBytes);
-    return *outputSizeBytes;
+    *outputSamplesSize = 2 * g726_decode(state->state, (int16_t *)outputSamples, (const uint8_t *) inputBytes, (int)inputBytesSize);
+    return *outputSamplesSize;
 }
 
 void
diff --git a/plugins/codecs/G729/G729decode.c b/plugins/codecs/G729/G729decode.c
index 10aee33b99..c774dd2058 100644
--- a/plugins/codecs/G729/G729decode.c
+++ b/plugins/codecs/G729/G729decode.c
@@ -41,27 +41,27 @@ codec_g729_get_frequency(void *ctx _U_)
 }
 
 static size_t
-codec_g729_decode(void *ctx, const void *input, size_t inputSizeBytes, void *output,
-        size_t *outputSizeBytes)
+codec_g729_decode(void *ctx, const void *inputBytes, size_t inputBytesSize,
+        void *outputSamples, size_t *outputSamplesSize)
 {
     bcg729DecoderChannelContextStruct *state = (bcg729DecoderChannelContextStruct *)ctx;
-    const guint8 *dataIn = (const guint8 *) input;
-    gint16 *dataOut = (gint16 *) output;
+    const guint8 *dataIn = (const guint8 *) inputBytes;
+    gint16 *dataOut = (gint16 *) outputSamples;
     size_t i;
 
     if (!ctx) {
         return 0;
     }
 
-    if (!output || !outputSizeBytes) {
-        return 80*2*(inputSizeBytes/10);
+    if (!outputSamples || !outputSamplesSize) {
+        return 80*2*(inputBytesSize/10);
     }
 
     /* The G729 algorithm encodes 10ms of voice into 80bit (10 bytes).
        Based on the RTP packetization period (usually 20ms), we need to
        pass to the bcg729 decoder chunks of 10ms (10 bytes)
     */
-    for (i = 0; i < (inputSizeBytes/10); i++) {
+    for (i = 0; i < (inputBytesSize/10); i++) {
         /* The bcg729 decoder library fails to declare the second
            argument to bcg729Decoder() to be a const pointer.  If you
            fix it, and some other functions, to use const, the library
@@ -72,8 +72,8 @@ codec_g729_decode(void *ctx, const void *input, size_t inputSizeBytes, void *out
         */
         bcg729Decoder(state, (guint8 *)dataIn + i*10, 10, 0, 0, 0, dataOut + i*80);
     }
-    *outputSizeBytes = 80*2*(inputSizeBytes/10);
-    return *outputSizeBytes;
+    *outputSamplesSize = 80*2*(inputBytesSize/10);
+    return *outputSamplesSize;
 }
 
 void
diff --git a/plugins/codecs/l16_mono/l16decode.c b/plugins/codecs/l16_mono/l16decode.c
index d8e6780ec9..bd99d6fb2c 100644
--- a/plugins/codecs/l16_mono/l16decode.c
+++ b/plugins/codecs/l16_mono/l16decode.c
@@ -43,25 +43,25 @@ codec_l16_get_frequency(void *ctx _U_)
 }
 
 static size_t
-codec_l16_decode(void *ctx _U_, const void *input, size_t inputSizeBytes,
-                 void *output, size_t *outputSizeBytes)
+codec_l16_decode(void *ctx _U_, const void *inputBytes, size_t inputBytesSize,
+                 void *outputSamples, size_t *outputSamplesSize)
 {
-    const guint16 *dataIn  = (const guint16 *)input;
-    guint16       *dataOut = (guint16 *)output;
+    const guint16 *dataIn  = (const guint16 *)inputBytes;
+    guint16       *dataOut = (guint16 *)outputSamples;
     size_t         i;
 
-    if (!output || !outputSizeBytes)
+    if (!outputSamples || !outputSamplesSize)
     {
-        return inputSizeBytes;
+        return inputBytesSize;
     }
 
-    for (i=0; i<inputSizeBytes/2; i++)
+    for (i=0; i<inputBytesSize/2; i++)
     {
         dataOut[i] = g_ntohs(dataIn[i]);
     }
 
-    *outputSizeBytes = inputSizeBytes;
-    return *outputSizeBytes;
+    *outputSamplesSize = inputBytesSize;
+    return *outputSamplesSize;
 }
 
 void