4 * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
6 * Contact: JongHyuk Choi <jhchoi.choi@samsung.com>, YeJin Cho <cho.yejin@samsung.com>,
7 * Seungbae Shin <seungbae.shin@samsung.com>, YoungHwan An <younghwan_.an@samsung.com>
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
23 #ifndef __MM_PLAYER_INI_H__
24 #define __MM_PLAYER_INI_H__
28 #include "mm_player_audioeffect.h"
37 #define LOG_TAG "MM_PLAYER"
39 #define MM_PLAYER_INI_DEFAULT_PATH SYSCONFDIR"/multimedia/mmfw_player.ini" /* SYSCONFDIR is defined at .spec */
40 #define MM_PLAYER_INI_DEFAULT_AUDIOEFFECT_PATH SYSCONFDIR"/multimedia/mmfw_player_audio_effect.ini" /* SYSCONFDIR is defined at .spec */
42 #define PLAYER_INI_MAX_STRLEN 100
43 #define PLAYER_INI_MAX_PARAM_STRLEN 256
45 #define PLAYER_INI_MAX_ELEMENT 10
46 #define PLAYER_INI_MAX_DEVICE_TYPE 10
47 #define PLAYER_INI_MAX_SUPPORTED_MEDIA_FORMAT 10 /* @see MAX_SUPPORTED_MEDIA_FORMAT in player_private.h */
49 /* NOTE : MMPlayer has no initalizing API for library itself
50 * so we cannot decide when those ini values to be released.
51 * this is the reason of all string items are static array.
52 * make it do with malloc when MMPlayerInitialize() API created
53 * before that time, we should be careful with size limitation
54 * of each string item.
57 KEYWORD_EXCLUDE, // for element exclude keyword
58 KEYWORD_DUMP, // for dump element keyword
59 KEYWORD_UNSUPPORTED_CODEC, // for un-supported codec
60 KEYWORD_A_SW_CODEC, // for audio sw codec
61 KEYWORD_V_SW_CODEC, // for video sw codec
62 KEYWORD_A_OFFLOAD_DEVICE_TYPE, // for audio device type which can support offload
63 KEYWORD_A_OFFLOAD_MEDIA_FORMAT, // supported media format for audio offload
68 gchar videosink_element_overlay[PLAYER_INI_MAX_STRLEN];
69 gchar videosink_element_fake[PLAYER_INI_MAX_STRLEN];
70 gchar videoconverter_element[PLAYER_INI_MAX_STRLEN];
71 gchar videocodec_element_hw[PLAYER_INI_MAX_STRLEN];
72 gchar videocodec_element_sw[PLAYER_INI_MAX_ELEMENT][PLAYER_INI_MAX_STRLEN];
73 gchar audiocodec_element_hw[PLAYER_INI_MAX_STRLEN];
74 gchar audiocodec_element_sw[PLAYER_INI_MAX_ELEMENT][PLAYER_INI_MAX_STRLEN];
75 gchar audioresampler_element[PLAYER_INI_MAX_STRLEN];
76 gchar audiosink_element[PLAYER_INI_MAX_STRLEN];
77 gchar audio_offload_sink_element[PLAYER_INI_MAX_STRLEN];
78 gchar audio_offload_device_type[PLAYER_INI_MAX_DEVICE_TYPE][PLAYER_INI_MAX_STRLEN];
79 gchar audio_offload_media_format[PLAYER_INI_MAX_SUPPORTED_MEDIA_FORMAT][PLAYER_INI_MAX_STRLEN];
81 gboolean generate_dot;
82 gboolean use_system_clock;
83 gint live_state_change_timeout;
84 gint localplayback_state_change_timeout;
85 gint delay_before_repeat;
87 gboolean video_playback_supported;
89 gchar gst_param[5][PLAYER_INI_MAX_PARAM_STRLEN];
90 gchar exclude_element_keyword[PLAYER_INI_MAX_ELEMENT][PLAYER_INI_MAX_STRLEN];
91 gchar unsupported_codec_keyword[PLAYER_INI_MAX_ELEMENT][PLAYER_INI_MAX_STRLEN];
93 gboolean disable_segtrap;
96 gint video_bo_timeout;
99 gchar httpsrc_element[PLAYER_INI_MAX_STRLEN];
100 guint http_ring_buffer_size;
104 gchar audioeffect_element[PLAYER_INI_MAX_STRLEN];
105 gchar audioeffect_element_custom[PLAYER_INI_MAX_STRLEN];
107 /* audio effect preset mode */
108 gboolean use_audio_effect_preset;
109 gboolean audio_effect_preset_list[MM_AUDIO_EFFECT_PRESET_NUM];
110 gboolean audio_effect_preset_earphone_only_list[MM_AUDIO_EFFECT_PRESET_NUM];
112 /* audio effect custom mode */
113 gboolean use_audio_effect_custom;
114 gboolean audio_effect_custom_list[MM_AUDIO_EFFECT_CUSTOM_NUM];
115 gboolean audio_effect_custom_earphone_only_list[MM_AUDIO_EFFECT_CUSTOM_NUM];
116 gint audio_effect_custom_eq_band_num;
117 gint audio_effect_custom_eq_band_width[MM_AUDIO_EFFECT_EQ_BAND_NUM_MAX];
118 gint audio_effect_custom_eq_band_freq[MM_AUDIO_EFFECT_EQ_BAND_NUM_MAX];
119 gint audio_effect_custom_ext_num;
120 gint audio_effect_custom_min_level_list[MM_AUDIO_EFFECT_CUSTOM_NUM];
121 gint audio_effect_custom_max_level_list[MM_AUDIO_EFFECT_CUSTOM_NUM];
123 /* dump buffer for debug */
124 gchar dump_element_keyword[PLAYER_INI_MAX_ELEMENT][PLAYER_INI_MAX_STRLEN];
125 gchar dump_element_path[PLAYER_INI_MAX_STRLEN];
126 gboolean set_dump_element_flag;
129 /* default values if each values are not specified in inifile */
131 #define DEFAULT_EMPTY_VALUE ""
132 #define DEFAULT_AUDIO_EFFECT_ELEMENT ""
133 #define DEFAULT_USE_AUDIO_EFFECT_PRESET FALSE
134 #define DEFAULT_AUDIO_EFFECT_PRESET_LIST ""
135 #define DEFAULT_AUDIO_EFFECT_PRESET_LIST_EARPHONE_ONLY ""
136 #define DEFAULT_USE_AUDIO_EFFECT_CUSTOM FALSE
137 #define DEFAULT_AUDIO_EFFECT_CUSTOM_LIST ""
138 #define DEFAULT_AUDIO_EFFECT_CUSTOM_LIST_EARPHONE_ONLY ""
139 #define DEFAULT_AUDIO_EFFECT_CUSTOM_EQ_BAND_NUM 0
140 #define DEFAULT_AUDIO_EFFECT_CUSTOM_EQ_BAND_WIDTH ""
141 #define DEFAULT_AUDIO_EFFECT_CUSTOM_EQ_BAND_FREQ ""
142 #define DEFAULT_AUDIO_EFFECT_CUSTOM_EQ_MIN 0
143 #define DEFAULT_AUDIO_EFFECT_CUSTOM_EQ_MAX 0
144 #define DEFAULT_AUDIO_EFFECT_CUSTOM_EXT_NUM 0
145 #define DEFAULT_USE_SINK_HANDLER TRUE
146 #define DEFAULT_SKIP_RESCAN TRUE
147 #define DEFAULT_GENERATE_DOT FALSE
148 #define DEFAULT_USE_SYSTEM_CLOCK TRUE
149 #define DEFAULT_DELAY_BEFORE_REPEAT 50 /* msec */
150 #define DEFAULT_EOS_DELAY 0 /* msec */
151 #define DEFAULT_VIDEOSINK_OVERLAY "tizenwlsink"
152 #define DEFAULT_VIDEOSINK_EVAS "evasimagesink"
153 #define DEFAULT_VIDEOSINK_FAKE "fakesink"
154 #define DEFAULT_AUDIORESAMPLER "audioresample"
155 #define DEFAULT_AUDIOSINK "pulsesink"
156 #define DEFAULT_CODEC_HW ""
157 #define DEFAULT_CODEC_SW ""
158 #define DEFAULT_A_OFFLOAD_DEVICE_TYPE ""
159 #define DEFAULT_GST_PARAM ""
160 #define DEFAULT_EXCLUDE_KEYWORD ""
161 #define DEFAULT_UNSUPPORTED_CODEC_KEYWORD ""
162 #define DEFAULT_ASYNC_START TRUE
163 #define DEFAULT_DISABLE_SEGTRAP TRUE
164 #define DEFAULT_VIDEO_CONVERTER ""
165 #define DEFAULT_VIDEO_PLAYBACK_SUPPORTED TRUE
166 #define DEFAULT_LIVE_STATE_CHANGE_TIMEOUT 30 /* sec */
167 #define DEFAULT_LOCALPLAYBACK_STATE_CHANGE_TIMEOUT 10 /* sec */
168 #define DEFAULT_PCM_BUFFER_SIZE 51200 /* bytes */
169 #define DEFAULT_NUM_OF_VIDEO_BO 10
170 #define DEFAULT_TIMEOUT_OF_VIDEO_BO 10 /* sec */
171 #define DEFAULT_AUDIO_OFFLOAD_SINK ""
174 #define DEFAULT_HTTPSRC "souphttpsrc"
175 #define DEFAULT_HTTP_RING_BUFFER_SIZE (20*1024*1024) /* bytes : 20MBytes */
176 #define DEFAULT_HTTP_TIMEOUT -1 /* infinite retry */
178 /* dump buffer for debug */
179 #define DEFAULT_DUMP_ELEMENT_KEYWORD ""
180 #define DEFAULT_DUMP_ELEMENT_PATH "/tmp/"
182 /* NOTE : following content should be same with above default values */
183 /* FIXIT : need smarter way to generate default ini file. */
184 /* FIXIT : finally, it should be an external file */
185 #define MM_PLAYER_DEFAULT_INI \
189 disable segtrap = yes ; same effect with --gst-disable-segtrap \n\
191 ; set default video sink but, it can be replaced with others selected by application\n\
192 ; 0:v4l2sink, 1:ximagesink, 2:xvimagesink, 3:fakesink 4:evasimagesink 5:glimagesink\n\
193 videosink element = 2 \n\
195 video converter element = \n\
197 audiosink element = pulsesink \n\
199 ; if yes. gstreamer will not update registry \n\
200 skip rescan = yes \n\
202 delay before repeat = 50 ; msec\n\
204 ; comma separated list of tocken which elemnts has it in it's name will not be used \n\
205 element exclude keyword = \n\
207 ; comma separated list of tocken \n\
208 unsupported codec keyword = \n\
210 async start = yes \n\
212 ; parameters for initializing gstreamer \n\
213 gstparam1 = --gst-debug=2\n\
219 ; generating dot file representing pipeline state \n\
220 ; export GST_DEBUG_DUMP_DOT_DIR=/tmp/\n\
221 generate dot = no \n\
223 ; parameter is for only video to be determined \n\
224 ; which clock will be used \n\
225 ; if yes, system clock will be used \n\
226 ; apart from this, audiosink is clock provider for audio \n\
227 use system clock = yes \n\
229 ; allowed timeout for changing pipeline state \n\
230 live state change timeout = 30 ; sec \n\
231 localplayback state change timeout = 4 ; sec \n\
233 ; delay in msec for sending EOS \n\
234 eos delay = 150 ; msec \n\
239 httppsrc element = souphttpsrc \n\
241 ; if yes, use file for buffering.\n\
242 ; if no, use memory for buffering.\n\
243 http use file buffer = no\n\
245 ; ring buffer size when use mem buffer \n\
246 http ring buffer size = 20971520 ; 20MBytes \n\
248 http buffering limit = 99 ; percent\n\
250 http max size bytes = 1048576 ; bytes\n\
252 http buffering time = 1.2 \n\
254 http timeout = -1 ; infinite retry \n\
259 mm_player_ini_load(mmplayer_ini_t *ini);
262 mm_player_audio_effect_ini_load(mmplayer_ini_t *ini);