contrib: add AppStream metadata
[libam7xxx.git] / 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' (3.1+)
11 for 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                           libxcb1-dev
22
23 With libav/ffmpeg version previous than 0.9 this patch is needed:
24 https://git.ao2.it/libam7xxx.git/blob/6d2d8613958e1f0ef011e9d848426086caafe9db:/debian/patches/0002-Revert-am7xxx-play-switch-to-avcodec_encode_video2.patch
25
26 The library and the example programs can be compiled following these steps:
27
28   $ git clone git://git.ao2.it/libam7xxx.git
29   $ cd libam7xxx
30   $ mkdir build
31   $ cd build
32   $ cmake ../
33   $ make
34
35 After that the example programs can be found in the +bin/+ subdirectory.
36
37 === Debug builds
38
39 The suggested way to hack on the project is:
40
41   $ mkdir build
42   $ cd build
43   $ cmake -D CMAKE_BUILD_TYPE=debug -D STRICT_COMPILATION_CHECKS=ON ../
44   $ make
45
46 If you want to check the code with the ''sparse'' static analysis tool you
47 can run:
48
49   $ mkdir build
50   $ cd build
51   $ cmake -D CMAKE_C_COMPILER=cgcc ../
52   $ make
53
54 And for a pre-release check with a different compiler, which never hurts:
55
56   $ mkdir build
57   $ cd build
58   $ cmake -D CMAKE_C_COMPILER=clang -D CMAKE_BUILD_TYPE=debug -D STRICT_COMPILATION_CHECKS=ON ../
59   $ make
60
61 === Cross Builds
62
63 If you want to build for MS Windows:
64
65   $ sudo aptitude install mingw-w64
66   $ mkdir build
67   $ cd build
68   $ wget -nv https://github.com/libusb/libusb/releases/download/v1.0.21/libusb-1.0.21.7z
69   $ 7z -olibusb-1.0.21 x libusb-1.0.21.7z
70   $ wget -nv https://ffmpeg.zeranoe.com/builds/win32/dev/ffmpeg-3.4.2-win32-dev.zip
71   $ unzip ffmpeg-3.4.2-win32-dev.zip
72   $ cmake  \
73           -D GNU_HOST=i686-w64-mingw32 \
74           -D CMAKE_TOOLCHAIN_FILE=../cmake_modules/mingw_cross_toolchain.cmake \
75           -D CMAKE_INSTALL_PREFIX=libam7xxx-win/ \
76           -D LIBUSB_1_INCLUDE_DIR=libusb-1.0.21/include/libusb-1.0 \
77           -D LIBUSB_1_LIBRARY=libusb-1.0.21/MinGW32/dll/libusb-1.0.dll \
78           -D FFMPEG_ROOT=$(pwd)/ffmpeg-3.4.2-win32-dev \
79           ../
80   $ make
81
82 After that you will find libam7xxx.dll in lib/ and picoproj.exe in the bin/
83 directory.
84
85 === Valgrind
86
87 You can run the test program under the http://valgrind.org/[valgrind]
88 dynamic analyzer by using a command like:
89
90   $ valgrind --leak-check=full --show-reachable=yes --track-origins=yes \
91     ./bin/picoproj -W 800 -H 480 -f my_image.jpg
92
93 or, for am7xxx-play:
94
95   $ valgrind --leak-check=full --show-reachable=yes --track-origins=yes \
96     ./bin/am7xxx-play -f x11grab -i :0