Commit | Line | Data |
---|---|---|
e4e13f5b LOK |
1 | This library provides support for the Pulse-Eight USB-CEC adapter. |
2 | ||
a1a112ac LOK |
3 | You can find a list of frequently asked questions on the following page: |
4 | http://libcec.pulse-eight.com/faq | |
5 | ||
0e8ac6a7 | 6 | =============================================================================== |
38280939 | 7 | === Linux & BSD === |
0e8ac6a7 LOK |
8 | =============================================================================== |
9 | ||
10 | libCEC needs the following dependencies in order to work correctly: | |
11 | * udev v151 or later | |
12 | * cdc-acm support compiled into the kernel or available as module | |
4b215264 | 13 | * liblockdev 1.0 or later |
0e8ac6a7 LOK |
14 | |
15 | To compile libCEC on Linux, you'll need the following dependencies: | |
16 | * autoconf 2.13 or later | |
17 | * automake 1.11 or later | |
80feba65 | 18 | * libtool |
0e8ac6a7 | 19 | * gcc 4.2 or later |
4b215264 | 20 | * liblockdev 1.0 development headers |
0e8ac6a7 | 21 | |
2b44051c LOK |
22 | The following dependencies are recommended. Without them, the adapter can not |
23 | be auto-detected. | |
24 | * pkg-config | |
25 | * udev development headers v151 or later | |
26 | ||
0e8ac6a7 | 27 | To compile, execute the following commands: |
38280939 | 28 | # ./bootstrap |
7b85ea89 | 29 | # ./configure |
0e8ac6a7 LOK |
30 | # make |
31 | # sudo make install | |
32 | ||
33 | =============================================================================== | |
34 | === OS-X === | |
35 | =============================================================================== | |
36 | ||
37 | To compile libCEC on OS-X, you'll need the following dependencies: | |
38 | * autoconf 2.13 or later | |
39 | * automake 1.11 or later | |
10ccd54d | 40 | * pkg-config |
4777f253 | 41 | * xcode 3.2.6 or later |
0e8ac6a7 | 42 | |
38280939 LOK |
43 | To compile, execute the following command: |
44 | # ./bootstrap | |
7b85ea89 | 45 | # ./configure |
f5ccf647 LOK |
46 | # make |
47 | # sudo make install | |
abbca718 | 48 | |
4777f253 ME |
49 | # Note: You may need to copy pkg.m4 to your m4 sources directory |
50 | ||
0e8ac6a7 LOK |
51 | =============================================================================== |
52 | === Windows === | |
53 | =============================================================================== | |
54 | ||
58f3d0a9 | 55 | To compile libCEC on Windows, you'll need both Visual Studio 2008 and 2012. |
0e8ac6a7 LOK |
56 | The installer needs the Windows DDK (Driver Development Kit) and Nullsoft's |
57 | NSIS. | |
58 | ||
59 | To compile libCEC, follow these instructions: | |
58f3d0a9 | 60 | * open /project/libcec.sln with Visual Studio 2012. |
f5ccf647 | 61 | * build the project. |
e4e13f5b LOK |
62 | |
63 | To build an installer on Windows: | |
f5ccf647 | 64 | * download and install NSIS. |
9e58420e LOK |
65 | * go to /project and execute create-installer.bat to create the installer. |
66 | * the installer is stored as /build/libCEC-installer.exe | |
abbca718 | 67 | |
29104708 LOK |
68 | =============================================================================== |
69 | === Raspberry Pi === | |
70 | =============================================================================== | |
71 | ||
72 | We've included a script that builds libCEC with support for the Raspberry Pi | |
73 | in /project/RPi/build.sh. This script pulls in the latest toolchain and | |
74 | firmware, builds the necessary dependencies, and finally builds libCEC. The | |
75 | result will be a softfp build. | |
76 | ||
77 | To build libCEc on your development machine, follow these instructions: | |
78 | * run '/project/RPi/build.sh /desired/destination/path/for/binaries' | |
79 | * run 'make install' | |
80 | ||
81 | To build libCEC on the Pi itself, just follow the instructions for Linux. | |
82 | The configure script automatically checks whether the required headers and | |
83 | libraries can be found. | |
84 | ||
85 | To specify the path of the Raspberry Pi's development headers, use the | |
86 | following option for 'configure': | |
87 | --with-rpi-include-path="/path/to/opt/vc/include" | |
88 | ||
89 | To specify the path of the Raspberry Pi's libraries, use the following option | |
90 | for 'configure': | |
91 | --with-rpi-lib-path="/path/to/libbcm_host.so" | |
92 | ||
4d3a7562 | 93 | =============================================================================== |
79e50026 | 94 | === CuBox / TDA995x === |
4d3a7562 | 95 | =============================================================================== |
96 | ||
51b611bc | 97 | Solid-Run's CuBox uses a combined HDMI tranceiver / CEC controller by NXP. The |
98 | device driver for it is based on an SDK by the chip vendor and is compiled into | |
99 | the Linux kernel. The following options for 'configure' have been introduced: | |
4d3a7562 | 100 | |
79e50026 LOK |
101 | To enable support for the CuBox / TDA995x: |
102 | --enable-tda995x | |
4d3a7562 | 103 | |
51b611bc | 104 | To specify the path to the SDK part of the kernel driver: |
105 | --with-tda995x-toolkit-path='path/to/linux/drivers/video/dovefb/nxp_hdmi' | |
4d3a7562 | 106 | |
107 | If the toolkit path is not specified, it is assumed that a directory named | |
108 | 'nxp_hdmi' (or a link to it) exists in the top level of the source tree. | |
109 | ||
0e8ac6a7 LOK |
110 | =============================================================================== |
111 | === Debugging / Testing === | |
112 | =============================================================================== | |
113 | ||
38280939 LOK |
114 | To compile libCEC with extensive debugging output, pass the following argument |
115 | to configure on Linux/OS-X/BSD: | |
116 | --enable-debug | |
117 | ||
0e8ac6a7 LOK |
118 | We provide a test client, named cec-client, to debug the device. |
119 | To check whether the device can be detected, execute the following command: | |
120 | * cec-client -l | |
121 | ||
122 | "cec-client -h" shows a list of commands and options that are available. | |
abbca718 | 123 | |
0e8ac6a7 LOK |
124 | =============================================================================== |
125 | === Developers === | |
126 | =============================================================================== | |
61f3c2ad | 127 | |
0e8ac6a7 LOK |
128 | We provide a C, C++ and .NET CLR interface to the adapter. |
129 | ||
130 | C++ developers: | |
131 | * the API can be found in /include/cec.h | |
132 | * an example implementation can be found in /src/testclient/main.cpp | |
133 | ||
134 | C developers: | |
135 | * the API can be found in /include/cecc.h | |
136 | ||
137 | .NET developers: | |
61f3c2ad | 138 | * add a reference to LibCecSharp.dll |
0e8ac6a7 LOK |
139 | * an example can be found in \src\CecSharpTester\CecSharpClient.cs |
140 | ||
141 | =============================================================================== | |
142 | === Developers Agreement === | |
143 | =============================================================================== | |
cc30d5c9 | 144 | |
0e8ac6a7 LOK |
145 | If you wish to contribute to this project, you must first sign our contributors |
146 | agreement. Please see http://www.pulse-eight.net/contributors for more | |
147 | information. |