ext/message.lv2/message.h

   1 /* lv2_message.h - C header file for the LV2 Message extension.
   2  * Copyright (C) 2010 David Robillard <http://drobilla.net>
   3  *
   4  * This header is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU Lesser General Public License as published
   6  * by the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This header is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
  12  * License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with this header; if not, write to the Free Software Foundation,
  16  * Inc., 59 Temple Place, Suite 330, Boston, MA 01222-1307 USA
  17  */
  18
  19 /** @file
  20  * C header for the LV2 Message extension <http://lv2plug.in/ns/ext/message>.
  21  */
  22
  23 #ifndef LV2_MESSAGE_H
  24 #define LV2_MESSAGE_H
  25
  26 #define LV2_MESSAGE_URI "http://lv2plug.in/ns/ext/message"
  27
  28 #include <stdint.h>
  29 #include <stddef.h>
  30
  31 #include "lv2/http/lv2plug.in/ns/ext/atom/atom.h"
  32
  33 /** An LV2 Message.
  34  *
  35  * A "Message" is an Atom of type message:Message.  The payload of a Message
  36  * is a key/value dictionary with URI mapped integer keys (uint32_t), followed
  37  * by a key/value dictionary with URI mapped integer keys and Atom values
  38  * (atom:Blank, i.e. LV2_).
  39  */
  40 typedef struct _LV2_Message_Message {
  41         uint32_t selector; /***< Selector URI mapped to integer */
  42         LV2_Atom triples; /***< Always an atom:Triples */
  43 } LV2_Message_Message;
  44
  45 #endif /* LV2_MESSAGE_H */
  46