Added metadata support in circular buffering. Integrated AR and BMDA.
[processor-sdk/performance-audio-sr.git] / readme_demo.txt
1 Update log:
2     06-20-16: Initial version
3     06-27-16: Add information on code installation & build
4     06-30-16: Add note concerning PAF Makefile ROOTDIR variable
5     07-08-16: Add information on UART LLD build
6     07-14-16: Add note concerning <root>
7     08-04-16: Add DDP(JOC), OAR and BMDA
8     
9 NOTE: Below mentioned <root> has only been verified for <root>=c:\ti.
10       Using another <root> will require changes to makefiles (e.g. DDP, Intrinsics)
11       hard-coded to use c:\ti.
12     
13     Code installation:
14         IPC: Unzip ipc_3_43_00_00_eng.zip (contains IPC engineering release) to <root>\ipc_3_43_00_00_eng\.
15         
16         PAF: 
17             Git repo: git@gitorious.design.ti.com:dolby-harmonious/os_paf_dev.git
18             Branch: dev_psdkaudio_qin
19             Commit: 941aaf7
20             
21             Clone Git repo into <root>\procsdk_audio_x_xx_xx_xx\paf\.
22             
23         Dolby Intrinsics: 
24             Git repo: git@gitorious.design.ti.com:dolby-harmonious/intrinsics.git
25             Branch: pp_harmonious_dev
26             Commit: 7c60646
27             
28             Clone Git repo into <root>\procsdk_audio_x_xx_xx_xx\intrinsics\.
29             
30         DDP: 
31             Git repo: git@gitorious.design.ti.com:dolby-harmonious/ddp.git
32             Branch: pp_harmonious_dev
33             Commit: ab55d5b
34             
35             Clone Git repo into <root>\procsdk_audio_x_xx_xx_xx\ddp\.
37         OAR: 
38             Git repo: git@gitorious.design.ti.com:dolby-harmonious/oar.git
39             Branch: dev_psdkaudio_qin
40             Commit: bd93259
41             
42             Clone Git repo into <root>\procsdk_audio_x_xx_xx_xx\oar\.
44         BMDA: 
45             Git repo: git@gitorious.design.ti.com:dolby-harmonious/bmda.git
46             Branch: dev_psdkaudio_qin
47             Commit: 55fada2
48             
49             Clone Git repo into <root>\procsdk_audio_x_xx_xx_xx\bmda\.
52     Build instructions:
53         PAF:
54             Rebuild paf libraries:
55                 1) Update <root>\procsdk_audio_x_xx_xx_xx\setup_env.bat for local environment.
56                 2) Open DOS shell.
57                 3) From DOS prompt, execute:
58                     > setup_env.bat
59                 4) Add ROOTDIR variable pa/build/target.mk, e.g.
60                     export ROOTDIR = C:\ti\procsdk_audio_x_xx_xx_xx\paf
61                 5) Modify ARCH variable in pa/build/target.mk to select c66x target
62                 6) From DOS prompt, execute:
63                     > build_libs.bat DSP
64                 6) Modify ARCH variable in pa/build/target.mk to select a15 target
65                 7) From DOS prompt, execute:
66                     > build_libs.bat ARM
69         DDP:
70             Rebuild DDP libraries:
71                 1) Open DOS prompt
72                 2) cd <root>\ddp\Dolby_Digital_Plus_Decoder_Imp\Source_Code\make\k2g\Wrapper\ddp_library
73                 3) Execute:
74                     > make
75                 3) cd <root>\ddp\Dolby_Digital_Plus_Decoder_Imp\Source_Code\make\k2g\Wrapper\ddp_wrapper
76                 4) From DOS prompt, execute:
77                     > make
78             
79          OAR:
80             Rebuild OAR libraries:
81                 1) Open DOS prompt
82                 2) cd <root>\oar\CCS_OAR_lib\make
83                 3) Execute:
84                     > make
85   
86         BMDA:
87             Rebuild BMDA libraries:
88                 1) Open DOS prompt
89                 2) cd <root>\bmda\Source_Code\make
90                 3) Execute:
91                     > make
92                 
94        UART LLD:
95             1) Open DOS prompt
96             2) cd <root>\pdk_k2g_1_0_1\packages
97             3) Execute:
98                 > pdksetupenv.bat
99             4) cd ti\drv\uart
100             5) Execute:
101                 > gmake all
102             
103         Platform lib:
104             1) Import CCS project into workspace located in <root>\pdk_k2g_1_0_1\packages\ti\platform\evmk2g\platform_lib\.
105             2) Rebuild project, Debug build profile
106             
107         DSP application:
108             1) Import CCS project into workspace located in <root>\procsdk_audio_x_xx_xx_xx\test_dsp\.
109             2) Rebuild project, Debug build profile
110         
111         ARM application:
112             1) Import CCS project into workspace located in <root>\procsdk_audio_x_xx_xx_xx\test_arm\.
113             2) Rebuild project, Debug build profile