DMPHeader.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.
 *
 * DMPHeader.h
 * The DMP Header
 * Copyright (C) 2007 Simon Newton
 */

#ifndef PLUGINS_E131_E131_DMPHEADER_H_
#define PLUGINS_E131_E131_DMPHEADER_H_

#include <stdint.h>
#include "plugins/e131/e131/DMPAddress.h"

namespace ola {
namespace plugin {
namespace e131 {

/*
 * Header for the DMP layer
 */
class DMPHeader {
 public:
    static const unsigned int DMP_HEADER_SIZE = 1;

    explicit DMPHeader(uint8_t header = 0): m_header(header) {}

    DMPHeader(bool is_virtual,
              bool is_relative,
              dmp_address_type type,
              dmp_address_size size) {
      m_header = (uint8_t) (is_virtual << 7 |
                            is_relative << 6 |
                            type << 4 |
                            size);
    }
    ~DMPHeader() {}

    bool IsVirtual() const { return m_header & VIRTUAL_MASK; }
    bool IsRelative() const { return  m_header & RELATIVE_MASK; }

    dmp_address_type Type() const {
      return (dmp_address_type) ((m_header & TYPE_MASK) >> 4);
    }

    dmp_address_size Size() const {
      return (dmp_address_size) (m_header & SIZE_MASK);
    }

    unsigned int Bytes() const { return DMPSizeToByteSize(Size()); }

    bool operator==(const DMPHeader &other) const {
      return m_header == other.m_header;
    }

    bool operator!=(const DMPHeader &other) const {
      return m_header != other.m_header;
    }

    uint8_t Header() const { return m_header; }

 private:
    static const uint8_t VIRTUAL_MASK = 0x80;
    static const uint8_t RELATIVE_MASK = 0x40;
    static const uint8_t TYPE_MASK = 0x30;
    static const uint8_t SIZE_MASK = 0x03;
    uint8_t m_header;
};
}  // namespace e131
}  // namespace plugin
}  // namespace ola
#endif  // PLUGINS_E131_E131_DMPHEADER_H_