triggercam 0.1.0__tar.gz

triggercam-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 tuo170
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

triggercam-0.1.0/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: triggercam
+Version: 0.1.0
+Summary: Thread-safe webcam capture with on-demand start/stop recording, built on OpenCV
+Author: tuo170
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/tuo170/triggercam
+Project-URL: Issues, https://github.com/tuo170/triggercam/issues
+Keywords: opencv,webcam,camera,recording,threading
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Multimedia :: Video :: Capture
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: opencv-python>=4.5
+Dynamic: license-file
+
+# triggercam
+
+> Thread-safe webcam capture for Python with on-demand start/stop recording, built on OpenCV.
+
+OpenCVベースの、スレッドセーフなWebカメラキャプチャライブラリです。プレビューを表示し続けたまま、録画の開始・停止を好きなタイミングでトリガーできます。
+
+```python
+import time
+from triggercam import Camera
+
+with Camera() as cam:
+    time.sleep(10)
+    cam.start_recording("clip")   # clip.mp4 に書き込み開始
+    time.sleep(10)
+    cam.stop_recording()          # clip_20260101-120000.mp4 にリネーム
+```
+
+## なぜtriggercamなのか
+
+よくある録画系のサンプルは「プログラム起動と同時に録画開始、`q`キーで終了」という一発勝負の構成がほとんどです。
+
+カメラのプレビューは動かし続けたまま、録画のON/OFFだけを自分のコードから好きなタイミング（センサーのトリガー、スケジュール、ボタン操作、検知イベントなど）で切り替えたい、というケース向けの例はあまり見かけませんでした。
+
+triggercam（本プログラム）では、それができます。
+
+現状、単純な録画ON/OFFのみの機能となっています。
+複数カメラ対応・動体検知・NVR的なUIが欲しい場合は、他の本格的なアプリケーションについても検討してください。
+
+## インストール
+
+```bash
+pip install triggercam
+```
+
+（まだPyPIには公開していません。今のところはソースから `pip install -e .` でインストールしてください）
+
+## API
+
+- `Camera(index=0, width=1280, height=720, fps=30, show_preview=True)` — カメラを開き、即座にバックグラウンドのキャプチャスレッドを開始します。
+- `cam.start_recording(filename)` — `<filename>.mp4`への書き込みを開始します。Writerが開けなかった場合（非対応コーデックなど）は`RuntimeError`を送出します。すでに録画中の場合は何もしません。
+- `cam.stop_recording()` — 録画を停止し、ファイル名を`<filename>_<タイムスタンプ>.mp4`にリネームします。最終的なパスを返します（録画していなかった場合は`None`）。
+- `cam.running` — キャプチャスレッドが停止すると`False`になります（カメラが切断された場合、プレビューウィンドウで`q`が押された場合など）。
+- `cam.close()` — スレッドを停止し、カメラ・Writerのリソースを解放します。プログラムが中断されても録画ファイルが壊れた状態で残らないよう、必ず呼び出してください（`with Camera() as cam:`を使えば自動的に呼ばれます）。
+
+一通りの流れと、Ctrl+Cでの安全な終了方法は[`examples/basic_recording.py`](examples/basic_recording.py)を参照してください。
+
+## 動作検証
+
+### 検証環境（2026-08-21）
+
+| 項目 | 内容 |
+|---|---|
+| OS | Windows 11 Pro |
+| Python | 3.10.6（プロジェクト専用のvenv） |
+| インストール方法 | `pip install -e .` |
+| 依存パッケージ | opencv-python 5.0.0.93 |
+| カメラ | Logi C270 HD WebCam（USB UVCカメラ） |
+
+### 確認できたこと
+
+- カメラが正しく認識され、プレビューウィンドウに実際の映像が表示されることを確認（起動してからプレビューウィンドウが表示されるまで少し時間がかかる）。
+- `start_recording()` → `stop_recording()` の一連の流れが正常に動作し、`clip.mp4` が `clip_<タイムスタンプ>.mp4` に正しくリネームされることを確認。
+- 録画サイクル（10秒待機→録画→待機→停止）が問題なく動作することを確認。
+- 録画中に`Ctrl+C`で強制中断した際、そのファイルが正しく`stop_recording()`まで処理された状態で残ることを確認（未リネームの壊れたファイルが残らない）。
+- 生成された動画ファイルはメディアプレイヤーで正常に再生可能なことを確認。
+
+### 未検証
+
+- Linux / macOSでの動作（カメラインデックスでのキャプチャのため動作するはずだが、実機未確認）
+
+## ライセンス
+
+MIT — [LICENSE](LICENSE)を参照してください。
+
+## 背景
+
+このライブラリは、[Qiitaに投稿した元のプログラム](https://qiita.com/tuo170/items/ca1933a88f3255792214)
+（ https://qiita.com/tuo170/items/ca1933a88f3255792214 ）
+を土台に、バグ修正・API設計・パッケージ化を行って作られています。
+
+実装のコーディングやレビュー、設計の壁打ち相手としてClaude Codeを使用しました。

triggercam-0.1.0/README.md

@@ -0,0 +1,81 @@
+# triggercam
+
+> Thread-safe webcam capture for Python with on-demand start/stop recording, built on OpenCV.
+
+OpenCVベースの、スレッドセーフなWebカメラキャプチャライブラリです。プレビューを表示し続けたまま、録画の開始・停止を好きなタイミングでトリガーできます。
+
+```python
+import time
+from triggercam import Camera
+
+with Camera() as cam:
+    time.sleep(10)
+    cam.start_recording("clip")   # clip.mp4 に書き込み開始
+    time.sleep(10)
+    cam.stop_recording()          # clip_20260101-120000.mp4 にリネーム
+```
+
+## なぜtriggercamなのか
+
+よくある録画系のサンプルは「プログラム起動と同時に録画開始、`q`キーで終了」という一発勝負の構成がほとんどです。
+
+カメラのプレビューは動かし続けたまま、録画のON/OFFだけを自分のコードから好きなタイミング（センサーのトリガー、スケジュール、ボタン操作、検知イベントなど）で切り替えたい、というケース向けの例はあまり見かけませんでした。
+
+triggercam（本プログラム）では、それができます。
+
+現状、単純な録画ON/OFFのみの機能となっています。
+複数カメラ対応・動体検知・NVR的なUIが欲しい場合は、他の本格的なアプリケーションについても検討してください。
+
+## インストール
+
+```bash
+pip install triggercam
+```
+
+（まだPyPIには公開していません。今のところはソースから `pip install -e .` でインストールしてください）
+
+## API
+
+- `Camera(index=0, width=1280, height=720, fps=30, show_preview=True)` — カメラを開き、即座にバックグラウンドのキャプチャスレッドを開始します。
+- `cam.start_recording(filename)` — `<filename>.mp4`への書き込みを開始します。Writerが開けなかった場合（非対応コーデックなど）は`RuntimeError`を送出します。すでに録画中の場合は何もしません。
+- `cam.stop_recording()` — 録画を停止し、ファイル名を`<filename>_<タイムスタンプ>.mp4`にリネームします。最終的なパスを返します（録画していなかった場合は`None`）。
+- `cam.running` — キャプチャスレッドが停止すると`False`になります（カメラが切断された場合、プレビューウィンドウで`q`が押された場合など）。
+- `cam.close()` — スレッドを停止し、カメラ・Writerのリソースを解放します。プログラムが中断されても録画ファイルが壊れた状態で残らないよう、必ず呼び出してください（`with Camera() as cam:`を使えば自動的に呼ばれます）。
+
+一通りの流れと、Ctrl+Cでの安全な終了方法は[`examples/basic_recording.py`](examples/basic_recording.py)を参照してください。
+
+## 動作検証
+
+### 検証環境（2026-08-21）
+
+| 項目 | 内容 |
+|---|---|
+| OS | Windows 11 Pro |
+| Python | 3.10.6（プロジェクト専用のvenv） |
+| インストール方法 | `pip install -e .` |
+| 依存パッケージ | opencv-python 5.0.0.93 |
+| カメラ | Logi C270 HD WebCam（USB UVCカメラ） |
+
+### 確認できたこと
+
+- カメラが正しく認識され、プレビューウィンドウに実際の映像が表示されることを確認（起動してからプレビューウィンドウが表示されるまで少し時間がかかる）。
+- `start_recording()` → `stop_recording()` の一連の流れが正常に動作し、`clip.mp4` が `clip_<タイムスタンプ>.mp4` に正しくリネームされることを確認。
+- 録画サイクル（10秒待機→録画→待機→停止）が問題なく動作することを確認。
+- 録画中に`Ctrl+C`で強制中断した際、そのファイルが正しく`stop_recording()`まで処理された状態で残ることを確認（未リネームの壊れたファイルが残らない）。
+- 生成された動画ファイルはメディアプレイヤーで正常に再生可能なことを確認。
+
+### 未検証
+
+- Linux / macOSでの動作（カメラインデックスでのキャプチャのため動作するはずだが、実機未確認）
+
+## ライセンス
+
+MIT — [LICENSE](LICENSE)を参照してください。
+
+## 背景
+
+このライブラリは、[Qiitaに投稿した元のプログラム](https://qiita.com/tuo170/items/ca1933a88f3255792214)
+（ https://qiita.com/tuo170/items/ca1933a88f3255792214 ）
+を土台に、バグ修正・API設計・パッケージ化を行って作られています。
+
+実装のコーディングやレビュー、設計の壁打ち相手としてClaude Codeを使用しました。

triggercam-0.1.0/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "triggercam"
+version = "0.1.0"
+description = "Thread-safe webcam capture with on-demand start/stop recording, built on OpenCV"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+authors = [{ name = "tuo170" }]
+keywords = ["opencv", "webcam", "camera", "recording", "threading"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Topic :: Multimedia :: Video :: Capture",
+    "Intended Audience :: Developers",
+]
+dependencies = ["opencv-python>=4.5"]
+
+[project.urls]
+Homepage = "https://github.com/tuo170/triggercam"
+Issues = "https://github.com/tuo170/triggercam/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]

triggercam-0.1.0/setup.cfg

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

triggercam-0.1.0/src/triggercam/__init__.py

@@ -0,0 +1,4 @@
+from .camera import Camera
+
+__all__ = ["Camera"]
+__version__ = "0.1.0"

triggercam-0.1.0/src/triggercam/camera.py

@@ -0,0 +1,152 @@
+"""Thread-safe webcam capture with on-demand start/stop recording.
+
+The camera is opened once and continuously read on a background thread so
+that a preview window (if enabled) stays responsive. Recording to a video
+file can be toggled on and off at any time from another thread via
+``start_recording()`` / ``stop_recording()``.
+"""
+
+from __future__ import annotations
+
+import datetime
+import os
+import threading
+from typing import Optional
+
+import cv2
+
+
+class Camera:
+    """Continuously captures frames from a webcam on a background thread.
+
+    Example:
+        with Camera() as cam:
+            time.sleep(10)
+            cam.start_recording("clip")
+            time.sleep(10)
+            cam.stop_recording()
+    """
+
+    def __init__(
+        self,
+        index: int = 0,
+        width: int = 1280,
+        height: int = 720,
+        fps: int = 30,
+        show_preview: bool = True,
+    ) -> None:
+        self.index = index
+        self.width = width
+        self.height = height
+        self.fps = fps
+        self.show_preview = show_preview
+
+        self._cap = cv2.VideoCapture(self.index)
+        self._cap.set(cv2.CAP_PROP_FOURCC, cv2.VideoWriter.fourcc(*"MJPG"))
+        self._cap.set(cv2.CAP_PROP_FRAME_WIDTH, self.width)
+        self._cap.set(cv2.CAP_PROP_FRAME_HEIGHT, self.height)
+        self._cap.set(cv2.CAP_PROP_FPS, self.fps)
+
+        self._writer: Optional[cv2.VideoWriter] = None
+        self._writer_lock = threading.Lock()
+        self._recording = False
+        self._filename: Optional[str] = None
+        self._stopped = False
+
+        self._thread = threading.Thread(target=self._run, daemon=True)
+        self._thread.start()
+
+    # -- public API -----------------------------------------------------
+
+    @property
+    def running(self) -> bool:
+        """False once the capture thread has stopped (e.g. camera lost, or
+        'q' pressed in the preview window)."""
+        return not self._stopped
+
+    def start_recording(self, filename: str) -> None:
+        """Start writing frames to ``<filename>.mp4``.
+
+        Safe to call from any thread. No-op if already recording. Raises
+        ``RuntimeError`` if the video writer could not be opened (e.g.
+        unsupported codec), so recording state is never silently wrong.
+        """
+        with self._writer_lock:
+            if self._recording:
+                return
+            writer = cv2.VideoWriter(
+                f"{filename}.mp4",
+                cv2.VideoWriter.fourcc(*"mp4v"),
+                self.fps,
+                (self.width, self.height),
+            )
+            if not writer.isOpened():
+                raise RuntimeError(f"Failed to open video writer for {filename}.mp4")
+            # Only flip the flag once the writer is confirmed ready, so the
+            # capture thread never sees recording=True before there is
+            # somewhere to write to.
+            self._writer = writer
+            self._filename = filename
+            self._recording = True
+
+    def stop_recording(self) -> Optional[str]:
+        """Stop recording and rename the file with a timestamp suffix.
+
+        Returns the final filename, or ``None`` if nothing was recording.
+        Safe to call even if recording never successfully started.
+        """
+        with self._writer_lock:
+            if not self._recording:
+                return None
+            self._recording = False
+            if self._writer is not None:
+                self._writer.release()
+                self._writer = None
+            filename = self._filename
+            self._filename = None
+            src = f"{filename}.mp4"
+            if not os.path.exists(src):
+                return None
+            timestamp = datetime.datetime.now().strftime("%Y%m%d-%H%M%S")
+            dst = f"{filename}_{timestamp}.mp4"
+            os.rename(src, dst)
+            return dst
+
+    def close(self) -> None:
+        """Stop the capture thread and release all resources.
+
+        Finalizes any in-progress recording first, so Ctrl+C / normal
+        shutdown never leaves a corrupted, un-finalized video file. Safe to
+        call multiple times.
+        """
+        if self._stopped:
+            return
+        self._stopped = True
+        self._thread.join(timeout=2)
+        self.stop_recording()
+        if self._cap.isOpened():
+            self._cap.release()
+        if self.show_preview:
+            cv2.destroyAllWindows()
+
+    def __enter__(self) -> "Camera":
+        return self
+
+    def __exit__(self, exc_type, exc, tb) -> None:
+        self.close()
+
+    # -- internal ---------------------------------------------------------
+
+    def _run(self) -> None:
+        while not self._stopped:
+            ret, frame = self._cap.read()
+            if not ret:
+                continue
+            if self.show_preview:
+                cv2.imshow("triggercam", frame)
+                if cv2.waitKey(1) & 0xFF == ord("q"):
+                    self._stopped = True
+                    break
+            with self._writer_lock:
+                if self._recording and self._writer is not None:
+                    self._writer.write(frame)

triggercam-0.1.0/src/triggercam.egg-info/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: triggercam
+Version: 0.1.0
+Summary: Thread-safe webcam capture with on-demand start/stop recording, built on OpenCV
+Author: tuo170
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/tuo170/triggercam
+Project-URL: Issues, https://github.com/tuo170/triggercam/issues
+Keywords: opencv,webcam,camera,recording,threading
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Multimedia :: Video :: Capture
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: opencv-python>=4.5
+Dynamic: license-file
+
+# triggercam
+
+> Thread-safe webcam capture for Python with on-demand start/stop recording, built on OpenCV.
+
+OpenCVベースの、スレッドセーフなWebカメラキャプチャライブラリです。プレビューを表示し続けたまま、録画の開始・停止を好きなタイミングでトリガーできます。
+
+```python
+import time
+from triggercam import Camera
+
+with Camera() as cam:
+    time.sleep(10)
+    cam.start_recording("clip")   # clip.mp4 に書き込み開始
+    time.sleep(10)
+    cam.stop_recording()          # clip_20260101-120000.mp4 にリネーム
+```
+
+## なぜtriggercamなのか
+
+よくある録画系のサンプルは「プログラム起動と同時に録画開始、`q`キーで終了」という一発勝負の構成がほとんどです。
+
+カメラのプレビューは動かし続けたまま、録画のON/OFFだけを自分のコードから好きなタイミング（センサーのトリガー、スケジュール、ボタン操作、検知イベントなど）で切り替えたい、というケース向けの例はあまり見かけませんでした。
+
+triggercam（本プログラム）では、それができます。
+
+現状、単純な録画ON/OFFのみの機能となっています。
+複数カメラ対応・動体検知・NVR的なUIが欲しい場合は、他の本格的なアプリケーションについても検討してください。
+
+## インストール
+
+```bash
+pip install triggercam
+```
+
+（まだPyPIには公開していません。今のところはソースから `pip install -e .` でインストールしてください）
+
+## API
+
+- `Camera(index=0, width=1280, height=720, fps=30, show_preview=True)` — カメラを開き、即座にバックグラウンドのキャプチャスレッドを開始します。
+- `cam.start_recording(filename)` — `<filename>.mp4`への書き込みを開始します。Writerが開けなかった場合（非対応コーデックなど）は`RuntimeError`を送出します。すでに録画中の場合は何もしません。
+- `cam.stop_recording()` — 録画を停止し、ファイル名を`<filename>_<タイムスタンプ>.mp4`にリネームします。最終的なパスを返します（録画していなかった場合は`None`）。
+- `cam.running` — キャプチャスレッドが停止すると`False`になります（カメラが切断された場合、プレビューウィンドウで`q`が押された場合など）。
+- `cam.close()` — スレッドを停止し、カメラ・Writerのリソースを解放します。プログラムが中断されても録画ファイルが壊れた状態で残らないよう、必ず呼び出してください（`with Camera() as cam:`を使えば自動的に呼ばれます）。
+
+一通りの流れと、Ctrl+Cでの安全な終了方法は[`examples/basic_recording.py`](examples/basic_recording.py)を参照してください。
+
+## 動作検証
+
+### 検証環境（2026-08-21）
+
+| 項目 | 内容 |
+|---|---|
+| OS | Windows 11 Pro |
+| Python | 3.10.6（プロジェクト専用のvenv） |
+| インストール方法 | `pip install -e .` |
+| 依存パッケージ | opencv-python 5.0.0.93 |
+| カメラ | Logi C270 HD WebCam（USB UVCカメラ） |
+
+### 確認できたこと
+
+- カメラが正しく認識され、プレビューウィンドウに実際の映像が表示されることを確認（起動してからプレビューウィンドウが表示されるまで少し時間がかかる）。
+- `start_recording()` → `stop_recording()` の一連の流れが正常に動作し、`clip.mp4` が `clip_<タイムスタンプ>.mp4` に正しくリネームされることを確認。
+- 録画サイクル（10秒待機→録画→待機→停止）が問題なく動作することを確認。
+- 録画中に`Ctrl+C`で強制中断した際、そのファイルが正しく`stop_recording()`まで処理された状態で残ることを確認（未リネームの壊れたファイルが残らない）。
+- 生成された動画ファイルはメディアプレイヤーで正常に再生可能なことを確認。
+
+### 未検証
+
+- Linux / macOSでの動作（カメラインデックスでのキャプチャのため動作するはずだが、実機未確認）
+
+## ライセンス
+
+MIT — [LICENSE](LICENSE)を参照してください。
+
+## 背景
+
+このライブラリは、[Qiitaに投稿した元のプログラム](https://qiita.com/tuo170/items/ca1933a88f3255792214)
+（ https://qiita.com/tuo170/items/ca1933a88f3255792214 ）
+を土台に、バグ修正・API設計・パッケージ化を行って作られています。
+
+実装のコーディングやレビュー、設計の壁打ち相手としてClaude Codeを使用しました。

triggercam-0.1.0/src/triggercam.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+src/triggercam/__init__.py
+src/triggercam/camera.py
+src/triggercam.egg-info/PKG-INFO
+src/triggercam.egg-info/SOURCES.txt
+src/triggercam.egg-info/dependency_links.txt
+src/triggercam.egg-info/requires.txt
+src/triggercam.egg-info/top_level.txt

triggercam-0.1.0/src/triggercam.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

triggercam-0.1.0/src/triggercam.egg-info/requires.txt

@@ -0,0 +1 @@
+opencv-python>=4.5

triggercam-0.1.0/src/triggercam.egg-info/top_level.txt

@@ -0,0 +1 @@
+triggercam