libcamera: Drop emitter object pointer from signal arguments

Many signals used in internal and public APIs carry the emitter pointer
as a signal argument. This was done to allow slots connected to multiple
signal instances to differentiate between emitters. While starting from
a good intention of facilitating the implementation of slots, it turned
out to be a bad API design as the signal isn't meant to know what it
will be connected to, and thus shouldn't carry parameters that are
solely meant to support a use case specific to the connected slot.

These pointers turn out to be unused in all slots but one. In the only
case where it is needed, it can be obtained by wrapping the slot in a
lambda function when connecting the signal. Do so, and drop the emitter
pointer from all signals.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Umang Jain <umang.jain@ideasonboard.com>
This commit is contained in:
Laurent Pinchart 2021-08-27 04:45:28 +03:00
parent 3f662ae3c0
commit 3335d5a504
32 changed files with 38 additions and 42 deletions

View file

@ -34,7 +34,7 @@ public:
bool enabled() const { return enabled_; } bool enabled() const { return enabled_; }
void setEnabled(bool enable); void setEnabled(bool enable);
Signal<EventNotifier *> activated; Signal<> activated;
protected: protected:
void message(Message *msg) override; void message(Message *msg) override;

View file

@ -41,7 +41,7 @@ public:
bool isRunning(); bool isRunning();
Signal<Thread *> finished; Signal<> finished;
static Thread *current(); static Thread *current();
static pid_t currentId(); static pid_t currentId();

View file

@ -33,7 +33,7 @@ public:
std::chrono::steady_clock::time_point deadline() const { return deadline_; } std::chrono::steady_clock::time_point deadline() const { return deadline_; }
Signal<Timer *> timeout; Signal<> timeout;
protected: protected:
void message(Message *msg) override; void message(Message *msg) override;

View file

@ -86,7 +86,7 @@ public:
Signal<Request *, FrameBuffer *> bufferCompleted; Signal<Request *, FrameBuffer *> bufferCompleted;
Signal<Request *> requestCompleted; Signal<Request *> requestCompleted;
Signal<Camera *> disconnected; Signal<> disconnected;
int acquire(); int acquire();
int release(); int release();

View file

@ -59,7 +59,7 @@ private:
std::string lookupDeviceNode(dev_t devnum); std::string lookupDeviceNode(dev_t devnum);
int addV4L2Device(dev_t devnum); int addV4L2Device(dev_t devnum);
void udevNotify(EventNotifier *notifier); void udevNotify();
struct udev *udev_; struct udev *udev_;
struct udev_monitor *monitor_; struct udev_monitor *monitor_;

View file

@ -35,7 +35,7 @@ private:
bool done; bool done;
}; };
void readyRead(IPCUnixSocket *socket); void readyRead();
int call(const IPCUnixSocket::Payload &message, int call(const IPCUnixSocket::Payload &message,
IPCUnixSocket::Payload *response, uint32_t seq); IPCUnixSocket::Payload *response, uint32_t seq);

View file

@ -37,7 +37,7 @@ public:
int send(const Payload &payload); int send(const Payload &payload);
int receive(Payload *payload); int receive(Payload *payload);
Signal<IPCUnixSocket *> readyRead; Signal<> readyRead;
private: private:
struct Header { struct Header {
@ -48,7 +48,7 @@ private:
int sendData(const void *buffer, size_t length, const int32_t *fds, unsigned int num); int sendData(const void *buffer, size_t length, const int32_t *fds, unsigned int num);
int recvData(void *buffer, size_t length, int32_t *fds, unsigned int num); int recvData(void *buffer, size_t length, int32_t *fds, unsigned int num);
void dataNotifier(EventNotifier *notifier); void dataNotifier();
int fd_; int fd_;
bool headerReceived_; bool headerReceived_;

View file

@ -53,7 +53,7 @@ public:
MediaLink *link(const MediaPad *source, const MediaPad *sink); MediaLink *link(const MediaPad *source, const MediaPad *sink);
int disableLinks(); int disableLinks();
Signal<MediaDevice *> disconnected; Signal<> disconnected;
protected: protected:
std::string logPrefix() const override; std::string logPrefix() const override;

View file

@ -38,7 +38,7 @@ public:
void kill(); void kill();
Signal<Process *, enum ExitStatus, int> finished; Signal<enum ExitStatus, int> finished;
private: private:
void closeAllFdsExcept(const std::vector<int> &fds); void closeAllFdsExcept(const std::vector<int> &fds);
@ -70,7 +70,7 @@ public:
private: private:
static ProcessManager *self_; static ProcessManager *self_;
void sighandler(EventNotifier *notifier); void sighandler();
std::list<Process *> processes_; std::list<Process *> processes_;

View file

@ -65,7 +65,7 @@ private:
void updateControls(ControlList *ctrls, void updateControls(ControlList *ctrls,
Span<const v4l2_ext_control> v4l2Ctrls); Span<const v4l2_ext_control> v4l2Ctrls);
void eventAvailable(EventNotifier *notifier); void eventAvailable();
std::map<unsigned int, struct v4l2_query_ext_ctrl> controlInfo_; std::map<unsigned int, struct v4l2_query_ext_ctrl> controlInfo_;
std::vector<std::unique_ptr<ControlId>> controlIds_; std::vector<std::unique_ptr<ControlId>> controlIds_;

View file

@ -238,7 +238,7 @@ private:
std::unique_ptr<FrameBuffer> createBuffer(unsigned int index); std::unique_ptr<FrameBuffer> createBuffer(unsigned int index);
FileDescriptor exportDmabufFd(unsigned int index, unsigned int plane); FileDescriptor exportDmabufFd(unsigned int index, unsigned int plane);
void bufferAvailable(EventNotifier *notifier); void bufferAvailable();
FrameBuffer *dequeueBuffer(); FrameBuffer *dequeueBuffer();
V4L2Capability caps_; V4L2Capability caps_;

View file

@ -278,7 +278,7 @@ void EventDispatcherPoll::processNotifiers(const std::vector<struct pollfd> &pol
} }
if (pfd.revents & event.events) if (pfd.revents & event.events)
notifier->activated.emit(notifier); notifier->activated.emit();
} }
/* Erase the notifiers_ entry if it is now empty. */ /* Erase the notifiers_ entry if it is now empty. */
@ -300,7 +300,7 @@ void EventDispatcherPoll::processTimers()
timers_.pop_front(); timers_.pop_front();
timer->stop(); timer->stop();
timer->timeout.emit(timer); timer->timeout.emit();
} }
} }

View file

@ -384,7 +384,7 @@ void Thread::finishThread()
data_->running_ = false; data_->running_ = false;
data_->mutex_.unlock(); data_->mutex_.unlock();
finished.emit(this); finished.emit();
data_->cv_.notify_all(); data_->cv_.notify_all();
} }

View file

@ -688,7 +688,7 @@ void Camera::disconnect()
LOG(Camera, Debug) << "Disconnecting camera " << id(); LOG(Camera, Debug) << "Disconnecting camera " << id();
_d()->disconnect(); _d()->disconnect();
disconnected.emit(this); disconnected.emit();
} }
int Camera::exportFrameBuffers(Stream *stream, int Camera::exportFrameBuffers(Stream *stream,

View file

@ -288,7 +288,7 @@ void DeviceEnumerator::removeDevice(const std::string &deviceNode)
LOG(DeviceEnumerator, Debug) LOG(DeviceEnumerator, Debug)
<< "Media device for node " << deviceNode << " removed."; << "Media device for node " << deviceNode << " removed.";
media->disconnected.emit(media.get()); media->disconnected.emit();
} }
/** /**

View file

@ -327,7 +327,7 @@ int DeviceEnumeratorUdev::addV4L2Device(dev_t devnum)
return 0; return 0;
} }
void DeviceEnumeratorUdev::udevNotify([[maybe_unused]] EventNotifier *notifier) void DeviceEnumeratorUdev::udevNotify()
{ {
struct udev_device *dev = udev_monitor_receive_device(monitor_); struct udev_device *dev = udev_monitor_receive_device(monitor_);
std::string action(udev_device_get_action(dev)); std::string action(udev_device_get_action(dev));

View file

@ -82,7 +82,7 @@ int IPCPipeUnixSocket::sendAsync(const IPCMessage &data)
return 0; return 0;
} }
void IPCPipeUnixSocket::readyRead([[maybe_unused]] IPCUnixSocket *socket) void IPCPipeUnixSocket::readyRead()
{ {
IPCUnixSocket::Payload payload; IPCUnixSocket::Payload payload;
int ret = socket_->receive(&payload); int ret = socket_->receive(&payload);

View file

@ -311,7 +311,7 @@ int IPCUnixSocket::recvData(void *buffer, size_t length,
return 0; return 0;
} }
void IPCUnixSocket::dataNotifier([[maybe_unused]] EventNotifier *notifier) void IPCUnixSocket::dataNotifier()
{ {
int ret; int ret;
@ -342,7 +342,7 @@ void IPCUnixSocket::dataNotifier([[maybe_unused]] EventNotifier *notifier)
return; return;
notifier_->setEnabled(false); notifier_->setEnabled(false);
readyRead.emit(this); readyRead.emit();
} }
} /* namespace libcamera */ } /* namespace libcamera */

View file

@ -448,7 +448,7 @@ void PipelineHandler::registerCamera(std::shared_ptr<Camera> camera)
*/ */
void PipelineHandler::hotplugMediaDevice(MediaDevice *media) void PipelineHandler::hotplugMediaDevice(MediaDevice *media)
{ {
media->disconnected.connect(this, &PipelineHandler::mediaDeviceDisconnected); media->disconnected.connect(this, [=]() { mediaDeviceDisconnected(media); });
} }
/** /**

View file

@ -66,7 +66,7 @@ void sigact(int signal, siginfo_t *info, void *ucontext)
} /* namespace */ } /* namespace */
void ProcessManager::sighandler([[maybe_unused]] EventNotifier *notifier) void ProcessManager::sighandler()
{ {
char data; char data;
ssize_t ret = read(pipe_[0], &data, sizeof(data)); ssize_t ret = read(pipe_[0], &data, sizeof(data));
@ -326,7 +326,7 @@ void Process::died(int wstatus)
exitStatus_ = WIFEXITED(wstatus) ? NormalExit : SignalExit; exitStatus_ = WIFEXITED(wstatus) ? NormalExit : SignalExit;
exitCode_ = exitStatus_ == NormalExit ? WEXITSTATUS(wstatus) : -1; exitCode_ = exitStatus_ == NormalExit ? WEXITSTATUS(wstatus) : -1;
finished.emit(this, exitStatus_, exitCode_); finished.emit(exitStatus_, exitCode_);
} }
/** /**

View file

@ -705,12 +705,11 @@ void V4L2Device::updateControls(ControlList *ctrls,
/** /**
* \brief Slot to handle V4L2 events from the V4L2 device * \brief Slot to handle V4L2 events from the V4L2 device
* \param[in] notifier The event notifier
* *
* When this slot is called, a V4L2 event is available to be dequeued from the * When this slot is called, a V4L2 event is available to be dequeued from the
* device. * device.
*/ */
void V4L2Device::eventAvailable([[maybe_unused]] EventNotifier *notifier) void V4L2Device::eventAvailable()
{ {
struct v4l2_event event{}; struct v4l2_event event{};
int ret = ioctl(VIDIOC_DQEVENT, &event); int ret = ioctl(VIDIOC_DQEVENT, &event);

View file

@ -1524,7 +1524,6 @@ int V4L2VideoDevice::queueBuffer(FrameBuffer *buffer)
/** /**
* \brief Slot to handle completed buffer events from the V4L2 video device * \brief Slot to handle completed buffer events from the V4L2 video device
* \param[in] notifier The event notifier
* *
* When this slot is called, a Buffer has become available from the device, and * When this slot is called, a Buffer has become available from the device, and
* will be emitted through the bufferReady Signal. * will be emitted through the bufferReady Signal.
@ -1532,7 +1531,7 @@ int V4L2VideoDevice::queueBuffer(FrameBuffer *buffer)
* For Capture video devices the FrameBuffer will contain valid data. * For Capture video devices the FrameBuffer will contain valid data.
* For Output video devices the FrameBuffer can be considered empty. * For Output video devices the FrameBuffer can be considered empty.
*/ */
void V4L2VideoDevice::bufferAvailable([[maybe_unused]] EventNotifier *notifier) void V4L2VideoDevice::bufferAvailable()
{ {
FrameBuffer *buffer = dequeueBuffer(); FrameBuffer *buffer = dequeueBuffer();
if (!buffer) if (!buffer)

View file

@ -66,7 +66,7 @@ public:
} }
private: private:
void readReady([[maybe_unused]] EventNotifier *notifier) void readReady()
{ {
size_ = read(notifier_->fd(), data_, sizeof(data_)); size_ = read(notifier_->fd(), data_, sizeof(data_));
notified_ = true; notified_ = true;

View file

@ -22,7 +22,7 @@ using namespace libcamera;
class EventTest : public Test class EventTest : public Test
{ {
protected: protected:
void readReady([[maybe_unused]] EventNotifier *notifier) void readReady()
{ {
size_ = read(notifier_->fd(), data_, sizeof(data_)); size_ = read(notifier_->fd(), data_, sizeof(data_));
notified_ = true; notified_ = true;

View file

@ -153,7 +153,7 @@ protected:
} }
private: private:
void readTrace([[maybe_unused]] EventNotifier *notifier) void readTrace()
{ {
ssize_t s = read(notifier_->fd(), &trace_, sizeof(trace_)); ssize_t s = read(notifier_->fd(), &trace_, sizeof(trace_));
if (s < 0) { if (s < 0) {

View file

@ -68,7 +68,7 @@ public:
} }
private: private:
void readyRead([[maybe_unused]] IPCUnixSocket *ipc) void readyRead()
{ {
IPCUnixSocket::Payload message, response; IPCUnixSocket::Payload message, response;
int ret; int ret;
@ -447,7 +447,7 @@ private:
return 0; return 0;
} }
void readyRead([[maybe_unused]] IPCUnixSocket *ipc) void readyRead()
{ {
if (!callResponse_) { if (!callResponse_) {
cerr << "Read ready without expecting data, fail." << endl; cerr << "Read ready without expecting data, fail." << endl;

View file

@ -65,7 +65,7 @@ public:
} }
private: private:
void readyRead([[maybe_unused]] IPCUnixSocket *ipc) void readyRead()
{ {
IPCUnixSocket::Payload message; IPCUnixSocket::Payload message;
int ret; int ret;

View file

@ -126,8 +126,7 @@ protected:
} }
private: private:
void procFinished([[maybe_unused]] Process *proc, void procFinished(enum Process::ExitStatus exitStatus, int exitCode)
enum Process::ExitStatus exitStatus, int exitCode)
{ {
exitStatus_ = exitStatus; exitStatus_ = exitStatus;
exitCode_ = exitCode; exitCode_ = exitCode;

View file

@ -81,8 +81,7 @@ protected:
} }
private: private:
void procFinished([[maybe_unused]] Process *proc, void procFinished(enum Process::ExitStatus exitStatus, int exitCode)
enum Process::ExitStatus exitStatus, int exitCode)
{ {
exitStatus_ = exitStatus; exitStatus_ = exitStatus;
exitCode_ = exitCode; exitCode_ = exitCode;

View file

@ -39,7 +39,7 @@ public:
} }
private: private:
void timeoutHandler([[maybe_unused]] Timer *timer) void timeoutHandler()
{ {
timeout_ = true; timeout_ = true;
} }

View file

@ -56,7 +56,7 @@ public:
} }
private: private:
void timeoutHandler([[maybe_unused]] Timer *timer) void timeoutHandler()
{ {
expiration_ = std::chrono::steady_clock::now(); expiration_ = std::chrono::steady_clock::now();
count_++; count_++;

View file

@ -57,7 +57,7 @@ public:
~{{proxy_worker_name}}() {} ~{{proxy_worker_name}}() {}
void readyRead([[maybe_unused]] IPCUnixSocket *socket) void readyRead()
{ {
IPCUnixSocket::Payload _message; IPCUnixSocket::Payload _message;
int _retRecv = socket_.receive(&_message); int _retRecv = socket_.receive(&_message);