1    /*
     2     *  Copyright 2013 by Texas Instruments Incorporated.
     3     *
     4     */
     5    
     6    /*
     7     * Copyright (c) 2013, Texas Instruments Incorporated
     8     * All rights reserved.
     9     *
    10     * Redistribution and use in source and binary forms, with or without
    11     * modification, are permitted provided that the following conditions
    12     * are met:
    13     *
    14     * *  Redistributions of source code must retain the above copyright
    15     *    notice, this list of conditions and the following disclaimer.
    16     *
    17     * *  Redistributions in binary form must reproduce the above copyright
    18     *    notice, this list of conditions and the following disclaimer in the
    19     *    documentation and/or other materials provided with the distribution.
    20     *
    21     * *  Neither the name of Texas Instruments Incorporated nor the names of
    22     *    its contributors may be used to endorse or promote products derived
    23     *    from this software without specific prior written permission.
    24     *
    25     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    26     * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
    27     * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    28     * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
    29     * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    30     * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    31     * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
    32     * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
    33     * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
    34     * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
    35     * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    36     *
    37     */
    38    
    39    /*
    40     *  ======== Settings.xdc ========
    41     */
    42    
    43    /*!
    44     *  ======== Settings ========
    45     *  Global configuration settings for all Codec Engine packages
    46     *
    47     *  This module provides high-level configuration settings for all
    48     *  Codec Engine packages.
    49     *
    50     *  @a(Linking with Codec Engine Libraries)
    51     *
    52     *  When linking an executable, this module's profile config param is
    53     *  used to select which libraries are used. See the {@link #profile}
    54     *  config param below. There are three typical use-cases.
    55     *
    56     *  1. Link with Codec Engine libraries of a specific profile. Add the
    57     *  following to your application cfg script.
    58     *
    59     *  @p(code)
    60     *  // set all codec engine libraries to the given profile
    61     *  xdc.useModule('ti.sdo.ce.global.Settings').profile = "debug";
    62     *  @p
    63     *
    64     *  2. Link with Codec Engine libraries using the program's profile. Add
    65     *  the following to your application cfg script.
    66     *
    67     *  @p(code)
    68     *  // use the program's profile
    69     *  var Program = xdc.useModule('xdc.cfg.Program');
    70     *  xdc.useModule('ti.sdo.ce.global.Settings').profile = Program.build.profile;
    71     *  @p
    72     *
    73     *  3. Specify a profile on a per-package basis.
    74     *
    75     *  @p(code)
    76     *  // specify the profile for some select packages
    77     *  xdc.loadPackage('ti.sdo.ce').profile = "debug";
    78     *  xdc.loadPackage('ti.sdo.ce.video').profile = "debug";
    79     *  xdc.loadPackage('ti.sdo.ce.image').profile = "debug";
    80     *  xdc.loadPackage('ti.sdo.ce.speech').profile = "debug";
    81     *  xdc.loadPackage('ti.sdo.ce.audio').profile = "debug";
    82     *  @p
    83     *
    84     *  Note that the third method above does not actually use the `profile`
    85     *  config param. It sets the package's profile config param directly.
    86     *
    87     *  The default value for the `profile` config param is `release`.
    88     *  Thus, even when building your executable using a debug profile, the
    89     *  Codec Engine release libraries will be used. This helps to keep the
    90     *  executable size smaller when you want to debug the application code.
    91     */
    92    metaonly module Settings
    93    {
    94        /*!
    95         *  ======== profile ========
    96         *  Name the library profile to use at link time
    97         *
    98         *  If the Codec Engine libraries have been built using the profile
    99         *  named by this config param, then these libraries will be used
   100         *  when linking the final executable. Otherwise, a substitute
   101         *  library will be used. For example, if this config param is set to
   102         *  debug but there are only release libraries available, then the
   103         *  release library is used.
   104         */
   105        config String profile = "release";
   106    }
   107    /*
   108     *  @(#) ti.sdo.ce.global; 1, 0, 0,3; 6-13-2013 00:15:37; /db/atree/library/trees/ce/ce-w08/src/ xlibrary
   109    
   110     */
   111