Remove obsolete output API.

[libsigrok.git] / libsigrok.h

diff --git a/libsigrok.h b/libsigrok.h
index 49703757d264b56bfd0c8ff8aba20be2c6b5435b..f9678de76e4f7c6dca37a5b0d8401dd96e3f160d 100644 (file)
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -479,9 +479,6 @@ struct sr_output_format {
         */
        char *description;
 
-       /** Datafeed type, SR_DF_HEADER, etc. */
-       int df_type;
-
        /**
         * This function is called once, at the beginning of an output stream.
         *
@@ -499,72 +496,6 @@ struct sr_output_format {
         */
        int (*init) (struct sr_output *o);
 
-       /**
-        * Whenever a chunk of data comes in, it will be passed to the
-        * output module via this function. The <code>data_in</code> and
-        * <code>length_in</code> values refers to this data; the module
-        * must not alter or g_free() this buffer.
-        *
-        * The function must allocate a buffer for storing its output, and
-        * pass along a pointer to this buffer in the <code>data_out</code>
-        * parameter, as well as storing the length of the buffer in
-        * <code>length_out</code>. The calling frontend will g_free()
-        * this buffer when it's done with it.
-        *
-        * IMPORTANT: The memory allocation much happen using a glib memory
-        * allocation call (not a "normal" malloc) since g_free() will be
-        * used to free the memory!
-        *
-        * If there is no output, this function MUST store NULL in the
-        * <code>data_out</code> parameter, so the caller knows not to try
-        * and g_free() it.
-        *
-        * Note: This API call is obsolete, use receive() instead.
-        *
-        * @param o Pointer to the respective 'struct sr_output'.
-        * @param data_in Pointer to the input data buffer.
-        * @param length_in Length of the input.
-        * @param data_out Pointer to the allocated output buffer.
-        * @param length_out Length (in bytes) of the output.
-        *
-        * @retval SR_OK Success
-        * @retval other Negative error code.
-        */
-       int (*data) (struct sr_output *o, const uint8_t *data_in,
-                    uint64_t length_in, uint8_t **data_out,
-                    uint64_t *length_out);
-
-       /**
-        * This function is called when an event occurs in the datafeed
-        * which the output module may need to be aware of. No data is
-        * passed in, only the fact that the event occurs. The following
-        * events can currently be passed in:
-        *
-        *  - SR_DF_TRIGGER: At this point in the datafeed, the trigger
-        *    matched. The output module may mark this in some way, e.g. by
-        *    plotting a red line on a graph.
-        *
-        *  - SR_DF_END: This marks the end of the datafeed. No more calls
-        *    into the output module will be done, so this is a good time to
-        *    free up any memory used to keep state, for example.
-        *
-        * Any output generated by this function must have a reference to
-        * it stored in the <code>data_out</code> and <code>length_out</code>
-        * parameters, or NULL if no output was generated.
-        *
-        * Note: This API call is obsolete, use receive() instead.
-        *
-        * @param o Pointer to the respective 'struct sr_output'.
-        * @param event_type Type of event that occured.
-        * @param data_out Pointer to the allocated output buffer.
-        * @param length_out Length (in bytes) of the output.
-        *
-        * @retval SR_OK Success
-        * @retval other Negative error code.
-        */
-       int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
-                       uint64_t *length_out);
-
        /**
         * This function is passed a copy of every packed in the data feed.
         * Any output generated by the output module in response to the