HACKING.asciidoc

   1 == Hacking libam7xxx
   2
   3 === Coding style
   4
   5 libam7xxx uses the linux kernel coding style:
   6 http://kernel.org/doc/Documentation/CodingStyle
   7
   8 === Getting and compiling libam7xxx
   9
  10 libam7xxx depends on 'libusb-1.0' and optionally on 'libav' or 'ffmpeg' for
  11 its example programs, the build system used is 'cmake'.
  12
  13 On a Debian based system, the dependencies can be installed with this command:
  14
  15   $ sudo aptitude install cmake \
  16                           libusb-1.0-0-dev \
  17                           libavformat-dev \
  18                           libavcodec-dev \
  19                           libavdevice-dev \
  20                           libswscale-dev
  21
  22 The library and the example programs can be compiled following these steps:
  23
  24   $ git clone git://git.ao2.it/libam7xxx.git
  25   $ cd libam7xxx
  26   $ mkdir build
  27   $ cd build
  28   $ cmake ../
  29   $ make
  30
  31 After that the example programs can be found in the +bin/+ subdirectory.
  32
  33 === Debug builds
  34
  35 The suggested way to hack on the project is:
  36
  37   $ mkdir build
  38   $ cd build
  39   $ cmake -D CMAKE_BUILD_TYPE=debug -D STRICT_COMPILATION_CHECKS=ON ../
  40   $ make
  41
  42 If you want to check the code with the ''sparse'' static analysis tool you
  43 can run:
  44
  45   $ mkdir build
  46   $ cd build
  47   $ cmake -D CMAKE_C_COMPILER=cgcc ../
  48   $ make
  49
  50 === Cross Builds
  51
  52 If you want to build for MS Windows:
  53
  54   $ sudo aptitude install mingw-w64
  55   $ mkdir build
  56   $ cd build
  57   $ wget -nv http://sourceforge.net/projects/libusbx/files/releases/1.0.11/Windows/libusbx-1.0.11-win.7z
  58   $ 7z -olibusbx-1.0.11-win x libusbx-1.0.11-win.7z
  59   $ cmake  \
  60           -D GNU_HOST=i686-w64-mingw32 \
  61           -D CMAKE_TOOLCHAIN_FILE=../cmake_modules/mingw_cross_toolchain.cmake \
  62           -D CMAKE_INSTALL_PREFIX=libam7xxx-win/ \
  63           -D LIBUSB_1_INCLUDE_DIR=libusbx-1.0.11-win/include/libusbx-1.0 \
  64           -D LIBUSB_1_LIBRARY=libusbx-1.0.11-win/MinGW32/dll/libusb-1.0.dll \
  65           -D BUILD_AM7XXX-PLAY:BOOL=FALSE \
  66           ../
  67   $ make
  68
  69 After that you will find libam7xxx.dll in lib/ and picoproj.exe in the bin/
  70 directory.
  71
  72 === Valgrind
  73
  74 You can run the test program under the http://valgrind.org/[valgrind]
  75 dynamic analyzer by using a command like:
  76
  77   $ valgrind --leak-check=full --show-reachable=yes --track-origins=yes \
  78     ./bin/picoproj -W 800 -H 480 -f my_image.jpg