Implements desiredInternalSampleRate
[opus.git] / readme.txt
1 ************************************************************************\r
2 Fixed Point SILK SDK 1.0.2 beta source code package\r
3 Copyright 2010 (c), Skype Limited\r
4 https://developer.skype.com/silk/\r
5 ************************************************************************\r
6 \r
7 Date: 09/03/2010 (Format: DD/MM/YYYY)\r
8 \r
9 I. Description\r
10 \r
11 This package contains files for compilation and evaluation of the fixed\r
12 point SILK SDK library. The following is included in this package:\r
13 \r
14     o Source code for the fixed point SILK SDK library\r
15     o Source code for creating encoder and decoder executables\r
16     o Test vectors\r
17     o Comparison tool\r
18     o Microsoft Visual Studio solution and project files\r
19     o Makefile for GNU C-compiler (GCC)\r
20     \r
21 II. Files and Folders\r
22 \r
23     o doc/          - contains more information about the SILK SDK\r
24     o interface/    - contains API header files\r
25     o src/          - contains all SILK SDK library source files\r
26     o test/         - contains source files for testing the SILK SDK\r
27     o test_vectors/ - contains test vectors   \r
28     o Makefile      - Makefile for compiling with GCC\r
29     o readme.txt    - this file\r
30     o Silk_SDK.sln  - Visual Studio solution for all SILK SDK code\r
31 \r
32 III. How to use the Makefile\r
33 \r
34     1. How to clean and compile the SILK SDK library:\r
35           \r
36        make clean lib\r
37  \r
38     2. How to compile an encoder executable:\r
39 \r
40        make encoder\r
41 \r
42     3. How to compile a decoder executable:\r
43 \r
44        make decoder\r
45 \r
46     4. How to compile the comparison tool:\r
47 \r
48        make signalcompare\r
49 \r
50     5. How to clean and compile all of the above:\r
51 \r
52        make clean all\r
53 \r
54     6. How to use the comparison tool:\r
55        \r
56        See 'How to use the test vectors.txt' in the test_vectors folder.        \r
57 \r
58 IV. History\r
59 \r
60     Version 1.0.2 - Updated with various bugfixes and improvements\r
61     Version 1.0.1 - First beta source code release\r
62     \r
63 V. Compatibility\r
64 \r
65     This package has been tested under the following platforms:\r
66 \r
67     Windows XP Home and Professional\r
68     Windows Vista, 32-bit version\r
69     Mac OS X Version 10.5.8\r
70     Ubuntu Linux 9.10, 64-bit version \r
71 \r
72 VI. Known Issues\r
73 \r
74     None\r
75 \r
76 VII. Additional Resources\r
77 \r
78     For more information, visit the SILK SDK web site at:\r
79 \r
80     <https://developer.skype.com/silk/>\r