cosmetics
[deb_libcec.git] / README
CommitLineData
e4e13f5b
LOK
1This library provides support for the Pulse-Eight USB-CEC adapter.
2
a1a112ac
LOK
3You 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
10libCEC 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
15To 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
22The following dependencies are recommended. Without them, the adapter can not
23be auto-detected.
24* pkg-config
25* udev development headers v151 or later
26
0e8ac6a7 27To 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
37To 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
43To 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
e81699ac
LOK
55To compile libCEC on Windows, you'll need Visual Studio 2012 and Visual Studio
56or Visual C++ 2008. The latter is needed to build LibCecSharp for .Net
57Framework 2.0.
58
59The adapter detection code needs the Windows DDK (Driver Development Kit).
60
61To create an installer, you'll need Nullsoft's NSIS.
0e8ac6a7
LOK
62
63To compile libCEC, follow these instructions:
58f3d0a9 64* open /project/libcec.sln with Visual Studio 2012.
f5ccf647 65* build the project.
e4e13f5b
LOK
66
67To build an installer on Windows:
f5ccf647 68* download and install NSIS.
9e58420e
LOK
69* go to /project and execute create-installer.bat to create the installer.
70* the installer is stored as /build/libCEC-installer.exe
abbca718 71
29104708
LOK
72===============================================================================
73 === Raspberry Pi ===
74===============================================================================
75
76We've included a script that builds libCEC with support for the Raspberry Pi
77in /project/RPi/build.sh. This script pulls in the latest toolchain and
78firmware, builds the necessary dependencies, and finally builds libCEC. The
79result will be a softfp build.
80
81To build libCEc on your development machine, follow these instructions:
82* run '/project/RPi/build.sh /desired/destination/path/for/binaries'
83* run 'make install'
84
85To build libCEC on the Pi itself, just follow the instructions for Linux.
86The configure script automatically checks whether the required headers and
87libraries can be found.
88
89To specify the path of the Raspberry Pi's development headers, use the
90following option for 'configure':
91--with-rpi-include-path="/path/to/opt/vc/include"
92
93To specify the path of the Raspberry Pi's libraries, use the following option
94for 'configure':
95--with-rpi-lib-path="/path/to/libbcm_host.so"
96
4d3a7562 97===============================================================================
79e50026 98 === CuBox / TDA995x ===
4d3a7562 99===============================================================================
100
51b611bc 101Solid-Run's CuBox uses a combined HDMI tranceiver / CEC controller by NXP. The
102device driver for it is based on an SDK by the chip vendor and is compiled into
103the Linux kernel. The following options for 'configure' have been introduced:
4d3a7562 104
79e50026
LOK
105To enable support for the CuBox / TDA995x:
106--enable-tda995x
4d3a7562 107
51b611bc 108To specify the path to the SDK part of the kernel driver:
109--with-tda995x-toolkit-path='path/to/linux/drivers/video/dovefb/nxp_hdmi'
4d3a7562 110
111If the toolkit path is not specified, it is assumed that a directory named
112'nxp_hdmi' (or a link to it) exists in the top level of the source tree.
113
0e8ac6a7
LOK
114===============================================================================
115 === Debugging / Testing ===
116===============================================================================
117
38280939
LOK
118To compile libCEC with extensive debugging output, pass the following argument
119to configure on Linux/OS-X/BSD:
120--enable-debug
121
0e8ac6a7
LOK
122We provide a test client, named cec-client, to debug the device.
123To check whether the device can be detected, execute the following command:
124* cec-client -l
125
126"cec-client -h" shows a list of commands and options that are available.
abbca718 127
0e8ac6a7
LOK
128===============================================================================
129 === Developers ===
130===============================================================================
61f3c2ad 131
0e8ac6a7
LOK
132We provide a C, C++ and .NET CLR interface to the adapter.
133
134C++ developers:
135* the API can be found in /include/cec.h
136* an example implementation can be found in /src/testclient/main.cpp
137
138C developers:
139* the API can be found in /include/cecc.h
140
141.NET developers:
61f3c2ad 142* add a reference to LibCecSharp.dll
0e8ac6a7
LOK
143* an example can be found in \src\CecSharpTester\CecSharpClient.cs
144
145===============================================================================
146 === Developers Agreement ===
147===============================================================================
cc30d5c9 148
0e8ac6a7
LOK
149If you wish to contribute to this project, you must first sign our contributors
150agreement. Please see http://www.pulse-eight.net/contributors for more
151information.