packages/ti/sdo/ce/video2/viddec2.c

   1 /*
   2  * Copyright (c) 2013, Texas Instruments Incorporated
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * *  Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * *  Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * *  Neither the name of Texas Instruments Incorporated nor the names of
  17  *    its contributors may be used to endorse or promote products derived
  18  *    from this software without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  */
  33 /*
  34  *  ======== viddec2.c ========
  35  *  The XDM IVIDDEC2-compliant video decode APIs
  36  *
  37  *  The methods defined here must be independent of whether the underlying
  38  *  algorithm is executed locally or remotely.
  39  *
  40  *  In fact, these methods must exist on *both* the client and server; the
  41  *  VIDDEC2 skeletons (viddec2_skel.c) call these APIs to create instances on
  42  *  the remote CPU.
  43  */
  44
  45 /* This define must precede inclusion of any xdc header files */
  46 #define Registry_CURDESC ti_sdo_ce_video2_viddec2_desc
  47
  48 #include <xdc/std.h>
  49 #include <xdc/runtime/Assert.h>
  50 #include <xdc/runtime/Diags.h>
  51 #include <xdc/runtime/Log.h>
  52 #include <xdc/runtime/Registry.h>
  53
  54 #include <string.h>  /* for memcpy and memset. */
  55
  56 #include <ti/sdo/ce/visa.h>
  57 #include <ti/sdo/ce/global/CESettings.h>
  58
  59 #include <ti/xdais/ialg.h>
  60 #include <ti/xdais/dm/ividdec2.h>
  61
  62 #include <ti/sdo/ce/utils/xdm/XdmUtils.h>
  63
  64 #include "viddec2.h"
  65 #include "_viddec2.h"
  66
  67 #define MODNAME "ti.sdo.ce.video2.VIDDEC2"
  68
  69 Registry_Desc ti_sdo_ce_video2_viddec2_desc;
  70
  71 static Int regInit = 0;     /* Registry_addModule() called */
  72
  73 /*
  74  *  ======== VIDDEC2_control ========
  75  *  This method must be the same for both local and remote invocation;
  76  *  each call site in the client might be calling different implementations
  77  *  (one that marshalls & sends and one that simply calls).  This API
  78  *  abstracts *all* video decoders (both high and low complexity
  79  *  decoders are invoked using this method).
  80  */
  81 XDAS_Int32 VIDDEC2_control(VIDDEC2_Handle handle, VIDDEC2_Cmd id,
  82     VIDDEC2_DynamicParams *dynParams, VIDDEC2_Status *status)
  83 {
  84     XDAS_Int32 retVal = VIDDEC2_EFAIL;
  85
  86     VIDDEC2_DynamicParams refDynParams;
  87     XDAS_Int32 refStatusSize;
  88     XDAS_Int32 refStatusDataBufSize;
  89
  90     /*
  91      * Note, we assign "VISA_isChecked()" results to a local variable
  92      * rather than repeatedly query it throughout this fxn because
  93      * someday we may allow dynamically changing the global
  94      * 'VISA_isChecked()' value on the fly.  If we allow that, we need
  95      * to ensure the value stays consistent in the context of this
  96      * call.
  97      */
  98     Bool checked = VISA_isChecked();
  99
 100     if (checked) {
 101         /* Ensure dynParams and status are non-NULL, per the XDM spec */
 102
 103         if ((!(XdmUtils_validateExtendedStruct(dynParams, sizeof(*dynParams),
 104                 "dynParams"))) || (!(XdmUtils_validateExtendedStruct(status,
 105                 sizeof(*status), "status")))) {
 106             /* for safety, return here before dereferencing and crashing */
 107             return (retVal);
 108         }
 109     }
 110
 111     Log_print6(Diags_ENTRY, "[+E] VIDDEC2_control> "
 112             "Enter (handle=0x%x, id=%d, dynParams=0x%x (size=0x%x), "
 113             "status=0x%x (size=0x%x)",
 114             (IArg)handle, (IArg)id, (IArg)dynParams, (IArg)(dynParams->size),
 115             (IArg)status, (IArg)(status->size));
 116
 117     if (handle) {
 118         IVIDDEC2_Fxns *fxns =
 119             (IVIDDEC2_Fxns *)VISA_getAlgFxns((VISA_Handle)handle);
 120         IVIDDEC2_Handle alg = VISA_getAlgHandle((VISA_Handle)handle);
 121
 122         if ((fxns != NULL) && (alg != NULL)) {
 123             if (checked) {
 124                 /*
 125                  * Make a reference copy of dynParams, status->size, and
 126                  * status->data.bufSize so we can check that the codec
 127                  * didn't modify these read-only fields during control().
 128                  */
 129                 refDynParams = *dynParams;
 130                 refStatusSize = status->size;
 131                 refStatusDataBufSize = status->data.bufSize;
 132             }
 133
 134             //Log_printf(ti_sdo_ce_dvtLog, "%s", (Arg)"VIDDEC2:control",
 135             //    (Arg)handle, (Arg)0);
 136
 137             VISA_enter((VISA_Handle)handle);
 138             retVal = fxns->control(alg, id, dynParams, status);
 139             VISA_exit((VISA_Handle)handle);
 140
 141             if (checked) {
 142                 /* ensure the codec didn't modify the read-only dynParams */
 143                 if (memcmp(&refDynParams, dynParams, sizeof(*dynParams)) != 0) {
 144                     Log_print1(Diags_USER7,
 145                             "[+7] ERROR> codec (0x%x) modified read-only dynParams "
 146                             "struct!", (IArg)handle);
 147                 }
 148
 149                 /* ensure the codec didn't change status->size */
 150                 if (status->size != refStatusSize) {
 151                     Log_print1(Diags_USER7,
 152                             "[+7] ERROR> codec (0x%x) modified read-only status->size "
 153                             "field!", (IArg)handle);
 154                 }
 155
 156                 /* ensure the codec didn't change status->data.bufSize */
 157                 if (status->data.bufSize != refStatusDataBufSize) {
 158                     Log_print1(Diags_USER7,
 159                             "[+7] ERROR> codec (0x%x) modified read-only "
 160                             "status->data.bufSize field!", (IArg)handle);
 161                 }
 162             }
 163         }
 164     }
 165
 166     Log_print2(Diags_EXIT, "[+X] VIDDEC2_control> "
 167             "Exit (handle=0x%x, retVal=0x%x)", (IArg)handle, (IArg)retVal);
 168
 169     return (retVal);
 170 }
 171
 172
 173 /*
 174  *  ======== VIDDEC2_create ========
 175  */
 176 VIDDEC2_Handle VIDDEC2_create(Engine_Handle engine, String name,
 177     VIDDEC2_Params *params)
 178 {
 179     Registry_Result   result;
 180     VIDDEC2_Handle visa;
 181
 182     /* TODO:M  Race here!  Do we need ATM_Increment in our OSAL? */
 183     if (regInit == 0) {
 184         /* Register this module for logging */
 185         result = Registry_addModule(&ti_sdo_ce_video2_viddec2_desc, MODNAME);
 186         Assert_isTrue(result == Registry_SUCCESS, (Assert_Id)NULL);
 187
 188         if (result == Registry_SUCCESS) {
 189             /* Set the diags mask to the CE default */
 190             CESettings_init();
 191             CESettings_setDiags(MODNAME);
 192         }
 193         regInit = 1;
 194     }
 195
 196     Log_print3(Diags_ENTRY, "[+E] VIDDEC2_create> "
 197             "Enter (engine=0x%x, name='%s', params=0x%x)",
 198             (IArg)engine, (IArg)name, (IArg)params);
 199
 200     visa = VISA_create(engine, name, (IALG_Params *)params,
 201         sizeof (_VIDDEC2_Msg), VIDDEC2_VISATYPE);
 202
 203     Log_print1(Diags_EXIT, "[+X] VIDDEC2_create> return (0x%x)", (IArg)visa);
 204
 205     return (visa);
 206 }
 207
 208
 209 /*
 210  *  ======== VIDDEC2_delete ========
 211  */
 212 Void VIDDEC2_delete(VIDDEC2_Handle handle)
 213 {
 214     Log_print1(Diags_ENTRY, "[+E] VIDDEC2_delete> Enter (handle=0x%x)",
 215             (IArg)handle);
 216
 217     VISA_delete(handle);
 218
 219     Log_print0(Diags_EXIT, "[+X] VIDDEC2_delete> return");
 220 }
 221
 222
 223 /*
 224  *  ======== VIDDEC2_process ========
 225  *  This method must be the same for both local and remote invocation;
 226  *  each call site in the client might be calling different implementations
 227  *  (one that marshalls & sends and one that simply calls).  This API
 228  *  abstracts *all* video decoders (both high and low complexity
 229  *  decoders are invoked using this method).
 230  */
 231 XDAS_Int32 VIDDEC2_process(VIDDEC2_Handle handle, XDM1_BufDesc *inBufs,
 232     XDM_BufDesc *outBufs, VIDDEC2_InArgs *inArgs, VIDDEC2_OutArgs *outArgs)
 233 {
 234     XDAS_Int32 retVal = VIDDEC2_EFAIL;
 235
 236     VIDDEC2_InArgs refInArgs;
 237     Int32 i;
 238
 239     /*
 240      * Note, we assign "VISA_isChecked()" results to a local variable
 241      * rather than repeatedly query it throughout this fxn because
 242      * someday we may allow dynamically changing the global
 243      * 'VISA_isChecked()' value on the fly.  If we allow that, we need
 244      * to ensure the value stays consistent in the context of this
 245      * call.
 246      */
 247     Bool checked = VISA_isChecked();
 248
 249     if (checked) {
 250         /* Ensure inArgs and outArgs are non-NULL, per the XDM spec */
 251
 252         if ((!(XdmUtils_validateExtendedStruct(inArgs, sizeof(*inArgs),
 253                 "inArgs"))) || (!(XdmUtils_validateExtendedStruct(outArgs,
 254                 sizeof(*outArgs), "outArgs")))) {
 255             /* for safety, return here before dereferencing and crashing */
 256             return (retVal);
 257         }
 258     }
 259
 260     Log_print5(Diags_ENTRY, "[+E] VIDDEC2_process> "
 261             "Enter (handle=0x%x, inBufs=0x%x, outBufs=0x%x, inArgs=0x%x, "
 262             "outArgs=0x%x)",
 263             (IArg)handle, (IArg)inBufs, (IArg)outBufs, (IArg)inArgs,
 264             (IArg)outArgs);
 265
 266     if (handle) {
 267         IVIDDEC2_Fxns *fxns =
 268             (IVIDDEC2_Fxns *)VISA_getAlgFxns((VISA_Handle)handle);
 269         IVIDDEC2_Handle alg = VISA_getAlgHandle((VISA_Handle)handle);
 270
 271         if ((fxns != NULL) && (alg != NULL)) {
 272             if (checked) {
 273                 /* validate inArgs with ranges. */
 274                 if (inArgs->inputID == 0) {
 275
 276                     Log_print2(Diags_USER7,
 277                             "[+7] ERROR> app provided codec (0x%x) with out of range "
 278                             "inArgs->inputID field (0x%x)",
 279                             (IArg)alg, (IArg)(inArgs->inputID));
 280                 }
 281
 282                 /*
 283                  * Validate inBufs and outBufs.
 284                  */
 285                 XdmUtils_validateSparseBufDesc1(inBufs, "inBufs");
 286                 XdmUtils_validateSparseBufDesc(outBufs, "outBufs");
 287
 288                 /*
 289                  * Make a reference copy of inArgs so we can check that
 290                  * the codec didn't modify them during process().
 291                  */
 292                 refInArgs = *inArgs;
 293             }
 294
 295             //Log_printf(ti_sdo_ce_dvtLog, "%s", (Arg)"VIDDEC2:process",
 296             //    (Arg)handle, (Arg)0);
 297
 298             VISA_enter((VISA_Handle)handle);
 299             retVal = fxns->process(alg, inBufs, outBufs, inArgs, outArgs);
 300             VISA_exit((VISA_Handle)handle);
 301
 302             if (checked) {
 303                 /* ensure the codec didn't modify the read-only inArgs */
 304                 if (memcmp(&refInArgs, inArgs, sizeof(*inArgs)) != 0) {
 305                     Log_print1(Diags_USER7,
 306                             "[+7] ERROR> codec (0x%x) modified read-only inArgs "
 307                             "struct!", (IArg)handle);
 308                 }
 309
 310                 /* Validate outArgs->decodedBufs */
 311                 XdmUtils_validateVideo1BufDesc(&(outArgs->decodedBufs),
 312                         "decodedBufs");
 313
 314                 /* Validate outArgs->displayBufs */
 315                 for (i = 0; ((outArgs->outputID[i] != 0) &&
 316                         (i < IVIDDEC2_MAX_IO_BUFFERS)); i++) {
 317                     XdmUtils_validateVideo1BufDesc(&(outArgs->displayBufs[i]),
 318                             "displayBufs");
 319                 }
 320             }
 321         }
 322     }
 323
 324     Log_print2(Diags_EXIT, "[+X] VIDDEC2_process> "
 325             "Exit (handle=0x%x, retVal=0x%x)", (IArg)handle, (IArg)retVal);
 326
 327     return (retVal);
 328 }