image-server-kit 0.0.1__tar.gz

image_server_kit-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

image_server_kit-0.0.1/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: image-server-kit
+Version: 0.0.1
+Summary: image_server (Template)
+Author-email: Kengo NAKADA <kengo.nakada@email.com>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xlogger-py
+Requires-Dist: pyserial
+Requires-Dist: nest_asyncio
+Requires-Dist: pydantic
+Requires-Dist: pyyaml
+Requires-Dist: pytest
+Requires-Dist: sphinx
+Requires-Dist: myst-parser
+Requires-Dist: sphinx-autobuild
+Requires-Dist: sphinx-rtd-theme
+Requires-Dist: sphinxcontrib-napoleon
+Requires-Dist: linkify-it-py
+Dynamic: license-file
+
+# image_server
+
+image_server は「USBカメラを扱うライブラリ」ではありません。
+
+本ライブラリは **画像転送機能を既存プログラムへ組み込むためのテンプレート** です。
+OpenCV・gRPC・Viewer を毎回実装するのではなく、画像取得部分だけを書き換えることで
+画像転送システムを短時間で構築できることを目的としています。
+
+## このライブラリが解決する問題
+
+通常は次のような処理を毎回実装する必要があります。
+
+- カメラ接続
+- フレーム取得
+- JPEG圧縮
+- 通信
+- Viewer
+- 接続管理
+- スレッド管理
+
+image_server はこれらを共通化し、利用者は **画像取得部だけ** を実装します。
+
+## レイヤ構造
+
+Application
+↓
+ImageStreamGrpcService
+↓
+ImageStreamCtrl
+↓
+Camera SDK
+
+ImageStreamCtrl は Camera SDK を抽象化する層です。
+ImageStreamGrpcService は画像配信だけを担当します。
+
+## 開発フロー
+
+1. ImageStreamCtrl を OpenCV で動かす
+2. SDK に置き換える
+3. run_image_server.py を起動
+4. Viewer で確認
+5. DeviceProxy や AI システムへ組み込む
+
+## 想定用途
+
+- USB Camera
+- Basler
+- IDS
+- HikVision
+- GigE Vision
+- ORiN Camera
+- AI 推論サーバ
+- 外観検査
+- ロボットビジョン

image_server_kit-0.0.1/README.md

@@ -0,0 +1,54 @@
+# image_server
+
+image_server は「USBカメラを扱うライブラリ」ではありません。
+
+本ライブラリは **画像転送機能を既存プログラムへ組み込むためのテンプレート** です。
+OpenCV・gRPC・Viewer を毎回実装するのではなく、画像取得部分だけを書き換えることで
+画像転送システムを短時間で構築できることを目的としています。
+
+## このライブラリが解決する問題
+
+通常は次のような処理を毎回実装する必要があります。
+
+- カメラ接続
+- フレーム取得
+- JPEG圧縮
+- 通信
+- Viewer
+- 接続管理
+- スレッド管理
+
+image_server はこれらを共通化し、利用者は **画像取得部だけ** を実装します。
+
+## レイヤ構造
+
+Application
+↓
+ImageStreamGrpcService
+↓
+ImageStreamCtrl
+↓
+Camera SDK
+
+ImageStreamCtrl は Camera SDK を抽象化する層です。
+ImageStreamGrpcService は画像配信だけを担当します。
+
+## 開発フロー
+
+1. ImageStreamCtrl を OpenCV で動かす
+2. SDK に置き換える
+3. run_image_server.py を起動
+4. Viewer で確認
+5. DeviceProxy や AI システムへ組み込む
+
+## 想定用途
+
+- USB Camera
+- Basler
+- IDS
+- HikVision
+- GigE Vision
+- ORiN Camera
+- AI 推論サーバ
+- 外観検査
+- ロボットビジョン

image_server_kit-0.0.1/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "image-server-kit"
+
+version = "0.0.1"
+
+description = "image_server (Template)"
+authors = [
+  { name="Kengo NAKADA", email="kengo.nakada@email.com" }
+]
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [
+    "xlogger-py",
+    #
+    "pyserial",
+    "nest_asyncio",
+    "pydantic",
+    "pyyaml",
+    "pytest",
+    "sphinx",
+    "myst-parser",
+    "sphinx-autobuild",
+    "sphinx-rtd-theme",
+    "sphinxcontrib-napoleon",
+    "linkify-it-py"
+]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+
+# ここでpytestのiniと同じようにオプションが書ける
+# 例えばテストマーク、フィルタ、カバレッジなども追記可能
+
+[tool.black]
+line-length = 88
+
+[tool.isort]
+profile = "black"

image_server_kit-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

image_server_kit-0.0.1/src/image_server/__init__.py

@@ -0,0 +1,3 @@
+from image_server.image_stream_ctrl import ImageStreamDeviceClass
+
+__all__ = ["ImageStreamDeviceClass"]

image_server_kit-0.0.1/src/image_server/image_stream_ctrl.py

@@ -0,0 +1,382 @@
+"""OpenCVを使用したローカル画像取得制御。"""
+
+import threading
+import time
+from typing import Any, Dict, Optional
+
+import cv2
+
+
+class ImageStreamDeviceClass:
+    """gRPCに依存しないOpenCVカメラ制御クラス。"""
+
+    def __init__(
+        self,
+        camera_id=0,
+        interval_sec=0.03,
+        width=None,
+        height=None,
+        fps=None,
+        backend=None,
+        reconnect_interval_sec=1.0,
+        logger=None,
+    ):
+        # type: (int, float, Optional[int], Optional[int], Optional[float], Optional[int], float, Optional[Any]) -> None
+        self._logger = logger
+        self._camera_id = int(camera_id)
+        self._interval_sec = max(0.001, float(interval_sec))
+        self._width = self._optional_positive_int(width)
+        self._height = self._optional_positive_int(height)
+        self._fps = self._optional_positive_float(fps)
+        self._backend = backend
+        self._reconnect_interval_sec = max(0.1, float(reconnect_interval_sec))
+
+        self._capture = None  # type: Optional[cv2.VideoCapture]
+        self._thread = None  # type: Optional[threading.Thread]
+        self._stop_event = threading.Event()
+        self._capture_lock = threading.RLock()
+        self._frame_lock = threading.RLock()
+
+        self._running = False
+        self._frame_id = 0
+        self._read_error_count = 0
+        self._last_error = None  # type: Optional[str]
+        self._last_frame_time_ns = None  # type: Optional[int]
+        self._latest_frame = None
+        self._started_time_ns = None  # type: Optional[int]
+
+    def connect(self):
+        # type: () -> bool
+        """カメラを開き、ローカル画像取得ループを開始する。"""
+        with self._capture_lock:
+            if self._capture is None or not self._capture.isOpened():
+                if not self._open_capture_unlocked():
+                    return False
+
+        return self.start_capture()
+
+    def disconnect(self):
+        # type: () -> bool
+        """画像取得ループを停止し、カメラを解放する。"""
+        self.stop_capture()
+        with self._capture_lock:
+            self._release_capture_unlocked()
+        self._log("info", "camera disconnected")
+        return True
+
+    def is_connected(self):
+        # type: () -> bool
+        """カメラが開かれているかを返す。"""
+        with self._capture_lock:
+            if self._capture is None:
+                return False
+            return bool(self._capture.isOpened())
+
+    def start_capture(self):
+        # type: () -> bool
+        """ローカル画像取得スレッドを開始する。"""
+        if self._running:
+            return True
+
+        with self._capture_lock:
+            if self._capture is None or not self._capture.isOpened():
+                if not self._open_capture_unlocked():
+                    return False
+
+        self._stop_event.clear()
+        self._running = True
+        self._started_time_ns = self._time_ns()
+        self._thread = threading.Thread(
+            target=self._capture_loop,
+            name="ImageStreamDeviceClass",
+        )
+        self._thread.daemon = True
+        self._thread.start()
+        self._log("info", "local image capture started")
+        return True
+
+    def stop_capture(self):
+        # type: () -> bool
+        """ローカル画像取得スレッドを停止する。"""
+        self._stop_event.set()
+        thread = self._thread
+        if thread is not None and thread.is_alive():
+            if thread is not threading.current_thread():
+                thread.join(3.0)
+        self._thread = None
+        self._running = False
+        self._log("info", "local image capture stopped")
+        return True
+
+    def read_once(self):
+        # type: () -> Any
+        """カメラから画像を1枚同期取得する。"""
+        if not self.is_connected():
+            with self._capture_lock:
+                if not self._open_capture_unlocked():
+                    raise RuntimeError(str(self._last_error))
+        return self._read_frame()
+
+    def get_latest_frame(self, copy_frame=True):
+        # type: (bool) -> Any
+        """取得済みの最新画像を返す。"""
+        with self._frame_lock:
+            if self._latest_frame is None:
+                return None
+            if copy_frame:
+                return self._latest_frame.copy()
+            return self._latest_frame
+
+    def get_status(self):
+        # type: () -> Dict[str, Any]
+        """ローカル画像取得状態を返す。"""
+        actual_width = None
+        actual_height = None
+        actual_fps = None
+
+        with self._capture_lock:
+            if self._capture is not None and self._capture.isOpened():
+                actual_width = int(self._capture.get(cv2.CAP_PROP_FRAME_WIDTH))
+                actual_height = int(self._capture.get(cv2.CAP_PROP_FRAME_HEIGHT))
+                actual_fps = float(self._capture.get(cv2.CAP_PROP_FPS))
+
+        uptime_sec = 0.0
+        if self._started_time_ns is not None:
+            uptime_sec = (
+                self._time_ns() - self._started_time_ns
+            ) / 1000000000.0
+
+        return {
+            "running": self._running,
+            "camera_id": self._camera_id,
+            "capture_opened": self.is_connected(),
+            "interval_sec": self._interval_sec,
+            "requested_width": self._width,
+            "requested_height": self._height,
+            "requested_fps": self._fps,
+            "actual_width": actual_width,
+            "actual_height": actual_height,
+            "actual_fps": actual_fps,
+            "frame_id": self._frame_id,
+            "read_error_count": self._read_error_count,
+            "last_frame_time_ns": self._last_frame_time_ns,
+            "uptime_sec": uptime_sec,
+            "last_error": self._last_error,
+        }
+
+    def get_config(self):
+        # type: () -> Dict[str, Any]
+        """ローカルカメラ設定を返す。"""
+        return {
+            "camera_id": self._camera_id,
+            "interval_sec": self._interval_sec,
+            "width": self._width,
+            "height": self._height,
+            "fps": self._fps,
+            "backend": self._backend,
+            "reconnect_interval_sec": self._reconnect_interval_sec,
+        }
+
+    def set_camera_config(self, width=None, height=None, fps=None):
+        # type: (Optional[int], Optional[int], Optional[float]) -> Dict[str, Any]
+        """解像度およびFPSの要求値を更新する。"""
+        self._width = self._optional_positive_int(width)
+        self._height = self._optional_positive_int(height)
+        self._fps = self._optional_positive_float(fps)
+
+        with self._capture_lock:
+            if self._capture is not None and self._capture.isOpened():
+                self._apply_capture_settings_unlocked()
+
+        return self.get_status()
+
+    def set_camera_id(self, camera_id):
+        # type: (int) -> bool
+        """カメラIDを変更して再接続する。"""
+        self.stop_capture()
+        with self._capture_lock:
+            self._release_capture_unlocked()
+            self._camera_id = int(camera_id)
+        return self.connect()
+
+    def clear_error(self):
+        # type: () -> bool
+        """直近のエラー文字列を消去する。"""
+        self._last_error = None
+        return True
+
+    def _capture_loop(self):
+        # type: () -> None
+        next_time = time.monotonic()
+
+        try:
+            while not self._stop_event.is_set():
+                try:
+                    self._read_frame()
+                except Exception as exc:
+                    self._set_error(str(exc))
+                    self._stop_event.wait(self._reconnect_interval_sec)
+                    with self._capture_lock:
+                        self._open_capture_unlocked()
+
+                next_time += self._interval_sec
+                delay = next_time - time.monotonic()
+                if delay > 0.0:
+                    self._stop_event.wait(delay)
+                else:
+                    next_time = time.monotonic()
+        finally:
+            self._running = False
+
+    def _read_frame(self):
+        # type: () -> Any
+        with self._capture_lock:
+            if self._capture is None or not self._capture.isOpened():
+                raise RuntimeError("Camera is not connected.")
+            ok, frame = self._capture.read()
+
+        if not ok or frame is None:
+            self._read_error_count += 1
+            with self._capture_lock:
+                self._release_capture_unlocked()
+            raise RuntimeError("Failed to read frame.")
+
+        with self._frame_lock:
+            self._latest_frame = frame.copy()
+            self._frame_id += 1
+            self._last_frame_time_ns = self._time_ns()
+
+        self._last_error = None
+        return frame
+
+    def _open_capture_unlocked(self):
+        # type: () -> bool
+        self._release_capture_unlocked()
+
+        try:
+            if self._backend is None:
+                capture = cv2.VideoCapture(self._camera_id)
+            else:
+                capture = cv2.VideoCapture(
+                    self._camera_id,
+                    int(self._backend),
+                )
+        except Exception as exc:
+            self._set_error(
+                "Failed to create VideoCapture: {}".format(exc)
+            )
+            return False
+
+        self._capture = capture
+        if not capture.isOpened():
+            self._set_error(
+                "Failed to open camera: {}".format(self._camera_id)
+            )
+            self._release_capture_unlocked()
+            return False
+
+        self._apply_capture_settings_unlocked()
+        self._last_error = None
+        self._log(
+            "info",
+            "camera connected: camera_id={}".format(self._camera_id),
+        )
+        return True
+
+    def _apply_capture_settings_unlocked(self):
+        # type: () -> None
+        if self._capture is None:
+            return
+        if self._width is not None:
+            self._capture.set(cv2.CAP_PROP_FRAME_WIDTH, self._width)
+        if self._height is not None:
+            self._capture.set(cv2.CAP_PROP_FRAME_HEIGHT, self._height)
+        if self._fps is not None:
+            self._capture.set(cv2.CAP_PROP_FPS, self._fps)
+
+    def _release_capture_unlocked(self):
+        # type: () -> None
+        if self._capture is not None:
+            try:
+                self._capture.release()
+            except Exception:
+                pass
+        self._capture = None
+
+    def _set_error(self, message):
+        # type: (str) -> None
+        self._last_error = str(message)
+        self._log("error", self._last_error)
+
+    def _log(self, level, message):
+        # type: (str, str) -> None
+        if self._logger is None:
+            return
+        method = getattr(self._logger, level, None)
+        if callable(method):
+            method(message)
+
+    @staticmethod
+    def _optional_positive_int(value):
+        # type: (Optional[int]) -> Optional[int]
+        if value is None:
+            return None
+        converted = int(value)
+        if converted <= 0:
+            raise ValueError("value must be greater than zero.")
+        return converted
+
+    @staticmethod
+    def _optional_positive_float(value):
+        # type: (Optional[float]) -> Optional[float]
+        if value is None:
+            return None
+        converted = float(value)
+        if converted <= 0.0:
+            raise ValueError("value must be greater than zero.")
+        return converted
+
+    @staticmethod
+    def _time_ns():
+        # type: () -> int
+        return int(time.time() * 1000000000)
+
+CAMERA_ID = 0
+CAPTURE_INTERVAL_SEC = 0.03
+CAMERA_WIDTH = None
+CAMERA_HEIGHT = None
+CAMERA_FPS = None
+WINDOW_NAME = "ImageStreamDeviceClass"
+
+
+def main():
+    """ローカルカメラへ接続し、取得画像をOpenCVウィンドウへ表示する。"""
+    image_stream = ImageStreamDeviceClass(
+        camera_id=CAMERA_ID,
+        interval_sec=CAPTURE_INTERVAL_SEC,
+        width=CAMERA_WIDTH,
+        height=CAMERA_HEIGHT,
+        fps=CAMERA_FPS,
+    )
+
+    if not image_stream.connect():
+        raise RuntimeError(str(image_stream.get_status()))
+
+    try:
+        while True:
+            frame = image_stream.get_latest_frame()
+            if frame is None:
+                time.sleep(0.01)
+                continue
+
+            cv2.imshow(WINDOW_NAME, frame)
+            key = cv2.waitKey(1) & 0xFF
+            if key == 27 or key == ord("q"):
+                break
+    finally:
+        image_stream.disconnect()
+        cv2.destroyAllWindows()
+
+
+if __name__ == "__main__":
+    main()

image_server_kit-0.0.1/src/image_server/server_grpc/__init__.py

@@ -0,0 +1,7 @@
+from image_server.server_grpc.client import ImageStreamClient
+from image_server.server_grpc.image_stream_grpc_service import ImageStreamGrpcService
+
+__all__ = [
+    "ImageStreamClient",
+    "ImageStreamGrpcService",
+]

image_server_kit-0.0.1/src/image_server/server_grpc/client.py

@@ -0,0 +1,88 @@
+"""grpc_frame用同期画像クライアント。"""
+
+from typing import Any, Dict, Iterator, Optional, Tuple
+
+import cv2
+import numpy as np
+
+from grpc_frame.grpc_client import SyncGrpcClient
+
+
+class ImageStreamClient(SyncGrpcClient):
+    """ImageStreamGrpcService用同期クライアント。"""
+
+    def __init__(
+        self,
+        server_ip,
+        server_port,
+        timeout_sec=None,
+        logger=None,
+        max_message_mb=64,
+    ):
+        # type: (str, int, Optional[float], Optional[Any], int) -> None
+        kwargs = {
+            "server_ip": server_ip,
+            "server_port": server_port,
+            "timeout_sec": timeout_sec,
+            "logger": logger,
+        }
+        try:
+            SyncGrpcClient.__init__(
+                self,
+                max_message_mb=max_message_mb,
+                **kwargs
+            )
+        except TypeError:
+            SyncGrpcClient.__init__(self, **kwargs)
+
+    @staticmethod
+    def decode_payload(payload):
+        # type: (Dict[str, Any]) -> Any
+        image_bytes = payload.get("image")
+        if not isinstance(
+            image_bytes,
+            (bytes, bytearray, memoryview),
+        ):
+            raise ValueError(
+                "payload does not contain JPEG bytes."
+            )
+
+        image_array = np.frombuffer(
+            image_bytes,
+            dtype=np.uint8,
+        )
+        frame = cv2.imdecode(
+            image_array,
+            cv2.IMREAD_COLOR,
+        )
+        if frame is None:
+            raise ValueError("Failed to decode JPEG payload.")
+        return frame
+
+    def iter_frames(self, topic="camera.frame"):
+        # type: (str) -> Iterator[Tuple[Dict[str, Any], Any]]
+        for payload in self.subscribe(topic=topic):
+            try:
+                frame = self.decode_payload(payload)
+            except ValueError:
+                continue
+            yield payload, frame
+
+    def show_camera_frame_stream(
+        self,
+        topic="camera.frame",
+        window_name="camera.frame",
+    ):
+        # type: (str, str) -> None
+        self.start_stream()
+        try:
+            for _payload, frame in self.iter_frames(topic=topic):
+                cv2.imshow(window_name, frame)
+                key = cv2.waitKey(1) & 0xFF
+                if key == 27 or key == ord("q"):
+                    break
+        finally:
+            try:
+                self.stop_stream()
+            finally:
+                cv2.destroyAllWindows()

image_server_kit-0.0.1/src/image_server/server_grpc/client.pyi

@@ -0,0 +1,21 @@
+from typing import Any, Optional, Union, Dict, List, Tuple, Callable, Sequence
+
+class ImageStreamClient:
+    def __init__(self, server_ip: Any, server_port: Any, timeout_sec: Any = ..., logger: Any = ..., max_message_mb: Any = ...) -> None: ...
+    def decode_payload(self, payload: Any) -> Any: ...
+    def iter_frames(self, topic: Any = ...) -> Any: ...
+    def show_camera_frame_stream(self, topic: Any = ..., window_name: Any = ...) -> Any: ...
+    def connect(self) -> Any: ...
+    def disconnect(self) -> Any: ...
+    def is_connected(self) -> Any: ...
+    def start_stream(self) -> Any: ...
+    def stop_stream(self) -> Any: ...
+    def capture_once(self) -> Any: ...
+    def publish_once(self) -> Any: ...
+    def save_snapshot(self, file_path: Any) -> Any: ...
+    def get_status(self) -> Any: ...
+    def get_config(self) -> Any: ...
+    def set_stream_config(self, interval_sec: Any = ..., jpeg_quality: Any = ..., topic_name: Any = ...) -> Any: ...
+    def set_camera_config(self, width: Any = ..., height: Any = ..., fps: Any = ...) -> Any: ...
+    def set_camera_id(self, camera_id: Any) -> Any: ...
+    def clear_error(self) -> Any: ...

image_server_kit-0.0.1/src/image_server/server_grpc/image_stream_grpc_service.py

@@ -0,0 +1,272 @@
+"""ImageStreamDeviceClassをgrpc_frameへ公開するサービス層。"""
+
+import os
+import threading
+import time
+from typing import Any, Dict, Optional
+
+import cv2
+
+from image_server.image_stream_ctrl import ImageStreamDeviceClass
+
+
+class ImageStreamGrpcService:
+    """ローカル画像制御をgRPC公開およびEventBus配信へ接続する。"""
+
+    def __init__(
+        self,
+        image_stream=None,
+        topic_name="camera.frame",
+        publish_interval_sec=0.1,
+        jpeg_quality=85,
+        logger=None,
+    ):
+        # type: (Optional[ImageStreamDeviceClass], str, float, int, Optional[Any]) -> None
+        self._logger = logger
+        self._image_stream = image_stream
+        if self._image_stream is None:
+            self._image_stream = ImageStreamDeviceClass(logger=logger)
+
+        self._topic_name = str(topic_name)
+        self._publish_interval_sec = max(
+            0.001,
+            float(publish_interval_sec),
+        )
+        self._jpeg_quality = self._validate_jpeg_quality(jpeg_quality)
+        self._event_bus = None
+        self._thread = None  # type: Optional[threading.Thread]
+        self._stop_event = threading.Event()
+        self._running = False
+        self._published_count = 0
+        self._encode_error_count = 0
+        self._last_publish_time_ns = None  # type: Optional[int]
+        self._last_error = None  # type: Optional[str]
+
+    def _set_event_bus(self, event_bus):
+        # type: (Any) -> None
+        """grpc_frameからEventBusを設定する。"""
+        self._event_bus = event_bus
+
+    def connect(self):
+        # type: () -> bool
+        """ローカル画像取得デバイスへ接続する。"""
+        return self._image_stream.connect()
+
+    def disconnect(self):
+        # type: () -> bool
+        """配信を停止し、ローカル画像取得デバイスを切断する。"""
+        self.stop_stream()
+        return self._image_stream.disconnect()
+
+    def is_connected(self):
+        # type: () -> bool
+        return self._image_stream.is_connected()
+
+    def start_stream(self):
+        # type: () -> bool
+        """EventBusへのJPEG画像配信を開始する。"""
+        if self._event_bus is None:
+            raise RuntimeError("EventBus is not set.")
+        if not self._image_stream.connect():
+            return False
+        if self._running:
+            return True
+
+        self._stop_event.clear()
+        self._running = True
+        self._thread = threading.Thread(
+            target=self._publish_loop,
+            name="ImageStreamGrpcService",
+        )
+        self._thread.daemon = True
+        self._thread.start()
+        return True
+
+    def stop_stream(self):
+        # type: () -> bool
+        """EventBusへの画像配信を停止する。"""
+        self._stop_event.set()
+        thread = self._thread
+        if thread is not None and thread.is_alive():
+            if thread is not threading.current_thread():
+                thread.join(3.0)
+        self._thread = None
+        self._running = False
+        return True
+
+    def capture_once(self):
+        # type: () -> Dict[str, Any]
+        """最新画像をJPEGペイロードとして返す。"""
+        frame = self._image_stream.get_latest_frame()
+        if frame is None:
+            frame = self._image_stream.read_once()
+        return self._encode_frame(frame)
+
+    def publish_once(self):
+        # type: () -> bool
+        """最新画像をEventBusへ1回配信する。"""
+        if self._event_bus is None:
+            raise RuntimeError("EventBus is not set.")
+
+        payload = self.capture_once()
+        self._event_bus.publish(
+            self._topic_name,
+            payload,
+            source="image_stream_grpc_service",
+        )
+        self._published_count += 1
+        self._last_publish_time_ns = self._time_ns()
+        return True
+
+    def save_snapshot(self, file_path):
+        # type: (str) -> Dict[str, Any]
+        """サーバー側ファイルへ最新画像を保存する。"""
+        if not file_path:
+            raise ValueError("file_path is required.")
+
+        frame = self._image_stream.get_latest_frame()
+        if frame is None:
+            frame = self._image_stream.read_once()
+
+        directory = os.path.dirname(os.path.abspath(file_path))
+        if directory and not os.path.isdir(directory):
+            os.makedirs(directory)
+
+        if not cv2.imwrite(file_path, frame):
+            raise RuntimeError(
+                "Failed to save snapshot: {}".format(file_path)
+            )
+
+        return {
+            "file_path": os.path.abspath(file_path),
+            "width": int(frame.shape[1]),
+            "height": int(frame.shape[0]),
+            "timestamp_ns": self._time_ns(),
+        }
+
+    def get_status(self):
+        # type: () -> Dict[str, Any]
+        """ローカル取得状態とgRPC配信状態を統合して返す。"""
+        status = self._image_stream.get_status()
+        status.update(
+            {
+                "stream_running": self._running,
+                "topic_name": self._topic_name,
+                "publish_interval_sec": self._publish_interval_sec,
+                "jpeg_quality": self._jpeg_quality,
+                "published_count": self._published_count,
+                "encode_error_count": self._encode_error_count,
+                "last_publish_time_ns": self._last_publish_time_ns,
+                "grpc_last_error": self._last_error,
+            }
+        )
+        return status
+
+    def get_config(self):
+        # type: () -> Dict[str, Any]
+        """ローカル設定と配信設定を返す。"""
+        return {
+            "camera": self._image_stream.get_config(),
+            "stream": {
+                "topic_name": self._topic_name,
+                "publish_interval_sec": self._publish_interval_sec,
+                "jpeg_quality": self._jpeg_quality,
+            },
+        }
+
+    def set_stream_config(
+        self,
+        interval_sec=None,
+        jpeg_quality=None,
+        topic_name=None,
+    ):
+        # type: (Optional[float], Optional[int], Optional[str]) -> Dict[str, Any]
+        """gRPC配信設定を変更する。"""
+        if interval_sec is not None:
+            self._publish_interval_sec = max(
+                0.001,
+                float(interval_sec),
+            )
+        if jpeg_quality is not None:
+            self._jpeg_quality = self._validate_jpeg_quality(
+                jpeg_quality
+            )
+        if topic_name is not None:
+            if not str(topic_name).strip():
+                raise ValueError("topic_name must not be empty.")
+            self._topic_name = str(topic_name)
+        return self.get_config()
+
+    def set_camera_config(self, width=None, height=None, fps=None):
+        # type: (Optional[int], Optional[int], Optional[float]) -> Dict[str, Any]
+        return self._image_stream.set_camera_config(
+            width,
+            height,
+            fps,
+        )
+
+    def set_camera_id(self, camera_id):
+        # type: (int) -> bool
+        return self._image_stream.set_camera_id(camera_id)
+
+    def clear_error(self):
+        # type: () -> bool
+        self._last_error = None
+        self._image_stream.clear_error()
+        return True
+
+    def _publish_loop(self):
+        # type: () -> None
+        next_time = time.monotonic()
+
+        try:
+            while not self._stop_event.is_set():
+                try:
+                    self.publish_once()
+                    self._last_error = None
+                except Exception as exc:
+                    self._last_error = str(exc)
+
+                next_time += self._publish_interval_sec
+                delay = next_time - time.monotonic()
+                if delay > 0.0:
+                    self._stop_event.wait(delay)
+                else:
+                    next_time = time.monotonic()
+        finally:
+            self._running = False
+
+    def _encode_frame(self, frame):
+        # type: (Any) -> Dict[str, Any]
+        params = [
+            int(cv2.IMWRITE_JPEG_QUALITY),
+            self._jpeg_quality,
+        ]
+        ok, encoded = cv2.imencode(".jpg", frame, params)
+        if not ok:
+            self._encode_error_count += 1
+            raise RuntimeError("Failed to encode frame.")
+
+        return {
+            "frame_id": self._image_stream.get_status().get("frame_id"),
+            "timestamp_ns": self._time_ns(),
+            "encoding": "jpg",
+            "width": int(frame.shape[1]),
+            "height": int(frame.shape[0]),
+            "image": encoded.tobytes(),
+        }
+
+    @staticmethod
+    def _validate_jpeg_quality(value):
+        # type: (int) -> int
+        quality = int(value)
+        if quality < 1 or quality > 100:
+            raise ValueError(
+                "jpeg_quality must be between 1 and 100."
+            )
+        return quality
+
+    @staticmethod
+    def _time_ns():
+        # type: () -> int
+        return int(time.time() * 1000000000)

image_server_kit-0.0.1/src/image_server/server_grpc/make_pyi.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+"""ImageStreamClientの型スタブを生成する。"""
+
+import inspect
+from pathlib import Path
+
+from grpc_frame.grpc_client import SyncGrpcClient
+from grpc_frame.make_pyi import generate_client_pyi
+
+
+CLIENT_CLASS_NAME = "ImageStreamClient"
+CTRL_CLASS_NAME = "ImageStreamGrpcService"
+BASE_CLASS_NAME = "SyncGrpcClient"
+
+
+def main():
+    """grpc_frameのgenerate_client_pyi()でclient.pyiを生成する。"""
+    current_dir = Path(__file__).resolve().parent
+    grpc_client_file = Path(inspect.getfile(SyncGrpcClient)).resolve()
+
+    generate_client_pyi(
+        client_py=current_dir / "client.py",
+        client_class=CLIENT_CLASS_NAME,
+        ctrl_py=current_dir / "image_stream_grpc_service.py",
+        ctrl_class=CTRL_CLASS_NAME,
+        base_py=grpc_client_file,
+        base_class=BASE_CLASS_NAME,
+        out_path=current_dir / "client.pyi",
+    )
+
+    print("generated: {}".format(current_dir / "client.pyi"))
+
+
+if __name__ == "__main__":
+    main()

image_server_kit-0.0.1/src/image_server_kit.egg-info/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: image-server-kit
+Version: 0.0.1
+Summary: image_server (Template)
+Author-email: Kengo NAKADA <kengo.nakada@email.com>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xlogger-py
+Requires-Dist: pyserial
+Requires-Dist: nest_asyncio
+Requires-Dist: pydantic
+Requires-Dist: pyyaml
+Requires-Dist: pytest
+Requires-Dist: sphinx
+Requires-Dist: myst-parser
+Requires-Dist: sphinx-autobuild
+Requires-Dist: sphinx-rtd-theme
+Requires-Dist: sphinxcontrib-napoleon
+Requires-Dist: linkify-it-py
+Dynamic: license-file
+
+# image_server
+
+image_server は「USBカメラを扱うライブラリ」ではありません。
+
+本ライブラリは **画像転送機能を既存プログラムへ組み込むためのテンプレート** です。
+OpenCV・gRPC・Viewer を毎回実装するのではなく、画像取得部分だけを書き換えることで
+画像転送システムを短時間で構築できることを目的としています。
+
+## このライブラリが解決する問題
+
+通常は次のような処理を毎回実装する必要があります。
+
+- カメラ接続
+- フレーム取得
+- JPEG圧縮
+- 通信
+- Viewer
+- 接続管理
+- スレッド管理
+
+image_server はこれらを共通化し、利用者は **画像取得部だけ** を実装します。
+
+## レイヤ構造
+
+Application
+↓
+ImageStreamGrpcService
+↓
+ImageStreamCtrl
+↓
+Camera SDK
+
+ImageStreamCtrl は Camera SDK を抽象化する層です。
+ImageStreamGrpcService は画像配信だけを担当します。
+
+## 開発フロー
+
+1. ImageStreamCtrl を OpenCV で動かす
+2. SDK に置き換える
+3. run_image_server.py を起動
+4. Viewer で確認
+5. DeviceProxy や AI システムへ組み込む
+
+## 想定用途
+
+- USB Camera
+- Basler
+- IDS
+- HikVision
+- GigE Vision
+- ORiN Camera
+- AI 推論サーバ
+- 外観検査
+- ロボットビジョン

image_server_kit-0.0.1/src/image_server_kit.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+pyproject.toml
+src/image_server/__init__.py
+src/image_server/image_stream_ctrl.py
+src/image_server/server_grpc/__init__.py
+src/image_server/server_grpc/client.py
+src/image_server/server_grpc/client.pyi
+src/image_server/server_grpc/image_stream_grpc_service.py
+src/image_server/server_grpc/make_pyi.py
+src/image_server_kit.egg-info/PKG-INFO
+src/image_server_kit.egg-info/SOURCES.txt
+src/image_server_kit.egg-info/dependency_links.txt
+src/image_server_kit.egg-info/requires.txt
+src/image_server_kit.egg-info/top_level.txt

image_server_kit-0.0.1/src/image_server_kit.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

image_server_kit-0.0.1/src/image_server_kit.egg-info/requires.txt

@@ -0,0 +1,12 @@
+xlogger-py
+pyserial
+nest_asyncio
+pydantic
+pyyaml
+pytest
+sphinx
+myst-parser
+sphinx-autobuild
+sphinx-rtd-theme
+sphinxcontrib-napoleon
+linkify-it-py

image_server_kit-0.0.1/src/image_server_kit.egg-info/top_level.txt

@@ -0,0 +1 @@
+image_server