Commit | Line | Data |
---|---|---|
e4e13f5b LOK |
1 | This library provides support for the Pulse-Eight USB-CEC adapter. |
2 | ||
0e8ac6a7 LOK |
3 | =============================================================================== |
4 | === Linux === | |
5 | =============================================================================== | |
6 | ||
7 | libCEC needs the following dependencies in order to work correctly: | |
8 | * udev v151 or later | |
9 | * cdc-acm support compiled into the kernel or available as module | |
4b215264 | 10 | * liblockdev 1.0 or later |
0e8ac6a7 LOK |
11 | |
12 | To compile libCEC on Linux, you'll need the following dependencies: | |
13 | * autoconf 2.13 or later | |
14 | * automake 1.11 or later | |
10ccd54d | 15 | * pkg-config |
80feba65 | 16 | * libtool |
0e8ac6a7 LOK |
17 | * udev development headers v151 or later |
18 | * gcc 4.2 or later | |
4b215264 | 19 | * liblockdev 1.0 development headers |
0e8ac6a7 LOK |
20 | |
21 | To compile, execute the following commands: | |
22 | # autoreconf -vif | |
7b85ea89 | 23 | # ./configure |
0e8ac6a7 LOK |
24 | # make |
25 | # sudo make install | |
26 | ||
27 | =============================================================================== | |
28 | === OS-X === | |
29 | =============================================================================== | |
30 | ||
31 | To compile libCEC on OS-X, you'll need the following dependencies: | |
32 | * autoconf 2.13 or later | |
33 | * automake 1.11 or later | |
10ccd54d | 34 | * pkg-config |
4777f253 | 35 | * xcode 3.2.6 or later |
0e8ac6a7 LOK |
36 | |
37 | To compile, execute the following commands (TODO: please verify): | |
f5ccf647 | 38 | # autoreconf -vif |
7b85ea89 | 39 | # ./configure |
f5ccf647 LOK |
40 | # make |
41 | # sudo make install | |
abbca718 | 42 | |
4777f253 ME |
43 | # Note: You may need to copy pkg.m4 to your m4 sources directory |
44 | ||
0e8ac6a7 LOK |
45 | =============================================================================== |
46 | === Windows === | |
47 | =============================================================================== | |
48 | ||
49 | To compile libCEC on Windows, you'll need Visual C++ 2010 or Visual Studio 2010 | |
50 | The installer needs the Windows DDK (Driver Development Kit) and Nullsoft's | |
51 | NSIS. | |
52 | ||
9e58420e LOK |
53 | To compile LibCecSharp on Windows, you'll need Visual C++ 2008 or Visual Studio |
54 | 2008, because it is compiled against .NET 2.0. | |
55 | ||
0e8ac6a7 | 56 | To compile libCEC, follow these instructions: |
f5ccf647 LOK |
57 | * open /project/libcec.sln with Visual C++ 2010 or Visual Studio 2010. |
58 | * build the project. | |
e4e13f5b LOK |
59 | |
60 | To build an installer on Windows: | |
f5ccf647 | 61 | * download and install NSIS. |
9e58420e LOK |
62 | * go to /project and execute create-installer.bat to create the installer. |
63 | * the installer is stored as /build/libCEC-installer.exe | |
abbca718 | 64 | |
4f2c35a3 MK |
65 | You will need both Visual Studio 2008 and Visual Studio 2010 to build the |
66 | installer from the command line. To build with Visual C++ 2008 and 2010, | |
67 | you will need to manually build libcec with Visual C++ 2010 and then | |
68 | build LibCecSharp.sln with Visual Studio 2008. See create-installer.bat | |
69 | for the required steps. | |
70 | ||
0e8ac6a7 LOK |
71 | =============================================================================== |
72 | === Debugging / Testing === | |
73 | =============================================================================== | |
74 | ||
75 | We provide a test client, named cec-client, to debug the device. | |
76 | To check whether the device can be detected, execute the following command: | |
77 | * cec-client -l | |
78 | ||
79 | "cec-client -h" shows a list of commands and options that are available. | |
abbca718 | 80 | |
0e8ac6a7 LOK |
81 | =============================================================================== |
82 | === Developers === | |
83 | =============================================================================== | |
61f3c2ad | 84 | |
0e8ac6a7 LOK |
85 | We provide a C, C++ and .NET CLR interface to the adapter. |
86 | ||
87 | C++ developers: | |
88 | * the API can be found in /include/cec.h | |
89 | * an example implementation can be found in /src/testclient/main.cpp | |
90 | ||
91 | C developers: | |
92 | * the API can be found in /include/cecc.h | |
93 | ||
94 | .NET developers: | |
61f3c2ad | 95 | * add a reference to LibCecSharp.dll |
0e8ac6a7 LOK |
96 | * an example can be found in \src\CecSharpTester\CecSharpClient.cs |
97 | ||
98 | =============================================================================== | |
99 | === Developers Agreement === | |
100 | =============================================================================== | |
cc30d5c9 | 101 | |
0e8ac6a7 LOK |
102 | If you wish to contribute to this project, you must first sign our contributors |
103 | agreement. Please see http://www.pulse-eight.net/contributors for more | |
104 | information. |