README

   1 This library provides support for the Pulse-Eight USB-CEC adapter.
   2
   3 You can find a list of frequently asked questions on the following page:
   4                     http://libcec.pulse-eight.com/faq
   5
   6 ===============================================================================
   7                              === Linux & BSD ===
   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
  13 * liblockdev 1.0 or later
  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
  18 * libtool
  19 * gcc 4.2 or later
  20 * liblockdev 1.0 development headers
  21
  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
  27 To compile, execute the following commands:
  28 # ./bootstrap
  29 # ./configure
  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
  40 * pkg-config
  41 * xcode 3.2.6 or later
  42
  43 To compile, execute the following command:
  44 # ./bootstrap
  45 # ./configure
  46 # make
  47 # sudo make install
  48
  49 # Note: You may need to copy pkg.m4 to your m4 sources directory
  50
  51 ===============================================================================
  52                               === Windows ===
  53 ===============================================================================
  54
  55 To compile libCEC on Windows, you'll need both Visual Studio 2008 and 2012.
  56 The installer needs the Windows DDK (Driver Development Kit) and Nullsoft's
  57 NSIS.
  58
  59 To compile libCEC, follow these instructions:
  60 * open /project/libcec.sln with Visual Studio 2012.
  61 * build the project.
  62
  63 To build an installer on Windows:
  64 * download and install NSIS.
  65 * go to /project and execute create-installer.bat to create the installer.
  66 * the installer is stored as /build/libCEC-installer.exe
  67
  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
  93 ===============================================================================
  94                            === CuBox / TDA995x ===
  95 ===============================================================================
  96
  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:
 100
 101 To enable support for the CuBox / TDA995x:
 102 --enable-tda995x
 103
 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'
 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
 110 ===============================================================================
 111                             === Debugging / Testing ===
 112 ===============================================================================
 113
 114 To compile libCEC with extensive debugging output, pass the following argument
 115 to configure on Linux/OS-X/BSD:
 116 --enable-debug
 117
 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.
 123
 124 ===============================================================================
 125                               === Developers ===
 126 ===============================================================================
 127
 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:
 138 * add a reference to LibCecSharp.dll
 139 * an example can be found in \src\CecSharpTester\CecSharpClient.cs
 140
 141 ===============================================================================
 142                         === Developers Agreement ===
 143 ===============================================================================
 144
 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.