Skip to content

Commit

Permalink
[ipcamera] Fix several issues and some improvements (openhab#11300)
Browse files Browse the repository at this point in the history 
* Fixes an issue now that the binding is not polling the snapshot anymore where the jpg could return an old image from cache.
* Fixes an issue that could be caused if you spammed the refresh key whilst watching ipcamera.mjpeg
* Improvements in stopping the servlet and stopping any open streams if the pause button is pressed on a camera thing.
* Reduces memory, thread and open file descriptor resource use.
* Fixes empty passwords create bad log output for logged ffmpeg commands.
* Fix for INSTAR cameras that created a WARN about bad user/pass when setting up the alarm server.

Closes openhab#11301

Signed-off-by: Matthew Skinner <matt@pcmus.com>
Signed-off-by: Nick Waterton <n.waterton@outlook.com>
  • Loading branch information
@Skinah @NickWaterton
Skinah authored and NickWaterton committed Dec 30, 2021
1 parent f8c92f2 commit 39d0649
Show file tree
Hide file tree
Showing 5 changed files with 136 additions and 73 deletions.
7 changes: 6 additions & 1 deletion ....openhab.binding.ipcamera/src/main/java/org/openhab/binding/ipcamera/internal/Ffmpeg.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,12 @@ public void run() {
public void startConverting() {
if (!ipCameraFfmpegThread.isAlive()) {
ipCameraFfmpegThread = new IpCameraFfmpegThread();
logger.debug("Starting ffmpeg with this command now:{}", ffmpegCommand.replaceAll(password, "********"));
if (!password.isEmpty()) {
logger.debug("Starting ffmpeg with this command now:{}",
ffmpegCommand.replaceAll(password, "********"));
} else {
logger.debug("Starting ffmpeg with this command now:{}", ffmpegCommand);
}
ipCameraFfmpegThread.start();
if (format.equals(FFmpegFormat.HLS)) {
ipCameraHandler.setChannelState(CHANNEL_START_STREAM, OnOffType.ON);
Expand Down
121 changes: 71 additions & 50 deletions ...ipcamera/src/main/java/org/openhab/binding/ipcamera/internal/handler/IpCameraHandler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import java.net.InetSocketAddress;
import java.net.MalformedURLException;
import java.net.URL;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
Expand Down Expand Up @@ -139,12 +140,12 @@ public class IpCameraHandler extends BaseThingHandler {
public @Nullable Ffmpeg ffmpegSnapshot = null;
public boolean streamingAutoFps = false;
public boolean motionDetected = false;

public Instant currentSnapshotTime = Instant.now();
private @Nullable ScheduledFuture<?> cameraConnectionJob = null;
private @Nullable ScheduledFuture<?> pollCameraJob = null;
private @Nullable ScheduledFuture<?> snapshotJob = null;
private @Nullable Bootstrap mainBootstrap;
private EventLoopGroup mainEventLoopGroup = new NioEventLoopGroup();
private EventLoopGroup mainEventLoopGroup = new NioEventLoopGroup(1);
private FullHttpRequest putRequestWithBody = new DefaultFullHttpRequest(HttpVersion.HTTP_1_1, new HttpMethod("PUT"),
"");
private String gifFilename = "ipcamera";
Expand Down Expand Up @@ -436,7 +437,7 @@ public boolean setBasicAuth(boolean useBasic) {
basicAuth = "";
return false;
} else if (!basicAuth.isEmpty()) {
// due to camera may have been sent multiple requests before the auth was set, this may trigger falsely.
// If the binding sends multiple requests before basicAuth was set, this may trigger falsely.
logger.warn("Camera is reporting your username and/or password is wrong.");
return false;
}
Expand Down Expand Up @@ -662,6 +663,7 @@ public void processSnapshot(byte[] incommingSnapshot) {
}
} finally {
lockCurrentSnapshot.unlock();
currentSnapshotTime = Instant.now();
}

if (updateImageChannel) {
Expand All @@ -676,10 +678,7 @@ public void processSnapshot(byte[] incommingSnapshot) {
}

public void startStreamServer() {
if (servlet == null) {
servlet = new CameraServlet(this, httpService);
}

servlet = new CameraServlet(this, httpService);
updateState(CHANNEL_HLS_URL, new StringType("http://" + hostIp + ":" + SERVLET_PORT + "/ipcamera/"
+ getThing().getUID().getId() + "/ipcamera.m3u8"));
updateState(CHANNEL_IMAGE_URL, new StringType("http://" + hostIp + ":" + SERVLET_PORT + "/ipcamera/"
Expand All @@ -696,7 +695,7 @@ private void openMjpegStream() {
sendHttpGET(mjpegUri);
}

void openChannel(Channel channel, String httpRequestURL) {
private void openChannel(Channel channel, String httpRequestURL) {
ChannelTracking tracker = channelTrackingMap.get(httpRequestURL);
if (tracker != null && !tracker.getReply().isEmpty()) {// We need to keep the stored reply
tracker.setChannel(channel);
Expand Down Expand Up @@ -1318,14 +1317,6 @@ private void bringCameraOnline() {
if (localFuture != null) {
localFuture.cancel(false);
}
if (thing.getThingTypeUID().getId().equals(INSTAR_THING)) {
logger.debug("Setting up the Alarm Server settings in the camera now");
sendHttpGET(
"/param.cgi?cmd=setmdalarm&-aname=server2&-switch=on&-interval=1&cmd=setalarmserverattr&-as_index=3&-as_server="
+ hostIp + "&-as_port=" + SERVLET_PORT + "&-as_path=/ipcamera/"
+ getThing().getUID().getId()
+ "/instar&-as_queryattr1=&-as_queryval1=&-as_queryattr2=&-as_queryval2=&-as_queryattr3=&-as_queryval3=&-as_activequery=1&-as_auth=0&-as_query1=0&-as_query2=0&-as_query3=0");
}
if (cameraConfig.getGifPreroll() > 0 || cameraConfig.getUpdateImageWhen().contains("1")) {
snapshotPolling = true;
snapshotJob = threadPool.scheduleWithFixedDelay(this::snapshotRunnable, 1000, cameraConfig.getPollTime(),
Expand Down Expand Up @@ -1428,6 +1419,18 @@ void snapshotRunnable() {
}

public byte[] getSnapshot() {
if (!isOnline) {
// Keep streams open when the camera goes offline so they dont stop.
return new byte[] { (byte) 0xff, (byte) 0xd8, (byte) 0xff, (byte) 0xe0, 0x00, 0x10, 0x4a, 0x46, 0x49, 0x46,
0x00, 0x01, 0x01, 0x01, 0x00, 0x48, 0x00, 0x48, 0x00, 0x00, (byte) 0xff, (byte) 0xdb, 0x00, 0x43,
0x00, 0x03, 0x02, 0x02, 0x02, 0x02, 0x02, 0x03, 0x02, 0x02, 0x02, 0x03, 0x03, 0x03, 0x03, 0x04,
0x06, 0x04, 0x04, 0x04, 0x04, 0x04, 0x08, 0x06, 0x06, 0x05, 0x06, 0x09, 0x08, 0x0a, 0x0a, 0x09,
0x08, 0x09, 0x09, 0x0a, 0x0c, 0x0f, 0x0c, 0x0a, 0x0b, 0x0e, 0x0b, 0x09, 0x09, 0x0d, 0x11, 0x0d,
0x0e, 0x0f, 0x10, 0x10, 0x11, 0x10, 0x0a, 0x0c, 0x12, 0x13, 0x12, 0x10, 0x13, 0x0f, 0x10, 0x10,
0x10, (byte) 0xff, (byte) 0xc9, 0x00, 0x0b, 0x08, 0x00, 0x01, 0x00, 0x01, 0x01, 0x01, 0x11, 0x00,
(byte) 0xff, (byte) 0xcc, 0x00, 0x06, 0x00, 0x10, 0x10, 0x05, (byte) 0xff, (byte) 0xda, 0x00, 0x08,
0x01, 0x01, 0x00, 0x00, 0x3f, 0x00, (byte) 0xd2, (byte) 0xcf, 0x20, (byte) 0xff, (byte) 0xd9 };
}
if (!snapshotPolling && !ffmpegSnapshotGeneration) {
sendHttpGET(snapshotUri);
}
Expand Down Expand Up @@ -1478,13 +1481,7 @@ public void startSnapshotPolling() {
*
*/
void pollCameraRunnable() {
// Snapshot should be first to keep consistent time between shots
if (streamingAutoFps) {
if (!snapshotPolling && !ffmpegSnapshotGeneration) {
// Dont need to poll if creating from RTSP stream with FFmpeg or we are polling at full rate already.
sendHttpGET(snapshotUri);
}
} else if (!snapshotUri.isEmpty() && !snapshotPolling) {// we need to check camera is still online.
if (!snapshotUri.isEmpty() && !snapshotPolling) {// we need to check camera is still online.
checkCameraConnection();
}
// NOTE: Use lowPriorityRequests if get request is not needed every poll.
Expand Down Expand Up @@ -1553,6 +1550,8 @@ void pollCameraRunnable() {
@Override
public void initialize() {
cameraConfig = getConfigAs(CameraConfig.class);
threadPool = Executors.newScheduledThreadPool(4);
mainEventLoopGroup = new NioEventLoopGroup(3);
snapshotUri = getCorrectUrlFormat(cameraConfig.getSnapshotUrl());
mjpegUri = getCorrectUrlFormat(cameraConfig.getMjpegUrl());
rtspUri = cameraConfig.getFfmpegInput();
Expand Down Expand Up @@ -1607,90 +1606,112 @@ public void initialize() {
if (mjpegUri.isEmpty()) {
mjpegUri = "/mjpegstream.cgi?-chn=12";
}
sendHttpGET(
"/param.cgi?cmd=setmdalarm&-aname=server2&-switch=on&-interval=1&cmd=setalarmserverattr&-as_index=3&-as_server="
+ hostIp + "&-as_port=" + SERVLET_PORT + "&-as_path=/ipcamera/"
+ getThing().getUID().getId()
+ "/instar&-as_queryattr1=&-as_queryval1=&-as_queryattr2=&-as_queryval2=&-as_queryattr3=&-as_queryval3=&-as_activequery=1&-as_auth=0&-as_query1=0&-as_query2=0&-as_query3=0");
break;
}
// Onvif and Instar event handling need the host IP and the server started.
// for poll times 9 seconds and above don't display a warning about the Image channel.
if (9000 > cameraConfig.getPollTime() && cameraConfig.getUpdateImageWhen().contains("1")) {
logger.warn(
"The Image channel is set to update more often than 8 seconds. This is not recommended. The Image channel is best used only for higher poll times. See the readme file on how to display the cameras picture for best results or use a higher poll time.");
}
// ONVIF and Instar event handling need the server started before connecting.
startStreamServer();
tryConnecting();
}

private void tryConnecting() {
if (!thing.getThingTypeUID().getId().equals(GENERIC_THING)) {
onvifCamera = new OnvifConnection(this, cameraConfig.getIp() + ":" + cameraConfig.getOnvifPort(),
cameraConfig.getUser(), cameraConfig.getPassword());
onvifCamera.setSelectedMediaProfile(cameraConfig.getOnvifMediaProfile());
// Only use ONVIF events if it is not an API camera.
onvifCamera.connect(thing.getThingTypeUID().getId().equals(ONVIF_THING));
}

// for poll times 9 seconds and above don't display a warning about the Image channel.
if (9000 > cameraConfig.getPollTime() && cameraConfig.getUpdateImageWhen().contains("1")) {
logger.warn(
"The Image channel is set to update more often than 8 seconds. This is not recommended. The Image channel is best used only for higher poll times. See the readme file on how to display the cameras picture for best results or use a higher poll time.");
}
// Waiting 3 seconds for ONVIF to discover the urls before running.
cameraConnectionJob = threadPool.scheduleWithFixedDelay(this::pollingCameraConnection, 4, 30, TimeUnit.SECONDS);
}

// What the camera needs to re-connect if the initialize() is not called.
private void resetAndRetryConnecting() {
dispose();
initialize();
offline();
tryConnecting();
}

@Override
public void dispose() {
private void offline() {
isOnline = false;
snapshotPolling = false;
Future<?> localFuture = pollCameraJob;
if (localFuture != null) {
localFuture.cancel(true);
localFuture = null;
}
localFuture = snapshotJob;
if (localFuture != null) {
localFuture.cancel(true);
localFuture = null;
}
localFuture = cameraConnectionJob;
if (localFuture != null) {
localFuture.cancel(true);
localFuture = null;
}
threadPool.shutdown();
threadPool = Executors.newScheduledThreadPool(4);

groupTracker.listOfOnlineCameraHandlers.remove(this);
groupTracker.listOfOnlineCameraUID.remove(getThing().getUID().getId());
// inform all group handlers that this camera has gone offline
for (IpCameraGroupHandler handle : groupTracker.listOfGroupHandlers) {
handle.cameraOffline(this);
}
basicAuth = ""; // clear out stored Password hash
useDigestAuth = false;
openChannels.close();

Ffmpeg localFfmpeg = ffmpegHLS;
if (localFfmpeg != null) {
localFfmpeg.stopConverting();
localFfmpeg = null;
ffmpegHLS = null;
}
localFfmpeg = ffmpegRecord;
if (localFfmpeg != null) {
localFfmpeg.stopConverting();
ffmpegRecord = null;
}
localFfmpeg = ffmpegGIF;
if (localFfmpeg != null) {
localFfmpeg.stopConverting();
ffmpegGIF = null;
}
localFfmpeg = ffmpegRtspHelper;
if (localFfmpeg != null) {
localFfmpeg.stopConverting();
ffmpegRtspHelper = null;
}
localFfmpeg = ffmpegMjpeg;
if (localFfmpeg != null) {
localFfmpeg.stopConverting();
ffmpegMjpeg = null;
}
localFfmpeg = ffmpegSnapshot;
if (localFfmpeg != null) {
localFfmpeg.stopConverting();
ffmpegSnapshot = null;
}
channelTrackingMap.clear();
onvifCamera.disconnect();
openChannels.close();
}

@Override
public void dispose() {
offline();
CameraServlet localServlet = servlet;
if (localServlet != null) {
localServlet.dispose();
localServlet = null;
}
threadPool.shutdown();
// inform all group handlers that this camera has gone offline
groupTracker.listOfOnlineCameraHandlers.remove(this);
groupTracker.listOfOnlineCameraUID.remove(getThing().getUID().getId());
for (IpCameraGroupHandler handle : groupTracker.listOfGroupHandlers) {
handle.cameraOffline(this);
}
basicAuth = ""; // clear out stored Password hash
useDigestAuth = false;
mainEventLoopGroup.shutdownGracefully();
mainBootstrap = null;
channelTrackingMap.clear();
}

public String getWhiteList() {
Expand Down
15 changes: 10 additions & 5 deletions ...g.ipcamera/src/main/java/org/openhab/binding/ipcamera/internal/onvif/OnvifConnection.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ public static enum RequestType {
private final Logger logger = LoggerFactory.getLogger(getClass());
private ScheduledExecutorService threadPool = Executors.newScheduledThreadPool(2);
private @Nullable Bootstrap bootstrap;
private EventLoopGroup mainEventLoopGroup = new NioEventLoopGroup();
private EventLoopGroup mainEventLoopGroup = new NioEventLoopGroup(2);
private String ipAddress = "";
private String user = "";
private String password = "";
Expand Down Expand Up @@ -857,10 +857,15 @@ private void cleanup() {
}

public void disconnect() {
if (usingEvents && isConnected && !mainEventLoopGroup.isShuttingDown()) {
sendOnvifRequest(requestBuilder(RequestType.Unsubscribe, subscriptionXAddr));
if (bootstrap != null) {
if (usingEvents && isConnected && !mainEventLoopGroup.isShuttingDown()) {
// Some cameras may continue to send events even when they can't reach a server.
sendOnvifRequest(requestBuilder(RequestType.Unsubscribe, subscriptionXAddr));
}
// give time for the Unsubscribe request to be sent to the camera.
threadPool.schedule(this::cleanup, 100, TimeUnit.MILLISECONDS);
} else {
cleanup();
}
// Some cameras may continue to send event callbacks even when they cant reach a server.
threadPool.schedule(this::cleanup, 500, TimeUnit.MILLISECONDS);
}
}
Loading

0 comments on commit 39d0649

Please sign in to comment.