vmbpy 1.1.0__py3-none-win_amd64.whl

vmbpy/__init__.py

@@ -0,0 +1,142 @@
+"""BSD 2-Clause License
+
+Copyright (c) 2023, Allied Vision Technologies GmbH
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+"""
+
+# Suppress 'imported but unused' - Error from static style checker.
+# flake8: noqa: F401
+
+__version__ = '1.1.0'
+
+__all__ = [
+    'VmbSystem',
+    'Stream',
+    'Camera',
+    'LocalDevice',
+    'CameraChangeHandler',
+    'CameraEvent',
+    'AccessMode',
+    'PersistType',
+    'ModulePersistFlags',
+    'Interface',
+    'TransportLayer',
+    'TransportLayerType',
+    'InterfaceChangeHandler',
+    'InterfaceEvent',
+    'PixelFormat',
+    'Frame',
+    'FeatureTypes',
+    'FeatureVisibility',
+    'FrameHandler',
+    'FrameStatus',
+    'PayloadType',
+    'AllocationMode',
+    'Debayer',
+    'intersect_pixel_formats',
+    'MONO_PIXEL_FORMATS',
+    'BAYER_PIXEL_FORMATS',
+    'RGB_PIXEL_FORMATS',
+    'RGBA_PIXEL_FORMATS',
+    'BGR_PIXEL_FORMATS',
+    'BGRA_PIXEL_FORMATS',
+    'YUV_PIXEL_FORMATS',
+    'YCBCR_PIXEL_FORMATS',
+    'COLOR_PIXEL_FORMATS',
+    'OPENCV_PIXEL_FORMATS',
+
+    'VmbSystemError',
+    'VmbTransportLayerError',
+    'VmbCameraError',
+    'VmbInterfaceError',
+    'VmbFeatureError',
+    'VmbFrameError',
+    'VmbTimeout',
+    'VmbChunkError',
+
+    'IntFeature',
+    'FloatFeature',
+    'StringFeature',
+    'BoolFeature',
+    'EnumEntry',
+    'EnumFeature',
+    'CommandFeature',
+    'RawFeature',
+
+    'FeatureContainer',
+    'PersistableFeatureContainer',
+
+    'LogLevel',
+    'LogConfig',
+    'Log',
+    'LOG_CONFIG_TRACE_CONSOLE_ONLY',
+    'LOG_CONFIG_TRACE_FILE_ONLY',
+    'LOG_CONFIG_TRACE',
+    'LOG_CONFIG_DEBUG_CONSOLE_ONLY',
+    'LOG_CONFIG_DEBUG_FILE_ONLY',
+    'LOG_CONFIG_DEBUG',
+    'LOG_CONFIG_INFO_CONSOLE_ONLY',
+    'LOG_CONFIG_INFO_FILE_ONLY',
+    'LOG_CONFIG_INFO',
+    'LOG_CONFIG_WARNING_CONSOLE_ONLY',
+    'LOG_CONFIG_WARNING_FILE_ONLY',
+    'LOG_CONFIG_WARNING',
+    'LOG_CONFIG_ERROR_CONSOLE_ONLY',
+    'LOG_CONFIG_ERROR_FILE_ONLY',
+    'LOG_CONFIG_ERROR',
+    'LOG_CONFIG_CRITICAL_CONSOLE_ONLY',
+    'LOG_CONFIG_CRITICAL_FILE_ONLY',
+    'LOG_CONFIG_CRITICAL',
+
+    'TraceEnable',
+    'ScopedLogEnable',
+    'RuntimeTypeCheckEnable',
+    'VmbIntEnum',
+    'VmbFlagEnum'
+]
+
+from .camera import AccessMode, Camera, CameraChangeHandler, CameraEvent
+from .error import (VmbCameraError, VmbChunkError, VmbFeatureError, VmbFrameError,
+                    VmbInterfaceError, VmbSystemError, VmbTimeout, VmbTransportLayerError)
+from .feature import (BoolFeature, CommandFeature, EnumEntry, EnumFeature, FeatureTypes,
+                      FeatureVisibility, FloatFeature, IntFeature, RawFeature, StringFeature)
+from .featurecontainer import (FeatureContainer, ModulePersistFlags, PersistableFeatureContainer,
+                               PersistType)
+from .frame import (BAYER_PIXEL_FORMATS, BGR_PIXEL_FORMATS, BGRA_PIXEL_FORMATS, COLOR_PIXEL_FORMATS,
+                    MONO_PIXEL_FORMATS, OPENCV_PIXEL_FORMATS, RGB_PIXEL_FORMATS, RGBA_PIXEL_FORMATS,
+                    YCBCR_PIXEL_FORMATS, YUV_PIXEL_FORMATS, AllocationMode, Debayer, Frame,
+                    FrameStatus, PayloadType, PixelFormat, intersect_pixel_formats)
+from .interface import Interface, InterfaceChangeHandler, InterfaceEvent
+from .localdevice import LocalDevice
+from .stream import FrameHandler, Stream
+from .transportlayer import TransportLayer, TransportLayerType
+from .util import (LOG_CONFIG_CRITICAL, LOG_CONFIG_CRITICAL_CONSOLE_ONLY,
+                   LOG_CONFIG_CRITICAL_FILE_ONLY, LOG_CONFIG_DEBUG, LOG_CONFIG_DEBUG_CONSOLE_ONLY,
+                   LOG_CONFIG_DEBUG_FILE_ONLY, LOG_CONFIG_ERROR, LOG_CONFIG_ERROR_CONSOLE_ONLY,
+                   LOG_CONFIG_ERROR_FILE_ONLY, LOG_CONFIG_INFO, LOG_CONFIG_INFO_CONSOLE_ONLY,
+                   LOG_CONFIG_INFO_FILE_ONLY, LOG_CONFIG_TRACE, LOG_CONFIG_TRACE_CONSOLE_ONLY,
+                   LOG_CONFIG_TRACE_FILE_ONLY, LOG_CONFIG_WARNING, LOG_CONFIG_WARNING_CONSOLE_ONLY,
+                   LOG_CONFIG_WARNING_FILE_ONLY, Log, LogConfig, LogLevel, RuntimeTypeCheckEnable,
+                   ScopedLogEnable, TraceEnable, VmbIntEnum, VmbFlagEnum)
+from .vmbsystem import VmbSystem

vmbpy/c_binding/__init__.py

@@ -0,0 +1,134 @@
+"""BSD 2-Clause License
+
+Copyright (c) 2022, Allied Vision Technologies GmbH
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+-------------------------------------------------------------------------
+
+NOTE: Vmb naming convention.
+VmbPy is based on VmbC, this submodule contains all wrapped types and functions provided by VmbC to
+make them usable from Python. By convention, all VmbC Types and Functions are prefixed with 'Vmb',
+this convention is kept for all python types interfacing with the C - Layer. VmbC developers should
+be able to understand the interface to VmbC and keeping the name convention helps a lot in that
+regard.
+
+However prefixing everything with 'Vmb' is not required in VmbPy, therefore most Types of the public
+API have no prefix.
+"""
+
+# Suppress 'imported but unused' - Error from static style checker.
+# flake8: noqa: F401
+
+__all__ = [
+    # Exports from vmb_common
+    'VmbInt8',
+    'VmbUint8',
+    'VmbInt16',
+    'VmbUint16',
+    'VmbInt32',
+    'VmbUint32',
+    'VmbInt64',
+    'VmbUint64',
+    'VmbHandle',
+    'VmbBool',
+    'VmbUchar',
+    'VmbDouble',
+    'VmbError',
+    'VmbCError',
+    'VmbPixelFormat',
+    'decode_cstr',
+    'decode_flags',
+
+    # Exports from vmb_c
+    'VmbTransportLayer',
+    'VmbAccessMode',
+    'VmbFeatureData',
+    'VmbFeaturePersist',
+    'VmbModulePersistFlags',
+    'VmbFeatureVisibility',
+    'VmbFeatureFlags',
+    'VmbFrameStatus',
+    'VmbPayloadType',
+    'VmbFrameFlags',
+    'VmbVersionInfo',
+    'VmbTransportLayerInfo',
+    'VmbInterfaceInfo',
+    'VmbCameraInfo',
+    'VmbFeatureInfo',
+    'VmbFeatureEnumEntry',
+    'VmbFrame',
+    'VmbFeaturePersistSettings',
+    'G_VMB_C_HANDLE',
+    'VMB_C_VERSION',
+    'EXPECTED_VMB_C_VERSION',
+    'call_vmb_c',
+
+    # Exports from vmb_image_transform
+    'VmbImage',
+    'VmbImageInfo',
+    'VmbDebayerMode',
+    'VmbTransformInfo',
+    'VMB_IMAGE_TRANSFORM_VERSION',
+    'EXPECTED_VMB_IMAGE_TRANSFORM_VERSION',
+    'call_vmb_image_transform',
+    'PIXEL_FORMAT_TO_LAYOUT',
+    'LAYOUT_TO_PIXEL_FORMAT',
+    'PIXEL_FORMAT_CONVERTIBILITY_MAP',
+
+    # Exports from wrapped_types
+    'AccessMode',
+    'Debayer',
+    'FeatureFlags',
+    'FeatureVisibility',
+    'FrameStatus',
+    'PayloadType',
+    'PersistType',
+    'ModulePersistFlags',
+    'PixelFormat',
+    'TransportLayerType',
+
+    # Exports from ctypes
+    'byref',
+    'sizeof',
+    'create_string_buffer'
+]
+
+from ctypes import byref, create_string_buffer, sizeof
+
+from .vmb_c import (EXPECTED_VMB_C_VERSION, G_VMB_C_HANDLE, VMB_C_VERSION, VmbAccessMode,
+                    VmbCameraInfo, VmbFeatureData, VmbFeatureEnumEntry, VmbFeatureFlags,
+                    VmbFeatureInfo, VmbFeaturePersist, VmbFeaturePersistSettings,
+                    VmbFeatureVisibility, VmbFrame, VmbFrameFlags, VmbFrameStatus, VmbPayloadType,
+                    VmbInterfaceInfo, VmbModulePersistFlags, VmbTransportLayer, VmbTransportLayerInfo,
+                    VmbVersionInfo, call_vmb_c)
+from .vmb_common import (VmbBool, VmbCError, VmbDouble, VmbError, VmbHandle, VmbInt8, VmbInt16,
+                         VmbInt32, VmbInt64, VmbPixelFormat, VmbUchar, VmbUint8, VmbUint16,
+                         VmbUint32, VmbUint64, _as_vmb_file_path, _select_vimbax_home, decode_cstr,
+                         decode_flags)
+from .vmb_image_transform import (EXPECTED_VMB_IMAGE_TRANSFORM_VERSION, LAYOUT_TO_PIXEL_FORMAT,
+                                  PIXEL_FORMAT_CONVERTIBILITY_MAP, PIXEL_FORMAT_TO_LAYOUT,
+                                  VMB_IMAGE_TRANSFORM_VERSION, VmbDebayerMode, VmbImage,
+                                  VmbImageInfo, VmbTransformInfo, call_vmb_image_transform)
+from .wrapped_types import (AccessMode, Debayer, FeatureFlags, FeatureVisibility, FrameStatus,
+                            PayloadType, ModulePersistFlags, PersistType, PixelFormat, TransportLayerType)

vmbpy/c_binding/lib/VmbC.xml

@@ -0,0 +1,69 @@
+<?xml version="1.0" standalone="no" ?>
+<Settings>
+
+    <!--
+        Use this to activate logging and set filename for logging (path can be absolute or relative to API)
+        Default behavior if omitted:    Logging is deactivated
+    -->
+    <!-- <LogFileName>VmbC.log</LogFileName> -->
+    
+    <!--
+        Append messages to log file or reset log file at each API restart (if logging is enabled)
+        True:                           Always append log messages
+        False:                          Reset log file at each API restart
+        Default behavior if omitted:    Reset log file at each API restart
+    -->     
+    <!-- <AppendLog>False</AppendLog> -->
+
+    <TlLoading>
+        <!--
+            Use this to specify paths and directories where VmbC should look for .cti files. 
+            If this element is used Vimba X will NOT evaluate the GENICAM_GENTL64_PATH or 
+            GENICAM_GENTL32_PATH variable.
+            If this element is missing or empty the values from GENICAM_GENTL64_PATH or
+            GENICAM_GENTL32_PATH are used. The paths listed there are not required though. 
+            If the "required" attribute for a path is set to "true" the VmbC initialization will fail in case 
+            that path does not contain a transport layer.
+        -->
+        <CtiPaths>
+            <!-- <Path required="false">.</Path> -->
+        </CtiPaths>
+        
+        <!--
+            Transport layer rules for filtering certain vendors and interfaces. The rules will be applied from top 
+            to bottom until a matching rule is found. Subsequent rules will be ignored then. The rules will be always
+            be applied to all input paths (even if the transport layer is placed next to the VmbC library). 
+            vendor-type: Vendor (short) name. Can also be set to wildcard *. If vendor-type is not specified it will be replaced by *.
+            interface-type: Transport layer interface type. Can also be set to wildcard *. If interface-type is not specified it will be replaced by *.
+               Valid interface-types are: GEV, CL, IIDC, UVC, CXP, CLHS, U3V, Custom
+            rule: "allow" or "deny". If the rule attribute is missing the TlRule will be discarded.
+            In case no TlRule element exists only AVT and NET transport layers are enabled.
+        -->
+        <TlRule vendor-type="SVS" interface-type="GEV" rule="deny"/>
+        <TlRule vendor-type="SVS" interface-type="U3V" rule="allow"/>
+        <TlRule vendor-type="EUR" interface-type="CXP" rule="allow"/>
+        <TlRule vendor-type="AVT" interface-type="*" rule="allow"/>
+        <TlRule vendor-type="NET" interface-type="*" rule="allow"/>
+        <TlRule rule="deny"/>
+
+        <!-- 
+            Poll for interfaces every XXX ms 
+            Default behavior if omitted:    2500 ms
+        -->
+        <InterfacePollingPeriod>2000</InterfacePollingPeriod>
+        
+        <!--
+            Polling periods in ms for devices selected by interface type and vendor type.
+            Default behavior if omitted:    2500 ms
+        -->
+        <!-- <DevicePollingPeriod tl-vendor="NET" interface-type="GEV">20</DevicePollingPeriod> -->
+
+        <!--
+            Timeout in ms used for updating the interface list
+            Default behavior if omitted:    No timeout used
+        -->
+        <!-- <UpdateDeviceListTimeout tl-vendor="NET" interface-type="GEV">50</UpdateDeviceListTimeout> -->
+
+    </TlLoading>
+
+</Settings>