{"id":3179,"date":"2019-05-29T09:41:20","date_gmt":"2019-05-29T07:41:20","guid":{"rendered":"https:\/\/demdlx704as001.ad.harman.com\/?page_id=3179"},"modified":"2024-04-24T14:29:22","modified_gmt":"2024-04-24T12:29:22","slug":"device-description-file","status":"publish","type":"page","link":"https:\/\/audioworx.transfunnel.co\/old\/?page_id=3179","title":{"rendered":"Device Description File"},"content":{"rendered":"
<\/span> <\/span><\/a><\/span>
<\/div>
<\/div><\/div>
\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t<\/span>
  1. Terms and Abbreviations<\/a>
    <\/div><\/li>
  2. Purpose of this Document<\/a>
    <\/div><\/li>
  3. Root Element<\/a>
    <\/div><\/li>
  4. Node Elements<\/a><\/span>
    <\/div>
    1. Communication Parameters<\/a>
      <\/div><\/li>
    2. Identification of Target Device<\/a>
      <\/div><\/li><\/ol><\/li>
    3. Virtual Device<\/a>
      <\/div><\/li>
    4. Objects<\/a><\/span>
      <\/div>
      1. Object<\/a>
        <\/div><\/li>
      2. Definition of a Table Object<\/a>
        <\/div><\/li>
      3. Definition of a Biquad Coefficients Object<\/a>
        <\/div><\/li><\/ol><\/li>
      4. StateVariables<\/a><\/span>
        <\/div>
        1. Common<\/a>
          <\/div><\/li>
        2. NumericalSV<\/a>
          <\/div><\/li>
        3. EnumSV<\/a>
          <\/div><\/li>
        4. FilterTypeSV<\/a>
          <\/div><\/li>
        5. FloatArraySV<\/a>
          <\/div><\/li>
        6. Float16ArraySV<\/a>
          <\/div><\/li>
        7. FixedPoint16ArraySV<\/a>
          <\/div><\/li>
        8. StringSV<\/a>
          <\/div><\/li>
        9. FixedPointM_NArraySV<\/a>
          <\/div><\/li><\/ol><\/li>
        10. TargetValue<\/a><\/span>
          <\/div>
          1. Common<\/a>
            <\/div><\/li>
          2. Target Value<\/a>
            <\/div><\/li>
          3. Block Target Value<\/a>
            <\/div><\/li><\/ol><\/li>
          4. Templates<\/a><\/span>
            <\/div>
            1. StateVariables<\/a><\/span>
              <\/div>
              1. FIR coefficients<\/a>
                <\/div><\/li>
              2. String<\/a>
                <\/div><\/li><\/ol><\/li><\/ol><\/li>
              3. Revision History<\/a>
                <\/div><\/li><\/ol><\/div><\/div>

                1.<\/span>Terms and Abbreviations<\/span> <\/span><\/span>
                <\/div>\u2191 Back to Top<\/a><\/h2>
                \n\n\n\n\n\n\n\n\n\n\n
                Abbreviation<\/td>\nMeaning<\/td>\n<\/tr>\n
                Addr<\/td>\nAddress<\/td>\n<\/tr>\n
                Attr<\/td>\nAttribute<\/td>\n<\/tr>\n
                Def<\/td>\nDefinition<\/td>\n<\/tr>\n
                Elmt<\/td>\nElement<\/td>\n<\/tr>\n
                Incl<\/td>\nInclude<\/td>\n<\/tr>\n
                Mlt<\/td>\nMultiplicity<\/td>\n<\/tr>\n
                SFD<\/td>\nSignal Flow Designer<\/td>\n<\/tr>\n
                Tmp<\/td>\nTemplate<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

                <\/p>\n<\/div>

                \n\t\t\t\t\t<\/div>
                <\/div><\/div><\/div><\/div>

                2.<\/span>Purpose of this Document<\/span> <\/span><\/span>
                <\/div>\u2191 Back to Top<\/a><\/h2>

                The device description file (DDF) describes all data structures of a target device and how to access them via xTP.<\/p>\n

                Usually this file is generated by SFD automatically, and is not visible to end user.<\/p>\n

                So this document is mainly for audio object developers. They have to implement the creation of the DDF inside of the audio algorithm toolbox (AAT).<\/p>\n<\/div>

                \n\t\t\t\t\t<\/div>
                <\/div><\/div><\/div><\/div>

                3.<\/span>Root Element<\/span> <\/span><\/span>
                <\/div>\u2191 Back to Top<\/a><\/h2>
                \n

                <Root><\/p>\n\n\n\n\n\n\n
                Name<\/th>\nType<\/th>\nMLt<\/th>\nDescription<\/th>\n<\/tr>\n
                <ObjectTemplates><\/td>\nElmt<\/td>\n0 .. 1<\/td>\nContainer Elmt for object Tmps.<\/td>\n<\/tr>\n
                <StateVariableTemplates><\/td>\nElmt<\/td>\n0 .. 1<\/td>\nContainer Elmt for StateVariable Temps.<\/td>\n<\/tr>\n
                <Node><\/td>\nElmt<\/td>\n1<\/td>\nThe Def of the node.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>
                \n\t\t\t\t\t<\/div>
                <\/div><\/div><\/div><\/div>

                4.<\/span>Node Elements<\/span> <\/span><\/span>
                <\/div>\u2191 Back to Top<\/a><\/h2>
                \n

                <Node><\/p>\n\n\n\n\n\n\n\n
                Name<\/th>\nID \/ Addr<\/th>\nType<\/th>\nMLt<\/th>\nDescription<\/th>\n<\/tr>\n
                TargetDevice<\/td>\nID<\/td>\nAttr<\/td>\n0 .. 1<\/td>\nTarget device used for xTP communication, default value is 0.<\/td>\n<\/tr>\n
                <VirtualDevices><\/td>\nID \/ Addr<\/td>\nElmt<\/td>\n1<\/td>\nContainer Elmt for VirtualDevice Defs.<\/td>\n<\/tr>\n
                <Communication><\/td>\nID \/ Addr<\/td>\nElmt<\/td>\n0 .. 1<\/td>\nSettings used for target device communication.<\/td>\n<\/tr>\n
                <Identification><\/td>\nID<\/td>\nElmt<\/td>\n0 .. 1<\/td>\nElmts used to check if compatible device is connected.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>
                \n\t\t\t\t\t<\/div>
                <\/div><\/div><\/div><\/div>

                4.1.<\/span>Communication Parameters<\/span> <\/span><\/span>
                <\/div>\u2191 Back to Top<\/a><\/h2>
                \n

                <Communication><\/span><\/p>\n\n\n\n\n
                Name<\/td>\nType<\/td>\nMlt<\/td>\nDescription<\/td>\n<\/tr>\n
                <MaxTuningDataSize><\/td>\nElmt<\/td>\n0 .. 1<\/td>\n\n

                Maximum number of bytes Incld in a single tuning data message.<\/p>\n

                Optional: Default value is 64.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>

                \n\t\t\t\t\t<\/div>
                <\/div><\/div><\/div><\/div>

                4.2.<\/span>Identification of Target Device<\/span> <\/span><\/span>
                <\/div>\u2191 Back to Top<\/a><\/h2>

                <Identification><\/p>\n

                Identification of the target device is optional. If at least <Product> exists, a message is sent to the target device to check if the target device matches the device description fil<\/p>\n

                \n\n\n\n\n\n
                Name<\/td>\nType<\/td>\nMlt<\/td>\nDescription<\/td>\n<\/tr>\n
                <Product><\/td>\nElmt<\/td>\n0 .. 1<\/td>\nA unique name of the product.<\/td>\n<\/tr>\n
                <Version><\/td>\nElmt<\/td>\n0 .. 1<\/td>\nThe version of the product. Format x.y<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>
                \n\t\t\t\t\t<\/div>
                <\/div><\/div><\/div><\/div>

                5.<\/span>Virtual Device<\/span> <\/span><\/span>
                <\/div>\u2191 Back to Top<\/a><\/h2>

                <VirtualDevice><\/p>\n

                VirtualDevice with index zero is always the NodeManager and is added automatically.<\/p>\n

                \n\n\n\n\n\n\n\n\n\n\n\n
                Name<\/td>\nID \/ Addr<\/td>\nType<\/td>\nMlt<\/td>\nDescription<\/td>\n<\/tr>\n
                Name<\/td>\nID \/Addr<\/td>\nAttr<\/td>\n1<\/td>\nName of the VirtualDevice.<\/td>\n<\/tr>\n
                TargetDevice<\/td>\nAddr<\/td>\nAttr<\/td>\n0 .. 1<\/td>\nIndex of the target device, which can be a decimal (15) or a hexadecimal (0x0F).<\/td>\n<\/tr>\n
                TargetAddr<\/td>\nAddr<\/td>\nAttr<\/td>\n0 .. 1<\/td>\nBase target device Addr, which can be a decimal (10944) or a hexadecimal (0x2AC0).<\/td>\n<\/tr>\n
                Core<\/td>\nID<\/td>\nAttr<\/td>\n0 .. 1<\/td>\nCore index of the target device. At least one parent of the Object must specify the core ID. Core ID is inherited from the parent Object.<\/td>\n<\/tr>\n
                Instance<\/td>\nID<\/td>\nAttr<\/td>\n0 .. 1<\/td>\nxAF instance index of the target device. At least one parent of the Object must specify the xAF instance ID. The instance ID is inherited from the parent object.<\/td>\n<\/tr>\n
                BlockID<\/td>\nID<\/td>\nAttr<\/td>\n0 .. 1<\/td>\nID of the audio processing block including sub- block ID. Format: xxx.yyy.zzz (xxx is MSB of block ID, yyy is LSB of block ID, zzz is sub-block ID).<\/td>\n<\/tr>\n
                <Objects><\/td>\nID \/Addr<\/td>\nElmt<\/td>\n0 .. 1<\/td>\nContainer for Object<\/em><\/a> Defs.<\/td>\n<\/tr>\n
                <StateVariables><\/td>\nID \/Addr<\/td>\nElmt<\/td>\n0 .. 1<\/td>\nContainer for StateVariables<\/em><\/a> Defs.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>
                \n\t\t\t\t\t<\/div>
                <\/div><\/div><\/div><\/div>

                6.<\/span>Objects<\/span> <\/span><\/span>
                <\/div>\u2191 Back to Top<\/a><\/h2>

                <Objects><\/p>\n

                Objects can be defined in two ways:<\/p>\n