Download the PHP package mimicak/camera-capture without Composer

CameraCapture PHP Library

The CameraCapture PHP library provides a flexible and extensible way to capture images from IP cameras, such as Hikvision and generic HTTP snapshot cameras. It uses a factory pattern to support multiple camera types and includes robust error handling, authentication, and MIME type validation.

Features

• Modular Design: Supports multiple camera types (e.g., Hikvision, generic HTTP snapshot) via a factory pattern.
• Extensible: Easily add new camera types by registering them with the CameraFactory.
• Authentication: Supports HTTP Basic and Digest authentication.
• SSL/TLS Support: Configurable HTTP/HTTPS protocols with SSL verification options.
• Type Safety: Uses constants from CameraTypes to avoid configuration errors.
• Error Handling: Throws detailed exceptions for network issues, invalid responses, or misconfigurations.
• Flexible Configuration: Supports type-specific options and customizable timeouts.

Requirements

• PHP 7.4 or higher
• PHP extensions: curl, fileinfo
• Composer (recommended for autoloading)

Installation

Using Composer (Recommended)

1. Add the library to your project:

   Note: Replace your-vendor/camera-capture with the actual package name if published to Packagist, or use a custom repository.

2. Ensure your composer.json includes autoloading:

3. Run composer dump-autoload to generate the autoloader.

Manual Installation

1. Clone or download the library to your project directory.
2. Place the src/ directory in your project.
3. Manually include the required files:

Usage

Basic Example

The following example demonstrates how to initialize the library, add cameras, capture images, and manage camera instances.

Expected Output (assuming cameras are accessible):

Configuration

Each camera configuration is an array with the following keys:

Type-Specific Options

• Hikvision (CameraTypes::TYPE_HIKVISION):
  • snapshotChannel: Channel for snapshot (e.g., '101' for main stream).
• HTTP Snapshot (CameraTypes::TYPE_HTTP_SNAPSHOT):
  • snapshotUrlPath: Path to the snapshot endpoint (e.g., '/cgi-bin/currentpic.cgi').
• Common Options (for both types):
  • connectTimeout: Connection timeout in seconds (default: 5).
  • timeout: Total operation timeout in seconds (default: 10).
  • verifySsl: Whether to verify SSL certificates (default: true).

Troubleshooting

• Connection Timeouts:
  • Ensure the camera’s IP and port are correct (e.g., telnet 192.168.1.3 443 for HTTPS).
  • Try protocol => 'https' or protocol => 'http' in the config.
  • Increase connectTimeout and timeout in the options array.
  • Set verifySsl => false for cameras with self-signed certificates.
• Authentication Errors:
  • Verify username and password in the camera’s web interface.
  • Ensure the camera supports Basic or Digest authentication.
• Invalid MIME Type:
  • Check the snapshot endpoint in a browser to confirm it returns an image.
  • Verify the endpoint in the camera’s documentation (e.g., /ISAPI/Streaming/channels/101/picture for Hikvision).
• Logs:
  • Errors are logged via CameraCapture::logError (defaults to PHP’s error log).
  • Override logError for custom logging (e.g., to a file or external service).

Extending the Library

To add a new camera type:

1. Create a class implementing CameraInterface (e.g., AxisCamera).
2. Register it in CameraFactory:

Testing

• Unit Tests: Use PHPUnit to test CameraCapture, CameraFactory, and camera classes. Mock CameraInterface for isolated tests.
• Integration Tests: Test with real cameras to verify snapshot capture.
• Example Test:

License

MIT License (or specify your preferred license).

Contributing

Contributions are welcome! Please submit pull requests or open issues on the GitHub repository.

Contact

For support, contact [[email protected]] or open an issue on GitHub.