1 /*
2 * Copyright (c) 2010, 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 /*
35 * ======== Settings.xdc ========
36 */
37
38 /*!
39 * ======== Settings ========
40 * Global configuration settings for all Codec Engine packages
41 *
42 * This module provides high-level configuration settings for all
43 * Codec Engine packages.
44 *
45 * @a(Linking with Codec Engine Libraries)
46 *
47 * When linking an executable, this module's profile config param is
48 * used to select which libraries are used. See the {@link #profile}
49 * config param below. There are three typical use-cases.
50 *
51 * 1. Link with Codec Engine libraries of a specific profile. Add the
52 * following to your application cfg script.
53 *
54 * @p(code)
55 * // set all codec engine libraries to the given profile
56 * xdc.useModule('ti.sdo.ce.global.Settings').profile = "debug";
57 * @p
58 *
59 * 2. Link with Codec Engine libraries using the program's profile. Add
60 * the following to your application cfg script.
61 *
62 * @p(code)
63 * // use the program's profile
64 * var Program = xdc.useModule('xdc.cfg.Program');
65 * xdc.useModule('ti.sdo.ce.global.Settings').profile = Program.build.profile;
66 * @p
67 *
68 * 3. Specify a profile on a per-package basis.
69 *
70 * @p(code)
71 * // specify the profile for some select packages
72 * xdc.loadPackage('ti.sdo.ce').profile = "debug";
73 * xdc.loadPackage('ti.sdo.ce.video').profile = "debug";
74 * xdc.loadPackage('ti.sdo.ce.image').profile = "debug";
75 * xdc.loadPackage('ti.sdo.ce.speech').profile = "debug";
76 * xdc.loadPackage('ti.sdo.ce.audio').profile = "debug";
77 * @p
78 *
79 * Note that the third method above does not actually use the `profile`
80 * config param. It sets the package's profile config param directly.
81 *
82 * The default value for the `profile` config param is `release`.
83 * Thus, even when building your executable using a debug profile, the
84 * Codec Engine release libraries will be used. This helps to keep the
85 * executable size smaller when you want to debug the application code.
86 */
87 metaonly module Settings
88 {
89 /*!
90 * ======== profile ========
91 * Name the library profile to use at link time
92 *
93 * If the Codec Engine libraries have been built using the profile
94 * named by this config param, then these libraries will be used
95 * when linking the final executable. Otherwise, a substitute
96 * library will be used. For example, if this config param is set to
97 * debug but there are only release libraries available, then the
98 * release library is used.
99 */
100 config String profile = "release";
101 }
102 /*
103 * @(#) ti.sdo.ce.global; 1, 0, 0,103; 12-2-2010 21:23:49; /db/atree/library/trees/ce/ce-r11x/src/ xlibrary
104
105 */
106