DmxBuffer.h

Go to the documentation of this file.

/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * DmxBuffer.h
 * Interface for the DmxBuffer
 * Copyright (C) 2005-2009 Simon Newton
 */

#ifndef INCLUDE_OLA_DMXBUFFER_H_
#define INCLUDE_OLA_DMXBUFFER_H_

#include <stdint.h>
#include <iostream>
#include <string>


namespace ola {

class DmxBuffer {
 public:
    DmxBuffer();

    DmxBuffer(const DmxBuffer &other);

    DmxBuffer(const uint8_t *data, unsigned int length);

    explicit DmxBuffer(const std::string &data);

    ~DmxBuffer();

    DmxBuffer& operator=(const DmxBuffer &other);

    bool operator==(const DmxBuffer &other) const;

    bool operator!=(const DmxBuffer &other) const;

    unsigned int Size() const { return m_length; }

    bool HTPMerge(const DmxBuffer &other);

    bool Set(const uint8_t *data, unsigned int length);

    bool Set(const std::string &data);

    bool Set(const DmxBuffer &other);

    bool SetFromString(const std::string &data);

    bool SetRangeToValue(unsigned int offset, uint8_t data,
                         unsigned int length);

    bool SetRange(unsigned int offset, const uint8_t *data,
                  unsigned int length);

    void SetChannel(unsigned int channel, uint8_t data);

    void Get(uint8_t *data, unsigned int *length) const;

    void GetRange(unsigned int slot, uint8_t *data,
                  unsigned int *length) const;

    uint8_t Get(unsigned int channel) const;

    const uint8_t *GetRaw() const { return m_data; }

    std::string Get() const;

    bool Blackout();

    void Reset();

    std::string ToString() const;

 private:
    bool Init();
    bool DuplicateIfNeeded();
    void CopyFromOther(const DmxBuffer &other);
    void CleanupMemory();
    unsigned int *m_ref_count;
    mutable bool m_copy_on_write;
    uint8_t *m_data;
    unsigned int m_length;
};

std::ostream& operator<<(std::ostream &out, const DmxBuffer &data);
}  // namespace ola
#endif  // INCLUDE_OLA_DMXBUFFER_H_