f6866456a3b35235795f0075d3ee9b29cb1bfb01
[platform/core/api/mediastreamer.git] / include / media_streamer.h
1 /*
2  * Copyright (c) 2015 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef __TIZEN_MEDIA_STREAMER_H__
18 #define __TIZEN_MEDIA_STREAMER_H__
19
20 #include <tizen.h>
21 #include <bundle.h>
22 #include <media_format.h>
23 #include <media_packet.h>
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 /**
30 * @file media_streamer.h
31 * @brief This file contains the capi media streamer API.
32 */
33
34 /**
35 * @addtogroup CAPI_MEDIA_STREAMER_MODULE
36 * @{
37 */
38
39 /**
40  * @brief Media Streamer handle type.
41  *
42  * @since_tizen 3.0
43  */
44 typedef void *media_streamer_h;
45
46 /**
47  * @brief Media Streamer node handle type.
48  *
49  * @since_tizen 3.0
50  */
51 typedef void *media_streamer_node_h;
52
53 /**
54  * @brief Enumeration for media streamer node type.
55  *
56  * @since_tizen 3.0
57  */
58 typedef enum {
59         MEDIA_STREAMER_NODE_TYPE_NONE,                 /**<  Not defined type */
60         MEDIA_STREAMER_NODE_TYPE_SRC,                  /**<  Source node type. Not available for media_streamer_node_create(). Use media_streamer_node_create_src() */
61         MEDIA_STREAMER_NODE_TYPE_SINK,                 /**<  Sink node type. Not available for media_streamer_node_create(). Use media_streamer_node_create_sink() */
62         MEDIA_STREAMER_NODE_TYPE_VIDEO_ENCODER,        /**<  Video encoder node type */
63         MEDIA_STREAMER_NODE_TYPE_VIDEO_DECODER,        /**<  Video decoder node type */
64         MEDIA_STREAMER_NODE_TYPE_AUDIO_ENCODER,        /**<  Audio encoder node type */
65         MEDIA_STREAMER_NODE_TYPE_AUDIO_DECODER,        /**<  Audio decoder node type */
66         MEDIA_STREAMER_NODE_TYPE_VIDEO_CONVERTER,      /**<  Video converter node type */
67         MEDIA_STREAMER_NODE_TYPE_AUDIO_CONVERTER,      /**<  Audio converter node type */
68         MEDIA_STREAMER_NODE_TYPE_AUDIO_RESAMPLE,       /**<  Audio resample node type */
69         MEDIA_STREAMER_NODE_TYPE_VIDEO_PAY,            /**<  RTP video payloader */
70         MEDIA_STREAMER_NODE_TYPE_AUDIO_PAY,            /**<  RTP audio payloader */
71         MEDIA_STREAMER_NODE_TYPE_VIDEO_DEPAY,          /**<  RTP video depayloader */
72         MEDIA_STREAMER_NODE_TYPE_AUDIO_DEPAY,          /**<  RTP audio depayloader */
73         MEDIA_STREAMER_NODE_TYPE_VIDEO_RATE,           /**<  Rate node type */
74         MEDIA_STREAMER_NODE_TYPE_VIDEO_SCALE,          /**<  Scale node type */
75         MEDIA_STREAMER_NODE_TYPE_TEXT_OVERLAY,         /**<  Overlay node type */
76         MEDIA_STREAMER_NODE_TYPE_PARSER,               /**<  Parser node type */
77         MEDIA_STREAMER_NODE_TYPE_FILTER,               /**<  Filter node type, to limit formats of data */
78         MEDIA_STREAMER_NODE_TYPE_TEE,                  /**<  Tee node type, splits data to multiple path */
79         MEDIA_STREAMER_NODE_TYPE_QUEUE,                /**<  Queue node type */
80         MEDIA_STREAMER_NODE_TYPE_MQUEUE,               /**<  Multiple data queue node type */
81         MEDIA_STREAMER_NODE_TYPE_MUXER,                /**<  Muxer node type */
82         MEDIA_STREAMER_NODE_TYPE_DEMUXER,              /**<  Demuxer node type */
83         MEDIA_STREAMER_NODE_TYPE_RTP,                  /**<  RTP component to send and receive data */
84         MEDIA_STREAMER_NODE_TYPE_INPUT_SELECTOR,       /**<  N-to-1 input stream selector */
85         MEDIA_STREAMER_NODE_TYPE_OUTPUT_SELECTOR,      /**<  1-to-N output stream selector */
86         MEDIA_STREAMER_NODE_TYPE_INTERLEAVE,           /**<  Folds many mono channel into one interleaved audio stream */
87         MEDIA_STREAMER_NODE_TYPE_DEINTERLEAVE,         /**<  Splits multi channel audio into many mono audio */
88         MEDIA_STREAMER_NODE_TYPE_WEBRTC                /**<  WebRTC component to send and receive data */
89 } media_streamer_node_type_e;
90
91 /**
92  * @brief Enumeration for media streamer source node type.
93  *
94  * @since_tizen 3.0
95  */
96 typedef enum {
97         MEDIA_STREAMER_NODE_SRC_TYPE_NONE,           /**<  Not defined source type */
98         MEDIA_STREAMER_NODE_SRC_TYPE_FILE,           /**<  Local file source type */
99         MEDIA_STREAMER_NODE_SRC_TYPE_HTTP,           /**<  HTTP source type, Network internet feature is required */
100         MEDIA_STREAMER_NODE_SRC_TYPE_RTSP,           /**<  RTSP source type, Network internet feature is required */
101         MEDIA_STREAMER_NODE_SRC_TYPE_CAMERA,         /**<  Camera source type, Camera feature is required */
102         MEDIA_STREAMER_NODE_SRC_TYPE_AUDIO_CAPTURE,  /**<  Audio capture source type, Microphone feature is required */
103         MEDIA_STREAMER_NODE_SRC_TYPE_VIDEO_CAPTURE,  /**<  Video capture source type, Camera feature is required */
104         MEDIA_STREAMER_NODE_SRC_TYPE_AUDIO_TEST,     /**<  Audio test source type */
105         MEDIA_STREAMER_NODE_SRC_TYPE_VIDEO_TEST,     /**<  Video test source type */
106         MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM,         /**<  Custom source type */
107         MEDIA_STREAMER_NODE_SRC_TYPE_ADAPTIVE        /**<  Adaptive source type, Network internet feature is required */
108 } media_streamer_node_src_type_e;
109
110 /**
111  * @brief Enumeration for media streamer sink node type.
112  *
113  * @since_tizen 3.0
114  */
115 typedef enum {
116         MEDIA_STREAMER_NODE_SINK_TYPE_NONE,   /**<  Not defined sink type */
117         MEDIA_STREAMER_NODE_SINK_TYPE_FILE,   /**<  Local file sink type */
118         MEDIA_STREAMER_NODE_SINK_TYPE_RTSP,   /**<  RTSP sink type, Network internet feature is required */
119         MEDIA_STREAMER_NODE_SINK_TYPE_HTTP,   /**<  HTTP sink type, Network internet feature is required */
120         MEDIA_STREAMER_NODE_SINK_TYPE_AUDIO,  /**<  Audio sink type */
121         MEDIA_STREAMER_NODE_SINK_TYPE_OVERLAY,/**<  Overlay sink type */
122         MEDIA_STREAMER_NODE_SINK_TYPE_FAKE,   /**<  Fake sink type */
123         MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM, /**<  Custom sink type */
124         MEDIA_STREAMER_NODE_SINK_TYPE_ADAPTIVE /**<  Adaptive sink type to generate fragmented files */
125 } media_streamer_node_sink_type_e;
126
127 /**
128  * @brief Enumeration for media streamer state.
129  *
130  * @since_tizen 3.0
131  */
132 typedef enum {
133         MEDIA_STREAMER_STATE_NONE,    /**<  Streamer is not created */
134         MEDIA_STREAMER_STATE_IDLE,    /**<  Streamer is created but not prepared */
135         MEDIA_STREAMER_STATE_READY,   /**<  Streamer is ready to play */
136         MEDIA_STREAMER_STATE_PLAYING, /**<  Streamer is playing */
137         MEDIA_STREAMER_STATE_PAUSED,  /**<  Streamer is paused */
138         MEDIA_STREAMER_STATE_SEEKING  /**<  Seek is under operation */
139 } media_streamer_state_e;
140
141 /**
142  * @brief Enumeration for media streamer error.
143  *
144  * @since_tizen 3.0
145  */
146 typedef enum {
147         MEDIA_STREAMER_ERROR_NONE = TIZEN_ERROR_NONE,                                        /**< Successful */
148         MEDIA_STREAMER_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER,              /**< Invalid parameter */
149         MEDIA_STREAMER_ERROR_INVALID_OPERATION  = TIZEN_ERROR_INVALID_OPERATION,             /**< Invalid operation */
150         MEDIA_STREAMER_ERROR_FILE_NO_SPACE_ON_DEVICE = TIZEN_ERROR_FILE_NO_SPACE_ON_DEVICE,  /**< No space left on the device */
151         MEDIA_STREAMER_ERROR_NOT_SUPPORTED  = TIZEN_ERROR_NOT_SUPPORTED,                     /**< The feature is not supported */
152         MEDIA_STREAMER_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED,              /**< Permission denied */
153         MEDIA_STREAMER_ERROR_INVALID_STATE = TIZEN_ERROR_MEDIA_STREAMER | 0x01,              /**< Invalid state */
154         MEDIA_STREAMER_ERROR_CONNECTION_FAILED = TIZEN_ERROR_MEDIA_STREAMER | 0x02,          /**< Connection failed */
155         MEDIA_STREAMER_ERROR_RESOURCE_CONFLICT = TIZEN_ERROR_MEDIA_STREAMER | 0x03,          /**< Resource conflict */
156         MEDIA_STREAMER_ERROR_SEEK_FAILED = TIZEN_ERROR_MEDIA_STREAMER | 0x04,                /**< Seek operation failure */
157 } media_streamer_error_e;
158
159 /**
160  * @brief Enumeration for media streamer buffer status of custom source.
161  *
162  * @since_tizen 3.0
163  */
164 typedef enum {
165         MEDIA_STREAMER_CUSTOM_BUFFER_UNDERRUN,  /**< Buffer underrun of custom source */
166         MEDIA_STREAMER_CUSTOM_BUFFER_OVERFLOW,  /**< Buffer overflow of custom source */
167 } media_streamer_custom_buffer_status_e;
168
169 /**
170  * @brief Enumeration for media streamer's interruption type.
171  *
172  * @since_tizen 3.0
173  */
174 typedef enum {
175         MEDIA_STREAMER_INTERRUPTED_BY_RESOURCE_CONFLICT,    /**< Interrupted by a resource conflict */
176         MEDIA_STREAMER_INTERRUPTED_BY_SECURITY,             /**< Interrupted by a security policy */
177 } media_streamer_interrupted_code_e;
178
179 /**
180  * @brief Definition for camera-id parameter of source node.
181  * @details Index number of camera to activate.
182  *          Data type is integer and default value is 0.
183  * @since_tizen 3.0
184  * @see media_streamer_node_get_params()
185  */
186 #define MEDIA_STREAMER_PARAM_CAMERA_ID "camera-id"
187
188 /**
189  * @brief Definition for capture-width parameter of source node.
190  * @details Width for camera size to capture.
191  *          Data type is integer and default value is 1600.
192  * @since_tizen 3.0
193  * @see media_streamer_node_get_params()
194  */
195 #define MEDIA_STREAMER_PARAM_CAPTURE_WIDTH "capture-width"
196
197 /**
198  * @brief Definition for capture-height parameter of source node.
199  * @details Height for camera size to capture.
200  *          Data type is integer and default value is 1200.
201  * @since_tizen 3.0
202  * @see media_streamer_node_get_params()
203  */
204 #define MEDIA_STREAMER_PARAM_CAPTURE_HEIGHT "capture-height"
205
206 /**
207  * @brief Definition for is-live parameter of source node.
208  * @details Whether to act as a live source.
209  *          Data type is boolean and default value is false.
210  * @since_tizen 3.0
211  * @see media_streamer_node_get_params()
212  */
213 #define MEDIA_STREAMER_PARAM_IS_LIVE_STREAM "is-live"
214
215 /**
216  * @brief Definition for uri parameter of source node.
217  * @details URI to read from
218  *          Data type is string.
219  * @since_tizen 3.0
220  * @see media_streamer_node_get_params()
221  */
222 #define MEDIA_STREAMER_PARAM_URI "uri"
223
224 /**
225  * @brief Definition for user-agent parameter of source node.
226  * @details Value of the User-Agent HTTP request header field.
227  *          Data type is string.
228  * @since_tizen 3.0
229  * @see media_streamer_node_get_params()
230  */
231 #define MEDIA_STREAMER_PARAM_USER_AGENT "user-agent"
232
233 /**
234  * @brief Definition for stream type parameter of source node.
235  * @details The type of the push data stream.
236  *          0:stream, 1:seekable, 2:random-access (default:0)
237  * @since_tizen 3.0
238  * @see media_streamer_node_get_params()
239  */
240 #define MEDIA_STREAMER_PARAM_STREAM_TYPE "stream-type"
241
242 /**
243  * @brief Definition for port parameter of source or sink node.
244  * @details The port to receive the packets from.
245  *          Data type is integer and default value is 5004.
246  * @since_tizen 3.0
247  * @see media_streamer_node_get_params()
248  */
249 #define MEDIA_STREAMER_PARAM_PORT "port"
250
251 /**
252  * @brief Definition for video port parameter of source node.
253  * @details The port to receive the video packets from.
254  *          Data type is integer.
255  * @since_tizen 3.0
256  * @see media_streamer_node_get_params()
257  */
258 #define MEDIA_STREAMER_PARAM_VIDEO_IN_PORT "video_in_port"
259
260 /**
261  * @brief Definition for audio port parameter of source node.
262  * @details The port to receive the audio packets from.
263  *          Data type is integer.
264  * @since_tizen 3.0
265  * @see media_streamer_node_get_params()
266  */
267 #define MEDIA_STREAMER_PARAM_AUDIO_IN_PORT "audio_in_port"
268
269 /**
270  * @brief Definition for video port parameter of sink node.
271  * @details The port to send the video packets to.
272  *          Data type is integer.
273  * @since_tizen 3.0
274  * @see media_streamer_node_get_params()
275  */
276 #define MEDIA_STREAMER_PARAM_VIDEO_OUT_PORT "video_out_port"
277
278 /**
279  * @brief Definition for audio port parameter of sink node.
280  * @details The port to send the audio packets to.
281  *          Data type is integer.
282  * @since_tizen 3.0
283  * @see media_streamer_node_get_params()
284  */
285 #define MEDIA_STREAMER_PARAM_AUDIO_OUT_PORT "audio_out_port"
286
287 /**
288  * @brief Definition for IP address parameter of source node.
289  * @details IP address to send/receive packets for.
290  *          Data type is string and default value is "0.0.0.0".
291  * @since_tizen 3.0
292  * @see media_streamer_node_get_params()
293  */
294 #define MEDIA_STREAMER_PARAM_IP_ADDRESS "address"
295
296 /**
297  * @brief Definition for the peer type of WebRTC node.
298  * @details The type of WebRTC peer, it can be "answer" or "offer".
299  *          Data type is string and default value is "answer".
300  * @since_tizen 6.0
301  * @see media_streamer_node_get_params()
302  */
303 #define MEDIA_STREAMER_PARAM_WEBRTC_PEER_TYPE "webrtc-peer-type"
304
305 /**
306  * @brief Definition for audio device name parameter of source or sink node.
307  * @details ALSA device, as defined in an asound configuration file.
308  *          ex) "hw:0,0", "hw:0,1"
309  *          Data type is string and default value is "default".
310  * @since_tizen 3.0
311  * @see media_streamer_node_get_params()
312  */
313 #define MEDIA_STREAMER_PARAM_AUDIO_DEVICE "audio_device"
314
315 /**
316  * @brief Definition for sync parameter of sink node.
317  * @details Synchronize on the clock
318  *          Data type is boolean and default value is true.
319  * @since_tizen 3.0
320  * @see media_streamer_node_get_params()
321  */
322 #define MEDIA_STREAMER_PARAM_CLOCK_SYNCHRONIZED "sync"
323
324 /**
325  * @brief Definition for rotate parameter of sink node.
326  * @details Rotate angle of display output.
327  *          0:none/1:rotate 90 degree/2:rotate 180 degree/3:rotate 270 degree
328  *          Default value is 3(rotate 270 degree).
329  * @since_tizen 3.0
330  * @see media_streamer_node_get_params()
331  */
332 #define MEDIA_STREAMER_PARAM_ROTATE "rotate"
333
334 /**
335  * @brief Definition for flip parameter of sink node.
336  * @details Flip for display.
337  *          0:none, 1:horizontal, 2:vertical, 3:both
338  *          Default value is 0.
339  * @since_tizen 3.0
340  * @see media_streamer_node_get_params()
341  */
342 #define MEDIA_STREAMER_PARAM_FLIP "flip"
343
344 /**
345  * @brief Definition for display geometry method parameter of sink node.
346  * @details Geometrical method for display.
347  *          0:Letter box
348  *          1:Original size
349  *          2:Full-screen
350  *          3:Cropped full screen
351  *          4:Original size if surface size is larger than video size(width/height),
352  *            or Letter box if video size(width/height) is larger than surface size.
353  *          5:Custom ROI
354  *          Default value is 0(Letter box).
355  * @since_tizen 3.0
356  * @see media_streamer_node_get_params()
357  */
358 #define MEDIA_STREAMER_PARAM_DISPLAY_GEOMETRY_METHOD "display-geometry-method"
359
360 /**
361  * @brief Definition for display parameter of sink node.
362  * @details It is a object to draw video frame on.
363  *          Data type is pointer.
364  * @since_tizen 3.0
365  * @see media_streamer_node_get_params()
366  */
367 #define MEDIA_STREAMER_PARAM_DISPLAY "display"
368
369 /**
370  * @brief Definition for visible parameter of sink node.
371  * @details Draws screen or blacks out.
372  *          Data type is boolean and default value is true(visible).
373  * @since_tizen 3.0
374  * @see media_streamer_node_get_params()
375  */
376 #define MEDIA_STREAMER_PARAM_VISIBLE "visible"
377
378 /**
379  * @brief Definition for use-tbm parameter of sink node.
380  * @details Use Tizen Buffer Memory instead of Shared Memory.
381  *          The sink node must receive the tbm-buffer created by the previous node.
382  *          The value is changeable only in the #MEDIA_STREAMER_STATE_IDLE state.
383  *          Data type is boolean and default value is false.
384  * @since_tizen 5.5
385  * @see media_streamer_node_get_params()
386  */
387 #define MEDIA_STREAMER_PARAM_USE_TBM "use-tbm"
388
389 /**
390  * @brief Definition for host parameter of sink node.
391  * @details The host/IP/Multicast group to send the packets to.
392  *          Data type is string and default value is "localhost".
393  * @since_tizen 3.0
394  * @see media_streamer_node_get_params()
395  */
396 #define MEDIA_STREAMER_PARAM_HOST "host"
397
398 /**
399  * @brief Definition for segment location parameter of adaptive sink node.
400  * @details Path for writing playlist from
401  *          Data type is string.
402  * @since_tizen 3.0
403  * @see media_streamer_node_get_params()
404  */
405 #define MEDIA_STREAMER_PARAM_SEGMENT_LOCATION "location"
406
407 /**
408  * @brief Definition for playlist location parameter of adaptive sink node.
409  * @details Path for writing playlist from. Data type is string.
410  * @since_tizen 3.0
411  * @see media_streamer_node_get_params()
412  */
413 #define MEDIA_STREAMER_PARAM_PLAYLIST_LOCATION "playlist-location"
414
415 /**
416  * @brief Called when error occurs in media streamer.
417  * @since_tizen 3.0
418  * @remarks Following error codes can be delivered.
419  *          #MEDIA_STREAMER_ERROR_INVALID_OPERATION,
420  *          #MEDIA_STREAMER_ERROR_FILE_NO_SPACE_ON_DEVICE,
421  *          #MEDIA_STREAMER_ERROR_NOT_SUPPORTED,
422  *          #MEDIA_STREAMER_ERROR_CONNECTION_FAILED,
423  *          #MEDIA_STREAMER_ERROR_RESOURCE_CONFLICT
424  * @param[in] streamer   Media streamer handle
425  * @param[in] error      The error that occurred in media steamer
426  * @param[in] user_data  The user data passed from the code where
427  *                       media_streamer_set_error_cb() was invoked
428  *                       This data will be accessible from media_streamer_error_cb()
429  * @pre Create media streamer handle by calling media_streamer_create().
430  * @see media_streamer_set_error_cb()
431  * @see media_streamer_unset_error_cb()
432  */
433 typedef void (*media_streamer_error_cb)(media_streamer_h streamer,
434                                         media_streamer_error_e error, void *user_data);
435
436 /**
437  * @brief Called when media streamer state is changed.
438  * @since_tizen 3.0
439  * @param[in] streamer        Media streamer handle
440  * @param[in] previous_state  The previous state of the media streamer
441  * @param[in] current_state   The current state of media streamer
442  * @param[in] user_data       The user data passed from the code where
443  *                            media_streamer_set_state_changed_cb() was invoked
444  *                            This data will be accessible from media_streamer_state_changed_cb()
445  * @pre Create media streamer handle by calling media_streamer_create().
446  * @see media_streamer_set_state_change_cb()
447  * @see media_streamer_unset_state_change_cb()
448  */
449 typedef void (*media_streamer_state_changed_cb)(media_streamer_h streamer,
450                                         media_streamer_state_e previous_state, media_streamer_state_e current_state, void *user_data);
451
452 /**
453  * @brief Called when the custom source needs more data or has enough data.
454  * @details This callback will be invoked when the buffer level drops below the threshold of max size
455  *          or no free space in custom source buffer.
456  * @since_tizen 3.0
457  * @remarks Callback can be applied only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type
458  * @param[in] src       Media streamer source node handle
459  * @param[in] status    Media streamer custom buffer status
460  * @param[in] user_data The user data passed from the callback registration function
461  * @see media_streamer_src_set_buffer_status_cb()
462  * @see media_streamer_node_get_param()
463  * @see media_streamer_node_set_param()
464  */
465 typedef void (*media_streamer_custom_buffer_status_cb)(media_streamer_node_h src,
466                                         media_streamer_custom_buffer_status_e status, void *user_data);
467
468 /**
469  * @brief Called when new data is available from custom sink.
470  * @details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
471  * @since_tizen 3.0
472  * @param[in] sink      Media streamer sink node handle
473  * @param[in] user_data The user data passed from the code where
474  *                       media_streamer_sink_set_data_ready_cb() was invoked
475  *                       This data will be accessible from media_streamer_sink_data_ready_cb()
476  * @pre media_streamer_sink_set_data_ready_cb()
477  * @see MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
478  * @see media_streamer_sink_set_data_ready_cb()
479  * @see media_streamer_sink_unset_data_ready_cb()
480  */
481 typedef void (*media_streamer_sink_data_ready_cb)(media_streamer_node_h sink, void *user_data);
482
483 /**
484  * @brief  Called when the end-of-stream has been reached.
485  * @details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
486  * @since_tizen 3.0
487  * @param[in] sink      Media streamer sink node handle
488  * @param[in] user_data The user data passed from the code where
489  *                       media_streamer_sink_set_eos_cb() was invoked
490  *                       This data will be accessible from media_streamer_sink_eos_cb()
491  * @pre media_streamer_sink_set_eos_cb()
492  * @see MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
493  * @see media_streamer_sink_set_eos_cb()
494  * @see media_streamer_sink_unset_eos_cb()
495  */
496 typedef void (*media_streamer_sink_eos_cb)(media_streamer_node_h sink, void *user_data);
497
498 /**
499  * @brief Called when the seek operation is completed.
500  * @since_tizen 3.0
501  * @param[in] user_data     The user data passed from the callback registration function
502  * @see media_streamer_set_play_position()
503  */
504 typedef void (*media_streamer_position_changed_cb)(void *user_data);
505
506 /**
507  * @brief Called when the media streamer is interrupted.
508  * @since_tizen 3.0
509  * @param[in] code       The interrupted error code
510  * @param[in] user_data  The user data passed from the callback registration function
511  * @see media_streamer_set_interrupted_cb()
512  * @see media_streamer_unset_interrupted_cb()
513  */
514 typedef void (*media_streamer_interrupted_cb)(media_streamer_interrupted_code_e code, void *user_data);
515
516 /**
517  * @brief Called when the media streamer WebRTC node needs to send the message to the remote peer of WebRTC connection.
518  * @since_tizen 6.0
519  * @remarks Two types will be delivered with @ message which is JSON string.
520  *          One is for the remote session description and the other is for a new ICE candidate.
521  *          For the remote session description, @ message will be {"sdp":{"type":"offer or answer","sdp":"..."}}.
522  *          For the new ICE candidate, @ message will be {"ice":{"candidate":"..."}}.
523  * @param[in] webrtc     Media streamer WebRTC node handle
524  * @param[in] message    The message to be passed to the remote peer over the signaling channel
525  * @param[in] user_data  The user data passed from the callback registration function
526  * @see media_streamer_webrtc_node_set_message_cb()
527  * @see media_streamer_webrtc_node_unset_message_cb()
528  */
529 typedef void (*media_streamer_webrtc_message_cb)(media_streamer_node_h webrtc, const char *message, void *user_data);
530
531 /**
532  * @brief Sets a error callback function to be invoked when an error occurs.
533  * @details Following error codes can be delivered by error callback.
534  *          #MEDIA_STREAMER_ERROR_INVALID_OPERATION,
535  *          #MEDIA_STREAMER_ERROR_FILE_NO_SPACE_ON_DEVICE,
536  *          #MEDIA_STREAMER_ERROR_NOT_SUPPORTED,
537  *          #MEDIA_STREAMER_ERROR_CONNECTION_FAILED,
538  *          #MEDIA_STREAMER_ERROR_RESOURCE_CONFLICT
539  * @since_tizen 3.0
540  * @param[in] streamer  Media streamer handle
541  * @param[in] callback  Callback function pointer
542  * @param[in] user_data The user data passed from the code where
543  *                      media_streamer_set_error_cb() was invoked
544  *                      This data will be accessible from media_streamer_error_cb()
545  * @return @c 0 on success,
546  *         otherwise a negative error value
547  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
548  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
549  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
550  * @pre Create a media streamer handle by calling media_streamer_create().
551  * @post media_streamer_error_cb() will be invoked.
552  * @see media_streamer_unset_error_cb()
553  * @see media_streamer_error_cb()
554  */
555 int media_streamer_set_error_cb(media_streamer_h streamer, media_streamer_error_cb callback, void *user_data);
556
557 /**
558  * @brief Unsets the error callback function.
559  * @since_tizen 3.0
560  * @param[in] streamer  Media streamer handle
561  * @return @c 0 on success,
562  *         otherwise a negative error value
563  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
564  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
565  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
566  * @see media_streamer_error_cb()
567  */
568 int media_streamer_unset_error_cb(media_streamer_h streamer);
569
570 /**
571  * @brief Sets a callback that will be triggered after media streamer state is changed.
572  * @since_tizen 3.0
573  * @param[in] streamer  Media streamer handle
574  * @param[in] callback  Callback function pointer
575  * @param[in] user_data The user data passed from the code
576  *                      where media_streamer_set_state_change_cb() was invoked
577  *                      This data will be accessible from media_streamer_state_changed_cb()
578  * @return @c 0 on success,
579  *         otherwise a negative error value
580  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
581  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
582  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
583  * @pre Create a media streamer handle by calling media_streamer_create().
584  * @post media_streamer_state_changed_cb() will be invoked.
585  * @see media_streamer_unset_state_change_cb()
586  * @see media_streamer_state_changed_cb()
587  */
588 int media_streamer_set_state_change_cb(media_streamer_h streamer, media_streamer_state_changed_cb callback, void *user_data);
589
590 /**
591  * @brief Unsets the state changed callback function.
592  * @since_tizen 3.0
593  * @param[in] streamer  Media streamer handle
594  * @return @c 0 on success,
595  *         otherwise a negative error value
596  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
597  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
598  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
599  * @see media_streamer_set_state_change_cb()
600  */
601 int media_streamer_unset_state_change_cb(media_streamer_h streamer);
602
603 /**
604  * @brief Sets a callback function to be invoked when the media streamer is interrupted.
605  * @since_tizen 3.0
606  * @param[in] streamer  Media streamer handle
607  * @param[in] callback  The callback function to register
608  * @param[in] user_data The user data to be passed to the callback function
609  * @return @c 0 on success,
610  *         otherwise a negative error value
611  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
612  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
613  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
614  * @post media_streamer_interrupted_cb() will be invoked.
615  * @see media_streamer_unset_interrupted_cb()
616  * @see #media_streamer_interrupted_code_e
617  */
618 int media_streamer_set_interrupted_cb(media_streamer_h streamer, media_streamer_interrupted_cb callback, void *user_data);
619
620 /**
621  * @brief Unsets the callback function.
622  * @since_tizen 3.0
623  * @param[in] streamer Media streamer handle
624  * @return @c 0 on success,
625  *         otherwise a negative error value
626  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
627  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
628  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
629  * @see media_streamer_set_interrupted_cb()
630  */
631 int media_streamer_unset_interrupted_cb(media_streamer_h streamer);
632
633 /**
634  * @brief Sets a callback function to be invoked when buffer underrun or overflow is occurred.
635  * @details This function can be called only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type
636  * @since_tizen 3.0
637  * @remarks This function is used for media stream playback only.
638  * @param[in] src       Media streamer source node handle
639  * @param[in] callback  The buffer status callback function to register
640  * @param[in] user_data The user data passed from the code where
641  *                       media_streamer_src_set_buffer_status_cb() was invoked
642  *                       This data will be accessible from media_streamer_custom_buffer_status_cb()
643  * @return @c 0 on success,
644  *         otherwise a negative error value
645  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
646  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
647  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
648  * @pre Create a media streamer source node handle by calling media_streamer_node_create_src().
649  * @pre Add created media streamer source node to media streamer by calling media_streamer_node_add().
650  * @post media_streamer_custom_buffer_status_cb() will be invoked.
651  * @see media_streamer_src_unset_buffer_status_cb()
652  * @see media_streamer_custom_buffer_status_cb()
653  */
654 int media_streamer_src_set_buffer_status_cb(media_streamer_node_h src, media_streamer_custom_buffer_status_cb callback, void *user_data);
655
656 /**
657  * @brief Unsets the source buffer status callback function.
658  * @since_tizen 3.0
659  * @param[in] src    Media streamer source node handle
660  * @return @c 0 on success,
661  *         otherwise a negative error value
662  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
663  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
664  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
665  * @see media_streamer_src_set_buffer_status_cb()
666  */
667 int media_streamer_src_unset_buffer_status_cb(media_streamer_node_h src);
668
669 /**
670  * @brief Sets a callback function to be called when the custom sink is ready for data processing.
671  * @details This function can be called only for #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
672  * @since_tizen 3.0
673  * @param[in] sink      Media streamer sink node handle
674  * @param[in] callback  Callback function pointer
675  * @param[in] user_data The user data passed from the code where
676  *                       media_streamer_sink_set_data_ready_cb() was invoked
677  *                       This data will be accessible from media_streamer_sink_data_ready_cb()
678  * @return @c 0 on success,
679  *         otherwise a negative error value
680  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
681  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
682  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
683  * @pre Create a media streamer sink handle by calling media_streamer_node_create_sink().
684  * @pre Add created media streamer sink node to media streamer by calling media_streamer_node_add().
685  * @post media_streamer_sink_data_ready_cb() will be invoked.
686  * @see media_streamer_sink_unset_data_ready_cb()
687  * @see media_streamer_sink_data_ready_cb()
688  */
689 int media_streamer_sink_set_data_ready_cb(media_streamer_node_h sink, media_streamer_sink_data_ready_cb callback, void *user_data);
690
691 /**
692  * @brief Unsets the sink data ready callback function.
693  * @since_tizen 3.0
694  * @param[in] sink    Media streamer sink node handle
695  * @return @c 0 on success,
696  *         otherwise a negative error value
697  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
698  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
699  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
700  * @see media_streamer_sink_set_data_ready_cb()
701  */
702 int media_streamer_sink_unset_data_ready_cb(media_streamer_node_h sink);
703
704 /**
705  * @brief Sets a callback function to be called when custom sink detect the end-of-stream.
706  * @since_tizen 3.0
707  * @param[in] sink      Media streamer sink node handle
708  * @param[in] callback  Callback function pointer
709  * @param[in] user_data The user data passed from the code where
710  *                       media_streamer_sink_set_eos_cb() was invoked.
711  *                       This data will be accessible from media_streamer_sink_eos_cb()
712  * @return @c 0 on success,
713  *         otherwise a negative error value
714  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
715  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
716  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
717  * @pre Create a media streamer sink handle by calling media_streamer_node_create_sink().
718  * @pre Add created media streamer sink node to media streamer by calling media_streamer_node_add().
719  * @post media_streamer_sink_eos_cb() will be invoked.
720  * @see media_streamer_sink_unset_eos_cb()
721  * @see media_streamer_sink_eos_cb()
722  */
723 int media_streamer_sink_set_eos_cb(media_streamer_node_h sink, media_streamer_sink_eos_cb callback, void *user_data);
724
725 /**
726  * @brief Unsets the sink end-of-stream callback function.
727  * @since_tizen 3.0
728  * @param[in] sink    Media streamer sink node handle
729  * @return @c 0 on success,
730  *         otherwise a negative error value
731  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
732  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
733  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
734  * @see media_streamer_sink_set_eos_cb()
735  */
736 int media_streamer_sink_unset_eos_cb(media_streamer_node_h sink);
737
738 /**
739  * @brief Creates an instance of media streamer and
740  *        passes the handle to the caller.
741  * @since_tizen 3.0
742  * @remarks You must release @a streamer using media_streamer_destroy()
743  * @param[out] streamer    Media streamer handle
744  * @return @c 0 on success,
745  *         otherwise a negative error value
746  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
747  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
748  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
749  * @post The media streamer state will be #MEDIA_STREAMER_STATE_IDLE.
750  * @see media_streamer_destroy()
751  */
752 int media_streamer_create(media_streamer_h *streamer);
753
754 /**
755  * @brief Sets media streamer state to #MEDIA_STREAMER_STATE_READY.
756  * @since_tizen 3.0
757  * @param[in] streamer     Media streamer handle
758  * @return @c 0 on success,
759  *         otherwise a negative error value
760  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
761  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
762  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
763  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
764  * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_IDLE
765  *      by calling media_streamer_create() or media_streamer_unprepare().
766  * @pre At least one source and one sink should be added and linked in the streamer
767  *      by calling media_streamer_node_create_src(), media_streamer_node_create_sink() and media_streamer_node_link().
768  * @post The media streamer state will be #MEDIA_STREAMER_STATE_READY.
769  * @see media_streamer_unprepare()
770  * @see media_streamer_create()
771  */
772 int media_streamer_prepare(media_streamer_h streamer);
773
774 /**
775  * @brief Sets media streamer state to #MEDIA_STREAMER_STATE_IDLE.
776  * @details The most recently used media is reset and no longer associated with the media streamer.
777  * @since_tizen 3.0
778  * @param[in] streamer     Media streamer handle
779  * @return @c 0 on success,
780  *         otherwise a negative error value
781  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
782  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
783  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
784  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
785  * @pre The media streamer state should be higher than #MEDIA_STREAMER_STATE_IDLE.
786  * @post The media streamer state will be #MEDIA_STREAMER_STATE_IDLE.
787  * @see media_streamer_prepare()
788  */
789 int media_streamer_unprepare(media_streamer_h streamer);
790
791 /**
792  * @brief Sets media streamer state to #MEDIA_STREAMER_STATE_PLAYING.
793  * @details Start running the current streamer, or resumes it if paused.
794  * @since_tizen 3.0
795  * @param[in] streamer     Media streamer handle
796  * @return @c 0 on success,
797  *         otherwise a negative error value
798  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
799  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
800  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
801  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
802  * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_READY by calling media_streamer_prepare() or
803  *      set to #MEDIA_STREAMER_STATE_PAUSED by calling media_streamer_pause().
804  * @post The media streamer state will be #MEDIA_STREAMER_STATE_PLAYING.
805  * @see media_streamer_create()
806  * @see media_streamer_pause()
807  * @see media_streamer_stop()
808  */
809 int media_streamer_play(media_streamer_h streamer);
810
811 /**
812  * @brief Pauses the media streamer.
813  * @since_tizen 3.0
814  * @param[in] streamer     Media streamer handle
815  * @return @c 0 on success,
816  *         otherwise a negative error value
817  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
818  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
819  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
820  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
821  * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_PLAYING.
822  * @post The media streamer state will be #MEDIA_STREAMER_STATE_PAUSED.
823  * @see media_streamer_create()
824  * @see media_streamer_play()
825  */
826 int media_streamer_pause(media_streamer_h streamer);
827
828 /**
829  * @brief Stops the media streamer.
830  * @since_tizen 3.0
831  * @param[in] streamer     Media streamer handle
832  * @return @c 0 on success,
833  *         otherwise a negative error value
834  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
835  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
836  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
837  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
838  * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_PLAYING by calling media_streamer_play() or
839  *      set to #MEDIA_STREAMER_STATE_PAUSED by calling media_streamer_pause().
840  * @post The media streamer state will be #MEDIA_STREAMER_STATE_READY.
841  * @see media_streamer_create()
842  * @see media_streamer_play()
843  * @see media_streamer_pause()
844  */
845 int media_streamer_stop(media_streamer_h streamer);
846
847 /**
848  * @brief Destroys media streamer.
849  * @since_tizen 3.0
850  * @remarks Nodes in streamer will be removed automatically.
851  *          Don't need to remove nodes by calling media_streamer_node_remove().
852  *          If you want to change the node without destroying streamer handle,
853  *          you can call the media_streamer_node_remove().
854  *          after setting the streamer state to #MEDIA_STREAMER_STATE_IDLE state.
855  * @param[in] streamer     Media streamer handle
856  * @return @c 0 on success,
857  *         otherwise a negative error value
858  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
859  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
860  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
861  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
862  * @pre Create a media streamer handle by calling media_streamer_create().
863  * @post The media streamer state will be #MEDIA_STREAMER_STATE_NONE.
864  * @see media_streamer_create()
865  */
866 int media_streamer_destroy(media_streamer_h streamer);
867
868 /**
869  * @brief Changes playback position to the defined time value, asynchronously.
870  * @since_tizen 3.0
871  * @param[in] streamer     Media streamer handle
872  * @param[in] time         Time in millisecond
873  * @param[in] accurate     If @c true, it will seek to the accurate position, but this might be considerably slower for some formats,
874  *                         otherwise @c false, it will seek to the nearest keyframe
875  * @param[in] callback     The callback function to register
876  * @param[in] user_data    The user data to be passed to the callback function
877  * @return @c 0 on success,
878  *         otherwise a negative error value
879  * @retval #MEDIA_STREAMER_ERROR_NONE    Successful
880  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
881  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
882  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
883  * @retval #MEDIA_STREAMER_ERROR_SEEK_FAILED Seek operation failure
884  * @pre The media streamer state must be one of these: #MEDIA_STREAMER_STATE_PAUSED, or #MEDIA_STREAMER_STATE_PLAYING.
885  * @post It invokes media_streamer_set_play_position() when seek operation completes, if you set a callback.
886  * @see media_streamer_get_play_position()
887  */
888 int media_streamer_set_play_position(media_streamer_h streamer, int time,
889                                         bool accurate, media_streamer_position_changed_cb callback, void *user_data);
890
891 /**
892  * @brief Gets the current position in milliseconds.
893  * @since_tizen 3.0
894  * @param[in]  streamer     Media streamer handle
895  * @param[out] time         The current position in milliseconds
896  * @return @c 0 on success,
897  *         otherwise a negative error value
898  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
899  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
900  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
901  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
902  * @pre The media streamer state must be one of these: #MEDIA_STREAMER_STATE_PAUSED, or #MEDIA_STREAMER_STATE_PLAYING.
903  * @see media_streamer_set_play_position()
904  */
905 int media_streamer_get_play_position(media_streamer_h streamer, int *time);
906
907 /**
908  * @brief Gets the total running time of the associated media.
909  * @since_tizen 3.0
910  * @remarks The streamer's source node type should be #MEDIA_STREAMER_NODE_SRC_TYPE_FILE or #MEDIA_STREAMER_NODE_SRC_TYPE_HTTP.
911  *          If not, return value will be #MEDIA_STREAMER_ERROR_NONE and duration will be -1.
912  * @param[in]  streamer     Media streamer handle
913  * @param[out] duration     The duration in milliseconds
914  * @return @c 0 on success,
915  *         otherwise a negative error value
916  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
917  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
918  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
919  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
920  * @pre The media streamer state must be one of these: #MEDIA_STREAMER_STATE_PAUSED, or #MEDIA_STREAMER_STATE_PLAYING.
921  */
922 int media_streamer_get_duration(media_streamer_h streamer, int *duration);
923
924 /**
925  * @brief Gets media streamer state.
926  * @since_tizen 3.0
927  * @param[in]  streamer     Media streamer handle
928  * @param[out] state        Media streamer state
929  * @return @c 0 on success,
930  *         otherwise a negative error value
931  * @retval #MEDIA_STREAMER_ERROR_NONE    Successful
932  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
933  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
934  * @pre Create a media streamer handle by calling media_streamer_create().
935  * @see #media_streamer_state_e
936  */
937 int media_streamer_get_state(media_streamer_h streamer, media_streamer_state_e *state);
938
939 /**
940  * @brief Creates media streamer source node.
941  * @since_tizen 3.0
942  * @remarks The internet privilege(%http://tizen.org/privilege/internet) should be added if any URIs are used to play from network.
943  *          The camera privilege(%http://tizen.org/privilege/camera) should be added if the source node handles the camera device.
944  *          The recorder privilege(%http://tizen.org/privilege/recorder) should be added if the source node handles the recorder device.
945  *          You can release source node using media_streamer_node_destroy().
946  * @param[in]  type     Media streamer source node type
947  * @param[out] src      Media streamer source node handle
948  * @return @c 0 on success,
949  *         otherwise a negative error value
950  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
951  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
952  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
953  * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
954  * @retval #MEDIA_STREAMER_ERROR_NOT_SUPPORTED Not supported
955  * @see #media_streamer_node_src_type_e
956  * @see media_streamer_node_destroy()
957  */
958 int media_streamer_node_create_src(media_streamer_node_src_type_e type, media_streamer_node_h *src);
959
960 /**
961  * @brief Pushes packet into custom source node.
962  * @details This function can be called only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM.
963  * @since_tizen 3.0
964  * @param[in] src       Media streamer source node handle
965  * @param[in] packet    Media packet handle
966  * @return @c 0 on success,
967  *         otherwise a negative error value
968  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
969  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
970  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
971  * @pre Create a source node handle by calling media_streamer_node_create_src().
972  * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_IDLE at least.
973  * @see #media_packet_h
974  */
975 int media_streamer_node_push_packet(media_streamer_node_h src, media_packet_h packet);
976
977 /**
978  * @brief Creates media streamer sink node.
979  * @since_tizen 3.0
980  * @remarks The internet privilege(%http://tizen.org/privilege/internet) should be added if any URIs are used to transmit the output data.
981  *          You can release @a sink node using media_streamer_node_destroy()
982  * @remarks If @a type is #MEDIA_STREAMER_NODE_SINK_TYPE_ADAPTIVE, the HTTP server will be started and the server will be able to transmit the output data to the other device.
983  *          The application must have an authentication responsibility between a server and client because the data transmission is not secure.
984  * @param[in]  type     Type of sink node to be created
985  * @param[out] sink     Media streamer sink node handle
986  * @return @c 0 on success,
987  *         otherwise a negative error value
988  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
989  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
990  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
991  * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
992  * @retval #MEDIA_STREAMER_ERROR_NOT_SUPPORTED Not supported
993  * @see #media_streamer_node_sink_type_e
994  * @see media_streamer_node_destroy()
995  */
996 int media_streamer_node_create_sink(media_streamer_node_sink_type_e type, media_streamer_node_h *sink);
997
998 /**
999  * @brief Pulls packet from custom sink node.
1000  * @details This function can be called only for #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
1001  * @since_tizen 3.0
1002  * @param[in] sink      Media streamer sink node handle
1003  * @param[out] packet   Media packet handle
1004  * @return @c 0 on success,
1005  *         otherwise a negative error value
1006  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1007  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1008  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1009  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1010  * @pre Create a sink node handle by calling media_streamer_node_create_sink().
1011  * @pre Set media_streamer_sink_data_ready_cb by calling media_streamer_sink_set_data_ready_cb().
1012  * @see #media_packet_h
1013  * @see media_streamer_node_create_sink()
1014  */
1015 int media_streamer_node_pull_packet(media_streamer_node_h sink, media_packet_h *packet);
1016
1017 /**
1018  * @brief Creates media streamer node except #MEDIA_STREAMER_NODE_TYPE_SRC and #MEDIA_STREAMER_NODE_TYPE_SINK.
1019  * @details Creates node specific @a type with specific format of input
1020  *          and output data.
1021  * @since_tizen 3.0
1022  * @remarks The node type should not be #MEDIA_STREAMER_NODE_TYPE_SRC and #MEDIA_STREAMER_NODE_TYPE_SINK.
1023  *          To create source / sink type node, media_streamer_node_create_src() / media_streamer_node_create_sink() should be called.
1024  *          You can release @a node using media_streamer_node_destroy().
1025  * @param[in]  type      Created node type
1026  * @param[in]  in_fmt    Media format handle for input data
1027  * @param[in]  out_fmt   Media format handle for output data
1028  * @param[out] node      Media streamer node handle to be created
1029  * @return @c 0 on success,
1030  *         otherwise a negative error value
1031  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1032  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1033  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1034  * @see #media_streamer_node_type_e
1035  * @see #media_format_h
1036  * @see media_streamer_node_destroy()
1037  */
1038 int media_streamer_node_create(media_streamer_node_type_e type, media_format_h in_fmt,
1039                                         media_format_h out_fmt, media_streamer_node_h *node);
1040
1041 /**
1042  * @brief Adds node to media streamer.
1043  * @since_tizen 3.0
1044  * @param[in] streamer    Media streamer handle
1045  * @param[in] node        Media streamer node handle to be added
1046  * @return @c 0 on success,
1047  *         otherwise a negative error value
1048  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1049  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1050  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1051  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1052  * @pre Create media streamer handle by calling media_streamer_create().
1053  * @pre Create node handle by calling media_streamer_node_create().
1054  * @see media_streamer_create()
1055  * @see media_streamer_node_create()
1056  * @see media_streamer_node_create_src()
1057  * @see media_streamer_node_create_sink()
1058  */
1059 int media_streamer_node_add(media_streamer_h streamer, media_streamer_node_h node);
1060
1061 /**
1062  * @brief Destroys media streamer node.
1063  * @since_tizen 3.0
1064  * @param[in] node        Media streamer node handle
1065  * @return @c 0 on success,
1066  *         otherwise a negative error value
1067  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1068  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1069  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1070  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1071  * @pre Create node handle by calling media_streamer_node_create().
1072  * @pre If the node was added to media streamer, it has to be removed by calling media_streamer_node_remove().
1073  * @see media_streamer_node_create()
1074  * @see media_streamer_node_create_src()
1075  * @see media_streamer_node_create_sink()
1076  * @see media_streamer_node_remove()
1077  */
1078 int media_streamer_node_destroy(media_streamer_node_h node);
1079
1080 /**
1081  * @brief Removes media streamer node from streamer.
1082  * @since_tizen 3.0
1083  * @remarks To remove node without error posting, the state of streamer should be #MEDIA_STREAMER_STATE_IDLE.
1084  *          If the node is linked, it will be unlinked before removing.
1085  * @param[in] streamer    Media streamer handle
1086  * @param[in] node        Media streamer node handle
1087  * @return @c 0 on success,
1088  *         otherwise a negative error value
1089  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1090  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1091  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1092  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1093  * @pre Add node to streamer by calling media_streamer_node_add().
1094  * @see media_streamer_node_add()
1095  */
1096 int media_streamer_node_remove(media_streamer_h streamer, media_streamer_node_h node);
1097
1098 /**
1099  * @brief Links two media streamer nodes.
1100  * @since_tizen 3.0
1101  * @remarks Pads are node's input and output, where you can connect other nodes.
1102  *          (@a node1) - (@a node2)
1103  *          @a node1 and @a node2 are determined relatively.
1104  *          In case of (A)-(B)-(C),
1105  *          (B) can be @a node2 with (A) or (B) can be @a node1 with (C).
1106  *          However, source type node is always @a node1 and sink type node is always @a node2.
1107  *          (A) is source type node and it should be @a node1.
1108  *          (C) is sink type node and it should be @a node2.
1109  * @param[in] node1     Media streamer node handle which has the @a src_pad_name pad
1110  * @param[in] src_pad_name  The name of the source pad of the @a node1
1111  * @param[in] node2     Media streamer node handle which has the @a sink_pad_name pad
1112  * @param[in] sink_pad_name The name of the sink pad of the @a node2
1113  * @return @c 0 on success,
1114  *         otherwise a negative error value
1115  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1116  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1117  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1118  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1119  * @pre Create node handles by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1120  *      And add the nodes into streamer by calling media_streamer_node_add().
1121  * @see media_streamer_node_create()
1122  * @see media_streamer_node_create_src()
1123  * @see media_streamer_node_create_sink()
1124  * @see media_streamer_node_add()
1125  */
1126 int media_streamer_node_link(media_streamer_node_h node1, const char *src_pad_name,
1127                                         media_streamer_node_h node2, const char *sink_pad_name);
1128
1129 /**
1130  * @brief Sets media format for pad of media streamer node.
1131  * @since_tizen 3.0
1132  * @param[in] node        Media streamer node handle
1133  * @param[in] pad_name    Pad name
1134  * @param[in] fmt         Media format handle
1135  * @return @c 0 on success,
1136  *         otherwise a negative error value
1137  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1138  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1139  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1140  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1141  * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1142  * @pre Get pad name by calling media_streamer_node_get_pad_name().
1143  * @see #media_format_h
1144  */
1145 int media_streamer_node_set_pad_format(media_streamer_node_h node, const char *pad_name, media_format_h fmt);
1146
1147 /**
1148  * @brief Gets media format for pad of media streamer node.
1149  * @since_tizen 3.0
1150  * @param[in] node        Media streamer node handle
1151  * @param[in] pad_name    Pad name
1152  * @param[out] fmt        Media format handle
1153  * @return @c 0 on success,
1154  *         otherwise a negative error value
1155  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1156  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1157  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1158  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1159  * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1160  * @pre Get pad name by calling media_streamer_node_get_pad_name().
1161  * @see #media_format_h
1162  */
1163 int media_streamer_node_get_pad_format(media_streamer_node_h node, const char *pad_name, media_format_h *fmt);
1164
1165 /**
1166  * @brief Gets name of node pads.
1167  * @since_tizen 3.0
1168  * @remarks After using the src_pad_name and sink_pad_name, it has to be freed.
1169  *          src_pad_name or sink_pad_name can be null according to the node type.
1170  *          In case of source type node, sink_pad_name will be null.
1171  *          In case of sink type node, src_pad_name will be null.
1172  * @param[in]  node            Media streamer node handle
1173  * @param[out] src_pad_name    Array of source pad name
1174  * @param[out] src_pad_num     The number of source pads
1175  * @param[out] sink_pad_name   Array of sink pad name
1176  * @param[out] sink_pad_num    The number of sink pads
1177  * @return @c 0 on success,
1178  *         otherwise a negative error value
1179  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1180  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1181  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1182  * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1183  * @see media_streamer_node_create()
1184  * @see media_streamer_node_create_src()
1185  * @see media_streamer_node_create_sink()
1186  */
1187 int media_streamer_node_get_pad_name(media_streamer_node_h node, char ***src_pad_name,
1188                                         int *src_pad_num, char ***sink_pad_name, int *sink_pad_num);
1189
1190 /**
1191  * @brief Sets parameters of node.
1192  * @details Many parameters can be set at one time all together by using bundle.
1193  * @since_tizen 3.0
1194  * @remarks The mediastorage privilege(%http://tizen.org/privilege/mediastorage) should be added if any video/audio files are written in the internal storage devices.
1195  *          The externalstorage privilege(%http://tizen.org/privilege/externalstorage) should be added if any video/audio files are written in the external storage devices.
1196  * @param[in] node        Media streamer node handle
1197  * @param[in] param_list  Key value array of media streamer node parameters
1198  * @return @c 0 on success,
1199  *         otherwise a negative error value
1200  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1201  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1202  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1203  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1204  * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
1205  * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1206  * @pre Get param list to set by calling media_streamer_node_get_params().
1207  * @see media_streamer_node_create()
1208  * @see media_streamer_node_create_src()
1209  * @see media_streamer_node_create_sink()
1210  * @see media_streamer_node_get_params()
1211  */
1212 int media_streamer_node_set_params(media_streamer_node_h node, bundle *param_list);
1213 /**
1214  * @brief Gets node parameter list.
1215  * @since_tizen 3.0
1216  * @remarks After using param_list, it has to be freed by calling bundle_free() in bundle.h
1217  *          Refer to the "Parameter information of node" in this file to get info.
1218  * @param[in]  node         Media streamer node handle
1219  * @param[out] param_list   Key value array of media streamer node parameters
1220  * @return @c 0 on success,
1221  *         otherwise a negative error value
1222  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1223  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1224  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1225  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1226  * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1227  * @post Set params which are needed to set by calling media_streamer_node_set_params() or media_streamer_node_set_param().
1228  * @see media_streamer_node_create()
1229  * @see media_streamer_node_create_src()
1230  * @see media_streamer_node_create_sink()
1231  * @see media_streamer_node_set_params()
1232  * @see media_streamer_node_set_param()
1233  */
1234 int media_streamer_node_get_params(media_streamer_node_h node, bundle **param_list);
1235
1236 /**
1237  * @brief Sets single parameter of node.
1238  * @details Sets parameter one by one without creating param bundle.
1239  * @since_tizen 3.0
1240  * @remarks The mediastorage privilege(%http://tizen.org/privilege/mediastorage) should be added if any video/audio files are written in the internal storage devices.
1241  *          The externalstorage privilege(%http://tizen.org/privilege/externalstorage) should be added if any video/audio files are written in the external storage devices.
1242  * @param[in] node        Media streamer node handle
1243  * @param[in] param_name  Param name of node
1244  * @param[in] param_value Param value of node
1245  * @return @c 0 on success,
1246  *         otherwise a negative error value
1247  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1248  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1249  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1250  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1251  * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
1252  * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1253  * @pre Get param list to set by calling media_streamer_node_get_params().
1254  * @see media_streamer_node_create()
1255  * @see media_streamer_node_create_src()
1256  * @see media_streamer_node_create_sink()
1257  * @see media_streamer_node_get_params()
1258  * @see media_streamer_node_get_param()
1259  */
1260 int media_streamer_node_set_param(media_streamer_node_h node,
1261                                         const char *param_name, const char *param_value);
1262
1263 /**
1264  * @brief Gets value of parameter.
1265  * @details Gets parameter one by one without creating param bundle.
1266  * @since_tizen 3.0
1267  * @param[in] node         Media streamer node handle
1268  * @param[in] param_name   Param name of node
1269  * @param[out] param_value Param value of node
1270  * @return @c 0 on success,
1271  *         otherwise a negative error value
1272  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1273  * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1274  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1275  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1276  * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1277  * @pre Get param list to know the param name by calling media_streamer_node_get_params().
1278  * @see media_streamer_node_create()
1279  * @see media_streamer_node_create_src()
1280  * @see media_streamer_node_create_sink()
1281  * @see media_streamer_node_get_params()
1282  * @see media_streamer_node_set_param()
1283  */
1284 int media_streamer_node_get_param(media_streamer_node_h node,
1285                                         const char *param_name, char **param_value);
1286
1287 /**
1288  * @brief Sets a callback function to be invoked when WebRTC node needs to send the message to the remote peer of WebRTC connection.
1289  * @details This function can be called only for #MEDIA_STREAMER_NODE_TYPE_WEBRTC type.
1290  * @since_tizen 6.0
1291  * @param[in] webrtc    Media streamer WebRTC node handle
1292  * @param[in] callback  The WebRTC message callback function to register
1293  * @param[in] user_data The user data to be passed to the callback function
1294  * @return @c 0 on success,
1295  *         otherwise a negative error value
1296  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1297  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1298  * @pre Create a media streamer WebRTC node handle by calling media_streamer_node_create().
1299  * @post media_streamer_webrtc_message_cb() will be invoked.
1300  * @see media_streamer_webrtc_node_unset_message_cb()
1301  * @see media_streamer_webrtc_message_cb()
1302  */
1303 int media_streamer_webrtc_node_set_message_cb(media_streamer_node_h webrtc, media_streamer_webrtc_message_cb callback, void *user_data);
1304
1305 /**
1306  * @brief Unsets the webrtc message callback function.
1307  * @since_tizen 6.0
1308  * @param[in] src    Media streamer WebRTC node handle
1309  * @return @c 0 on success,
1310  *         otherwise a negative error value
1311  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1312  * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1313  * @see media_streamer_webrtc_node_set_message_cb()
1314  */
1315 int media_streamer_webrtc_node_unset_message_cb(media_streamer_node_h webrtc);
1316
1317 /**
1318  * @}
1319  */
1320
1321 #ifdef __cplusplus
1322 }
1323 #endif
1324
1325 #endif /* __TIZEN_MEDIA_STREAMER_H__ */