JaRuleWidgetImpl.h

/*
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Library General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * JaRuleWidgetImpl.h
 * The implementation of the Ja Rule Widget.
 * Copyright (C) 2015 Simon Newton
 */

#ifndef PLUGINS_USBDMX_JARULEWIDGETIMPL_H_
#define PLUGINS_USBDMX_JARULEWIDGETIMPL_H_

#include <ola/base/Macro.h>
#include <ola/io/ByteString.h>
#include <ola/rdm/DiscoveryAgent.h>
#include <ola/rdm/QueueingRDMController.h>
#include <ola/rdm/RDMCommand.h>
#include <ola/rdm/RDMControllerInterface.h>
#include <ola/rdm/UID.h>
#include <ola/util/SequenceNumber.h>

#include "plugins/usbdmx/JaRuleEndpoint.h"
#include "plugins/usbdmx/JaRuleWidget.h"
#include "plugins/usbdmx/LibUsbAdaptor.h"

namespace ola {
namespace plugin {
namespace usbdmx {

class JaRuleWidgetImpl : public ola::rdm::DiscoveryTargetInterface,
 public ola::rdm::DiscoverableRDMControllerInterface {
 public:
 JaRuleWidgetImpl(ola::io::SelectServerInterface *ss,
 AsyncronousLibUsbAdaptor *adaptor,
 libusb_device *device,
 const ola::rdm::UID &controller_uid);

 ~JaRuleWidgetImpl();

 bool Init();

 // From DiscoverableRDMControllerInterface
 void RunFullDiscovery(ola::rdm::RDMDiscoveryCallback *callback);
 void RunIncrementalDiscovery(ola::rdm::RDMDiscoveryCallback *callback);
 void SendRDMRequest(ola::rdm::RDMRequest *request,
 ola::rdm::RDMCallback *on_complete);

 // From DiscoveryTargetInterface
 void MuteDevice(const ola::rdm::UID &target,
 MuteDeviceCallback *mute_complete);
 void UnMuteAll(UnMuteDeviceCallback *unmute_complete);
 void Branch(const ola::rdm::UID &lower,
 const ola::rdm::UID &upper,
 BranchCallback *branch_complete);

 bool SendDMX(const DmxBuffer &buffer);

 void ResetDevice();

 private:
 typedef enum {
 RC_OK,
 RC_UNKNOWN,
 RC_BUFFER_FULL,
 RC_BAD_PARAM,
 RC_TX_ERROR,
 RC_RDM_TIMEOUT,
 RC_RDM_BCAST_RESPONSE,
 RC_RDM_INVALID_RESPONSE,
 } JaRuleReturnCode;

 PACK(
 struct DUBTiming {
 uint16_t start; 
 uint16_t end; 
 });

 PACK(
 struct GetSetTiming {
 uint16_t break_start; 
 uint16_t mark_start; 
 uint16_t mark_end; 
 });

 JaRuleEndpoint m_endpoint;
 bool m_in_shutdown;

 // DMX members
 DmxBuffer m_dmx;
 bool m_dmx_in_progress;
 bool m_dmx_queued;
 JaRuleEndpoint::CommandCompleteCallback *m_dmx_callback;

 // RDM members
 ola::rdm::DiscoveryAgent m_discovery_agent;
 const ola::rdm::UID m_our_uid;
 ola::SequenceNumber<uint8_t> m_transaction_number;
 ola::rdm::UIDSet m_uids;

 void CheckStatusFlags(uint8_t flags);
 void DMXComplete(JaRuleEndpoint::CommandResult result, uint8_t return_code,
 uint8_t status_flags, const ola::io::ByteString &payload);
 void MuteDeviceComplete(MuteDeviceCallback *mute_complete,
 JaRuleEndpoint::CommandResult result,
 uint8_t return_code,
 uint8_t status_flags,
 const ola::io::ByteString &payload);
 void UnMuteDeviceComplete(UnMuteDeviceCallback *unmute_complete,
 JaRuleEndpoint::CommandResult result,
 uint8_t return_code,
 uint8_t status_flags,
 const ola::io::ByteString &payload);
 void DUBComplete(BranchCallback *callback,
 JaRuleEndpoint::CommandResult status,
 uint8_t return_code,
 uint8_t status_flags,
 const ola::io::ByteString &payload);
 void RDMComplete(const ola::rdm::RDMRequest *request,
 ola::rdm::RDMCallback *m_rdm_callback,
 JaRuleEndpoint::CommandResult result,
 uint8_t return_code,
 uint8_t status_flags,
 const ola::io::ByteString &payload);
 ola::rdm::RDMResponse* UnpackRDMResponse(
 const ola::rdm::RDMRequest *request,
 const ola::io::ByteString &payload,
 ola::rdm::RDMStatusCode *status_code);
 void DiscoveryComplete(ola::rdm::RDMDiscoveryCallback *callback,
 OLA_UNUSED bool ok,
 const ola::rdm::UIDSet &uids);
 JaRuleEndpoint::CommandClass GetCommandFromRequest(
 const ola::rdm::RDMRequest *request);

 DISALLOW_COPY_AND_ASSIGN(JaRuleWidgetImpl);
};
} // namespace usbdmx
} // namespace plugin
} // namespace ola
#endif // PLUGINS_USBDMX_JARULEWIDGETIMPL_H_