update MJPEGCamera #29
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
walesch-yan
commented
Jan 15, 2025
Comment on lines
+39
to
+57
| #### Authentication for MJPEG Streams | ||
|
|
||
| Some MJPEG streams may require authentication to access. To support such scenarios, the `MJPEGCamera` class includes built-in authentication support. Currently, both `Basic` and `Digest` authentication methods are supported. | ||
|
|
||
| Below is an example of how to use the video-streamer to access a stream requiring `Basic` authentication: | ||
|
|
||
| ```bash | ||
| video-streamer -of MPEG1 -uri <stream_url> -auth Basic -user <username> -pass <password> | ||
| ``` | ||
|
|
||
| ##### Explanation of the Parameters: | ||
| - `-of`: Specifies the ouput format, here `MPEG1` is used. | ||
| - `-uri`: The URL of the MJPEG stream. | ||
| - `-auth`: Specifies the authentication method (`Basic` or `Digest`) | ||
| - `-user`: The username for authentication | ||
| - `-pass`: The password required for authentication | ||
|
|
||
| Replace `<stream_url>`, `<username>` and `<password>` with the appropriate values for your stream. Ensure you handle credentials securely and avoid exposing them in public or shared scripts! | ||
|
|
There was a problem hiding this comment.
Here I added some documentation for the newly added authentication feature:)
Comment on lines
+83
to
+91
| def _image_to_rgb24(self, image: bytes) -> bytearray: | ||
| """ | ||
| Convert binary image data into raw RGB24-encoded byte array | ||
| Supported image types include JPEG, PNG, BMP, TIFF, GIF, ... | ||
| """ | ||
| image_array = np.frombuffer(image, dtype=np.uint8) | ||
| frame = cv2.imdecode(image_array, cv2.IMREAD_COLOR) | ||
| rgb_frame = cv2.cvtColor(frame, cv2.COLOR_BGR2RGB) | ||
| return bytearray(rgb_frame.tobytes()) |
There was a problem hiding this comment.
Another addition is this function in the Camera base class, which allows the transformation of any image type supported by opencv into the desired rgb24 format
Comment on lines
+100
to
+126
| def _set_size(self) -> None: | ||
| buffer = bytearray() | ||
| # To set the size, extract the first image from the MJPEG stream | ||
| try: | ||
| response = requests.get(self._device_uri, stream=True, verify=False, auth=self._authentication) | ||
| if response.status_code == 200: | ||
| boundary = self._extract_boundary(response.headers) | ||
| if not boundary: | ||
| logging.error("Boundary not found in Content-Type header.") | ||
| return | ||
|
|
||
| for chunk in response.iter_content(chunk_size=8192): | ||
| buffer.extend(chunk) | ||
|
|
||
| while True: | ||
| frame, buffer = self._extract_frame(buffer, boundary) | ||
| if frame is None: | ||
| break | ||
| image = Image.open(io.BytesIO(frame)) | ||
| self._width, self._height = image.size | ||
| return | ||
| else: | ||
| logging.error(f"Received unexpected status code {response.status_code}") | ||
| return | ||
| except requests.RequestException as e: | ||
| logging.exception(f"Exception occured during stream request") | ||
| return |
There was a problem hiding this comment.
The first consumed image from the stream is used to set the size from the input source. This ensures correct encoding/decoding in the streamer later on
Comment on lines
+138
to
+145
| def _extract_boundary(self, headers): | ||
| """ | ||
| Extract the boundary marker from the Content-Type header. | ||
| """ | ||
| content_type = headers.get("Content-Type", "") | ||
| if "boundary=" in content_type: | ||
| return content_type.split("boundary=")[-1] | ||
| return None |
There was a problem hiding this comment.
The boundary extracted here acts as a delimiter between different images in an MJPEG stream, from my understanding, this delimiter could be different depending on the stream, but should always be present in the response header, hence this extraction function
|
Very nice, thanks alot ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the MJPEG camera by introducing some improvements to its general usage:
rgb24image, similar to how the data is stored for the other cameras and equal to the expected format for theffmpeg(MPEG1) streamer. It involves the drop of the specificget_jpegfunction from this class, it now uses the same as the parent class. This would introduce two additional transformation operation when theMJPEGstreamer is used, however using the MJPEG streamer with the MJPEG Camera might already be unnecessary.StreamConsumedError(which is not present on every stream)Where possible, this PR also enforces to use the correct types by using casting and correct type hints in the whole codebase