Use 'src' to unify parameter name for the source

Parameter names of media_streamer_node_link() are also
revised to avoid any possibility of misunderstanding,
the previous name - src_node - does not mean a source type
node.

[Version] 0.1.41
[Issue Type] Doxygen

Change-Id: Idfa954a679d8c30f04f74944b71c019e93d654ee
Signed-off-by: Sangchul Lee <sc11.lee@samsung.com>

diff --git a/include/media_streamer.h b/include/media_streamer.h
index 236d2cf..a23b6ca 100644 (file)
--- a/include/media_streamer.h
+++ b/include/media_streamer.h
@@ -445,21 +445,21 @@ typedef void (*media_streamer_state_changed_cb)(media_streamer_h streamer,
  *          or no free space in custom source buffer.
  * @since_tizen 3.0
  * @remarks Callback can be applied only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type
- * @param[in] node      Media streamer source node handle
+ * @param[in] src       Media streamer source node handle
  * @param[in] status    Media streamer custom buffer status
  * @param[in] user_data The user data passed from the callback registration function
  * @see media_streamer_src_set_buffer_status_cb()
  * @see media_streamer_node_get_param()
  * @see media_streamer_node_set_param()
  */
-typedef void (*media_streamer_custom_buffer_status_cb)(media_streamer_node_h node,
+typedef void (*media_streamer_custom_buffer_status_cb)(media_streamer_node_h src,
                                        media_streamer_custom_buffer_status_e status, void *user_data);
 
 /**
  * @brief Called when new data is available from custom sink.
  * @details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
  * @since_tizen 3.0
- * @param[in] node      Media streamer sink node handle
+ * @param[in] sink      Media streamer sink node handle
  * @param[in] user_data The user data passed from the code where
  *                       media_streamer_sink_set_data_ready_cb() was invoked
  *                       This data will be accessible from media_streamer_sink_data_ready_cb()
@@ -468,13 +468,13 @@ typedef void (*media_streamer_custom_buffer_status_cb)(media_streamer_node_h nod
  * @see media_streamer_sink_set_data_ready_cb()
  * @see media_streamer_sink_unset_data_ready_cb()
  */
-typedef void (*media_streamer_sink_data_ready_cb)(media_streamer_node_h node, void *user_data);
+typedef void (*media_streamer_sink_data_ready_cb)(media_streamer_node_h sink, void *user_data);
 
 /**
  * @brief  Called when the end-of-stream has been reached.
  * @details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
  * @since_tizen 3.0
- * @param[in] node      Media streamer sink node handle
+ * @param[in] sink      Media streamer sink node handle
  * @param[in] user_data The user data passed from the code where
  *                       media_streamer_sink_set_eos_cb() was invoked
  *                       This data will be accessible from media_streamer_sink_eos_cb()
@@ -483,7 +483,7 @@ typedef void (*media_streamer_sink_data_ready_cb)(media_streamer_node_h node, vo
  * @see media_streamer_sink_set_eos_cb()
  * @see media_streamer_sink_unset_eos_cb()
  */
-typedef void (*media_streamer_sink_eos_cb)(media_streamer_node_h node, void *user_data);
+typedef void (*media_streamer_sink_eos_cb)(media_streamer_node_h sink, void *user_data);
 
 /**
  * @brief Called when the seek operation is completed.
@@ -610,7 +610,7 @@ int media_streamer_unset_interrupted_cb(media_streamer_h streamer);
  * @details This function can be called only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type
  * @since_tizen 3.0
  * @remarks This function is used for media stream playback only.
- * @param[in] source    Media streamer source node handle
+ * @param[in] src       Media streamer source node handle
  * @param[in] callback  The buffer status callback function to register
  * @param[in] user_data The user data passed from the code where
  *                       media_streamer_src_set_buffer_status_cb() was invoked
@@ -626,12 +626,12 @@ int media_streamer_unset_interrupted_cb(media_streamer_h streamer);
  * @see media_streamer_src_unset_buffer_status_cb()
  * @see media_streamer_custom_buffer_status_cb()
  */
-int media_streamer_src_set_buffer_status_cb(media_streamer_node_h source, media_streamer_custom_buffer_status_cb callback, void *user_data);
+int media_streamer_src_set_buffer_status_cb(media_streamer_node_h src, media_streamer_custom_buffer_status_cb callback, void *user_data);
 
 /**
  * @brief Unsets the source buffer status callback function.
  * @since_tizen 3.0
- * @param[in] source    Media streamer source node handle
+ * @param[in] src    Media streamer source node handle
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
@@ -639,7 +639,7 @@ int media_streamer_src_set_buffer_status_cb(media_streamer_node_h source, media_
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
  * @see media_streamer_src_set_buffer_status_cb()
  */
-int media_streamer_src_unset_buffer_status_cb(media_streamer_node_h source);
+int media_streamer_src_unset_buffer_status_cb(media_streamer_node_h src);
 
 /**
  * @brief Sets a callback function to be called when the custom sink is ready for data processing.
@@ -919,7 +919,7 @@ int media_streamer_get_state(media_streamer_h streamer, media_streamer_state_e *
  *          The recorder privilege(%http://tizen.org/privilege/recorder) should be added if the source node handles the recorder device.
  *          You can release source node using media_streamer_node_destroy().
  * @param[in]  type     Media streamer source node type
- * @param[out] source   Media streamer source node handle
+ * @param[out] src      Media streamer source node handle
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
@@ -1074,31 +1074,32 @@ int media_streamer_node_remove(media_streamer_h streamer, media_streamer_node_h
  * @brief Links two media streamer nodes.
  * @since_tizen 3.0
  * @remarks Pads are node's input and output, where you can connect other nodes.
- *          (src_node) - (sink_node)
- *          src_node and sink_node is determined relatively.
+ *          (@a node1) - (@a node2)
+ *          @a node1 and @a node2 are determined relatively.
  *          In case of (A)-(B)-(C),
- *          (B) can be sink_node with (A) or (B) can be src_node with (C).
- *          However, source type node is always source node and sink type node is always sink node.
- *          (A) is source node and can not be sink node at all.
- *          (C) is sink node and can not be source node at all.
- * @param[in] src_node      Media streamer node handle
- * @param[in] src_pad_name  The name of the source pad of the source node
- * @param[in] dest_node     The destination media streamer node handle
- * @param[in] sink_pad_name The name of the sink pad of the destination node
+ *          (B) can be @a node2 with (A) or (B) can be @a node1 with (C).
+ *          However, source type node is always @a node1 and sink type node is always @a node2.
+ *          (A) is source type node and it should be @a node1.
+ *          (C) is sink type node and it should be @a node2.
+ * @param[in] node1     Media streamer node handle which has the @a src_pad_name pad
+ * @param[in] src_pad_name  The name of the source pad of the @a node1
+ * @param[in] node2     Media streamer node handle which has the @a sink_pad_name pad
+ * @param[in] sink_pad_name The name of the sink pad of the @a node2
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre Create a source node and a destination node handles
- *      by calling media_streamer_node_create()
- *      and add the nodes into streamer by calling media_streamer_node_add().
+ * @pre Create node handles by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
+ *      And add the nodes into streamer by calling media_streamer_node_add().
  * @see media_streamer_node_create()
+ * @see media_streamer_node_create_src()
+ * @see media_streamer_node_create_sink()
  * @see media_streamer_node_add()
  */
-int media_streamer_node_link(media_streamer_node_h src_node, const char *src_pad_name,
-                                       media_streamer_node_h dest_node, const char *sink_pad_name);
+int media_streamer_node_link(media_streamer_node_h node1, const char *src_pad_name,
+                                       media_streamer_node_h node2, const char *sink_pad_name);
 
 /**
  * @brief Sets media format for pad of media streamer node.

diff --git a/packaging/capi-media-streamer.spec b/packaging/capi-media-streamer.spec
index fd9b6e1..ec454cc 100644 (file)
--- a/packaging/capi-media-streamer.spec
+++ b/packaging/capi-media-streamer.spec
@@ -1,6 +1,6 @@
 Name:       capi-media-streamer
 Summary:    A Media Streamer API
-Version:    0.1.40
+Version:    0.1.41
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0

diff --git a/src/media_streamer.c b/src/media_streamer.c
index c35edd9..94eb85b 100644 (file)
--- a/src/media_streamer.c
+++ b/src/media_streamer.c
@@ -412,9 +412,9 @@ int media_streamer_unset_state_change_cb(media_streamer_h streamer)
        return MEDIA_STREAMER_ERROR_NONE;
 }
 
-int media_streamer_src_set_buffer_status_cb(media_streamer_node_h source, media_streamer_custom_buffer_status_cb callback, void *user_data)
+int media_streamer_src_set_buffer_status_cb(media_streamer_node_h src, media_streamer_custom_buffer_status_cb callback, void *user_data)
 {
-       media_streamer_node_s *ms_src = (media_streamer_node_s *) source;
+       media_streamer_node_s *ms_src = (media_streamer_node_s *) src;
        media_streamer_callback_s *src_callback = NULL;
 
        ms_debug_fenter();
@@ -439,9 +439,9 @@ int media_streamer_src_set_buffer_status_cb(media_streamer_node_h source, media_
        return MEDIA_STREAMER_ERROR_NONE;
 }
 
-int media_streamer_src_unset_buffer_status_cb(media_streamer_node_h source)
+int media_streamer_src_unset_buffer_status_cb(media_streamer_node_h src)
 {
-       media_streamer_node_s *ms_src = (media_streamer_node_s *) source;
+       media_streamer_node_s *ms_src = (media_streamer_node_s *) src;
 
        ms_debug_fenter();
 
@@ -729,17 +729,17 @@ int media_streamer_node_pull_packet(media_streamer_node_h sink, media_packet_h *
        return ms_element_pull_packet(ms_node->gst_element, packet);
 }
 
-int media_streamer_node_link(media_streamer_node_h src_node, const char *src_pad_name, media_streamer_node_h dest_node, const char *sink_pad_name)
+int media_streamer_node_link(media_streamer_node_h node1, const char *src_pad_name, media_streamer_node_h node2, const char *sink_pad_name)
 {
        int ret = MEDIA_STREAMER_ERROR_NONE;
-       media_streamer_node_s *ms_src_node = (media_streamer_node_s *) src_node;
-       media_streamer_node_s *ms_dest_node = (media_streamer_node_s *) dest_node;
+       media_streamer_node_s *ms_src_node = (media_streamer_node_s *) node1;
+       media_streamer_node_s *ms_dest_node = (media_streamer_node_s *) node2;
        gboolean link_ret = FALSE;
 
        ms_debug_fenter();
 
-       ms_retvm_if(ms_src_node == NULL, MEDIA_STREAMER_ERROR_INVALID_PARAMETER, "src_node is NULL");
-       ms_retvm_if(ms_dest_node == NULL, MEDIA_STREAMER_ERROR_INVALID_PARAMETER, "dest_node is NULL");
+       ms_retvm_if(ms_src_node == NULL, MEDIA_STREAMER_ERROR_INVALID_PARAMETER, "node1 is NULL");
+       ms_retvm_if(ms_dest_node == NULL, MEDIA_STREAMER_ERROR_INVALID_PARAMETER, "node2 is NULL");
 
        link_ret = gst_element_link_pads(ms_src_node->gst_element, src_pad_name, ms_dest_node->gst_element, sink_pad_name);