Skip to content

Commit

Permalink
deploy: 4743fd8
Browse files Browse the repository at this point in the history
  • Loading branch information
@EmmanuelP
EmmanuelP committed Jan 21, 2025
1 parent ab7a662 commit 4d97e28
Show file tree
Hide file tree
Showing 782 changed files with 4,519 additions and 4,337 deletions.
61 changes: 30 additions & 31 deletions aravis-main/building.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,19 +104,18 @@ <h1 id="installing-aravis">Installing Aravis<a class="md-anchor" href="#installi
<a href="https://github.com/AravisProject/aravis/releases">https://github.com/AravisProject/aravis/releases</a>,
you can build and install Aravis like <a href="http://mesonbuild.com/Quick-guide.html#compiling-a-meson-project">any other meson
project</a>:</p>
<div class="codehilite"><pre><span></span><code>meson setup build
<span class="nb">cd</span> build
<div class="codehilite"><pre><span></span><code>meson<span class="w"> </span>setup<span class="w"> </span>build
<span class="nb">cd</span><span class="w"> </span>build
ninja
ninja install
ninja<span class="w"> </span>install
</code></pre></div>

<p>The build can be configured at any time using <code>meson configure</code> in the build
directory. <code>meson configure</code> invoked without any other argument will show the
<p>The build can be configured at any time&nbsp;using <code>meson configure</code> in the build&nbsp;directory. <code>meson configure</code> invoked without any other argument will show the
configuration&nbsp;options.</p>
<p>On some platforms (like Ubuntu), you may have to configure the dynamic linker
(ld) to let it know where the aravis libraries are installed, and run ldconfig
as root in order to update ld&nbsp;cache.</p>
<div class="codehilite"><pre><span></span><code>sudo ldconfig
<div class="codehilite"><pre><span></span><code>sudo<span class="w"> </span>ldconfig
</code></pre></div>

<h2 id="release-versions">Release versions<a class="md-anchor" href="#release-versions" title="Permanent link"></a></h2>
Expand All @@ -125,37 +124,37 @@ <h2 id="release-versions">Release versions<a class="md-anchor" href="#release-ve
<p>The current version naming follows a major.minor.micro scheme. Odd minor values
indicates development releases, and even minor values stable releases. Prior to
1.0.0, stable releases with different minor are not compatible, and are parallel
installable, with executables suffixed with <code>-major.minor</code>.</p>
installable, with executables suffixed&nbsp;with <code>-major.minor</code>.</p>
<h2 id="install-dependencies-on-ubuntu-2004">Install dependencies on Ubuntu 20.04<a class="md-anchor" href="#install-dependencies-on-ubuntu-2004" title="Permanent link"></a></h2>
<p>Prior to running <code>meson</code> and <code>ninja</code>, dependencies can be installed using the
<p>Prior to&nbsp;running <code>meson</code> and <code>ninja</code>, dependencies can be installed using the
following(tested on Ubuntu&nbsp;20.04):</p>
<div class="codehilite"><pre><span></span><code>sudo apt install libxml2-dev libglib2.0-dev cmake libusb-1.0-0-dev gobject-introspection <span class="se">\</span>
libgtk-3-dev gtk-doc-tools xsltproc libgstreamer1.0-dev <span class="se">\</span>
libgstreamer-plugins-base1.0-dev libgstreamer-plugins-good1.0-dev <span class="se">\</span>
libgirepository1.0-dev gettext
<div class="codehilite"><pre><span></span><code>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>libxml2-dev<span class="w"> </span>libglib2.0-dev<span class="w"> </span>cmake<span class="w"> </span>libusb-1.0-0-dev<span class="w"> </span>gobject-introspection<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>libgtk-3-dev<span class="w"> </span>gtk-doc-tools<span class="w"> </span>xsltproc<span class="w"> </span>libgstreamer1.0-dev<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>libgstreamer-plugins-base1.0-dev<span class="w"> </span>libgstreamer-plugins-good1.0-dev<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>libgirepository1.0-dev<span class="w"> </span>gettext
</code></pre></div>

<h2 id="install-dependencies-on-fedora-3435">Install dependencies on Fedora 34/35<a class="md-anchor" href="#install-dependencies-on-fedora-3435" title="Permanent link"></a></h2>
<p>Due to differences in the deb and rpm package ecosystems dependencies can be
installed on Fedora (tested on 34 and 35)&nbsp;with:</p>
<div class="codehilite"><pre><span></span><code>sudo dnf install libxml2-devel glib2-devel cmake libusb1-devel gobject-introspection <span class="se">\</span>
gobject-introspection-devel gstreamer1-plugins-base-devel gtk3-devel <span class="se">\</span>
gtk-doc libxslt gstreamer1-devel gstreamer1-plugins-good python3-gobject <span class="se">\</span>
g++ meson gettext
<div class="codehilite"><pre><span></span><code>sudo<span class="w"> </span>dnf<span class="w"> </span>install<span class="w"> </span>libxml2-devel<span class="w"> </span>glib2-devel<span class="w"> </span>cmake<span class="w"> </span>libusb1-devel<span class="w"> </span>gobject-introspection<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>gobject-introspection-devel<span class="w"> </span>gstreamer1-plugins-base-devel<span class="w"> </span>gtk3-devel<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>gtk-doc<span class="w"> </span>libxslt<span class="w"> </span>gstreamer1-devel<span class="w"> </span>gstreamer1-plugins-good<span class="w"> </span>python3-gobject<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>g++<span class="w"> </span>meson<span class="w"> </span>gettext
</code></pre></div>

<h2 id="building-on-macos">Building on macOS<a class="md-anchor" href="#building-on-macos" title="Permanent link"></a></h2>
<p>Using the <span class="caps">GNU</span> build system on macOS is not directly supported, but can be
mimicked by augmenting the install procedure above with some environment
settings (tested on macOS&nbsp;Catalina):</p>
<div class="codehilite"><pre><span></span><code>brew install gettext intltool gtk-doc libxml2 meson libusb
meson setup build
ninja -C build
<div class="codehilite"><pre><span></span><code>brew<span class="w"> </span>install<span class="w"> </span>gettext<span class="w"> </span>intltool<span class="w"> </span>gtk-doc<span class="w"> </span>libxml2<span class="w"> </span>meson<span class="w"> </span>libusb
meson<span class="w"> </span>setup<span class="w"> </span>build
ninja<span class="w"> </span>-C<span class="w"> </span>build
</code></pre></div>

<p>If you want to be able to build the viewer, you have to install some additional&nbsp;packages:</p>
<div class="codehilite"><pre><span></span><code>brew install gtk+3 gstreamer gst-plugins-base gst-plugins-good gst-plugins-bad libnotify gnome-icon-theme
meson configure -Dviewer<span class="o">=</span>enabled build
<div class="codehilite"><pre><span></span><code>brew<span class="w"> </span>install<span class="w"> </span>gtk+3<span class="w"> </span>gstreamer<span class="w"> </span>gst-plugins-base<span class="w"> </span>gst-plugins-good<span class="w"> </span>gst-plugins-bad<span class="w"> </span>libnotify<span class="w"> </span>gnome-icon-theme
meson<span class="w"> </span>configure<span class="w"> </span>-Dviewer<span class="o">=</span>enabled<span class="w"> </span>build
</code></pre></div>

<h2 id="building-on-windows">Building on Windows<a class="md-anchor" href="#building-on-windows" title="Permanent link"></a></h2>
Expand All @@ -165,30 +164,30 @@ <h2 id="building-on-windows">Building on Windows<a class="md-anchor" href="#buil
<p>To build Aravis by yourself, install <span class="caps">MSYS2</span> and enter the mingw64 shell. Refer to
the <a href="https://github.com/AravisProject/aravis/blob/main/.github/workflows/aravis-mingw.yml">mingw <span class="caps">CI</span> configuration
file</a>
for list of dependencies (such as <code>mingw-w64-x86_64-libxml2</code> and so on) which
must be installed prior to building via <code>pacman -S ...</code>. The build process
for list of dependencies (such&nbsp;as <code>mingw-w64-x86_64-libxml2</code> and so on) which
must be installed prior to building&nbsp;via <code>pacman -S ...</code>. The build process
itself is the same as on other platforms&nbsp;(meson/ninja).</p>
<p>Alternatively, you can build Aravis using Microsoft Visual C++ (<span class="caps">MSVC</span>) and Conan
package manager. Have a look at the <a href="https://github.com/AravisProject/aravis/blob/main/.github/workflows/aravis-msvc.yml">msvc <span class="caps">CI</span> configuration
file</a>.</p>
<h3 id="cross-compilation-for-windows">Cross-compilation for Windows<a class="md-anchor" href="#cross-compilation-for-windows" title="Permanent link"></a></h3>
<p>Aravis for Windows can be also cross-compiled on Linux (and used in Wine) using
<a href="https://pypi.org/project/crossroad/">crossroad</a>, provided that cross-compiler
and native build tools (<code>sudo apt install gcc-mingw-w64-x86-64 meson
and native build tools&nbsp;(<code>sudo apt install gcc-mingw-w64-x86-64 meson
ninja=build</code> on Debian/Ubuntu) are&nbsp;installed:</p>
<div class="codehilite"><pre><span></span><code><span class="c1"># note: use the git version, not the one from pypi</span>
pip3 install --user git+git://git.tuxfamily.org/gitroot/crossroad/crossroad.git
pip3<span class="w"> </span>install<span class="w"> </span>--user<span class="w"> </span>git+git://git.tuxfamily.org/gitroot/crossroad/crossroad.git
<span class="c1"># create cross-compilation environment with architecture &quot;w64&quot; called &quot;aravis&quot;</span>
crossroad w64 aravis
crossroad<span class="w"> </span>w64<span class="w"> </span>aravis
<span class="c1"># install packages required for compilation; crossroad adds the mingw-w64_x86_64- prefix automatically</span>
crossroad install libnotify gstreamer gst-plugins-good gst-plugins-bad gst-plugins-bad gobject-introspection libusb gtk3 libxml2 zlib
crossroad<span class="w"> </span>install<span class="w"> </span>libnotify<span class="w"> </span>gstreamer<span class="w"> </span>gst-plugins-good<span class="w"> </span>gst-plugins-bad<span class="w"> </span>gst-plugins-bad<span class="w"> </span>gobject-introspection<span class="w"> </span>libusb<span class="w"> </span>gtk3<span class="w"> </span>libxml2<span class="w"> </span>zlib
<span class="c1"># clone aravis sources</span>
git clone https://github.com/AravisProject/aravis
<span class="nb">cd</span> aravis
git<span class="w"> </span>clone<span class="w"> </span>https://github.com/AravisProject/aravis
<span class="nb">cd</span><span class="w"> </span>aravis
<span class="c1"># configure, crossroad adjusts meson for cross-compilation; build directory is created</span>
crossroad meson setup build
crossroad<span class="w"> </span>meson<span class="w"> </span>setup<span class="w"> </span>build
<span class="c1"># compile and install</span>
ninja -C build install
ninja<span class="w"> </span>-C<span class="w"> </span>build<span class="w"> </span>install
</code></pre></div>

<h1 id="debugging-aravis">Debugging Aravis<a class="md-anchor" href="#debugging-aravis" title="Permanent link"></a></h1>
Expand Down
8 changes: 4 additions & 4 deletions aravis-main/callback.DomDocumentCreateFunction.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,10 @@ <h4 id="declaration" style="display:flex;">
</h4>

<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="n">ArvDomDocument</span><span class="o">*</span><span class="w"></span>
<span class="p">(</span><span class="o">*</span><span class="w"> </span><span class="n">ArvDomDocumentCreateFunction</span><span class="p">)</span><span class="w"> </span><span class="p">(</span><span class="w"></span>
<span class="kt">void</span><span class="w"></span>
<span class="p">)</span><span class="w"></span>
<pre><code><div class="highlight"><pre><span></span><span class="n">ArvDomDocument</span><span class="o">*</span>
<span class="p">(</span><span class="o">*</span><span class="w"> </span><span class="n">ArvDomDocumentCreateFunction</span><span class="p">)</span><span class="w"> </span><span class="p">(</span>
<span class="kt">void</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
Expand Down
16 changes: 8 additions & 8 deletions aravis-main/callback.FakeCameraFillPattern.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,14 +114,14 @@ <h4 id="declaration" style="display:flex;">
</h4>

<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="kt">void</span><span class="w"></span>
<span class="p">(</span><span class="o">*</span><span class="w"> </span><span class="n">ArvFakeCameraFillPattern</span><span class="p">)</span><span class="w"> </span><span class="p">(</span><span class="w"></span>
<span class="w"> </span><span class="n">ArvBuffer</span><span class="o">*</span><span class="w"> </span><span class="n">buffer</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="kt">void</span><span class="o">*</span><span class="w"> </span><span class="n">fill_pattern_data</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="n">guint32</span><span class="w"> </span><span class="n">exposure_time_us</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="n">guint32</span><span class="w"> </span><span class="n">gain</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="n">ArvPixelFormat</span><span class="w"> </span><span class="n">pixel_format</span><span class="w"></span>
<span class="p">)</span><span class="w"></span>
<pre><code><div class="highlight"><pre><span></span><span class="kt">void</span>
<span class="p">(</span><span class="o">*</span><span class="w"> </span><span class="n">ArvFakeCameraFillPattern</span><span class="p">)</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ArvBuffer</span><span class="o">*</span><span class="w"> </span><span class="n">buffer</span><span class="p">,</span>
<span class="w"> </span><span class="kt">void</span><span class="o">*</span><span class="w"> </span><span class="n">fill_pattern_data</span><span class="p">,</span>
<span class="w"> </span><span class="n">guint32</span><span class="w"> </span><span class="n">exposure_time_us</span><span class="p">,</span>
<span class="w"> </span><span class="n">guint32</span><span class="w"> </span><span class="n">gain</span><span class="p">,</span>
<span class="w"> </span><span class="n">ArvPixelFormat</span><span class="w"> </span><span class="n">pixel_format</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
Expand Down
16 changes: 8 additions & 8 deletions aravis-main/callback.StreamCallback.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,12 @@ <h4 id="declaration" style="display:flex;">
</h4>

<div class="docblock">
<pre><code><div class="highlight"><pre><span></span><span class="kt">void</span><span class="w"></span>
<span class="p">(</span><span class="o">*</span><span class="w"> </span><span class="n">ArvStreamCallback</span><span class="p">)</span><span class="w"> </span><span class="p">(</span><span class="w"></span>
<span class="w"> </span><span class="kt">void</span><span class="o">*</span><span class="w"> </span><span class="n">user_data</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="n">ArvStreamCallbackType</span><span class="w"> </span><span class="n">type</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="n">ArvBuffer</span><span class="o">*</span><span class="w"> </span><span class="n">buffer</span><span class="w"></span>
<span class="p">)</span><span class="w"></span>
<pre><code><div class="highlight"><pre><span></span><span class="kt">void</span>
<span class="p">(</span><span class="o">*</span><span class="w"> </span><span class="n">ArvStreamCallback</span><span class="p">)</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="kt">void</span><span class="o">*</span><span class="w"> </span><span class="n">user_data</span><span class="p">,</span>
<span class="w"> </span><span class="n">ArvStreamCallbackType</span><span class="w"> </span><span class="n">type</span><span class="p">,</span>
<span class="w"> </span><span class="n">ArvBuffer</span><span class="o">*</span><span class="w"> </span><span class="n">buffer</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
Expand All @@ -135,10 +135,10 @@ <h4 id="description" style="display:flex;">
</h4>

<div class="docblock">
<p>This is the signature of the callback passed on an <code>ArvStream</code> instantiation, which will be called on the stream
<p>This is the signature of the callback passed on&nbsp;an <code>ArvStream</code> instantiation, which will be called on the stream
receiving thread initialization and finalization, and on every received buffer, once when the buffer is pulled from
the buffer queue, and one more when the buffer is done (successfully or&nbsp;not).</p>
<p><code>buffer</code> is assured to be a valid <code>ArvBuffer</code> object only when type is <code>ARV_STREAM_CALLBACK_TYPE_START_BUFFER</code> or
<p><code>buffer</code> is assured to be a&nbsp;valid <code>ArvBuffer</code> object only when type&nbsp;is <code>ARV_STREAM_CALLBACK_TYPE_START_BUFFER</code> or
<code>ARV_STREAM_CALLBACK_TYPE_BUFFER_DONE</code>.</p>
<p>The callback is awaken from the stream receiving thread, which means it is forbidden to access to the camera
instance, except if you take care to protect the instance access from concurrent access. It also means all the time
Expand Down
2 changes: 1 addition & 1 deletion aravis-main/class.Buffer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ <h4 id="methods">
<div class="">
<h6><a href="method.Buffer.find_component.html">arv_buffer_find_component</a></h6>
<div class="docblock">
<p>Search for the part corresponding to <code>component_id</code>.</p>
<p>Search for the part corresponding&nbsp;to <code>component_id</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.8.25</span></p>
Expand Down
Loading

0 comments on commit 4d97e28

Please sign in to comment.