Difference between revisions of "Developers Documentation"

From Ghpsdr3 SDR project
Jump to: navigation, search
(Installing Qt5 Beta)
(Installing Qt5)
Line 82: Line 82:
  
 
= Installing Qt5 =
 
= Installing Qt5 =
You need to add the unsupported packages to your system. It will exist as a stand alone system separate from any other version of qt or creator etc. that you may have installed.
 
  
Two options are available:
+
http://qt-project.org/downloads
  
# Qt5 beta (preferred)
+
The recommended path to install into is /opt/Qt5.0.0 (Use sudo to run the isntaller.)
# Canonical Qt5 Edgers ppa
+
 
+
 
+
== Installing Qt5 Beta 1 ==
+
 
+
You download and install the Qt5 Beta 1 with the proper package from the following page:
+
 
+
<pre>http://releases.qt-project.org/qt5.0/beta1/</pre>
+
 
+
'''Note: also a more recent release does exist (Beta2); however, due to a misalignment between QAction class and uic preprocessor, the UI.cpp fails to compile.'''
+
 
+
You set the path to point to the qmake you want to use:
+
 
+
<pre>
+
$ export PATH=/where/the/Qt/bin/dir/is:$PATH
+
</pre>
+
 
+
For example, mine is:
+
 
+
<pre>export PATH=/home/alex/Qt5.0.0beta1/Desktop/Qt/5.0.0-beta1/gcc_64/bin:$PATH
+
</pre>
+
 
+
 
+
You can check which version of Qt is active by:
+
 
+
<pre>$ qmake --version
+
QMake version 2.01a Using Qt version 5.0.0 in /home/alex/Qt5.0.0beta1/Desktop/Qt/5.0.0-beta1/gcc_64/lib
+
</pre>
+
 
+
 
+
The master branch now has conditional compile for Qt5 Beta and for older versions of Qt. Once the above PATH is set for the version of Qt you want, you can just use the usual automake steps to build.
+
 
+
The opengl-qt5 branch is customised for qt5 Beta ONLY. You also need to have a video card/ video chip in your PC that is opengl 2.0 compatible for it to compile and run.
+
 
+
== Adding the qt5 “Canonical Qt5 Edgers” ppa to your system ==
+
 
+
In a terminal, copy and paste ...
+
<pre>
+
sudo add-apt-repository ppa:canonical-qt5-edgers/qt5-daily
+
</pre>
+
Your system will now fetch the PPA's key. This enables your Ubuntu system to verify that the packages in the PPA have not been interfered with since they were built.
+
 
+
Now, as a one-off, you should tell your system to pull down the latest list of software from each archive it knows about, including the PPA you just added:
+
<pre>
+
sudo apt-get update
+
</pre>
+
Now you're ready to start installing software from the PPA!
+
 
+
== Installing from the ppa ==
+
 
+
You will be installing the packages from the daily build of qt5 and the version date etc. could change but it is important to check that you have marked for install the package corresponding to the qt5 build as some of the packages may also be installed for qt 4.8.x A good check is to open the url for the Edgers and compare your selection to their file list at [https://launchpad.net/~canonical-qt5-edgers/+archive/qt5-daily canonical-qt5-edgers]
+
 
+
The packages will be identified with similar to
+
  5.0-2012xxx ubuntu5 Zoltan Balogh (2012-04-05)
+
I have shown the example on the first entry in the list only.
+
 
+
Open Synaptic and use the quick find to look for and mark for install each of the packages in the following list ...
+
<pre>
+
qt-components-qtquick2    5.0-2012xxx ubuntu5 Zoltan Balogh (2012-04-05)
+
qt3d
+
qtbase
+
qtdeclarative
+
qtdoc
+
qtjsbackend
+
qtmultimedia
+
qtquick1
+
qtscript
+
qtsvg
+
qttools
+
qtwebkit
+
qtxmlpatterns
+
 
+
These packages will install by default in /opt/qt5
+
</pre>
+
note: there are a couple of packages which you do not need to install.
+
 
+
If you are using the command line, the needed command are shown below for convenience:
+
 
+
<pre>
+
sudo apt-get install qt-components-qtquick2 qt3d qtbase
+
sudo apt-get install qtdeclarative qtdoc  qtjsbackend  qtmultimedia  qtquick1
+
sudo apt-get install qtscript qtsvg qttools  qtwebkit qtxmlpatterns
+
</pre>
+
  
 
== Setting the path to qt5 ==
 
== Setting the path to qt5 ==
Line 175: Line 91:
 
From a terminal
 
From a terminal
 
<pre>
 
<pre>
$ export PATH=/opt/qt5/bin:$PATH
+
$ export PATH=/opt/Qt5.0.0/5.0.0/gcc_64/bin:/opt/Qt5.0.0/Tools/QtCreator/bin:$PATH
 
</pre>
 
</pre>
  
Line 188: Line 104:
 
sh ./cleanup.sh
 
sh ./cleanup.sh
 
autoreconf -i
 
autoreconf -i
./configure CFLAGS='-fopenmp -O3 -msse3' CXXFLAGS='-fopenmp -O3 -msse3'
+
 
 +
 
 +
./alex-config
  
 
</pre>
 
</pre>
Line 213: Line 131:
 
Click on the Qt Versions panel
 
Click on the Qt Versions panel
 
Click on Add button
 
Click on Add button
Navigate to /opt/qt5/bin
+
Navigate to /opt/Qt5.0.0/5.0.0/gcc_64/bin
 
Click on qmake
 
Click on qmake
 
Click on open
 
Click on open
 
Click on Apply then OK
 
Click on Apply then OK
 
</pre>
 
</pre>
You need to point to the qmake file which is found in /opt/qt5/bin
+
You need to point to the qmake file which is found in /opt/Qt5.0.0/5.0.0/gcc_64/bin
  
 
== Choosing the build library in QtCreator ==
 
== Choosing the build library in QtCreator ==

Revision as of 11:37, 20 December 2012

Most of the development discussion has been taking place on the sdr-widget google group.


Installing portaudio19-dev with jackd2

Portaudio19-dev depends on having a copy of libjack-dev installed and if the libkjack-jackd2-dev package is installed before portaudio19-dev it's dependency will be satisfied and it will not uninstall jackd2 and install jackd1 if you have already installed jackd2 on your system.

If jackd1 and portaudio19-dev already installed

From Synaptic

Uninstall portaudio19-dev
Uninstall jackd1
Install Jackd2
Install libjack-jackd2-dev
Install portaudio19-dev

If you are starting from scratch

From Synaptic

Install Jackd2
Install libjack-jackd2-dev
Install portaudio19-dev


The following commands install all the environment needed (Debian/Ubuntu):

sudo apt-get install jackd2 libjack-jackd2-dev portaudio19-dev

sudo apt-get install make gcc g++ autoconf automake autotools-dev libtool git subversion
sudo apt-get install libusb-0.1-4 libusb-dev libfftw3-dev libpulse-dev libsamplerate0-dev 
sudo apt-get install libusb-1.0-0-dev libconfig8-dev xdg-utils libortp-dev
sudo apt-get install libevent-dev

If the machine doesn't have an OpenGL aware accelerated video card, please install also the following packages:

sudo apt-get install mesa-utils
sudo apt-get install mesa-common-dev
sudo apt-get install libgl1-mesa-dev
sudo apt-get install x11proto-xext-dev
sudo apt-get install libxrender-dev

Note: in at least one case (thanks to Pierluigi iw4blg), even if the machine was running with an NVidia card and proprietary NVidia device drivers, the test for Qt in configure did fail, as well did the example programs enclosed in qt5 package, complaining that both GL/gl.h and libGL were missing. Installing all the above packages the problem was solved.

Installing codec2 low bit rate audio encoding and decoding

To download and build the codec2 library. See:

http://www.rowetel.com/blog/?page_id=452

Now go get codec2 using subversion

cd
svn co https://freetel.svn.sourceforge.net/svnroot/freetel/codec2-dev
cd codec2-dev
autoreconf -i
./configure
make
sudo make install
sudo ldconfig

Installing Qt5

http://qt-project.org/downloads

The recommended path to install into is /opt/Qt5.0.0 (Use sudo to run the isntaller.)

Setting the path to qt5

From a terminal

$ export PATH=/opt/Qt5.0.0/5.0.0/gcc_64/bin:/opt/Qt5.0.0/Tools/QtCreator/bin:$PATH

Compiling QtRadio

cd
git clone https://github.com/alexlee188/ghpsdr3-alex.git
cd ghpsdr3-alex
git checkout master

sh ./cleanup.sh
autoreconf -i


./alex-config

for those of us with older machines use the line below instead:

./configure CXXFLAGS='-O3 -msse2 -fopenmp'

Last, build everything:

make
sudo make install

Setting QtCreator to use the qt5 libraries

If you want to use Qt Creator (you use the same Qt Creator as with Qt4), you need to configure it to use Qt5 as one of the options:

From the top line menu of QtCreator ...

Tools > Options > Build & Run
Click on the Qt Versions panel
Click on Add button
Navigate to /opt/Qt5.0.0/5.0.0/gcc_64/bin
Click on qmake
Click on open
Click on Apply then OK

You need to point to the qmake file which is found in /opt/Qt5.0.0/5.0.0/gcc_64/bin

Choosing the build library in QtCreator

you need to (re)import your QtRadio project and then you will be able to select Qt5 (or the previous Qt4.8 etc.) for building the application.

It may be necessary to edit the project file (QtRadio.pro) to choose which version of Qt Creator you are using which can be the SDK directly from Nokia, or the Ubuntu install of Creator. The line "_UsingSDK" needs to be set to true or false as appropriate.