cleanups

Update some docs
Remove special structs for some events
Remove some unused flags
Update some plugins

spa/include/spa/defs.h

@@ -41,8 +41,8 @@ typedef enum {
   SPA_RESULT_NO_FORMAT                 = -4,
   SPA_RESULT_INVALID_COMMAND           = -5,
   SPA_RESULT_INVALID_PORT              = -6,
-  SPA_RESULT_HAVE_ENOUGH_INPUT         = -7,
-  SPA_RESULT_NEED_MORE_INPUT           = -8,
+  SPA_RESULT_HAVE_OUTPUT               = -7,
+  SPA_RESULT_NEED_INPUT                = -8,
   SPA_RESULT_PORTS_CHANGED             = -9,
   SPA_RESULT_FORMAT_CHANGED            = -10,
   SPA_RESULT_PROPERTIES_CHANGED        = -11,
@@ -69,6 +69,7 @@ typedef enum {
   SPA_RESULT_NO_MEMORY                 = -32,
   SPA_RESULT_NO_PERMISSION             = -33,
   SPA_RESULT_SKIPPED                   = -34,
+  SPA_RESULT_OUT_OF_BUFFERS            = -35,
 } SpaResult;
 
 #define SPA_ASYNC_MASK                  (3 << 30)

spa/include/spa/node-event.h

@@ -76,14 +76,6 @@ typedef struct {
   SpaResult    res;
 } SpaNodeEventAsyncComplete;
 
-typedef struct {
-  SpaNodeEvent event;
-} SpaNodeEventHaveOutput;
-
-typedef struct {
-  SpaNodeEvent event;
-} SpaNodeEventNeedInput;
-
 typedef struct {
   SpaNodeEvent event;
   uint32_t port_id;

spa/include/spa/node.h

@@ -84,7 +84,6 @@ typedef enum {
  */
 typedef enum {
   SPA_PORT_INPUT_FLAG_NONE                  = 0,
-  SPA_PORT_INPUT_FLAG_NEED_INPUT            = 1 << 0,
 } SpaPortInputFlags;
 
 /**
@@ -106,13 +105,9 @@ typedef struct {
 /**
  * SpaPortOutputFlags:
  * @SPA_PORT_OUTPUT_FLAG_NONE: no flag
- * @SPA_PORT_OUTPUT_FLAG_PULL: force a #SPA_NODE_EVENT_NEED_INPUT event on the
- *                        peer input ports when no data is available.
  */
 typedef enum {
   SPA_PORT_OUTPUT_FLAG_NONE                  =  0,
-  SPA_PORT_OUTPUT_FLAG_HAVE_OUTPUT           = (1 << 0),
-  SPA_PORT_OUTPUT_FLAG_PULL                  = (1 << 1),
 } SpaPortOutputFlags;
 
 /**
@@ -152,7 +147,10 @@ typedef void   (*SpaNodeEventCallback)   (SpaNode      *node,
 /**
  * SpaNode:
  *
- * The main processing nodes.
+ * A SpaNode is a component that can comsume and produce buffers.
+ *
+ *
+ *
  */
 struct _SpaNode {
   /* the total size of this node. This can be used to expand this
@@ -559,18 +557,65 @@ struct _SpaNode {
                                        uint32_t          port_id,
                                        SpaNodeCommand   *command);
   /**
-   * SpaNode::process:
+   * SpaNode::process_input:
    * @node: a #SpaNode
-   * @flags: process flags
    *
-   * Process the node.
+   * Process the input area of the node.
    *
-   * Returns: #SPA_RESULT_OK on success
-   *          #SPA_RESULT_HAVE_ENOUGH_INPUT when output can be produced.
+   * For synchronous nodes, this function is called to start processing data
+   * or when process_output returned SPA_RESULT_NEED_MORE_INPUT
+   *
+   * For Asynchronous node, this function is called when a NEED_INPUT event
+   * is received from the node.
+   *
+   * Before calling this function, you must configure SpaPortInput structures
+   * configured on the input ports.
+   *
+   * The node will loop through all SpaPortInput structures and will
+   * process the buffers. For each port, the port info will be updated as:
+   *
+   *  - The buffer_id is set to SPA_ID_INVALID and the status is set to
+   *    SPA_RESULT_OK when the buffer was successfully consumed
+   *
+   *  - The buffer_id is untouched and the status is set to an error when
+   *    the buffer was invalid.
+   *
+   *  - The buffer_id is untouched and the status is set to SPA_RESULT_OK
+   *    when no input was consumed. This can happen when the node does not
+   *    need input on this port.
+   *
+   * Returns: #SPA_RESULT_OK on success or when the node is asynchronous
+   *          #SPA_RESULT_HAVE_OUTPUT for synchronous nodes when output
+   *                                  can be consumed.
+   *          #SPA_RESULT_OUT_OF_BUFFERS for synchronous nodes when buffers
+   *                                     should be released with port_reuse_buffer
+   *          #SPA_RESULT_ERROR when one of the inputs is in error
    */
   SpaResult   (*process_input)           (SpaNode *node);
-  SpaResult   (*process_output)          (SpaNode *node);
 
+  /**
+   * SpaNode::process_output:
+   * @node: a #SpaNode
+   *
+   * Tell the node to produce more output.
+   *
+   * Before calling this function you must process the buffers and events
+   * in the SpaPortOutput structure and set the buffer_id to SPA_ID_INVALID
+   * for all consumed buffers. Buffers that you do not want to consume should
+   * be returned to the node with port_reuse_buffer.
+   *
+   * For synchronous nodes, this function can be called when process_input
+   * returned #SPA_RESULT_HAVE_ENOUGH_INPUT.
+   *
+   * For Asynchronous node, this function is called when a HAVE_OUTPUT event
+   * is received from the node.
+   *
+   * Returns: #SPA_RESULT_OK on success or when the node is asynchronous
+   *          #SPA_RESULT_NEED_INPUT for synchronous nodes when input
+   *                                 is needed.
+   *          #SPA_RESULT_ERROR when one of the outputs is in error
+   */
+  SpaResult   (*process_output)          (SpaNode *node);
 };
 
 #define spa_node_get_props(n,...)          (n)->get_props((n),__VA_ARGS__)

spa/include/spa/port.h

@@ -132,31 +132,6 @@ typedef struct {
   SpaDict            *extra;
 } SpaPortInfo;
 
-
-/**
- * SpaPortStatusFlags:
- * @SPA_PORT_STATUS_FLAG_NONE: no status flags
- * @SPA_PORT_STATUS_FLAG_HAVE_FORMAT: port has a format
- * @SPA_PORT_STATUS_FLAG_HAVE_BUFFERS: port has buffers
- * @SPA_PORT_STATUS_FLAG_HAVE_OUTPUT: port has output
- * @SPA_PORT_STATUS_FLAG_NEED_INPUT: port needs input
- */
-typedef enum {
-  SPA_PORT_STATUS_FLAG_NONE                  = 0,
-  SPA_PORT_STATUS_FLAG_HAVE_FORMAT           = 1 << 0,
-  SPA_PORT_STATUS_FLAG_HAVE_BUFFERS          = 1 << 1,
-  SPA_PORT_STATUS_FLAG_HAVE_OUTPUT           = 1 << 2,
-  SPA_PORT_STATUS_FLAG_NEED_INPUT            = 1 << 3,
-} SpaPortStatusFlags;
-
-/**
- * SpaPortStatus:
- * @flags: port status flags
- */
-typedef struct {
-  SpaPortStatusFlags   flags;
-} SpaPortStatus;
-
 #ifdef __cplusplus
 }  /* extern "C" */
 #endif