akvirtualcamera/VCamUtils/src/ipcbridge.h

237 lines
8.4 KiB
C
Raw Normal View History

/* akvirtualcamera, virtual camera for Mac and Windows.
* Copyright (C) 2020 Gonzalo Exequiel Pedone
*
* akvirtualcamera is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* akvirtualcamera is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with akvirtualcamera. If not, see <http://www.gnu.org/licenses/>.
*
* Web-Site: http://webcamoid.github.io/
*/
#ifndef IPCBRIDGE_H
#define IPCBRIDGE_H
#include <string>
#include <map>
#include "image/videoformattypes.h"
#include "image/videoframetypes.h"
#include "utils.h"
namespace AkVCam
{
class IpcBridgePrivate;
class VideoFormat;
class VideoFrame;
class IpcBridge
{
public:
enum ServerState
{
ServerStateAvailable,
ServerStateGone
};
enum Operation
{
OperationCreate,
OperationEdit,
OperationDestroy,
OperationDestroyAll
};
AKVCAM_SIGNAL(ServerStateChanged,
ServerState state)
AKVCAM_SIGNAL(FrameReady,
const std::string &deviceId,
const VideoFrame &frame)
AKVCAM_SIGNAL(DeviceAdded,
const std::string &deviceId)
AKVCAM_SIGNAL(DeviceRemoved,
const std::string &deviceId)
AKVCAM_SIGNAL(ListenerAdded,
const std::string &deviceId,
const std::string &listener)
AKVCAM_SIGNAL(ListenerRemoved,
const std::string &deviceId,
const std::string &listener)
AKVCAM_SIGNAL(BroadcastingChanged,
const std::string &deviceId,
const std::string &broadcaster)
AKVCAM_SIGNAL(MirrorChanged,
const std::string &deviceId,
bool horizontalMirror,
bool verticalMirror)
AKVCAM_SIGNAL(ScalingChanged,
const std::string &deviceId,
Scaling scaling)
AKVCAM_SIGNAL(AspectRatioChanged,
const std::string &deviceId,
AspectRatio aspectRatio)
AKVCAM_SIGNAL(SwapRgbChanged,
const std::string &deviceId,
bool swap)
public:
IpcBridge();
~IpcBridge();
/* Server & Client */
// Get the last error message.
std::wstring errorMessage() const;
// Pass extra options to the bridge.
void setOption(const std::string &key, const std::string &value);
// Driver search paths.
std::vector<std::wstring> driverPaths() const;
// Set driver search paths.
void setDriverPaths(const std::vector<std::wstring> &driverPaths);
// Driver configuration.
std::vector<std::string> availableDrivers() const;
std::string driver() const;
bool setDriver(const std::string &driver);
// Configure method to be used for executing commands with elevated
// privileges.
std::vector<std::string> availableRootMethods() const;
std::string rootMethod() const;
bool setRootMethod(const std::string &rootMethod);
// Manage main service connection.
void connectService(bool asClient);
void disconnectService();
// Register the peer to the global server.
bool registerPeer(bool asClient);
// Unregister the peer to the global server.
void unregisterPeer();
// List available devices.
std::vector<std::string> listDevices() const;
// Return human readable description of the device.
std::wstring description(const std::string &deviceId) const;
// Output pixel formats supported by the driver.
std::vector<PixelFormat> supportedOutputPixelFormats() const;
// Default output pixel format of the driver.
PixelFormat defaultOutputPixelFormat() const;
// Return supported formats for the device.
std::vector<VideoFormat> formats(const std::string &deviceId) const;
// Return return the status of the device.
std::string broadcaster(const std::string &deviceId) const;
// Device is horizontal mirrored,
bool isHorizontalMirrored(const std::string &deviceId);
// Device is vertical mirrored,
bool isVerticalMirrored(const std::string &deviceId);
// Scaling mode for frames shown in clients.
Scaling scalingMode(const std::string &deviceId);
// Aspect ratio mode for frames shown in clients.
AspectRatio aspectRatioMode(const std::string &deviceId);
// Check if red and blue channels are swapped.
bool swapRgb(const std::string &deviceId);
// Returns the clients that are capturing from a virtual camera.
std::vector<std::string> listeners(const std::string &deviceId);
// Returns clients PIDs using the virtual devices.
std::vector<uint64_t> clientsPids() const;
// Returns client executable from PID.
std::string clientExe(uint64_t pid) const;
// Returns 'true' if the application needs to be restarted before
// creating, editing, or removing the virtual devices.
bool needsRestart(Operation operation) const;
// Can create, edit, or remove virtual devices?
bool canApply(Operation operation) const;
/* Server */
// Create a device definition.
std::string deviceCreate(const std::wstring &description,
const std::vector<VideoFormat> &formats);
// Edit a device definition.
bool deviceEdit(const std::string &deviceId,
const std::wstring &description,
const std::vector<VideoFormat> &formats);
// Change device description.
bool changeDescription(const std::string &deviceId,
const std::wstring &description);
// Remove a device definition.
bool deviceDestroy(const std::string &deviceId);
// Remove all device definitions.
bool destroyAllDevices();
// Start frame transfer to the device.
bool deviceStart(const std::string &deviceId,
const VideoFormat &format);
// Stop frame transfer to the device.
void deviceStop(const std::string &deviceId);
// Transfer a frame to the device.
bool write(const std::string &deviceId,
const VideoFrame &frame);
// Set mirroring options for device,
void setMirroring(const std::string &deviceId,
bool horizontalMirrored,
bool verticalMirrored);
// Set scaling options for device.
void setScaling(const std::string &deviceId,
Scaling scaling);
// Set aspect ratio options for device.
void setAspectRatio(const std::string &deviceId,
AspectRatio aspectRatio);
// Swap red and blue channels.
void setSwapRgb(const std::string &deviceId, bool swap);
/* Client */
// Increment the count of device listeners
bool addListener(const std::string &deviceId);
// Decrement the count of device listeners
bool removeListener(const std::string &deviceId);
private:
IpcBridgePrivate *d;
friend class IpcBridgePrivate;
};
}
#endif // IPCBRIDGE_H