[ivimm/ipumm.git] / extrel / ti / ivahd_codecs / packages / ti / sdo / codecs / mpeg4vdec / ce / package / package.doc.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <package kind='package' name='ti.sdo.codecs.mpeg4vdec.ce' nodoc='0' root='../../../../../' summary='Provides+ICodec+interface+adapter+for+ti.sdo.codecs.mpeg4vdec+codec'>
3 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Erequires%3C%2Fspan%3E+%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2Fvideo3%2Fpackage.html%22+title%3D%22ti.sdo.ce.video3%22%3Eti.sdo.ce.video3%3C%2Fa%3E%3B'/>
4 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Erequires%3C%2Fspan%3E+%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fcodecs%2Fmpeg4vdec%2Fpackage.html%22+title%3D%22ti.sdo.codecs.mpeg4vdec%22%3Eti.sdo.codecs.mpeg4vdec%3C%2Fa%3E%3B'/>
5 <line blank='1' always='0'/>
6 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Epackage%3C%2Fspan%3E+%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3Eti.sdo.codecs.mpeg4vdec.ce%3C%2Fspan%3E%3C%2Fgo%3E+%5B1%2C+0%2C+0%5D+%7B'/>
7 <line tab='0' content='%7D'/>
8 <unit name='MPEG4VDEC' kind='module' nodoc='0' metaonly='1' summary='MPEG4VDEC+codec+specification' inherits='ti.sdo.ce.video3.IVIDDEC3'>
9 <synopSpec>
10 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Epackage%3C%2Fspan%3E+%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fcodecs%2Fmpeg4vdec%2Fce%2Fpackage.html%22+title%3D%22ti.sdo.codecs.mpeg4vdec.ce%22%3Eti.sdo.codecs.mpeg4vdec.ce%3C%2Fa%3E%3B'/>
11 <line blank='1' always='0'/>
12 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Emetaonly+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Emodule%3C%2Fspan%3E+%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EMPEG4VDEC%3C%2Fspan%3E%3C%2Fgo%3E%3Cspan+class%3D%22xdoc-kw1%22%3E+inherits+%3C%2Fspan%3E%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2Fvideo3%2FIVIDDEC3.html%22+title%3D%22ti.sdo.ce.video3.IVIDDEC3%22%3EIVIDDEC3%3C%2Fa%3E+%7B'/>
13 <line tab='0' content='%7D'/>
14 </synopSpec>
15 <specInfo>
16 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Emetaonly+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Emodule%3C%2Fspan%3E+%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EMPEG4VDEC%3C%2Fspan%3E%3C%2Fgo%3E+%7B%3Cb%3E%26nbsp%3B%26nbsp%3B...%3C%2Fb%3E'/>
17 <line tab='0' comment='inherits+%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2Fvideo3%2FIVIDDEC3.html%22+title%3D%22ti.sdo.ce.video3.IVIDDEC3%22%3Eti.sdo.ce.video3.IVIDDEC3%3C%2Fa%3E'/>
18 <line tab='1' comment='inherits+%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2FICodec.html%22+title%3D%22ti.sdo.ce.ICodec%22%3Eti.sdo.ce.ICodec%3C%2Fa%3E'/>
19 </specInfo>
20 <synopMeta>
21 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Evar%3C%2Fspan%3E+MPEG4VDEC+%3D+%3Cspan+class%3D%22xdoc-kw3%22%3Exdc.useModule%3C%2Fspan%3E%28%3Cspan+class%3D%22xdoc-id%22%3E%27ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC%27%3C%2Fspan%3E%29%3B'/>
22 </synopMeta>
23 <docSect name='details'>
24 <docPara content='This+file+specifies+information+necessary+to+integrate+with+the+Codec%0A++Engine.'/>
25 <docPara content='By+inheriting+ti.sdo.ce.video3.IVIDDEC3%2C+MPEG4VDEC+declares+that+it+%22is%0A++a%22+video3+algorithm.++This+allows+the+codec+engine+to+automatically%0A++supply+simple+stubs+and+skeletons+for+transparent+execution+of+DSP%0A++codecs+by+the+GPP.'/>
26 <docPara content='In+addition+to+declaring+the+type+of+the+MPEG4VDEC+algorithm%2C+we%0A++declare+the+external+symbol+required+by+xDAIS+that+identifies+the%0A++algorithms+implementation+functions.'/>
27 </docSect>
28 <group name='module-wide constants & types'>
29 <decl spacer='1'/>
30 </group>
31 <group name='module-wide config parameters'>
32 <decl spacer='1'/>
33 <decl kind='config' name='alg' anchor='alg' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.alg' nodoc='0' external='1' overrides='0' readonly='1' instance='0' summary=''>
34 <synopSpec>
35 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Ereadonly+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Econfig%3C%2Fspan%3E+%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fcodecs%2Fmpeg4vdec%2FMPEG4VDEC.html%23.Module%22+title%3D%22ti.sdo.codecs.mpeg4vdec.MPEG4VDEC.Module%22%3EMPEG4VDEC.Module%3C%2Fa%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3Ealg%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%253Ca%2Bclass%253D%2522xdoc-link%2522%2Bhref%253D%2522..%252F..%252F..%252F..%252F..%252Fti%252Fsdo%252Fcodecs%252Fmpeg4vdec%252FMPEG4VDEC.html%2523module%2522%2Btitle%253D%2522ti.sdo.codecs.mpeg4vdec.MPEG4VDEC.module%2522%253EMPEG4VDEC.module%253C%252Fa%253E%3B'/>
36 </synopSpec>
37 <synopMeta>
38 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econst%3C%2Fspan%3E+%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3Ealg%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%3Ci%3E%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fcodecs%2Fmpeg4vdec%2FMPEG4VDEC.html%23.Module%22+title%3D%22ti.sdo.codecs.mpeg4vdec.MPEG4VDEC.Module%22%3EMPEG4VDEC.Module%3C%2Fa%3E%3C%2Fi%3E+%253Ca%2Bclass%253D%2522xdoc-link%2522%2Bhref%253D%2522..%252F..%252F..%252F..%252F..%252Fti%252Fsdo%252Fcodecs%252Fmpeg4vdec%252FMPEG4VDEC.html%2523module%2522%2Btitle%253D%2522ti.sdo.codecs.mpeg4vdec.MPEG4VDEC.module%2522%253EMPEG4VDEC.module%253C%252Fa%253E%3B'/>
39 </synopMeta>
40 </decl>
41 <decl kind='config' name='codecClassConfigurable' anchor='codec.Class.Configurable' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.codecClassConfigurable' nodoc='1' external='1' overrides='1' readonly='1' instance='0' summary='' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2Fvideo3%2FIVIDDEC3.html%23codec.Class.Configurable%22+title%3D%22ti.sdo.ce.video3.IVIDDEC3.codecClassConfigurable%22%3EIVIDDEC3%3C%2Fa%3E'>
42 <synopSpec>
43 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Eoverride+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Ereadonly+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Econfig%3C%2Fspan%3E+%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EcodecClassConfigurable%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%3B'/>
44 </synopSpec>
45 <synopMeta>
46 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econst%3C%2Fspan%3E+%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3EcodecClassConfigurable%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%3C%2Fi%3E+%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%3B'/>
47 </synopMeta>
48 </decl>
49 <decl kind='config' name='frameRate' anchor='frame.Rate' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.frameRate' nodoc='1' external='1' overrides='0' readonly='1' instance='0' summary='Smallest+supported+frame+rate+%28frames+%2F+second%29' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2FICodec.html%23frame.Rate%22+title%3D%22ti.sdo.ce.ICodec.frameRate%22%3EICodec%3C%2Fa%3E'>
50 <synopSpec>
51 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Ereadonly+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Econfig%3C%2Fspan%3E+%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EframeRate%3C%2Fspan%3E%3C%2Fgo%3E%3B'/>
52 </synopSpec>
53 <synopMeta>
54 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econst%3C%2Fspan%3E+%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3EframeRate%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%3C%2Fi%3E+%3Ci%3Ecomputed+value%3C%2Fi%3E%3B'/>
55 </synopMeta>
56 <docSect name='details'>
57 <docPara content='This+is+used+to+compute+a+default+priority+assignment+for+algorithm%0A++threads+in+a+DSP+Server.'/>
58 </docSect>
59 </decl>
60 <decl kind='config' name='ialgFxns' anchor='ialg.Fxns' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.ialgFxns' nodoc='0' external='1' overrides='1' readonly='1' instance='0' summary='Name+of+xDAIS+alg+function+table' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2FICodec.html%23ialg.Fxns%22+title%3D%22ti.sdo.ce.ICodec.ialgFxns%22%3EICodec%3C%2Fa%3E'>
61 <synopSpec>
62 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Eoverride+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Ereadonly+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Econfig%3C%2Fspan%3E+%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EialgFxns%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%2522MPEG4VDEC_TI_IMPEG4VDEC%2522%3B'/>
63 </synopSpec>
64 <synopMeta>
65 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econst%3C%2Fspan%3E+%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3EialgFxns%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%3C%2Fi%3E+%2522MPEG4VDEC_TI_IMPEG4VDEC%2522%3B'/>
66 </synopMeta>
67 <docSect name='details'>
68 <docPara content='All+xDAIS+algorithms+must+define+an+IALG_Fxns+structure+that%0A++contains+implementations+of+the+IALG+methods.++This+configuration%0A++parameter+is+simply+the+extern+name+of+this+structure.'/>
69 </docSect>
70 </decl>
71 <decl kind='config' name='idma3Fxns' anchor='idma3.Fxns' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.idma3Fxns' nodoc='0' external='1' overrides='0' readonly='1' instance='0' summary='Name+of+xDAIS+alg+IDMA3+Interface+function+table' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2FICodec.html%23idma3.Fxns%22+title%3D%22ti.sdo.ce.ICodec.idma3Fxns%22%3EICodec%3C%2Fa%3E'>
72 <synopSpec>
73 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Ereadonly+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Econfig%3C%2Fspan%3E+%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3Eidma3Fxns%3C%2Fspan%3E%3C%2Fgo%3E%3B'/>
74 </synopSpec>
75 <synopMeta>
76 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econst%3C%2Fspan%3E+%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3Eidma3Fxns%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%3C%2Fi%3E+%3Ci%3Ecomputed+value%3C%2Fi%3E%3B'/>
77 </synopMeta>
78 <docSect name='details'>
79 <docPara content='All+xDAIS+algorithms+that+use+DMA+must+define+an+IDMA3_Fxns+structure%0A++containing+the+pointers+to+functions+implementatng+the+IDMA3+interface.%0A++If+algorithm+does+not+use+DMA+this+structure+does+not+have+to+be%0A++defined.'/>
80 <docPara content='This+configuration+parameter+is+simply+the+extern+name+of+this%0A++structure+when+defined%2C+null+otherwise.'/>
81 </docSect>
82 </decl>
83 <decl kind='config' name='iresFxns' anchor='ires.Fxns' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.iresFxns' nodoc='0' external='1' overrides='1' readonly='1' instance='0' summary='Name+of+xDAIS+alg+IRES+Interface+function+table' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2FICodec.html%23ires.Fxns%22+title%3D%22ti.sdo.ce.ICodec.iresFxns%22%3EICodec%3C%2Fa%3E'>
84 <synopSpec>
85 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Eoverride+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Ereadonly+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Econfig%3C%2Fspan%3E+%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EiresFxns%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%2522MPEG4VDEC_TI_IRES%2522%3B'/>
86 </synopSpec>
87 <synopMeta>
88 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econst%3C%2Fspan%3E+%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3EiresFxns%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%3C%2Fi%3E+%2522MPEG4VDEC_TI_IRES%2522%3B'/>
89 </synopMeta>
90 <docSect name='details'>
91 <docPara content='All+xDAIS+algorithms+that+use+an+IRES+resource+must+define+an%0A++IRES_Fxns+structure+containing+the+pointers+to+functions%0A++implementatng+the+IRES+interface.%0A++If+algorithm+does+not+use+an+IRES+resource+this+structure+does+not%0A++have+to+be+defined.'/>
92 <docPara content='This+configuration+parameter+is+simply+the+extern+name+of+this%0A++structure+when+defined%2C+null+otherwise.'/>
93 </docSect>
94 <docSect name='see'>
95 <docPara content='%3Ca+class%3D%22xdoc-link%22+href%3D%22MPEG4VDEC.html%23ialg.Fxns%22+title%3D%22ialgFxns%22%3EialgFxns%3C%2Fa%3E%2C+%3Ca+class%3D%22xdoc-link%22+href%3D%22MPEG4VDEC.html%23idma3.Fxns%22+title%3D%22idma3Fxns%22%3Eidma3Fxns%3C%2Fa%3E'/>
96 </docSect>
97 </decl>
98 <decl kind='config' name='rpcProtocolVersion' anchor='rpc.Protocol.Version' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.rpcProtocolVersion' nodoc='0' external='1' overrides='1' readonly='1' instance='0' summary='Version+of+the+Protocol+used+between+the+stubFxns+and+the+serverFxns' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2Fvideo3%2FIVIDDEC3.html%23rpc.Protocol.Version%22+title%3D%22ti.sdo.ce.video3.IVIDDEC3.rpcProtocolVersion%22%3EIVIDDEC3%3C%2Fa%3E'>
99 <synopSpec>
100 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Eoverride+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Ereadonly+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Econfig%3C%2Fspan%3E+%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3ErpcProtocolVersion%3C%2Fspan%3E%3C%2Fgo%3E+%3D+0%3B'/>
101 </synopSpec>
102 <synopMeta>
103 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econst%3C%2Fspan%3E+%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3ErpcProtocolVersion%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%3C%2Fi%3E+0%3B'/>
104 </synopMeta>
105 <docSect name='details'>
106 <docPara content='This+is+set+by+a+particular+implementation+of+a+stub%2Fskeleton+RPC+pair%2C%0A++and+is+used+at+runtime+to+ensure+the+protocol+matches.++This+is%0A++important%2C+for+example%2C+to+ensure+that+the+protocol+used+by+skeletons%0A++built+into+a+server+matches+that+used+by+the+stubs+built+into+the%0A++application.++Specifically%2C+this+is+typically+changed+when+the%0A++marshalling%2Funmarshalling+message+format+changes.'/>
107 <docPara content='This+is+generally+not+configured+by+application+or+server+config%0A++scripts%2C+but+rather+by+developers+of+VISA-like+API+class+extensions.'/>
108 <docPara content='This+rpcProtocolVersion+is+built+into+the+local+application+executable%2C%0A++as+well+as+the+remote+server%27s+executable.'/>
109 <docPara content='Developers+of+class+extensions+should+ensure+this+config+parameter+is%0A++set+appropriately+by+each+release+of+their+stubs%2Fskeletons.++If+a+new%0A++protocol+is+introduced%2C+implying+that+updating+both+would+result+in%0A++error%2C+the+number+should+be+incremented.'/>
110 <docPara content='There+is+no+%22backward-compatibility%22+requirement+in+rpcProtocolVersion.%0A++If+the+version+is+different%2C+regardless+of+whether+it%27s+larger+or%0A++smaller%2C+the+creation+of+algorithms+of+this+class+will+fail.'/>
111 </docSect>
112 </decl>
113 <decl spacer='1'/>
114 <decl spacer='1'/>
115 <decl kind='config' name='isLocal' anchor='is.Local' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.isLocal' nodoc='1' external='1' overrides='0' readonly='0' instance='0' summary='Require+this+codec+to+run+%22locally%22' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2FICodec.html%23is.Local%22+title%3D%22ti.sdo.ce.ICodec.isLocal%22%3EICodec%3C%2Fa%3E'>
116 <synopSpec>
117 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econfig%3C%2Fspan%3E+%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EisLocal%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%3B'/>
118 </synopSpec>
119 <synopMeta>
120 <line tab='0' content='%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3EisLocal%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%3C%2Fi%3E+%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%3B'/>
121 </synopMeta>
122 <docSect name='details'>
123 <docPara content='This+configuration+parameter+determines+whether+or+not+the%0A++application+requires+the+codec%27s+library+in+order+to+link.%0A++For+example%2C+this+parameter+is+set+to+false+in+the+case+that%0A++the+application+is+running+on+a+different+CPU+than+the+codec.'/>
124 </docSect>
125 </decl>
126 <decl kind='config' name='manageInBufsCache' anchor='manage.In.Bufs.Cache' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.manageInBufsCache' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='Codec+Class+configuration+param' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2Fvideo3%2FIVIDDEC3.html%23manage.In.Bufs.Cache%22+title%3D%22ti.sdo.ce.video3.IVIDDEC3.manageInBufsCache%22%3EIVIDDEC3%3C%2Fa%3E'>
127 <synopSpec>
128 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econfig%3C%2Fspan%3E+%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EmanageInBufsCache%3C%2Fspan%3E%3C%2Fgo%3E%5B16%5D+%3D+%255B'/>
129 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
130 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
131 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
132 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
133 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
134 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
135 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
136 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
137 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
138 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
139 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
140 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
141 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
142 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
143 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
144 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E'/>
145 <line tab='0' content='%255D%3B'/>
146 </synopSpec>
147 <synopMeta>
148 <line tab='0' content='%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3EmanageInBufsCache%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%5B16%5D%3C%2Fi%3E+%255B'/>
149 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
150 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
151 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
152 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
153 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
154 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
155 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
156 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
157 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
158 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
159 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
160 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
161 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
162 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
163 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
164 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E'/>
165 <line tab='0' content='%255D%3B'/>
166 </synopMeta>
167 <docSect name='details'>
168 <docPara content='Determines+whether+cache+will+be+managed+on+the+DSP+for+each+of+the%0A++%28up+to+16%29+input+buffers+given+to+the+codec%27s+%22process%28%29%22+call.'/>
169 <docPara content='If+this+flag+is+set+to+%22false%22+for+one+or+more%0A++elements%2C+the+cache+for+the+corresponding+input+buffer+will+not+be%0A++invalidated+before+the+process%28%29+call.+Skipping+unnecessary+cache%0A++invalidation+improves+performance%2C+especially+if+a+buffer+is+large.'/>
170 <docPara content='%28If+element+%22i%22+in+this+array+is+set+to+true%2C+cache+for+inBufs%5Bi%5D+will%0A++be+invalidated+only+if+the+buffer+is+supplied%2C+of+course.%29'/>
171 <docPara content='For+example%2C+if+you+know+that+a+particular+codec+of+this+class+always%0A++reads+the+data+from+its+inBufs%5B1%5D+buffer+only+via+DMA%2C+you+can+set%0A++manageInBufsCache%5B1%5D+%3D+false%3B'/>
172 </docSect>
173 </decl>
174 <decl kind='config' name='manageOutBufsCache' anchor='manage.Out.Bufs.Cache' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.manageOutBufsCache' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='Codec+Class+configuration+param' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2Fvideo3%2FIVIDDEC3.html%23manage.Out.Bufs.Cache%22+title%3D%22ti.sdo.ce.video3.IVIDDEC3.manageOutBufsCache%22%3EIVIDDEC3%3C%2Fa%3E'>
175 <synopSpec>
176 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econfig%3C%2Fspan%3E+%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EmanageOutBufsCache%3C%2Fspan%3E%3C%2Fgo%3E%5B16%5D+%3D+%255B'/>
177 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
178 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
179 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
180 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
181 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
182 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
183 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
184 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
185 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
186 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
187 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
188 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
189 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
190 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
191 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
192 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E'/>
193 <line tab='0' content='%255D%3B'/>
194 </synopSpec>
195 <synopMeta>
196 <line tab='0' content='%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3EmanageOutBufsCache%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%5B16%5D%3C%2Fi%3E+%255B'/>
197 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
198 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
199 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
200 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
201 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
202 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
203 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
204 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
205 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
206 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
207 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
208 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
209 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
210 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
211 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E%252C'/>
212 <line tab='1' content='%253Cspan%2Bclass%253D%2522xdoc-kw2%2522%253Etrue%253C%252Fspan%253E'/>
213 <line tab='0' content='%255D%3B'/>
214 </synopMeta>
215 <docSect name='details'>
216 <docPara content='Determines+whether+cache+will+be+managed+on+the+DSP+for+each+of+the%0A++%28up+to+16%29+output+buffers+given+to+the+codec%27s+%22process%28%29%22+call.'/>
217 <docPara content='If+this+flag+is+set+to+%22false%22+for+one+or+more%0A++elements%2C+the+cache+for+the+corresponding+output+buffer+will+not+be%0A++invalidated+before+the+process%28%29+call.%0A++Skipping+unnecessary+cache+invalidation+improves%0A++performance.+Whether+the+buffer+will+be+written+back+after+the+process%28%29%0A++call+depends+on+the+algorithm+and+cannot+be+controlled+here.'/>
218 <docPara content='For+example%2C+if+you+know+that+a+particular+codec+of+this+class+always%0A++writes+the+data+to+its+outBufs%5B2%5D+buffer+only+via+DMA%2C+you+can+set%0A++manageOutBufsCache%5B2%5D+%3D+false%3B'/>
219 </docSect>
220 </decl>
221 <decl kind='config' name='serverFxns' anchor='server.Fxns' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.serverFxns' nodoc='0' external='1' overrides='1' readonly='0' instance='0' summary='Name+of+skeleton+fxn+table' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2Fvideo3%2FIVIDDEC3.html%23server.Fxns%22+title%3D%22ti.sdo.ce.video3.IVIDDEC3.serverFxns%22%3EIVIDDEC3%3C%2Fa%3E'>
222 <synopSpec>
223 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Eoverride+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Econfig%3C%2Fspan%3E+%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EserverFxns%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%2522VIDDEC3_SKEL%2522%3B'/>
224 </synopSpec>
225 <synopMeta>
226 <line tab='0' content='%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3EserverFxns%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%3C%2Fi%3E+%2522VIDDEC3_SKEL%2522%3B'/>
227 </synopMeta>
228 <docSect name='details'>
229 <docPara content='All+algorithm%27s+that+can+run+on+a+remote+processor+must+specify+a+set%0A++of+%22stub%22+functions+that+marshall+arguments+to+send+to+the+remote%0A++process+that+runs+corresponding+%22skeletons%22+to+do+the+actual%0A++processing.++This+configuration+parameter+defines+the+entry+point+for%0A++this+algorithm%27s+the+skeletons+%28which+run+on+the+remote+processor%29.'/>
230 <docPara content='This+is+generally+not+configured+by+application+or+server+config%0A++scripts%2C+but+rather+by+developers+of+VISA-like+API+class+extensions.%0A++However%2C+an+application+or+server+integrator+could+use+this+config%0A++param+to+configure+in+custom+serverFxns.'/>
231 </docSect>
232 <docSect name='see'>
233 <docPara content='%3Ca+class%3D%22xdoc-link%22+href%3D%22MPEG4VDEC.html%23stub.Fxns%22+title%3D%22stubFxns%22%3EstubFxns%3C%2Fa%3E'/>
234 </docSect>
235 </decl>
236 <decl kind='config' name='stubFxns' anchor='stub.Fxns' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.stubFxns' nodoc='0' external='1' overrides='1' readonly='0' instance='0' summary='Name+of+stubs+fxn+table' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2Fvideo3%2FIVIDDEC3.html%23stub.Fxns%22+title%3D%22ti.sdo.ce.video3.IVIDDEC3.stubFxns%22%3EIVIDDEC3%3C%2Fa%3E'>
237 <synopSpec>
238 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Eoverride+%3C%2Fspan%3E%3Cspan+class%3D%22xdoc-kw1%22%3Econfig%3C%2Fspan%3E+%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EstubFxns%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%2522VIDDEC3_STUBS%2522%3B'/>
239 </synopSpec>
240 <synopMeta>
241 <line tab='0' content='%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3EstubFxns%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EString%3C%2Fspan%3E%3C%2Fi%3E+%2522VIDDEC3_STUBS%2522%3B'/>
242 </synopMeta>
243 <docSect name='details'>
244 <docPara content='All+algorithm%27s+that+can+run+on+a+remote+processor+must+specify+a+set%0A++of+%22stub%22+functions+that+marshall+arguments+to+send+to+the+remote%0A++process+that+runs+corresponding+%22skeletons%22+to+do+the+actual%0A++processing.++This+configuration+parameter+defines+the+entry+point+for%0A++this+algorithm%27s+the+stubs+%28which+run+on+the+local+processor%29.'/>
245 <docPara content='This+is+generally+not+configured+by+application+or+server+config%0A++scripts%2C+but+rather+by+developers+of+VISA-like+API+class+extensions.%0A++However%2C+an+application+or+server+integrator+could+use+this+config%0A++param+to+configure+in+custom+stubFxns.'/>
246 </docSect>
247 <docSect name='see'>
248 <docPara content='%3Ca+class%3D%22xdoc-link%22+href%3D%22MPEG4VDEC.html%23server.Fxns%22+title%3D%22serverFxns%22%3EserverFxns%3C%2Fa%3E'/>
249 </docSect>
250 </decl>
251 <decl kind='config' name='useCache' anchor='use.Cache' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.useCache' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='Flag+indicating+whether+the+framework+should+provide+cached+memory' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2FICodec.html%23use.Cache%22+title%3D%22ti.sdo.ce.ICodec.useCache%22%3EICodec%3C%2Fa%3E'>
252 <synopSpec>
253 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econfig%3C%2Fspan%3E+%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EuseCache%3C%2Fspan%3E%3C%2Fgo%3E%3B'/>
254 </synopSpec>
255 <synopMeta>
256 <line tab='0' content='%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3EuseCache%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EBool%3C%2Fspan%3E%3C%2Fi%3E+%3Cspan+class%3D%22xdoc-kw2%22%3Eundefined%3C%2Fspan%3E%3B'/>
257 </synopMeta>
258 <docSect name='details'>
259 <docPara content='If+set+to+true%2C+the+alg%27s+memory+requests+will+be+allocated+from%0A++cacheable+memory.++If+set+to+false%2C+the+memory+will+be+allocated+from%0A++non-cached+memory.+If+left+unset%2C+the%0A++ti.sdo.ce.alg.Algorithm.useCache+flag+will+determine+whether+the%0A++alg%27s+memory+will+be+allocated+from+cached+or+non-cached+memory.'/>
260 </docSect>
261 </decl>
262 <decl kind='config' name='uuid' anchor='uuid' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.uuid' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='Unique+algorithm+implementation+ID' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2FICodec.html%23uuid%22+title%3D%22ti.sdo.ce.ICodec.uuid%22%3EICodec%3C%2Fa%3E'>
263 <synopSpec>
264 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw1%22%3Econfig%3C%2Fspan%3E+%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3Euuid%3C%2Fspan%3E%3C%2Fgo%3E%3B'/>
265 </synopSpec>
266 <synopMeta>
267 <line tab='0' content='%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3Euuid%3C%2Fspan%3E%3C%2Fgo%3E+%3D+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%3C%2Fi%3E+%3Cspan+class%3D%22xdoc-kw2%22%3Eundefined%3C%2Fspan%3E%3B'/>
268 </synopMeta>
269 <docSect name='details'>
270 <docPara content='This+integer+must+be+a+unique+ID+for+every+algorithm+in+a+%22system%22%2C%0A++where+the+%22system%22+includes+all+possible+DSP+Servers.'/>
271 <docPara content='This+id+is+used+by+the+Codec+Engine+APIs+to+identify+the+algorithm%0A++implementation+that+will+create+an+instance+on+a+DSP+Server.'/>
272 <docPara content='If+a+codec+doesn%27t+explicitly+configure+this+parameter%2C+a+%22very+likely%0A++unique%22+ID+will+be+generated.++It+is+recommended+that+codecs+not%0A++explicitly+configure+this+parameter%2C+and+leave+it+to+the+system.'/>
273 </docSect>
274 </decl>
275 </group>
276 <group name='module-wide functions'>
277 <decl spacer='1'/>
278 <decl kind='fxn' name='getCreationStackSize' anchor='get.Creation.Stack.Size' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.getCreationStackSize' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='Get+the+maximum+required+stack+size+%28in+octets%29+for+this+algorithm%0A++during+algorithm+instance+creation' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2FICodec.html%23get.Creation.Stack.Size%22+title%3D%22ti.sdo.ce.ICodec.getCreationStackSize%22%3EICodec%3C%2Fa%3E'>
279 <synopSpec>
280 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetCreationStackSize%3C%2Fspan%3E%3C%2Fgo%3E%28+%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fxdc%2Fcfg%2FProgram.html%23.Module%22+title%3D%22xdc.cfg.Program.Module%22%3EProgram.Module%3C%2Fa%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3Eprog%3C%2Fspan%3E%3C%2Fgo%3E+%29%3B'/>
281 </synopSpec>
282 <synopMeta>
283 <line tab='0' content='%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3EgetCreationStackSize%3C%2Fspan%3E%3C%2Fgo%3E%28+%3Ci%3E%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fxdc%2Fcfg%2FProgram.html%23.Module%22+title%3D%22xdc.cfg.Program.Module%22%3EProgram.Module%3C%2Fa%3E%3C%2Fi%3E+%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3Eprog%3C%2Fspan%3E%3C%2Fgo%3E+%29+%3Ci%3Ereturns%3C%2Fi%3E+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%3C%2Fi%3E'/>
284 </synopMeta>
285 <docSect name='details'>
286 <docPara content='This+method+is+called+during+DSP+Server+configuration+and+is+used+to%0A++ensure+that+the+instance+creation+thread+on+the+server+has+sufficient%0A++stackspace+to+instantiate+the+algorithm.++This+stack+size+is+typically%0A++the+greater+of+the+stack+sizes+required+by+the+algorithm%27s%0A++algNumAlloc%28%29%2C+algAlloc%28%29%2C+or+algInit%28%29+methods.'/>
287 </docSect>
288 </decl>
289 <decl kind='fxn' name='getDaramScratchSize' anchor='get.Daram.Scratch.Size' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.getDaramScratchSize' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='Get+the+maximum+scratch+size+%28in+octets%29+required+for+this+algorithm%0A++from+DARAM+space' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2FICodec.html%23get.Daram.Scratch.Size%22+title%3D%22ti.sdo.ce.ICodec.getDaramScratchSize%22%3EICodec%3C%2Fa%3E'>
290 <synopSpec>
291 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetDaramScratchSize%3C%2Fspan%3E%3C%2Fgo%3E%28+%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fxdc%2Fcfg%2FProgram.html%23.Module%22+title%3D%22xdc.cfg.Program.Module%22%3EProgram.Module%3C%2Fa%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3Eprog%3C%2Fspan%3E%3C%2Fgo%3E+%29%3B'/>
292 </synopSpec>
293 <synopMeta>
294 <line tab='0' content='%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3EgetDaramScratchSize%3C%2Fspan%3E%3C%2Fgo%3E%28+%3Ci%3E%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fxdc%2Fcfg%2FProgram.html%23.Module%22+title%3D%22xdc.cfg.Program.Module%22%3EProgram.Module%3C%2Fa%3E%3C%2Fi%3E+%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3Eprog%3C%2Fspan%3E%3C%2Fgo%3E+%29+%3Ci%3Ereturns%3C%2Fi%3E+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%3C%2Fi%3E'/>
295 </synopMeta>
296 <docSect name='details'>
297 <docPara content='This+method+is+called+during+DSP+Server+configuration+and+is+used+to%0A++ensure+that+sufficient+scratch+space+is+configured+for+the+specified%0A++set+of+algorithms.'/>
298 </docSect>
299 </decl>
300 <decl kind='fxn' name='getSaramScratchSize' anchor='get.Saram.Scratch.Size' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.getSaramScratchSize' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='Get+the+maximum+scratch+size+%28in+octets%29+required+for+this+algorithm%0A++from+SARAM+space' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2FICodec.html%23get.Saram.Scratch.Size%22+title%3D%22ti.sdo.ce.ICodec.getSaramScratchSize%22%3EICodec%3C%2Fa%3E'>
301 <synopSpec>
302 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetSaramScratchSize%3C%2Fspan%3E%3C%2Fgo%3E%28+%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fxdc%2Fcfg%2FProgram.html%23.Module%22+title%3D%22xdc.cfg.Program.Module%22%3EProgram.Module%3C%2Fa%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3Eprog%3C%2Fspan%3E%3C%2Fgo%3E+%29%3B'/>
303 </synopSpec>
304 <synopMeta>
305 <line tab='0' content='%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3EgetSaramScratchSize%3C%2Fspan%3E%3C%2Fgo%3E%28+%3Ci%3E%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fxdc%2Fcfg%2FProgram.html%23.Module%22+title%3D%22xdc.cfg.Program.Module%22%3EProgram.Module%3C%2Fa%3E%3C%2Fi%3E+%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3Eprog%3C%2Fspan%3E%3C%2Fgo%3E+%29+%3Ci%3Ereturns%3C%2Fi%3E+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%3C%2Fi%3E'/>
306 </synopMeta>
307 <docSect name='details'>
308 <docPara content='This+method+is+called+during+DSP+Server+configuration+and+is+used+to%0A++ensure+that+sufficient+scratch+space+is+configured+for+the+specified%0A++set+of+algorithms.'/>
309 </docSect>
310 </decl>
311 <decl kind='fxn' name='getStackSize' anchor='get.Stack.Size' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.getStackSize' nodoc='0' external='1' overrides='0' readonly='0' instance='0' summary='Get+the+maximum+stack+size+%28in+octets%29+required+for+this+algorithm%0A++during+its+execution+phase' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2FICodec.html%23get.Stack.Size%22+title%3D%22ti.sdo.ce.ICodec.getStackSize%22%3EICodec%3C%2Fa%3E'>
312 <synopSpec>
313 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetStackSize%3C%2Fspan%3E%3C%2Fgo%3E%28+%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fxdc%2Fcfg%2FProgram.html%23.Module%22+title%3D%22xdc.cfg.Program.Module%22%3EProgram.Module%3C%2Fa%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3Eprog%3C%2Fspan%3E%3C%2Fgo%3E+%29%3B'/>
314 </synopSpec>
315 <synopMeta>
316 <line tab='0' content='%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3EgetStackSize%3C%2Fspan%3E%3C%2Fgo%3E%28+%3Ci%3E%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fxdc%2Fcfg%2FProgram.html%23.Module%22+title%3D%22xdc.cfg.Program.Module%22%3EProgram.Module%3C%2Fa%3E%3C%2Fi%3E+%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3Eprog%3C%2Fspan%3E%3C%2Fgo%3E+%29+%3Ci%3Ereturns%3C%2Fi%3E+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%3C%2Fi%3E'/>
317 </synopMeta>
318 <docSect name='details'>
319 <docPara content='This+method+is+called+during+DSP+Server+configuration+and+is+used+to%0A++ensure+that+threads+on+the+server+have+sufficient+stackspace+to+run%0A++the+algorithm.'/>
320 </docSect>
321 </decl>
322 <decl kind='fxn' name='getUUID' anchor='get.U.U.I.D' altext='ti.sdo.codecs.mpeg4vdec.ce.MPEG4VDEC.getUUID' nodoc='1' external='1' overrides='0' readonly='0' instance='0' summary='Get+a+uuid+for+this+codec' origin='%3Ca+class%3D%22xdoc-link%22+href%3D%22..%2F..%2F..%2F..%2F..%2Fti%2Fsdo%2Fce%2FICodec.html%23get.U.U.I.D%22+title%3D%22ti.sdo.ce.ICodec.getUUID%22%3EICodec%3C%2Fa%3E'>
323 <synopSpec>
324 <line tab='0' content='%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%26nbsp%3B%3Cgo%3E%3Cspan+class%3D%22xdoc-id%22%3EgetUUID%3C%2Fspan%3E%3C%2Fgo%3E%28++%29%3B'/>
325 </synopSpec>
326 <synopMeta>
327 <line tab='0' content='%3Cgo%3EMPEG4VDEC.%3Cspan+class%3D%22xdoc-id%22%3EgetUUID%3C%2Fspan%3E%3C%2Fgo%3E%28++%29+%3Ci%3Ereturns%3C%2Fi%3E+%3Ci%3E%3Cspan+class%3D%22xdoc-kw2%22%3EInt%3C%2Fspan%3E%3C%2Fi%3E'/>
328 </synopMeta>
329 <docSect name='details'>
330 <docPara content='This+method+is+used+to+get+the+uuid+rather+than+reading+the+uuid%0A++config+parameter%3B+this+allows+the+algorithm+producer+to+let+the%0A++system+generate+a+uuid+from+the+algorithm%27s+name.'/>
331 <docPara content='Individual+algorithm%27s+should+not+implement+this+methods%3B+the+default%0A++%28base%29+implementation+provided+in+the+ti.sdo.ce+package+should+be%0A++sufficient.'/>
332 </docSect>
333 </decl>
334 </group>
335 </unit>
336 </package>