From ccfe4d64184ae4c2983ae6b099c7c7ebb3770d0f Mon Sep 17 00:00:00 2001
From: wm4 <wm4@nowhere>
Date: Mon, 20 Apr 2015 23:05:52 +0200
Subject: client API: add MPV_FORMAT_BYTE_ARRAY type

This will be used in the following commit, which adds screenshot_raw.

The reasoning is that this will be better for binding scripting
languages.

One could special-case the screenshot_raw commit and define fixed
semantics for passing through a pointer using the current API, like
formatting a pointer as string. But that would be ridiculous and
unclean.
---
 libmpv/client.h | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

(limited to 'libmpv')

diff --git a/libmpv/client.h b/libmpv/client.h
index 511c4794b4..a800043359 100644
--- a/libmpv/client.h
+++ b/libmpv/client.h
@@ -24,6 +24,7 @@
 #ifndef MPV_CLIENT_API_H_
 #define MPV_CLIENT_API_H_
 
+#include <stddef.h>
 #include <stdint.h>
 
 #ifdef __cplusplus
@@ -632,7 +633,13 @@ typedef enum mpv_format {
     /**
      * See MPV_FORMAT_NODE_ARRAY.
      */
-    MPV_FORMAT_NODE_MAP         = 8
+    MPV_FORMAT_NODE_MAP         = 8,
+    /**
+     * A raw, untyped byte array. Only used only with mpv_node, and only in
+     * some very special situations. (Currently, only for the screenshot_raw
+     * command.)
+     */
+    MPV_FORMAT_BYTE_ARRAY       = 9
 } mpv_format;
 
 /**
@@ -654,6 +661,10 @@ typedef struct mpv_node {
          *    or if format==MPV_FORMAT_NODE_MAP
          */
         struct mpv_node_list *list;
+        /**
+         * valid if format==MPV_FORMAT_BYTE_ARRAY
+         */
+        struct mpv_byte_array *ba;
     } u;
     /**
      * Type of the data stored in this struct. This value rules what members in
@@ -666,6 +677,7 @@ typedef struct mpv_node {
      *  MPV_FORMAT_DOUBLE       (u.double_)
      *  MPV_FORMAT_NODE_ARRAY   (u.list)
      *  MPV_FORMAT_NODE_MAP     (u.list)
+     *  MPV_FORMAT_BYTE_ARRAY   (u.ba)
      *  MPV_FORMAT_NONE         (no member)
      *
      * If you encounter a value you don't know, you must not make any
@@ -706,6 +718,21 @@ typedef struct mpv_node_list {
     char **keys;
 } mpv_node_list;
 
+/**
+ * (see mpv_node)
+ */
+typedef struct mpv_byte_array {
+    /**
+     * Pointer to the data. In what format the data is stored is up to whatever
+     * uses MPV_FORMAT_BYTE_ARRAY.
+     */
+    void *data;
+    /**
+     * Size of the data pointed to by ptr.
+     */
+    size_t size;
+} mpv_byte_array;
+
 /**
  * Frees any data referenced by the node. It doesn't free the node itself.
  * Call this only if the mpv client API set the node. If you constructed the
-- 
cgit v1.2.3