ReadMe.md 4.19 KB
Newer Older
Sergi Hernandez's avatar
Sergi Hernandez committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
stream_srt_sink                        {#mainpage}
============

## Description

stream_strt_sink

## Installation

* Add the labrobotica repository if it is not already added: run the commands on _add repository_ and _add key_ from [labrobotica_how_to installation](https://gitlab.iri.upc.edu/labrobotica/labrobotica_how_to/-/blob/master/README.md#installation)
* Install the package:

      sudo apt update && sudo apt install iri-stream-srt-sink-dev

## Disclaimer  

Copyright (C) Institut de Robòtica i Informàtica Industrial, CSIC-UPC.
Mantainer IRI labrobotica (labrobotica@iri.upc.edu)

This package is distributed in the hope that it will be useful, but without any warranty. It is provided "as is" without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The entire risk as to the quality and performance of the program is with you. should the program prove defective, the GMR group does not assume the cost of any necessary servicing, repair  or correction.

In no event unless required by applicable law the author will be liable to you for damages, including any general, special, incidental or consequential damages arising out of the use or inability to use the program (including but not limited to loss of data or data being rendered inaccurate or losses sustained by you or third parties or a failure of the program to operate with any other programs), even if the author has been advised of the possibility of such damages.

You should have received a copy of the GNU Lesser General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>

## For developers

<details><summary>click here</summary>
<p>

## Dependencies

This package requires of the following system libraries and packages

* [cmake](https://www.cmake.org "CMake's Homepage"), a cross-platform build system.
* [doxygen](http://www.doxygen.org "Doxygen's Homepage") and [graphviz](http://www.graphviz.org "Graphviz's Homepage") to generate the documentation.
* stdc++ and pthread libraries.

Under linux all of these utilities are available in ready-to-use packages.

Under MacOS most of the packages are available via [fink](http://www.finkproject.org/ "Fink's Homepage")

This package also requires of the following dependencies:

## Compilation and installation from source

Clone this repository and create a build folder inside:

    mkdir build

Inside the build folder execute the following commands:

    cmake ..

The default build mode is DEBUG. That is, objects and executables include debug information.

The RELEASE build mode optimizes for speed. To build in this mode execute instead
    cmake .. -DCMAKE_BUILD_TYPE=RELEASE

The release mode will be kept until next time cmake is executed.

    make -j $(nproc)    

In case no errors are reported, the generated libraries (if any) will be located at the
_lib_ folder and the executables (if any) will be located at the _bin_ folder.

In order to be able to use the library, it it necessary to copy it into the system.
To do that, execute

    make install

as root and the shared libraries will be copied to */usr/local/lib/iri/stream_srt_sink* directory
and the header files will be copied to */usr/local/include/iri/stream_srt_sink* directory. At
this point, the library may be used by any user.

To remove the library from the system, exceute

    make uninstall

as root, and all the associated files will be removed from the system.

To generate the documentation execute the following command:

    make doc

## How to use it

To use this library in another library or application, in the CMakeLists.txt file, first it is necessary to locate if the library has been installed or not using the following command

    FIND_PACKAGE(stream_srt_sink)

In the case that the package is present, it is necessary to add the header files directory to the include directory path by using

    INCLUDE_DIRECTORIES(${stream_srt_sink_INCLUDE_DIRS})

and it is also necessary to link with the desired libraries by using the following command

    TARGET_LINK_LIBRARIES(<executable name> ${stream_srt_sink_LIBRARIES})

## Examples

There are examples that show how to use the different classes.

</p>
</details>